diff --git a/.gitattributes b/.gitattributes index 379a6bbdb4..2a92ef0172 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 389bcda90d..eb77167ce8 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 e826628a07..4ea110cb13 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 @@ -126,7 +126,8 @@ runs: if [ -n "$covered" ] && [ -n "$missed" ]; then local total=$((covered + missed)) if [ "$total" -gt 0 ]; then - echo "scale=1; $covered * 100 / $total" | bc + awk -v covered="$covered" -v total="$total" \ + 'BEGIN { printf "%.1f\n", covered * 100 / total }' else echo "0" fi diff --git a/.github/copilot-instructions.md b/.github/copilot-instructions.md index 79fa9522c9..a9bc22d0ec 100644 --- a/.github/copilot-instructions.md +++ b/.github/copilot-instructions.md @@ -11,7 +11,7 @@ - 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) @@ -39,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 βœ… @@ -61,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 index 32ea46fbfe..16dbe27095 100644 --- a/.github/instructions/docs-style.instructions.md +++ b/.github/instructions/docs-style.instructions.md @@ -10,7 +10,7 @@ This style guide applies to all documentation in the `docs/` directory. These do Use **sentence case** for all headings. Capitalize only the first word and proper nouns. -* `## Quick start: Azure AI Foundry` β€” not `## Quick Start: Azure AI Foundry` +* `## 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. @@ -49,7 +49,7 @@ When a callout applies to a specific language, put the qualifier as bold text in ```markdown > [!TIP] -> **(Python / Go)** These SDKs use a single `Data` class/struct with all fields optional. +> **(Python / Go)** These SDKs use separate, per-event data types. ``` ## Lists 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 index 060228d553..d034b20377 100644 --- a/.github/skills/new-java-e2e-test-yaml-and-test/SKILL.md +++ b/.github/skills/new-java-e2e-test-yaml-and-test/SKILL.md @@ -54,7 +54,7 @@ conversations: ### Step 3: Create the Java IT test class -Place it in `java/src/test/java/com/github/copilot/` with an `IT` suffix +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:** @@ -141,12 +141,12 @@ mvn clean verify | What | Where | |------|-------| -| Test context (manages proxy, workDir, CLI) | `java/src/test/java/com/github/copilot/E2ETestContext.java` | -| Java proxy wrapper | `java/src/test/java/com/github/copilot/CapiProxy.java` | +| 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/src/test/java/com/github/copilot/*IT.java` | +| Existing IT tests for reference | `java/sdk/src/test/java/com/github/copilot/*IT.java` | ## How the Proxy Matches Requests diff --git a/.github/workflows/codegen-check.yml b/.github/workflows/codegen-check.yml index 78927f1600..f37a71e45e 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/docs-validation.yml b/.github/workflows/docs-validation.yml index 4f53b71e4c..dff02f0d26 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 37cdc07f7c..4695cae7f2 100644 --- a/.github/workflows/dotnet-sdk-tests.yml +++ b/.github/workflows/dotnet-sdk-tests.yml @@ -12,7 +12,7 @@ permissions: jobs: test: - name: ".NET SDK Tests (${{ matrix.os }}, ${{ matrix.transport }}, ${{ matrix.backend }})" + name: ".NET SDK Tests (${{ matrix.os }}, ${{ matrix.transport }}, ${{ matrix.backend }}, ${{ matrix.shard }})" if: github.event.repository.fork == false env: POWERSHELL_UPDATECHECK: Off @@ -24,24 +24,80 @@ jobs: 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 + # TODO(cli-1.0.81-2): CLI 1.0.81-5 still stops completing in-process + # CAPI model turns, causing repeated per-test timeouts until the + # 30-minute job limit. Stdio CAPI and in-process BYOK remain enabled. + - os: ubuntu-latest + transport: inprocess + - os: macos-latest + transport: inprocess + # The macOS default/capi host runs the whole suite on the smallest + # runner in the matrix (3 vCPU / 7 GB vs ubuntu's 4 / 16). Since the + # 1.0.81-2 bump it stopped finishing: the job ran 50+ minutes until + # the runner lost communication with the server, and a runner that + # dies that way uploads no logs at all, so the failure could not be + # diagnosed from CI output. Split it across isolated hosts so one + # poisoned runtime cannot consume the entire job without diagnostics. + - os: macos-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: macos-latest + transport: default + backend: capi + shard: "1" + - os: macos-latest + transport: default + backend: capi + shard: "2a" + - os: macos-latest + transport: default + backend: capi + shard: "2b" + - os: macos-latest + transport: default + backend: capi + shard: "2c" - 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 }} + # A hung test used to run until the runner died (~50 min) and the dying + # runner never uploaded its logs, so the failures were undiagnosable. + # Every healthy cell finishes well under 15 min. + timeout-minutes: 30 defaults: run: shell: bash @@ -92,9 +148,48 @@ jobs: - name: Run .NET SDK tests env: COPILOT_HMAC_KEY: ${{ secrets.COPILOT_DEVELOPER_CLI_INTEGRATION_HMAC_KEY }} + DOTNET_TEST_SHARD: ${{ matrix.shard }} run: | - args=(--no-build -v n) - if [[ -n "$DOTNET_TEST_FILTER" ]]; then - args+=(--filter "$DOTNET_TEST_FILTER") + # --blame-hang names the offending test instead of letting it wedge + # the runner. No single test legitimately runs for 10 minutes; the + # whole suite normally finishes in about five. + args=(--no-build -v n --blame-hang --blame-hang-timeout 10m --blame-hang-dump-type none) + + filter="$DOTNET_TEST_FILTER" + if [[ "$DOTNET_TEST_SHARD" != "full" ]]; then + case "$DOTNET_TEST_SHARD" in + 1) + initials=(A C D H I J K L N Q S U W Y) + shard_filter="FullyQualifiedName~GitHub.Copilot.Test.ConnectionToken" + ;; + 2) + initials=(B E F G M O P R T V X Z) + shard_filter="" + ;; + 2a) + initials=(B E F G) + shard_filter="" + ;; + 2b) + initials=(M O P R) + shard_filter="" + ;; + 2c) + initials=(T V X Z) + shard_filter="" + ;; + esac + + 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/java-adapt-handwritten-code-to-accept-upgrade-changes.lock.yml b/.github/workflows/java-adapt-handwritten-code-to-accept-upgrade-changes.lock.yml index de924a01ae..e94e0775c0 100644 --- 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 @@ -1,4 +1,4 @@ -# gh-aw-metadata: {"schema_version":"v4","frontmatter_hash":"a5f19a89f89b0693f86ca89ea90e3a633fe19c17bf4d27214fa9124429cdc156","body_hash":"41bc10df4ac9179064417476fbb39fef7423d0998dc0beb7bad42e9eb7ab0494","compiler_version":"v0.83.1","strict":true,"agent_id":"copilot","engine_versions":{"copilot":"1.0.73"}} +# 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 # 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 index b1623ff78a..dd1bfe2bbc 100644 --- a/.github/workflows/java-adapt-handwritten-code-to-accept-upgrade-changes.md +++ b/.github/workflows/java-adapt-handwritten-code-to-accept-upgrade-changes.md @@ -51,17 +51,17 @@ You are an automation agent that fixes handwritten Java SDK source and test code - The branch `${{ inputs.branch }}` already has: - Updated `java/scripts/codegen/package.json` with the new version - - Regenerated `java/src/generated/java/` code that compiles successfully + - 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/src/generated/java/` +- ❌ 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/src/test/java/com/github/copilot/sdk/generated/`) -- βœ… DO edit `java/src/main/java/com/github/copilot/sdk/**` -- βœ… DO edit `java/src/test/java/com/github/copilot/sdk/**` (excluding the `generated` subpackage) +- ❌ 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 @@ -146,7 +146,7 @@ mvn verify -Dskip.test.harness=true If this passes, commit and push: ```bash -git add java/src/main/java java/src/test/java +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 diff --git a/.github/workflows/java-codegen-check.yml b/.github/workflows/java-codegen-check.yml index e1c11cd6da..f2f4527966 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 08005d7f7c..1d8d28c439 100644 --- a/.github/workflows/java-codegen-fix.lock.yml +++ b/.github/workflows/java-codegen-fix.lock.yml @@ -1,4 +1,4 @@ -# gh-aw-metadata: {"schema_version":"v4","frontmatter_hash":"b0390c9ab9beb0d7e106314299e89e486269ab7f64d8489d5021132d79aa6b9b","body_hash":"fe41f8fe1c12cb585cfaefdd755f58d2a84410d9d819cd706a3192ce052e2545","compiler_version":"v0.83.1","strict":true,"agent_id":"copilot","engine_versions":{"copilot":"1.0.73"}} +# 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 # diff --git a/.github/workflows/java-codegen-fix.md b/.github/workflows/java-codegen-fix.md index 1fe465f4c5..b1dcb1f636 100644 --- a/.github/workflows/java-codegen-fix.md +++ b/.github/workflows/java-codegen-fix.md @@ -54,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 }}` @@ -66,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: @@ -126,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. @@ -162,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/`. @@ -179,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`) @@ -236,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 \ No newline at end of file diff --git a/.github/workflows/java-publish-maven.yml b/.github/workflows/java-publish-maven.yml index 944a0ee38e..fd07aae155 100644 --- a/.github/workflows/java-publish-maven.yml +++ b/.github/workflows/java-publish-maven.yml @@ -1,9 +1,6 @@ name: "Java Publish to Maven Central" env: - # Disable Husky Git hooks in CI to prevent local development hooks - # (e.g., pre-commit formatting checks) from running during automated - # workflows that perform git commits and pushes. HUSKY: 0 on: @@ -37,6 +34,10 @@ on: type: boolean required: false default: false + outputs: + mavenPublished: + description: "Whether the Java package was published to Maven Central" + value: ${{ jobs.deploy-maven.outputs.published }} secrets: JAVA_RELEASE_TOKEN: required: true @@ -52,8 +53,7 @@ on: required: true permissions: - contents: write - id-token: write + contents: read concurrency: group: publish-maven @@ -66,11 +66,6 @@ jobs: steps: - name: Verify JAVA_RELEASE_TOKEN can push to repository run: | - # JAVA_RELEASE_TOKEN is used by actions/checkout and for: - # - git push origin main (doc updates) - # - mvn release:prepare -DpushChanges=true (release commits + tags) - # - git revert + push (rollback on failure) - # It must have push (contents:write) permission on this repo. PUSH=$(gh api repos/${{ github.repository }} --jq '.permissions.push // false') if [ "$PUSH" != "true" ]; then echo "::error::JAVA_RELEASE_TOKEN lacks push permission on ${{ github.repository }}. It is required for pushing release commits and tags to main." @@ -80,49 +75,24 @@ 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 + prepare-release: + name: Prepare Java release needs: preflight runs-on: ubuntu-latest + permissions: + contents: write defaults: run: shell: bash working-directory: ./java outputs: - version: ${{ steps.versions.outputs.release_version }} + release_version: ${{ steps.versions.outputs.release_version }} + development_version: ${{ steps.versions.outputs.development_version }} + release_tag: ${{ steps.release-identity.outputs.release_tag }} + tag_commit: ${{ steps.release-identity.outputs.tag_commit }} + pre_prepare_commit: ${{ steps.pre-prepare.outputs.pre_prepare_commit }} + post_prepare_commit: ${{ steps.release-identity.outputs.post_prepare_commit }} + docs_commit: ${{ steps.update-docs.outputs.docs_commit_sha }} steps: - uses: actions/checkout@de0fac2e4500dabe0009e67214ff5f5447ce83dd # v6.0.2 with: @@ -136,100 +106,66 @@ jobs: - uses: ./.github/actions/setup-copilot - - name: Set up JDK 25 - uses: actions/setup-java@be666c2fcd27ec809703dec50e508c2fdc7f6654 # v5 + - uses: actions/setup-java@be666c2fcd27ec809703dec50e508c2fdc7f6654 # v5 with: java-version: "25" distribution: "microsoft" cache: "maven" - server-id: central - server-username: MAVEN_USERNAME - server-password: MAVEN_PASSWORD - gpg-private-key: ${{ secrets.JAVA_GPG_SECRET_KEY }} - gpg-passphrase: JAVA_GPG_PASSPHRASE - name: Determine versions id: versions - working-directory: ./java run: | CURRENT_VERSION=$(mvn help:evaluate -Dexpression=project.version -q -DforceStdout) echo "Current pom.xml version: $CURRENT_VERSION" - # Determine release version if [ -n "${{ inputs.releaseVersion }}" ]; then RELEASE_VERSION="${{ inputs.releaseVersion }}" else - # Remove -SNAPSHOT suffix if present RELEASE_VERSION="${CURRENT_VERSION%-SNAPSHOT}" fi echo "Release version: $RELEASE_VERSION" - # Determine next development version if [ -n "${{ inputs.developmentVersion }}" ]; then DEV_VERSION="${{ inputs.developmentVersion }}" if [[ "$DEV_VERSION" != *-SNAPSHOT ]]; then - echo "::error::developmentVersion '${DEV_VERSION}' must end with '-SNAPSHOT' (e.g., '${DEV_VERSION}-SNAPSHOT'). The maven-release-plugin requires the next development version to be a snapshot." + echo "::error::developmentVersion '${DEV_VERSION}' must end with '-SNAPSHOT'." exit 1 fi else - # 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]+(-(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 + echo "Error: RELEASE_VERSION '$RELEASE_VERSION' is invalid." >&2 exit 1 fi - # Extract the base M.M.P portion (before any qualifier) BASE_VERSION=$(echo "$RELEASE_VERSION" | grep -oE '^[0-9]+\.[0-9]+\.[0-9]+') QUALIFIER=$(echo "$RELEASE_VERSION" | sed "s|^${BASE_VERSION}||") IFS='.' read -r MAJOR MINOR PATCH <<< "$BASE_VERSION" - NEXT_PATCH=$((PATCH + 1)) - DEV_VERSION="${MAJOR}.${MINOR}.${NEXT_PATCH}${QUALIFIER}-SNAPSHOT" + DEV_VERSION="${MAJOR}.${MINOR}.$((PATCH + 1))${QUALIFIER}-SNAPSHOT" fi - echo "Next development version: $DEV_VERSION" - - echo "release_version=$RELEASE_VERSION" >> $GITHUB_OUTPUT - echo "dev_version=$DEV_VERSION" >> $GITHUB_OUTPUT - echo "### Version Summary" >> $GITHUB_STEP_SUMMARY - echo "- **Release version:** $RELEASE_VERSION" >> $GITHUB_STEP_SUMMARY - echo "- **Next development version:** $DEV_VERSION" >> $GITHUB_STEP_SUMMARY + echo "release_version=$RELEASE_VERSION" >> "$GITHUB_OUTPUT" + echo "development_version=$DEV_VERSION" >> "$GITHUB_OUTPUT" - name: Update documentation with release version id: update-docs - working-directory: ./java run: | VERSION="${{ steps.versions.outputs.release_version }}" - - # Update release 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 versions in README.md (must run AFTER release version seds - # because the release copilot-sdk-java: pattern partially matches inside snapshot - # strings β€” the snapshot-specific seds override with the correct DEV_VERSION) - 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 - 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]*\)*-SNAPSHOT|copilot-sdk-java:${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 - - # Commit the documentation changes before release:prepare (requires clean working directory) - git add README.md jbang-example.java + DEV_VERSION="${{ steps.versions.outputs.development_version }}" + ./scripts/test-update-documentation-versions.sh + ./scripts/update-documentation-versions.sh "$VERSION" "$DEV_VERSION" README.md sdk/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 - echo "docs_commit_sha=$(git rev-parse HEAD)" >> $GITHUB_OUTPUT - + echo "docs_commit_sha=$(git rev-parse HEAD)" >> "$GITHUB_OUTPUT" git push origin main + - name: Record rollback base + id: pre-prepare + run: echo "pre_prepare_commit=$(git rev-parse HEAD^)" >> "$GITHUB_OUTPUT" + - name: Prepare Release - working-directory: ./java run: | mvn -B release:prepare \ -DreleaseVersion=${{ steps.versions.outputs.release_version }} \ - -DdevelopmentVersion=${{ steps.versions.outputs.dev_version }} \ + -DdevelopmentVersion=${{ steps.versions.outputs.development_version }} \ -DtagNameFormat=java/v@{project.version} \ -DpushChanges=true \ -Darguments="-DskipTests" @@ -238,33 +174,465 @@ jobs: MAVEN_PASSWORD: ${{ secrets.JAVA_MAVEN_CENTRAL_PASSWORD }} JAVA_GPG_PASSPHRASE: ${{ secrets.JAVA_GPG_PASSPHRASE }} - - name: Perform Release and Deploy to Maven Central + - name: Record immutable release identity + id: release-identity + run: | + TAG="java/v${{ steps.versions.outputs.release_version }}" + TAG_COMMIT=$(git rev-parse "${TAG}^{commit}") + POST_PREPARE_COMMIT=$(git rev-parse HEAD) + echo "release_tag=$TAG" >> "$GITHUB_OUTPUT" + echo "tag_commit=$TAG_COMMIT" >> "$GITHUB_OUTPUT" + echo "post_prepare_commit=$POST_PREPARE_COMMIT" >> "$GITHUB_OUTPUT" + + build-linux-arm64-classifier: + name: Build Linux ARM64 native classifier + needs: prepare-release + runs-on: ubuntu-24.04-arm + permissions: + contents: read + defaults: + run: + shell: bash working-directory: ./java + steps: + - uses: actions/checkout@de0fac2e4500dabe0009e67214ff5f5447ce83dd # v6.0.2 + with: + ref: ${{ needs.prepare-release.outputs.release_tag }} + fetch-depth: 1 + 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: Build and validate linux-arm64 classifier run: | - mvn -B release:perform \ - -Dgoals="deploy" \ - -Darguments="-DskipTests -Prelease" - env: - MAVEN_USERNAME: ${{ secrets.JAVA_MAVEN_CENTRAL_USERNAME }} - MAVEN_PASSWORD: ${{ secrets.JAVA_MAVEN_CENTRAL_PASSWORD }} - JAVA_GPG_PASSPHRASE: ${{ secrets.JAVA_GPG_PASSPHRASE }} + set -euo pipefail + SOURCE_COMMIT=$(git rev-parse HEAD) + if [ "$SOURCE_COMMIT" != "${{ needs.prepare-release.outputs.tag_commit }}" ]; then + echo "::error::Checked out $SOURCE_COMMIT instead of the prepared tag commit." + exit 1 + fi + node copilot-native/scripts/validate-native-host.mjs linux-arm64 + mvn -B -pl copilot-native package -DskipTests -Dcopilot.native.libc=glibc + VERSION="${{ needs.prepare-release.outputs.release_version }}" + JAR="copilot-native/target/copilot-sdk-java-runtime-$VERSION-linux-arm64.jar" + PRIMARY_JAR="copilot-native/target/copilot-sdk-java-runtime-$VERSION.jar" + test -f "$JAR" + node copilot-native/scripts/validate-native-artifact.mjs \ + classifier linux-arm64 "$JAR" "$(basename "$JAR")" .. + node copilot-native/scripts/validate-native-artifact.mjs placeholder "$PRIMARY_JAR" + MANIFEST="copilot-native/target/linux-arm64-$VERSION.sha256" + HASH=$(sha256sum "$JAR" | cut -d ' ' -f 1) + printf '%s %s' "$HASH" "$(basename "$JAR")" > "$MANIFEST" + node copilot-native/scripts/validate-native-artifact.mjs \ + checksum "$JAR" "$MANIFEST" "$(basename "$JAR")" + + - uses: actions/upload-artifact@043fb46d1a93c77aae656e7c1c64a875d1fc6a0a # v7 + with: + name: java-native-linux-arm64-release-${{ github.run_id }}-${{ github.run_attempt }} + path: | + java/copilot-native/target/copilot-sdk-java-runtime-${{ needs.prepare-release.outputs.release_version }}-linux-arm64.jar + java/copilot-native/target/linux-arm64-${{ needs.prepare-release.outputs.release_version }}.sha256 + if-no-files-found: error + retention-days: 1 + + build-windows-classifier: + name: Build Windows native classifier + needs: prepare-release + runs-on: windows-latest + permissions: + contents: read + defaults: + run: + shell: pwsh + working-directory: ./java + steps: + - uses: actions/checkout@de0fac2e4500dabe0009e67214ff5f5447ce83dd # v6.0.2 + with: + ref: ${{ needs.prepare-release.outputs.release_tag }} + fetch-depth: 1 + persist-credentials: false + + - uses: actions/setup-java@be666c2fcd27ec809703dec50e508c2fdc7f6654 # v5 + with: + java-version: "25" + distribution: "microsoft" + cache: "maven" - - name: Rollback documentation commit on failure - if: failure() && steps.update-docs.outputs.docs_commit_sha != '' + - uses: actions/setup-node@48b55a011bda9f5d6aeb4c2d9c7362e8dae4041e # v6 + with: + node-version: 22 + + - name: Build and validate win32-x64 classifier + run: | + $sourceCommit = git rev-parse HEAD + if ($sourceCommit -ne '${{ needs.prepare-release.outputs.tag_commit }}') { + throw "Checked out $sourceCommit instead of the prepared tag commit." + } + node copilot-native/scripts/validate-native-host.mjs win32-x64 + mvn -B -pl copilot-native package -DskipTests + $version = '${{ needs.prepare-release.outputs.release_version }}' + $jar = "copilot-native/target/copilot-sdk-java-runtime-$version-win32-x64.jar" + $primaryJar = "copilot-native/target/copilot-sdk-java-runtime-$version.jar" + if (-not (Test-Path -LiteralPath $jar -PathType Leaf)) { + throw "Expected Windows classifier was not produced: $jar" + } + node copilot-native/scripts/validate-native-artifact.mjs classifier win32-x64 $jar ([IO.Path]::GetFileName($jar)) .. + node copilot-native/scripts/validate-native-artifact.mjs placeholder $primaryJar + $manifest = "copilot-native/target/win32-x64-$version.sha256" + $hash = (Get-FileHash -Algorithm SHA256 -LiteralPath $jar).Hash.ToLowerInvariant() + "$hash $([IO.Path]::GetFileName($jar))" | Set-Content -NoNewline -Encoding ascii $manifest + node copilot-native/scripts/validate-native-artifact.mjs checksum $jar $manifest ([IO.Path]::GetFileName($jar)) + + - uses: actions/upload-artifact@043fb46d1a93c77aae656e7c1c64a875d1fc6a0a # v7 + with: + name: java-native-win32-x64-release-${{ github.run_id }}-${{ github.run_attempt }} + path: | + java/copilot-native/target/copilot-sdk-java-runtime-${{ needs.prepare-release.outputs.release_version }}-win32-x64.jar + java/copilot-native/target/win32-x64-${{ needs.prepare-release.outputs.release_version }}.sha256 + if-no-files-found: error + retention-days: 1 + + build-windows-arm64-classifier: + name: Build Windows ARM64 native classifier + needs: prepare-release + runs-on: windows-11-arm + permissions: + contents: read + defaults: + run: + shell: pwsh working-directory: ./java + steps: + - uses: actions/checkout@de0fac2e4500dabe0009e67214ff5f5447ce83dd # v6.0.2 + with: + ref: ${{ needs.prepare-release.outputs.release_tag }} + fetch-depth: 1 + 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: Build and validate win32-arm64 classifier run: | - echo "Release failed, rolling back documentation commit..." - git revert --no-edit ${{ steps.update-docs.outputs.docs_commit_sha }} - git push origin main + $sourceCommit = git rev-parse HEAD + if ($sourceCommit -ne '${{ needs.prepare-release.outputs.tag_commit }}') { + throw "Checked out $sourceCommit instead of the prepared tag commit." + } + node copilot-native/scripts/validate-native-host.mjs win32-arm64 + mvn -B -pl copilot-native package -DskipTests + $version = '${{ needs.prepare-release.outputs.release_version }}' + $jar = "copilot-native/target/copilot-sdk-java-runtime-$version-win32-arm64.jar" + $primaryJar = "copilot-native/target/copilot-sdk-java-runtime-$version.jar" + if (-not (Test-Path -LiteralPath $jar -PathType Leaf)) { + throw "Expected Windows ARM64 classifier was not produced: $jar" + } + node copilot-native/scripts/validate-native-artifact.mjs classifier win32-arm64 $jar ([IO.Path]::GetFileName($jar)) .. + node copilot-native/scripts/validate-native-artifact.mjs placeholder $primaryJar + $manifest = "copilot-native/target/win32-arm64-$version.sha256" + $hash = (Get-FileHash -Algorithm SHA256 -LiteralPath $jar).Hash.ToLowerInvariant() + "$hash $([IO.Path]::GetFileName($jar))" | Set-Content -NoNewline -Encoding ascii $manifest + node copilot-native/scripts/validate-native-artifact.mjs checksum $jar $manifest ([IO.Path]::GetFileName($jar)) + + - uses: actions/upload-artifact@043fb46d1a93c77aae656e7c1c64a875d1fc6a0a # v7 + with: + name: java-native-win32-arm64-release-${{ github.run_id }}-${{ github.run_attempt }} + path: | + java/copilot-native/target/copilot-sdk-java-runtime-${{ needs.prepare-release.outputs.release_version }}-win32-arm64.jar + java/copilot-native/target/win32-arm64-${{ needs.prepare-release.outputs.release_version }}.sha256 + if-no-files-found: error + retention-days: 1 + + build-darwin-classifier: + name: Build Darwin native classifier + needs: prepare-release + runs-on: macos-26 + permissions: + contents: read + defaults: + run: + shell: bash + working-directory: ./java + steps: + - uses: actions/checkout@de0fac2e4500dabe0009e67214ff5f5447ce83dd # v6.0.2 + with: + ref: ${{ needs.prepare-release.outputs.release_tag }} + fetch-depth: 1 + persist-credentials: false - # Also run Maven release:rollback to clean up any partial release state - mvn -B release:rollback || true + - uses: actions/setup-java@be666c2fcd27ec809703dec50e508c2fdc7f6654 # v5 + with: + java-version: "25" + distribution: "microsoft" + cache: "maven" - github-release: - name: Create GitHub Release - needs: [preflight, publish-maven] - if: github.ref == 'refs/heads/main' + - uses: actions/setup-node@48b55a011bda9f5d6aeb4c2d9c7362e8dae4041e # v6 + with: + node-version: 22 + + - name: Build and validate darwin-arm64 classifier + run: | + set -euo pipefail + SOURCE_COMMIT=$(git rev-parse HEAD) + if [ "$SOURCE_COMMIT" != "${{ needs.prepare-release.outputs.tag_commit }}" ]; then + echo "::error::Checked out $SOURCE_COMMIT instead of the prepared tag commit." + exit 1 + fi + node copilot-native/scripts/validate-native-host.mjs darwin-arm64 + mvn -B -pl copilot-native package -DskipTests + VERSION="${{ needs.prepare-release.outputs.release_version }}" + JAR="copilot-native/target/copilot-sdk-java-runtime-$VERSION-darwin-arm64.jar" + PRIMARY_JAR="copilot-native/target/copilot-sdk-java-runtime-$VERSION.jar" + test -f "$JAR" + node copilot-native/scripts/validate-native-artifact.mjs \ + classifier darwin-arm64 "$JAR" "$(basename "$JAR")" .. + node copilot-native/scripts/validate-native-artifact.mjs placeholder "$PRIMARY_JAR" + MANIFEST="copilot-native/target/darwin-arm64-$VERSION.sha256" + HASH=$(shasum -a 256 "$JAR" | cut -d ' ' -f 1) + printf '%s %s' "$HASH" "$(basename "$JAR")" > "$MANIFEST" + node copilot-native/scripts/validate-native-artifact.mjs \ + checksum "$JAR" "$MANIFEST" "$(basename "$JAR")" + + - uses: actions/upload-artifact@043fb46d1a93c77aae656e7c1c64a875d1fc6a0a # v7 + with: + name: java-native-darwin-arm64-release-${{ github.run_id }}-${{ github.run_attempt }} + path: | + java/copilot-native/target/copilot-sdk-java-runtime-${{ needs.prepare-release.outputs.release_version }}-darwin-arm64.jar + java/copilot-native/target/darwin-arm64-${{ needs.prepare-release.outputs.release_version }}.sha256 + if-no-files-found: error + retention-days: 1 + + deploy-maven: + name: Deploy Java release to Maven Central + needs: + [ + prepare-release, + build-linux-arm64-classifier, + build-windows-classifier, + build-windows-arm64-classifier, + build-darwin-classifier, + ] + runs-on: ubuntu-latest + permissions: + contents: read + defaults: + run: + shell: bash + working-directory: ./java + outputs: + version: ${{ needs.prepare-release.outputs.release_version }} + published: ${{ steps.publish-maven.outcome == 'success' }} + steps: + - uses: actions/checkout@de0fac2e4500dabe0009e67214ff5f5447ce83dd # v6.0.2 + with: + ref: ${{ needs.prepare-release.outputs.release_tag }} + fetch-depth: 1 + persist-credentials: false + + - uses: ./.github/actions/setup-copilot + + - uses: actions/setup-java@be666c2fcd27ec809703dec50e508c2fdc7f6654 # v5 + with: + java-version: "25" + distribution: "microsoft" + cache: "maven" + server-id: central + server-username: MAVEN_USERNAME + server-password: MAVEN_PASSWORD + gpg-private-key: ${{ secrets.JAVA_GPG_SECRET_KEY }} + gpg-passphrase: JAVA_GPG_PASSPHRASE + + - uses: actions/setup-node@48b55a011bda9f5d6aeb4c2d9c7362e8dae4041e # v6 + with: + node-version: 22 + + - uses: actions/download-artifact@d3f86a106a0bac45b974a628896c90dbdf5c8093 # v4.3.0 + with: + name: java-native-linux-arm64-release-${{ github.run_id }}-${{ github.run_attempt }} + path: ${{ runner.temp }}/java-native-linux-arm64 + + - uses: actions/download-artifact@d3f86a106a0bac45b974a628896c90dbdf5c8093 # v4.3.0 + with: + name: java-native-win32-x64-release-${{ github.run_id }}-${{ github.run_attempt }} + path: ${{ runner.temp }}/java-native-win32-x64 + + - uses: actions/download-artifact@d3f86a106a0bac45b974a628896c90dbdf5c8093 # v4.3.0 + with: + name: java-native-win32-arm64-release-${{ github.run_id }}-${{ github.run_attempt }} + path: ${{ runner.temp }}/java-native-win32-arm64 + + - uses: actions/download-artifact@d3f86a106a0bac45b974a628896c90dbdf5c8093 # v4.3.0 + with: + name: java-native-darwin-arm64-release-${{ github.run_id }}-${{ github.run_attempt }} + path: ${{ runner.temp }}/java-native-darwin-arm64 + + - name: Verify immutable source and Linux ARM64 classifier + id: linux-arm64-artifact + run: | + SOURCE_COMMIT=$(git rev-parse HEAD) + if [ "$SOURCE_COMMIT" != "${{ needs.prepare-release.outputs.tag_commit }}" ]; then + echo "::error::Checked out $SOURCE_COMMIT instead of the prepared tag commit." + exit 1 + fi + VERSION="${{ needs.prepare-release.outputs.release_version }}" + ARTIFACT_DIRECTORY="${{ runner.temp }}/java-native-linux-arm64" + JAR="$ARTIFACT_DIRECTORY/copilot-sdk-java-runtime-$VERSION-linux-arm64.jar" + MANIFEST="$ARTIFACT_DIRECTORY/linux-arm64-$VERSION.sha256" + test -f "$JAR" + test -f "$MANIFEST" + node "$GITHUB_WORKSPACE/java/copilot-native/scripts/validate-native-artifact.mjs" \ + checksum "$JAR" "$MANIFEST" "$(basename "$JAR")" + node "$GITHUB_WORKSPACE/java/copilot-native/scripts/validate-native-artifact.mjs" \ + classifier linux-arm64 "$JAR" "$(basename "$JAR")" "$GITHUB_WORKSPACE" + echo "linux_arm64_jar=$JAR" >> "$GITHUB_OUTPUT" + echo "linux_arm64_sha=$(cut -d ' ' -f 1 "$MANIFEST")" >> "$GITHUB_OUTPUT" + + - name: Verify immutable source and Windows classifier + id: windows-artifact + run: | + SOURCE_COMMIT=$(git rev-parse HEAD) + if [ "$SOURCE_COMMIT" != "${{ needs.prepare-release.outputs.tag_commit }}" ]; then + echo "::error::Checked out $SOURCE_COMMIT instead of the prepared tag commit." + exit 1 + fi + VERSION="${{ needs.prepare-release.outputs.release_version }}" + ARTIFACT_DIRECTORY="${{ runner.temp }}/java-native-win32-x64" + JAR="$ARTIFACT_DIRECTORY/copilot-sdk-java-runtime-$VERSION-win32-x64.jar" + MANIFEST="$ARTIFACT_DIRECTORY/win32-x64-$VERSION.sha256" + test -f "$JAR" + test -f "$MANIFEST" + node "$GITHUB_WORKSPACE/java/copilot-native/scripts/validate-native-artifact.mjs" \ + checksum "$JAR" "$MANIFEST" "$(basename "$JAR")" + node "$GITHUB_WORKSPACE/java/copilot-native/scripts/validate-native-artifact.mjs" \ + classifier win32-x64 "$JAR" "$(basename "$JAR")" "$GITHUB_WORKSPACE" + echo "windows_jar=$JAR" >> "$GITHUB_OUTPUT" + echo "windows_sha=$(cut -d ' ' -f 1 "$MANIFEST")" >> "$GITHUB_OUTPUT" + + - name: Verify immutable source and Darwin classifier + id: darwin-artifact + run: | + SOURCE_COMMIT=$(git rev-parse HEAD) + if [ "$SOURCE_COMMIT" != "${{ needs.prepare-release.outputs.tag_commit }}" ]; then + echo "::error::Checked out $SOURCE_COMMIT instead of the prepared tag commit." + exit 1 + fi + VERSION="${{ needs.prepare-release.outputs.release_version }}" + ARTIFACT_DIRECTORY="${{ runner.temp }}/java-native-darwin-arm64" + JAR="$ARTIFACT_DIRECTORY/copilot-sdk-java-runtime-$VERSION-darwin-arm64.jar" + MANIFEST="$ARTIFACT_DIRECTORY/darwin-arm64-$VERSION.sha256" + test -f "$JAR" + test -f "$MANIFEST" + node "$GITHUB_WORKSPACE/java/copilot-native/scripts/validate-native-artifact.mjs" \ + checksum "$JAR" "$MANIFEST" "$(basename "$JAR")" + node "$GITHUB_WORKSPACE/java/copilot-native/scripts/validate-native-artifact.mjs" \ + classifier darwin-arm64 "$JAR" "$(basename "$JAR")" "$GITHUB_WORKSPACE" + echo "darwin_jar=$JAR" >> "$GITHUB_OUTPUT" + echo "darwin_sha=$(cut -d ' ' -f 1 "$MANIFEST")" >> "$GITHUB_OUTPUT" + + - name: Verify immutable source and Windows ARM64 classifier + id: windows-arm64-artifact + run: | + SOURCE_COMMIT=$(git rev-parse HEAD) + if [ "$SOURCE_COMMIT" != "${{ needs.prepare-release.outputs.tag_commit }}" ]; then + echo "::error::Checked out $SOURCE_COMMIT instead of the prepared tag commit." + exit 1 + fi + VERSION="${{ needs.prepare-release.outputs.release_version }}" + ARTIFACT_DIRECTORY="${{ runner.temp }}/java-native-win32-arm64" + JAR="$ARTIFACT_DIRECTORY/copilot-sdk-java-runtime-$VERSION-win32-arm64.jar" + MANIFEST="$ARTIFACT_DIRECTORY/win32-arm64-$VERSION.sha256" + test -f "$JAR" + test -f "$MANIFEST" + node "$GITHUB_WORKSPACE/java/copilot-native/scripts/validate-native-artifact.mjs" \ + checksum "$JAR" "$MANIFEST" "$(basename "$JAR")" + node "$GITHUB_WORKSPACE/java/copilot-native/scripts/validate-native-artifact.mjs" \ + classifier win32-arm64 "$JAR" "$(basename "$JAR")" "$GITHUB_WORKSPACE" + echo "windows_arm64_jar=$JAR" >> "$GITHUB_OUTPUT" + echo "windows_arm64_sha=$(cut -d ' ' -f 1 "$MANIFEST")" >> "$GITHUB_OUTPUT" + + - name: Build Linux classifier and deploy complete release + id: publish-maven + run: | + VERSION="${{ needs.prepare-release.outputs.release_version }}" + mvn -B deploy -DskipTests -Prelease -Dcopilot.native.libc=glibc \ + "-Dcopilot.native.external.linux.arm64.classifier.path=${{ steps.linux-arm64-artifact.outputs.linux_arm64_jar }}" \ + "-Dcopilot.native.external.win32.classifier.path=${{ steps.windows-artifact.outputs.windows_jar }}" \ + "-Dcopilot.native.external.win32.arm64.classifier.path=${{ steps.windows-arm64-artifact.outputs.windows_arm64_jar }}" \ + "-Dcopilot.native.external.darwin.classifier.path=${{ steps.darwin-artifact.outputs.darwin_jar }}" + LINUX_JAR="copilot-native/target/copilot-sdk-java-runtime-$VERSION-linux-x64.jar" + test -f "$LINUX_JAR" + node copilot-native/scripts/validate-native-artifact.mjs \ + classifier linux-x64 "$LINUX_JAR" "$(basename "$LINUX_JAR")" .. + LINUX_SHA=$(sha256sum "$LINUX_JAR" | cut -d ' ' -f 1) + GROUP_ID=$(mvn -q -pl copilot-native help:evaluate -Dexpression=project.groupId -DforceStdout) + ARTIFACT_ID=$(mvn -q -pl copilot-native help:evaluate -Dexpression=project.artifactId -DforceStdout) + POM_VERSION=$(mvn -q -pl copilot-native help:evaluate -Dexpression=project.version -DforceStdout) + if [ -z "$GROUP_ID" ] || [ -z "$ARTIFACT_ID" ] || [ "$POM_VERSION" != "$VERSION" ]; then + echo "::error::Unexpected copilot-native Maven coordinates: $GROUP_ID:$ARTIFACT_ID:$POM_VERSION (expected version $VERSION)" + exit 1 + fi + { + echo "### Maven Central Release" + echo "- **Version:** $VERSION" + echo "- **Source tag:** \`${{ needs.prepare-release.outputs.release_tag }}\`" + echo "- **Source commit:** \`${{ needs.prepare-release.outputs.tag_commit }}\`" + echo "- **Next development version:** ${{ needs.prepare-release.outputs.development_version }}" + echo "- **Repository:** Maven Central" + echo "" + echo "#### Maven Coordinates" + echo "" + echo '```xml' + echo "" + echo " $GROUP_ID" + echo " $ARTIFACT_ID" + echo " $POM_VERSION" + echo "" + echo '```' + echo "" + echo "#### Published Native Classifiers" + echo "" + echo "| Classifier | Build runner | Artifact | SHA-256 | Status |" + echo "| --- | --- | --- | --- | --- |" + echo "| \`linux-x64\` | \`ubuntu-latest\` | \`$(basename "$LINUX_JAR")\` | \`$LINUX_SHA\` | Published |" + echo "| \`linux-arm64\` | \`ubuntu-24.04-arm\` | \`$(basename "${{ steps.linux-arm64-artifact.outputs.linux_arm64_jar }}")\` | \`${{ steps.linux-arm64-artifact.outputs.linux_arm64_sha }}\` | Published |" + echo "| \`win32-x64\` | \`windows-latest\` | \`$(basename "${{ steps.windows-artifact.outputs.windows_jar }}")\` | \`${{ steps.windows-artifact.outputs.windows_sha }}\` | Published |" + echo "| \`win32-arm64\` | \`windows-11-arm\` | \`$(basename "${{ steps.windows-arm64-artifact.outputs.windows_arm64_jar }}")\` | \`${{ steps.windows-arm64-artifact.outputs.windows_arm64_sha }}\` | Published |" + echo "| \`darwin-arm64\` | \`macos-26\` | \`$(basename "${{ steps.darwin-artifact.outputs.darwin_jar }}")\` | \`${{ steps.darwin-artifact.outputs.darwin_sha }}\` | Published |" + } >> "$GITHUB_STEP_SUMMARY" + env: + MAVEN_USERNAME: ${{ secrets.JAVA_MAVEN_CENTRAL_USERNAME }} + MAVEN_PASSWORD: ${{ secrets.JAVA_MAVEN_CENTRAL_PASSWORD }} + JAVA_GPG_PASSPHRASE: ${{ secrets.JAVA_GPG_PASSPHRASE }} + + rollback-release: + name: Roll back failed Java release preparation + needs: + [ + prepare-release, + build-linux-arm64-classifier, + build-windows-classifier, + build-windows-arm64-classifier, + build-darwin-classifier, + deploy-maven, + ] + if: ${{ failure() && needs.prepare-release.outputs.docs_commit != '' }} runs-on: ubuntu-latest + permissions: + contents: write defaults: run: shell: bash @@ -273,61 +641,127 @@ jobs: - uses: actions/checkout@de0fac2e4500dabe0009e67214ff5f5447ce83dd # v6.0.2 with: fetch-depth: 0 - - name: Create GitHub Release + token: ${{ secrets.JAVA_RELEASE_TOKEN }} + + - name: Safely revert release commits and tag + env: + DOCS_COMMIT: ${{ needs.prepare-release.outputs.docs_commit }} + PREPARE_RESULT: ${{ needs.prepare-release.result }} + PRE_PREPARE_COMMIT: ${{ needs.prepare-release.outputs.pre_prepare_commit }} + POST_PREPARE_COMMIT: ${{ needs.prepare-release.outputs.post_prepare_commit }} + RELEASE_TAG: java/v${{ needs.prepare-release.outputs.release_version }} + TAG_COMMIT: ${{ needs.prepare-release.outputs.tag_commit }} 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 + set -euo pipefail + git config user.name "github-actions[bot]" + git config user.email "github-actions[bot]@users.noreply.github.com" + git fetch origin main --tags + MAIN_COMMIT=$(git rev-parse origin/main) + echo "Rollback inspection: main=$MAIN_COMMIT docs=$DOCS_COMMIT pre=$PRE_PREPARE_COMMIT post=$POST_PREPARE_COMMIT tag=$RELEASE_TAG" + + unsafe_rollback() { + echo "::error::Unsafe rollback state: $*" >&2 + exit 1 + } + + if ! git cat-file -e "${PRE_PREPARE_COMMIT}^{commit}"; then + unsafe_rollback "Recorded pre-prepare commit does not exist: $PRE_PREPARE_COMMIT" + fi + if ! git cat-file -e "${DOCS_COMMIT}^{commit}"; then + unsafe_rollback "Recorded documentation commit does not exist: $DOCS_COMMIT" + fi + if ! git merge-base --is-ancestor "$PRE_PREPARE_COMMIT" "$MAIN_COMMIT"; then + unsafe_rollback "Recorded pre-prepare commit is not an ancestor of main." + fi + if [ "$(git rev-parse "${DOCS_COMMIT}^")" != "$PRE_PREPARE_COMMIT" ]; then + unsafe_rollback "Documentation commit is not immediately based on the recorded pre-prepare commit." fi - # Generate release notes from template - export VERSION GROUP_ID ARTIFACT_ID - RELEASE_NOTES=$(envsubst < $GITHUB_WORKSPACE/.github/workflows/java.notes.template) + mapfile -t ROLLBACK_COMMITS < <(git rev-list --reverse "$PRE_PREPARE_COMMIT..$MAIN_COMMIT") + FIRST_PARENT_COUNT=$(git rev-list --count --first-parent "$PRE_PREPARE_COMMIT..$MAIN_COMMIT") + if [ "${#ROLLBACK_COMMITS[@]}" -ne "$FIRST_PARENT_COUNT" ]; then + unsafe_rollback "Release range contains merged history." + fi + if [ "${#ROLLBACK_COMMITS[@]}" -lt 1 ] || [ "${#ROLLBACK_COMMITS[@]}" -gt 3 ]; then + unsafe_rollback "Expected one to three release-preparation commits after the recorded base; found ${#ROLLBACK_COMMITS[@]}." + fi + if [ "${ROLLBACK_COMMITS[0]}" != "$DOCS_COMMIT" ]; then + unsafe_rollback "The first commit after the recorded base is not the recorded documentation commit." + fi - # 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) + EXPECTED_PARENT="$PRE_PREPARE_COMMIT" + for COMMIT in "${ROLLBACK_COMMITS[@]}"; do + if git rev-parse -q --verify "${COMMIT}^2" >/dev/null; then + unsafe_rollback "Release range contains merge commit $COMMIT." + fi + if [ "$(git rev-parse "${COMMIT}^")" != "$EXPECTED_PARENT" ]; then + unsafe_rollback "Release range is not a linear continuation of the recorded base." + fi + EXPECTED_PARENT="$COMMIT" + done - echo "Current tag: ${CURRENT_TAG}" - echo "Previous tag: ${PREV_TAG}" + RELEASE_VERSION="${RELEASE_TAG#java/v}" + if [ "$(git log -1 --format=%s "$DOCS_COMMIT")" != "docs: update version references to $RELEASE_VERSION" ]; then + unsafe_rollback "Recorded documentation commit has an unexpected subject." + fi - # 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") + RELEASE_PREPARE_COMMIT="" + if [ "${#ROLLBACK_COMMITS[@]}" -ge 2 ]; then + RELEASE_PREPARE_COMMIT="${ROLLBACK_COMMITS[1]}" + if [ "$(git log -1 --format=%s "$RELEASE_PREPARE_COMMIT")" != "[maven-release-plugin] prepare release $RELEASE_TAG" ]; then + unsafe_rollback "Release-version commit has an unexpected subject." + fi + fi + if [ "${#ROLLBACK_COMMITS[@]}" -eq 3 ] && [ "$(git log -1 --format=%s "${ROLLBACK_COMMITS[2]}")" != "[maven-release-plugin] prepare for next development iteration" ]; then + unsafe_rollback "Development-version commit has an unexpected subject." + fi - if [ -n "$PREV_TAG" ]; then - GH_ARGS+=("--notes-start-tag" "$PREV_TAG") + TAG_OBJECT=$(git ls-remote --refs origin "refs/tags/$RELEASE_TAG" | awk '{print $1}') + if [ -n "$TAG_OBJECT" ]; then + git fetch --no-tags origin "+refs/tags/$RELEASE_TAG:refs/tags/$RELEASE_TAG" + REMOTE_TAG_COMMIT=$(git rev-parse "${RELEASE_TAG}^{commit}") + if [ -z "$RELEASE_PREPARE_COMMIT" ] || [ "$REMOTE_TAG_COMMIT" != "$RELEASE_PREPARE_COMMIT" ]; then + unsafe_rollback "Release tag does not point to the guarded release-version commit." + fi + elif [ -n "$TAG_COMMIT" ]; then + unsafe_rollback "Recorded release tag is absent from the remote." fi - ${{ inputs.prerelease == true && 'GH_ARGS+=("--prerelease")' || '' }} + if [ "$PREPARE_RESULT" = "success" ]; then + if [ -z "$POST_PREPARE_COMMIT" ] || [ -z "$TAG_COMMIT" ]; then + unsafe_rollback "Successful preparation did not record its immutable release identity." + fi + if [ "$MAIN_COMMIT" != "$POST_PREPARE_COMMIT" ]; then + unsafe_rollback "main has advanced beyond the recorded post-prepare commit." + fi + if [ -z "$TAG_OBJECT" ] || [ "$REMOTE_TAG_COMMIT" != "$TAG_COMMIT" ]; then + unsafe_rollback "Remote release tag does not match the recorded tag commit." + fi + fi - 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 }}" - env: - GITHUB_TOKEN: ${{ secrets.JAVA_RELEASE_GITHUB_TOKEN }} + git checkout -B release-rollback "$MAIN_COMMIT" + git revert --no-edit "$PRE_PREPARE_COMMIT..$MAIN_COMMIT" + if [ -n "$TAG_OBJECT" ]; then + git push --atomic \ + "--force-with-lease=refs/heads/main:$MAIN_COMMIT" \ + "--force-with-lease=refs/tags/$RELEASE_TAG:$TAG_OBJECT" \ + origin HEAD:refs/heads/main ":refs/tags/$RELEASE_TAG" + else + git push \ + "--force-with-lease=refs/heads/main:$MAIN_COMMIT" \ + origin HEAD:refs/heads/main + fi + echo "Release preparation rollback completed after guarded history inspection." deploy-site: name: Deploy Documentation Site - needs: [preflight, publish-maven, github-release] - if: github.ref == 'refs/heads/main' + needs: [preflight, deploy-maven] + if: github.ref == 'refs/heads/main' && needs.deploy-maven.outputs.published == 'true' runs-on: ubuntu-latest steps: - name: Trigger site deployment on standalone repo run: | - VERSION="${{ needs.publish-maven.outputs.version }}" + VERSION="${{ needs.deploy-maven.outputs.version }}" TAG="java/v${VERSION}" PUBLISH_AS_LATEST=true if [ "${{ inputs.prerelease }}" = "true" ]; then @@ -339,7 +773,9 @@ jobs: -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 + { + echo "### Site Deployment" + 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-publish-snapshot.yml b/.github/workflows/java-publish-snapshot.yml index 8c957627ff..c0a894dca0 100644 --- a/.github/workflows/java-publish-snapshot.yml +++ b/.github/workflows/java-publish-snapshot.yml @@ -16,8 +16,282 @@ concurrency: cancel-in-progress: false jobs: - publish-snapshot: + resolve-source: + name: Resolve immutable snapshot source + runs-on: ubuntu-latest + outputs: + source_sha: ${{ steps.source.outputs.sha }} + steps: + - uses: actions/checkout@de0fac2e4500dabe0009e67214ff5f5447ce83dd # v6.0.2 + with: + ref: ${{ github.sha }} + fetch-depth: 1 + persist-credentials: false + + - id: source + shell: bash + run: | + SHA=$(git rev-parse HEAD) + echo "sha=$SHA" >> "$GITHUB_OUTPUT" + + build-linux-arm64-classifier: + name: Build Linux ARM64 snapshot classifier + needs: resolve-source + runs-on: ubuntu-24.04-arm + permissions: + contents: read + outputs: + version: ${{ steps.build.outputs.version }} + defaults: + run: + shell: bash + working-directory: ./java + steps: + - uses: actions/checkout@de0fac2e4500dabe0009e67214ff5f5447ce83dd # v6.0.2 + with: + ref: ${{ github.sha }} + fetch-depth: 1 + 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: Build and validate linux-arm64 classifier + id: build + run: | + set -euo pipefail + SOURCE_COMMIT=$(git rev-parse HEAD) + if [ "$SOURCE_COMMIT" != "${{ needs.resolve-source.outputs.source_sha }}" ]; then + echo "::error::Checked out $SOURCE_COMMIT instead of the resolved snapshot source." + exit 1 + fi + node copilot-native/scripts/validate-native-host.mjs linux-arm64 + mvn -B -pl copilot-native package -DskipTests -Dcopilot.native.libc=glibc + VERSION=$(mvn help:evaluate -Dexpression=project.version -q -DforceStdout) + JAR="copilot-native/target/copilot-sdk-java-runtime-$VERSION-linux-arm64.jar" + PRIMARY_JAR="copilot-native/target/copilot-sdk-java-runtime-$VERSION.jar" + test -f "$JAR" + node copilot-native/scripts/validate-native-artifact.mjs \ + classifier linux-arm64 "$JAR" "$(basename "$JAR")" .. + node copilot-native/scripts/validate-native-artifact.mjs placeholder "$PRIMARY_JAR" + MANIFEST="copilot-native/target/linux-arm64-$VERSION.sha256" + HASH=$(sha256sum "$JAR" | cut -d ' ' -f 1) + printf '%s %s' "$HASH" "$(basename "$JAR")" > "$MANIFEST" + node copilot-native/scripts/validate-native-artifact.mjs \ + checksum "$JAR" "$MANIFEST" "$(basename "$JAR")" + echo "version=$VERSION" >> "$GITHUB_OUTPUT" + + - uses: actions/upload-artifact@043fb46d1a93c77aae656e7c1c64a875d1fc6a0a # v7 + with: + name: java-native-linux-arm64-snapshot-${{ github.run_id }}-${{ github.run_attempt }} + path: | + java/copilot-native/target/copilot-sdk-java-runtime-${{ steps.build.outputs.version }}-linux-arm64.jar + java/copilot-native/target/linux-arm64-${{ steps.build.outputs.version }}.sha256 + if-no-files-found: error + retention-days: 1 + + build-windows-classifier: + name: Build Windows snapshot classifier + needs: resolve-source + runs-on: windows-latest + permissions: + contents: read + outputs: + version: ${{ steps.build.outputs.version }} + defaults: + run: + shell: pwsh + working-directory: ./java + steps: + - uses: actions/checkout@de0fac2e4500dabe0009e67214ff5f5447ce83dd # v6.0.2 + with: + ref: ${{ github.sha }} + fetch-depth: 1 + 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: Build and validate win32-x64 classifier + id: build + run: | + $sourceCommit = git rev-parse HEAD + if ($sourceCommit -ne '${{ needs.resolve-source.outputs.source_sha }}') { + throw "Checked out $sourceCommit instead of the resolved snapshot source." + } + node copilot-native/scripts/validate-native-host.mjs win32-x64 + mvn -B -pl copilot-native package -DskipTests + $version = mvn help:evaluate "-Dexpression=project.version" -q "-DforceStdout" + $jar = "copilot-native/target/copilot-sdk-java-runtime-$version-win32-x64.jar" + $primaryJar = "copilot-native/target/copilot-sdk-java-runtime-$version.jar" + if (-not (Test-Path -LiteralPath $jar -PathType Leaf)) { + throw "Expected Windows classifier was not produced: $jar" + } + node copilot-native/scripts/validate-native-artifact.mjs classifier win32-x64 $jar ([IO.Path]::GetFileName($jar)) .. + node copilot-native/scripts/validate-native-artifact.mjs placeholder $primaryJar + $manifest = "copilot-native/target/win32-x64-$version.sha256" + $hash = (Get-FileHash -Algorithm SHA256 -LiteralPath $jar).Hash.ToLowerInvariant() + "$hash $([IO.Path]::GetFileName($jar))" | Set-Content -NoNewline -Encoding ascii $manifest + node copilot-native/scripts/validate-native-artifact.mjs checksum $jar $manifest ([IO.Path]::GetFileName($jar)) + "version=$version" | Add-Content $env:GITHUB_OUTPUT + + - uses: actions/upload-artifact@043fb46d1a93c77aae656e7c1c64a875d1fc6a0a # v7 + with: + name: java-native-win32-x64-snapshot-${{ github.run_id }}-${{ github.run_attempt }} + path: | + java/copilot-native/target/copilot-sdk-java-runtime-${{ steps.build.outputs.version }}-win32-x64.jar + java/copilot-native/target/win32-x64-${{ steps.build.outputs.version }}.sha256 + if-no-files-found: error + retention-days: 1 + + build-windows-arm64-classifier: + name: Build Windows ARM64 snapshot classifier + needs: resolve-source + runs-on: windows-11-arm + permissions: + contents: read + outputs: + version: ${{ steps.build.outputs.version }} + defaults: + run: + shell: pwsh + working-directory: ./java + steps: + - uses: actions/checkout@de0fac2e4500dabe0009e67214ff5f5447ce83dd # v6.0.2 + with: + ref: ${{ github.sha }} + fetch-depth: 1 + 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: Build and validate win32-arm64 classifier + id: build + run: | + $sourceCommit = git rev-parse HEAD + if ($sourceCommit -ne '${{ needs.resolve-source.outputs.source_sha }}') { + throw "Checked out $sourceCommit instead of the resolved snapshot source." + } + node copilot-native/scripts/validate-native-host.mjs win32-arm64 + mvn -B -pl copilot-native package -DskipTests + $version = mvn help:evaluate "-Dexpression=project.version" -q "-DforceStdout" + $jar = "copilot-native/target/copilot-sdk-java-runtime-$version-win32-arm64.jar" + $primaryJar = "copilot-native/target/copilot-sdk-java-runtime-$version.jar" + if (-not (Test-Path -LiteralPath $jar -PathType Leaf)) { + throw "Expected Windows ARM64 classifier was not produced: $jar" + } + node copilot-native/scripts/validate-native-artifact.mjs classifier win32-arm64 $jar ([IO.Path]::GetFileName($jar)) .. + node copilot-native/scripts/validate-native-artifact.mjs placeholder $primaryJar + $manifest = "copilot-native/target/win32-arm64-$version.sha256" + $hash = (Get-FileHash -Algorithm SHA256 -LiteralPath $jar).Hash.ToLowerInvariant() + "$hash $([IO.Path]::GetFileName($jar))" | Set-Content -NoNewline -Encoding ascii $manifest + node copilot-native/scripts/validate-native-artifact.mjs checksum $jar $manifest ([IO.Path]::GetFileName($jar)) + "version=$version" | Add-Content $env:GITHUB_OUTPUT + + - uses: actions/upload-artifact@043fb46d1a93c77aae656e7c1c64a875d1fc6a0a # v7 + with: + name: java-native-win32-arm64-snapshot-${{ github.run_id }}-${{ github.run_attempt }} + path: | + java/copilot-native/target/copilot-sdk-java-runtime-${{ steps.build.outputs.version }}-win32-arm64.jar + java/copilot-native/target/win32-arm64-${{ steps.build.outputs.version }}.sha256 + if-no-files-found: error + retention-days: 1 + + build-darwin-classifier: + name: Build Darwin snapshot classifier + needs: resolve-source + runs-on: macos-26 + permissions: + contents: read + outputs: + version: ${{ steps.build.outputs.version }} + defaults: + run: + shell: bash + working-directory: ./java + steps: + - uses: actions/checkout@de0fac2e4500dabe0009e67214ff5f5447ce83dd # v6.0.2 + with: + ref: ${{ github.sha }} + fetch-depth: 1 + 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: Build and validate darwin-arm64 classifier + id: build + run: | + set -euo pipefail + SOURCE_COMMIT=$(git rev-parse HEAD) + if [ "$SOURCE_COMMIT" != "${{ needs.resolve-source.outputs.source_sha }}" ]; then + echo "::error::Checked out $SOURCE_COMMIT instead of the resolved snapshot source." + exit 1 + fi + node copilot-native/scripts/validate-native-host.mjs darwin-arm64 + mvn -B -pl copilot-native package -DskipTests + VERSION=$(mvn help:evaluate -Dexpression=project.version -q -DforceStdout) + JAR="copilot-native/target/copilot-sdk-java-runtime-$VERSION-darwin-arm64.jar" + PRIMARY_JAR="copilot-native/target/copilot-sdk-java-runtime-$VERSION.jar" + test -f "$JAR" + node copilot-native/scripts/validate-native-artifact.mjs \ + classifier darwin-arm64 "$JAR" "$(basename "$JAR")" .. + node copilot-native/scripts/validate-native-artifact.mjs placeholder "$PRIMARY_JAR" + MANIFEST="copilot-native/target/darwin-arm64-$VERSION.sha256" + HASH=$(shasum -a 256 "$JAR" | cut -d ' ' -f 1) + printf '%s %s' "$HASH" "$(basename "$JAR")" > "$MANIFEST" + node copilot-native/scripts/validate-native-artifact.mjs \ + checksum "$JAR" "$MANIFEST" "$(basename "$JAR")" + echo "version=$VERSION" >> "$GITHUB_OUTPUT" + + - uses: actions/upload-artifact@043fb46d1a93c77aae656e7c1c64a875d1fc6a0a # v7 + with: + name: java-native-darwin-arm64-snapshot-${{ github.run_id }}-${{ github.run_attempt }} + path: | + java/copilot-native/target/copilot-sdk-java-runtime-${{ steps.build.outputs.version }}-darwin-arm64.jar + java/copilot-native/target/darwin-arm64-${{ steps.build.outputs.version }}.sha256 + if-no-files-found: error + retention-days: 1 + + deploy-snapshot: name: Publish SNAPSHOT to Maven Central + needs: + [ + resolve-source, + build-linux-arm64-classifier, + build-windows-classifier, + build-windows-arm64-classifier, + build-darwin-classifier, + ] runs-on: ubuntu-latest defaults: run: @@ -26,12 +300,13 @@ jobs: steps: - uses: actions/checkout@de0fac2e4500dabe0009e67214ff5f5447ce83dd # v6.0.2 with: - fetch-depth: 0 + ref: ${{ github.sha }} + fetch-depth: 1 + persist-credentials: false - uses: ./.github/actions/setup-copilot - - name: Set up JDK 25 - uses: actions/setup-java@be666c2fcd27ec809703dec50e508c2fdc7f6654 # v5 + - uses: actions/setup-java@be666c2fcd27ec809703dec50e508c2fdc7f6654 # v5 with: java-version: "25" distribution: "microsoft" @@ -40,22 +315,182 @@ jobs: server-username: MAVEN_USERNAME server-password: MAVEN_PASSWORD - - name: Verify version is a SNAPSHOT - working-directory: ./java + - uses: actions/setup-node@48b55a011bda9f5d6aeb4c2d9c7362e8dae4041e # v6 + with: + node-version: 22 + + - uses: actions/download-artifact@d3f86a106a0bac45b974a628896c90dbdf5c8093 # v4.3.0 + with: + name: java-native-linux-arm64-snapshot-${{ github.run_id }}-${{ github.run_attempt }} + path: ${{ runner.temp }}/java-native-linux-arm64 + + - uses: actions/download-artifact@d3f86a106a0bac45b974a628896c90dbdf5c8093 # v4.3.0 + with: + name: java-native-win32-x64-snapshot-${{ github.run_id }}-${{ github.run_attempt }} + path: ${{ runner.temp }}/java-native-win32-x64 + + - uses: actions/download-artifact@d3f86a106a0bac45b974a628896c90dbdf5c8093 # v4.3.0 + with: + name: java-native-win32-arm64-snapshot-${{ github.run_id }}-${{ github.run_attempt }} + path: ${{ runner.temp }}/java-native-win32-arm64 + + - uses: actions/download-artifact@d3f86a106a0bac45b974a628896c90dbdf5c8093 # v4.3.0 + with: + name: java-native-darwin-arm64-snapshot-${{ github.run_id }}-${{ github.run_attempt }} + path: ${{ runner.temp }}/java-native-darwin-arm64 + + - name: Verify version, source, and Linux ARM64 classifier + id: linux-arm64-artifact run: | + SOURCE_COMMIT=$(git rev-parse HEAD) + if [ "$SOURCE_COMMIT" != "${{ needs.resolve-source.outputs.source_sha }}" ]; then + echo "::error::Checked out $SOURCE_COMMIT instead of the resolved snapshot source." + exit 1 + fi VERSION=$(mvn help:evaluate -Dexpression=project.version -q -DforceStdout) - echo "Publishing version: $VERSION" if [[ "$VERSION" != *"-SNAPSHOT" ]]; then - echo "ERROR: This workflow only publishes SNAPSHOT versions. Current version: $VERSION" + echo "::error::This workflow only publishes SNAPSHOT versions. Current version: $VERSION" + exit 1 + fi + if [ "$VERSION" != "${{ needs.build-linux-arm64-classifier.outputs.version }}" ]; then + echo "::error::Linux ARM64 classifier version does not match deploy version." exit 1 fi - echo "### Snapshot Publish" >> $GITHUB_STEP_SUMMARY - echo "- **Version:** $VERSION" >> $GITHUB_STEP_SUMMARY - echo "- **Repository:** Maven Central Snapshots" >> $GITHUB_STEP_SUMMARY + ARTIFACT_DIRECTORY="${{ runner.temp }}/java-native-linux-arm64" + JAR="$ARTIFACT_DIRECTORY/copilot-sdk-java-runtime-$VERSION-linux-arm64.jar" + MANIFEST="$ARTIFACT_DIRECTORY/linux-arm64-$VERSION.sha256" + test -f "$JAR" + test -f "$MANIFEST" + node "$GITHUB_WORKSPACE/java/copilot-native/scripts/validate-native-artifact.mjs" \ + checksum "$JAR" "$MANIFEST" "$(basename "$JAR")" + node "$GITHUB_WORKSPACE/java/copilot-native/scripts/validate-native-artifact.mjs" \ + classifier linux-arm64 "$JAR" "$(basename "$JAR")" "$GITHUB_WORKSPACE" + echo "linux_arm64_jar=$JAR" >> "$GITHUB_OUTPUT" + echo "version=$VERSION" >> "$GITHUB_OUTPUT" + echo "linux_arm64_sha=$(cut -d ' ' -f 1 "$MANIFEST")" >> "$GITHUB_OUTPUT" - - name: Deploy Snapshot - working-directory: ./java - run: mvn -B deploy -DskipTests + - name: Verify version, source, and Windows classifier + id: windows-artifact + run: | + SOURCE_COMMIT=$(git rev-parse HEAD) + if [ "$SOURCE_COMMIT" != "${{ needs.resolve-source.outputs.source_sha }}" ]; then + echo "::error::Checked out $SOURCE_COMMIT instead of the resolved snapshot source." + exit 1 + fi + VERSION="${{ steps.linux-arm64-artifact.outputs.version }}" + if [ "$VERSION" != "${{ needs.build-windows-classifier.outputs.version }}" ]; then + echo "::error::Windows classifier version does not match deploy version." + exit 1 + fi + ARTIFACT_DIRECTORY="${{ runner.temp }}/java-native-win32-x64" + JAR="$ARTIFACT_DIRECTORY/copilot-sdk-java-runtime-$VERSION-win32-x64.jar" + MANIFEST="$ARTIFACT_DIRECTORY/win32-x64-$VERSION.sha256" + test -f "$JAR" + test -f "$MANIFEST" + node "$GITHUB_WORKSPACE/java/copilot-native/scripts/validate-native-artifact.mjs" \ + checksum "$JAR" "$MANIFEST" "$(basename "$JAR")" + node "$GITHUB_WORKSPACE/java/copilot-native/scripts/validate-native-artifact.mjs" \ + classifier win32-x64 "$JAR" "$(basename "$JAR")" "$GITHUB_WORKSPACE" + echo "windows_jar=$JAR" >> "$GITHUB_OUTPUT" + echo "version=$VERSION" >> "$GITHUB_OUTPUT" + echo "windows_sha=$(cut -d ' ' -f 1 "$MANIFEST")" >> "$GITHUB_OUTPUT" + + - name: Verify version, source, and Darwin classifier + id: darwin-artifact + run: | + SOURCE_COMMIT=$(git rev-parse HEAD) + if [ "$SOURCE_COMMIT" != "${{ needs.resolve-source.outputs.source_sha }}" ]; then + echo "::error::Checked out $SOURCE_COMMIT instead of the resolved snapshot source." + exit 1 + fi + VERSION="${{ steps.windows-artifact.outputs.version }}" + if [ "$VERSION" != "${{ needs.build-darwin-classifier.outputs.version }}" ]; then + echo "::error::Darwin classifier version does not match deploy version." + exit 1 + fi + ARTIFACT_DIRECTORY="${{ runner.temp }}/java-native-darwin-arm64" + JAR="$ARTIFACT_DIRECTORY/copilot-sdk-java-runtime-$VERSION-darwin-arm64.jar" + MANIFEST="$ARTIFACT_DIRECTORY/darwin-arm64-$VERSION.sha256" + test -f "$JAR" + test -f "$MANIFEST" + node "$GITHUB_WORKSPACE/java/copilot-native/scripts/validate-native-artifact.mjs" \ + checksum "$JAR" "$MANIFEST" "$(basename "$JAR")" + node "$GITHUB_WORKSPACE/java/copilot-native/scripts/validate-native-artifact.mjs" \ + classifier darwin-arm64 "$JAR" "$(basename "$JAR")" "$GITHUB_WORKSPACE" + echo "darwin_jar=$JAR" >> "$GITHUB_OUTPUT" + echo "darwin_sha=$(cut -d ' ' -f 1 "$MANIFEST")" >> "$GITHUB_OUTPUT" + + - name: Verify version, source, and Windows ARM64 classifier + id: windows-arm64-artifact + run: | + SOURCE_COMMIT=$(git rev-parse HEAD) + if [ "$SOURCE_COMMIT" != "${{ needs.resolve-source.outputs.source_sha }}" ]; then + echo "::error::Checked out $SOURCE_COMMIT instead of the resolved snapshot source." + exit 1 + fi + VERSION="${{ steps.windows-artifact.outputs.version }}" + if [ "$VERSION" != "${{ needs.build-windows-arm64-classifier.outputs.version }}" ]; then + echo "::error::Windows ARM64 classifier version does not match deploy version." + exit 1 + fi + ARTIFACT_DIRECTORY="${{ runner.temp }}/java-native-win32-arm64" + JAR="$ARTIFACT_DIRECTORY/copilot-sdk-java-runtime-$VERSION-win32-arm64.jar" + MANIFEST="$ARTIFACT_DIRECTORY/win32-arm64-$VERSION.sha256" + test -f "$JAR" + test -f "$MANIFEST" + node "$GITHUB_WORKSPACE/java/copilot-native/scripts/validate-native-artifact.mjs" \ + checksum "$JAR" "$MANIFEST" "$(basename "$JAR")" + node "$GITHUB_WORKSPACE/java/copilot-native/scripts/validate-native-artifact.mjs" \ + classifier win32-arm64 "$JAR" "$(basename "$JAR")" "$GITHUB_WORKSPACE" + echo "windows_arm64_jar=$JAR" >> "$GITHUB_OUTPUT" + echo "windows_arm64_sha=$(cut -d ' ' -f 1 "$MANIFEST")" >> "$GITHUB_OUTPUT" + + - name: Build Linux classifier and deploy complete snapshot + run: | + VERSION="${{ steps.windows-artifact.outputs.version }}" + mvn -B deploy -DskipTests -Dcopilot.native.libc=glibc \ + "-Dcopilot.native.external.linux.arm64.classifier.path=${{ steps.linux-arm64-artifact.outputs.linux_arm64_jar }}" \ + "-Dcopilot.native.external.win32.classifier.path=${{ steps.windows-artifact.outputs.windows_jar }}" \ + "-Dcopilot.native.external.win32.arm64.classifier.path=${{ steps.windows-arm64-artifact.outputs.windows_arm64_jar }}" \ + "-Dcopilot.native.external.darwin.classifier.path=${{ steps.darwin-artifact.outputs.darwin_jar }}" + LINUX_JAR="copilot-native/target/copilot-sdk-java-runtime-$VERSION-linux-x64.jar" + test -f "$LINUX_JAR" + node copilot-native/scripts/validate-native-artifact.mjs \ + classifier linux-x64 "$LINUX_JAR" "$(basename "$LINUX_JAR")" .. + LINUX_SHA=$(sha256sum "$LINUX_JAR" | cut -d ' ' -f 1) + GROUP_ID=$(mvn -q -pl copilot-native help:evaluate -Dexpression=project.groupId -DforceStdout) + ARTIFACT_ID=$(mvn -q -pl copilot-native help:evaluate -Dexpression=project.artifactId -DforceStdout) + POM_VERSION=$(mvn -q -pl copilot-native help:evaluate -Dexpression=project.version -DforceStdout) + if [ -z "$GROUP_ID" ] || [ -z "$ARTIFACT_ID" ] || [ "$POM_VERSION" != "$VERSION" ]; then + echo "::error::Unexpected copilot-native Maven coordinates: $GROUP_ID:$ARTIFACT_ID:$POM_VERSION (expected version $VERSION)" + exit 1 + fi + { + echo "### Snapshot Publish" + echo "- **Version:** $VERSION" + echo "- **Source commit:** \`${{ needs.resolve-source.outputs.source_sha }}\`" + echo "- **Repository:** Maven Central Snapshots" + echo "" + echo "#### Maven Coordinates" + echo "" + echo '```xml' + echo "" + echo " $GROUP_ID" + echo " $ARTIFACT_ID" + echo " $POM_VERSION" + echo "" + echo '```' + echo "" + echo "#### Published Native Classifiers" + echo "" + echo "| Classifier | Build runner | Artifact | SHA-256 | Status |" + echo "| --- | --- | --- | --- | --- |" + echo "| \`linux-x64\` | \`ubuntu-latest\` | \`$(basename "$LINUX_JAR")\` | \`$LINUX_SHA\` | Published |" + echo "| \`linux-arm64\` | \`ubuntu-24.04-arm\` | \`$(basename "${{ steps.linux-arm64-artifact.outputs.linux_arm64_jar }}")\` | \`${{ steps.linux-arm64-artifact.outputs.linux_arm64_sha }}\` | Published |" + echo "| \`win32-x64\` | \`windows-latest\` | \`$(basename "${{ steps.windows-artifact.outputs.windows_jar }}")\` | \`${{ steps.windows-artifact.outputs.windows_sha }}\` | Published |" + echo "| \`win32-arm64\` | \`windows-11-arm\` | \`$(basename "${{ steps.windows-arm64-artifact.outputs.windows_arm64_jar }}")\` | \`${{ steps.windows-arm64-artifact.outputs.windows_arm64_sha }}\` | Published |" + echo "| \`darwin-arm64\` | \`macos-26\` | \`$(basename "${{ steps.darwin-artifact.outputs.darwin_jar }}")\` | \`${{ steps.darwin-artifact.outputs.darwin_sha }}\` | Published |" + } >> "$GITHUB_STEP_SUMMARY" env: MAVEN_USERNAME: ${{ secrets.JAVA_MAVEN_CENTRAL_USERNAME }} MAVEN_PASSWORD: ${{ secrets.JAVA_MAVEN_CENTRAL_PASSWORD }} diff --git a/.github/workflows/java-sdk-tests.yml b/.github/workflows/java-sdk-tests.yml index c92b5291a3..36310d26b5 100644 --- a/.github/workflows/java-sdk-tests.yml +++ b/.github/workflows/java-sdk-tests.yml @@ -17,6 +17,407 @@ permissions: contents: read jobs: + java-sdk-inprocess: + name: "Java SDK InProcess Tests (${{ matrix.classifier }})" + if: github.event.repository.fork == false + strategy: + fail-fast: false + matrix: + include: + - os: ubuntu-latest + classifier: linux-x64 + - os: ubuntu-24.04-arm + classifier: linux-arm64 + maven-args: -Dcopilot.native.libc=glibc + - os: windows-latest + classifier: win32-x64 + - os: windows-11-arm + classifier: win32-arm64 + - os: macos-26 + classifier: darwin-arm64 + runs-on: ${{ matrix.os }} + defaults: + run: + 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: Validate native host + run: node copilot-native/scripts/validate-native-host.mjs ${{ matrix.classifier }} + + - name: Run Java SDK tests (InProcess) + env: + CI: "true" + run: mvn clean verify -Pinprocess ${{ matrix.maven-args }} + + - 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-${{ matrix.classifier }} + path: | + java/sdk/target/surefire-reports/ + java/sdk/target/surefire-reports-isolated/ + java/sdk/target/failsafe-reports/ + retention-days: 7 + + java-native-publication-linux-arm64: + name: "Java Native Publication Input (linux-arm64)" + if: github.event.repository.fork == false + runs-on: ubuntu-24.04-arm + permissions: + contents: read + outputs: + source_sha: ${{ steps.build.outputs.source_sha }} + version: ${{ steps.build.outputs.version }} + 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: Build and validate linux-arm64 classifier + id: build + run: | + set -euo pipefail + node copilot-native/scripts/validate-native-host.mjs linux-arm64 + mvn -B -pl copilot-native package -DskipTests -Dcopilot.native.libc=glibc + VERSION=$(mvn help:evaluate -Dexpression=project.version -q -DforceStdout) + JAR="copilot-native/target/copilot-sdk-java-runtime-$VERSION-linux-arm64.jar" + PRIMARY_JAR="copilot-native/target/copilot-sdk-java-runtime-$VERSION.jar" + test -f "$JAR" + node copilot-native/scripts/validate-native-artifact.mjs \ + classifier linux-arm64 "$JAR" "$(basename "$JAR")" .. + node copilot-native/scripts/validate-native-artifact.mjs placeholder "$PRIMARY_JAR" + MANIFEST="copilot-native/target/linux-arm64-$VERSION.sha256" + HASH=$(sha256sum "$JAR" | cut -d ' ' -f 1) + printf '%s %s' "$HASH" "$(basename "$JAR")" > "$MANIFEST" + node copilot-native/scripts/validate-native-artifact.mjs \ + checksum "$JAR" "$MANIFEST" "$(basename "$JAR")" + echo "source_sha=$(git rev-parse HEAD)" >> "$GITHUB_OUTPUT" + echo "version=$VERSION" >> "$GITHUB_OUTPUT" + + - uses: actions/upload-artifact@043fb46d1a93c77aae656e7c1c64a875d1fc6a0a # v7 + with: + name: java-native-publication-linux-arm64-${{ github.run_id }}-${{ github.run_attempt }} + path: | + java/copilot-native/target/copilot-sdk-java-runtime-${{ steps.build.outputs.version }}-linux-arm64.jar + java/copilot-native/target/linux-arm64-${{ steps.build.outputs.version }}.sha256 + if-no-files-found: error + retention-days: 1 + + java-native-publication-windows: + name: "Java Native Publication Input (win32-x64)" + if: github.event.repository.fork == false + runs-on: windows-latest + permissions: + contents: read + outputs: + source_sha: ${{ steps.build.outputs.source_sha }} + version: ${{ steps.build.outputs.version }} + defaults: + run: + shell: pwsh + 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: Build and validate win32-x64 classifier + id: build + run: | + node copilot-native/scripts/validate-native-host.mjs win32-x64 + mvn -B -pl copilot-native package -DskipTests + $version = mvn help:evaluate "-Dexpression=project.version" -q "-DforceStdout" + $jar = "copilot-native/target/copilot-sdk-java-runtime-$version-win32-x64.jar" + $primaryJar = "copilot-native/target/copilot-sdk-java-runtime-$version.jar" + if (-not (Test-Path -LiteralPath $jar -PathType Leaf)) { + throw "Expected Windows classifier was not produced: $jar" + } + node copilot-native/scripts/validate-native-artifact.mjs classifier win32-x64 $jar ([IO.Path]::GetFileName($jar)) .. + node copilot-native/scripts/validate-native-artifact.mjs placeholder $primaryJar + $manifest = "copilot-native/target/win32-x64-$version.sha256" + $hash = (Get-FileHash -Algorithm SHA256 -LiteralPath $jar).Hash.ToLowerInvariant() + "$hash $([IO.Path]::GetFileName($jar))" | Set-Content -NoNewline -Encoding ascii $manifest + node copilot-native/scripts/validate-native-artifact.mjs checksum $jar $manifest ([IO.Path]::GetFileName($jar)) + echo "source_sha=$(git rev-parse HEAD)" >> $env:GITHUB_OUTPUT + echo "version=$version" >> $env:GITHUB_OUTPUT + + - uses: actions/upload-artifact@043fb46d1a93c77aae656e7c1c64a875d1fc6a0a # v7 + with: + name: java-native-publication-win32-x64-${{ github.run_id }}-${{ github.run_attempt }} + path: | + java/copilot-native/target/copilot-sdk-java-runtime-${{ steps.build.outputs.version }}-win32-x64.jar + java/copilot-native/target/win32-x64-${{ steps.build.outputs.version }}.sha256 + if-no-files-found: error + retention-days: 1 + + java-native-publication-windows-arm64: + name: "Java Native Publication Input (win32-arm64)" + if: github.event.repository.fork == false + runs-on: windows-11-arm + permissions: + contents: read + outputs: + source_sha: ${{ steps.build.outputs.source_sha }} + version: ${{ steps.build.outputs.version }} + defaults: + run: + shell: pwsh + 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: Build and validate win32-arm64 classifier + id: build + run: | + node copilot-native/scripts/validate-native-host.mjs win32-arm64 + mvn -B -pl copilot-native package -DskipTests + $version = mvn help:evaluate "-Dexpression=project.version" -q "-DforceStdout" + $jar = "copilot-native/target/copilot-sdk-java-runtime-$version-win32-arm64.jar" + $primaryJar = "copilot-native/target/copilot-sdk-java-runtime-$version.jar" + if (-not (Test-Path -LiteralPath $jar -PathType Leaf)) { + throw "Expected Windows ARM64 classifier was not produced: $jar" + } + node copilot-native/scripts/validate-native-artifact.mjs classifier win32-arm64 $jar ([IO.Path]::GetFileName($jar)) .. + node copilot-native/scripts/validate-native-artifact.mjs placeholder $primaryJar + $manifest = "copilot-native/target/win32-arm64-$version.sha256" + $hash = (Get-FileHash -Algorithm SHA256 -LiteralPath $jar).Hash.ToLowerInvariant() + "$hash $([IO.Path]::GetFileName($jar))" | Set-Content -NoNewline -Encoding ascii $manifest + node copilot-native/scripts/validate-native-artifact.mjs checksum $jar $manifest ([IO.Path]::GetFileName($jar)) + echo "source_sha=$(git rev-parse HEAD)" >> $env:GITHUB_OUTPUT + echo "version=$version" >> $env:GITHUB_OUTPUT + + - uses: actions/upload-artifact@043fb46d1a93c77aae656e7c1c64a875d1fc6a0a # v7 + with: + name: java-native-publication-win32-arm64-${{ github.run_id }}-${{ github.run_attempt }} + path: | + java/copilot-native/target/copilot-sdk-java-runtime-${{ steps.build.outputs.version }}-win32-arm64.jar + java/copilot-native/target/win32-arm64-${{ steps.build.outputs.version }}.sha256 + if-no-files-found: error + retention-days: 1 + + java-native-publication-darwin: + name: "Java Native Publication Input (darwin-arm64)" + if: github.event.repository.fork == false + runs-on: macos-26 + permissions: + contents: read + outputs: + source_sha: ${{ steps.build.outputs.source_sha }} + version: ${{ steps.build.outputs.version }} + 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: Build and validate darwin-arm64 classifier + id: build + run: | + set -euo pipefail + node copilot-native/scripts/validate-native-host.mjs darwin-arm64 + mvn -B -pl copilot-native package -DskipTests + VERSION=$(mvn help:evaluate -Dexpression=project.version -q -DforceStdout) + JAR="copilot-native/target/copilot-sdk-java-runtime-$VERSION-darwin-arm64.jar" + PRIMARY_JAR="copilot-native/target/copilot-sdk-java-runtime-$VERSION.jar" + test -f "$JAR" + node copilot-native/scripts/validate-native-artifact.mjs \ + classifier darwin-arm64 "$JAR" "$(basename "$JAR")" .. + node copilot-native/scripts/validate-native-artifact.mjs placeholder "$PRIMARY_JAR" + MANIFEST="copilot-native/target/darwin-arm64-$VERSION.sha256" + HASH=$(shasum -a 256 "$JAR" | cut -d ' ' -f 1) + printf '%s %s' "$HASH" "$(basename "$JAR")" > "$MANIFEST" + node copilot-native/scripts/validate-native-artifact.mjs \ + checksum "$JAR" "$MANIFEST" "$(basename "$JAR")" + echo "source_sha=$(git rev-parse HEAD)" >> "$GITHUB_OUTPUT" + echo "version=$VERSION" >> "$GITHUB_OUTPUT" + + - uses: actions/upload-artifact@043fb46d1a93c77aae656e7c1c64a875d1fc6a0a # v7 + with: + name: java-native-publication-darwin-arm64-${{ github.run_id }}-${{ github.run_attempt }} + path: | + java/copilot-native/target/copilot-sdk-java-runtime-${{ steps.build.outputs.version }}-darwin-arm64.jar + java/copilot-native/target/darwin-arm64-${{ steps.build.outputs.version }}.sha256 + if-no-files-found: error + retention-days: 1 + + java-native-publication-assembly: + name: "Java Native Publication Assembly" + if: github.event.repository.fork == false + needs: + [ + java-native-publication-linux-arm64, + java-native-publication-windows, + java-native-publication-windows-arm64, + java-native-publication-darwin, + ] + runs-on: ubuntu-latest + defaults: + run: + shell: bash + working-directory: ./java + steps: + - uses: actions/checkout@de0fac2e4500dabe0009e67214ff5f5447ce83dd # v6.0.2 + with: + ref: ${{ github.sha }} + 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 + + - uses: actions/download-artifact@d3f86a106a0bac45b974a628896c90dbdf5c8093 # v4.3.0 + with: + name: java-native-publication-linux-arm64-${{ github.run_id }}-${{ github.run_attempt }} + path: ${{ github.workspace }}/java/native-publication-input/linux-arm64 + + - uses: actions/download-artifact@d3f86a106a0bac45b974a628896c90dbdf5c8093 # v4.3.0 + with: + name: java-native-publication-win32-x64-${{ github.run_id }}-${{ github.run_attempt }} + path: ${{ github.workspace }}/java/native-publication-input/windows + + - uses: actions/download-artifact@d3f86a106a0bac45b974a628896c90dbdf5c8093 # v4.3.0 + with: + name: java-native-publication-win32-arm64-${{ github.run_id }}-${{ github.run_attempt }} + path: ${{ github.workspace }}/java/native-publication-input/windows-arm64 + + - uses: actions/download-artifact@d3f86a106a0bac45b974a628896c90dbdf5c8093 # v4.3.0 + with: + name: java-native-publication-darwin-arm64-${{ github.run_id }}-${{ github.run_attempt }} + path: ${{ github.workspace }}/java/native-publication-input/darwin + + - name: Verify native inputs and deploy the complete local release + run: | + set -euo pipefail + test "$(git rev-parse HEAD)" = "${{ needs.java-native-publication-linux-arm64.outputs.source_sha }}" + test "$(git rev-parse HEAD)" = "${{ needs.java-native-publication-windows.outputs.source_sha }}" + test "$(git rev-parse HEAD)" = "${{ needs.java-native-publication-windows-arm64.outputs.source_sha }}" + test "$(git rev-parse HEAD)" = "${{ needs.java-native-publication-darwin.outputs.source_sha }}" + VERSION="${{ needs.java-native-publication-windows.outputs.version }}" + test "$VERSION" = "${{ needs.java-native-publication-linux-arm64.outputs.version }}" + test "$VERSION" = "${{ needs.java-native-publication-windows-arm64.outputs.version }}" + test "$VERSION" = "${{ needs.java-native-publication-darwin.outputs.version }}" + LINUX_ARM64_DIRECTORY="$GITHUB_WORKSPACE/java/native-publication-input/linux-arm64" + WINDOWS_DIRECTORY="$GITHUB_WORKSPACE/java/native-publication-input/windows" + WINDOWS_ARM64_DIRECTORY="$GITHUB_WORKSPACE/java/native-publication-input/windows-arm64" + DARWIN_DIRECTORY="$GITHUB_WORKSPACE/java/native-publication-input/darwin" + LINUX_ARM64_JAR="$LINUX_ARM64_DIRECTORY/copilot-sdk-java-runtime-$VERSION-linux-arm64.jar" + LINUX_ARM64_MANIFEST="$LINUX_ARM64_DIRECTORY/linux-arm64-$VERSION.sha256" + WINDOWS_JAR="$WINDOWS_DIRECTORY/copilot-sdk-java-runtime-$VERSION-win32-x64.jar" + WINDOWS_MANIFEST="$WINDOWS_DIRECTORY/win32-x64-$VERSION.sha256" + WINDOWS_ARM64_JAR="$WINDOWS_ARM64_DIRECTORY/copilot-sdk-java-runtime-$VERSION-win32-arm64.jar" + WINDOWS_ARM64_MANIFEST="$WINDOWS_ARM64_DIRECTORY/win32-arm64-$VERSION.sha256" + DARWIN_JAR="$DARWIN_DIRECTORY/copilot-sdk-java-runtime-$VERSION-darwin-arm64.jar" + DARWIN_MANIFEST="$DARWIN_DIRECTORY/darwin-arm64-$VERSION.sha256" + node copilot-native/scripts/validate-native-artifact.mjs \ + checksum "$LINUX_ARM64_JAR" "$LINUX_ARM64_MANIFEST" "$(basename "$LINUX_ARM64_JAR")" + node copilot-native/scripts/validate-native-artifact.mjs \ + classifier linux-arm64 "$LINUX_ARM64_JAR" "$(basename "$LINUX_ARM64_JAR")" .. + node copilot-native/scripts/validate-native-artifact.mjs \ + checksum "$WINDOWS_JAR" "$WINDOWS_MANIFEST" "$(basename "$WINDOWS_JAR")" + node copilot-native/scripts/validate-native-artifact.mjs \ + classifier win32-x64 "$WINDOWS_JAR" "$(basename "$WINDOWS_JAR")" .. + node copilot-native/scripts/validate-native-artifact.mjs \ + checksum "$WINDOWS_ARM64_JAR" "$WINDOWS_ARM64_MANIFEST" "$(basename "$WINDOWS_ARM64_JAR")" + node copilot-native/scripts/validate-native-artifact.mjs \ + classifier win32-arm64 "$WINDOWS_ARM64_JAR" "$(basename "$WINDOWS_ARM64_JAR")" .. + node copilot-native/scripts/validate-native-artifact.mjs \ + checksum "$DARWIN_JAR" "$DARWIN_MANIFEST" "$(basename "$DARWIN_JAR")" + node copilot-native/scripts/validate-native-artifact.mjs \ + classifier darwin-arm64 "$DARWIN_JAR" "$(basename "$DARWIN_JAR")" .. + export GNUPGHOME="$GITHUB_WORKSPACE/java/copilot-native/target/local-publication-gpg" + rm -rf "$GNUPGHOME" + mkdir -p "$GNUPGHOME" + chmod 700 "$GNUPGHOME" + gpg --batch --pinentry-mode loopback --passphrase '' \ + --quick-generate-key 'Copilot SDK local validation ' rsa2048 sign 1d + LOCAL_REPOSITORY="$GITHUB_WORKSPACE/java/copilot-native/target/local-publication-repository" + rm -rf "$LOCAL_REPOSITORY" + mvn -B -pl copilot-native deploy -Prelease -DskipTests \ + -Dcopilot.native.libc=glibc \ + -Dcopilot.native.test.local.publication=true \ + "-Dcopilot.native.external.linux.arm64.classifier.path=$LINUX_ARM64_JAR" \ + "-Dcopilot.native.external.win32.classifier.path=$WINDOWS_JAR" \ + "-Dcopilot.native.external.win32.arm64.classifier.path=$WINDOWS_ARM64_JAR" \ + "-Dcopilot.native.external.darwin.classifier.path=$DARWIN_JAR" \ + "-Dmaven.repo.local=$LOCAL_REPOSITORY" + node copilot-native/scripts/validate-local-publication.mjs \ + "$LOCAL_REPOSITORY" copilot-sdk-java-runtime "$VERSION" .. --signatures + java-sdk: name: "Java SDK Tests (JDK ${{ matrix.test-jdk }})" if: github.event.repository.fork == false @@ -45,6 +446,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 @@ -76,7 +481,9 @@ jobs: if: matrix.test-jdk == '25' env: CI: "true" - run: mvn verify -Dskip.test.harness=true + run: | + node copilot-native/scripts/validate-native-host.mjs linux-x64 + mvn verify -Dskip.test.harness=true -Dcopilot.native.libc=glibc -Dcopilot.native.skip.download=false - name: Switch to JDK 17 if: matrix.test-jdk == '17' @@ -92,7 +499,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' @@ -100,9 +507,9 @@ 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 Test Report Summary @@ -117,7 +524,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 cffef0a353..e7e9a417d2 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 e209a110b6..0000000000 --- a/.github/workflows/java.notes.template +++ /dev/null @@ -1,29 +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}) - -πŸ“– [Documentation](https://github.github.io/copilot-sdk-java/${VERSION}/) Β· [Javadoc](https://github.github.io/copilot-sdk-java/${VERSION}/apidocs/index.html) - - -## 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/publish.yml b/.github/workflows/publish.yml index b44fd582a2..98bf236900 100644 --- a/.github/workflows/publish.yml +++ b/.github/workflows/publish.yml @@ -379,7 +379,8 @@ jobs: needs.publish-nodejs.result == 'success' && needs.publish-dotnet.result == 'success' && needs.publish-python.result == 'success' && - needs.publish-rust.result == 'success' + needs.publish-rust.result == 'success' && + needs.publish-java.outputs.mavenPublished == 'true' runs-on: ubuntu-latest permissions: actions: write @@ -434,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 @@ -453,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 8c4d5806db..1ea9739756 100644 --- a/.github/workflows/python-sdk-tests.yml +++ b/.github/workflows/python-sdk-tests.yml @@ -79,4 +79,6 @@ jobs: - 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 781f41b22b..23b19d9b82 100644 --- a/.github/workflows/release-changelog.lock.yml +++ b/.github/workflows/release-changelog.lock.yml @@ -1,4 +1,4 @@ -# gh-aw-metadata: {"schema_version":"v4","frontmatter_hash":"9342b428009e6a3b47258c08b78735a89fc72714b73a44b72c4714e310d60006","body_hash":"89e26ed929f440bd6af57d1da92b06dbf1739b4a1d34b9923286919d00f272d1","compiler_version":"v0.83.1","strict":true,"agent_id":"copilot","engine_versions":{"copilot":"1.0.73"}} +# 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 # @@ -62,7 +62,7 @@ on: 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 diff --git a/.github/workflows/release-changelog.md b/.github/workflows/release-changelog.md index 7a682c56dd..c846b0dd32 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: @@ -55,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. @@ -68,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 @@ -81,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. @@ -90,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: @@ -118,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.** @@ -154,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 @@ -171,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/sdk-consistency-review.lock.yml b/.github/workflows/sdk-consistency-review.lock.yml index 3c1756644d..bc33be9ad1 100644 --- a/.github/workflows/sdk-consistency-review.lock.yml +++ b/.github/workflows/sdk-consistency-review.lock.yml @@ -1,4 +1,4 @@ -# gh-aw-metadata: {"schema_version":"v4","frontmatter_hash":"fb73d13f101fc375308576a64180f63934cc9e8306cb6ef6303f1b9788d9df28","body_hash":"478a74e14ae52b64cd38c57a44953fad4d8003a2414912a19de8f0f4a354a92f","compiler_version":"v0.83.1","strict":true,"agent_id":"copilot","engine_versions":{"copilot":"1.0.73"}} +# 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 # diff --git a/.github/workflows/sdk-consistency-review.md b/.github/workflows/sdk-consistency-review.md index 8a4ff106a0..550d9349d0 100644 --- a/.github/workflows/sdk-consistency-review.md +++ b/.github/workflows/sdk-consistency-review.md @@ -74,7 +74,7 @@ When a pull request modifies any SDK client code, review it to ensure: - **Python**: `python/copilot/` - **Go**: `go/` - **.NET**: `dotnet/src/` -- **Java**: `java/src/main/java/` +- **Java**: `java/sdk/src/main/java/` - **Rust**: `rust/src/` ## Review Process diff --git a/.github/workflows/update-copilot-dependency.yml b/.github/workflows/update-copilot-dependency.yml index b1a668a7cb..9646366ad5 100644 --- a/.github/workflows/update-copilot-dependency.yml +++ b/.github/workflows/update-copilot-dependency.yml @@ -192,11 +192,11 @@ jobs: - Enum value additions/renames in generated types - New event types requiring handler registration - Removed or renamed generated types - 3. **Fix handwritten source** (`java/src/main/java/com/github/copilot/sdk/`): + 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/src/test/java/com/github/copilot/sdk/`): + 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` diff --git a/.gitignore b/.gitignore index 4aff9be11d..c1e9833769 100644 --- a/.gitignore +++ b/.gitignore @@ -14,9 +14,10 @@ docs/.validation/ *.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/CHANGELOG.md b/CHANGELOG.md index 41bf05e171..d695ed6fb6 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -5,6 +5,66 @@ 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: rotating session-scoped GitHub credentials + +All six SDKs can now acquire short-lived GitHub credentials through a session-scoped callback. The SDK registers the callback before session create or resume, maps `initial` and `refresh` requests to the owning session, and removes registrations on rollback, replacement, session close, and client close. Static per-session `gitHubToken` credentials remain supported and are mutually exclusive with the callback. + +Token responses use the shared tagged token/cancelled shape and require `expiresIn`, expressed as the positive number of seconds remaining when the callback completes. See [github/copilot-agent-runtime#16381](https://github.com/github/copilot-agent-runtime/pull/16381) for the runtime credential-authority implementation. + +Initial acquisition occurs during create or resume; cancellation, callback errors, and invalid credentials reject that operation instead of falling back to ambient authentication. Idle sessions refresh only before their next credential-consuming operation. + +### Feature: extensions can request sensitive environment variables + +Copilot CLI extensions can now ask for named sensitive environment variables when they join a session. `joinSession()` accepts a `requestedEnvironmentVariables` option listing the variable names the extension needs. The CLI shows a permission prompt naming the extension and the exact variables requested. On approval, only those variables reach that extension and their values are written into the extension process's `process.env` before `joinSession()` resolves. On denial, `joinSession()` rejects, the extension does not load, and its tools never reach the model. + +An approval is remembered against the exact set of names the user saw, so an extension that later asks for one more variable prompts again. Names that are unset, or that the CLI does not filter from extensions, are not prompted for. This is the client half of the feature; it requires a Copilot CLI that supports extension environment access, and older CLIs ignore the request and grant nothing. + +```ts +import { joinSession } from "@github/copilot-sdk/extension"; + +const session = await joinSession({ + requestedEnvironmentVariables: ["GITHUB_TOKEN"], +}); +const token = process.env.GITHUB_TOKEN; +``` + +### 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 diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index f60625ec15..5135e596dd 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -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 . --group 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 SDK 10+](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 43ff70debd..b2ef69d053 100644 --- a/README.md +++ b/README.md @@ -21,9 +21,9 @@ The GitHub Copilot SDK exposes the same engine behind Copilot CLI: a production- | ------------------------ | ----------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------ | | **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) | +| **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/) | +| **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. @@ -69,7 +69,7 @@ Billing for the GitHub Copilot SDK is based on the same model as the Copilot CLI ### 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. diff --git a/docs/README.md b/docs/README.md index 9e0d8fddff..3be019f144 100644 --- a/docs/README.md +++ b/docs/README.md @@ -8,7 +8,7 @@ Welcome to the GitHub Copilot SDK docs. Whether you're building your first Copil |---|---| | **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, environment variables, BYOK | +| **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 | @@ -26,7 +26,7 @@ How to configure and deploy the SDK for your use case. * [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 +* [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 @@ -35,6 +35,7 @@ How to configure and deploy the SDK for your use case. 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) @@ -62,6 +63,7 @@ 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 diff --git a/docs/auth/README.md b/docs/auth/README.md index 282bcb0192..a85d6de6e8 100644 --- a/docs/auth/README.md +++ b/docs/auth/README.md @@ -3,10 +3,11 @@ 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. See [Authenticate Copilot SDK](authenticate.md#authentication-priority) for details. +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 1a01901863..a7582b5510 100644 --- a/docs/auth/authenticate.md +++ b/docs/auth/authenticate.md @@ -7,9 +7,10 @@ The GitHub Copilot SDK supports multiple authentication methods to fit different | Method | Use Case | Copilot Subscription Required | |--------|----------|-------------------------------| | [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 | +| [GitHub OAuth App](#github-oauth-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, and more) | 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 @@ -23,26 +24,13 @@ This is the default authentication method when running the Copilot CLI interacti **SDK Configuration:**
-Node.js / TypeScript +.NET -```typescript -import { CopilotClient } from "@github/copilot-sdk"; +```csharp +using GitHub.Copilot; // Default: uses logged-in user credentials -const client = new CopilotClient(); -``` - -
- -
-Python - -```python -from copilot import CopilotClient - -# Default: uses logged-in user credentials -client = CopilotClient() -await client.start() +await using CopilotClient client = new(); ```
@@ -74,26 +62,51 @@ client := copilot.NewClient(nil)
-.NET +Java -```csharp -using GitHub.Copilot; +```java +import com.github.copilot.CopilotClient; // Default: uses logged-in user credentials -await using var client = new CopilotClient(); +var client = new CopilotClient(); +client.start().get(); ```
-Java +Python -```java -import com.github.copilot.CopilotClient; +```python +from copilot import CopilotClient + +# Default: uses logged-in user credentials +client = CopilotClient() +await client.start() +``` + +
+ +
+Rust + +```rust +use github_copilot_sdk::{Client, ClientOptions}; // Default: uses logged-in user credentials -var client = new CopilotClient(); -client.start().get(); +let client = Client::start(ClientOptions::default()).await?; +``` + +
+ +
+TypeScript + +```typescript +import { CopilotClient } from "@github/copilot-sdk"; + +// Default: uses logged-in user credentials +const client = new CopilotClient(); ```
@@ -103,42 +116,41 @@ client.start().get(); * Development and testing environments * Any scenario where a user can sign in interactively -## OAuth GitHub App +## GitHub OAuth App Use an OAuth GitHub App to authenticate users through your application and pass their credentials to the SDK. This enables your application to make Copilot API requests on behalf of users who authorize your app. **How it works:** 1. User authorizes your OAuth GitHub App 1. Your app receives a user access token (`gho_` or `ghu_` prefix) -1. Pass the token to the SDK via `gitHubToken` option +1. Pass the token to the SDK through its client configuration **SDK Configuration:**
-Node.js / TypeScript +.NET -```typescript -import { CopilotClient } from "@github/copilot-sdk"; + +```csharp +using GitHub.Copilot; -const client = new CopilotClient({ - gitHubToken: userAccessToken, // Token from OAuth flow - useLoggedInUser: false, // Don't use stored CLI credentials +var userAccessToken = "token"; +await using CopilotClient client = new(new CopilotClientOptions +{ + GitHubToken = userAccessToken, + UseLoggedInUser = false, }); ``` + -
- -
-Python - -```python -from copilot import CopilotClient +```csharp +using GitHub.Copilot; -client = CopilotClient({ - "github_token": user_access_token, # Token from OAuth flow - "use_logged_in_user": False, # Don't use stored CLI credentials -}) -await client.start() +await using var client = new CopilotClient(new CopilotClientOptions +{ + GitHubToken = userAccessToken, // Token from OAuth flow + UseLoggedInUser = false, // Don't use stored CLI credentials +}); ```
@@ -167,41 +179,13 @@ func main() { import copilot "github.com/github/copilot-sdk/go" client := copilot.NewClient(&copilot.ClientOptions{ - GitHubToken: userAccessToken, // Token from OAuth flow - UseLoggedInUser: copilot.Bool(false), // Don't use stored CLI credentials + GitHubToken: userAccessToken, // Token from OAuth flow + UseLoggedInUser: copilot.Bool(false), // Don't use stored CLI credentials }) ``` -
-.NET - - -```csharp -using GitHub.Copilot; - -var userAccessToken = "token"; -await using var client = new CopilotClient(new CopilotClientOptions -{ - GitHubToken = userAccessToken, - UseLoggedInUser = false, -}); -``` - - -```csharp -using GitHub.Copilot; - -await using var client = new CopilotClient(new CopilotClientOptions -{ - GitHubToken = userAccessToken, // Token from OAuth flow - UseLoggedInUser = false, // Don't use stored CLI credentials -}); -``` - -
-
Java @@ -219,6 +203,50 @@ client.start().get();
+
+Python + +```python +from copilot import CopilotClient + +client = CopilotClient({ + "github_token": user_access_token, # Token from OAuth flow + "use_logged_in_user": False, # Don't use stored CLI credentials +}) +await client.start() +``` + +
+ +
+Rust + +```rust +use github_copilot_sdk::{Client, ClientOptions}; + +let client = Client::start( + ClientOptions::default() + .with_github_token(user_access_token) + .with_use_logged_in_user(false), +).await?; +``` + +
+ +
+TypeScript + +```typescript +import { CopilotClient } from "@github/copilot-sdk"; + +const client = new CopilotClient({ + gitHubToken: userAccessToken, // Token from OAuth flow + useLoggedInUser: false, // Don't use stored CLI credentials +}); +``` + +
+ **Supported token types:** * `gho_` - OAuth user access tokens * `ghu_` - GitHub App user access tokens @@ -232,10 +260,139 @@ client.start().get(); * SaaS applications building on top of Copilot * Any multi-user application where you need to make requests on behalf of different users +For more information, see [GitHub OAuth](../setup/github-oauth.md). + +## Rotating session-scoped GitHub tokens + +For multi-user services and integrations, set a token provider on each session instead of storing one long-lived token. The runtime calls the provider for the effective GitHub host and identifies the request as `initial` or `refresh`. The session ID is absent only when a cloud session has not received its ID yet. + +Return a tagged token result or an explicit cancellation. Every token result must include `expiresIn`: the positive number of seconds remaining when the callback completes. Production GitHub tokens typically last eight hours, so `8 * 60 * 60` is a common value. Do not set both the static per-session token and the provider. + +
+TypeScript + + +```typescript +const session = await client.createSession({ + gitHubTokenProvider: async ({ host, sessionId, reason }) => { + const token = await acquireGitHubToken({ host, sessionId, reason }); + return { + kind: "token", + accessToken: token.value, + expiresIn: token.secondsRemaining, + }; + }, +}); +``` + +
+
+Python + + +```python +async def provide_github_token(args): + token = await acquire_github_token( + host=args["host"], + session_id=args["session_id"], + reason=args["reason"], + ) + return { + "kind": "token", + "accessToken": token.value, + "expiresIn": token.seconds_remaining, + } + + +session = await client.create_session(github_token_provider=provide_github_token) +``` + +
+
+Go + + +```go +session, err := client.CreateSession(ctx, &copilot.SessionConfig{ + GitHubTokenProvider: func(args copilot.GitHubTokenProviderArgs) (*copilot.GitHubTokenProviderResult, error) { + token, secondsRemaining, err := acquireGitHubToken(args.Host, args.SessionID, args.Reason) + if err != nil { + return nil, err + } + return copilot.GitHubTokenResult(&copilot.GitHubToken{ + AccessToken: token, + ExpiresIn: secondsRemaining, + }), nil + }, +}) +``` + +
+
+.NET + + +```csharp +await using var session = await client.CreateSessionAsync(new SessionConfig +{ + GitHubTokenProvider = async args => + { + var token = await AcquireGitHubTokenAsync(args.Host, args.SessionId, args.Reason); + return GitHubTokenProviderResult.FromToken(new GitHubToken + { + AccessToken = token.Value, + ExpiresIn = token.SecondsRemaining, + }); + }, +}); +``` + +
+
+Java + + +```java +var session = client.createSession(new SessionConfig() + .setGitHubTokenProvider(args -> + acquireGitHubToken(args.host(), args.sessionId(), args.reason()) + .thenApply(token -> GitHubTokenProviderResult.token( + token.value(), token.secondsRemaining()))) + .setOnPermissionRequest(PermissionHandler.APPROVE_ALL) +).get(); +``` + +
+
+Rust + + +```rust +let provider = Arc::new(|args: GitHubTokenProviderArgs| async move { + let token = acquire_github_token(&args.host, args.session_id.as_ref(), args.reason).await?; + Ok(GitHubTokenProviderResult::Token(GitHubToken::new( + token.value, + token.seconds_remaining, + ))) +}); + +let session = client + .create_session(SessionConfig::default().with_github_token_provider(provider)) + .await?; +``` + +
+ +The runtime performs the `initial` acquisition as part of session creation or resume. A cancelled acquisition, provider error, invalid response, or token without a stable account identity rejects the create or resume operation. The runtime does not fall back to ambient authentication. + +After the session is established, the runtime performs async preflight before each credential-consuming operation. It requests a `refresh` when the current token has one hour or less remaining. Idle sessions are not refreshed until their next credential-consuming operation. The runtime does not use background timers, rejection-driven replay, 401/403 challenge propagation, or upscope for this callback. + ## Environment variables 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 @@ -250,13 +407,52 @@ For automation, CI/CD pipelines, and server-to-server scenarios, you can authent No code changes neededβ€”the SDK automatically detects environment variables:
-Node.js / TypeScript +.NET -```typescript -import { CopilotClient } from "@github/copilot-sdk"; +```csharp +using GitHub.Copilot; // Token is read from environment variable automatically -const client = new CopilotClient(); +await using CopilotClient client = new(); +``` + +
+ +
+Go + + +```go +package main + +import copilot "github.com/github/copilot-sdk/go" + +func main() { + // Token is read from environment variable automatically + client := copilot.NewClient(nil) + _ = client +} +``` + + +```go +import copilot "github.com/github/copilot-sdk/go" + +// Token is read from environment variable automatically +client := copilot.NewClient(nil) +``` + +
+ +
+Java + +```java +import com.github.copilot.CopilotClient; + +// Token is read from environment variable automatically +var client = new CopilotClient(); +client.start().get(); ```
@@ -274,6 +470,30 @@ await client.start() +
+Rust + +```rust +use github_copilot_sdk::{Client, ClientOptions}; + +// Token is read from environment variable automatically +let client = Client::start(ClientOptions::default()).await?; +``` + +
+ +
+TypeScript + +```typescript +import { CopilotClient } from "@github/copilot-sdk"; + +// Token is read from environment variable automatically +const client = new CopilotClient(); +``` + +
+ **When to use:** * CI/CD pipelines (GitHub Actions, Jenkins, and more) * Automated testing @@ -282,16 +502,16 @@ await client.start() ## 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 @@ -310,40 +530,20 @@ For multi-user server mode, pass a per-session `gitHubToken` so each session run ## Disabling auto-login -To prevent the SDK from automatically using stored credentials or `gh` CLI auth, use the `useLoggedInUser: false` option: +To prevent the SDK from automatically using stored credentials or `gh` CLI auth, configure it to disable logged-in-user fallback:
-Node.js / TypeScript +.NET -```typescript -const client = new CopilotClient({ - useLoggedInUser: false, // Only use explicit tokens +```csharp +await using var client = new CopilotClient(new CopilotClientOptions +{ + UseLoggedInUser = false, // Only use explicit tokens }); ```
-
-Python - - -```python -from copilot import CopilotClient - -client = CopilotClient({ - "use_logged_in_user": False, -}) -``` - - -```python -client = CopilotClient({ - "use_logged_in_user": False, # Only use explicit tokens -}) -``` - -
-
Go @@ -370,18 +570,6 @@ client := copilot.NewClient(&copilot.ClientOptions{
-
-.NET - -```csharp -await using var client = new CopilotClient(new CopilotClientOptions -{ - UseLoggedInUser = false, // Only use explicit tokens -}); -``` - -
-
Java @@ -397,6 +585,51 @@ client.start().get();
+
+Python + + +```python +from copilot import CopilotClient + +client = CopilotClient({ + "use_logged_in_user": False, +}) +``` + + +```python +client = CopilotClient({ + "use_logged_in_user": False, # Only use explicit tokens +}) +``` + +
+ +
+Rust + +```rust +use github_copilot_sdk::{Client, ClientOptions}; + +let client = Client::start( + ClientOptions::default().with_use_logged_in_user(false), +).await?; +``` + +
+ +
+TypeScript + +```typescript +const client = new CopilotClient({ + useLoggedInUser: false, // Only use explicit tokens +}); +``` + +
+ ## Next steps * [BYOK Documentation](./byok.md) - Learn how to use your own API keys diff --git a/docs/auth/server-to-server-tokens.md b/docs/auth/server-to-server-tokens.md new file mode 100644 index 0000000000..b7b4fcf409 --- /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 index 15788bbe56..573f4f22e1 100644 --- a/docs/developer-docs/secrets.md +++ b/docs/developer-docs/secrets.md @@ -50,7 +50,7 @@ These secrets are used by the Java SDK Maven Central publishing workflow (`java- * **`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 this repository and `github/copilot-sdk-java`. Used to trigger the `release-changelog.lock.yml` workflow and the documentation site deployment after a release is published. +* **`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 diff --git a/docs/features/README.md b/docs/features/README.md index b695fea6d4..f97140b784 100644 --- a/docs/features/README.md +++ b/docs/features/README.md @@ -16,9 +16,12 @@ These guides cover the capabilities you can add to your Copilot SDK application. | [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 | diff --git a/docs/features/citations.md b/docs/features/citations.md new file mode 100644 index 0000000000..b68ae292cd --- /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/context-management.md b/docs/features/context-management.md new file mode 100644 index 0000000000..6472b046aa --- /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/hooks.md b/docs/features/hooks.md index feee55546d..6a78339901 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 | @@ -1055,6 +1057,7 @@ For full type definitions, input/output field tables, and additional examples fo * [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) diff --git a/docs/features/mcp.md b/docs/features/mcp.md index 6f715bd2ed..caac633275 100644 --- a/docs/features/mcp.md +++ b/docs/features/mcp.md @@ -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 index ccd95df95a..4af11d9a7e 100644 --- a/docs/features/plugin-directories.md +++ b/docs/features/plugin-directories.md @@ -240,6 +240,41 @@ let client = Client::start( > 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: diff --git a/docs/features/remote-sessions.md b/docs/features/remote-sessions.md index 5a15ca8258..f103b9cf6e 100644 --- a/docs/features/remote-sessions.md +++ b/docs/features/remote-sessions.md @@ -13,7 +13,7 @@ For running sessions on GitHub-hosted compute, see [Cloud Sessions](./cloud-sess ### 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. @@ -23,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 }), @@ -59,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) { @@ -78,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", @@ -201,6 +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 `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/skills.md b/docs/features/skills.md index 5b8388162a..d76196429e 100644 --- a/docs/features/skills.md +++ b/docs/features/skills.md @@ -351,6 +351,22 @@ The markdown body contains the instructions that are injected into the session c | .NET | `SkillDirectories` | `List` | Directories to load skills from | | .NET | `DisabledSkills` | `List` | Skills to disable | +### Built-in skills and `mode: "empty"` + +The runtime ships with a set of bundled **built-in** skills that are eligible by +default. When you run the client in `mode: "empty"` (the recommended baseline for +[multi-tenant servers](../setup/multi-tenancy.md)), the SDK excludes every +runtime-bundled built-in skill: it sends an empty `includedBuiltinSkills` list on +the post-create and post-resume options patch, alongside the empty +`installedPlugins` list. + +This exclusion is the default, not a permanent restriction. To allow selected +runtime-bundled skills, set `includedBuiltinSkills` (or the language-specific +casing) to their names. You can also opt into your **own** custom skills under +`mode: "empty"`β€”enable skills and pass your own `skillDirectories`β€”and those +remain fully usable, including a custom skill that shares a name with a built-in. +Under `mode: "copilot-cli"` the field is omitted unless you set the option. + ## Best practices 1. **Organize by domain** - Group related skills together (e.g., `skills/security/`, `skills/testing/`) diff --git a/docs/features/streaming-events.md b/docs/features/streaming-events.md index 69e12e6dc8..10f111d9f9 100644 --- a/docs/features/streaming-events.md +++ b/docs/features/streaming-events.md @@ -210,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. @@ -548,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` @@ -661,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 | |------------|------|----------|-------------| @@ -684,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 | |------------|------|----------|-------------| @@ -835,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 | |------------|------|----------|-------------| @@ -847,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 | |------------|------|----------|-------------| @@ -925,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) @@ -958,7 +958,7 @@ This table lists key `data` payload fields. Common envelope fields are documente | `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?` | @@ -969,8 +969,8 @@ This table lists key `data` payload fields. Common envelope fields are documente | `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` | @@ -984,8 +984,8 @@ This table lists key `data` payload fields. Common envelope fields are documente | `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` | diff --git a/docs/features/usage-and-billing.md b/docs/features/usage-and-billing.md new file mode 100644 index 0000000000..ec662b6850 --- /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 5f0ce835da..53b6497fdb 100644 --- a/docs/getting-started.md +++ b/docs/getting-started.md @@ -2053,6 +2053,7 @@ let mut options = ClientOptions::default(); options.transport = Transport::External { host: "localhost".to_string(), port: 4321, + connection_token: None, }; let client = Client::start(options).await?; @@ -2263,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 index 517be96145..a6c7e1aa66 100644 --- a/docs/hooks/README.md +++ b/docs/hooks/README.md @@ -6,5 +6,6 @@ Detailed API reference for each session hook in the GitHub Copilot SDK. * [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/hooks-overview.md b/docs/hooks/hooks-overview.md index 6de4c3e72c..8d5583e996 100644 --- a/docs/hooks/hooks-overview.md +++ b/docs/hooks/hooks-overview.md @@ -16,6 +16,7 @@ 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 | @@ -263,6 +264,7 @@ 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 diff --git a/docs/hooks/user-prompt-transformed.md b/docs/hooks/user-prompt-transformed.md new file mode 100644 index 0000000000..f7791d78b2 --- /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/observability/opentelemetry.md b/docs/observability/opentelemetry.md index ad86145e40..b3932ce66a 100644 --- a/docs/observability/opentelemetry.md +++ b/docs/observability/opentelemetry.md @@ -152,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 index cc4183ca7a..e4723ab48e 100644 --- a/docs/setup/README.md +++ b/docs/setup/README.md @@ -8,5 +8,5 @@ Configure and deploy the GitHub Copilot SDK for your use case. * [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 Azure AI Foundry +* [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/bundled-cli.md b/docs/setup/bundled-cli.md index f067de8fde..9d9c80c35b 100644 --- a/docs/setup/bundled-cli.md +++ b/docs/setup/bundled-cli.md @@ -39,6 +39,9 @@ flowchart TB ## Quick start +> [!NOTE] +> Each SDK has a minimum language runtime requirementβ€”see the Prerequisites section of the [Node.js](../../nodejs/README.md#prerequisites), [Python](../../python/README.md#prerequisites), [Go](../../go/README.md#prerequisites), [Rust](../../rust/README.md#prerequisites), [Java](../../java/README.md#prerequisites), or [.NET](../../dotnet/README.md#prerequisites) READMEβ€”since an unsupported runtime (e.g. Python below the stated floor) can cause `pip`/package managers to silently resolve an outdated SDK release instead of reporting a version conflict. +
Node.js / TypeScript diff --git a/docs/setup/multi-tenancy.md b/docs/setup/multi-tenancy.md index 2f82dde0bf..ebbafe4fb0 100644 --- a/docs/setup/multi-tenancy.md +++ b/docs/setup/multi-tenancy.md @@ -24,7 +24,9 @@ This guide is a sister to [Scaling and multi-tenancy](./scaling.md). Use that gu | `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. | +| Per-session GitHub token or provider | Scoping auth to the requesting user | Prefer a rotating provider for short-lived credentials; use a static `gitHubToken` only when rotation is unnecessary. | + +For callback-backed credentials, see [Rotating session-scoped GitHub tokens](../auth/authenticate.md#rotating-session-scoped-github-tokens). Each session owns its provider registration, so concurrent sessions can use different GitHub hosts and accounts without sharing callback state. ### `mode: "empty"` @@ -396,10 +398,13 @@ Session-level isolation means the runtime keeps user-specific model and state in | 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"`. | +| Skills | In `mode: "empty"` no runtime-bundled built-in skills are eligible by default; callers can allow selected built-ins or opt into their own custom skills. 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. +Under `mode: "empty"` the SDK excludes every runtime-bundled built-in skill by default (it sends an empty `includedBuiltinSkills` list on the post-create/post-resume options patch, alongside the empty `installedPlugins` list). Set `includedBuiltinSkills` (or the language-specific casing) to explicitly allow selected built-ins, just as `availableTools` allows selected runtime-bundled tools. A caller can also opt into its **own** custom skillsβ€”for example by enabling skills and pointing at its own skill directoriesβ€”and those remain usable. + 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 diff --git a/docs/troubleshooting/compatibility.md b/docs/troubleshooting/compatibility.md index c68d59cc7b..da8bf0daae 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; 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 | diff --git a/dotnet/README.md b/dotnet/README.md index 796ef22549..461ff0cf94 100644 --- a/dotnet/README.md +++ b/dotnet/README.md @@ -37,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", @@ -64,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 @@ -78,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. @@ -117,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 @@ -125,7 +131,10 @@ 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. +- `GitHubTokenProvider` - Acquires session-scoped GitHub tokens on demand. Return `GitHubTokenProviderResult.FromToken` with a positive `ExpiresIn` value (production GitHub tokens typically use `8 * 60 * 60` seconds), or `GitHubTokenProviderResult.Cancel()`. Cannot be combined with `GitHubToken`. +- `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. @@ -136,6 +145,24 @@ Resume an existing session. Returns the session with `WorkspacePath` populated i **ResumeSessionConfig:** - `OnPermissionRequest` - Optional handler called before each tool execution to approve or deny it. See [Permission Handling](#permission-handling) section. +- `GitHubTokenProvider` - Replaces the session-scoped token provider when resuming. Cannot be combined with `GitHubToken`. + +```csharp +await using var session = await client.CreateSessionAsync(new SessionConfig +{ + GitHubTokenProvider = async args => + { + var token = await AcquireTokenAsync(args.Host); + return GitHubTokenProviderResult.FromToken(new GitHubToken + { + AccessToken = token, + ExpiresIn = 8 * 60 * 60 + }); + } +}); +``` + +Initial acquisition runs during session creation or resume. Cancellation, provider errors, and invalid token responses reject that operation instead of falling back to ambient authentication. Idle sessions refresh only before their next credential-consuming operation; there is no background refresh timer. ##### `PingAsync(string? message = null): Task` @@ -289,9 +316,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", @@ -303,9 +330,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", @@ -714,13 +741,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", } } }); @@ -775,7 +801,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; @@ -787,9 +813,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 @@ -797,6 +825,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 @@ -1024,6 +1057,25 @@ catch (Exception ex) } ``` +## Development + +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 MIT diff --git a/dotnet/src/Client.cs b/dotnet/src/Client.cs index c8d83dfee2..f2da0a48f7 100644 --- a/dotnet/src/Client.cs +++ b/dotnet/src/Client.cs @@ -70,12 +70,14 @@ public sealed partial class CopilotClient : IDisposable, IAsyncDisposable /// that has not been explicitly disposed or removed. /// internal readonly ConcurrentDictionary _sessions = new(); + private readonly ConcurrentDictionary>> _gitHubTokenProviders = new(); private readonly CopilotClientOptions _options; private readonly RuntimeConnection _connection; private readonly ILogger _logger; private readonly int? _optionsPort; private readonly string? _optionsHost; + private readonly string[] _builtinPluginDirectories; private readonly Func>>? _onListModels; private readonly List _lifecycleHandlers = []; @@ -90,8 +92,7 @@ public sealed partial class CopilotClient : IDisposable, IAsyncDisposable /// /// 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. + /// built once at construction and registered on every connection. /// private readonly ClientGlobalApiHandlers? _clientGlobalApis; @@ -138,6 +139,14 @@ public CopilotClient(CopilotClientOptions? options = null) { _options = options ?? new(); _connection = _options.Connection ?? ResolveDefaultConnection(_options); + _builtinPluginDirectories = _options.BuiltinPluginDirectories?.ToArray() ?? []; + foreach (var path in _builtinPluginDirectories.Where(path => !IsFullyQualifiedPath(path))) + { + throw new ArgumentException( + $"{nameof(CopilotClientOptions)}.{nameof(CopilotClientOptions.BuiltinPluginDirectories)} " + + $"must contain only absolute paths: {path}", + nameof(options)); + } switch (_connection) { @@ -317,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. /// @@ -423,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) @@ -505,6 +541,7 @@ public async Task StopAsync() } _sessions.Clear(); + ClearGitHubTokenProviders(); await CleanupConnectionAsync(errors, gracefulRuntimeShutdown: true); @@ -536,6 +573,7 @@ public async Task StopAsync() public async Task ForceStopAsync() { _sessions.Clear(); + ClearGitHubTokenProviders(); var errors = new List(); await CleanupConnectionAsync(errors, gracefulRuntimeShutdown: false); @@ -783,7 +821,9 @@ 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); @@ -906,6 +946,7 @@ private void ApplyConfigDefaultsForMode(SessionConfigBase config) { if (_options.Mode == CopilotClientMode.Empty) { + config.EnableExperimentalMode ??= false; config.EnableSessionTelemetry ??= false; config.SkipEmbeddingRetrieval ??= true; config.EmbeddingCacheStorage ??= EmbeddingCacheStorageMode.InMemory; @@ -916,6 +957,7 @@ private void ApplyConfigDefaultsForMode(SessionConfigBase config) config.EnableSkills ??= false; config.Memory ??= new MemoryConfiguration { Enabled = false }; config.McpOAuthTokenStorage ??= McpOAuthTokenStorageMode.InMemory; + config.CustomAgentsLocalOnly ??= true; } } @@ -990,8 +1032,9 @@ private void ApplyConfigDefaultsForMode(SessionConfigBase config) /// patch for the current mode. In empty mode this defaults the four /// overridable feature flags to safe values (caller values from /// win); installedPlugins=[] is - /// unconditional under empty mode so apps that need plugins must switch - /// modes. In copilot-cli mode only explicitly-set fields are forwarded. + /// unconditional under empty mode. includedBuiltinSkills defaults to + /// an empty list, but callers can explicitly allow selected runtime-bundled + /// skills. In copilot-cli mode only explicitly-set fields are forwarded. /// private async Task UpdateSessionOptionsForModeAsync(CopilotSession session, SessionConfigBase config, CancellationToken cancellationToken) { @@ -1001,6 +1044,7 @@ private async Task UpdateSessionOptionsForModeAsync(CopilotSession session, Sess bool? coauthorEnabled = null; bool? manageScheduleEnabled = null; IList? installedPlugins = null; + IList? includedBuiltinSkills = null; if (_options.Mode == CopilotClientMode.Empty) { @@ -1009,6 +1053,7 @@ private async Task UpdateSessionOptionsForModeAsync(CopilotSession session, Sess coauthorEnabled = config.CoauthorEnabled ?? false; manageScheduleEnabled = config.ManageScheduleEnabled ?? false; installedPlugins = []; + includedBuiltinSkills = config.IncludedBuiltinSkills ?? []; hasAnyPatch = true; } else @@ -1017,6 +1062,7 @@ private async Task UpdateSessionOptionsForModeAsync(CopilotSession session, Sess if (config.CustomAgentsLocalOnly is not null) { customAgentsLocalOnly = config.CustomAgentsLocalOnly; hasAnyPatch = true; } if (config.CoauthorEnabled is not null) { coauthorEnabled = config.CoauthorEnabled; hasAnyPatch = true; } if (config.ManageScheduleEnabled is not null) { manageScheduleEnabled = config.ManageScheduleEnabled; hasAnyPatch = true; } + if (config.IncludedBuiltinSkills is not null) { includedBuiltinSkills = config.IncludedBuiltinSkills; hasAnyPatch = true; } } if (!hasAnyPatch) return; @@ -1030,6 +1076,7 @@ await session.Rpc.Options.UpdateAsync( coauthorEnabled: coauthorEnabled, manageScheduleEnabled: manageScheduleEnabled, installedPlugins: installedPlugins, + includedBuiltinSkills: includedBuiltinSkills, cancellationToken: cancellationToken).ConfigureAwait(false); #pragma warning restore GHCP001 } @@ -1079,6 +1126,7 @@ await session.Rpc.Options.UpdateAsync( public async Task CreateSessionAsync(SessionConfig config, CancellationToken cancellationToken = default) { ArgumentNullException.ThrowIfNull(config); + ValidateGitHubTokenConfig(config); var connection = await EnsureConnectedAsync(cancellationToken); var totalTimestamp = Stopwatch.GetTimestamp(); @@ -1093,6 +1141,7 @@ 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 || @@ -1112,19 +1161,22 @@ public async Task CreateSessionAsync(SessionConfig config, Cance ? null : (string.IsNullOrEmpty(config.SessionId) ? Guid.NewGuid().ToString() : config.SessionId); + var registrationId = RegisterGitHubTokenProvider(config.GitHubTokenProvider); + var registrationTransferred = false; CopilotSession? session = null; - if (localSessionId != null) - { - session = InitializeSession( - localSessionId, - connection.Rpc, - config, - transformCallbacks, - hasHooks, - "CopilotClient.CreateSessionAsync"); - } try { + if (localSessionId != null) + { + session = InitializeSession( + localSessionId, + connection.Rpc, + config, + transformCallbacks, + hasHooks, + "CopilotClient.CreateSessionAsync"); + } + var (traceparent, tracestate) = TelemetryHelpers.GetTraceContext(); var request = new CreateSessionRequest( @@ -1136,6 +1188,7 @@ public async Task CreateSessionAsync(SessionConfig config, Cance config.ContextTier, config.Tools?.Select(ToolDefinition.FromAIFunction).ToList(), config.EnableCitations, + config.EnableFileChangeTracking, wireSystemMessage, toolFilter.AvailableTools, toolFilter.ExcludedTools, @@ -1143,6 +1196,7 @@ public async Task CreateSessionAsync(SessionConfig config, Cance config.Provider, config.Capi, config.EnableSessionTelemetry, + config.EnableExperimentalMode, config.OnPermissionRequest != null ? true : null, config.OnUserInputRequest != null ? true : null, config.OnExitPlanModeRequest != null ? true : null, @@ -1159,6 +1213,7 @@ public async Task CreateSessionAsync(SessionConfig config, Cance config.Agent, config.ConfigDirectory, config.EnableConfigDiscovery, + config.CustomAgentsLocalOnly, config.SkipEmbeddingRetrieval, config.EmbeddingCacheStorage, config.OrganizationCustomInstructions, @@ -1171,17 +1226,19 @@ public async Task CreateSessionAsync(SessionConfig config, Cance config.DisabledSkills, config.InfiniteSessions, config.SessionLimits, - Commands: config.Commands?.Select(c => new CommandWireDefinition(c.Name, c.Description)).ToList(), + Commands: config.Commands?.Select(c => new CommandWireDefinition(c.Name, c.Description ?? string.Empty)).ToList(), RequestElicitation: config.OnElicitationRequest != null, RequestMcpApps: config.EnableMcpApps ? true : null, Traceparent: traceparent, Tracestate: tracestate, ModelCapabilities: config.ModelCapabilities, GitHubToken: config.GitHubToken, + GitHubTokenProviderRegistrationId: registrationId, RemoteSession: config.RemoteSession, Cloud: config.Cloud, InstructionDirectories: config.InstructionDirectories, PluginDirectories: config.PluginDirectories, + DisabledMcpServers: config.DisabledMcpServers, LargeOutput: config.LargeOutput, ToolSearch: config.ToolSearch, Memory: config.Memory, @@ -1196,7 +1253,10 @@ public async Task CreateSessionAsync(SessionConfig config, Cance ToolFilterPrecedence: toolFilter.ToolFilterPrecedence, ExpAssignments: config.ExpAssignments, EnableManagedSettings: config.EnableManagedSettings, - EnableGitHubTelemetryForwarding: _options.OnGitHubTelemetry != null ? true : null); + GitHubMcpToolConfig: config.GitHubMcpToolConfig, + ManagedSettings: config.ManagedSettings, + EnableGitHubTelemetryForwarding: _options.OnGitHubTelemetry != null ? true : null, + AdditionalDirectories: config.AdditionalDirectories); var rpcTimestamp = Stopwatch.GetTimestamp(); @@ -1253,6 +1313,11 @@ public async Task CreateSessionAsync(SessionConfig config, Cance session.SetOpenCanvases(response.OpenCanvases); await UpdateSessionOptionsForModeAsync(session, config, cancellationToken).ConfigureAwait(false); + if (registrationId is not null) + { + session.SetGitHubTokenProviderRegistration(registrationId); + registrationTransferred = true; + } } catch (Exception ex) { @@ -1268,6 +1333,13 @@ public async Task CreateSessionAsync(SessionConfig config, Cance throw; } + finally + { + if (!registrationTransferred && registrationId is not null) + { + UnregisterGitHubTokenProvider(registrationId); + } + } LoggingHelpers.LogTiming(_logger, LogLevel.Debug, null, "CopilotClient.CreateSessionAsync complete. Elapsed={Elapsed}, SessionId={SessionId}", @@ -1305,6 +1377,7 @@ public async Task ResumeSessionAsync(string sessionId, ResumeSes { ArgumentNullException.ThrowIfNull(sessionId); ArgumentNullException.ThrowIfNull(config); + ValidateGitHubTokenConfig(config); var connection = await EnsureConnectedAsync(cancellationToken); var totalTimestamp = Stopwatch.GetTimestamp(); @@ -1319,6 +1392,7 @@ 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 || @@ -1326,17 +1400,21 @@ public async Task ResumeSessionAsync(string sessionId, ResumeSes var (wireSystemMessage, transformCallbacks) = ExtractTransformCallbacks(config.SystemMessage); - // Create and register the session before issuing the RPC so that - // events emitted by the CLI (e.g. session.start) are not dropped. - var session = InitializeSession( - sessionId, - connection.Rpc, - config, - transformCallbacks, - hasHooks, - "CopilotClient.ResumeSessionAsync"); + var registrationId = RegisterGitHubTokenProvider(config.GitHubTokenProvider); + var registrationTransferred = false; + CopilotSession? session = null; try { + // Create and register the session before issuing the RPC so that + // events emitted by the CLI (e.g. session.start) are not dropped. + session = InitializeSession( + sessionId, + connection.Rpc, + config, + transformCallbacks, + hasHooks, + "CopilotClient.ResumeSessionAsync"); + var (traceparent, tracestate) = TelemetryHelpers.GetTraceContext(); var request = new ResumeSessionRequest( @@ -1348,6 +1426,7 @@ public async Task ResumeSessionAsync(string sessionId, ResumeSes config.ContextTier, config.Tools?.Select(ToolDefinition.FromAIFunction).ToList(), config.EnableCitations, + config.EnableFileChangeTracking, wireSystemMessage, toolFilter.AvailableTools, toolFilter.ExcludedTools, @@ -1355,6 +1434,7 @@ public async Task ResumeSessionAsync(string sessionId, ResumeSes config.Provider, config.Capi, config.EnableSessionTelemetry, + config.EnableExperimentalMode, config.OnPermissionRequest != null ? true : null, config.OnUserInputRequest != null ? true : null, config.OnExitPlanModeRequest != null ? true : null, @@ -1363,6 +1443,7 @@ public async Task ResumeSessionAsync(string sessionId, ResumeSes config.WorkingDirectory, config.ConfigDirectory, config.EnableConfigDiscovery, + config.CustomAgentsLocalOnly, config.SkipEmbeddingRetrieval, config.EmbeddingCacheStorage, config.OrganizationCustomInstructions, @@ -1384,17 +1465,19 @@ public async Task ResumeSessionAsync(string sessionId, ResumeSes config.DisabledSkills, config.InfiniteSessions, config.SessionLimits, - Commands: config.Commands?.Select(c => new CommandWireDefinition(c.Name, c.Description)).ToList(), + Commands: config.Commands?.Select(c => new CommandWireDefinition(c.Name, c.Description ?? string.Empty)).ToList(), RequestElicitation: config.OnElicitationRequest != null, RequestMcpApps: config.EnableMcpApps ? true : null, Traceparent: traceparent, Tracestate: tracestate, ModelCapabilities: config.ModelCapabilities, GitHubToken: config.GitHubToken, + GitHubTokenProviderRegistrationId: registrationId, RemoteSession: config.RemoteSession, ContinuePendingWork: config.ContinuePendingWork, InstructionDirectories: config.InstructionDirectories, PluginDirectories: config.PluginDirectories, + DisabledMcpServers: config.DisabledMcpServers, LargeOutput: config.LargeOutput, ToolSearch: config.ToolSearch, Memory: config.Memory, @@ -1410,7 +1493,10 @@ public async Task ResumeSessionAsync(string sessionId, ResumeSes ToolFilterPrecedence: toolFilter.ToolFilterPrecedence, ExpAssignments: config.ExpAssignments, EnableManagedSettings: config.EnableManagedSettings, - EnableGitHubTelemetryForwarding: _options.OnGitHubTelemetry != null ? true : null); + GitHubMcpToolConfig: config.GitHubMcpToolConfig, + ManagedSettings: config.ManagedSettings, + EnableGitHubTelemetryForwarding: _options.OnGitHubTelemetry != null ? true : null, + AdditionalDirectories: config.AdditionalDirectories); var rpcTimestamp = Stopwatch.GetTimestamp(); var response = await InvokeRpcAsync( @@ -1430,10 +1516,15 @@ public async Task ResumeSessionAsync(string sessionId, ResumeSes } await UpdateSessionOptionsForModeAsync(session, config, cancellationToken).ConfigureAwait(false); + if (registrationId is not null) + { + session.SetGitHubTokenProviderRegistration(registrationId); + registrationTransferred = true; + } } catch (Exception ex) { - session.RemoveFromClient(); + session?.RemoveFromClient(); if (ex is not OperationCanceledException) { LoggingHelpers.LogTiming(_logger, LogLevel.Warning, ex, @@ -1443,12 +1534,19 @@ public async Task ResumeSessionAsync(string sessionId, ResumeSes } throw; } + finally + { + if (!registrationTransferred && registrationId is not null) + { + UnregisterGitHubTokenProvider(registrationId); + } + } LoggingHelpers.LogTiming(_logger, LogLevel.Debug, null, "CopilotClient.ResumeSessionAsync complete. Elapsed={Elapsed}, SessionId={SessionId}", totalTimestamp, sessionId); - return session; + return session!; } /// @@ -1608,7 +1706,10 @@ public async Task DeleteSessionAsync(string sessionId, CancellationToken cancell throw new InvalidOperationException($"Failed to delete session {sessionId}: {response.Error}"); } - RemoveSession(sessionId); + if (_sessions.TryRemove(sessionId, out var session)) + { + session.ReleaseGitHubTokenProviderRegistration(); + } } /// @@ -1890,25 +1991,94 @@ await Rpc.SessionFs.SetProviderAsync( /// /// 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. + /// depending on which options are configured. The GitHub token dispatcher is + /// always registered because providers are configured per session. /// 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), + GitHubToken = new GitHubTokenAdapter(this), }; } + private static void ValidateGitHubTokenConfig(SessionConfigBase config) + { + if (config.GitHubToken is not null && config.GitHubTokenProvider is not null) + { + throw new ArgumentException( + $"{nameof(SessionConfigBase.GitHubToken)} and {nameof(SessionConfigBase.GitHubTokenProvider)} cannot be used together.", + nameof(config)); + } + } + + private string? RegisterGitHubTokenProvider( + Func>? provider) + { + if (provider is null) + { + return null; + } + + var registrationId = Guid.NewGuid().ToString(); + if (!_gitHubTokenProviders.TryAdd(registrationId, provider)) + { + throw new InvalidOperationException("Failed to register GitHub token provider."); + } + return registrationId; + } + + internal void UnregisterGitHubTokenProvider(string registrationId) + => _gitHubTokenProviders.TryRemove(registrationId, out _); + + private void ClearGitHubTokenProviders() => _gitHubTokenProviders.Clear(); + + private sealed class GitHubTokenAdapter(CopilotClient client) : IGitHubTokenHandler + { + public async Task GetTokenAsync( + GitHubTokenAcquireRequest request, + CancellationToken cancellationToken = default) + { + if (!client._gitHubTokenProviders.TryGetValue(request.RegistrationId, out var provider)) + { + throw new InvalidOperationException( + $"Unknown GitHub token provider registration ID '{request.RegistrationId}'."); + } + + var reason = request.Reason == GitHubTokenAcquireReason.Initial + ? GitHubTokenRequestReason.Initial + : request.Reason == GitHubTokenAcquireReason.Refresh + ? GitHubTokenRequestReason.Refresh + : throw new InvalidOperationException($"Unknown GitHub token request reason '{request.Reason}'."); + var result = await provider(new GitHubTokenProviderArgs + { + Host = request.Host, + SessionId = request.SessionId, + Reason = reason, + }).ConfigureAwait(false); + + if (result is { Cancelled: true }) + { + return new GitHubTokenAcquireResultCancelled(); + } + if (result?.Token is not { } token) + { + throw new InvalidOperationException( + "GitHub token provider returned neither a token nor cancellation."); + } + return new GitHubTokenAcquireResultToken + { + AccessToken = token.AccessToken, + TokenType = token.TokenType, + ExpiresIn = token.ExpiresIn, + }; + } + } + /// /// Tells the runtime to route its outbound model-layer requests through this /// client's LLM inference provider. No-op when interception is not configured. @@ -2486,11 +2656,6 @@ private void RegisterSession(CopilotSession session) } } - private void RemoveSession(string sessionId) - { - _sessions.TryRemove(sessionId, out _); - } - /// /// Disposes the synchronously. /// @@ -2701,6 +2866,7 @@ internal record CreateSessionRequest( ContextTier? ContextTier, IList? Tools, bool? EnableCitations, + bool? EnableFileChangeTracking, SystemMessageConfig? SystemMessage, IList? AvailableTools, IList? ExcludedTools, @@ -2708,6 +2874,7 @@ internal record CreateSessionRequest( ProviderConfig? Provider, CapiSessionOptions? Capi, bool? EnableSessionTelemetry, + bool? IsExperimentalMode, bool? RequestPermission, bool? RequestUserInput, bool? RequestExitPlanMode, @@ -2724,6 +2891,7 @@ internal record CreateSessionRequest( string? Agent, [property: JsonPropertyName("configDir")] string? ConfigDirectory, bool? EnableConfigDiscovery, + [property: JsonPropertyName("customAgentsLocalOnly")] bool? CustomAgentsLocalOnly, bool? SkipEmbeddingRetrieval, EmbeddingCacheStorageMode? EmbeddingCacheStorage, string? OrganizationCustomInstructions, @@ -2743,10 +2911,12 @@ internal record CreateSessionRequest( string? Tracestate = null, ModelCapabilitiesOverride? ModelCapabilities = null, string? GitHubToken = null, + [property: JsonPropertyName("gitHubTokenProviderRegistrationId")] string? GitHubTokenProviderRegistrationId = null, RemoteSessionMode? RemoteSession = null, CloudSessionOptions? Cloud = null, IList? InstructionDirectories = null, IList? PluginDirectories = null, + [property: JsonPropertyName("disabledMcpServers")] IList? DisabledMcpServers = null, LargeToolOutputConfig? LargeOutput = null, ToolSearchConfig? ToolSearch = null, MemoryConfiguration? Memory = null, @@ -2762,7 +2932,10 @@ internal record CreateSessionRequest( OptionsUpdateToolFilterPrecedence? ToolFilterPrecedence = null, [property: JsonPropertyName("expAssignments")] CopilotExpAssignmentResponse? ExpAssignments = null, [property: JsonPropertyName("enableManagedSettings")] bool? EnableManagedSettings = null, - bool? EnableGitHubTelemetryForwarding = 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( @@ -2772,7 +2945,8 @@ internal record ToolDefinition( bool? OverridesBuiltInTool = null, bool? SkipPermission = null, CopilotToolDefer? Defer = null, - IDictionary? Metadata = null) + IDictionary? Metadata = null, + bool? IsTerminal = null) { public static ToolDefinition FromAIFunction(AIFunctionDeclaration function) { @@ -2780,11 +2954,13 @@ public static ToolDefinition FromAIFunction(AIFunctionDeclaration function) 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, defer, - metadata); + metadata, + isTerminal ? true : null); } } @@ -2805,6 +2981,7 @@ internal record ResumeSessionRequest( ContextTier? ContextTier, IList? Tools, bool? EnableCitations, + bool? EnableFileChangeTracking, SystemMessageConfig? SystemMessage, IList? AvailableTools, IList? ExcludedTools, @@ -2812,6 +2989,7 @@ internal record ResumeSessionRequest( ProviderConfig? Provider, CapiSessionOptions? Capi, bool? EnableSessionTelemetry, + bool? IsExperimentalMode, bool? RequestPermission, bool? RequestUserInput, bool? RequestExitPlanMode, @@ -2820,6 +2998,7 @@ internal record ResumeSessionRequest( string? WorkingDirectory, [property: JsonPropertyName("configDir")] string? ConfigDirectory, bool? EnableConfigDiscovery, + [property: JsonPropertyName("customAgentsLocalOnly")] bool? CustomAgentsLocalOnly, bool? SkipEmbeddingRetrieval, EmbeddingCacheStorageMode? EmbeddingCacheStorage, string? OrganizationCustomInstructions, @@ -2848,10 +3027,12 @@ internal record ResumeSessionRequest( string? Tracestate = null, ModelCapabilitiesOverride? ModelCapabilities = null, string? GitHubToken = null, + [property: JsonPropertyName("gitHubTokenProviderRegistrationId")] string? GitHubTokenProviderRegistrationId = null, RemoteSessionMode? RemoteSession = null, bool? ContinuePendingWork = null, IList? InstructionDirectories = null, IList? PluginDirectories = null, + [property: JsonPropertyName("disabledMcpServers")] IList? DisabledMcpServers = null, LargeToolOutputConfig? LargeOutput = null, ToolSearchConfig? ToolSearch = null, MemoryConfiguration? Memory = null, @@ -2868,7 +3049,10 @@ internal record ResumeSessionRequest( OptionsUpdateToolFilterPrecedence? ToolFilterPrecedence = null, [property: JsonPropertyName("expAssignments")] CopilotExpAssignmentResponse? ExpAssignments = null, [property: JsonPropertyName("enableManagedSettings")] bool? EnableManagedSettings = null, - bool? EnableGitHubTelemetryForwarding = 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( @@ -2881,7 +3065,7 @@ internal record ResumeSessionResponse( internal record CommandWireDefinition( string Name, - string? Description); + string Description); internal record GetLastSessionIdResponse( string? SessionId); @@ -2909,6 +3093,9 @@ internal record ConnectHandshakeRequest( string? Token, [property: JsonPropertyName("enableGitHubTelemetryForwarding")] bool? EnableGitHubTelemetryForwarding = null); + internal record BuiltinPluginDirectoriesRequest( + string[] Paths); + internal record SetForegroundSessionRequest( string SessionId); @@ -2944,6 +3131,7 @@ internal record HooksInvokeResponse( [JsonSerializable(typeof(GetSessionMetadataRequest))] [JsonSerializable(typeof(GetSessionMetadataResponse))] [JsonSerializable(typeof(ConnectHandshakeRequest))] + [JsonSerializable(typeof(BuiltinPluginDirectoriesRequest))] [JsonSerializable(typeof(McpOAuthTokenStorageMode))] [JsonSerializable(typeof(EmbeddingCacheStorageMode))] [JsonSerializable(typeof(ModelCapabilitiesOverride))] diff --git a/dotnet/src/CopilotTool.cs b/dotnet/src/CopilotTool.cs index e22296bccd..ca62ccc5d7 100644 --- a/dotnet/src/CopilotTool.cs +++ b/dotnet/src/CopilotTool.cs @@ -18,6 +18,9 @@ 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"; @@ -91,7 +94,7 @@ static void ApplyToolInvocationBinding(AIFunctionFactoryOptions factoryOptions) static void ApplyToolOptions(AIFunctionFactoryOptions factoryOptions, CopilotToolOptions? toolOptions) { - if (toolOptions is not null && (toolOptions.OverridesBuiltInTool || toolOptions.SkipPermission || toolOptions.Defer is not null || toolOptions.Metadata is not null)) + 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) @@ -112,6 +115,11 @@ static void ApplyToolOptions(AIFunctionFactoryOptions factoryOptions, CopilotToo additionalProperties[SkipPermissionKey] = true; } + if (toolOptions.IsTerminal) + { + additionalProperties[IsTerminalKey] = true; + } + if (toolOptions.Defer is { } defer) { additionalProperties[DeferKey] = defer; @@ -152,6 +160,16 @@ public sealed class CopilotToolOptions /// 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. /// diff --git a/dotnet/src/Generated/Rpc.cs b/dotnet/src/Generated/Rpc.cs index d09976bc80..f3c1a57e6e 100644 --- a/dotnet/src/Generated/Rpc.cs +++ b/dotnet/src/Generated/Rpc.cs @@ -61,11 +61,36 @@ internal sealed class ConnectResult public string Version { get; set; } = string.Empty; } -/// Parameters for the `server.connect` handshake: an optional connection token and optional connection-level opt-ins (e.g. GitHub telemetry forwarding). +/// Identity of the integrating host, declared once on the `server.connect` handshake so telemetry from this connection is attributed to a single, consistent surface. All fields are optional; omit them to keep the default attribution. +[Experimental(Diagnostics.Experimental)] +internal sealed class ConnectClientInfo +{ + /// Name of the host editor, e.g. `"vscode"`. + [JsonPropertyName("editorName")] + public string? EditorName { get; set; } + + /// Version of the host editor, e.g. `"1.124.2"`. Ignored unless it looks like a version string. + [JsonPropertyName("editorVersion")] + public string? EditorVersion { get; set; } + + /// Name of the Copilot extension within the host, e.g. `"copilot-chat"`. + [JsonPropertyName("extensionName")] + public string? ExtensionName { get; set; } + + /// Version of the Copilot extension within the host, e.g. `"0.54.0"`. Ignored unless it looks like a version string. + [JsonPropertyName("extensionVersion")] + public string? ExtensionVersion { get; set; } +} + +/// Connection-level opt-ins for the `server.connect` handshake. Transport authentication is consumed by the native protocol boundary before dispatch. [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, in addition to the runtime's normal GitHub/CTS emission (dual-write). 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. + /// Identity of the integrating host. Optional; omit it to keep the default attribution. + [JsonPropertyName("clientInfo")] + public ConnectClientInfo? ClientInfo { get; set; } + + /// 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; } @@ -74,7 +99,7 @@ internal sealed class ConnectRequest public string? Token { get; set; } } -/// Active server-driven promotion for a model, including its discount and expiry. +/// Active server-driven promotion for a model, including its discount and optional expiry. [Experimental(Diagnostics.Experimental)] public sealed class ModelBillingPromo { @@ -82,15 +107,15 @@ public sealed class ModelBillingPromo [JsonPropertyName("discountPercent")] public double? DiscountPercent { get; set; } - /// UTC ISO 8601 timestamp marking when the promotion ends. Always present: the API only surfaces a promo whose expiry parses and is in the future. Consumers should treat a past value as expired. + /// 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; } = string.Empty; + 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. + /// 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; } } @@ -111,6 +136,10 @@ public sealed class ModelBillingTokenPricesLongContext [JsonPropertyName("cacheReadPrice")] public double? CacheReadPrice { get; set; } + /// AI Credits cost per billing batch of 1-hour cache-write (cache creation) tokens. + [JsonPropertyName("cacheWrite1hPrice")] + public double? CacheWrite1hPrice { get; set; } + /// AI Credits cost per billing batch of cache-write (cache creation) tokens. [JsonPropertyName("cacheWritePrice")] public double? CacheWritePrice { get; set; } @@ -156,6 +185,10 @@ public sealed class ModelBillingTokenPrices [JsonPropertyName("cacheReadPrice")] public double? CacheReadPrice { get; set; } + /// AI Credits cost per billing batch of 1-hour cache-write (cache creation) tokens. + [JsonPropertyName("cacheWrite1hPrice")] + public double? CacheWrite1hPrice { get; set; } + /// AI Credits cost per billing batch of cache-write (cache creation) tokens. [JsonPropertyName("cacheWritePrice")] public double? CacheWritePrice { get; set; } @@ -197,7 +230,7 @@ public sealed class ModelBilling [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 time-boxed discount. + /// 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; } @@ -274,6 +307,19 @@ public sealed class ModelCapabilities public ModelCapabilitiesSupports? Supports { get; set; } } +/// A service-published message about a model, carrying a stable machine-readable code alongside human-readable text. +[Experimental(Diagnostics.Experimental)] +public sealed class ModelMessage +{ + /// Stable machine-readable identifier for the message, such as `client_version_deprecated`. Hosts can key custom presentation off this; unrecognized codes should fall back to displaying `message`. + [JsonPropertyName("code")] + public string Code { get; set; } = string.Empty; + + /// Human-readable message text intended for display to the user. + [JsonPropertyName("message")] + public string Message { get; set; } = string.Empty; +} + /// Policy state (if applicable). [Experimental(Diagnostics.Experimental)] public sealed class ModelPolicy @@ -287,6 +333,15 @@ public sealed class ModelPolicy public string? Terms { get; set; } } +/// Service-published warning text that hosts should display when presenting a model. +[Experimental(Diagnostics.Experimental)] +public sealed class ModelWarningText +{ + /// Data-retention warning for the model. The text may contain Markdown links and should be rendered as Markdown when supported. + [JsonPropertyName("dataRetention")] + public string? DataRetention { get; set; } +} + /// Copilot model metadata, including identifier, display name, capabilities, policy, billing, reasoning efforts, and picker categories. [Experimental(Diagnostics.Experimental)] public sealed class Model @@ -307,6 +362,10 @@ public sealed class Model [JsonPropertyName("id")] public string Id { get; set; } = string.Empty; + /// Informational notices the service published for this model, such as an upcoming change or a recommended alternative. Present only when the service published at least one notice. Hosts should surface these without implying anything is wrong with the model. + [JsonPropertyName("infoMessages")] + public IList? InfoMessages { get; set; } + /// Model capability category for grouping in the model picker. [JsonPropertyName("modelPickerCategory")] public ModelPickerCategory? ModelPickerCategory { get; set; } @@ -323,9 +382,21 @@ public sealed class Model [JsonPropertyName("policy")] public ModelPolicy? Policy { get; set; } + /// Context-window tiers this model offers, when the provider advertises them independently of tiered token pricing. Copilot models carry their tiers in `billing.tokenPrices`; a provider that has no pricing to publish (an agent host reached over AHP, for example) declares them here instead, so the model picker can still offer the tier toggle. + [JsonPropertyName("supportedContextTiers")] + public IList? SupportedContextTiers { get; set; } + /// Supported reasoning effort levels (only present if model supports reasoning effort). [JsonPropertyName("supportedReasoningEfforts")] public IList? SupportedReasoningEfforts { get; set; } + + /// Warnings the service published for this model, such as a deprecated client version. Present only when the service published at least one warning. The model remains usable; hosts should surface these as advisory rather than blocking. + [JsonPropertyName("warningMessages")] + public IList? WarningMessages { get; set; } + + /// Warning text the service requires hosts to surface for this model. Present only when the service published at least one warning. + [JsonPropertyName("warningText")] + public ModelWarningText? WarningText { get; set; } } /// List of Copilot models available to the resolved user, including capabilities and billing metadata. @@ -341,9 +412,31 @@ public sealed class ModelList [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. + /// GitHub token accepted for compatibility with existing SDK clients. When provided, resolves this token instead of using the current account. [JsonPropertyName("gitHubToken")] public string? GitHubToken { get; set; } + + /// Opaque account identifier returned by `account.getAllUsers`. When omitted, the current account is used. + [JsonPropertyName("selectionId")] + public string? SelectionId { get; set; } +} + +/// 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 provider or provider-model metadata. 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. @@ -439,12 +532,16 @@ public sealed class AccountGetQuotaResult [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. + /// GitHub token accepted for compatibility with existing SDK clients. When provided, resolves this token instead of using the current account. [JsonPropertyName("gitHubToken")] public string? GitHubToken { get; set; } + + /// Opaque account identifier returned by `account.getAllUsers`. When omitted, the current account is used. + [JsonPropertyName("selectionId")] + public string? SelectionId { get; set; } } -/// Initial authentication info for the session. +/// Authentication credentials accepted only at native protocol ingress. Runtime outputs use credential-free `AuthIdentity` metadata. /// Polymorphic base type discriminated by type. [Experimental(Diagnostics.Experimental)] [JsonPolymorphic( @@ -453,6 +550,7 @@ internal sealed class AccountGetQuotaRequest [JsonDerivedType(typeof(AuthInfoHmac), "hmac")] [JsonDerivedType(typeof(AuthInfoEnv), "env")] [JsonDerivedType(typeof(AuthInfoToken), "token")] +[JsonDerivedType(typeof(AuthInfoTokenProvider), "token-provider")] [JsonDerivedType(typeof(AuthInfoCopilotApiToken), "copilot-api-token")] [JsonDerivedType(typeof(AuthInfoUser), "user")] [JsonDerivedType(typeof(AuthInfoGhCli), "gh-cli")] @@ -469,19 +567,23 @@ public partial class AuthInfo [Experimental(Diagnostics.Experimental)] public sealed class CopilotUserResponseEndpoints { - /// Gets or sets the api value. + /// Copilot API endpoint URL. [JsonPropertyName("api")] public string? Api { get; set; } - /// Gets or sets the origin-tracker value. + /// Experimental-service endpoint URL. + [JsonPropertyName("exp")] + public string? Exp { get; set; } + + /// Origin-tracker endpoint URL. [JsonPropertyName("origin-tracker")] public string? OriginTracker { get; set; } - /// Gets or sets the proxy value. + /// Copilot proxy endpoint URL. [JsonPropertyName("proxy")] public string? Proxy { get; set; } - /// Gets or sets the telemetry value. + /// Copilot telemetry endpoint URL. [JsonPropertyName("telemetry")] public string? Telemetry { get; set; } } @@ -489,11 +591,11 @@ public sealed class CopilotUserResponseEndpoints /// RPC data type for CopilotUserResponseOrganizationListItem operations. public sealed class CopilotUserResponseOrganizationListItem { - /// Gets or sets the login value. + /// GitHub login of the organization. [JsonPropertyName("login")] public string? Login { get; set; } - /// Gets or sets the name value. + /// Display name of the organization. [JsonPropertyName("name")] public string? Name { get; set; } } @@ -783,7 +885,7 @@ public sealed class CopilotUserResponse public bool? TokenBasedBilling { get; set; } } -/// Authentication-info variant for GitHub-internal HMAC auth, carrying the public GitHub host and HMAC secret. +/// Authentication-info input variant for GitHub-internal HMAC auth, carrying the public GitHub host and HMAC secret. /// The hmac variant of . [Experimental(Diagnostics.Experimental)] public partial class AuthInfoHmac : AuthInfo @@ -806,7 +908,7 @@ public partial class AuthInfoHmac : AuthInfo public required string Host { get; set; } } -/// Authentication-info variant for a token sourced from an environment variable, with host, optional login, token, and env var name. +/// Authentication-info input 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 partial class AuthInfoEnv : AuthInfo @@ -838,7 +940,7 @@ public partial class AuthInfoEnv : AuthInfo public required string Token { get; set; } } -/// Authentication-info variant for SDK-configured token authentication, carrying host and the secret token value. +/// Authentication-info input variant for SDK-configured token authentication, carrying host and the secret token value. /// The token variant of . [Experimental(Diagnostics.Experimental)] public partial class AuthInfoToken : AuthInfo @@ -856,11 +958,39 @@ public partial class AuthInfoToken : AuthInfo [JsonPropertyName("host")] public required string Host { get; set; } + /// Opaque native GitHub credential registration backing this token identity, when applicable. + [JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)] + [JsonPropertyName("registrationId")] + public string? RegistrationId { get; set; } + /// The token value itself. Treat as a secret. [JsonPropertyName("token")] public required string Token { get; set; } } +/// Authentication-info variant backed by an SDK GitHub token callback. It carries routing metadata but never a plaintext token. +/// The token-provider variant of . +[Experimental(Diagnostics.Experimental)] +public partial class AuthInfoTokenProvider : AuthInfo +{ + /// + [JsonIgnore] + public override string Type => "token-provider"; + + /// Snapshot of the authenticated user's Copilot subscription info, if known. + [JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)] + [JsonPropertyName("copilotUser")] + public CopilotUserResponse? CopilotUser { get; set; } + + /// Authentication host. + [JsonPropertyName("host")] + public required string Host { get; set; } + + /// Opaque SDK callback registration identifier. + [JsonPropertyName("registrationId")] + public required string RegistrationId { get; set; } +} + /// 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)] @@ -903,7 +1033,7 @@ public partial class AuthInfoUser : AuthInfo public required string Login { get; set; } } -/// Authentication-info variant for GitHub CLI credentials, carrying host, login, and the `gh auth token` value. +/// Authentication-info input variant for GitHub CLI credentials, carrying host, login, and the `gh auth token` value. /// The gh-cli variant of . [Experimental(Diagnostics.Experimental)] public partial class AuthInfoGhCli : AuthInfo @@ -930,7 +1060,7 @@ public partial class AuthInfoGhCli : AuthInfo public required string Token { get; set; } } -/// Authentication-info variant for API-key authentication to a non-GitHub LLM provider, carrying the secret `apiKey` and host. +/// Authentication-info input 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)] public partial class AuthInfoApiKey : AuthInfo @@ -966,7 +1096,7 @@ public sealed class AccountGetCurrentAuthResult public AuthInfo? AuthInfo { get; set; } } -/// Authenticated account entry returned by `account.getAllUsers`, with auth info and an optional associated token. +/// Authenticated account entry returned by `account.getAllUsers`. [Experimental(Diagnostics.Experimental)] public sealed class AccountAllUsers { @@ -974,6 +1104,10 @@ public sealed class AccountAllUsers [JsonPropertyName("authInfo")] public AuthInfo AuthInfo { get => field ??= new(); set; } + /// Opaque identifier accepted by account and model selection APIs. + [JsonPropertyName("selectionId")] + public string? SelectionId { get; set; } + /// Associated token, if available. [JsonPropertyName("token")] public string? Token { get; set; } @@ -988,7 +1122,7 @@ public sealed class AccountLoginResult public bool StoredInVault { get; set; } } -/// Credentials to store after successful authentication. +/// Credentials to validate and store. Omit login to resolve the authenticated user from the token. [Experimental(Diagnostics.Experimental)] internal sealed class AccountLoginRequest { @@ -996,9 +1130,9 @@ internal sealed class AccountLoginRequest [JsonPropertyName("host")] public string Host { get; set; } = string.Empty; - /// User login/username. + /// User login/username. When omitted, the runtime validates the token and resolves the login from GitHub. [JsonPropertyName("login")] - public string Login { get; set; } = string.Empty; + public string? Login { get; set; } /// GitHub authentication token. [JsonPropertyName("token")] @@ -1020,7 +1154,11 @@ internal sealed class AccountLogoutRequest { /// Authentication information for the user to log out. [JsonPropertyName("authInfo")] - public AuthInfo AuthInfo { get => field ??= new(); set; } + public AuthInfo? AuthInfo { get; set; } + + /// Opaque account identifier returned by `account.getAllUsers`. + [JsonPropertyName("selectionId")] + public string? SelectionId { get; set; } } /// Confirmation that the secret values were registered. @@ -1091,7012 +1229,7583 @@ internal sealed class McpDiscoverRequest public string? WorkingDirectory { get; set; } } -/// User-configured MCP servers, keyed by server name. +/// Outcome of an mcp.planInstall call: either a normalised plan, or one typed refusal. Nothing is written in either case. +/// Polymorphic base type discriminated by kind. [Experimental(Diagnostics.Experimental)] -public sealed class McpConfigList +[JsonPolymorphic( + TypeDiscriminatorPropertyName = "kind", + UnknownDerivedTypeHandling = JsonUnknownDerivedTypeHandling.FallBackToBaseType)] +[JsonDerivedType(typeof(McpPlanInstallResultPlanned), "planned")] +[JsonDerivedType(typeof(McpPlanInstallResultNegotiationRefused), "negotiation-refused")] +[JsonDerivedType(typeof(McpPlanInstallResultHandleRejected), "handle-rejected")] +[JsonDerivedType(typeof(McpPlanInstallResultInvalidRequest), "invalid-request")] +[JsonDerivedType(typeof(McpPlanInstallResultAuthenticationRequired), "authentication-required")] +[JsonDerivedType(typeof(McpPlanInstallResultPolicyRejected), "policy-rejected")] +[JsonDerivedType(typeof(McpPlanInstallResultNetworkFailure), "network-failure")] +[JsonDerivedType(typeof(McpPlanInstallResultUnsafeRetrieval), "unsafe-retrieval")] +[JsonDerivedType(typeof(McpPlanInstallResultMalformedCard), "malformed-card")] +[JsonDerivedType(typeof(McpPlanInstallResultContractViolation), "contract-violation")] +[JsonDerivedType(typeof(McpPlanInstallResultUnavailableTransport), "unavailable-transport")] +[JsonDerivedType(typeof(McpPlanInstallResultNotInstallable), "not-installable")] +[JsonDerivedType(typeof(McpPlanInstallResultUnavailable), "unavailable")] +public partial class McpPlanInstallResult { - /// All MCP servers from user config, keyed by name. - [JsonPropertyName("servers")] - public IDictionary Servers { get => field ??= new Dictionary(); set; } + /// The type discriminator. + [JsonPropertyName("kind")] + public virtual string Kind { get; set; } = string.Empty; } -/// MCP server name and configuration to add to user configuration. + +/// The protocol version and capability set the runtime actually honoured for a successful catalog operation. [Experimental(Diagnostics.Experimental)] -internal sealed class McpConfigAddRequest +public sealed class CatalogNegotiatedContract { - /// MCP server configuration (stdio process or remote HTTP/SSE). - [JsonPropertyName("config")] - public JsonElement Config { get; set; } + /// Wire features the runtime understood for this operation. Always a superset of the caller's required features, because any shortfall is a refusal instead. Operation availability remains a separate typed result. + [JsonPropertyName("grantedCapabilities")] + public IList GrantedCapabilities { 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; + /// Protocol version of the runtime that served the request. + [JsonPropertyName("runtimeProtocolVersion")] + public long RuntimeProtocolVersion { get; set; } } -/// MCP server name and replacement configuration to write to user configuration. +/// One change applying the plan would make, described rather than serialised so the configuration payload stays behind the runtime boundary. [Experimental(Diagnostics.Experimental)] -internal sealed class McpConfigUpdateRequest +public sealed class McpPlanConfigurationChange { - /// MCP server configuration (stdio process or remote HTTP/SSE). - [JsonPropertyName("config")] - public JsonElement Config { get; set; } + /// Names of the configuration fields the change would set, without their values. + [JsonPropertyName("changedFields")] + public IList ChangedFields { get => field ??= []; set; } - /// Name of the MCP server to update. - [RegularExpression("^[^\\x00-\\x1f/\\x7f-\\x9f}]+(?:\\/[^\\x00-\\x1f/\\x7f-\\x9f}]+)*$")] + /// Configuration key the change applies to. [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; -} + [JsonPropertyName("configKey")] + public string ConfigKey { get; set; } = string.Empty; -/// MCP server name to remove from user configuration. -[Experimental(Diagnostics.Experimental)] -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; -} + /// Whether the change would create a new entry or modify an existing one. + [JsonPropertyName("operation")] + public McpPlanConfigurationOperation Operation { get; set; } -/// MCP server names to enable for new sessions. -[Experimental(Diagnostics.Experimental)] -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; } -} + /// Scope the change would be written to. + [JsonPropertyName("scope")] + public McpPlanScope Scope { get; set; } -/// MCP server names to disable for new sessions. -[Experimental(Diagnostics.Experimental)] -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; } + /// Secret placeholders the written configuration would reference. The constrained placeholder type cannot carry a literal secret value. + [JsonPropertyName("secretReferences")] + public IList SecretReferences { get => field ??= []; set; } } -/// Information about an installed plugin tracked in global state. +/// Normalised identity of the MCP server a plan targets, independent of how the card spelled it. [Experimental(Diagnostics.Experimental)] -public sealed class InstalledPluginInfo +public sealed class McpPlanResourceIdentity { - /// 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 for new sessions. - [JsonPropertyName("enabled")] - public bool Enabled { get; set; } + /// Canonical, normalised name of the server, for example `io.github.owner/server`. + [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("canonicalName")] + public string CanonicalName { get; set; } = string.Empty; - /// Marketplace the plugin came from. Empty string ("") for direct repo / URL / local installs. - [JsonPropertyName("marketplace")] - public string Marketplace { get; set; } = string.Empty; + /// Registry identifier of the server, when it came from a registry. + [JsonPropertyName("registryId")] + public string? RegistryId { get; set; } - /// Plugin name. - [JsonPropertyName("name")] - public string Name { get; set; } = string.Empty; + /// Local configuration key the server would be recorded under. + [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; - /// Installed version (when reported by the plugin manifest). + /// Version advertised by the card, when it declares one. [JsonPropertyName("version")] public string? Version { get; set; } } -/// Plugins installed in user/global state. +/// Outcome of evaluating the planned server against registry and enterprise policy. Evaluation is read-only. [Experimental(Diagnostics.Experimental)] -public sealed class PluginListResult +public sealed class McpPlanPolicyResult { - /// Installed plugins. - [JsonPropertyName("plugins")] - public IList Plugins { get => field ??= []; set; } + /// What policy decided for this server. + [JsonPropertyName("decision")] + public McpPlanPolicyDecision Decision { get; set; } + + /// Human-readable explanation, safe to surface. Never contains a query, URL, handle, or secret. + [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(1000)] + [JsonPropertyName("reason")] + public string? Reason { get; set; } + + /// Which authority produced the decision. + [JsonPropertyName("source")] + public McpPlanPolicySource Source { get; set; } } -/// Result of installing a plugin. +/// Semantic digest of a strictly parsed and schema-validated JSON MCP card. Both URL-backed and embedded cards are canonicalised with RFC 8785 JSON Canonicalization Scheme, encoded as UTF-8, and hashed with SHA-256. [Experimental(Diagnostics.Experimental)] -public sealed class PluginInstallResult +public sealed class CardDigest { - /// 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; } - - /// Optional post-install message provided by the plugin (e.g. setup instructions). - [JsonPropertyName("postInstallMessage")] - public string? PostInstallMessage { get; set; } + /// Digest algorithm and canonical representation. + [JsonPropertyName("algorithm")] + public CardDigestAlgorithm Algorithm { get; set; } - /// Number of skills discovered and installed from the plugin. - [JsonPropertyName("skillsInstalled")] - public long SkillsInstalled { get; set; } + /// SHA-256 digest of the RFC 8785 canonical UTF-8 bytes, encoded as exactly 64 lowercase hexadecimal characters. + [RegularExpression("^[0-9a-f]{64}$")] + [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(64)] + [MaxLength(64)] + [JsonPropertyName("value")] + public string Value { get; set; } = string.Empty; } -/// Plugin source and optional working directory for relative-path resolution. +/// Provenance of the exact validated JSON MCP card content bound privately to a completed plan and its opaque handle. [Experimental(Diagnostics.Experimental)] -internal sealed class PluginsInstallRequest +public sealed class McpPlanProvenance { - /// 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; + /// Authority associated with the validated card, without path, query, or credentials. Inert untrusted data. + [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("authority")] + public string Authority { 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; } + /// Semantic digest of the exact validated JSON content bound to the plan handle. + [JsonPropertyName("cardDigest")] + public CardDigest CardDigest { get => field ??= new(); set; } + + /// JSON MCP media type the validated card was interpreted as. + [JsonPropertyName("mediaType")] + public McpServerCardMediaType MediaType { get; set; } + + /// ISO 8601 timestamp at which the runtime completed strict parsing and schema validation of the card content. + [JsonPropertyName("validatedAt")] + public string ValidatedAt { get; set; } = string.Empty; } -/// Name (or spec) of the plugin to uninstall. +/// Where a plan would be written. [Experimental(Diagnostics.Experimental)] -internal sealed class PluginsUninstallRequest +public sealed class McpPlanTarget { - /// 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; } + /// Configuration key the server would be recorded under within that scope. + [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("configKey")] + public string ConfigKey { get; set; } = string.Empty; - /// Plugin name or "plugin@marketplace" spec to uninstall. When ambiguous, prefer the fully-qualified spec. - [JsonPropertyName("name")] - public string Name { get; set; } = string.Empty; + /// Configuration scope the plan targets. + [JsonPropertyName("scope")] + public McpPlanScope Scope { get; set; } } -/// Result of updating a single plugin. +/// One eligible way to run the server, represented as a tagged package or remote variant so package identity and endpoint states cannot contradict the install method. +/// Polymorphic base type discriminated by installMethod. [Experimental(Diagnostics.Experimental)] -public sealed class PluginUpdateResult +[JsonPolymorphic( + TypeDiscriminatorPropertyName = "installMethod", + UnknownDerivedTypeHandling = JsonUnknownDerivedTypeHandling.FallBackToBaseType)] +[JsonDerivedType(typeof(McpPlanTransportChoicePackage), "package")] +[JsonDerivedType(typeof(McpPlanTransportChoiceRemote), "remote")] +public partial class McpPlanTransportChoice { - /// Version after the update, when reported by the plugin manifest. - [JsonPropertyName("newVersion")] - public string? NewVersion { get; set; } - - /// Version that was previously installed, when available. - [JsonPropertyName("previousVersion")] - public string? PreviousVersion { get; set; } - - /// Number of skills discovered and installed after the update. - [JsonPropertyName("skillsInstalled")] - public long SkillsInstalled { get; set; } + /// The type discriminator. + [JsonPropertyName("installMethod")] + public virtual string InstallMethod { get; set; } = string.Empty; } -/// Name (or spec) of the plugin to update. + +/// One non-secret value a transport choice needs, represented as a scalar or enumerated variant so enum values cannot be missing or attached to another type. +/// Polymorphic base type discriminated by kind. [Experimental(Diagnostics.Experimental)] -internal sealed class PluginsUpdateRequest +[JsonPolymorphic( + TypeDiscriminatorPropertyName = "kind", + UnknownDerivedTypeHandling = JsonUnknownDerivedTypeHandling.FallBackToBaseType)] +[JsonDerivedType(typeof(McpPlanRequiredValueScalar), "scalar")] +[JsonDerivedType(typeof(McpPlanRequiredValueEnum), "enum")] +public partial class McpPlanRequiredValue { - /// Plugin name or "plugin@marketplace" spec to update. - [JsonPropertyName("name")] - public string Name { get; set; } = string.Empty; + /// The type discriminator. + [JsonPropertyName("kind")] + public virtual string Kind { get; set; } = string.Empty; } -/// Per-plugin result from updating all plugins, with versions, skills installed, success flag, and optional error. + +/// One non-secret scalar value a transport choice needs before it can be applied. +/// The scalar variant of . [Experimental(Diagnostics.Experimental)] -public sealed class PluginUpdateAllEntry +public partial class McpPlanRequiredValueScalar : McpPlanRequiredValue { - /// Error message (failure only). - [JsonPropertyName("error")] - public string? Error { get; set; } + /// + [JsonIgnore] + public override string Kind => "scalar"; - /// Marketplace the plugin came from. Empty string ("") for direct installs. - [JsonPropertyName("marketplace")] - public string Marketplace { get; set; } = string.Empty; + /// Where the value is applied when the server is launched. + [JsonPropertyName("category")] + public required McpPlanValueCategory Category { get; set; } - /// Plugin name that was updated. - [JsonPropertyName("name")] - public string Name { get; set; } = string.Empty; + /// Default supplied by the card, when the value can be resolved without input. Presence is the authoritative indication that a default exists. Inert untrusted data. + [JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)] + [JsonPropertyName("defaultValue")] + public string? DefaultValue { get; set; } - /// Version after the update, when available. - [JsonPropertyName("newVersion")] - public string? NewVersion { get; set; } + /// Human-readable explanation from the card. Inert untrusted text. + [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(1000)] + [JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)] + [JsonPropertyName("description")] + public string? Description { get; set; } - /// Previously installed version, when available. - [JsonPropertyName("previousVersion")] - public string? PreviousVersion { get; set; } + /// Whether the value may be supplied more than once. + [JsonPropertyName("isRepeated")] + public required bool IsRepeated { get; set; } - /// Number of skills installed after the update (success only). - [JsonPropertyName("skillsInstalled")] - public long? SkillsInstalled { get; set; } + /// Key the value is supplied under. Inert untrusted data. + [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("key")] + public required string Key { get; set; } - /// Whether the update succeeded for this plugin. - [JsonPropertyName("success")] - public bool Success { get; set; } + /// Whether the value must be present for the plan to be applicable. + [JsonPropertyName("required")] + public required bool Required { get; set; } + + /// Human-readable label from the card. Inert untrusted text. + [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(200)] + [JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)] + [JsonPropertyName("title")] + public string? Title { get; set; } + + /// Scalar type the value must conform to. + [JsonPropertyName("valueType")] + public required McpPlanScalarValueType ValueType { get; set; } } -/// Result of updating all installed plugins. +/// One enumerated non-secret value a transport choice needs before it can be applied. The permitted values are structurally required. +/// The enum variant of . [Experimental(Diagnostics.Experimental)] -public sealed class PluginUpdateAllResult +public partial class McpPlanRequiredValueEnum : McpPlanRequiredValue { - /// Per-plugin update results in deterministic order. - [JsonPropertyName("results")] - public IList Results { get => field ??= []; set; } + /// + [JsonIgnore] + public override string Kind => "enum"; + + /// Where the value is applied when the server is launched. + [JsonPropertyName("category")] + public required McpPlanValueCategory Category { get; set; } + + /// Default supplied by the card, when the value can be resolved without input. Presence is the authoritative indication that a default exists. Inert untrusted data. + [JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)] + [JsonPropertyName("defaultValue")] + public string? DefaultValue { get; set; } + + /// Human-readable explanation from the card. Inert untrusted text. + [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(1000)] + [JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)] + [JsonPropertyName("description")] + public string? Description { get; set; } + + /// Non-empty permitted value set. Inert untrusted data. + [JsonPropertyName("enumValues")] + public required IList EnumValues { get; set; } + + /// Whether the value may be supplied more than once. + [JsonPropertyName("isRepeated")] + public required bool IsRepeated { get; set; } + + /// Key the value is supplied under. Inert untrusted data. + [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("key")] + public required string Key { get; set; } + + /// Whether the value must be present for the plan to be applicable. + [JsonPropertyName("required")] + public required bool Required { get; set; } + + /// Human-readable label from the card. Inert untrusted text. + [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(200)] + [JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)] + [JsonPropertyName("title")] + public string? Title { get; set; } + + /// Discriminator: the value must be one of `enumValues`. + [JsonPropertyName("valueType")] + public required McpPlanEnumValueType ValueType { get; set; } } -/// Plugin names (or specs) to enable. +/// A secret a transport choice needs, referenced by placeholder. No secret value ever appears in a plan, and the placeholder resolves against the keychain only when a plan is applied. [Experimental(Diagnostics.Experimental)] -internal sealed class PluginsEnableRequest +public sealed class McpPlanSecretPlaceholder { - /// 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; } + /// Key the secret is supplied under. Inert untrusted data. + [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("key")] + public string Key { get; set; } = string.Empty; + + /// The runtime-assigned `${secret:<id>}` placeholder written into configuration in place of the value. + [JsonPropertyName("placeholder")] + public string Placeholder { get; set; } = string.Empty; + + /// Human-readable label from the card. Inert untrusted text. + [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(200)] + [JsonPropertyName("title")] + public string? Title { get; set; } } -/// Plugin names (or specs) to disable. +/// An eligible local-package transport choice. Package identity is required and a remote endpoint cannot be represented. +/// The package variant of . [Experimental(Diagnostics.Experimental)] -internal sealed class PluginsDisableRequest +public partial class McpPlanTransportChoicePackage : McpPlanTransportChoice { - /// 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; } + /// + [JsonIgnore] + public override string InstallMethod => "package"; + + /// Stable identifier for this choice within the plan, used to select it when the plan is applied. + [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(128)] + [JsonPropertyName("choiceId")] + public required string ChoiceId { get; set; } + + /// Package identifier. Inert untrusted data. + [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(512)] + [JsonPropertyName("packageIdentifier")] + public required string PackageIdentifier { get; set; } + + /// Packaging ecosystem, for example `oci` or `npm`. + [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(64)] + [JsonPropertyName("packageType")] + public required string PackageType { get; set; } + + /// Typed values this choice requires, excluding secrets. + [JsonPropertyName("requiredValues")] + public required IList RequiredValues { get; set; } + + /// Secrets this choice requires, referenced by placeholder only. + [JsonPropertyName("secretPlaceholders")] + public required IList SecretPlaceholders { get; set; } + + /// Local process transport this package choice would use. + [JsonPropertyName("transport")] + public required McpPlanPackageTransport Transport { get; set; } } -/// Registered marketplace summary. +/// An eligible remote-endpoint transport choice. The endpoint is required and package identity cannot be represented. +/// The remote variant of . [Experimental(Diagnostics.Experimental)] -public sealed class MarketplaceInfo +public partial class McpPlanTransportChoiceRemote : McpPlanTransportChoice { - /// True when this is a default marketplace shipped with the runtime. Defaults are not removable. - [JsonPropertyName("isDefault")] - public bool? IsDefault { get; set; } + /// + [JsonIgnore] + public override string InstallMethod => "remote"; - /// Marketplace name (matches the @marketplace suffix in plugin specs). - [JsonPropertyName("name")] - public string Name { get; set; } = string.Empty; + /// Stable identifier for this choice within the plan, used to select it when the plan is applied. + [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(128)] + [JsonPropertyName("choiceId")] + public required string ChoiceId { 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; + /// Endpoint URL. Inert untrusted data. + [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(2048)] + [JsonPropertyName("endpoint")] + public required string Endpoint { get; set; } + + /// Typed values this choice requires, excluding secrets. + [JsonPropertyName("requiredValues")] + public required IList RequiredValues { get; set; } + + /// Secrets this choice requires, referenced by placeholder only. + [JsonPropertyName("secretPlaceholders")] + public required IList SecretPlaceholders { get; set; } + + /// Endpoint transport this remote choice would use. + [JsonPropertyName("transport")] + public required McpPlanRemoteTransport Transport { get; set; } } -/// All registered marketplaces, including built-in defaults. +/// A normalised, inert description of what installing an MCP server would involve. Carries no raw card, no install specification, and no secret value. [Experimental(Diagnostics.Experimental)] -public sealed class MarketplaceListResult +public sealed class McpInstallPlan { - /// Registered marketplaces. - [JsonPropertyName("marketplaces")] - public IList Marketplaces { get => field ??= []; set; } + /// The configuration changes installing would make, described rather than serialised, so the mutable configuration payload stays behind the runtime boundary. + [JsonPropertyName("configurationChanges")] + public IList ConfigurationChanges { get => field ??= []; set; } + + /// Normalised identity of the server the plan would install. + [JsonPropertyName("identity")] + public McpPlanResourceIdentity Identity { get => field ??= new(); set; } + + /// Opaque, runtime-instance scoped, TTL-bound, single-use handle for this plan. Rejected when stale, replayed, or presented to a different runtime instance. Never logged. + [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("planHandle")] + public string PlanHandle { get; set; } = string.Empty; + + /// ISO 8601 timestamp after which the plan handle is stale and will be rejected. Abandoning a plan needs no call: an unused handle simply expires, so cancellation before commit is side-effect free. + [JsonPropertyName("planHandleExpiresAt")] + public string PlanHandleExpiresAt { get; set; } = string.Empty; + + /// Outcome of evaluating the server against registry and enterprise policy. + [JsonPropertyName("policy")] + public McpPlanPolicyResult Policy { get => field ??= new(); set; } + + /// Origin and semantic digest of the exact validated JSON MCP card content bound to this plan. + [JsonPropertyName("provenance")] + public McpPlanProvenance Provenance { get => field ??= new(); set; } + + /// Identifier of the choice the runtime would pick by default. Omitted when there is no eligible transport, or when the runtime expresses no preference. + [JsonPropertyName("recommendedTransportChoiceId")] + public string? RecommendedTransportChoiceId { get; set; } + + /// Whether applying this plan would require an MCP reload to take effect. Planning itself never reloads. + [JsonPropertyName("reloadRequired")] + public bool ReloadRequired { get; set; } + + /// Whether the plan cannot be applied without further input, because a required value has no default or a secret must be supplied. + [JsonPropertyName("requiresInteractiveConfiguration")] + public bool RequiresInteractiveConfiguration { get; set; } + + /// Configuration scope and key the plan would write to. + [JsonPropertyName("target")] + public McpPlanTarget Target { get => field ??= new(); set; } + + /// Every eligible transport, so a host can present an explicit choice. A completed plan always has at least one; when none is eligible, planning returns `CatalogUnavailableTransportError` instead. + [JsonPropertyName("transportChoices")] + public IList TransportChoices { get => field ??= []; set; } } -/// Result of registering a new marketplace. +/// A computed MCP install plan. Nothing has been applied: the plan describes what installing would change, and the plan handle is what a later apply operation would consume. +/// The planned variant of . [Experimental(Diagnostics.Experimental)] -public sealed class MarketplaceAddResult +public partial class McpPlanInstallResultPlanned : McpPlanInstallResult { - /// Final name of the marketplace as resolved from its manifest. - [JsonPropertyName("name")] - public string Name { get; set; } = string.Empty; + /// + [JsonIgnore] + public override string Kind => "planned"; + + /// Protocol version and capabilities the runtime honoured. + [JsonPropertyName("negotiated")] + public required CatalogNegotiatedContract Negotiated { get; set; } + + /// The normalised plan. + [JsonPropertyName("plan")] + public required McpInstallPlan Plan { get; set; } } -/// Marketplace source and optional working directory for relative-path resolution. +/// The caller's protocol version or required capabilities cannot be honoured. Returned instead of a partial or ambiguous success. +/// The negotiation-refused variant of . [Experimental(Diagnostics.Experimental)] -internal sealed class PluginsMarketplacesAddRequest +public partial class McpPlanInstallResultNegotiationRefused : McpPlanInstallResult { - /// 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; + /// + [JsonIgnore] + public override string Kind => "negotiation-refused"; - /// 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; } + /// Human-readable explanation, safe to surface. Never contains a query, URL, handle, or secret. + [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(1000)] + [JsonPropertyName("message")] + public required string Message { get; set; } + + /// Lowest caller protocol version this runtime will serve. + [JsonPropertyName("minimumSupportedProtocolVersion")] + public required long MinimumSupportedProtocolVersion { get; set; } + + /// Whether the version or the capability set was the problem. + [JsonPropertyName("reason")] + public required CatalogNegotiationRefusedReason Reason { get; set; } + + /// Protocol version of the runtime that refused the request. + [JsonPropertyName("runtimeProtocolVersion")] + public required long RuntimeProtocolVersion { get; set; } + + /// Every wire feature this runtime understands, so the caller can retry within that contract. This list does not imply that every deployment has enabled every operation. + [JsonPropertyName("supportedCapabilities")] + public required IList SupportedCapabilities { get; set; } + + /// The subset of the caller's bounded extensible capability identifiers this runtime cannot honour. + [JsonPropertyName("unsupportedCapabilities")] + public required IList UnsupportedCapabilities { get; set; } } -/// Outcome of the remove attempt, including dependent-plugin info when applicable. +/// A presented handle was not accepted. Handles are runtime-instance scoped, TTL-bound, and single-use, so each way of failing is reported distinctly. +/// The handle-rejected variant of . [Experimental(Diagnostics.Experimental)] -public sealed class MarketplaceRemoveResult +public partial class McpPlanInstallResultHandleRejected : McpPlanInstallResult { - /// Names of installed plugins that prevented removal. Populated only when `removed=false`. - [JsonPropertyName("dependentPlugins")] - public IList? DependentPlugins { get; set; } + /// + [JsonIgnore] + public override string Kind => "handle-rejected"; - /// 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; } + /// Which kind of handle was presented. + [JsonPropertyName("handleType")] + public required CatalogHandleType HandleType { get; set; } + + /// Human-readable explanation, safe to surface. Never contains the handle itself, nor a query, URL, or secret. + [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(1000)] + [JsonPropertyName("message")] + public required string Message { get; set; } + + /// Why the handle was rejected. + [JsonPropertyName("reason")] + public required CatalogHandleRejectionReason Reason { get; set; } } -/// Name of the marketplace to remove and an optional force flag. +/// The request was rejected before any work was done, because a bounded field fell outside its permitted range or a required field was unusable. +/// The invalid-request variant of . [Experimental(Diagnostics.Experimental)] -internal sealed class PluginsMarketplacesRemoveRequest +public partial class McpPlanInstallResultInvalidRequest : McpPlanInstallResult { - /// 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; } + /// + [JsonIgnore] + public override string Kind => "invalid-request"; - /// Marketplace name to remove. - [JsonPropertyName("name")] - public string Name { get; set; } = string.Empty; + /// Which request field was rejected. + [JsonPropertyName("field")] + public required CatalogInvalidRequestField Field { get; set; } + + /// Human-readable explanation, safe to surface. Never echoes the offending value, nor a query, URL, handle, or secret. + [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(1000)] + [JsonPropertyName("message")] + public required string Message { get; set; } } -/// Plugin entry advertised by a marketplace. +/// An optional catalog authentication exchange did not establish the caller's identity. Anonymous search remains supported; this refusal is reserved for an operation that cannot continue after the attempted exchange. It is distinct from `policy-rejected` and from a network failure, and the reason identifies the recovery action. +/// The authentication-required variant of . [Experimental(Diagnostics.Experimental)] -public sealed class MarketplacePluginInfo +public partial class McpPlanInstallResultAuthenticationRequired : McpPlanInstallResult { - /// Short description from the marketplace catalog, when present. - [JsonPropertyName("description")] - public string? Description { get; set; } + /// + [JsonIgnore] + public override string Kind => "authentication-required"; - /// Plugin name as listed in the marketplace catalog. - [JsonPropertyName("name")] - public string Name { get; set; } = string.Empty; + /// Human-readable explanation, safe to surface. Never contains a credential or token, nor a query, URL, handle, or secret. + [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(1000)] + [JsonPropertyName("message")] + public required string Message { get; set; } + + /// Why authentication failed. Only an expired credential justifies attempting a silent refresh; an absent or rejected credential requires sign-in. + [JsonPropertyName("reason")] + public required CatalogAuthenticationRequiredReason Reason { get; set; } } -/// Plugins advertised by the marketplace. +/// Registry or enterprise policy refused the operation. +/// The policy-rejected variant of . [Experimental(Diagnostics.Experimental)] -public sealed class MarketplaceBrowseResult +public partial class McpPlanInstallResultPolicyRejected : McpPlanInstallResult { - /// Plugins advertised by the marketplace. - [JsonPropertyName("plugins")] - public IList Plugins { get => field ??= []; set; } + /// + [JsonIgnore] + public override string Kind => "policy-rejected"; + + /// Human-readable explanation, safe to surface. Never contains a query, URL, handle, or secret. + [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(1000)] + [JsonPropertyName("message")] + public required string Message { get; set; } + + /// Which authority produced the decision. + [JsonPropertyName("source")] + public required McpPlanPolicySource Source { get; set; } } -/// Name of the marketplace whose plugin catalog to fetch. +/// The runtime could not reach the catalog authority or retrieve a card. Covers being offline as well as transport-level failure. +/// The network-failure variant of . [Experimental(Diagnostics.Experimental)] -internal sealed class PluginsMarketplacesBrowseRequest +public partial class McpPlanInstallResultNetworkFailure : McpPlanInstallResult { - /// Marketplace name to browse. - [JsonPropertyName("name")] - public string Name { get; set; } = string.Empty; + /// + [JsonIgnore] + public override string Kind => "network-failure"; + + /// Human-readable explanation, safe to surface. Never contains a query, URL, handle, or secret. + [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(1000)] + [JsonPropertyName("message")] + public required string Message { get; set; } + + /// Categorised failure, low cardinality so it can be aggregated without carrying a URL. + [JsonPropertyName("reason")] + public required CatalogNetworkFailureReason Reason { get; set; } + + /// HTTP status code, when the failure was a rejected response. + [JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)] + [JsonPropertyName("statusCode")] + public int? StatusCode { get; set; } } -/// Per-marketplace refresh result, including marketplace name, success flag, and optional failure error. +/// Retrieval was refused by the runtime's hardened fetch boundary before any request left the process, or before a redirect was followed. +/// The unsafe-retrieval variant of . [Experimental(Diagnostics.Experimental)] -public sealed class MarketplaceRefreshEntry +public partial class McpPlanInstallResultUnsafeRetrieval : McpPlanInstallResult { - /// Error message (failure only). - [JsonPropertyName("error")] - public string? Error { get; set; } + /// + [JsonIgnore] + public override string Kind => "unsafe-retrieval"; - /// Marketplace name that was refreshed. - [JsonPropertyName("name")] - public string Name { get; set; } = string.Empty; + /// Human-readable explanation, safe to surface. Never contains the refused URL, nor a query, handle, or secret. + [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(1000)] + [JsonPropertyName("message")] + public required string Message { get; set; } - /// Whether the refresh succeeded. - [JsonPropertyName("success")] - public bool Success { get; set; } + /// Which control refused the retrieval, low cardinality so it can be aggregated without carrying a URL. + [JsonPropertyName("reason")] + public required CatalogUnsafeRetrievalReason Reason { get; set; } } -/// Result of refreshing one or more marketplace catalogs. +/// A card could not be parsed or did not satisfy its declared media type's schema. +/// The malformed-card variant of . [Experimental(Diagnostics.Experimental)] -public sealed class MarketplaceRefreshResult +public partial class McpPlanInstallResultMalformedCard : McpPlanInstallResult { - /// Per-marketplace refresh results in deterministic order. - [JsonPropertyName("results")] - public IList Results { get => field ??= []; set; } + /// + [JsonIgnore] + public override string Kind => "malformed-card"; + + /// Media type the card was interpreted as, when it declared one this runtime recognises. + [JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)] + [JsonPropertyName("mediaType")] + public CatalogMediaType? MediaType { get; set; } + + /// Human-readable explanation, safe to surface. Never echoes card content, nor a query, URL, handle, or secret. + [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(1000)] + [JsonPropertyName("message")] + public required string Message { get; set; } + + /// How the card failed validation. + [JsonPropertyName("reason")] + public required CatalogMalformedCardReason Reason { get; set; } } -/// RPC data type for PluginsMarketplacesRefresh operations. +/// An upstream catalog response broke the wire contract. Most importantly, every result must carry exactly one of a URL or embedded data: a result carrying both, or neither, is refused here rather than being guessed at. +/// The contract-violation variant of . [Experimental(Diagnostics.Experimental)] -internal sealed class PluginsMarketplacesRefreshRequest +public partial class McpPlanInstallResultContractViolation : McpPlanInstallResult { - /// Marketplace name to refresh. When omitted, every registered marketplace is refreshed. - [JsonPropertyName("name")] - public string? Name { get; set; } + /// + [JsonIgnore] + public override string Kind => "contract-violation"; + + /// Human-readable explanation, safe to surface. Never echoes response content, nor a query, URL, handle, or secret. + [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(1000)] + [JsonPropertyName("message")] + public required string Message { get; set; } + + /// Which rule the response broke. + [JsonPropertyName("reason")] + public required CatalogContractViolationReason Reason { get; set; } } -/// Server-side skill metadata, including name, description, source, enabled/invocable state, path, project path, and argument hint. +/// No transport this runtime can use is available for the requested server. +/// The unavailable-transport variant of . [Experimental(Diagnostics.Experimental)] -public sealed class ServerSkill +public partial class McpPlanInstallResultUnavailableTransport : McpPlanInstallResult { - /// Optional freeform hint describing the skill's expected arguments, from the `argument-hint` frontmatter field. - [JsonPropertyName("argumentHint")] - public string? ArgumentHint { get; set; } - - /// 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 string? Path { get; set; } - - /// The project path this skill belongs to (only for project/inherited skills). - [JsonPropertyName("projectPath")] - public string? ProjectPath { get; set; } + /// + [JsonIgnore] + public override string Kind => "unavailable-transport"; - /// Source location type (e.g., project, personal-copilot, plugin, builtin). - [JsonPropertyName("source")] - public SkillSource Source { get; set; } + /// Human-readable explanation, safe to surface. Never contains a query, URL, handle, or secret. + [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(1000)] + [JsonPropertyName("message")] + public required string Message { get; set; } - /// Whether the skill can be invoked by the user as a slash command. - [JsonPropertyName("userInvocable")] - public bool UserInvocable { get; set; } + /// Why no transport could be offered. + [JsonPropertyName("reason")] + public required CatalogUnavailableTransportReason Reason { get; set; } } -/// Skills discovered across global and project sources. +/// The candidate is discoverable but cannot be installed. `application/ai-skill` resolves here, because it stays searchable while remaining typed non-installable. +/// The not-installable variant of . [Experimental(Diagnostics.Experimental)] -public sealed class ServerSkillList +public partial class McpPlanInstallResultNotInstallable : McpPlanInstallResult { - /// 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; } + /// + [JsonIgnore] + public override string Kind => "not-installable"; - /// All discovered skills across all sources. - [JsonPropertyName("skills")] - public IList Skills { get => field ??= []; set; } + /// Human-readable explanation, safe to surface. Never contains a query, URL, handle, or secret. + [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(1000)] + [JsonPropertyName("message")] + public required string Message { get; set; } + + /// Why the candidate cannot be installed. + [JsonPropertyName("reason")] + public required CatalogNotInstallableReason Reason { get; set; } } -/// Optional project paths and additional skill directories to include in discovery. +/// The operation is not available on this runtime. Distinct from a network failure: nothing was attempted. +/// The unavailable variant of . [Experimental(Diagnostics.Experimental)] -internal sealed class SkillsDiscoverRequest +public partial class McpPlanInstallResultUnavailable : McpPlanInstallResult { - /// 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; } + /// + [JsonIgnore] + public override string Kind => "unavailable"; - /// Optional list of project directory paths to scan for project-scoped skills. - [JsonPropertyName("projectPaths")] - public IList? ProjectPaths { get; set; } + /// Human-readable explanation, safe to surface. Never contains a query, URL, handle, or secret. + [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(1000)] + [JsonPropertyName("message")] + public required string Message { get; set; } - /// Optional list of additional skill directory paths to include. - [JsonPropertyName("skillDirectories")] - public IList? SkillDirectories { get; set; } + /// Why the operation is unavailable. + [JsonPropertyName("reason")] + public required CatalogUnavailableReason Reason { get; set; } } -/// Canonical directory where skills can be discovered or created, with scope, preference, and optional project path. +/// The protocol version and capability set a caller requires, supplied on every catalog request so negotiation cannot be skipped by omission. [Experimental(Diagnostics.Experimental)] -public sealed class SkillDiscoveryPath +public sealed class CatalogClientContract { - /// Absolute path of the create/discovery target (may not exist on disk yet). - [JsonPropertyName("path")] - public string Path { get; set; } = string.Empty; - - /// 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; } - - /// The input project path this directory was derived from (only for project scope). - [JsonPropertyName("projectPath")] - public string? ProjectPath { get; set; } + /// SDK protocol version the caller was generated against. A caller below the runtime's minimum supported version is refused rather than served a partial result. + [JsonPropertyName("protocolVersion")] + public long ProtocolVersion { get; set; } - /// Which tier this directory belongs to. - [JsonPropertyName("scope")] - public SkillDiscoveryScope Scope { get; set; } + /// Wire features the caller requires the runtime to understand. Identifiers are bounded but extensible so a newer caller can negotiate with an older runtime. Requiring an unknown feature yields a typed refusal listing what is understood, never a partial grant. A grant does not promise that a deployment has enabled the operation; typed unavailable results report that separately. + [JsonPropertyName("requiredCapabilities")] + public IList RequiredCapabilities { get => field ??= []; set; } } -/// Canonical locations where skills can be created so the runtime will recognize them. +/// What an install plan is computed from: a candidate handle from a previous search, or a card supplied directly. +/// Polymorphic base type discriminated by kind. [Experimental(Diagnostics.Experimental)] -public sealed class SkillDiscoveryPathList +[JsonPolymorphic( + TypeDiscriminatorPropertyName = "kind", + UnknownDerivedTypeHandling = JsonUnknownDerivedTypeHandling.FallBackToBaseType)] +[JsonDerivedType(typeof(McpPlanInstallSourceCandidate), "candidate")] +[JsonDerivedType(typeof(McpPlanInstallSourceCard), "card")] +public partial class McpPlanInstallSource { - /// Canonical skill create/discovery directories, in priority order. - [JsonPropertyName("paths")] - public IList Paths { get => field ??= []; set; } + /// The type discriminator. + [JsonPropertyName("kind")] + public virtual string Kind { get; set; } = string.Empty; } -/// Optional project paths to enumerate. + +/// Plan from a candidate returned by a previous catalog search. +/// The candidate variant of . [Experimental(Diagnostics.Experimental)] -internal sealed class SkillsGetDiscoveryPathsRequest +public partial class McpPlanInstallSourceCandidate : McpPlanInstallSource { - /// 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; } + /// + [JsonIgnore] + public override string Kind => "candidate"; - /// Optional list of project directory paths. When omitted or empty, only personal and custom directories are returned. - [JsonPropertyName("projectPaths")] - public IList? ProjectPaths { get; set; } + /// Single-use candidate handle. Consumed by this call, so a replay of the same handle is rejected. + [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(256)] + [JsonPropertyName("candidateHandle")] + public required string CandidateHandle { get; set; } + + /// The runtime- or authority-minted `searchId` returned with the search that produced this candidate. A search implementation binds it to private candidate-handle context; a planning implementation must verify that context before returning a plan. The unavailable planning implementation in this contract layer validates presence but does not claim the verification has occurred. It identifies a search rather than a person and must never be joined with user identity to re-identify anyone. + [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(64)] + [JsonPropertyName("searchId")] + public required string SearchId { get; set; } } -/// Skill names to mark as disabled in global configuration, replacing any previous list. +/// A card supplied directly by the caller. Exactly one of a URL or embedded data, encoded structurally so neither both nor neither can be expressed. +/// Polymorphic base type discriminated by kind. [Experimental(Diagnostics.Experimental)] -internal sealed class SkillsConfigSetDisabledSkillsRequest +[JsonPolymorphic( + TypeDiscriminatorPropertyName = "kind", + UnknownDerivedTypeHandling = JsonUnknownDerivedTypeHandling.FallBackToBaseType)] +[JsonDerivedType(typeof(McpServerCardReferenceUrl), "url")] +[JsonDerivedType(typeof(McpServerCardReferenceEmbedded), "embedded")] +public partial class McpServerCardReference { - /// List of skill names to disable. - [JsonPropertyName("disabledSkills")] - public IList DisabledSkills { get => field ??= []; set; } + /// The type discriminator. + [JsonPropertyName("kind")] + public virtual string Kind { get; set; } = string.Empty; } -/// Custom agent metadata, including identifiers, display details, source, tools, model, MCP servers, skills, and file path. + +/// An MCP server card to be retrieved from a URL through the runtime's hardened fetch boundary. +/// The url variant of . [Experimental(Diagnostics.Experimental)] -public sealed class AgentInfo +public partial class McpServerCardReferenceUrl : McpServerCardReference { - /// Description of the agent's purpose. - [JsonPropertyName("description")] - public string Description { get; set; } = string.Empty; - - /// Human-readable display name. - [JsonPropertyName("displayName")] - public string DisplayName { get; set; } = string.Empty; - - /// 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; - - /// 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; } - - /// Preferred model id for this agent. When omitted, inherits the outer agent's model. - [JsonPropertyName("model")] - public string? Model { get; set; } - - /// Unique identifier of the custom agent. - [JsonPropertyName("name")] - public string Name { get; set; } = string.Empty; - - /// 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; } - - /// Skill names preloaded into this agent's context. Omitted means none. - [JsonPropertyName("skills")] - public IList? Skills { get; set; } - - /// Where the agent definition was loaded from. - [JsonPropertyName("source")] - public AgentInfoSource? Source { get; set; } + /// + [JsonIgnore] + public override string Kind => "url"; - /// Allowed tool names for this agent. Empty array means none; omitted means inherit defaults. - [JsonPropertyName("tools")] - public IList? Tools { get; set; } + /// Media type the card is expected to conform to. + [JsonPropertyName("mediaType")] + public required McpServerCardMediaType MediaType { 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; } + /// Card URL. Retrieved only through the runtime's hardened boundary, with scheme, credential, address-range, redirect, timeout, and response-size controls applied. Never logged. + [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(2048)] + [JsonPropertyName("url")] + public required string Url { get; set; } } -/// Agents discovered across user, project, plugin, and remote sources. +/// An MCP server card supplied inline as an inert document. +/// The embedded variant of . [Experimental(Diagnostics.Experimental)] -public sealed class ServerAgentList +public partial class McpServerCardReferenceEmbedded : McpServerCardReference { - /// All discovered agents across all sources. - [JsonPropertyName("agents")] - public IList Agents { get => field ??= []; set; } + /// + [JsonIgnore] + public override string Kind => "embedded"; + + /// The card document verbatim, treated as inert untrusted bytes. The runtime parses and validates it; the host is not expected to interpret it. Never logged. + [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(1048576)] + [JsonPropertyName("data")] + public required string Data { get; set; } + + /// Media type the card is expected to conform to. + [JsonPropertyName("mediaType")] + public required McpServerCardMediaType MediaType { get; set; } } -/// Optional project paths to include in agent discovery. +/// Plan from a card supplied directly by the caller, without a preceding search. +/// The card variant of . [Experimental(Diagnostics.Experimental)] -internal sealed class AgentsDiscoverRequest +public partial class McpPlanInstallSourceCard : McpPlanInstallSource { - /// 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; } + /// + [JsonIgnore] + public override string Kind => "card"; - /// 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; } + /// The card to plan from: exactly one of a URL or embedded data. + [JsonPropertyName("card")] + public required McpServerCardReference Card { get; set; } } -/// Canonical directory where custom agents can be discovered or created, with scope, preference, and optional project path. +/// A side-effect-free request for an MCP install plan. Computing a plan never writes configuration, stores a secret, or reloads MCP servers. [Experimental(Diagnostics.Experimental)] -public sealed class AgentDiscoveryPath +internal sealed class McpPlanInstallRequest { - /// Absolute path of the search/create directory (may not exist on disk yet). - [JsonPropertyName("path")] - public string Path { 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; } + /// Protocol version and capabilities the caller requires. + [JsonPropertyName("contract")] + public CatalogClientContract Contract { get => field ??= new(); set; } - /// Which tier this directory belongs to. + /// Configuration scope the plan targets. Defaults to user scope when omitted. [JsonPropertyName("scope")] - public AgentDiscoveryPathScope Scope { get; set; } + public McpPlanScope? Scope { get; set; } + + /// What to plan: either a candidate handle from a previous search, or a card supplied directly. + [JsonPropertyName("source")] + public McpPlanInstallSource Source { get => field ??= new(); set; } } -/// Canonical locations where custom agents can be created so the runtime will recognize them. +/// User-configured MCP servers, keyed by server name. [Experimental(Diagnostics.Experimental)] -public sealed class AgentDiscoveryPathList +public sealed class McpConfigList { - /// Canonical agent create/discovery directories, in priority order. - [JsonPropertyName("paths")] - public IList Paths { get => field ??= []; set; } + /// All MCP servers from user config, keyed by name. + [JsonPropertyName("servers")] + public IDictionary Servers { get => field ??= new Dictionary(); set; } } -/// Optional project paths to include when enumerating agent discovery directories. +/// MCP server name and configuration to add to user configuration. [Experimental(Diagnostics.Experimental)] -internal sealed class AgentsGetDiscoveryPathsRequest +internal sealed class McpConfigAddRequest { - /// 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; } + /// MCP server configuration (stdio process or remote HTTP/SSE). + [JsonPropertyName("config")] + public JsonElement Config { 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; } + /// 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; } -/// Loaded instruction source for a session, including path, content, category, location, applicability, and optional description. +/// MCP server name and replacement configuration to write to user configuration. [Experimental(Diagnostics.Experimental)] -public sealed class InstructionSource +internal sealed class McpConfigUpdateRequest { - /// 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 InstructionSourceLocation Location { get; set; } - - /// The project path this source was discovered from. Only set by sessionless discovery for repository/working-directory sources, where it disambiguates same-named files (e.g. .github/copilot-instructions.md) across multiple workspace roots. The session-scoped getSources leaves it unset. - [JsonPropertyName("projectPath")] - public string? ProjectPath { get; set; } + /// MCP server configuration (stdio process or remote HTTP/SSE). + [JsonPropertyName("config")] + public JsonElement Config { get; set; } - /// File path relative to repo or absolute for home. - [JsonPropertyName("sourcePath")] - public string SourcePath { get; set; } = string.Empty; + /// 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; +} - /// Category of instruction source β€” used for merge logic. - [JsonPropertyName("type")] - public InstructionSourceType Type { get; set; } +/// MCP server name to remove from user configuration. +[Experimental(Diagnostics.Experimental)] +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; } -/// Instruction sources discovered across user, repository, and plugin sources. +/// MCP server names to enable for new sessions. [Experimental(Diagnostics.Experimental)] -public sealed class ServerInstructionSourceList +internal sealed class McpConfigEnableRequest { - /// All discovered instruction sources. - [JsonPropertyName("sources")] - public IList Sources { get => field ??= []; set; } + /// 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; } } -/// Optional project paths to include in instruction discovery. +/// MCP server names to disable for new sessions. [Experimental(Diagnostics.Experimental)] -internal sealed class InstructionsDiscoverRequest +internal sealed class McpConfigDisableRequest { - /// 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; } + /// 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; } +} - /// 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; } +/// Installed plugin that contributes a discovered extension. +[Experimental(Diagnostics.Experimental)] +public sealed class DiscoveredExtensionPlugin +{ + /// Installed plugin name. + [JsonPropertyName("name")] + public string Name { get; set; } = string.Empty; } -/// Canonical file or directory where custom instructions can be discovered or created, with location, kind, preference, and project path. +/// Discovered extension metadata and persistent enablement state. [Experimental(Diagnostics.Experimental)] -public sealed class InstructionDiscoveryPath +public sealed class DiscoveredExtension { - /// Whether the target is a single file or a directory of instruction files. - [JsonPropertyName("kind")] - public InstructionDiscoveryPathKind Kind { get; set; } + /// Whether this extension's persistent per-ID preference is enabled. + [JsonPropertyName("enabled")] + public bool Enabled { get; set; } - /// Which tier this target belongs to. - [JsonPropertyName("location")] - public InstructionDiscoveryPathLocation Location { get; set; } + /// Source-qualified ID accepted by both server and session extension enablement methods. + [JsonPropertyName("id")] + public string Id { get; set; } = string.Empty; - /// Absolute path of the file or directory (may not exist on disk yet). + /// Human-readable extension name. + [JsonPropertyName("name")] + public string Name { get; set; } = string.Empty; + + /// Absolute path to the extension entry module, suitable for revealing it in a file manager. [JsonPropertyName("path")] public string Path { get; set; } = string.Empty; - /// 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; } -} + /// Containing plugin metadata for plugin-contributed extensions. + [JsonPropertyName("plugin")] + public DiscoveredExtensionPlugin? Plugin { get; set; } -/// Canonical files and directories where custom instructions can be created so the runtime will recognize them. -[Experimental(Diagnostics.Experimental)] -public sealed class InstructionDiscoveryPathList -{ - /// Canonical instruction create/discovery files and directories, in priority order. - [JsonPropertyName("paths")] - public IList Paths { get => field ??= []; set; } + /// Discovery source. + [JsonPropertyName("source")] + public DiscoveredExtensionSource Source { get; set; } } -/// Optional project paths to include when enumerating instruction discovery targets. +/// Extensions discovered from persisted Copilot home state and their effective loading mode. Launch-scoped additional plugins are not included. [Experimental(Diagnostics.Experimental)] -internal sealed class InstructionsGetDiscoveryPathsRequest +public sealed class DiscoveredExtensions { - /// 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; } + /// Discovered user and enabled installed-plugin extensions from persisted Copilot home state. + [JsonPropertyName("extensions")] + public IList Extensions { get => field ??= []; 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; } + /// Effective extension loading mode. Defaults to load_and_augment when unset. + [JsonPropertyName("mode")] + public DiscoveredExtensionMode Mode { get; set; } } -/// A literal choice the command input accepts, with a human-facing description. +/// Source-qualified extension identifiers to persistently enable for future sessions. [Experimental(Diagnostics.Experimental)] -public sealed class SlashCommandInputChoice +internal sealed class DiscoveredExtensionsEnableRequest { - /// 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; + /// Source-qualified user or plugin extension IDs to enable. + [JsonPropertyName("ids")] + public IList Ids { get => field ??= []; set; } } -/// Optional unstructured input hint. +/// Source-qualified extension identifiers to persistently disable for future sessions. [Experimental(Diagnostics.Experimental)] -public sealed class SlashCommandInput +internal sealed class DiscoveredExtensionsDisableRequest { - /// 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; } - - /// Optional completion hint for the input (e.g. 'directory' for filesystem path completion). - [JsonPropertyName("completion")] - public SlashCommandInputCompletion? Completion { get; set; } - - /// Hint to display when command input has not been provided. - [JsonPropertyName("hint")] - public string Hint { get; set; } = string.Empty; - - /// 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; } - - /// When true, the command requires non-empty input; clients should render the input hint as required. - [JsonPropertyName("required")] - public bool? Required { get; set; } + /// Source-qualified user or plugin extension IDs to disable. + [JsonPropertyName("ids")] + public IList Ids { get => field ??= []; set; } } -/// Slash-command metadata with name, aliases, description, kind, input hint, execution allowance, and schedulability. +/// Outcome of a catalog.search call: either bounded inert candidates, or one typed refusal. Never a partial success. +/// Polymorphic base type discriminated by kind. [Experimental(Diagnostics.Experimental)] -public sealed class SlashCommandInfo +[JsonPolymorphic( + TypeDiscriminatorPropertyName = "kind", + UnknownDerivedTypeHandling = JsonUnknownDerivedTypeHandling.FallBackToBaseType)] +[JsonDerivedType(typeof(CatalogSearchResultSucceeded), "succeeded")] +[JsonDerivedType(typeof(CatalogSearchResultNegotiationRefused), "negotiation-refused")] +[JsonDerivedType(typeof(CatalogSearchResultUnsupportedKind), "unsupported-kind")] +[JsonDerivedType(typeof(CatalogSearchResultInvalidRequest), "invalid-request")] +[JsonDerivedType(typeof(CatalogSearchResultAuthenticationRequired), "authentication-required")] +[JsonDerivedType(typeof(CatalogSearchResultPolicyRejected), "policy-rejected")] +[JsonDerivedType(typeof(CatalogSearchResultNetworkFailure), "network-failure")] +[JsonDerivedType(typeof(CatalogSearchResultUnsafeRetrieval), "unsafe-retrieval")] +[JsonDerivedType(typeof(CatalogSearchResultMalformedCard), "malformed-card")] +[JsonDerivedType(typeof(CatalogSearchResultContractViolation), "contract-violation")] +[JsonDerivedType(typeof(CatalogSearchResultUnavailable), "unavailable")] +public partial class CatalogSearchResult { - /// Canonical aliases without leading slashes. - [JsonPropertyName("aliases")] - public IList? Aliases { get; set; } - - /// Whether the command may run while an agent turn is active. - [JsonPropertyName("allowDuringAgentExecution")] - public bool AllowDuringAgentExecution { get; set; } - - /// Human-readable command description. - [JsonPropertyName("description")] - public string Description { get; set; } = string.Empty; - - /// Whether the command is experimental. - [JsonPropertyName("experimental")] - public bool? Experimental { get; set; } - - /// Optional unstructured input hint. - [JsonPropertyName("input")] - public SlashCommandInput? Input { get; set; } - - /// Coarse command category for grouping and behavior: runtime built-in, skill-backed command, or SDK/client-owned command. + /// The type discriminator. [JsonPropertyName("kind")] - public SlashCommandKind Kind { get; set; } - - /// Canonical command name without a leading slash. - [JsonPropertyName("name")] - public string Name { get; set; } = string.Empty; - - /// 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; } + public virtual string Kind { get; set; } = string.Empty; } -/// Slash commands available in the session, after applying any include/exclude filters. + +/// One inert catalog result, represented as an MCP server or discovery-only AI skill variant so kind, media type, provenance, and installability cannot contradict each other. +/// Polymorphic base type discriminated by kind. [Experimental(Diagnostics.Experimental)] -public sealed class CommandList +[JsonPolymorphic( + TypeDiscriminatorPropertyName = "kind", + UnknownDerivedTypeHandling = JsonUnknownDerivedTypeHandling.FallBackToBaseType)] +[JsonDerivedType(typeof(CatalogCandidateMcpServer), "mcp-server")] +[JsonDerivedType(typeof(CatalogCandidateAiSkill), "ai-skill")] +public partial class CatalogCandidate { - /// Commands available in this session. - [JsonPropertyName("commands")] - public IList Commands { get => field ??= []; set; } + /// The type discriminator. + [JsonPropertyName("kind")] + public virtual string Kind { get; set; } = string.Empty; } -/// A single user setting's effective value alongside its default, so consumers can render settings left at their default. + +/// Where and when an MCP server catalog reference was observed. Discovery provenance deliberately carries no content digest because search does not establish the exact validated content a later plan will bind. [Experimental(Diagnostics.Experimental)] -public sealed class UserSettingMetadata +public sealed class CatalogMcpServerCandidateProvenance { - /// The centrally-known default for this setting (null when no default is registered). - [JsonPropertyName("default")] - public JsonElement Default { get; set; } + /// Host of the catalog authority that advertised the reference, without path, query, or credentials. Inert untrusted data. + [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("authority")] + public string Authority { get; set; } = string.Empty; - /// 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; } + /// JSON MCP media type advertised for the referenced card. + [JsonPropertyName("mediaType")] + public McpServerCardMediaType MediaType { get; set; } - /// The effective value: the user's value if set, otherwise the default. - [JsonPropertyName("value")] - public JsonElement Value { get; set; } + /// ISO 8601 timestamp at which the runtime observed the catalog reference. This is not a retrieval or validation timestamp. + [JsonPropertyName("observedAt")] + public string ObservedAt { get; set; } = string.Empty; } -/// 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. +/// Where a candidate's card came from. Exactly one of a URL or embedded data: the union has no variant carrying both, and no variant carrying neither, so the rule holds structurally rather than by validation. +/// Polymorphic base type discriminated by kind. [Experimental(Diagnostics.Experimental)] -public sealed class UserSettingsGetResult +[JsonPolymorphic( + TypeDiscriminatorPropertyName = "kind", + UnknownDerivedTypeHandling = JsonUnknownDerivedTypeHandling.FallBackToBaseType)] +[JsonDerivedType(typeof(CatalogCandidateSourceUrl), "url")] +[JsonDerivedType(typeof(CatalogCandidateSourceEmbedded), "embedded")] +public partial class CatalogCandidateSource { - /// 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; } + /// The type discriminator. + [JsonPropertyName("kind")] + public virtual string Kind { get; set; } = string.Empty; } -/// Outcome of writing user settings. + +/// Candidate whose card is retrieved from a URL through the runtime's hardened fetch boundary. +/// The url variant of . [Experimental(Diagnostics.Experimental)] -public sealed class UserSettingsSetResult +public partial class CatalogCandidateSourceUrl : CatalogCandidateSource { - /// 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; } + /// + [JsonIgnore] + public override string Kind => "url"; + + /// Card URL as advertised. Inert untrusted data: the runtime retrieves it only through its own hardened boundary, and it is never logged. + [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("url")] + public required string Url { 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. +/// Candidate whose card reference arrived inline. The document and its content-derived properties stay behind the runtime boundary. +/// The embedded variant of . [Experimental(Diagnostics.Experimental)] -internal sealed class UserSettingsSetRequest +public partial class CatalogCandidateSourceEmbedded : CatalogCandidateSource { - /// Partial user settings to write, as a free-form object keyed by setting name. - [JsonPropertyName("settings")] - public JsonElement Settings { get; set; } + /// + [JsonIgnore] + public override string Kind => "embedded"; } -/// Indicates whether the calling client was registered as the session filesystem provider. +/// An inert MCP server catalog result. Every free-text field is untrusted external data and must never be treated as an instruction, and the handle is the only way to refer to the candidate in a later operation. +/// The mcp-server variant of . [Experimental(Diagnostics.Experimental)] -public sealed class SessionFsSetProviderResult +public partial class CatalogCandidateMcpServer : CatalogCandidate { - /// Whether the provider was set successfully. - [JsonPropertyName("success")] - public bool Success { get; set; } + /// + [JsonIgnore] + public override string Kind => "mcp-server"; + + /// Description taken verbatim from the card. Inert untrusted text. + [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(1000)] + [JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)] + [JsonPropertyName("description")] + public string? Description { get; set; } + + /// Display name taken verbatim from the card. Inert untrusted text. + [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(200)] + [JsonPropertyName("displayName")] + public required string DisplayName { get; set; } + + /// Opaque, runtime-instance scoped, TTL-bound, single-use handle for this candidate. Carries no readable information and is rejected when stale, replayed, or presented to a different runtime instance. Never logged. + [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("handle")] + public required string Handle { get; set; } + + /// ISO 8601 timestamp after which the handle is stale and will be rejected. + [JsonPropertyName("handleExpiresAt")] + public required string HandleExpiresAt { get; set; } + + /// Whether this MCP server can be planned for installation, and if policy prevents it. + [JsonPropertyName("installability")] + public required CatalogMcpServerInstallability Installability { get; set; } + + /// JSON MCP media type of the underlying card. + [JsonPropertyName("mediaType")] + public required McpServerCardMediaType MediaType { get; set; } + + /// Where the catalog reference was observed, without the card itself or any content digest. + [JsonPropertyName("provenance")] + public required CatalogMcpServerCandidateProvenance Provenance { get; set; } + + /// Publisher taken verbatim from the card. Inert untrusted text. + [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(200)] + [JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)] + [JsonPropertyName("publisher")] + public string? Publisher { get; set; } + + /// Where the card came from: exactly one of a URL or embedded data, encoded as a tagged union so neither both nor neither can be represented. + [JsonPropertyName("source")] + public required CatalogCandidateSource Source { get; set; } } -/// Optional capabilities declared by the provider. +/// Where and when an AI skill catalog reference was observed. Discovery provenance deliberately carries no content digest because search does not establish the exact validated content a later plan will bind. [Experimental(Diagnostics.Experimental)] -public sealed class SessionFsSetProviderCapabilities +public sealed class CatalogAiSkillCandidateProvenance { - /// Whether the provider supports SQLite query/exists operations. - [JsonPropertyName("sqlite")] - public bool? Sqlite { get; set; } + /// Host of the catalog authority that advertised the reference, without path, query, or credentials. Inert untrusted data. + [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("authority")] + public string Authority { get; set; } = string.Empty; + + /// Media type advertised for the referenced AI skill card. + [JsonPropertyName("mediaType")] + public string MediaType { get; set; } = string.Empty; + + /// ISO 8601 timestamp at which the runtime observed the catalog reference. This is not a retrieval or validation timestamp. + [JsonPropertyName("observedAt")] + public string ObservedAt { get; set; } = string.Empty; } -/// Initial working directory, session-state path layout, and path conventions used to register the calling SDK client as the session filesystem provider. +/// An inert AI skill catalog result. AI skills are discovery-only and cannot be represented as installable through this surface. +/// The ai-skill variant of . [Experimental(Diagnostics.Experimental)] -internal sealed class SessionFsSetProviderRequest +public partial class CatalogCandidateAiSkill : CatalogCandidate { - /// Optional capabilities declared by the provider. - [JsonPropertyName("capabilities")] - public SessionFsSetProviderCapabilities? Capabilities { get; set; } + /// + [JsonIgnore] + public override string Kind => "ai-skill"; - /// Path conventions used by this filesystem. - [JsonPropertyName("conventions")] - public SessionFsSetProviderConventions Conventions { get; set; } + /// Description taken verbatim from the card. Inert untrusted text. + [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(1000)] + [JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)] + [JsonPropertyName("description")] + public string? Description { get; set; } - /// Initial working directory for sessions. - [JsonPropertyName("initialCwd")] - public string InitialCwd { get; set; } = string.Empty; + /// Display name taken verbatim from the card. Inert untrusted text. + [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(200)] + [JsonPropertyName("displayName")] + public required string DisplayName { 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; + /// Opaque, runtime-instance scoped, TTL-bound, single-use handle for this candidate. Carries no readable information and is rejected when stale, replayed, or presented to a different runtime instance. Never logged. + [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("handle")] + public required string Handle { get; set; } + + /// ISO 8601 timestamp after which the handle is stale and will be rejected. + [JsonPropertyName("handleExpiresAt")] + public required string HandleExpiresAt { get; set; } + + /// AI skills are discovery-only and cannot be installed through this surface. + [JsonPropertyName("installability")] + public required string Installability { get; set; } + + /// Media type of the underlying AI skill card. + [JsonPropertyName("mediaType")] + public required string MediaType { get; set; } + + /// Where the catalog reference was observed, without the card itself or any content digest. + [JsonPropertyName("provenance")] + public required CatalogAiSkillCandidateProvenance Provenance { get; set; } + + /// Publisher taken verbatim from the card. Inert untrusted text. + [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(200)] + [JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)] + [JsonPropertyName("publisher")] + public string? Publisher { get; set; } + + /// Where the card came from: exactly one of a URL or embedded data, encoded as a tagged union so neither both nor neither can be represented. + [JsonPropertyName("source")] + public required CatalogCandidateSource Source { get; set; } } -/// Indicates whether the calling client was registered as the LLM inference provider. +/// A completed catalog search: inert candidate summaries, each carrying a single-use handle. +/// The succeeded variant of . [Experimental(Diagnostics.Experimental)] -public sealed class LlmInferenceSetProviderResult +public partial class CatalogSearchResultSucceeded : CatalogSearchResult { - /// Whether the provider was set successfully. - [JsonPropertyName("success")] - public bool Success { get; set; } + /// + [JsonIgnore] + public override string Kind => "succeeded"; + + /// Matching candidates, never more than the requested limit. All text is inert untrusted data. + [JsonPropertyName("candidates")] + public required IList Candidates { get; set; } + + /// Protocol version and capabilities the runtime honoured. + [JsonPropertyName("negotiated")] + public required CatalogNegotiatedContract Negotiated { get; set; } + + /// Pseudonymous identifier for this search, issued by the runtime or by the catalog authority it queried and never by the caller, so it cannot be forged or replayed to attribute an install to a search that never happened. Always present on a success, so a result set can be tied to the installs it leads to. It identifies a search rather than a person: it is derived from no user, account, device, or query data, and must never be joined with user identity to re-identify anyone. + [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(64)] + [JsonPropertyName("searchId")] + public required string SearchId { get; set; } + + /// Whether further matches existed beyond the requested limit. + [JsonPropertyName("truncated")] + public required bool Truncated { get; set; } } -/// Whether the start frame was accepted. +/// The caller's protocol version or required capabilities cannot be honoured. Returned instead of a partial or ambiguous success. +/// The negotiation-refused variant of . [Experimental(Diagnostics.Experimental)] -public sealed class LlmInferenceHttpResponseStartResult +public partial class CatalogSearchResultNegotiationRefused : CatalogSearchResult { - /// True when the response start was matched to a pending request; false when unknown. - [JsonPropertyName("accepted")] - public bool Accepted { get; set; } + /// + [JsonIgnore] + public override string Kind => "negotiation-refused"; + + /// Human-readable explanation, safe to surface. Never contains a query, URL, handle, or secret. + [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(1000)] + [JsonPropertyName("message")] + public required string Message { get; set; } + + /// Lowest caller protocol version this runtime will serve. + [JsonPropertyName("minimumSupportedProtocolVersion")] + public required long MinimumSupportedProtocolVersion { get; set; } + + /// Whether the version or the capability set was the problem. + [JsonPropertyName("reason")] + public required CatalogNegotiationRefusedReason Reason { get; set; } + + /// Protocol version of the runtime that refused the request. + [JsonPropertyName("runtimeProtocolVersion")] + public required long RuntimeProtocolVersion { get; set; } + + /// Every wire feature this runtime understands, so the caller can retry within that contract. This list does not imply that every deployment has enabled every operation. + [JsonPropertyName("supportedCapabilities")] + public required IList SupportedCapabilities { get; set; } + + /// The subset of the caller's bounded extensible capability identifiers this runtime cannot honour. + [JsonPropertyName("unsupportedCapabilities")] + public required IList UnsupportedCapabilities { get; set; } } -/// Response head. +/// The request asked for a candidate kind this runtime does not serve. +/// The unsupported-kind variant of . [Experimental(Diagnostics.Experimental)] -internal sealed class LlmInferenceHttpResponseStartRequest +public partial class CatalogSearchResultUnsupportedKind : CatalogSearchResult { - /// Gets or sets the headers value. - [JsonPropertyName("headers")] - public IDictionary> Headers { get => field ??= new Dictionary>(); set; } + /// + [JsonIgnore] + public override string Kind => "unsupported-kind"; - /// Matches the requestId from the originating httpRequestStart frame. - [JsonPropertyName("requestId")] - public string RequestId { get; set; } = string.Empty; + /// Human-readable explanation, safe to surface. Never contains a query, URL, handle, or secret. + [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(1000)] + [JsonPropertyName("message")] + public required string Message { get; set; } - /// HTTP status code. - [JsonPropertyName("status")] - public long Status { get; set; } + /// The kinds from the request that are not supported. + [JsonPropertyName("requestedKinds")] + public required IList RequestedKinds { get; set; } - /// Optional HTTP status reason phrase. - [JsonPropertyName("statusText")] - public string? StatusText { get; set; } + /// Every candidate kind this runtime can serve. + [JsonPropertyName("supportedKinds")] + public required IList SupportedKinds { get; set; } } -/// Whether the chunk was accepted. +/// The request was rejected before any work was done, because a bounded field fell outside its permitted range or a required field was unusable. +/// The invalid-request variant of . [Experimental(Diagnostics.Experimental)] -public sealed class LlmInferenceHttpResponseChunkResult +public partial class CatalogSearchResultInvalidRequest : CatalogSearchResult { - /// True when the chunk was matched to a pending request; false when unknown. - [JsonPropertyName("accepted")] - public bool Accepted { get; set; } + /// + [JsonIgnore] + public override string Kind => "invalid-request"; + + /// Which request field was rejected. + [JsonPropertyName("field")] + public required CatalogInvalidRequestField Field { get; set; } + + /// Human-readable explanation, safe to surface. Never echoes the offending value, nor a query, URL, handle, or secret. + [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(1000)] + [JsonPropertyName("message")] + public required string Message { get; set; } } -/// Set to terminate the response with a transport-level failure. Implies end-of-stream; any further chunks for this requestId are ignored. +/// An optional catalog authentication exchange did not establish the caller's identity. Anonymous search remains supported; this refusal is reserved for an operation that cannot continue after the attempted exchange. It is distinct from `policy-rejected` and from a network failure, and the reason identifies the recovery action. +/// The authentication-required variant of . [Experimental(Diagnostics.Experimental)] -public sealed class LlmInferenceHttpResponseChunkError +public partial class CatalogSearchResultAuthenticationRequired : CatalogSearchResult { - /// Optional machine-readable error code. - [JsonPropertyName("code")] - public string? Code { get; set; } + /// + [JsonIgnore] + public override string Kind => "authentication-required"; - /// Human-readable failure description. + /// Human-readable explanation, safe to surface. Never contains a credential or token, nor a query, URL, handle, or secret. + [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(1000)] [JsonPropertyName("message")] - public string Message { get; set; } = string.Empty; + public required string Message { get; set; } + + /// Why authentication failed. Only an expired credential justifies attempting a silent refresh; an absent or rejected credential requires sign-in. + [JsonPropertyName("reason")] + public required CatalogAuthenticationRequiredReason Reason { get; set; } } -/// A response body chunk or terminal error. +/// Registry or enterprise policy refused the operation. +/// The policy-rejected variant of . [Experimental(Diagnostics.Experimental)] -internal sealed class LlmInferenceHttpResponseChunkRequest +public partial class CatalogSearchResultPolicyRejected : CatalogSearchResult { - /// When true, `data` is base64-encoded bytes. When absent or false, `data` is UTF-8 text. - [JsonPropertyName("binary")] - public bool? Binary { 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; - - /// 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; } + /// + [JsonIgnore] + public override string Kind => "policy-rejected"; - /// 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; } + /// Human-readable explanation, safe to surface. Never contains a query, URL, handle, or secret. + [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(1000)] + [JsonPropertyName("message")] + public required string Message { get; set; } - /// Matches the requestId from the originating httpRequestStart frame. - [JsonPropertyName("requestId")] - public string RequestId { get; set; } = string.Empty; + /// Which authority produced the decision. + [JsonPropertyName("source")] + public required McpPlanPolicySource Source { get; set; } } -/// Pre-resolved working-directory context for session startup. +/// The runtime could not reach the catalog authority or retrieve a card. Covers being offline as well as transport-level failure. +/// The network-failure variant of . [Experimental(Diagnostics.Experimental)] -public sealed class SessionContext +public partial class CatalogSearchResultNetworkFailure : CatalogSearchResult { - /// Active git branch. - [JsonPropertyName("branch")] - public string? Branch { get; set; } - - /// Most recent working directory for this session. - [JsonPropertyName("cwd")] - public string Cwd { get; set; } = string.Empty; + /// + [JsonIgnore] + public override string Kind => "network-failure"; - /// Git repository root, if the cwd was inside a git repo. - [JsonPropertyName("gitRoot")] - public string? GitRoot { get; set; } + /// Human-readable explanation, safe to surface. Never contains a query, URL, handle, or secret. + [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(1000)] + [JsonPropertyName("message")] + public required string Message { get; set; } - /// Repository host type. - [JsonPropertyName("hostType")] - public SessionContextHostType? HostType { get; set; } + /// Categorised failure, low cardinality so it can be aggregated without carrying a URL. + [JsonPropertyName("reason")] + public required CatalogNetworkFailureReason Reason { get; set; } - /// Repository slug in `owner/name` form, when known. - [JsonPropertyName("repository")] - public string? Repository { get; set; } + /// HTTP status code, when the failure was a rejected response. + [JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)] + [JsonPropertyName("statusCode")] + public int? StatusCode { get; set; } } -/// GitHub repository the remote session belongs to. +/// Retrieval was refused by the runtime's hardened fetch boundary before any request left the process, or before a redirect was followed. +/// The unsafe-retrieval variant of . [Experimental(Diagnostics.Experimental)] -public sealed class RemoteSessionMetadataRepository +public partial class CatalogSearchResultUnsafeRetrieval : CatalogSearchResult { - /// Branch associated with the remote session. - [JsonPropertyName("branch")] - public string Branch { get; set; } = string.Empty; + /// + [JsonIgnore] + public override string Kind => "unsafe-retrieval"; - /// Repository name. - [JsonPropertyName("name")] - public string Name { get; set; } = string.Empty; + /// Human-readable explanation, safe to surface. Never contains the refused URL, nor a query, handle, or secret. + [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(1000)] + [JsonPropertyName("message")] + public required string Message { get; set; } - /// Repository owner. - [JsonPropertyName("owner")] - public string Owner { get; set; } = string.Empty; + /// Which control refused the retrieval, low cardinality so it can be aggregated without carrying a URL. + [JsonPropertyName("reason")] + public required CatalogUnsafeRetrievalReason Reason { get; set; } } -/// Remote session metadata for the session to hand off (typically obtained from `sessions.list` with `source: "remote"`). +/// A card could not be parsed or did not satisfy its declared media type's schema. +/// The malformed-card variant of . [Experimental(Diagnostics.Experimental)] -public sealed class RemoteSessionMetadataValue +public partial class CatalogSearchResultMalformedCard : CatalogSearchResult { - /// Most recent working directory context. - [JsonPropertyName("context")] - public SessionContext? Context { get; set; } + /// + [JsonIgnore] + public override string Kind => "malformed-card"; - /// Always true for remote sessions. - [JsonPropertyName("isRemote")] - public bool IsRemote { get; set; } + /// Media type the card was interpreted as, when it declared one this runtime recognises. + [JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)] + [JsonPropertyName("mediaType")] + public CatalogMediaType? MediaType { get; set; } - /// Last-modified time as an ISO 8601 timestamp. - [JsonPropertyName("modifiedTime")] - public string ModifiedTime { get; set; } = string.Empty; + /// Human-readable explanation, safe to surface. Never echoes card content, nor a query, URL, handle, or secret. + [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(1000)] + [JsonPropertyName("message")] + public required string Message { get; set; } - /// Optional human-friendly name set via /rename. - [JsonPropertyName("name")] - public string? Name { get; set; } + /// How the card failed validation. + [JsonPropertyName("reason")] + public required CatalogMalformedCardReason Reason { get; set; } +} - /// Pull request number associated with the session. - [JsonPropertyName("pullRequestNumber")] - public long? PullRequestNumber { get; set; } +/// An upstream catalog response broke the wire contract. Most importantly, every result must carry exactly one of a URL or embedded data: a result carrying both, or neither, is refused here rather than being guessed at. +/// The contract-violation variant of . +[Experimental(Diagnostics.Experimental)] +public partial class CatalogSearchResultContractViolation : CatalogSearchResult +{ + /// + [JsonIgnore] + public override string Kind => "contract-violation"; - /// Backing remote session IDs (most recent first). - [JsonPropertyName("remoteSessionIds")] - public IList RemoteSessionIds { get => field ??= []; set; } + /// Human-readable explanation, safe to surface. Never echoes response content, nor a query, URL, handle, or secret. + [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(1000)] + [JsonPropertyName("message")] + public required string Message { get; set; } - /// GitHub repository the remote session belongs to. - [JsonPropertyName("repository")] - public RemoteSessionMetadataRepository Repository { get => field ??= new(); set; } + /// Which rule the response broke. + [JsonPropertyName("reason")] + public required CatalogContractViolationReason Reason { get; set; } +} - /// Original remote resource identifier (task ID or PR node ID). - [JsonPropertyName("resourceId")] - public string? ResourceId { get; set; } +/// The operation is not available on this runtime. Distinct from a network failure: nothing was attempted. +/// The unavailable variant of . +[Experimental(Diagnostics.Experimental)] +public partial class CatalogSearchResultUnavailable : CatalogSearchResult +{ + /// + [JsonIgnore] + public override string Kind => "unavailable"; - /// Stable session identifier. - [JsonPropertyName("sessionId")] - public string SessionId { get; set; } = string.Empty; + /// Human-readable explanation, safe to surface. Never contains a query, URL, handle, or secret. + [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(1000)] + [JsonPropertyName("message")] + public required string Message { get; set; } - /// Deadline (ISO 8601) at which a CLI remote session becomes stale without further heartbeats. - [JsonPropertyName("staleAt")] - public string? StaleAt { get; set; } + /// Why the operation is unavailable. + [JsonPropertyName("reason")] + public required CatalogUnavailableReason Reason { get; set; } +} - /// Session creation time as an ISO 8601 timestamp. - [JsonPropertyName("startTime")] - public string StartTime { get; set; } = string.Empty; +/// A bounded catalog search. Both the query length and the result count are capped by the schema so a caller cannot request an unbounded scan. +[Experimental(Diagnostics.Experimental)] +internal sealed class CatalogSearchRequest +{ + /// Protocol version and capabilities the caller requires. + [JsonPropertyName("contract")] + public CatalogClientContract Contract { get => field ??= new(); set; } - /// Server-side task state returned by GitHub. - [JsonPropertyName("state")] - public string? State { get; set; } + /// Restrict results to these candidate kinds. When omitted, every kind the runtime supports is searched. + [JsonPropertyName("kinds")] + public IList? Kinds { get; set; } - /// Short summary of the session, when one has been derived. - [JsonPropertyName("summary")] - public string? Summary { get; set; } + /// Maximum number of candidates to return. Defaults to 10 when omitted. + [JsonPropertyName("limit")] + public int? Limit { get; set; } - /// Whether the remote task originated from CCA or CLI `--remote`. - [JsonPropertyName("taskType")] - public RemoteSessionMetadataTaskType? TaskType { get; set; } + /// Free-text search query. Never written to logs or telemetry. + [RegularExpression("\\S")] + [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(256)] + [JsonPropertyName("query")] + public string Query { get; set; } = string.Empty; } -/// `sessions.open` handoff progress update with step, status, and optional message. +/// Information about an installed plugin tracked in global state. [Experimental(Diagnostics.Experimental)] -public sealed class SessionsOpenProgress +public sealed class InstalledPluginInfo { - /// Optional step message. - [JsonPropertyName("message")] - public string? Message { 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; } - /// Step status. - [JsonPropertyName("status")] - public SessionsOpenProgressStatus Status { get; set; } + /// Whether the plugin is currently enabled for new sessions. + [JsonPropertyName("enabled")] + public bool Enabled { get; set; } - /// Handoff step. - [JsonPropertyName("step")] - public SessionsOpenProgressStep Step { get; set; } + /// Absolute path of the marketplace directory a live plugin was resolved from. Present only on live, never-persisted records β€” a plugin belonging to a directory/local marketplace, which is loaded from its real directory on every pass instead of a copy under the installed-plugins cache. Its presence is what marks a listed plugin as live: such a plugin is always present on disk, so `enabled` is its only meaningful state and it is never "not installed". + [JsonPropertyName("installedFrom")] + public string? InstalledFrom { get; set; } + + /// Marketplace the plugin came from. Empty string ("") for direct repo / URL / local installs. + [JsonPropertyName("marketplace")] + public string Marketplace { get; set; } = string.Empty; + + /// Plugin name. + [JsonPropertyName("name")] + public string Name { get; set; } = string.Empty; + + /// Installed version (when reported by the plugin manifest). + [JsonPropertyName("version")] + public string? Version { get; set; } } -/// Result of opening a session. +/// Plugins installed in user/global state. [Experimental(Diagnostics.Experimental)] -public sealed class SessionOpenResult +public sealed class PluginListResult { - /// Remote session metadata, present when status is `connected`. - [JsonPropertyName("metadata")] - public RemoteSessionMetadataValue? Metadata { get; set; } + /// Installed plugins. + [JsonPropertyName("plugins")] + public IList Plugins { get => field ??= []; set; } +} - /// Handoff progress steps, present when status is `handed_off`. - [JsonPropertyName("progress")] - public IList? Progress { get; set; } +/// Result of installing a plugin. +[Experimental(Diagnostics.Experimental)] +public sealed class PluginInstallResult +{ + /// 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; } - /// Remote session ID, present when status is `connected`. - [JsonPropertyName("remoteSessionId")] - public string? RemoteSessionId { get; set; } + /// The newly installed plugin's metadata. + [JsonPropertyName("plugin")] + public InstalledPluginInfo Plugin { get => field ??= new(); set; } - /// 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. - [JsonInclude] - [JsonPropertyName("sessionApi")] - internal JsonElement? SessionApi { get; set; } + /// Optional post-install message provided by the plugin (e.g. setup instructions). + [JsonPropertyName("postInstallMessage")] + public string? PostInstallMessage { get; set; } - /// Opened session ID. Omitted when status is `not_found`. - [JsonPropertyName("sessionId")] - public string? SessionId { get; set; } + /// Number of skills discovered and installed from the plugin. + [JsonPropertyName("skillsInstalled")] + public long SkillsInstalled { 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; } +/// 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; - /// Outcome of the open request. - [JsonPropertyName("status")] - public SessionsOpenStatus Status { 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; } } -/// Identifier and optional friendly name assigned to the newly forked session. +/// Name (or spec) of the plugin to uninstall. [Experimental(Diagnostics.Experimental)] -public sealed class SessionsForkResult +internal sealed class PluginsUninstallRequest { - /// Friendly name assigned to the forked session, if any. - [JsonPropertyName("name")] - public string? Name { get; set; } + /// 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; } - /// The new forked session's ID. - [JsonPropertyName("sessionId")] - public string SessionId { get; set; } = string.Empty; + /// Plugin name or "plugin@marketplace" spec to uninstall. When ambiguous, prefer the fully-qualified spec. + [JsonPropertyName("name")] + public string Name { get; set; } = string.Empty; } -/// Source session identifier to fork from, optional event-ID boundary, and optional friendly name for the new session. +/// Result of updating a single plugin. [Experimental(Diagnostics.Experimental)] -internal sealed class SessionsForkRequest +public sealed class PluginUpdateResult { - /// Optional friendly name to assign to the forked session. - [JsonPropertyName("name")] - public string? Name { get; set; } + /// Version after the update, when reported by the plugin manifest. + [JsonPropertyName("newVersion")] + public string? NewVersion { get; set; } - /// Source session ID to fork from. - [JsonPropertyName("sessionId")] - public string SessionId { get; set; } = string.Empty; + /// Version that was previously installed, when available. + [JsonPropertyName("previousVersion")] + public string? PreviousVersion { 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; } + /// Number of skills discovered and installed after the update. + [JsonPropertyName("skillsInstalled")] + public long SkillsInstalled { get; set; } } -/// Repository associated with the connected remote session. +/// Name (or spec) of the plugin to update. [Experimental(Diagnostics.Experimental)] -public sealed class ConnectedRemoteSessionMetadataRepository +internal sealed class PluginsUpdateRequest { - /// Branch associated with the remote session. - [JsonPropertyName("branch")] - public string Branch { get; set; } = string.Empty; - - /// Repository name. + /// Plugin name or "plugin@marketplace" spec to update. [JsonPropertyName("name")] public string Name { get; set; } = string.Empty; - - /// Repository owner or organization login. - [JsonPropertyName("owner")] - public string Owner { get; set; } = string.Empty; } -/// Metadata for a connected remote session. +/// Per-plugin result from updating all plugins, with versions, skills installed, success flag, and optional error. [Experimental(Diagnostics.Experimental)] -public sealed class ConnectedRemoteSessionMetadata +public sealed class PluginUpdateAllEntry { - /// Neutral SDK discriminator for the connected remote session kind. - [JsonPropertyName("kind")] - public ConnectedRemoteSessionMetadataKind Kind { get; set; } + /// Error message (failure only). + [JsonPropertyName("error")] + public string? Error { get; set; } - /// Last session update time as an ISO 8601 string. - [JsonPropertyName("modifiedTime")] - public DateTimeOffset ModifiedTime { get; set; } + /// Marketplace the plugin came from. Empty string ("") for direct installs. + [JsonPropertyName("marketplace")] + public string Marketplace { get; set; } = string.Empty; - /// Optional friendly session name. + /// Plugin name that was updated. [JsonPropertyName("name")] - public string? Name { get; set; } - - /// Pull request number associated with the session. - [JsonPropertyName("pullRequestNumber")] - public long? PullRequestNumber { get; set; } - - /// Repository associated with the connected remote session. - [JsonPropertyName("repository")] - public ConnectedRemoteSessionMetadataRepository Repository { get => field ??= new(); set; } - - /// Original remote resource identifier. - [JsonPropertyName("resourceId")] - public string? ResourceId { get; set; } - - /// SDK session ID for the connected remote session. - [JsonPropertyName("sessionId")] - public string SessionId { get; set; } = string.Empty; + public string Name { get; set; } = string.Empty; - /// Remote session staleness deadline as an ISO 8601 string. - [JsonPropertyName("staleAt")] - public DateTimeOffset? StaleAt { get; set; } + /// Version after the update, when available. + [JsonPropertyName("newVersion")] + public string? NewVersion { get; set; } - /// Session start time as an ISO 8601 string. - [JsonPropertyName("startTime")] - public DateTimeOffset StartTime { get; set; } + /// Previously installed version, when available. + [JsonPropertyName("previousVersion")] + public string? PreviousVersion { get; set; } - /// Remote session state returned by the backing service. - [JsonPropertyName("state")] - public string? State { get; set; } + /// Number of skills installed after the update (success only). + [JsonPropertyName("skillsInstalled")] + public long? SkillsInstalled { get; set; } - /// Optional session summary. - [JsonPropertyName("summary")] - public string? Summary { get; set; } + /// Whether the update succeeded for this plugin. + [JsonPropertyName("success")] + public bool Success { get; set; } } -/// Remote session connection result. +/// Result of updating all installed plugins. [Experimental(Diagnostics.Experimental)] -public sealed class RemoteSessionConnectionResult +public sealed class PluginUpdateAllResult { - /// Metadata for a connected remote session. - [JsonPropertyName("metadata")] - public ConnectedRemoteSessionMetadata Metadata { get => field ??= new(); set; } - - /// SDK session ID for the connected remote session. - [JsonPropertyName("sessionId")] - public string SessionId { get; set; } = string.Empty; + /// Per-plugin update results in deterministic order. + [JsonPropertyName("results")] + public IList Results { get => field ??= []; set; } } -/// Remote session connection parameters. +/// Plugin names (or specs) to enable. [Experimental(Diagnostics.Experimental)] -internal sealed class ConnectRemoteSessionParams +internal sealed class PluginsEnableRequest { - /// Session ID to connect to. - [JsonPropertyName("sessionId")] - public string SessionId { get; set; } = string.Empty; + /// 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; } } -/// Local or remote session metadata entry. Narrow on `isRemote` to access source-specific fields. -/// Data type discriminated by isRemote. +/// Plugin names (or specs) to disable. [Experimental(Diagnostics.Experimental)] -public partial class SessionListEntry +internal sealed class PluginsDisableRequest { - /// The boolean discriminator. - [JsonPropertyName("isRemote")] - public bool IsRemote { get; set; } - - /// Runtime client name that created/last resumed this session. - [JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)] - [JsonPropertyName("clientName")] - public string? ClientName { get; set; } - - /// Pre-resolved working-directory context for session startup. - [JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)] - [JsonPropertyName("context")] - public SessionContext? Context { get; set; } - - /// True for detached maintenance sessions that should be hidden from normal resume lists. - [JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)] - [JsonPropertyName("isDetached")] - public bool? IsDetached { 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; } +} - /// 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; } +/// Trusted built-in plugin directories to use for this runtime process. +[Experimental(Diagnostics.Experimental)] +internal sealed class PluginsBuiltinSetRequest +{ + /// Complete replacement set of trusted built-in plugin directories. Every entry must be an absolute local filesystem path no longer than 4096 characters. + [JsonPropertyName("paths")] + public IList Paths { get => field ??= []; set; } +} - /// Last-modified time of the session's persisted state, as ISO 8601. - [JsonPropertyName("modifiedTime")] - public required string ModifiedTime { get; set; } +/// Registered marketplace summary. +[Experimental(Diagnostics.Experimental)] +public sealed class MarketplaceInfo +{ + /// True when this is a default marketplace shipped with the runtime. Defaults are not removable. + [JsonPropertyName("isDefault")] + public bool? IsDefault { get; set; } - /// Optional human-friendly name set via /rename. - [JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)] + /// Marketplace name (matches the @marketplace suffix in plugin specs). [JsonPropertyName("name")] - public string? Name { get; set; } - - /// Pull request number associated with the session. - [JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)] - [JsonPropertyName("pullRequestNumber")] - public long? PullRequestNumber { get; set; } - - /// Backing remote session IDs (most recent first). - [JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)] - [JsonPropertyName("remoteSessionIds")] - public IList? RemoteSessionIds { get; set; } - - /// GitHub repository the remote session belongs to. - [JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)] - [JsonPropertyName("repository")] - public RemoteSessionMetadataRepository? Repository { get; set; } - - /// Original remote resource identifier (task ID or PR node ID). - [JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)] - [JsonPropertyName("resourceId")] - public string? ResourceId { get; set; } - - /// Stable session identifier. - [JsonPropertyName("sessionId")] - public required string SessionId { get; set; } - - /// 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; } - - /// Session creation time as an ISO 8601 timestamp. - [JsonPropertyName("startTime")] - public required string StartTime { get; set; } - - /// Server-side task state returned by GitHub. - [JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)] - [JsonPropertyName("state")] - public string? State { get; set; } - - /// Short summary of the session, when one has been derived. - [JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)] - [JsonPropertyName("summary")] - public string? Summary { get; set; } + public string Name { get; set; } = string.Empty; - /// Whether the remote task originated from CCA or CLI `--remote`. - [JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)] - [JsonPropertyName("taskType")] - public RemoteSessionMetadataTaskType? TaskType { 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; } -/// Sessions matching the filter, ordered most-recently-modified first. +/// All registered marketplaces, including built-in defaults. [Experimental(Diagnostics.Experimental)] -public sealed class SessionList +public sealed class MarketplaceListResult { - /// Sessions ordered most-recently-modified first. Discriminated by `isRemote`. - [JsonPropertyName("sessions")] - public IList Sessions { get => field ??= []; set; } + /// Registered marketplaces. + [JsonPropertyName("marketplaces")] + public IList Marketplaces { get => field ??= []; set; } } -/// Optional filter applied to the returned sessions. +/// Result of registering a new marketplace. [Experimental(Diagnostics.Experimental)] -public sealed class SessionListFilter +public sealed class MarketplaceAddResult { - /// 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; } + /// Final name of the marketplace as resolved from its manifest. + [JsonPropertyName("name")] + public string Name { get; set; } = string.Empty; } -/// Optional source filter, metadata-load limit, and context filter applied to the returned sessions. +/// Marketplace source and optional working directory for relative-path resolution. [Experimental(Diagnostics.Experimental)] -internal sealed class SessionsListRequest +internal sealed class PluginsMarketplacesAddRequest { - /// Optional filter applied to the returned sessions. - [JsonPropertyName("filter")] - public SessionListFilter? Filter { get; set; } - - /// When true, include detached maintenance sessions. Defaults to false for user-facing session lists. - [JsonPropertyName("includeDetached")] - public bool? IncludeDetached { 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; } - - /// Which session sources to include. Defaults to `local` for backward compatibility. + /// 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 SessionSource? Source { get; set; } + public string Source { 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; } + /// 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; } } -/// ID of the local session bound to the given GitHub task, or omitted when none. +/// Outcome of the remove attempt, including dependent-plugin info when applicable. [Experimental(Diagnostics.Experimental)] -public sealed class SessionsFindByTaskIDResult +public sealed class MarketplaceRemoveResult { - /// Omitted when no local session is bound to that GitHub task. - [JsonPropertyName("sessionId")] - public string? SessionId { get; set; } + /// Names of installed plugins that prevented removal. Populated only when `removed=false`. + [JsonPropertyName("dependentPlugins")] + public IList? DependentPlugins { 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; } } -/// GitHub task ID to look up. +/// Name of the marketplace to remove and an optional force flag. [Experimental(Diagnostics.Experimental)] -internal sealed class SessionsFindByTaskIDRequest +internal sealed class PluginsMarketplacesRemoveRequest { - /// GitHub task ID to look up. - [JsonPropertyName("taskId")] - public string TaskId { get; set; } = string.Empty; + /// 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; } + + /// Marketplace name to remove. + [JsonPropertyName("name")] + public string Name { get; set; } = string.Empty; } -/// Session ID matching the prefix, omitted when no unique match exists. +/// Plugin entry advertised by a marketplace. [Experimental(Diagnostics.Experimental)] -public sealed class SessionsFindByPrefixResult +public sealed class MarketplacePluginInfo { - /// Omitted when no unique session matches the prefix (no match or ambiguous). - [JsonPropertyName("sessionId")] - public string? SessionId { get; set; } + /// 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; } -/// UUID prefix to resolve to a unique session ID. +/// Plugins advertised by the marketplace. [Experimental(Diagnostics.Experimental)] -internal sealed class SessionsFindByPrefixRequest +public sealed class MarketplaceBrowseResult { - /// 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; + /// Plugins advertised by the marketplace. + [JsonPropertyName("plugins")] + public IList Plugins { get => field ??= []; set; } } -/// Most-relevant session ID for the supplied context, or omitted when no sessions exist. +/// Name of the marketplace whose plugin catalog to fetch. [Experimental(Diagnostics.Experimental)] -public sealed class SessionsGetLastForContextResult +internal sealed class PluginsMarketplacesBrowseRequest { - /// Most-relevant session ID for the supplied context, or omitted when no sessions exist. - [JsonPropertyName("sessionId")] - public string? SessionId { get; set; } + /// Marketplace name to browse. + [JsonPropertyName("name")] + public string Name { get; set; } = string.Empty; } -/// Optional working-directory context used to score session relevance. +/// Per-marketplace refresh result, including marketplace name, success flag, and optional failure error. [Experimental(Diagnostics.Experimental)] -internal sealed class SessionsGetLastForContextRequest +public sealed class MarketplaceRefreshEntry { - /// Optional working-directory context used to score session relevance. When omitted the most-recently-modified session wins. - [JsonPropertyName("context")] - public SessionContext? Context { get; set; } + /// Error message (failure only). + [JsonPropertyName("error")] + public string? Error { 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; } } -/// Absolute path to the session's events.jsonl file on disk. +/// Result of refreshing one or more marketplace catalogs. [Experimental(Diagnostics.Experimental)] -internal sealed class SessionsGetEventFilePathResult +public sealed class MarketplaceRefreshResult { - /// Absolute path to the session's events.jsonl file. - [JsonPropertyName("filePath")] - public string FilePath { get; set; } = string.Empty; + /// Per-marketplace refresh results in deterministic order. + [JsonPropertyName("results")] + public IList Results { get => field ??= []; set; } } -/// Session ID whose event-log file path to compute. +/// RPC data type for PluginsMarketplacesRefresh operations. [Experimental(Diagnostics.Experimental)] -internal sealed class SessionsGetEventFilePathRequest +internal sealed class PluginsMarketplacesRefreshRequest { - /// Session ID whose event-log file path to compute. - [JsonPropertyName("sessionId")] - public string SessionId { get; set; } = string.Empty; -} - -/// Map of sessionId -> on-disk size in bytes for each session's workspace directory. -[Experimental(Diagnostics.Experimental)] -public sealed class SessionSizes -{ - /// Map of sessionId -> on-disk size in bytes for the session's workspace directory. - [JsonPropertyName("sizes")] - public IDictionary Sizes { get => field ??= new Dictionary(); set; } + /// Marketplace name to refresh. When omitted, every registered marketplace is refreshed. + [JsonPropertyName("name")] + public string? Name { get; set; } } -/// Session IDs from the input set that are currently in use by another process. +/// Server-side skill metadata, including name, description, source, enabled/invocable state, path, project path, and argument hint. [Experimental(Diagnostics.Experimental)] -public sealed class SessionsCheckInUseResult +public sealed class ServerSkill { - /// 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; } + /// Optional freeform hint describing the skill's expected arguments, from the `argument-hint` frontmatter field. + [JsonPropertyName("argumentHint")] + public string? ArgumentHint { 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 (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 string? Path { get; set; } + + /// The project path this skill belongs to (only for project/inherited skills). + [JsonPropertyName("projectPath")] + public string? ProjectPath { 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; } } -/// Session IDs to test for live in-use locks. +/// Skills discovered across global and project sources. [Experimental(Diagnostics.Experimental)] -internal sealed class SessionsCheckInUseRequest +public sealed class ServerSkillList { - /// Session IDs to test for live in-use locks. - [JsonPropertyName("sessionIds")] - public IList SessionIds { get => field ??= []; 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; } + + /// All discovered skills across all sources. + [JsonPropertyName("skills")] + public IList Skills { get => field ??= []; set; } } -/// The session's persisted remote-steerable flag, or omitted when no value has been persisted. +/// Optional project paths and additional skill directories to include in discovery. [Experimental(Diagnostics.Experimental)] -internal sealed class SessionsGetPersistedRemoteSteerableResult +internal sealed class SkillsDiscoverRequest { - /// The session's persisted remote-steerable flag if recorded; omitted when no value has been persisted. - [JsonPropertyName("remoteSteerable")] - public bool? RemoteSteerable { get; 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; } + + /// 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; } } -/// Session ID to look up the persisted remote-steerable flag for. +/// Canonical directory where skills can be discovered or created, with scope, preference, and optional project path. [Experimental(Diagnostics.Experimental)] -internal sealed class SessionsGetPersistedRemoteSteerableRequest +public sealed class SkillDiscoveryPath { - /// Session ID to look up the persisted remote-steerable flag for. - [JsonPropertyName("sessionId")] - public string SessionId { get; set; } = string.Empty; + /// Absolute path of the create/discovery target (may not exist on disk yet). + [JsonPropertyName("path")] + public string Path { get; set; } = string.Empty; + + /// 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; } + + /// 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 SkillDiscoveryScope Scope { 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. +/// Canonical locations where skills can be created so the runtime will recognize them. [Experimental(Diagnostics.Experimental)] -public sealed class SessionsCloseResult +public sealed class SkillDiscoveryPathList { + /// Canonical skill create/discovery directories, in priority order. + [JsonPropertyName("paths")] + public IList Paths { get => field ??= []; set; } } -/// Session ID to close. +/// Optional project paths to enumerate. [Experimental(Diagnostics.Experimental)] -internal sealed class SessionsCloseRequest +internal sealed class SkillsGetDiscoveryPathsRequest { - /// Session ID to close. - [JsonPropertyName("sessionId")] - public string SessionId { get; set; } = string.Empty; + /// 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; } + + /// Optional list of project directory paths. When omitted or empty, only personal and custom directories are returned. + [JsonPropertyName("projectPaths")] + public IList? ProjectPaths { get; set; } } -/// Map of sessionId -> bytes freed by removing the session's workspace directory. +/// Skill names to mark as disabled in global configuration, replacing any previous list. [Experimental(Diagnostics.Experimental)] -public sealed class SessionBulkDeleteResult +internal sealed class SkillsConfigSetDisabledSkillsRequest { - /// 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; } + /// List of skill names to disable. + [JsonPropertyName("disabledSkills")] + public IList DisabledSkills { get => field ??= []; set; } } -/// Session IDs to close, deactivate, and delete from disk. +/// Adds or removes a single skill from the global disabled list, leaving every other entry untouched. [Experimental(Diagnostics.Experimental)] -internal sealed class SessionsBulkDeleteRequest +internal sealed class SkillsConfigSetSkillDisabledRequest { - /// Session IDs to close, deactivate, and delete from disk. - [JsonPropertyName("sessionIds")] - public IList SessionIds { get => field ??= []; set; } + /// True to disable the skill, false to enable it. + [JsonPropertyName("disabled")] + public bool Disabled { get; set; } + + /// Name of the skill to add to or remove from the disabled list. + [JsonPropertyName("name")] + public string Name { get; set; } = string.Empty; } -/// Outcome of the prune operation: deleted IDs, dry-run candidates, skipped IDs, total bytes freed, and the dry-run flag. +/// Agent metadata, including identifiers, display details, source, tools, model, MCP servers, skills, and file path. [Experimental(Diagnostics.Experimental)] -public sealed class SessionPruneResult +public sealed class AgentInfo { - /// Session IDs that would be deleted in dry-run mode (always empty otherwise). - [JsonPropertyName("candidates")] - public IList Candidates { get => field ??= []; set; } + /// Description of the agent's purpose. + [JsonPropertyName("description")] + public string Description { get; set; } = string.Empty; - /// Session IDs that were deleted (always empty in dry-run mode). - [JsonPropertyName("deleted")] - public IList Deleted { get => field ??= []; set; } + /// Human-readable display name. + [JsonPropertyName("displayName")] + public string DisplayName { get; set; } = string.Empty; - /// True when no deletions were actually performed. - [JsonPropertyName("dryRun")] - public bool DryRun { 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; - /// Total bytes freed (actual when not dry-run, projected when dry-run). - [JsonPropertyName("freedBytes")] - public long FreedBytes { 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; } - /// Session IDs that were skipped (e.g., named sessions). - [JsonPropertyName("skipped")] - public IList Skipped { get => field ??= []; 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; } -/// Age threshold and optional flags controlling which old sessions are pruned (or simulated when dryRun is true). -[Experimental(Diagnostics.Experimental)] -internal sealed class SessionsPruneOldRequest -{ - /// When true, only report what would be deleted without performing any deletion. - [JsonPropertyName("dryRun")] - public bool? DryRun { get; set; } + /// Name of the agent. Use `id` as the stable selection identifier. + [JsonPropertyName("name")] + public string Name { get; set; } = string.Empty; - /// Session IDs that should never be considered for pruning. - [JsonPropertyName("excludeSessionIds")] - public IList? ExcludeSessionIds { 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; } - /// When true, named sessions (set via /rename) are also eligible for pruning. - [JsonPropertyName("includeNamed")] - public bool? IncludeNamed { 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; } - /// Delete sessions whose modifiedTime is at least this many days old. - [JsonPropertyName("olderThanDays")] - public long OlderThanDays { get; set; } -} + /// Skill names preloaded into this agent's context. Omitted means none. + [JsonPropertyName("skills")] + public IList? Skills { get; set; } -/// Flush a session's pending events to disk. No-op when no writer exists for the session (e.g., already closed). -[Experimental(Diagnostics.Experimental)] -public sealed class SessionsSaveResult -{ -} + /// Where the agent definition was loaded from. + [JsonPropertyName("source")] + public AgentInfoSource? Source { get; set; } -/// Session ID whose pending events should be flushed to disk. -[Experimental(Diagnostics.Experimental)] -internal sealed class SessionsSaveRequest -{ - /// Session ID whose pending events should be flushed to disk. - [JsonPropertyName("sessionId")] - public string SessionId { get; set; } = string.Empty; + /// Allowed tool names for this agent. Empty array means none; omitted means inherit defaults. + [JsonPropertyName("tools")] + public IList? Tools { 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; } } -/// 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. +/// Agents discovered across user, project, plugin, and remote sources. [Experimental(Diagnostics.Experimental)] -public sealed class SessionsReleaseLockResult +public sealed class ServerAgentList { + /// All discovered agents across all sources. + [JsonPropertyName("agents")] + public IList Agents { get => field ??= []; set; } } -/// Session ID whose in-use lock should be released. +/// Optional project paths to include in agent discovery. [Experimental(Diagnostics.Experimental)] -internal sealed class SessionsReleaseLockRequest +internal sealed class AgentsDiscoverRequest { - /// Session ID whose in-use lock should be released. - [JsonPropertyName("sessionId")] - public string SessionId { get; set; } = string.Empty; + /// 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; } + + /// 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; } } -/// Persisted local session metadata, including identifiers, timestamps, summary/name, client, context, detached state, and task ID. +/// Canonical directory where custom agents can be discovered or created, with scope, preference, and optional project path. [Experimental(Diagnostics.Experimental)] -public sealed class LocalSessionMetadataValue +public sealed class AgentDiscoveryPath { - /// Runtime client name that created/last resumed this session. - [JsonPropertyName("clientName")] - public string? ClientName { get; set; } - - /// 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; } + /// Absolute path of the search/create directory (may not exist on disk yet). + [JsonPropertyName("path")] + public string Path { get; set; } = string.Empty; - /// Stable 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; } - /// Session creation time as an ISO 8601 timestamp. - [JsonPropertyName("startTime")] - public string StartTime { get; set; } = string.Empty; + /// The input project path this directory was derived from (only for project scope). + [JsonPropertyName("projectPath")] + public string? ProjectPath { get; set; } - /// Short summary of the session, when one has been derived. - [JsonPropertyName("summary")] - public string? Summary { get; set; } + /// Which tier this directory belongs to. + [JsonPropertyName("scope")] + public AgentDiscoveryPathScope Scope { get; set; } } -/// The enriched metadata records, with summary and context fields backfilled where available. Sessions confirmed empty and unnamed are omitted. +/// Canonical locations where custom agents can be created so the runtime will recognize them. [Experimental(Diagnostics.Experimental)] -public sealed class SessionEnrichMetadataResult +public sealed class AgentDiscoveryPathList { - /// Enriched records, with summary and context backfilled. Sessions confirmed empty and unnamed may be omitted. - [JsonPropertyName("sessions")] - public IList Sessions { get => field ??= []; set; } + /// Canonical agent create/discovery directories, in priority order. + [JsonPropertyName("paths")] + public IList Paths { get => field ??= []; set; } } -/// Session metadata records to enrich with summary and context information. +/// Optional project paths to include when enumerating agent discovery directories. [Experimental(Diagnostics.Experimental)] -internal sealed class SessionsEnrichMetadataRequest +internal sealed class AgentsGetDiscoveryPathsRequest { - /// Session metadata records to enrich. Records that already have summary and context are returned unchanged. - [JsonPropertyName("sessions")] - public IList Sessions { get => field ??= []; 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; } -/// 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 -{ + /// Optional list of project directory paths. When omitted or empty, only the user-level directory is returned. + [JsonPropertyName("projectPaths")] + public IList? ProjectPaths { get; set; } } -/// Active session ID and an optional flag for deferring repo-level hooks until folder trust. +/// Loaded instruction source for a session, including path, content, category, location, applicability, and optional description. [Experimental(Diagnostics.Experimental)] -internal sealed class SessionsReloadPluginHooksRequest +public sealed class InstructionSource { - /// When true, skip repo-level hooks. Use before folder trust is confirmed; loadDeferredRepoHooks loads them post-trust. - [JsonPropertyName("deferRepoHooks")] - public bool? DeferRepoHooks { get; set; } + /// Glob pattern(s) from frontmatter β€” when set, this instruction applies only to matching files. + [JsonPropertyName("applyTo")] + public IList? ApplyTo { get; set; } - /// Active session ID to reload hooks for. - [JsonPropertyName("sessionId")] - public string SessionId { get; set; } = string.Empty; -} + /// Raw content of the instruction file. + [JsonPropertyName("content")] + public string Content { get; set; } = string.Empty; -/// 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; } + /// When true, this source starts disabled and must be toggled on by the user. + [JsonPropertyName("defaultDisabled")] + public bool? DefaultDisabled { 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; } + /// 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 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 InstructionSourceType Type { get; set; } } -/// Active session ID whose deferred repo-level hooks should be loaded. +/// Instruction sources discovered across user, repository, and plugin sources. [Experimental(Diagnostics.Experimental)] -internal sealed class SessionsLoadDeferredRepoHooksRequest +public sealed class ServerInstructionSourceList { - /// Active session ID whose deferred repo-level hooks should be loaded. - [JsonPropertyName("sessionId")] - public string SessionId { get; set; } = string.Empty; + /// All discovered instruction sources. + [JsonPropertyName("sources")] + public IList Sources { 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. +/// Optional project paths to include in instruction discovery. [Experimental(Diagnostics.Experimental)] -public sealed class SessionsSetAdditionalPluginsResult +internal sealed class 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. + [JsonPropertyName("excludeHostInstructions")] + public bool? ExcludeHostInstructions { 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; } } -/// Installed plugin record from global state, with marketplace, version, install time, enabled state, cache path, and source. +/// 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 InstalledPlugin +public sealed class InstructionDiscoveryPath { - /// 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. - [JsonPropertyName("installed_at")] - public string InstalledAt { get; set; } = string.Empty; + /// Whether the target is a single file or a directory of instruction files. + [JsonPropertyName("kind")] + public InstructionDiscoveryPathKind Kind { get; set; } - /// Marketplace the plugin came from (empty string for direct repo installs). - [JsonPropertyName("marketplace")] - public string Marketplace { get; set; } = string.Empty; + /// Which tier this target belongs to. + [JsonPropertyName("location")] + public InstructionDiscoveryPathLocation Location { get; set; } - /// Plugin name. - [JsonPropertyName("name")] - public string Name { get; set; } = string.Empty; + /// Absolute path of the file or directory (may not exist on disk yet). + [JsonPropertyName("path")] + public string Path { get; set; } = string.Empty; - /// Source for direct repo installs (when marketplace is empty). - [JsonPropertyName("source")] - public JsonElement? Source { 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; } - /// Version installed (if available). - [JsonPropertyName("version")] - public string? Version { get; set; } + /// The input project path this target was derived from (only for repository targets). + [JsonPropertyName("projectPath")] + public string? ProjectPath { get; set; } } -/// Manager-wide additional plugins to register; replaces any previously-configured set. +/// Canonical files and directories where custom instructions can be created so the runtime will recognize them. [Experimental(Diagnostics.Experimental)] -internal sealed class SessionsSetAdditionalPluginsRequest +public sealed class InstructionDiscoveryPathList { - /// 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; } + /// Canonical instruction create/discovery files and directories, in priority order. + [JsonPropertyName("paths")] + public IList Paths { get => field ??= []; set; } } -/// Dynamic-context board entry count, when available. +/// Optional project paths to include when enumerating instruction discovery targets. [Experimental(Diagnostics.Experimental)] -internal sealed class SessionsGetBoardEntryCountResult +internal sealed class InstructionsGetDiscoveryPathsRequest { - /// Board entry count, when available. - [JsonPropertyName("count")] - public long? Count { 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; } } -/// Session ID whose board entry count should be returned. +/// A literal choice the command input accepts, with a human-facing description. [Experimental(Diagnostics.Experimental)] -internal sealed class SessionsGetBoardEntryCountRequest +public sealed class SlashCommandInputChoice { - /// Session ID whose board entry count should be returned. - [JsonPropertyName("sessionId")] - public string SessionId { 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; } -/// State of the runtime-managed remote-control singleton. -/// Polymorphic base type discriminated by state. +/// Optional unstructured input hint. [Experimental(Diagnostics.Experimental)] -[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 +public sealed class SlashCommandInput { - /// The type discriminator. - [JsonPropertyName("state")] - public virtual string State { get; set; } = string.Empty; -} + /// 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; } + /// Optional completion hint for the input (e.g. 'directory' for filesystem path completion). + [JsonPropertyName("completion")] + public SlashCommandInputCompletion? Completion { get; set; } -/// Remote control is not connected. -/// The off variant of . -[Experimental(Diagnostics.Experimental)] -public partial class RemoteControlStatusOff : RemoteControlStatus -{ - /// - [JsonIgnore] - public override string State => "off"; -} + /// Hint to display when command input has not been provided. + [JsonPropertyName("hint")] + public string Hint { get; set; } = string.Empty; -/// Remote control is in the middle of initial setup. -/// The connecting variant of . -[Experimental(Diagnostics.Experimental)] -public partial class RemoteControlStatusConnecting : RemoteControlStatus -{ - /// - [JsonIgnore] - public override string State => "connecting"; + /// 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; } - /// Session id the connection is attaching to. - [JsonPropertyName("attachedSessionId")] - public required string AttachedSessionId { 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; } } -/// Remote control is connected to a local session. -/// The active variant of . +/// Slash-command metadata with name, aliases, description, kind, input hint, execution allowance, and schedulability. [Experimental(Diagnostics.Experimental)] -public partial class RemoteControlStatusActive : RemoteControlStatus +public sealed class SlashCommandInfo { - /// - [JsonIgnore] - public override string State => "active"; - - /// Session id remote control is pointed at. - [JsonPropertyName("attachedSessionId")] - public required string AttachedSessionId { get; set; } + /// Canonical aliases without leading slashes. + [JsonPropertyName("aliases")] + public IList? Aliases { 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; } + /// Whether the command may run while an agent turn is active. + [JsonPropertyName("allowDuringAgentExecution")] + public bool AllowDuringAgentExecution { get; set; } - /// MC frontend URL for this session, when known. - [JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)] - [JsonPropertyName("frontendUrl")] - public string? FrontendUrl { get; set; } + /// Human-readable command description. + [JsonPropertyName("description")] + public string Description { get; set; } = string.Empty; - /// Whether the MC session may steer this session. - [JsonPropertyName("isSteerable")] - public required bool IsSteerable { get; set; } + /// Whether the command is experimental. + [JsonPropertyName("experimental")] + public bool? Experimental { get; set; } - /// 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. - [JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)] - [JsonInclude] - [JsonPropertyName("promptManager")] - internal JsonElement? PromptManager { get; set; } -} + /// Optional unstructured input hint. + [JsonPropertyName("input")] + public SlashCommandInput? Input { get; set; } -/// The last setup attempt failed. The singleton is otherwise off. -/// The error variant of . -[Experimental(Diagnostics.Experimental)] -public partial class RemoteControlStatusError : RemoteControlStatus -{ - /// - [JsonIgnore] - public override string State => "error"; + /// 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; } - /// Session id the failing setup attempt targeted, when known. - [JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)] - [JsonPropertyName("attachedSessionId")] - public string? AttachedSessionId { get; set; } + /// Canonical command name without a leading slash. + [JsonPropertyName("name")] + public string Name { get; set; } = string.Empty; - /// Human-readable error message from the last setup attempt. - [JsonPropertyName("error")] - public required string Error { 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; } } -/// Wrapper for the singleton's current status. +/// Slash commands available in the session, after applying any include/exclude filters. [Experimental(Diagnostics.Experimental)] -public sealed class RemoteControlStatusResult +public sealed class CommandList { - /// State of the runtime-managed remote-control singleton. - [JsonPropertyName("status")] - public RemoteControlStatus Status { get => field ??= new(); set; } + /// Commands available in this session. + [JsonPropertyName("commands")] + public IList Commands { get => field ??= []; set; } } -/// Reattach to an existing MC session without creating a new one. +/// 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 RemoteControlConfigExistingMcSession +public sealed class UserSettingMetadata { - /// Existing MC session ID to reattach to. - [JsonPropertyName("mcSessionId")] - public string McSessionId { get; set; } = string.Empty; + /// The centrally-known default for this setting (null when no default is registered). + [JsonPropertyName("default")] + public JsonElement Default { get; set; } - /// Existing MC task ID for the reattached session. - [JsonPropertyName("mcTaskId")] - public string McTaskId { get; set; } = string.Empty; + /// 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; } + + /// The effective value: the user's value if set, otherwise the default. + [JsonPropertyName("value")] + public JsonElement Value { get; set; } } -/// Configuration for the runtime-managed remote-control singleton. +/// 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 RemoteControlConfig +public sealed class UserSettingsGetResult { - /// 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; } + /// 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; } } -/// Parameters for attaching the remote-control singleton to a session. +/// Outcome of writing user settings. [Experimental(Diagnostics.Experimental)] -internal sealed class SessionsStartRemoteControlRequest +public sealed class UserSettingsSetResult { - /// 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; + /// 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; } } -/// Outcome of a transferRemoteControl call. +/// 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)] -public sealed class RemoteControlTransferResult +internal sealed class UserSettingsSetRequest { - /// 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; } + /// Partial user settings to write, as a free-form object keyed by setting name. + [JsonPropertyName("settings")] + public JsonElement Settings { get; set; } } -/// Parameters for atomically rebinding the remote-control singleton. +/// Validated device-managed settings discovered before a session exists. [Experimental(Diagnostics.Experimental)] -internal sealed class SessionsTransferRemoteControlRequest +public sealed class ManagedSettingsReadResult { - /// 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; } + /// Discovery or validation error text when managed settings could not be read safely. + [JsonPropertyName("errorMessage")] + public string? ErrorMessage { get; set; } - /// Local session id to point remote control at. - [JsonPropertyName("toSessionId")] - public string ToSessionId { get; set; } = string.Empty; + /// 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; } } -/// Patch for the singleton's steering state. +/// Indicates whether the calling client was registered as the session filesystem provider. [Experimental(Diagnostics.Experimental)] -internal sealed class SessionsSetRemoteControlSteeringRequest +public sealed class SessionFsSetProviderResult { - /// 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; } + /// Whether the provider was set successfully. + [JsonPropertyName("success")] + public bool Success { get; set; } } -/// Outcome of a stopRemoteControl call. +/// Optional capabilities declared by the provider. [Experimental(Diagnostics.Experimental)] -public sealed class RemoteControlStopResult +public sealed class SessionFsSetProviderCapabilities { - /// State of the runtime-managed remote-control singleton. - [JsonPropertyName("status")] - public RemoteControlStatus Status { get => field ??= new(); set; } - - /// Whether the singleton was actually torn down by this call. - [JsonPropertyName("stopped")] - public bool Stopped { get; set; } + /// Whether the provider supports SQLite query/exists operations. + [JsonPropertyName("sqlite")] + public bool? Sqlite { get; set; } } -/// RPC data type for SessionsStopRemoteControl operations. +/// 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)] -internal sealed class SessionsStopRemoteControlRequest +internal sealed class SessionFsSetProviderRequest { - /// 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; } + /// Optional capabilities declared by the provider. + [JsonPropertyName("capabilities")] + public SessionFsSetProviderCapabilities? Capabilities { get; set; } - /// 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; } + /// Path conventions used by this filesystem. + [JsonPropertyName("conventions")] + public SessionFsSetProviderConventions Conventions { get; set; } + + /// Initial working directory for sessions. + [JsonPropertyName("initialCwd")] + public string InitialCwd { get; set; } = string.Empty; + + /// Path within each session's SessionFs where the runtime stores files for that session. + [JsonPropertyName("sessionStatePath")] + public string SessionStatePath { get; set; } = string.Empty; } -/// Handle for releasing the extension tool registration. +/// Indicates whether the calling client was registered as the LLM inference provider. [Experimental(Diagnostics.Experimental)] -internal sealed class RegisterExtensionToolsResult +public sealed class LlmInferenceSetProviderResult { - /// In-process unsubscribe function (CLI-only optimization). Marked internal: replaced by an explicit `extensions.unregister` RPC in the SDK migration. - [JsonInclude] - [JsonPropertyName("unsubscribe")] - internal JsonElement Unsubscribe { get; set; } + /// Whether the provider was set successfully. + [JsonPropertyName("success")] + public bool Success { get; set; } } -/// Optional registration options. +/// Whether the start frame was accepted. [Experimental(Diagnostics.Experimental)] -public sealed class SessionsRegisterExtensionToolsOnSessionOptions +public sealed class LlmInferenceHttpResponseStartResult { - /// In-process `() => boolean` gating callback (CLI-only optimization). Marked internal: replaced by runtime-side enable/disable RPCs in the SDK migration. - [JsonInclude] - [JsonPropertyName("enabled")] - internal JsonElement? Enabled { get; set; } + /// True when the response start was matched to a pending request; false when unknown. + [JsonPropertyName("accepted")] + public bool Accepted { get; set; } } -/// Params to attach an extension loader's tools to a session. +/// Response head. [Experimental(Diagnostics.Experimental)] -internal sealed class RegisterExtensionToolsParams +internal sealed class LlmInferenceHttpResponseStartRequest { - /// 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. - [JsonInclude] - [JsonPropertyName("loader")] - internal JsonElement Loader { get; set; } + /// HTTP response headers, preserving multiple values per name. + [JsonPropertyName("headers")] + public IDictionary> Headers { get => field ??= new Dictionary>(); set; } - /// Optional registration options. - [JsonPropertyName("options")] - public SessionsRegisterExtensionToolsOnSessionOptions? Options { get; set; } + /// Matches the requestId from the originating httpRequestStart frame. + [JsonPropertyName("requestId")] + public string RequestId { get; set; } = string.Empty; - /// Session to register extension tools on. - [JsonPropertyName("sessionId")] - public string SessionId { get; set; } = string.Empty; + /// HTTP status code. + [JsonPropertyName("status")] + public long Status { get; set; } + + /// Optional HTTP status reason phrase. + [JsonPropertyName("statusText")] + public string? StatusText { get; set; } } -/// Params to attach or detach an in-process ExtensionController delegate. +/// Whether the chunk was accepted. [Experimental(Diagnostics.Experimental)] -internal sealed class ConfigureSessionExtensionsParams +public sealed class LlmInferenceHttpResponseChunkResult { - /// 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. - [JsonInclude] - [JsonPropertyName("controller")] - internal JsonElement? Controller { get; set; } - - /// Session to attach the extension controller delegate to. - [JsonPropertyName("sessionId")] - public string SessionId { get; set; } = string.Empty; + /// True when the chunk was matched to a pending request; false when unknown. + [JsonPropertyName("accepted")] + public bool Accepted { get; set; } } -/// Outcome of an agentRegistry.spawn call. -/// Polymorphic base type discriminated by kind. +/// 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)] -[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 LlmInferenceHttpResponseChunkError { - /// The type discriminator. - [JsonPropertyName("kind")] - public virtual string Kind { get; set; } = string.Empty; -} + /// 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; +} -/// Full registry entry for the spawned child. Lets the controller call `handleLiveTargetSelected(entry)` directly without re-reading the registry (avoids a TOCTOU window). +/// A response body chunk or terminal error. [Experimental(Diagnostics.Experimental)] -public sealed class AgentRegistryLiveTargetEntry +internal sealed class LlmInferenceHttpResponseChunkRequest { - /// Kind of attention required when status === "attention". Meaningful only when status === "attention". - [JsonPropertyName("attentionKind")] - public AgentRegistryLiveTargetEntryAttentionKind? AttentionKind { 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; } - /// Git branch of the session (when known). + /// 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; + + /// 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; +} + +/// Pre-resolved working-directory context for session startup. +[Experimental(Diagnostics.Experimental)] +public sealed class SessionContext +{ + /// Active git branch. [JsonPropertyName("branch")] public string? Branch { get; set; } - /// Copilot CLI version that wrote the entry. - [JsonPropertyName("copilotVersion")] - public string CopilotVersion { get; set; } = string.Empty; - - /// Working directory of the session (when known). + /// Most recent working directory for this session. [JsonPropertyName("cwd")] - public string? Cwd { get; set; } + public string Cwd { get; set; } = string.Empty; - /// Bind host for the entry's JSON-RPC server. - [JsonPropertyName("host")] - public string Host { get; set; } = string.Empty; + /// Git repository root, if the cwd was inside a git repo. + [JsonPropertyName("gitRoot")] + public string? GitRoot { get; set; } - /// Process kind tag for the registry entry. - [JsonPropertyName("kind")] - public AgentRegistryLiveTargetEntryKind Kind { get; set; } + /// Repository host type. + [JsonPropertyName("hostType")] + public SessionContextHostType? HostType { get; set; } - /// Wall-clock milliseconds since the watcher last observed this entry (heartbeat freshness). - [JsonPropertyName("lastSeenMs")] - public long LastSeenMs { get; set; } + /// Repository slug in `owner/name` form, when known. + [JsonPropertyName("repository")] + public string? Repository { 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; } +/// 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; - /// Model identifier currently selected for the session. - [JsonPropertyName("model")] - public string? Model { get; set; } + /// Repository name. + [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; } + /// Repository owner. + [JsonPropertyName("owner")] + public string Owner { get; set; } = string.Empty; +} - /// TCP port the entry's JSON-RPC server is listening on. - [JsonPropertyName("port")] - public long Port { 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; } - /// Registry entry schema version (1 = ui-server, 2 = managed-server). - [JsonPropertyName("schemaVersion")] - public long SchemaVersion { get; set; } + /// Host-supplied human description of what the session is doing right now ("running tests", "waiting for approval"). Optional in the protocol and absent on hosts that do not publish it, so never rely on it -- it enriches `hostStatus`, it does not replace it. + [JsonPropertyName("hostActivity")] + public string? HostActivity { get; set; } - /// Session ID of the foreground session for this entry. + /// Live status as the owning host reports it in its session listing, so a row for a session running elsewhere can show that it is running. Absent for hosts that publish no such status (the cloud task managers), which read as idle. + [JsonPropertyName("hostStatus")] + public RemoteSessionHostStatus? HostStatus { get; set; } + + /// Always true for remote sessions. + [JsonPropertyName("isRemote")] + public bool IsRemote { get; set; } + + /// Last-modified time as an ISO 8601 timestamp. + [JsonPropertyName("modifiedTime")] + public string ModifiedTime { get; set; } = string.Empty; + + /// Optional human-friendly name set via /rename. + [JsonPropertyName("name")] + public string? Name { get; set; } + + /// Pull request number associated with the session. + [JsonPropertyName("pullRequestNumber")] + public long? PullRequestNumber { get; set; } + + /// Backing remote session IDs (most recent first). + [JsonPropertyName("remoteSessionIds")] + public IList RemoteSessionIds { get => field ??= []; set; } + + /// GitHub repository the remote session belongs to. + [JsonPropertyName("repository")] + public RemoteSessionMetadataRepository Repository { get => field ??= new(); set; } + + /// Original remote resource identifier (task ID or PR node ID). + [JsonPropertyName("resourceId")] + public string? ResourceId { get; set; } + + /// Stable session identifier. [JsonPropertyName("sessionId")] - public string? SessionId { get; set; } + public string SessionId { get; set; } = string.Empty; - /// Friendly session name (when set). - [JsonPropertyName("sessionName")] - public string? SessionName { get; set; } + /// Deadline (ISO 8601) at which a CLI remote session becomes stale without further heartbeats. + [JsonPropertyName("staleAt")] + public string? StaleAt { get; set; } - /// ISO 8601 timestamp captured at registration. - [JsonPropertyName("startedAt")] - public string StartedAt { get; set; } = string.Empty; + /// Session creation time as an ISO 8601 timestamp. + [JsonPropertyName("startTime")] + public string StartTime { get; set; } = string.Empty; - /// Coarse lifecycle status of the foreground session. - [JsonPropertyName("status")] - public AgentRegistryLiveTargetEntryStatus? Status { get; set; } + /// Server-side task state returned by GitHub. + [JsonPropertyName("state")] + public string? State { get; set; } - /// Monotonic per-publisher revision counter incremented on every status update. Lets watchers detect transient flips. - [JsonPropertyName("statusRevision")] - public long? StatusRevision { get; set; } + /// Short summary of the session, when one has been derived. + [JsonPropertyName("summary")] + public string? Summary { get; set; } - /// Connection token (null when the target is unauthenticated). - [JsonInclude] - [JsonPropertyName("token")] - internal string? Token { get; set; } + /// Whether the remote task originated from CCA or CLI `--remote`. + [JsonPropertyName("taskType")] + public RemoteSessionMetadataTaskType? TaskType { get; set; } } -/// Per-spawn log-capture outcome; populated from spawnLiveTarget. +/// `sessions.open` handoff progress update with step, status, and optional message. [Experimental(Diagnostics.Experimental)] -public sealed class AgentRegistryLogCapture +public sealed class SessionsOpenProgress { - /// 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; } + /// Optional step message. + [JsonPropertyName("message")] + public string? Message { get; set; } - /// Categorized reason for log-open failure. - [JsonPropertyName("openErrorReason")] - public AgentRegistryLogCaptureOpenErrorReason? OpenErrorReason { get; set; } + /// Step status. + [JsonPropertyName("status")] + public SessionsOpenProgressStatus Status { get; set; } - /// Absolute path to the per-spawn log file (only set when enabled). - [JsonPropertyName("path")] - public string? Path { get; set; } + /// Handoff step. + [JsonPropertyName("step")] + public SessionsOpenProgressStep Step { get; set; } } -/// Managed-server child was spawned and registered successfully. -/// The spawned variant of . +/// Result of opening a session. [Experimental(Diagnostics.Experimental)] -public partial class AgentRegistrySpawnResultSpawned : AgentRegistrySpawnResult +public sealed class SessionOpenResult { - /// - [JsonIgnore] - public override string Kind => "spawned"; + /// Remote session metadata, present when status is `connected`. + [JsonPropertyName("metadata")] + public RemoteSessionMetadataValue? Metadata { get; set; } - /// 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; } + /// Handoff progress steps, present when status is `handed_off`. + [JsonPropertyName("progress")] + public IList? Progress { 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; } + /// Remote session ID, present when status is `connected`. + [JsonPropertyName("remoteSessionId")] + public string? RemoteSessionId { 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; } + /// Opened session ID. Omitted when status is `not_found`. + [JsonPropertyName("sessionId")] + public string? SessionId { get; set; } - /// Per-spawn log-capture outcome; populated from spawnLiveTarget. - [JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)] - [JsonPropertyName("logCapture")] - public AgentRegistryLogCapture? LogCapture { 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; } + + /// Outcome of the open request. + [JsonPropertyName("status")] + public SessionsOpenStatus Status { get; set; } } -/// `child_process.spawn` itself failed before the child entered the registry. -/// The spawn-error variant of . +/// Identifier and optional friendly name assigned to the newly forked session. [Experimental(Diagnostics.Experimental)] -public partial class AgentRegistrySpawnResultSpawnError : AgentRegistrySpawnResult +public sealed class SessionsForkResult { - /// - [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; } + /// Friendly name assigned to the forked session, if any. + [JsonPropertyName("name")] + public string? Name { get; set; } - /// Human-readable error message. - [JsonPropertyName("message")] - public required string Message { get; set; } + /// The new forked session's ID. + [JsonPropertyName("sessionId")] + public string SessionId { get; set; } = string.Empty; } -/// Spawn succeeded but the child did not publish a matching managed-server entry within the timeout. -/// The registry-timeout 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 AgentRegistrySpawnResultRegistryTimeout : AgentRegistrySpawnResult +internal sealed class SessionsForkRequest { - /// - [JsonIgnore] - public override string Kind => "registry-timeout"; + /// Optional friendly name to assign to the forked session. + [JsonPropertyName("name")] + public string? Name { 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; } + /// Source session ID to fork from. + [JsonPropertyName("sessionId")] + public string SessionId { get; set; } = string.Empty; - /// Per-spawn log-capture outcome; populated from spawnLiveTarget. - [JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)] - [JsonPropertyName("logCapture")] - public AgentRegistryLogCapture? LogCapture { 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; } } -/// Synchronous pre-validation rejected the spawn request. -/// The validation-error variant of . +/// Repository associated with the connected remote session. [Experimental(Diagnostics.Experimental)] -public partial class AgentRegistrySpawnResultValidationError : AgentRegistrySpawnResult +public sealed class ConnectedRemoteSessionMetadataRepository { - /// - [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; } + /// Branch associated with the remote session. + [JsonPropertyName("branch")] + public string Branch { 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; } + /// Repository name. + [JsonPropertyName("name")] + public string Name { 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; } + /// Repository owner or organization login. + [JsonPropertyName("owner")] + public string Owner { get; set; } = string.Empty; } -/// Inputs to spawn a managed-server child via the controller's spawn delegate. +/// Metadata for a connected remote session. [Experimental(Diagnostics.Experimental)] -internal sealed class AgentRegistrySpawnRequest +public sealed class ConnectedRemoteSessionMetadata { - /// 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; } + /// Neutral SDK discriminator for the connected remote session kind. + [JsonPropertyName("kind")] + public ConnectedRemoteSessionMetadataKind Kind { get; set; } - /// Model identifier to apply to the new session. - [JsonPropertyName("model")] - public string? Model { get; set; } + /// Last session update time as an ISO 8601 string. + [JsonPropertyName("modifiedTime")] + public DateTimeOffset ModifiedTime { get; set; } - /// Friendly session name. Must satisfy validateSessionName: non-empty, no leading/trailing whitespace, <=100 chars, no control chars, no double quotes. + /// Optional friendly session name. [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; } + /// Pull request number associated with the session. + [JsonPropertyName("pullRequestNumber")] + public long? PullRequestNumber { get; set; } + + /// Repository associated with the connected remote session. + [JsonPropertyName("repository")] + public ConnectedRemoteSessionMetadataRepository Repository { get => field ??= new(); set; } + + /// Original remote resource identifier. + [JsonPropertyName("resourceId")] + public string? ResourceId { get; set; } + + /// SDK session ID for the connected remote session. + [JsonPropertyName("sessionId")] + public string SessionId { get; set; } = string.Empty; + + /// Remote session staleness deadline as an ISO 8601 string. + [JsonPropertyName("staleAt")] + public DateTimeOffset? StaleAt { 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; } } -/// Identifies the target session. +/// Remote session connection result. [Experimental(Diagnostics.Experimental)] -internal sealed class SessionSuspendRequest +public sealed class RemoteSessionConnectionResult { - /// Target session identifier. + /// Metadata for a connected remote session. + [JsonPropertyName("metadata")] + public ConnectedRemoteSessionMetadata Metadata { get => field ??= new(); set; } + + /// SDK session ID for the connected remote session. [JsonPropertyName("sessionId")] public string SessionId { get; set; } = string.Empty; } -/// Result of sending a user message. +/// Remote session connection parameters. [Experimental(Diagnostics.Experimental)] -public sealed class SendResult +internal sealed class ConnectRemoteSessionParams { - /// Unique identifier assigned to the message. - [JsonPropertyName("messageId")] - public string MessageId { get; set; } = string.Empty; + /// Session ID to connect to. + [JsonPropertyName("sessionId")] + public string SessionId { get; set; } = string.Empty; } -/// Parameters for sending a user message to the session. +/// Local or remote session metadata entry. Narrow on `isRemote` to access source-specific fields. +/// Data type discriminated by isRemote. [Experimental(Diagnostics.Experimental)] -internal sealed class SendRequest +public partial class SessionListEntry { - /// 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; } + /// The boolean discriminator. + [JsonPropertyName("isRemote")] + public bool IsRemote { get; set; } - /// Optional attachments (files, directories, selections, blobs, GitHub references) to include with the message. - [JsonPropertyName("attachments")] - public IList? Attachments { get; set; } + /// Runtime client name that created/last resumed this session. + [JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)] + [JsonPropertyName("clientName")] + public string? ClientName { 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; } + /// Pre-resolved working-directory context for session startup. + [JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)] + [JsonPropertyName("context")] + public SessionContext? Context { get; set; } - /// If provided, this is shown in the timeline instead of `prompt`. - [JsonPropertyName("displayPrompt")] - public string? DisplayPrompt { get; set; } + /// Host-supplied human description of what the session is doing right now ("running tests", "waiting for approval"). Optional in the protocol and absent on hosts that do not publish it, so never rely on it -- it enriches `hostStatus`, it does not replace it. + [JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)] + [JsonPropertyName("hostActivity")] + public string? HostActivity { get; set; } - /// 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; } + /// Live status as the owning host reports it in its session listing, so a row for a session running elsewhere can show that it is running. Absent for hosts that publish no such status (the cloud task managers), which read as idle. + [JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)] + [JsonPropertyName("hostStatus")] + public RemoteSessionHostStatus? HostStatus { get; set; } - /// If true, adds the message to the front of the queue instead of the end. - [JsonPropertyName("prepend")] - public bool? Prepend { get; set; } + /// True for detached maintenance sessions that should be hidden from normal resume lists. + [JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)] + [JsonPropertyName("isDetached")] + public bool? IsDetached { get; set; } - /// The user message text. - [JsonPropertyName("prompt")] - public string Prompt { get; set; } = string.Empty; + /// 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; } - /// 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; } + /// Last-modified time of the session's persisted state, as ISO 8601. + [JsonPropertyName("modifiedTime")] + public required string ModifiedTime { 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; } + /// Optional human-friendly name set via /rename. + [JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)] + [JsonPropertyName("name")] + public string? Name { get; set; } - /// Target session identifier. - [JsonPropertyName("sessionId")] - public string SessionId { get; set; } = string.Empty; + /// Pull request number associated with the session. + [JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)] + [JsonPropertyName("pullRequestNumber")] + public long? PullRequestNumber { get; set; } - /// Optional provenance tag copied to the resulting user.message event. Must match one of three forms: the literal `system`, `command-<command-id>` for messages originating from a command (e.g. slash command, Mission Control command), or `schedule-<numeric-id>` for messages originating from a scheduled job. - [RegularExpression("^(system|command-.*|schedule-\\d+)$")] - [JsonInclude] - [JsonPropertyName("source")] - internal string? Source { get; set; } + /// Backing remote session IDs (most recent first). + [JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)] + [JsonPropertyName("remoteSessionIds")] + public IList? RemoteSessionIds { get; set; } - /// W3C Trace Context traceparent header for distributed tracing of this agent turn. - [JsonPropertyName("traceparent")] - public string? Traceparent { get; set; } + /// GitHub repository the remote session belongs to. + [JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)] + [JsonPropertyName("repository")] + public RemoteSessionMetadataRepository? Repository { get; set; } - /// W3C Trace Context tracestate header for distributed tracing. - [JsonPropertyName("tracestate")] - public string? Tracestate { get; set; } + /// Original remote resource identifier (task ID or PR node ID). + [JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)] + [JsonPropertyName("resourceId")] + public string? ResourceId { 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; } + /// Stable session identifier. + [JsonPropertyName("sessionId")] + public required string SessionId { get; set; } + + /// 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; } + + /// Session creation time as an ISO 8601 timestamp. + [JsonPropertyName("startTime")] + public required string StartTime { get; set; } + + /// Server-side task state returned by GitHub. + [JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)] + [JsonPropertyName("state")] + public string? State { get; set; } + + /// Short summary of the session, when one has been derived. + [JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)] + [JsonPropertyName("summary")] + public string? Summary { get; set; } + + /// Whether the remote task originated from CCA or CLI `--remote`. + [JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)] + [JsonPropertyName("taskType")] + public RemoteSessionMetadataTaskType? TaskType { get; set; } } -/// Result of sending zero or more user messages. +/// Sessions matching the filter, ordered most-recently-modified first. [Experimental(Diagnostics.Experimental)] -public sealed class SendMessagesResult +public sealed class SessionList { - /// 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; } + /// Sessions ordered most-recently-modified first. Discriminated by `isRemote`. + [JsonPropertyName("sessions")] + public IList Sessions { get => field ??= []; set; } } -/// A single user message to append to the session as part of a `session.sendMessages` turn. +/// Optional filter applied to the returned sessions. [Experimental(Diagnostics.Experimental)] -public sealed class SendMessageItem +public sealed class SessionListFilter { - /// Optional attachments (files, directories, selections, blobs, GitHub references) to include with this message. - [JsonPropertyName("attachments")] - public IList? Attachments { get; set; } + /// Match sessions whose context.branch equals this value. + [JsonPropertyName("branch")] + public string? Branch { 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; } + /// Match sessions whose context.cwd equals this value. + [JsonPropertyName("cwd")] + public string? Cwd { get; set; } - /// If provided, this is shown in the timeline instead of `prompt`. - [JsonPropertyName("displayPrompt")] - public string? DisplayPrompt { get; set; } + /// Match sessions whose context.gitRoot equals this value. + [JsonPropertyName("gitRoot")] + public string? GitRoot { get; set; } - /// The user message text. - [JsonPropertyName("prompt")] - public string Prompt { get; set; } = string.Empty; + /// Match sessions whose context.repository equals this value. + [JsonPropertyName("repository")] + public string? Repository { 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; } +/// Optional source filter, metadata-load limit, and context filter applied to the returned sessions. +[Experimental(Diagnostics.Experimental)] +internal sealed class SessionsListRequest +{ + /// Optional filter applied to the returned sessions. + [JsonPropertyName("filter")] + public SessionListFilter? Filter { get; set; } - /// Optional provenance tag copied to the resulting user.message event. Must match one of three forms: the literal `system`, `command-<command-id>` for messages originating from a command (e.g. slash command, Mission Control command), or `schedule-<numeric-id>` for messages originating from a scheduled job. - [RegularExpression("^(system|command-.*|schedule-\\d+)$")] - [JsonInclude] + /// When true, include detached maintenance sessions. Defaults to false for user-facing session lists. + [JsonPropertyName("includeDetached")] + public bool? IncludeDetached { 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; } + + /// Which session sources to include. Defaults to `local` for backward compatibility. [JsonPropertyName("source")] - internal string? Source { get; set; } + public SessionSource? Source { get; set; } + + /// 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; } } -/// 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. +/// Persisted local session metadata, including identifiers, timestamps, summary/name, client, context, detached state, and task ID. [Experimental(Diagnostics.Experimental)] -internal sealed class SendMessagesRequest +public sealed class LocalSessionMetadataValue { - /// 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; } + /// Runtime client name that created/last resumed this session. + [JsonPropertyName("clientName")] + public string? ClientName { 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; } + /// Pre-resolved working-directory context for session startup. + [JsonPropertyName("context")] + public SessionContext? Context { 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; } + /// True for detached maintenance sessions that should be hidden from normal resume lists. + [JsonPropertyName("isDetached")] + public bool? IsDetached { get; set; } - /// If true, adds the messages to the front of the queue instead of the end. - [JsonPropertyName("prepend")] - public bool? Prepend { get; set; } + /// Always false for local sessions. + [JsonPropertyName("isRemote")] + public bool IsRemote { 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; } + /// 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; } - /// Target session identifier. + /// 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; - /// 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; } + /// Session creation time as an ISO 8601 timestamp. + [JsonPropertyName("startTime")] + public string StartTime { get; set; } = string.Empty; - /// 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. - [JsonPropertyName("wait")] - public bool? Wait { get; set; } + /// Short summary of the session, when one has been derived. + [JsonPropertyName("summary")] + public string? Summary { get; set; } } -/// Result of aborting the current turn. +/// Persisted local session metadata when the session exists. [Experimental(Diagnostics.Experimental)] -public sealed class AbortResult +internal sealed class SessionsGetMetadataResult { - /// 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; } + /// Local session metadata, omitted when the session does not exist. + [JsonPropertyName("session")] + public LocalSessionMetadataValue? Session { get; set; } } -/// Parameters for aborting the current turn. +/// Session ID whose persisted metadata should be read. [Experimental(Diagnostics.Experimental)] -internal sealed class AbortRequest +internal sealed class SessionsGetMetadataRequest { - /// Finite reason code describing why the current turn was aborted. - [JsonPropertyName("reason")] - public AbortReason? Reason { get; set; } - - /// Target session identifier. + /// Session ID to inspect. [JsonPropertyName("sessionId")] public string SessionId { get; set; } = string.Empty; } -/// Parameters for shutting down the session. +/// Recent local session IDs that contain user-visible history. [Experimental(Diagnostics.Experimental)] -internal sealed class ShutdownRequest +internal sealed class SessionsListNonEmptySessionIdsResult { - /// 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; } + /// Session IDs ordered newest-first. + [JsonPropertyName("sessionIds")] + public IList SessionIds { get => field ??= []; set; } } -/// Identifier of the session event that was emitted for the log message. +/// Limit for non-empty local session IDs. [Experimental(Diagnostics.Experimental)] -public sealed class LogResult +internal sealed class SessionsListNonEmptySessionIdsRequest { - /// The unique identifier of the emitted session event. - [JsonPropertyName("eventId")] - public Guid EventId { get; set; } + /// Maximum number of session IDs to return. + [JsonPropertyName("limit")] + public long? Limit { get; set; } } -/// Message text, optional severity level, persistence flag, optional follow-up URL, and optional tip. +/// ID of the local session bound to the given GitHub task, or omitted when none. [Experimental(Diagnostics.Experimental)] -internal sealed class LogRequest +public sealed class SessionsFindByTaskIDResult { - /// 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; - - /// Target session identifier. + /// Omitted when no local session is bound to that GitHub task. [JsonPropertyName("sessionId")] - public string SessionId { get; set; } = string.Empty; - - /// Optional actionable tip displayed alongside the message. Only honored on `level: "info"`. - [JsonPropertyName("tip")] - public string? Tip { 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; } + public string? SessionId { 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; } +/// GitHub task ID to look up. +[Experimental(Diagnostics.Experimental)] +internal sealed class SessionsFindByTaskIDRequest +{ + /// GitHub task ID to look up. + [JsonPropertyName("taskId")] + public string TaskId { get; set; } = string.Empty; } -/// Authentication status and account metadata for the session. +/// Session ID matching the prefix, omitted when no unique match exists. [Experimental(Diagnostics.Experimental)] -public sealed class SessionAuthStatus +public sealed class SessionsFindByPrefixResult { - /// Authentication type. - [JsonPropertyName("authType")] - public AuthInfoType? AuthType { get; set; } + /// Omitted when no unique session matches the prefix (no match or ambiguous). + [JsonPropertyName("sessionId")] + public string? SessionId { get; set; } +} - /// Copilot plan tier (e.g., individual_pro, business). - [JsonPropertyName("copilotPlan")] - public string? CopilotPlan { get; set; } - - /// Authentication host URL. - [Url] - [StringSyntax(StringSyntaxAttribute.Uri)] - [JsonPropertyName("host")] - public string? Host { get; set; } +/// UUID prefix to resolve to a unique session ID. +[Experimental(Diagnostics.Experimental)] +internal sealed class 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. + [JsonPropertyName("prefix")] + public string Prefix { get; set; } = string.Empty; +} - /// Whether the session has resolved authentication. - [JsonPropertyName("isAuthenticated")] - public bool IsAuthenticated { get; set; } +/// Most-relevant session ID for the supplied context, or omitted when no sessions exist. +[Experimental(Diagnostics.Experimental)] +public sealed class SessionsGetLastForContextResult +{ + /// Most-relevant session ID for the supplied context, or omitted when no sessions exist. + [JsonPropertyName("sessionId")] + public string? SessionId { get; set; } +} - /// Authenticated login/username, if available. - [JsonPropertyName("login")] - public string? Login { get; set; } +/// Optional working-directory context used to score session relevance. +[Experimental(Diagnostics.Experimental)] +internal sealed class SessionsGetLastForContextRequest +{ + /// Optional working-directory context used to score session relevance. When omitted the most-recently-modified session wins. + [JsonPropertyName("context")] + public SessionContext? Context { get; set; } +} - /// Human-readable authentication status description. - [JsonPropertyName("statusMessage")] - public string? StatusMessage { get; set; } +/// Absolute path to the session's events.jsonl file on disk. +[Experimental(Diagnostics.Experimental)] +internal sealed class SessionsGetEventFilePathResult +{ + /// Absolute path to the session's events.jsonl file. + [JsonPropertyName("filePath")] + public string FilePath { get; set; } = string.Empty; } -/// Identifies the target session. +/// Session ID whose event-log file path to compute. [Experimental(Diagnostics.Experimental)] -internal sealed class SessionGitHubAuthGetStatusRequest +internal sealed class SessionsGetEventFilePathRequest { - /// Target session identifier. + /// Session ID whose event-log file path to compute. [JsonPropertyName("sessionId")] public string SessionId { get; set; } = string.Empty; } -/// Indicates whether the credential update succeeded. +/// Map of sessionId -> on-disk size in bytes for each session's workspace directory. [Experimental(Diagnostics.Experimental)] -public sealed class SessionSetCredentialsResult +public sealed class SessionSizes { - /// 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; } + /// 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 the operation succeeded. - [JsonPropertyName("success")] - public bool Success { get; set; } +/// Session IDs from the input set that are currently in use by another process. +[Experimental(Diagnostics.Experimental)] +public sealed class SessionsCheckInUseResult +{ + /// 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; } } -/// New auth credentials to install on the session. Omit to leave credentials unchanged. +/// Session IDs to test for live in-use locks. [Experimental(Diagnostics.Experimental)] -internal sealed class SessionSetCredentialsParams +internal sealed class SessionsCheckInUseRequest { - /// 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; } + /// Session IDs to test for live in-use locks. + [JsonPropertyName("sessionIds")] + public IList SessionIds { get => field ??= []; set; } +} - /// Target session identifier. +/// The session's persisted remote-steerable flag, or omitted when no value has been persisted. +[Experimental(Diagnostics.Experimental)] +internal sealed class SessionsGetPersistedRemoteSteerableResult +{ + /// The session's persisted remote-steerable flag if recorded; omitted when no value has been persisted. + [JsonPropertyName("remoteSteerable")] + public bool? RemoteSteerable { get; set; } +} + +/// Session ID to look up the persisted remote-steerable flag for. +[Experimental(Diagnostics.Experimental)] +internal sealed class SessionsGetPersistedRemoteSteerableRequest +{ + /// Session ID to look up the persisted remote-steerable flag for. [JsonPropertyName("sessionId")] public string SessionId { get; set; } = string.Empty; } -/// A file included in the redacted debug bundle. +/// 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 DebugCollectLogsCollectedEntry +public sealed class SessionsCloseResult { - /// 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; } +/// Session ID to close. +[Experimental(Diagnostics.Experimental)] +internal sealed class SessionsCloseRequest +{ + /// Session ID to close. + [JsonPropertyName("sessionId")] + public string SessionId { get; set; } = string.Empty; +} - /// Source category for this entry. - [JsonPropertyName("source")] - public DebugCollectLogsSource Source { get; set; } +/// Map of sessionId -> bytes freed by removing the session's workspace directory. +[Experimental(Diagnostics.Experimental)] +public sealed class 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). + [JsonPropertyName("freedBytes")] + public IDictionary FreedBytes { get => field ??= new Dictionary(); set; } } -/// An optional debug bundle entry that could not be included. +/// Session IDs to close, deactivate, and delete from disk. [Experimental(Diagnostics.Experimental)] -public sealed class DebugCollectLogsSkippedEntry +internal sealed class SessionsBulkDeleteRequest { - /// Relative path requested for this bundle entry. - [JsonPropertyName("bundlePath")] - public string BundlePath { get; set; } = string.Empty; + /// Session IDs to close, deactivate, and delete from disk. + [JsonPropertyName("sessionIds")] + public IList SessionIds { get => field ??= []; set; } +} - /// Server-local source path that could not be read. - [JsonPropertyName("path")] - public string? Path { get; set; } +/// Session ID to delete from disk. +[Experimental(Diagnostics.Experimental)] +internal sealed class SessionsDeleteRequest +{ + /// Session ID to delete. + [JsonPropertyName("sessionId")] + public string SessionId { get; set; } = string.Empty; - /// Reason the entry was skipped. - [JsonPropertyName("reason")] - public string Reason { get; set; } = string.Empty; + /// Internal resolved session directory path to delete. + [JsonPropertyName("sessionPath")] + public string? SessionPath { get; set; } } -/// Result of collecting a redacted debug bundle. +/// Outcome of the prune operation: deleted IDs, dry-run candidates, skipped IDs, total bytes freed, and the dry-run flag. [Experimental(Diagnostics.Experimental)] -public sealed class DebugCollectLogsResult +public sealed class SessionPruneResult { - /// Files included in the redacted bundle. - [JsonPropertyName("entries")] - public IList Entries { get => field ??= []; set; } + /// Session IDs that would be deleted in dry-run mode (always empty otherwise). + [JsonPropertyName("candidates")] + public IList Candidates { get => field ??= []; set; } - /// Destination kind that was written. - [JsonPropertyName("kind")] - public DebugCollectLogsResultKind Kind { get; set; } + /// Session IDs that were deleted (always empty in dry-run mode). + [JsonPropertyName("deleted")] + public IList Deleted { get => field ??= []; 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; + /// True when no deletions were actually performed. + [JsonPropertyName("dryRun")] + public bool DryRun { get; set; } - /// Optional files or directories that could not be included. - [JsonPropertyName("skippedEntries")] - public IList? SkippedEntries { 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; } } -/// A caller-provided server-local file or directory to include in the debug bundle. +/// Age threshold and optional flags controlling which old sessions are pruned (or simulated when dryRun is true). [Experimental(Diagnostics.Experimental)] -public sealed class DebugCollectLogsEntry +internal sealed class SessionsPruneOldRequest { - /// 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; } + /// When true, only report what would be deleted without performing any deletion. + [JsonPropertyName("dryRun")] + public bool? DryRun { get; set; } - /// Server-local source path to read. - [JsonPropertyName("path")] - public string Path { get; set; } = string.Empty; + /// Session IDs that should never be considered for pruning. + [JsonPropertyName("excludeSessionIds")] + public IList? ExcludeSessionIds { get; set; } - /// How text content from this entry should be redacted. Defaults to plain-text. - [JsonPropertyName("redaction")] - public DebugCollectLogsRedaction? Redaction { get; set; } + /// When true, named sessions (set via /rename) are also eligible for pruning. + [JsonPropertyName("includeNamed")] + public bool? IncludeNamed { 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; } + /// Delete sessions whose modifiedTime is at least this many days old. + [JsonPropertyName("olderThanDays")] + public long OlderThanDays { get; set; } } -/// Destination for the redacted debug bundle. -/// Polymorphic base type discriminated by kind. +/// Flush a session's pending events to disk. No-op when no writer exists for the session (e.g., already closed). [Experimental(Diagnostics.Experimental)] -[JsonPolymorphic( - TypeDiscriminatorPropertyName = "kind", - UnknownDerivedTypeHandling = JsonUnknownDerivedTypeHandling.FallBackToBaseType)] -[JsonDerivedType(typeof(DebugCollectLogsDestinationArchive), "archive")] -[JsonDerivedType(typeof(DebugCollectLogsDestinationDirectory), "directory")] -public partial class DebugCollectLogsDestination +public sealed class SessionsSaveResult { - /// The type discriminator. - [JsonPropertyName("kind")] - public virtual string Kind { get; set; } = string.Empty; } - -/// The archive variant of . +/// Session ID whose pending events should be flushed to disk. [Experimental(Diagnostics.Experimental)] -public partial class DebugCollectLogsDestinationArchive : DebugCollectLogsDestination +internal sealed class SessionsSaveRequest { - /// - [JsonIgnore] - public override string Kind => "archive"; - - /// 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; } - - /// Absolute or server-relative path for the .tgz archive to create. - [JsonPropertyName("outputPath")] - public required string OutputPath { get; set; } + /// Session ID whose pending events should be flushed to disk. + [JsonPropertyName("sessionId")] + public string SessionId { get; set; } = string.Empty; } -/// The directory variant of . +/// 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)] -public partial class DebugCollectLogsDestinationDirectory : DebugCollectLogsDestination +public sealed class SessionsReleaseLockResult { - /// - [JsonIgnore] - public override string Kind => "directory"; +} - /// Directory where redacted files should be staged. The directory is created if needed. - [JsonPropertyName("outputDirectory")] - public required string OutputDirectory { get; set; } +/// 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; } -/// Built-in session diagnostics to include in the bundle. Omitted fields default to true. +/// 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 DebugCollectLogsInclude +public sealed class SessionEnrichMetadataResult { - /// 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; } - - /// 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; } + /// Enriched records, with summary and context backfilled. Sessions confirmed empty and unnamed may be omitted. + [JsonPropertyName("sessions")] + public IList Sessions { get => field ??= []; set; } } -/// Options for collecting a redacted session debug bundle. +/// Session metadata records to enrich with summary and context information. [Experimental(Diagnostics.Experimental)] -internal sealed class DebugCollectLogsRequest +internal sealed class SessionsEnrichMetadataRequest { - /// 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; } - - /// 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; } - - /// 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; + /// Session metadata records to enrich. Records that already have summary and context are returned unchanged. + [JsonPropertyName("sessions")] + public IList Sessions { get => field ??= []; set; } } -/// Canvas action that the agent or host can invoke. To discover the input schema for a particular action, call the list_canvas_capabilities tool. +/// 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 CanvasAction +public sealed class SessionsReloadPluginHooksResult { - /// 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; } -/// Canvas available in the current session. +/// Active session ID and an optional flag for deferring repo-level hooks until folder trust. [Experimental(Diagnostics.Experimental)] -public sealed class DiscoveredCanvas +internal sealed class SessionsReloadPluginHooksRequest { - /// 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; - - /// 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; - - /// 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; } + /// When true, skip repo-level hooks. Use before folder trust is confirmed; loadDeferredRepoHooks loads them post-trust. + [JsonPropertyName("deferRepoHooks")] + public bool? DeferRepoHooks { get; set; } - /// JSON Schema for canvas open input. - [JsonPropertyName("inputSchema")] - public JsonElement? InputSchema { get; set; } + /// Active session ID to reload hooks for. + [JsonPropertyName("sessionId")] + public string SessionId { get; set; } = string.Empty; } -/// Declared canvases available in this session. +/// Queued repo-level startup prompts and the total hook command count after loading. [Experimental(Diagnostics.Experimental)] -public sealed class CanvasList +public sealed class SessionLoadDeferredRepoHooksResult { - /// Declared canvases available in this session. - [JsonPropertyName("canvases")] - public IList Canvases { get => field ??= []; set; } + /// 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; } + + /// 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; } } -/// Identifies the target session. +/// Active session ID whose deferred repo-level hooks should be loaded. [Experimental(Diagnostics.Experimental)] -internal sealed class SessionCanvasListRequest +internal sealed class SessionsLoadDeferredRepoHooksRequest { - /// Target session identifier. + /// Active session ID whose deferred repo-level hooks should be loaded. [JsonPropertyName("sessionId")] public string SessionId { get; set; } = string.Empty; } -/// Open canvas instance snapshot. +/// 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 OpenCanvasInstance +public sealed class SessionsSetAdditionalPluginsResult { - /// 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; +/// 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; } - /// Owning extension display name, when available. - [JsonPropertyName("extensionName")] - public string? ExtensionName { get; set; } + /// Whether the plugin is currently enabled. + [JsonPropertyName("enabled")] + public bool Enabled { get; set; } - /// Host-local PNG path for the canvas icon, when supplied. - [JsonPropertyName("icon")] - public string? Icon { get; set; } + /// Installation timestamp. + [JsonPropertyName("installed_at")] + public string InstalledAt { get; set; } = string.Empty; - /// Input supplied when the instance was opened. - [JsonPropertyName("input")] - public JsonElement? Input { get; set; } + /// Absolute path of the marketplace directory a live plugin was resolved from. Present only on live, never-persisted records β€” those synthesized at session start for a directory/local marketplace, whose cache_path points at the real plugin directory on disk rather than a copy under the installed-plugins cache. Its presence is what marks a record as live, and no record carrying it is ever written to the persisted installedPlugins key. + [JsonPropertyName("installed_from")] + public string? InstalledFrom { get; set; } - /// Stable caller-supplied canvas instance identifier. - [JsonPropertyName("instanceId")] - public string InstanceId { get; set; } = string.Empty; + /// Marketplace the plugin came from (empty string for direct repo installs). + [JsonPropertyName("marketplace")] + public string Marketplace { get; set; } = string.Empty; - /// Provider-supplied status text. - [JsonPropertyName("status")] - public string? Status { get; set; } + /// Plugin name. + [JsonPropertyName("name")] + public string Name { get; set; } = string.Empty; - /// Rendered title. - [JsonPropertyName("title")] - public string? Title { get; set; } + /// Source for direct repo installs (when marketplace is empty). + [JsonPropertyName("source")] + public JsonElement? Source { get; set; } - /// URL for web-rendered canvases. - [JsonPropertyName("url")] - public string? Url { 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; } + + /// Version installed (if available). + [JsonPropertyName("version")] + public string? Version { get; set; } } -/// Live open-canvas snapshot. +/// Manager-wide additional plugins to register; replaces any previously-configured set. [Experimental(Diagnostics.Experimental)] -public sealed class CanvasListOpenResult +internal sealed class SessionsSetAdditionalPluginsRequest { - /// Currently open canvas instances. - [JsonPropertyName("openCanvases")] - public IList OpenCanvases { get => field ??= []; 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; } } -/// Identifies the target session. +/// Dynamic-context board entry count, when available. [Experimental(Diagnostics.Experimental)] -internal sealed class SessionCanvasListOpenRequest +internal sealed class SessionsGetBoardEntryCountResult { - /// Target session identifier. - [JsonPropertyName("sessionId")] - public string SessionId { get; set; } = string.Empty; + /// Board entry count, when available. + [JsonPropertyName("count")] + public long? Count { get; set; } } -/// Canvas open parameters. +/// Session ID whose board entry count should be returned. [Experimental(Diagnostics.Experimental)] -internal sealed class CanvasOpenRequest +internal sealed class SessionsGetBoardEntryCountRequest { - /// 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. + /// Session ID whose board entry count should be returned. [JsonPropertyName("sessionId")] public string SessionId { get; set; } = string.Empty; } -/// Canvas close parameters. +/// State of the runtime-managed remote-control singleton. +/// Polymorphic base type discriminated by state. [Experimental(Diagnostics.Experimental)] -internal sealed class CanvasCloseRequest +[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 { - /// 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; + /// The type discriminator. + [JsonPropertyName("state")] + public virtual string State { get; set; } = string.Empty; } -/// Canvas action invocation result. -[Experimental(Diagnostics.Experimental)] -public sealed class CanvasActionInvokeResult -{ - /// Provider-supplied action result. - [JsonPropertyName("result")] - public JsonElement? Result { get; set; } -} -/// Canvas action invocation parameters. +/// Remote control is not connected. +/// The off variant of . [Experimental(Diagnostics.Experimental)] -internal sealed class CanvasActionInvokeRequest +public partial class RemoteControlStatusOff : RemoteControlStatus { - /// 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; + /// + [JsonIgnore] + public override string State => "off"; } -/// Machine-readable factory run failure. -/// Polymorphic base type discriminated by type. +/// Remote control is in the middle of initial setup. +/// The connecting variant of . [Experimental(Diagnostics.Experimental)] -[JsonPolymorphic( - TypeDiscriminatorPropertyName = "type", - UnknownDerivedTypeHandling = JsonUnknownDerivedTypeHandling.FallBackToBaseType)] -[JsonDerivedType(typeof(FactoryRunFailureFactoryLimitReached), "factory_limit_reached")] -[JsonDerivedType(typeof(FactoryRunFailureFactoryResumeDeclined), "factory_resume_declined")] -public partial class FactoryRunFailure +public partial class RemoteControlStatusConnecting : RemoteControlStatus { - /// The type discriminator. - [JsonPropertyName("type")] - public virtual string Type { 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; } +} -/// The factory_limit_reached variant of . +/// Remote control is connected to a local session. +/// The active variant of . [Experimental(Diagnostics.Experimental)] -public partial class FactoryRunFailureFactoryLimitReached : FactoryRunFailure +public partial class RemoteControlStatusActive : RemoteControlStatus { /// [JsonIgnore] - public override string Type => "factory_limit_reached"; + public override string State => "active"; - /// Resource ceiling that stopped the run. - [JsonPropertyName("kind")] - public required FactoryRunFailureKind Kind { get; set; } + /// Session id remote control is pointed at. + [JsonPropertyName("attachedSessionId")] + public required string AttachedSessionId { get; set; } - /// Factory run identifier. - [JsonPropertyName("runId")] - public required string RunId { 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; } - /// Approved effective ceiling that was reached. - [JsonPropertyName("value")] - public required double Value { 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; } } -/// The factory_resume_declined variant of . +/// The last setup attempt failed. The singleton is otherwise off. +/// The error variant of . [Experimental(Diagnostics.Experimental)] -public partial class FactoryRunFailureFactoryResumeDeclined : FactoryRunFailure +public partial class RemoteControlStatusError : RemoteControlStatus { /// [JsonIgnore] - public override string Type => "factory_resume_declined"; + public override string State => "error"; - /// Human-readable reason the resume did not proceed. - [JsonPropertyName("reason")] - public required string Reason { get; set; } + /// Session id the failing setup attempt targeted, when known. + [JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)] + [JsonPropertyName("attachedSessionId")] + public string? AttachedSessionId { get; set; } - /// Factory run identifier whose changed limits were declined. - [JsonPropertyName("runId")] - public required string RunId { get; set; } + /// Human-readable error message from the last setup attempt. + [JsonPropertyName("error")] + public required string Error { get; set; } } -/// Complete current or terminal factory run envelope. +/// Wrapper for the singleton's current status. [Experimental(Diagnostics.Experimental)] -public sealed class FactoryRunResult +public sealed class RemoteControlStatusResult { - /// Error message for an errored run. - [JsonPropertyName("error")] - public string? Error { get; set; } - - /// Machine-readable failure details for an errored run. - [JsonPropertyName("failure")] - public FactoryRunFailure? Failure { 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; } - - /// Current or terminal factory run status. + /// State of the runtime-managed remote-control singleton. [JsonPropertyName("status")] - public FactoryRunStatus Status { get; set; } + public RemoteControlStatus Status { get => field ??= new(); set; } } -/// Wire-only per-invocation factory resource ceiling overrides. +/// Reattach to an existing MC session without creating a new one. [Experimental(Diagnostics.Experimental)] -public sealed class FactoryRunLimits +public sealed class RemoteControlConfigExistingMcSession { - /// 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; } + /// Existing MC session ID to reattach to. + [JsonPropertyName("mcSessionId")] + public string McSessionId { get; set; } = string.Empty; - /// Factory active-run timeout in milliseconds. - [JsonPropertyName("timeout")] - public double? Timeout { get; set; } + /// Existing MC task ID for the reattached session. + [JsonPropertyName("mcTaskId")] + public string McTaskId { get; set; } = string.Empty; } -/// Options controlling factory invocation. +/// Configuration for the runtime-managed remote-control singleton. [Experimental(Diagnostics.Experimental)] -public sealed class RunOptions +public sealed class RemoteControlConfig { - /// Per-invocation resource ceiling overrides. - [JsonPropertyName("limits")] - public FactoryRunLimits? Limits { get; set; } + /// Reattach to an existing MC session without creating a new one. + [JsonPropertyName("existingMcSession")] + public RemoteControlConfigExistingMcSession? ExistingMcSession { get; set; } - /// Run identifier whose journal and progress should seed this resumed run. - [JsonPropertyName("resumeFromRunId")] - public string? ResumeFromRunId { 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; } -/// Parameters for invoking a registered factory. -[Experimental(Diagnostics.Experimental)] -internal sealed class FactoryRunRequest -{ - /// Factory input value. - [JsonPropertyName("args")] - public JsonElement Args { get; set; } + /// Whether remote export should be enabled. + [JsonPropertyName("remote")] + public bool Remote { get; set; } - /// Registered factory name. - [JsonPropertyName("name")] - public string Name { get; set; } = string.Empty; + /// When true, suppresses timeline messages on successful setup. + [JsonPropertyName("silent")] + public bool Silent { get; set; } - /// Factory invocation options. - [JsonPropertyName("options")] - public RunOptions? Options { get; set; } + /// Whether the MC session may steer the local session (write mode). + [JsonPropertyName("steerable")] + public bool Steerable { get; set; } - /// Target session identifier. - [JsonPropertyName("sessionId")] - public string SessionId { get; set; } = string.Empty; + /// Existing Mission Control task ID to attach the exported session to. + [JsonPropertyName("taskId")] + public string? TaskId { get; set; } } -/// Parameters for retrieving a factory run. +/// Parameters for attaching the remote-control singleton to a session. [Experimental(Diagnostics.Experimental)] -internal sealed class FactoryGetRunRequest +internal sealed class SessionsStartRemoteControlRequest { - /// Factory run identifier. - [JsonPropertyName("runId")] - public string RunId { get; set; } = string.Empty; + /// Configuration for the runtime-managed remote-control singleton. + [JsonPropertyName("config")] + public RemoteControlConfig Config { get => field ??= new(); set; } - /// Target session identifier. + /// Local session id to attach remote control to. [JsonPropertyName("sessionId")] public string SessionId { get; set; } = string.Empty; } -/// Parameters for cancelling a factory run. +/// Outcome of a transferRemoteControl call. [Experimental(Diagnostics.Experimental)] -internal sealed class FactoryCancelRequest +public sealed class RemoteControlTransferResult { - /// Factory run identifier. - [JsonPropertyName("runId")] - public string RunId { 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 rebinding actually happened. + [JsonPropertyName("transferred")] + public bool Transferred { get; set; } } -/// Acknowledgement that a factory request was accepted. +/// Parameters for atomically rebinding the remote-control singleton. [Experimental(Diagnostics.Experimental)] -public sealed class FactoryAckResult +internal sealed class 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). + [JsonPropertyName("expectedFromSessionId")] + public string? ExpectedFromSessionId { get; set; } + + /// Local session id to point remote control at. + [JsonPropertyName("toSessionId")] + public string ToSessionId { get; set; } = string.Empty; } -/// One ordered factory progress line. +/// Patch for the singleton's steering state. [Experimental(Diagnostics.Experimental)] -public sealed class FactoryLogLine +internal sealed class SessionsSetRemoteControlSteeringRequest { - /// 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; + /// 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; } } -/// Parameters for recording factory progress. +/// Outcome of a stopRemoteControl call. [Experimental(Diagnostics.Experimental)] -internal sealed class FactoryLogRequest +public sealed class RemoteControlStopResult { - /// 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; -} + /// State of the runtime-managed remote-control singleton. + [JsonPropertyName("status")] + public RemoteControlStatus Status { get => field ??= new(); set; } -/// Result of one factory-scoped subagent call. -[Experimental(Diagnostics.Experimental)] -public sealed class FactoryAgentResult -{ - /// Agent result, omitted when the agent produced no result. - [JsonPropertyName("result")] - public JsonElement? Result { get; set; } + /// Whether the singleton was actually torn down by this call. + [JsonPropertyName("stopped")] + public bool Stopped { get; set; } } -/// Options for one factory-scoped subagent call. +/// RPC data type for SessionsStopRemoteControl operations. [Experimental(Diagnostics.Experimental)] -public sealed class FactoryAgentOptions +internal sealed class SessionsStopRemoteControlRequest { - /// 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; } + /// 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; } - /// Optional JSON Schema for structured agent output. - [JsonPropertyName("schema")] - public JsonElement? Schema { get; set; } + /// 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; } } -/// Parameters for one factory-scoped subagent call. +/// Handle for releasing the extension tool registration. [Experimental(Diagnostics.Experimental)] -internal sealed class FactoryAgentRequest +internal sealed class RegisterExtensionToolsResult { - /// Factory run identifier that owns the subagent. - [JsonPropertyName("factoryRunId")] - public string FactoryRunId { 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; } -/// Result of reading a factory journal entry. +/// Optional registration options. [Experimental(Diagnostics.Experimental)] -public sealed class FactoryJournalGetResult +public sealed class SessionsRegisterExtensionToolsOnSessionOptions { - /// Whether the journal contained the requested key. - [JsonPropertyName("hit")] - public bool Hit { get; set; } - - /// Cached JSON result. The hit field distinguishes a cached JSON null from a miss. - [JsonPropertyName("resultJson")] - public JsonElement? ResultJson { get; set; } } -/// Parameters for reading a factory journal entry. +/// Params to attach an extension loader's tools to a session. [Experimental(Diagnostics.Experimental)] -internal sealed class FactoryJournalGetRequest +internal sealed class RegisterExtensionToolsParams { - /// Namespaced journal key. - [JsonPropertyName("key")] - public string Key { get; set; } = string.Empty; - - /// Factory run identifier. - [JsonPropertyName("runId")] - public string RunId { get; set; } = string.Empty; + /// Optional registration options. + [JsonPropertyName("options")] + public SessionsRegisterExtensionToolsOnSessionOptions? Options { get; set; } - /// Target session identifier. + /// Session to register extension tools on. [JsonPropertyName("sessionId")] public string SessionId { get; set; } = string.Empty; } -/// Parameters for storing a factory journal entry. +/// Params to attach or detach an in-process ExtensionController delegate. [Experimental(Diagnostics.Experimental)] -internal sealed class FactoryJournalPutRequest +internal sealed class ConfigureSessionExtensionsParams { - /// Namespaced journal key. - [JsonPropertyName("key")] - public string Key { get; set; } = string.Empty; - - /// JSON result to memoize. - [JsonPropertyName("resultJson")] - public JsonElement ResultJson { get; set; } - - /// Factory run identifier. - [JsonPropertyName("runId")] - public string RunId { get; set; } = string.Empty; - - /// Target session identifier. + /// Session to attach the extension controller delegate to. [JsonPropertyName("sessionId")] public string SessionId { get; set; } = string.Empty; } -/// 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. +/// Outcome of an agentRegistry.spawn call. +/// Polymorphic base type discriminated by kind. [Experimental(Diagnostics.Experimental)] -public sealed class CurrentModel +[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 { - /// 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; } + /// The type discriminator. + [JsonPropertyName("kind")] + public virtual string Kind { get; set; } = string.Empty; } -/// Identifies the target session. -[Experimental(Diagnostics.Experimental)] -internal sealed class SessionModelGetCurrentRequest -{ - /// Target session identifier. - [JsonPropertyName("sessionId")] - public string SessionId { get; set; } = string.Empty; -} -/// The model identifier active on the session after the switch. +/// 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 ModelSwitchToResult +public sealed class AgentRegistryLiveTargetEntry { - /// Currently active model identifier after the switch. - [JsonPropertyName("modelId")] - public string? ModelId { get; set; } -} + /// Kind of attention required when status === "attention". Meaningful only when status === "attention". + [JsonPropertyName("attentionKind")] + public AgentRegistryLiveTargetEntryAttentionKind? AttentionKind { get; set; } -/// Vision-specific limits. -[Experimental(Diagnostics.Experimental)] -public sealed class ModelCapabilitiesOverrideLimitsVision -{ - /// Maximum image size in bytes. - [JsonPropertyName("max_prompt_image_size")] - public long? MaxPromptImageSize { get; set; } + /// Git branch of the session (when known). + [JsonPropertyName("branch")] + public string? Branch { get; set; } - /// Maximum number of images per prompt. - [JsonPropertyName("max_prompt_images")] - public long? MaxPromptImages { get; set; } + /// Copilot CLI version that wrote the entry. + [JsonPropertyName("copilotVersion")] + public string CopilotVersion { get; set; } = string.Empty; - /// MIME types the model accepts. - [JsonPropertyName("supported_media_types")] - public IList? SupportedMediaTypes { get; set; } -} + /// Working directory of the session (when known). + [JsonPropertyName("cwd")] + public string? Cwd { get; set; } -/// Token limits for prompts, outputs, and context window. -[Experimental(Diagnostics.Experimental)] -public sealed class ModelCapabilitiesOverrideLimits -{ - /// Maximum total context window size in tokens. - [JsonPropertyName("max_context_window_tokens")] - public long? MaxContextWindowTokens { get; set; } + /// Bind host for the entry's JSON-RPC server. + [JsonPropertyName("host")] + public string Host { get; set; } = string.Empty; - /// Maximum number of output/completion tokens. - [JsonPropertyName("max_output_tokens")] - public long? MaxOutputTokens { get; set; } + /// Process kind tag for the registry entry. + [JsonPropertyName("kind")] + public AgentRegistryLiveTargetEntryKind Kind { get; set; } - /// Maximum number of prompt/input tokens. - [JsonPropertyName("max_prompt_tokens")] - public long? MaxPromptTokens { get; set; } + /// Wall-clock milliseconds since the watcher last observed this entry (heartbeat freshness). + [JsonPropertyName("lastSeenMs")] + public long LastSeenMs { get; set; } - /// Vision-specific limits. - [JsonPropertyName("vision")] - public ModelCapabilitiesOverrideLimitsVision? Vision { 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; } -/// Feature flags indicating what the model supports. -[Experimental(Diagnostics.Experimental)] -public sealed class 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). - [JsonPropertyName("adaptive_thinking")] - public AdaptiveThinkingSupport? AdaptiveThinking { get; set; } + /// Model identifier currently selected for the session. + [JsonPropertyName("model")] + public string? Model { get; set; } - /// Whether this model supports reasoning effort configuration. - [JsonPropertyName("reasoningEffort")] - public bool? ReasoningEffort { get; set; } + /// Operating-system pid of the process owning this entry. + [JsonPropertyName("pid")] + public long Pid { get; set; } - /// Whether this model supports vision/image input. - [JsonPropertyName("vision")] - public bool? Vision { get; set; } -} + /// TCP port the entry's JSON-RPC server is listening on. + [JsonPropertyName("port")] + public long Port { get; set; } -/// Optional capability overrides (vision, tool_calls, reasoning, etc.). -[Experimental(Diagnostics.Experimental)] -public sealed class ModelCapabilitiesOverride -{ - /// Token limits for prompts, outputs, and context window. - [JsonPropertyName("limits")] - public ModelCapabilitiesOverrideLimits? Limits { get; set; } + /// Registry entry schema version (1 = ui-server, 2 = managed-server). + [JsonPropertyName("schemaVersion")] + public long SchemaVersion { get; set; } - /// Feature flags indicating what the model supports. - [JsonPropertyName("supports")] - public ModelCapabilitiesOverrideSupports? Supports { get; set; } -} - -/// Target model identifier and optional reasoning effort, summary, capability overrides, and context tier. -[Experimental(Diagnostics.Experimental)] -internal sealed class 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. - [JsonPropertyName("contextTier")] - public ContextTier? ContextTier { get; set; } - - /// Override individual model capabilities resolved by the runtime. - [JsonPropertyName("modelCapabilities")] - public ModelCapabilitiesOverride? ModelCapabilities { get; set; } + /// Session ID of the foreground session for this entry. + [JsonPropertyName("sessionId")] + public string? SessionId { get; set; } - /// 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; + /// Friendly session name (when set). + [JsonPropertyName("sessionName")] + public string? SessionName { get; set; } - /// Reasoning effort level to use for the model. "none" disables reasoning. - [JsonPropertyName("reasoningEffort")] - public string? ReasoningEffort { get; set; } + /// ISO 8601 timestamp captured at registration. + [JsonPropertyName("startedAt")] + public string StartedAt { get; set; } = string.Empty; - /// Reasoning summary mode to request for supported model clients. - [JsonPropertyName("reasoningSummary")] - public ReasoningSummary? ReasoningSummary { get; set; } + /// Coarse lifecycle status of the foreground session. + [JsonPropertyName("status")] + public AgentRegistryLiveTargetEntryStatus? Status { get; set; } - /// 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; } - /// Output verbosity level to request for supported models. - [JsonPropertyName("verbosity")] - public Verbosity? Verbosity { get; set; } + /// Connection token (null when the target is unauthenticated). + [JsonInclude] + [JsonPropertyName("token")] + internal string? Token { get; set; } } -/// 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. +/// Per-spawn log-capture outcome; populated from spawnLiveTarget. [Experimental(Diagnostics.Experimental)] -public sealed class ModelSetReasoningEffortResult +public sealed class AgentRegistryLogCapture { - /// Reasoning effort level recorded on the session after the update. - [JsonPropertyName("reasoningEffort")] - public string ReasoningEffort { get; set; } = string.Empty; -} + /// Whether per-spawn log capture is on (false when env-disabled or open failed). + [JsonPropertyName("enabled")] + public bool Enabled { 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; + /// 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; } - /// Target session identifier. - [JsonPropertyName("sessionId")] - public string SessionId { get; set; } = string.Empty; + /// 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; } } -/// Cost-category metadata for a CAPI model. +/// Managed-server child was spawned and registered successfully. +/// The spawned variant of . [Experimental(Diagnostics.Experimental)] -public sealed class SessionModelPriceCategory +public partial class AgentRegistrySpawnResultSpawned : AgentRegistrySpawnResult { - /// Gets or sets the id value. - [JsonPropertyName("id")] - public string Id { get; set; } = string.Empty; + /// + [JsonIgnore] + public override string Kind => "spawned"; - /// Gets or sets the priceCategory value. - [JsonPropertyName("priceCategory")] - public ModelPickerPriceCategory PriceCategory { get; set; } -} + /// 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; } -/// 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; } + /// 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; } - /// 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; } + /// 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-quota snapshots returned alongside the model list, keyed by quota type. - [JsonPropertyName("quotaSnapshots")] - public IDictionary? QuotaSnapshots { get; set; } + /// Per-spawn log-capture outcome; populated from spawnLiveTarget. + [JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)] + [JsonPropertyName("logCapture")] + public AgentRegistryLogCapture? LogCapture { get; set; } } -/// Optional listing options. +/// `child_process.spawn` itself failed before the child entered the registry. +/// The spawn-error variant of . [Experimental(Diagnostics.Experimental)] -public sealed class ModelListRequest +public partial class AgentRegistrySpawnResultSpawnError : AgentRegistrySpawnResult { - /// If true, bypasses the per-session model list cache and re-fetches from CAPI. - [JsonPropertyName("skipCache")] - public bool? SkipCache { get; set; } -} + /// + [JsonIgnore] + public override string Kind => "spawn-error"; -/// Optional listing options. -[Experimental(Diagnostics.Experimental)] -internal sealed class ModelListRequestWithSession -{ - /// Target session identifier. - [JsonPropertyName("sessionId")] - public string SessionId { get; set; } = string.Empty; + /// Underlying errno code (e.g. ENOENT, EACCES) when available. + [JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)] + [JsonPropertyName("code")] + public string? Code { get; set; } - /// If true, bypasses the per-session model list cache and re-fetches from CAPI. - [JsonPropertyName("skipCache")] - public bool? SkipCache { get; set; } + /// Human-readable error message. + [JsonPropertyName("message")] + public required string Message { get; set; } } -/// Identifies the target session. +/// 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 SessionModeGetRequest +public partial class AgentRegistrySpawnResultRegistryTimeout : AgentRegistrySpawnResult { - /// Target session identifier. - [JsonPropertyName("sessionId")] - public string SessionId { get; set; } = string.Empty; + /// + [JsonIgnore] + public override string Kind => "registry-timeout"; + + /// 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; } } -/// Agent interaction mode to apply to the session. +/// Synchronous pre-validation rejected the spawn request. +/// The validation-error variant of . [Experimental(Diagnostics.Experimental)] -internal sealed class ModeSetRequest +public partial class AgentRegistrySpawnResultValidationError : AgentRegistrySpawnResult { - /// The session mode the agent is operating in. - [JsonPropertyName("mode")] - public SessionMode Mode { get; set; } + /// + [JsonIgnore] + public override string Kind => "validation-error"; - /// Target session identifier. - [JsonPropertyName("sessionId")] - public string SessionId { get; set; } = string.Empty; + /// 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; } } -/// The session's friendly name, or null when not yet set. +/// Inputs to spawn a managed-server child via the controller's spawn delegate. [Experimental(Diagnostics.Experimental)] -public sealed class NameGetResult +internal sealed class AgentRegistrySpawnRequest { - /// The session name (user-set or auto-generated), or null if not yet 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 SessionNameGetRequest +internal sealed class SessionSuspendRequest { /// Target session identifier. [JsonPropertyName("sessionId")] public string SessionId { get; set; } = string.Empty; } -/// New friendly name to apply to the session. +/// Result of sending a user message. [Experimental(Diagnostics.Experimental)] -internal sealed class NameSetRequest +public sealed class SendResult { - /// 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. - [JsonPropertyName("sessionId")] - public string SessionId { get; set; } = string.Empty; + /// Unique identifier assigned to the message. + [JsonPropertyName("messageId")] + public string MessageId { get; set; } = string.Empty; } -/// Indicates whether the auto-generated summary was applied as the session's name. +/// Parameters for sending a user message to the session. [Experimental(Diagnostics.Experimental)] -public sealed class NameSetAutoResult +internal sealed class SendRequest { - /// 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; } -} + /// 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; } -/// 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; + /// Optional attachments (files, directories, selections, blobs, GitHub references) to include with the message. + [JsonPropertyName("attachments")] + public IList? Attachments { 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; -} + /// If false, this message will not trigger a Premium Request Unit charge. User messages default to billable. + [JsonPropertyName("billable")] + public bool? Billable { 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; } + /// If provided, this is shown in the timeline instead of `prompt`. + [JsonPropertyName("displayPrompt")] + public string? DisplayPrompt { get; set; } - /// Whether the plan file exists in the workspace. - [JsonPropertyName("exists")] - public bool Exists { get; set; } + /// 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; } - /// Absolute file path of the plan file, or null if workspace is not enabled. - [JsonPropertyName("path")] - public string? Path { 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; } -/// Identifies the target session. -[Experimental(Diagnostics.Experimental)] -internal sealed class SessionPlanReadRequest -{ /// 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; } } -/// Replacement contents to write to the session plan file. +/// Result of sending zero or more user messages. [Experimental(Diagnostics.Experimental)] -internal sealed class PlanUpdateRequest +public sealed class SendMessagesResult { - /// The new content for the plan file. - [JsonPropertyName("content")] - public string Content { 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; } +} - /// Target session identifier. - [JsonPropertyName("sessionId")] - public string SessionId { get; set; } = string.Empty; +/// A single user message to append to the session as part of a `session.sendMessages` turn. +[Experimental(Diagnostics.Experimental)] +public sealed class SendMessageItem +{ + /// Optional attachments (files, directories, selections, blobs, GitHub references) to include with this message. + [JsonPropertyName("attachments")] + public IList? Attachments { 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; } + + /// If provided, this is shown in the timeline instead of `prompt`. + [JsonPropertyName("displayPrompt")] + public string? DisplayPrompt { get; set; } + + /// The user message text. + [JsonPropertyName("prompt")] + public string Prompt { get; set; } = string.Empty; + + /// 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; } + + /// 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; } } -/// Identifies the target session. +/// 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)] -internal sealed class SessionPlanDeleteRequest +internal sealed class SendMessagesRequest { + /// 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; } + + /// 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; } + + /// 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; } + + /// If true, adds the messages to the front of the queue instead of the end. + [JsonPropertyName("prepend")] + public bool? Prepend { 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; } + /// Target session identifier. [JsonPropertyName("sessionId")] public string SessionId { get; set; } = string.Empty; + + /// 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 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; } } -/// 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. +/// Internal request for sending a system notification. [Experimental(Diagnostics.Experimental)] -public sealed class PlanSqlTodosRow +internal sealed class SendSystemNotificationRequest { - /// Todo description. - [JsonPropertyName("description")] - public string? Description { get; set; } + /// Optional structured notification kind. + [JsonPropertyName("kind")] + public JsonElement? Kind { get; set; } - /// Todo identifier. - [JsonPropertyName("id")] - public string? Id { get; set; } + /// Notification text to deliver to the model. + [JsonPropertyName("message")] + public string Message { get; set; } = string.Empty; - /// Todo status. - [JsonPropertyName("status")] - public string? Status { get; set; } + /// Internal delivery options, including passive policy. + [JsonPropertyName("options")] + public JsonElement? Options { get; set; } - /// Todo title. - [JsonPropertyName("title")] - public string? Title { get; set; } + /// Target session identifier. + [JsonPropertyName("sessionId")] + public string SessionId { get; set; } = string.Empty; } -/// Todo rows read from the session SQL database. Empty when no session database is available. +/// Result of aborting the current turn. [Experimental(Diagnostics.Experimental)] -public sealed class PlanReadSqlTodosResult +public sealed class AbortResult { - /// Rows from the session SQL todos table, ordered by creation time and id. - [JsonPropertyName("rows")] - public IList Rows { 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 SessionPlanReadSqlTodosRequest +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; } -/// A single dependency edge read from the session SQL `todo_deps` table, indicating that one todo must complete before another. +/// Result of interrupting the main agent turn. [Experimental(Diagnostics.Experimental)] -public sealed class PlanSqlTodoDependency +public sealed class InterruptMainTurnResult { - /// ID of the todo it depends on. - [JsonPropertyName("dependsOn")] - public string DependsOn { get; set; } = string.Empty; - - /// ID of the todo that has the dependency. - [JsonPropertyName("todoId")] - public string TodoId { get; set; } = string.Empty; + /// Whether an in-flight main agent turn was interrupted. False when the main loop was not processing. + [JsonPropertyName("interrupted")] + public bool Interrupted { get; set; } } -/// Todo rows + dependency edges read from the session SQL database. +/// Parameters for interrupting the main agent turn. [Experimental(Diagnostics.Experimental)] -public sealed class PlanReadSqlTodosWithDependenciesResult +internal sealed class InterruptMainTurnRequest { - /// 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; } + /// 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; } - /// 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; } + /// Target session identifier. + [JsonPropertyName("sessionId")] + public string SessionId { get; set; } = string.Empty; } /// Identifies the target session. [Experimental(Diagnostics.Experimental)] -internal sealed class SessionPlanReadSqlTodosWithDependenciesRequest +internal sealed class SessionCancelAllBackgroundAgentsRequest { /// Target session identifier. [JsonPropertyName("sessionId")] public string SessionId { get; set; } = string.Empty; } -/// RPC data type for WorkspacesGetWorkspaceResultWorkspace operations. -public sealed class WorkspacesGetWorkspaceResultWorkspace +/// Parameters for shutting down the session. +[Experimental(Diagnostics.Experimental)] +internal sealed class ShutdownRequest { - /// 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; } + /// Optional human-readable reason. Typically the message of the error that triggered shutdown when type is 'error'. + [JsonPropertyName("reason")] + public string? Reason { get; set; } - /// Gets or sets the client_name value. - [JsonPropertyName("client_name")] - public string? ClientName { get; set; } + /// Target session identifier. + [JsonPropertyName("sessionId")] + public string SessionId { get; set; } = string.Empty; - /// Gets or sets the created_at value. - [JsonPropertyName("created_at")] - public DateTimeOffset? CreatedAt { get; set; } + /// Why the session is being shut down. Defaults to "routine" when omitted. + [JsonPropertyName("type")] + public ShutdownType? Type { get; set; } +} - /// Gets or sets the cwd value. - [JsonPropertyName("cwd")] - public string? Cwd { 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; } +} - /// Gets or sets the git_root value. - [JsonPropertyName("git_root")] - public string? GitRoot { get; set; } +/// Message text, optional severity level, persistence flag, optional follow-up URL, and optional tip. +[Experimental(Diagnostics.Experimental)] +internal sealed class LogRequest +{ + /// When true, the message is transient and not persisted to the session event log on disk. + [JsonPropertyName("ephemeral")] + public bool? Ephemeral { get; set; } - /// Allowed values for the `WorkspacesWorkspaceDetailsHostType` enumeration. - [JsonPropertyName("host_type")] - public WorkspacesWorkspaceDetailsHostType? HostType { get; set; } + /// Log severity level. Determines how the message is displayed in the timeline. Defaults to "info". + [JsonPropertyName("level")] + public SessionLogLevel? Level { 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; + /// Human-readable message. + [JsonPropertyName("message")] + public string Message { 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; } + /// Target session identifier. + [JsonPropertyName("sessionId")] + public string SessionId { get; set; } = string.Empty; - /// Gets or sets the mc_task_id value. - [JsonPropertyName("mc_task_id")] - public string? McTaskId { get; set; } + /// Optional actionable tip displayed alongside the message. Only honored on `level: "info"`. + [JsonPropertyName("tip")] + public string? Tip { get; set; } - /// Gets or sets the name value. - [JsonPropertyName("name")] - public string? Name { 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; } - /// Gets or sets the remote_steerable value. - [JsonPropertyName("remote_steerable")] - public bool? RemoteSteerable { 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; } +} - /// Gets or sets the repository value. - [JsonPropertyName("repository")] - public string? Repository { get; set; } +/// Authentication status and account metadata for the session. +[Experimental(Diagnostics.Experimental)] +public sealed class SessionAuthStatus +{ + /// Authentication type. + [JsonPropertyName("authType")] + public AuthInfoType? AuthType { get; set; } - /// Gets or sets the summary_count value. - [JsonPropertyName("summary_count")] - public long? SummaryCount { get; set; } + /// Copilot plan tier (e.g., individual_pro, business). + [JsonPropertyName("copilotPlan")] + public string? CopilotPlan { get; set; } - /// Gets or sets the updated_at value. - [JsonPropertyName("updated_at")] - public DateTimeOffset? UpdatedAt { get; set; } + /// Authentication host URL. + [Url] + [StringSyntax(StringSyntaxAttribute.Uri)] + [JsonPropertyName("host")] + public string? Host { get; set; } - /// Gets or sets the user_named value. - [JsonPropertyName("user_named")] - public bool? UserNamed { get; set; } -} + /// Whether the session has resolved authentication. + [JsonPropertyName("isAuthenticated")] + public bool IsAuthenticated { get; set; } -/// Current workspace metadata for the session, including its absolute filesystem path when available. -[Experimental(Diagnostics.Experimental)] -public sealed class WorkspacesGetWorkspaceResult -{ - /// 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; } + /// Authenticated login/username, if available. + [JsonPropertyName("login")] + public string? Login { get; set; } - /// Current workspace metadata, or null if not available. - [JsonPropertyName("workspace")] - public WorkspacesGetWorkspaceResultWorkspace? Workspace { get; set; } + /// Human-readable authentication status description. + [JsonPropertyName("statusMessage")] + public string? StatusMessage { get; set; } } /// Identifies the target session. [Experimental(Diagnostics.Experimental)] -internal sealed class SessionWorkspacesGetWorkspaceRequest +internal sealed class SessionGitHubAuthGetStatusRequest { /// Target session identifier. [JsonPropertyName("sessionId")] public string SessionId { get; set; } = string.Empty; } -/// Relative paths of files stored in the session workspace files directory. +/// Indicates whether the credential update succeeded. [Experimental(Diagnostics.Experimental)] -public sealed class WorkspacesListFilesResult +public sealed class SessionSetCredentialsResult { - /// Relative file paths in the workspace files directory. - [JsonPropertyName("files")] - public IList Files { get => field ??= []; 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; } -/// Identifies the target session. -[Experimental(Diagnostics.Experimental)] -internal sealed class SessionWorkspacesListFilesRequest -{ - /// Target session identifier. - [JsonPropertyName("sessionId")] - public string SessionId { get; set; } = string.Empty; + /// Whether the operation succeeded. + [JsonPropertyName("success")] + public bool Success { get; set; } } -/// Contents of the requested workspace file as a UTF-8 string. +/// Authentication credentials accepted by session.gitHubAuth.setCredentials. Session-owned token-provider identities cannot be installed through this method. +/// Polymorphic base type discriminated by type. [Experimental(Diagnostics.Experimental)] -public sealed class WorkspacesReadFileResult +[JsonPolymorphic( + TypeDiscriminatorPropertyName = "type", + UnknownDerivedTypeHandling = JsonUnknownDerivedTypeHandling.FallBackToBaseType)] +[JsonDerivedType(typeof(SettableAuthInfoHmac), "hmac")] +[JsonDerivedType(typeof(SettableAuthInfoEnv), "env")] +[JsonDerivedType(typeof(SettableAuthInfoToken), "token")] +[JsonDerivedType(typeof(SettableAuthInfoCopilotApiToken), "copilot-api-token")] +[JsonDerivedType(typeof(SettableAuthInfoUser), "user")] +[JsonDerivedType(typeof(SettableAuthInfoGhCli), "gh-cli")] +[JsonDerivedType(typeof(SettableAuthInfoApiKey), "api-key")] +public partial class SettableAuthInfo { - /// File content as a UTF-8 string. - [JsonPropertyName("content")] - public string Content { get; set; } = string.Empty; + /// The type discriminator. + [JsonPropertyName("type")] + public virtual string Type { get; set; } = string.Empty; } -/// Relative path of the workspace file to read. + +/// Authentication-info input variant for GitHub-internal HMAC auth, carrying the public GitHub host and HMAC secret. +/// The hmac variant of . [Experimental(Diagnostics.Experimental)] -internal sealed class WorkspacesReadFileRequest +public partial class SettableAuthInfoHmac : SettableAuthInfo { - /// Relative path within the workspace files directory. - [JsonPropertyName("path")] - public string Path { get; set; } = string.Empty; + /// + [JsonIgnore] + public override string Type => "hmac"; - /// Target session identifier. - [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; } + + /// 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; } } -/// Relative path and UTF-8 content for the workspace file to create or overwrite. +/// Authentication-info input 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)] -internal sealed class WorkspacesCreateFileRequest +public partial class SettableAuthInfoEnv : SettableAuthInfo { - /// File content to write as a UTF-8 string. - [JsonPropertyName("content")] - public string Content { get; set; } = string.Empty; + /// + [JsonIgnore] + public override string Type => "env"; - /// Relative path within the workspace files directory. - [JsonPropertyName("path")] - public string Path { 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; } - /// Target session identifier. - [JsonPropertyName("sessionId")] - public string SessionId { get; set; } = string.Empty; -} + /// Name of the environment variable the token was sourced from. + [JsonPropertyName("envVar")] + public required string EnvVar { 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; + /// Authentication host (e.g. https://github.com or a GHES host). + [JsonPropertyName("host")] + public required string Host { get; set; } - /// Checkpoint number assigned by the workspace manager. - [JsonPropertyName("number")] - public long Number { 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; } - /// Human-readable checkpoint title. - [JsonPropertyName("title")] - public string Title { get; set; } = string.Empty; + /// The token value itself. Treat as a secret. + [JsonPropertyName("token")] + public required string Token { get; set; } } -/// Workspace checkpoints in chronological order; empty when the workspace is not enabled. +/// Token authentication accepted by session.gitHubAuth.setCredentials. +/// The token variant of . [Experimental(Diagnostics.Experimental)] -public sealed class WorkspacesListCheckpointsResult +public partial class SettableAuthInfoToken : SettableAuthInfo { - /// Workspace checkpoints in chronological order. Empty when workspace is not enabled. - [JsonPropertyName("checkpoints")] - public IList Checkpoints { get => field ??= []; set; } -} + /// + [JsonIgnore] + public override string Type => "token"; -/// Identifies the target session. -[Experimental(Diagnostics.Experimental)] -internal sealed class SessionWorkspacesListCheckpointsRequest -{ - /// Target session identifier. - [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; } -/// Checkpoint content as a UTF-8 string, or null when the checkpoint or workspace is missing. -[Experimental(Diagnostics.Experimental)] -public sealed class WorkspacesReadCheckpointResult -{ - /// Checkpoint content as a UTF-8 string, or null when the checkpoint or workspace is missing. - [JsonPropertyName("content")] - public string? Content { 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; } } -/// Checkpoint number to read. +/// 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)] -internal sealed class WorkspacesReadCheckpointRequest +public partial class SettableAuthInfoCopilotApiToken : SettableAuthInfo { - /// Checkpoint number to read. - [JsonPropertyName("number")] - public long Number { get; set; } + /// + [JsonIgnore] + public override string Type => "copilot-api-token"; - /// Target session identifier. - [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; } + + /// Authentication host (always the public GitHub host). + [JsonPropertyName("host")] + public required string Host { get; set; } } -/// RPC data type for WorkspacesSaveLargePasteResultSaved operations. -public sealed class WorkspacesSaveLargePasteResultSaved +/// 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)] +public partial class SettableAuthInfoUser : SettableAuthInfo { - /// Filename within the workspace files directory. - [JsonPropertyName("filename")] - public string Filename { get; set; } = string.Empty; + /// + [JsonIgnore] + public override string Type => "user"; - /// Absolute filesystem path to the saved paste file. - [JsonPropertyName("filePath")] - public string FilePath { 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; } - /// Size of the saved file in bytes. - [JsonPropertyName("sizeBytes")] - public long SizeBytes { get; set; } + /// Authentication host. + [JsonPropertyName("host")] + public required string Host { get; set; } + + /// OAuth user login. + [JsonPropertyName("login")] + public required string Login { get; set; } } -/// Descriptor for the saved paste file, or null when the workspace is unavailable. +/// Authentication-info input 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 WorkspacesSaveLargePasteResult -{ - /// 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; } -} - -/// Pasted content to save as a UTF-8 file in the session workspace. -[Experimental(Diagnostics.Experimental)] -internal sealed class WorkspacesSaveLargePasteRequest -{ - /// Pasted content to save as a UTF-8 file. - [JsonPropertyName("content")] - public string Content { get; set; } = string.Empty; - - /// Target session identifier. - [JsonPropertyName("sessionId")] - public string SessionId { get; set; } = string.Empty; -} - -/// A single changed file and its unified diff. -[Experimental(Diagnostics.Experimental)] -public sealed class WorkspaceDiffFileChange +public partial class SettableAuthInfoGhCli : SettableAuthInfo { - /// Type of change represented by this file diff. - [JsonPropertyName("changeType")] - public WorkspaceDiffFileChangeType ChangeType { get; set; } + /// + [JsonIgnore] + public override string Type => "gh-cli"; - /// Unified diff content for the file. Empty when the diff was truncated. - [JsonPropertyName("diff")] - public string Diff { 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; } - /// Whether the diff content was omitted because it exceeded the per-file size limit. - [JsonPropertyName("isTruncated")] - public bool? IsTruncated { get; set; } + /// Authentication host. + [JsonPropertyName("host")] + public required string Host { get; set; } - /// Original file path for renamed files. - [JsonPropertyName("oldPath")] - public string? OldPath { get; set; } + /// User login as reported by `gh auth status`. + [JsonPropertyName("login")] + public required string Login { get; set; } - /// Path to the changed file, relative to the workspace root. - [JsonPropertyName("path")] - public string Path { get; set; } = string.Empty; + /// The token returned by `gh auth token`. Treat as a secret. + [JsonPropertyName("token")] + public required string Token { get; set; } } -/// Workspace diff result for the requested mode. +/// Authentication-info input 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)] -public sealed class WorkspaceDiffResult +public partial class SettableAuthInfoApiKey : SettableAuthInfo { - /// 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; } -} + /// + [JsonIgnore] + public override string Type => "api-key"; -/// Parameters for computing a workspace diff. -[Experimental(Diagnostics.Experimental)] -internal sealed class WorkspacesDiffRequest -{ - /// When true, ignore whitespace-only changes (git `--ignore-all-space`). Defaults to false. - [JsonPropertyName("ignoreWhitespace")] - public bool? IgnoreWhitespace { get; set; } + /// The API key. Treat as a secret. + [JsonPropertyName("apiKey")] + public required string ApiKey { get; set; } - /// Diff mode requested by the client. - [JsonPropertyName("mode")] - public WorkspaceDiffMode Mode { 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; } - /// Target session identifier. - [JsonPropertyName("sessionId")] - public string SessionId { get; set; } = string.Empty; + /// Authentication host. + [JsonPropertyName("host")] + public required string Host { get; set; } } -/// 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`). +/// New auth credentials to install on the session. Omit to leave credentials unchanged. [Experimental(Diagnostics.Experimental)] -public sealed class CompletionsGetTriggerCharactersResult +internal sealed class SessionSetCredentialsParams { - /// Trigger characters advertised by the host (e.g. `["@", "#"]`). Empty disables host-driven completions for the session. - [JsonPropertyName("triggerCharacters")] - public IList TriggerCharacters { get => field ??= []; 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 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 SettableAuthInfo? Credentials { get; set; } -/// Identifies the target session. -[Experimental(Diagnostics.Experimental)] -internal sealed class SessionCompletionsGetTriggerCharactersRequest -{ /// Target session identifier. [JsonPropertyName("sessionId")] public string SessionId { get; set; } = string.Empty; } -/// 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. +/// Credential-free authentication identity safe to expose to hosts and user interfaces. [Experimental(Diagnostics.Experimental)] -public sealed class SessionCompletionItem +public sealed class AuthIdentity { - /// Text spliced into the composer when the item is accepted. - [JsonPropertyName("insertText")] - public string InsertText { get; set; } = string.Empty; + /// Snapshot of the authenticated user's Copilot subscription info, if known. + [JsonPropertyName("copilotUser")] + public CopilotUserResponse? CopilotUser { get; set; } - /// 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; } + /// Name of the environment variable that supplied the credential, when applicable. + [JsonPropertyName("envVar")] + public string? EnvVar { get; set; } - /// Primary display label for the picker row. Falls back to `insertText` when absent. - [JsonPropertyName("label")] - public string? Label { get; set; } + /// Authentication host. + [JsonPropertyName("host")] + public string Host { get; set; } = string.Empty; - /// End (exclusive) of the replacement range in `text`, in UTF-16 code units. - [JsonPropertyName("rangeEnd")] - public long? RangeEnd { get; set; } + /// Authenticated login, when available. + [JsonPropertyName("login")] + public string? Login { get; set; } - /// Start of the replacement range in `text`, in UTF-16 code units. - [JsonPropertyName("rangeStart")] - public long? RangeStart { get; set; } -} + /// Opaque SDK GitHub credential registration backing this identity. Routing metadata only; never a credential. + [JsonPropertyName("registrationId")] + public string? RegistrationId { get; set; } -/// Host-driven completion items for the current composer input. Empty when the host returns no items or does not support completions. -[Experimental(Diagnostics.Experimental)] -public sealed class CompletionsRequestResult -{ - /// Completion items in host-ranked order. - [JsonPropertyName("items")] - public IList Items { get => field ??= []; set; } + /// Authentication type. + [JsonPropertyName("type")] + public AuthInfoType Type { get; set; } } -/// Request host-driven completions for the current composer input. +/// Identifies the target session. [Experimental(Diagnostics.Experimental)] -internal sealed class CompletionsRequestRequest +internal sealed class SessionGitHubAuthGetCurrentAuthInfoRequest { - /// 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; } -/// Instruction sources loaded for the session, in merge order. +/// Identifies the target session. [Experimental(Diagnostics.Experimental)] -public sealed class InstructionsGetSourcesResult +internal sealed class SessionGitHubAuthGetAllAuthAvailableRequest { - /// Instruction sources for the session. - [JsonPropertyName("sources")] - public IList Sources { get => field ??= []; set; } + /// Target session identifier. + [JsonPropertyName("sessionId")] + public string SessionId { get; set; } = string.Empty; } /// Identifies the target session. [Experimental(Diagnostics.Experimental)] -internal sealed class SessionInstructionsGetSourcesRequest +internal sealed class SessionGitHubAuthRefreshCopilotUserRequest { /// Target session identifier. [JsonPropertyName("sessionId")] public string SessionId { get; set; } = string.Empty; } -/// Indicates whether fleet mode was successfully activated. +/// Internal GitHub login parameters. [Experimental(Diagnostics.Experimental)] -public sealed class FleetStartResult +internal sealed class SessionAuthLoginRequest { - /// Whether fleet mode was successfully activated. - [JsonPropertyName("started")] - public bool Started { get; set; } -} + /// GitHub host URL. + [JsonPropertyName("host")] + public string Host { get; set; } = string.Empty; -/// 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; } + /// GitHub login. + [JsonPropertyName("login")] + public string Login { get; set; } = string.Empty; + + /// Whether to persist the token after login. + [JsonPropertyName("persist")] + public bool? Persist { get; set; } /// Target session identifier. [JsonPropertyName("sessionId")] public string SessionId { 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; } + /// GitHub authentication token. + [JsonPropertyName("token")] + public string Token { get; set; } = string.Empty; } -/// Identifies the target session. +/// Parameters for switching the session's active authentication. [Experimental(Diagnostics.Experimental)] -internal sealed class SessionAgentListRequest +internal sealed class SessionAuthSwitchRequest { + /// Authentication information to activate. + [JsonPropertyName("authInfo")] + public AuthInfo AuthInfo { get => field ??= new(); set; } + /// Target session identifier. [JsonPropertyName("sessionId")] public string SessionId { get; set; } = string.Empty; -} -/// The currently selected custom agent, or null when using the default agent. -[Experimental(Diagnostics.Experimental)] -public sealed class AgentGetCurrentResult -{ - /// Currently selected custom agent, or null if using the default agent. - [JsonPropertyName("agent")] - public AgentInfo? Agent { get; set; } + /// Optional token paired with the authentication information. + [JsonPropertyName("token")] + public string? Token { get; set; } } /// Identifies the target session. [Experimental(Diagnostics.Experimental)] -internal sealed class SessionAgentGetCurrentRequest +internal sealed class SessionGitHubAuthLogoutRequest { /// Target session identifier. [JsonPropertyName("sessionId")] public string SessionId { get; set; } = string.Empty; } -/// The newly selected custom agent. -[Experimental(Diagnostics.Experimental)] -public sealed class AgentSelectResult -{ - /// The newly selected custom agent. - [JsonPropertyName("agent")] - public AgentInfo Agent { get => field ??= new(); set; } -} - -/// Name of the custom agent to select for subsequent turns. +/// Parameters identifying a GitHub authentication to log out. [Experimental(Diagnostics.Experimental)] -internal sealed class AgentSelectRequest +internal sealed class SessionAuthLogoutUserRequest { - /// Name of the custom agent to select. - [JsonPropertyName("name")] - public string Name { get; set; } = string.Empty; + /// Authentication information to log out. + [JsonPropertyName("authInfo")] + public AuthInfo AuthInfo { get => field ??= new(); set; } /// Target session identifier. [JsonPropertyName("sessionId")] public string SessionId { get; set; } = string.Empty; } -/// Identifies the target session. +/// Validation error from an authentication attempt. [Experimental(Diagnostics.Experimental)] -internal sealed class SessionAgentDeselectRequest +public sealed class AuthValidationError { - /// Target session identifier. - [JsonPropertyName("sessionId")] - public string SessionId { get; set; } = string.Empty; -} + /// Optional message returned by GitHub. + [JsonPropertyName("githubMessage")] + public string? GitHubMessage { get; set; } -/// Custom agents available to the session after reloading definitions from disk. -[Experimental(Diagnostics.Experimental)] -public sealed class AgentReloadResult -{ - /// Reloaded custom agents. - [JsonPropertyName("agents")] - public IList Agents { get => field ??= []; set; } + /// Authentication validation error message. + [JsonPropertyName("message")] + public string Message { get; set; } = string.Empty; } /// Identifies the target session. [Experimental(Diagnostics.Experimental)] -internal sealed class SessionAgentReloadRequest +internal sealed class SessionGitHubAuthLastAuthErrorsRequest { /// Target session identifier. [JsonPropertyName("sessionId")] public string SessionId { get; set; } = string.Empty; } -/// Identifier assigned to the newly started background agent task. +/// A file included in the redacted debug bundle. [Experimental(Diagnostics.Experimental)] -public sealed class TasksStartAgentResult +public sealed class DebugCollectLogsCollectedEntry { - /// Generated agent ID for the background task. - [JsonPropertyName("agentId")] - public string AgentId { get; set; } = string.Empty; -} + /// Relative path of the file in the staged bundle/archive. + [JsonPropertyName("bundlePath")] + public string BundlePath { get; set; } = string.Empty; -/// Agent type, prompt, name, and optional description and model override for the new task. + /// Redacted output size in bytes. + [JsonPropertyName("sizeBytes")] + public long SizeBytes { get; set; } + + /// Source category for this entry. + [JsonPropertyName("source")] + public DebugCollectLogsSource Source { get; set; } +} + +/// An optional debug bundle entry that could not be included. [Experimental(Diagnostics.Experimental)] -internal sealed class TasksStartAgentRequest +public sealed class DebugCollectLogsSkippedEntry { - /// Type of agent to start (e.g., 'explore', 'task', 'general-purpose'). - [JsonPropertyName("agentType")] - public string AgentType { get; set; } = string.Empty; + /// Relative path requested for this bundle entry. + [JsonPropertyName("bundlePath")] + public string BundlePath { get; set; } = string.Empty; - /// Short description of the task. - [JsonPropertyName("description")] - public string? Description { get; set; } + /// Server-local source path that could not be read. + [JsonPropertyName("path")] + public string? Path { get; set; } - /// Optional model override. - [JsonPropertyName("model")] - public string? Model { get; set; } + /// Reason the entry was skipped. + [JsonPropertyName("reason")] + public string Reason { 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; +/// Result of collecting a redacted debug bundle. +[Experimental(Diagnostics.Experimental)] +public sealed class DebugCollectLogsResult +{ + /// Files included in the redacted bundle. + [JsonPropertyName("entries")] + public IList Entries { get => field ??= []; set; } - /// Task prompt for the agent. - [JsonPropertyName("prompt")] - public string Prompt { get; set; } = string.Empty; + /// Destination kind that was written. + [JsonPropertyName("kind")] + public DebugCollectLogsResultKind Kind { get; set; } - /// Target session identifier. - [JsonPropertyName("sessionId")] - public string SessionId { get; set; } = string.Empty; + /// 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; } } -/// Tracked task union returned by task APIs, containing either an agent task or a shell task. -/// Polymorphic base type discriminated by type. +/// A caller-provided server-local file or directory to include in the debug bundle. +[Experimental(Diagnostics.Experimental)] +public sealed class DebugCollectLogsEntry +{ + /// 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; } +} + +/// Destination for the redacted debug bundle. +/// Polymorphic base type discriminated by kind. [Experimental(Diagnostics.Experimental)] [JsonPolymorphic( - TypeDiscriminatorPropertyName = "type", + TypeDiscriminatorPropertyName = "kind", UnknownDerivedTypeHandling = JsonUnknownDerivedTypeHandling.FallBackToBaseType)] -[JsonDerivedType(typeof(TaskInfoAgent), "agent")] -[JsonDerivedType(typeof(TaskInfoShell), "shell")] -public partial class TaskInfo +[JsonDerivedType(typeof(DebugCollectLogsDestinationArchive), "archive")] +[JsonDerivedType(typeof(DebugCollectLogsDestinationDirectory), "directory")] +public partial class DebugCollectLogsDestination { /// The type discriminator. - [JsonPropertyName("type")] - public virtual string Type { get; set; } = string.Empty; + [JsonPropertyName("kind")] + public virtual string Kind { get; set; } = string.Empty; } -/// Tracked background agent task metadata, including IDs, status, timing, agent type, prompt, model, result, and latest response. -/// The agent variant of . +/// The archive variant of . [Experimental(Diagnostics.Experimental)] -public partial class TaskInfoAgent : TaskInfo +public partial class DebugCollectLogsDestinationArchive : DebugCollectLogsDestination { /// [JsonIgnore] - public override string Type => "agent"; + public override string Kind => "archive"; - /// ISO 8601 timestamp when the current active period began. + /// 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("activeStartedAt")] - public DateTimeOffset? ActiveStartedAt { get; set; } + [JsonPropertyName("noOverwrite")] + public bool? NoOverwrite { get; set; } - /// Accumulated active execution time in milliseconds. - [JsonConverter(typeof(MillisecondsTimeSpanConverter))] - [JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)] - [JsonPropertyName("activeTimeMs")] - public TimeSpan? ActiveTime { get; set; } + /// Absolute or server-relative path for the .tgz archive to create. + [JsonPropertyName("outputPath")] + public required string OutputPath { get; set; } +} - /// Type of agent running this task. - [JsonPropertyName("agentType")] - public required string AgentType { get; set; } +/// The directory variant of . +[Experimental(Diagnostics.Experimental)] +public partial class DebugCollectLogsDestinationDirectory : DebugCollectLogsDestination +{ + /// + [JsonIgnore] + public override string Kind => "directory"; - /// 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; } + /// Directory where redacted files should be staged. The directory is created if needed. + [JsonPropertyName("outputDirectory")] + public required string OutputDirectory { get; set; } +} - /// ISO 8601 timestamp when the task finished. - [JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)] - [JsonPropertyName("completedAt")] - public DateTimeOffset? CompletedAt { get; set; } +/// Built-in session diagnostics to include in the bundle. Omitted fields default to true. +[Experimental(Diagnostics.Experimental)] +public sealed class 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. + [JsonPropertyName("currentProcessLogPath")] + public string? CurrentProcessLogPath { get; set; } - /// Short description of the task. - [JsonPropertyName("description")] - public required string Description { get; set; } + /// Include the session event log (`events.jsonl`). Defaults to true. + [JsonPropertyName("events")] + public bool? Events { get; set; } - /// Error message when the task failed. - [JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)] - [JsonPropertyName("error")] - public string? Error { 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; } - /// Whether task execution is synchronously awaited or managed in the background. - [JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)] - [JsonPropertyName("executionMode")] - public TaskExecutionMode? ExecutionMode { get; set; } + /// Maximum number of previous process logs to include. Defaults to 5. + [JsonPropertyName("previousProcessLogLimit")] + public long? PreviousProcessLogLimit { get; set; } - /// Unique task identifier. - [JsonPropertyName("id")] - public required string Id { 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; } - /// ISO 8601 timestamp when the agent entered idle state. - [JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)] - [JsonPropertyName("idleSince")] - public DateTimeOffset? IdleSince { get; set; } + /// Include process logs for the session. Defaults to true. + [JsonPropertyName("processLogs")] + public bool? ProcessLogs { get; set; } - /// Most recent response text from the agent. - [JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)] - [JsonPropertyName("latestResponse")] - public string? LatestResponse { get; set; } + /// Include interactive shell logs written under the session's `shell-logs` directory. Defaults to true. + [JsonPropertyName("shellLogs")] + public bool? ShellLogs { get; set; } +} - /// Requested model override for the task when specified. - [JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)] - [JsonPropertyName("model")] - public string? Model { get; set; } +/// Options for collecting a redacted session debug bundle. +[Experimental(Diagnostics.Experimental)] +internal sealed class 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. + [JsonPropertyName("additionalEntries")] + public IList? AdditionalEntries { 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; } + /// 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; } - /// Runtime model resolved for the task when available. - [JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)] - [JsonPropertyName("resolvedModel")] - public string? ResolvedModel { get; set; } + /// Which built-in session diagnostics to include. Omitted fields default to true. + [JsonPropertyName("include")] + public DebugCollectLogsInclude? Include { get; set; } - /// Result text from the task when available. - [JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)] - [JsonPropertyName("result")] - public string? Result { get; set; } + /// Target session identifier. + [JsonPropertyName("sessionId")] + public string SessionId { get; set; } = string.Empty; +} - /// ISO 8601 timestamp when the task was started. - [JsonPropertyName("startedAt")] - public required DateTimeOffset StartedAt { get; set; } +/// 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 CanvasAction +{ + /// Description of the action. + [JsonPropertyName("description")] + public string? Description { get; set; } - /// Current lifecycle status of the task. - [JsonPropertyName("status")] - public required TaskStatus Status { get; set; } + /// JSON Schema for the action input. + [JsonPropertyName("inputSchema")] + public JsonElement? InputSchema { get; set; } - /// Tool call ID associated with this agent task. - [JsonPropertyName("toolCallId")] - public required string ToolCallId { get; set; } + /// Action name exposed by the canvas provider. + [JsonPropertyName("name")] + public string Name { get; set; } = string.Empty; } -/// Tracked shell task metadata, including ID, command, status, timing, attachment/execution mode, log path, and PID. -/// The shell variant of . +/// Canvas available in the current session. [Experimental(Diagnostics.Experimental)] -public partial class TaskInfoShell : TaskInfo +public sealed class DiscoveredCanvas { - /// - [JsonIgnore] - public override string Type => "shell"; + /// Actions the agent or host may invoke on an open instance. + [JsonPropertyName("actions")] + public IList? Actions { 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; } - - /// Whether this shell task can be promoted to background mode. - [JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)] - [JsonPropertyName("canPromoteToBackground")] - public bool? CanPromoteToBackground { get; set; } - - /// Command being executed. - [JsonPropertyName("command")] - public required string Command { get; set; } - - /// ISO 8601 timestamp when the task finished. - [JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)] - [JsonPropertyName("completedAt")] - public DateTimeOffset? CompletedAt { get; set; } + /// Provider-local canvas identifier. + [JsonPropertyName("canvasId")] + public string CanvasId { get; set; } = string.Empty; - /// Short description of the task. + /// 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; } - - /// Whether task execution is synchronously awaited or managed in the background. - [JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)] - [JsonPropertyName("executionMode")] - public TaskExecutionMode? ExecutionMode { get; set; } + public string Description { get; set; } = string.Empty; - /// Unique task identifier. - [JsonPropertyName("id")] - public required string Id { get; set; } + /// Human-readable canvas name. + [JsonPropertyName("displayName")] + public string DisplayName { get; set; } = string.Empty; - /// Path to the detached shell log, when available. - [JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)] - [JsonPropertyName("logPath")] - public string? LogPath { get; set; } + /// Owning provider identifier. + [JsonPropertyName("extensionId")] + public string ExtensionId { get; set; } = string.Empty; - /// Process ID when available. - [JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)] - [JsonPropertyName("pid")] - public long? Pid { get; set; } + /// Owning extension display name, when available. + [JsonPropertyName("extensionName")] + public string? ExtensionName { get; set; } - /// ISO 8601 timestamp when the task was started. - [JsonPropertyName("startedAt")] - public required DateTimeOffset StartedAt { get; set; } + /// Host-local PNG path for the canvas icon, when supplied. + [JsonPropertyName("icon")] + public string? Icon { get; set; } - /// Current lifecycle status of the task. - [JsonPropertyName("status")] - public required TaskStatus Status { get; set; } + /// JSON Schema for canvas open input. + [JsonPropertyName("inputSchema")] + public JsonElement? InputSchema { get; set; } } -/// Background tasks currently tracked by the session. +/// Declared canvases available in this session. [Experimental(Diagnostics.Experimental)] -public sealed class TaskList +public sealed class CanvasList { - /// Currently tracked tasks. - [JsonPropertyName("tasks")] - public IList Tasks { 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 SessionTasksListRequest +internal sealed class SessionCanvasListRequest { /// 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. +/// Open canvas instance snapshot. [Experimental(Diagnostics.Experimental)] -public sealed class TasksRefreshResult +public sealed class OpenCanvasInstance { -} + /// Provider-local canvas identifier. + [JsonPropertyName("canvasId")] + public string CanvasId { get; set; } = string.Empty; -/// Identifies the target session. -[Experimental(Diagnostics.Experimental)] -internal sealed class SessionTasksRefreshRequest -{ - /// Target session identifier. - [JsonPropertyName("sessionId")] - public string SessionId { 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; } + + /// 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; } } -/// 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). +/// Live open-canvas snapshot. [Experimental(Diagnostics.Experimental)] -public sealed class TasksWaitForPendingResult +public sealed class CanvasListOpenResult { + /// Currently open canvas instances. + [JsonPropertyName("openCanvases")] + public IList OpenCanvases { get => field ??= []; set; } } /// Identifies the target session. [Experimental(Diagnostics.Experimental)] -internal sealed class SessionTasksWaitForPendingRequest +internal sealed class SessionCanvasListOpenRequest { /// 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. - [JsonPropertyName("type")] - public virtual string Type { get; set; } = string.Empty; -} - - -/// Timestamped display line for task progress output or recent agent activity. +/// Canvas open parameters. [Experimental(Diagnostics.Experimental)] -public sealed class TaskProgressLine +internal sealed class CanvasOpenRequest { - /// Display message, e.g., "β–Έ bash", "βœ“ edit src/foo.ts". - [JsonPropertyName("message")] - public string Message { get; set; } = string.Empty; + /// Provider-local canvas identifier. + [JsonPropertyName("canvasId")] + public string CanvasId { get; set; } = string.Empty; - /// ISO 8601 timestamp when this event occurred. - [JsonPropertyName("timestamp")] - public DateTimeOffset Timestamp { 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; } -/// 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 Type => "agent"; + /// Canvas open input. + [JsonPropertyName("input")] + public JsonElement? Input { get; set; } - /// The most recent intent reported by the agent. - [JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)] - [JsonPropertyName("latestIntent")] - public string? LatestIntent { get; set; } + /// Caller-supplied stable instance identifier. + [JsonPropertyName("instanceId")] + public string InstanceId { get; set; } = string.Empty; - /// Recent tool execution events converted to display lines. - [JsonPropertyName("recentActivity")] - public required IList RecentActivity { get; set; } + /// Target session identifier. + [JsonPropertyName("sessionId")] + public string SessionId { get; set; } = string.Empty; } -/// Progress snapshot for a shell task, with recent stdout/stderr output and optional process ID. -/// The shell variant of . -public partial class TasksGetProgressResultProgressShell : TasksGetProgressResultProgress +/// Canvas close parameters. +[Experimental(Diagnostics.Experimental)] +internal sealed class CanvasCloseRequest { - /// - [JsonIgnore] - public override string Type => "shell"; - - /// Process ID when available. - [JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)] - [JsonPropertyName("pid")] - public long? Pid { get; set; } + /// Open canvas instance identifier. + [JsonPropertyName("instanceId")] + public string InstanceId { get; set; } = string.Empty; - /// Recent stdout/stderr lines from the running shell command. - [JsonPropertyName("recentOutput")] - public required string RecentOutput { get; set; } + /// Target session identifier. + [JsonPropertyName("sessionId")] + public string SessionId { get; set; } = string.Empty; } -/// Progress information for the task, or null when no task with that ID is tracked. +/// Canvas action invocation result. [Experimental(Diagnostics.Experimental)] -public sealed class TasksGetProgressResult +public sealed class CanvasActionInvokeResult { - /// 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; } + /// Provider-supplied action result. + [JsonPropertyName("result")] + public JsonElement? Result { get; set; } } -/// Identifier of the background task to fetch progress for. +/// Canvas action invocation parameters. [Experimental(Diagnostics.Experimental)] -internal sealed class TasksGetProgressRequest +internal sealed class CanvasActionInvokeRequest { - /// Task identifier (agent ID or shell ID). - [JsonPropertyName("id")] - public string Id { get; set; } = string.Empty; + /// 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; } -/// The first sync-waiting task that can currently be promoted to background mode. +/// Internal canvas provider registration parameters. [Experimental(Diagnostics.Experimental)] -public sealed class TasksGetCurrentPromotableResult +internal sealed class CanvasProviderRegisterRequest { - /// 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; } -} + /// Canvas contributions supplied by the provider. + [JsonPropertyName("canvases")] + public IList Canvases { get => field ??= []; set; } + + /// Connection identifier for callback routing. + [JsonPropertyName("connectionId")] + public string ConnectionId { get; set; } = string.Empty; + + /// Provider metadata supplied by the host. + [JsonPropertyName("info")] + public JsonElement Info { get; set; } -/// Identifies the target session. -[Experimental(Diagnostics.Experimental)] -internal sealed class SessionTasksGetCurrentPromotableRequest -{ /// Target session identifier. [JsonPropertyName("sessionId")] public string SessionId { get; set; } = string.Empty; } -/// Indicates whether the task was successfully promoted to background mode. +/// Internal canvas provider unregistration parameters. [Experimental(Diagnostics.Experimental)] -public sealed class TasksPromoteToBackgroundResult +internal sealed class CanvasProviderUnregisterRequest { - /// Whether the task was successfully promoted to background mode. - [JsonPropertyName("promoted")] - public bool Promoted { get; set; } + /// Connection identifier to unregister. + [JsonPropertyName("connectionId")] + public string ConnectionId { get; set; } = string.Empty; + + /// Target session identifier. + [JsonPropertyName("sessionId")] + public string SessionId { get; set; } = string.Empty; } -/// Identifier of the task to promote to background mode. +/// Machine-readable factory run failure. +/// Polymorphic base type discriminated by type. [Experimental(Diagnostics.Experimental)] -internal sealed class TasksPromoteToBackgroundRequest +[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 { - /// Task identifier. - [JsonPropertyName("id")] - public string Id { get; set; } = string.Empty; - - /// 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; } -/// The promoted task as it now exists in background mode, omitted if no promotable task was waiting. + +/// The factory_limit_reached variant of . [Experimental(Diagnostics.Experimental)] -public sealed class TasksPromoteCurrentToBackgroundResult +public partial class FactoryRunFailureFactoryLimitReached : FactoryRunFailure { - /// 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; } + /// + [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; } } -/// Identifies the target session. +/// The factory_resume_declined variant of . [Experimental(Diagnostics.Experimental)] -internal sealed class SessionTasksPromoteCurrentToBackgroundRequest +public partial class FactoryRunFailureFactoryResumeDeclined : FactoryRunFailure { - /// Target session identifier. - [JsonPropertyName("sessionId")] - public string SessionId { get; set; } = string.Empty; + /// + [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; } } -/// Indicates whether the background task was successfully cancelled. +/// The factory_durable_failure variant of . [Experimental(Diagnostics.Experimental)] -public sealed class TasksCancelResult +public partial class FactoryRunFailureFactoryDurableFailure : FactoryRunFailure { - /// Whether the task was successfully cancelled. - [JsonPropertyName("cancelled")] - public bool Cancelled { get; set; } + /// + [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; } } -/// Identifier of the background task to cancel. +/// The run stopped because its usage accounting could not be completed. +/// The factory_accounting_incomplete variant of . [Experimental(Diagnostics.Experimental)] -internal sealed class TasksCancelRequest +public partial class FactoryRunFailureFactoryAccountingIncomplete : FactoryRunFailure { - /// Task identifier. - [JsonPropertyName("id")] - public string Id { get; set; } = string.Empty; + /// + [JsonIgnore] + public override string Type => "factory_accounting_incomplete"; - /// Target session identifier. - [JsonPropertyName("sessionId")] - public string SessionId { get; set; } = string.Empty; + /// 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; } } -/// Indicates whether the task was removed. False when the task does not exist or is still running/idle. +/// Complete current or terminal factory run envelope. [Experimental(Diagnostics.Experimental)] -public sealed class TasksRemoveResult +public sealed class FactoryRunResult { - /// 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; } + /// Error message for an errored run. + [JsonPropertyName("error")] + public string? Error { get; set; } + + /// Machine-readable failure details for an errored run. + [JsonPropertyName("failure")] + public FactoryRunFailure? Failure { 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; } + + /// Current or terminal factory run status. + [JsonPropertyName("status")] + public FactoryRunStatus Status { get; set; } } -/// Identifier of the completed or cancelled task to remove from tracking. +/// Wire-only per-invocation factory resource ceiling overrides. [Experimental(Diagnostics.Experimental)] -internal sealed class TasksRemoveRequest +public sealed class FactoryRunLimits { - /// Task identifier. - [JsonPropertyName("id")] - public string Id { get; set; } = string.Empty; + /// 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; } - /// Target session identifier. - [JsonPropertyName("sessionId")] - public string SessionId { get; set; } = string.Empty; + /// 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; } } -/// Indicates whether the message was delivered, with an error message when delivery failed. +/// Options controlling factory invocation. [Experimental(Diagnostics.Experimental)] -public sealed class TasksSendMessageResult +public sealed class RunOptions { - /// Error message if delivery failed. - [JsonPropertyName("error")] - public string? Error { get; set; } + /// Per-invocation resource ceiling overrides. + [JsonPropertyName("limits")] + public FactoryRunLimits? Limits { get; set; } - /// Whether the message was successfully delivered or steered. - [JsonPropertyName("sent")] - public bool Sent { get; set; } + /// Whether to emit factory phase names to the session transcript. + [JsonPropertyName("logPhaseNames")] + public bool? LogPhaseNames { get; set; } + + /// Whether to notify the originating session when the factory completes. + [JsonPropertyName("notifyOnComplete")] + public bool? NotifyOnComplete { get; set; } + + /// Run identifier whose journal and progress should seed this resumed run. + [JsonPropertyName("resumeFromRunId")] + public string? ResumeFromRunId { get; set; } } -/// Identifier of the target agent task, message content, and optional sender agent ID. +/// Parameters for invoking a registered factory. [Experimental(Diagnostics.Experimental)] -internal sealed class TasksSendMessageRequest +internal sealed class FactoryRunRequest { - /// Agent ID of the sender, if sent on behalf of another agent. - [JsonPropertyName("fromAgentId")] - public string? FromAgentId { get; set; } + /// Factory input value. + [JsonPropertyName("args")] + public JsonElement Args { get; set; } - /// Agent task identifier. - [JsonPropertyName("id")] - public string Id { get; set; } = string.Empty; + /// Registered factory name. + [JsonPropertyName("name")] + public string Name { get; set; } = string.Empty; - /// Message content to send to the agent. - [JsonPropertyName("message")] - public string Message { 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; } -/// Skill metadata available to a session, with name, description, source, enabled/invocable state, path, plugin, and argument hint. +/// Resolved persisted factory identity and resumed run envelope. [Experimental(Diagnostics.Experimental)] -public sealed class Skill +public sealed class FactoryResumeResult { - /// Optional freeform hint describing the skill's expected arguments, from the `argument-hint` frontmatter field. - [JsonPropertyName("argumentHint")] - public string? ArgumentHint { get; set; } - - /// Description of what the skill does. - [JsonPropertyName("description")] - public string Description { get; set; } = string.Empty; + /// Persisted factory name resolved for the resumed run. + [JsonPropertyName("factoryName")] + public string FactoryName { get; set; } = string.Empty; - /// Whether the skill is currently enabled. - [JsonPropertyName("enabled")] - public bool Enabled { get; set; } + /// Terminal resumed run envelope. + [JsonPropertyName("run")] + public FactoryRunResult Run { get => field ??= new(); set; } +} - /// Unique identifier for the skill. - [JsonPropertyName("name")] - public string Name { get; set; } = string.Empty; +/// Parameters for resuming a factory run from its persisted identity. +[Experimental(Diagnostics.Experimental)] +internal sealed class FactoryResumeRequest +{ + /// Optional per-invocation resource ceiling overrides. + [JsonPropertyName("limits")] + public FactoryRunLimits? Limits { get; set; } - /// Absolute path to the skill file. - [JsonPropertyName("path")] - public string? Path { get; set; } + /// Whether to emit factory phase names to the session transcript. + [JsonPropertyName("logPhaseNames")] + public bool? LogPhaseNames { get; set; } - /// Name of the plugin that provides the skill, when source is 'plugin'. - [JsonPropertyName("pluginName")] - public string? PluginName { get; set; } + /// Whether to notify the originating session when the factory completes. + [JsonPropertyName("notifyOnComplete")] + public bool? NotifyOnComplete { get; set; } - /// Source location type (e.g., project, personal-copilot, plugin, builtin). - [JsonPropertyName("source")] - public SkillSource Source { get; set; } + /// Factory run identifier. + [JsonPropertyName("runId")] + public string RunId { get; set; } = string.Empty; - /// Whether the skill can be invoked by the user as a slash command. - [JsonPropertyName("userInvocable")] - public bool UserInvocable { get; set; } + /// Target session identifier. + [JsonPropertyName("sessionId")] + public string SessionId { get; set; } = string.Empty; } -/// Skills available to the session, with their enabled state. +/// Options for an internal tool-originated factory invocation. [Experimental(Diagnostics.Experimental)] -public sealed class SkillList +internal sealed class FactoryToolRunOptions { - /// Available skills. - [JsonPropertyName("skills")] - public IList Skills { get => field ??= []; set; } + /// 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; } } -/// Identifies the target session. +/// Internal parameters for invoking a registered factory from a tool. [Experimental(Diagnostics.Experimental)] -internal sealed class SessionSkillsListRequest +internal sealed class FactoryToolRunRequest { + /// Factory input value. + [JsonPropertyName("args")] + public JsonElement Args { get; set; } + + /// Registered factory name. + [JsonPropertyName("name")] + public string Name { get; set; } = string.Empty; + + /// Tool-originated factory invocation options. + [JsonPropertyName("options")] + public FactoryToolRunOptions? Options { get; set; } + /// Target session identifier. [JsonPropertyName("sessionId")] public string SessionId { get; set; } = string.Empty; + + /// Opaque identifier of the originating tool call. + [JsonPropertyName("toolCallId")] + public string? ToolCallId { get; set; } } -/// Skill invocation record with name, path, content, allowed tools, and turn number. +/// Internal parameters for resuming a factory run from a tool. [Experimental(Diagnostics.Experimental)] -public sealed class SkillsInvokedSkill +internal sealed class FactoryToolResumeRequest { - /// Tools that should be auto-approved when this skill is active, captured at invocation time. - [JsonPropertyName("allowedTools")] - public IList? AllowedTools { get; set; } + /// Optional per-invocation resource ceiling overrides. + [JsonPropertyName("limits")] + public FactoryRunLimits? Limits { get; set; } - /// Full content of the skill file. - [JsonPropertyName("content")] - public string Content { get; set; } = string.Empty; - - /// Turn number when the skill was invoked. - [JsonPropertyName("invokedAtTurn")] - public long InvokedAtTurn { get; set; } - - /// Unique identifier for the skill. - [JsonPropertyName("name")] - public string Name { get; set; } = string.Empty; - - /// Path to the SKILL.md file. - [JsonPropertyName("path")] - public string Path { get; set; } = string.Empty; -} - -/// Skills invoked during this session, ordered by invocation time (most recent last). -[Experimental(Diagnostics.Experimental)] -public sealed class SkillsGetInvokedResult -{ - /// Skills invoked during this session, ordered by invocation time (most recent last). - [JsonPropertyName("skills")] - public IList Skills { get => field ??= []; set; } -} + /// Factory run identifier. + [JsonPropertyName("runId")] + public string RunId { get; set; } = string.Empty; -/// Identifies the target session. -[Experimental(Diagnostics.Experimental)] -internal sealed class SessionSkillsGetInvokedRequest -{ /// Target session identifier. [JsonPropertyName("sessionId")] public string SessionId { get; set; } = string.Empty; + + /// Opaque identifier of the originating tool call. + [JsonPropertyName("toolCallId")] + public string? ToolCallId { get; set; } } -/// Name of the skill to enable for the session. +/// Parameters for retrieving a factory run. [Experimental(Diagnostics.Experimental)] -internal sealed class SkillsEnableRequest +internal sealed class FactoryGetRunRequest { - /// Name of the skill to enable. - [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; } -/// Name of the skill to disable for the session. +/// Declared or approved factory resource ceilings. [Experimental(Diagnostics.Experimental)] -internal sealed class SkillsDisableRequest +public sealed class FactoryDeclaredLimits { - /// Name of the skill to disable. - [JsonPropertyName("name")] - public string Name { get; set; } = string.Empty; + /// Maximum AI credits consumed by subagents and descendants. + [JsonPropertyName("maxAiCredits")] + public double? MaxAiCredits { get; set; } - /// Target session identifier. - [JsonPropertyName("sessionId")] - public string SessionId { get; set; } = string.Empty; -} + /// Maximum concurrently active subagents. + [JsonPropertyName("maxConcurrentSubagents")] + public long? MaxConcurrentSubagents { get; set; } -/// Diagnostics from reloading skill definitions, with warnings and errors as separate lists. -[Experimental(Diagnostics.Experimental)] -public sealed class SkillsLoadDiagnostics -{ - /// Errors emitted while loading skills (e.g. skills that failed to load entirely). - [JsonPropertyName("errors")] - public IList Errors { get => field ??= []; set; } + /// Maximum total subagents spawned by the run. + [JsonPropertyName("maxTotalSubagents")] + public long? MaxTotalSubagents { get; set; } - /// Warnings emitted while loading skills (e.g. skills that loaded but had issues). - [JsonPropertyName("warnings")] - public IList Warnings { get => field ??= []; set; } + /// Maximum accumulated active execution time in seconds. + [JsonPropertyName("timeoutSeconds")] + public double? TimeoutSeconds { get; set; } } -/// Identifies the target session. +/// Durable factory resource consumption. [Experimental(Diagnostics.Experimental)] -internal sealed class SessionSkillsReloadRequest +public sealed class FactoryRunConsumed { - /// Target session identifier. - [JsonPropertyName("sessionId")] - public string SessionId { get; set; } = string.Empty; -} + /// Accumulated active execution time in milliseconds. + [JsonPropertyName("activeMs")] + public long ActiveMs { 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; + /// AI usage consumed by the run in nano-AIU. + [JsonPropertyName("nanoAiu")] + public long NanoAiu { get; set; } + + /// Total subagents spawned by the run. + [JsonPropertyName("subagents")] + public long Subagents { get; set; } } -/// Recorded MCP server connection failure. +/// Current factory phase identity. [Experimental(Diagnostics.Experimental)] -public sealed class McpServerFailureInfo +public sealed class FactoryCurrentPhase { - /// Failure message produced when the MCP server connection failed. - [JsonPropertyName("message")] - public string Message { get; set; } = string.Empty; + /// Current phase identifier. + [JsonPropertyName("id")] + public string Id { get; set; } = string.Empty; - /// epoch-ms timestamp at which the failure was recorded. - [JsonPropertyName("timestamp")] - public long Timestamp { get; set; } + /// Zero-based declared phase ordinal, or null for an undeclared phase. + [JsonPropertyName("ordinal")] + public long? Ordinal { get; set; } } -/// Recorded MCP server pending-auth state. +/// Prompt-safe terminal factory outcome. [Experimental(Diagnostics.Experimental)] -public sealed class McpServerNeedsAuthInfo +public sealed class FactoryRunTerminal { - /// epoch-ms timestamp at which the server signalled it needs authentication. - [JsonPropertyName("timestamp")] - public long Timestamp { get; set; } + /// Human-readable terminal error. + [JsonPropertyName("error")] + public string? Error { get; set; } + + /// Machine-readable terminal failure. + [JsonPropertyName("failure")] + public FactoryRunFailure? Failure { get; set; } + + /// Human-readable terminal reason. + [JsonPropertyName("reason")] + public string? Reason { get; set; } + + /// Prompt-safe preview of the completed result. + [JsonPropertyName("resultPreview")] + public string? ResultPreview { get; set; } } -/// Host-level state, omitted when no MCP host is initialized. +/// Durable factory run summary with read-time live overlays. [Experimental(Diagnostics.Experimental)] -public sealed class McpHostState +public sealed class FactoryRunSummary { - /// Names of currently-connected MCP clients. - [JsonPropertyName("clients")] - public IList Clients { get => field ??= []; set; } + /// Epoch milliseconds when the current active segment started, or null while inactive. + [JsonPropertyName("activeSegmentStartedAt")] + public long? ActiveSegmentStartedAt { get; set; } - /// Configured servers that are explicitly disabled. - [JsonPropertyName("disabledServers")] - public IList DisabledServers { get => field ??= []; set; } + /// Approved effective resource ceilings, or null until approved. + [JsonPropertyName("approved")] + public FactoryDeclaredLimits? Approved { get; set; } - /// Map of server name to recorded connection failure. - [JsonPropertyName("failedServers")] - public IDictionary FailedServers { get => field ??= new Dictionary(); set; } + /// Epoch milliseconds when the run completed, or null while nonterminal. + [JsonPropertyName("completedAt")] + public long? CompletedAt { get; set; } - /// Configured servers filtered out by enterprise allowlist policy. - [JsonPropertyName("filteredServers")] - public IList FilteredServers { get => field ??= []; set; } + /// Durable resource consumption. + [JsonPropertyName("consumed")] + public FactoryRunConsumed Consumed { get => field ??= new(); set; } - /// Whether third-party MCP servers are policy-enabled for this session. - [JsonPropertyName("mcp3pEnabled")] - public bool Mcp3pEnabled { get; set; } + /// Epoch milliseconds when the run was created. + [JsonPropertyName("createdAt")] + public long CreatedAt { get; set; } - /// Map of server name to recorded pending-auth state. - [JsonPropertyName("needsAuthServers")] - public IDictionary NeedsAuthServers { get => field ??= new Dictionary(); set; } + /// Current phase identity, or null before any phase is entered. + [JsonPropertyName("currentPhase")] + public FactoryCurrentPhase? CurrentPhase { get; set; } - /// Names of servers with in-flight connection attempts. - [JsonPropertyName("pendingConnections")] - public IList PendingConnections { get => field ??= []; set; } -} + /// Resource ceilings declared by the factory. + [JsonPropertyName("declaredLimits")] + public FactoryDeclaredLimits DeclaredLimits { get => field ??= new(); set; } -/// MCP server status entry, including config source/plugin source and any connection error. -[Experimental(Diagnostics.Experimental)] -public sealed class McpServer -{ - /// Error message if the server failed to connect. - [JsonPropertyName("error")] - public string? Error { get; set; } + /// Number of phases declared by the factory. + [JsonPropertyName("declaredPhaseCount")] + public long DeclaredPhaseCount { 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; + /// Human-readable factory description. + [JsonPropertyName("description")] + public string Description { get; set; } = string.Empty; - /// Configuration source: user, workspace, plugin, or builtin. - [JsonPropertyName("source")] - public McpServerSource? Source { get; set; } + /// Registered factory name. + [JsonPropertyName("factoryName")] + public string FactoryName { get; set; } = string.Empty; - /// Plugin name that provided this server, when source is plugin. - [JsonPropertyName("sourcePlugin")] - public string? SourcePlugin { get; set; } + /// Number of direct factory agents currently live. + [JsonPropertyName("liveAgentCount")] + public long LiveAgentCount { get; set; } - /// Plugin version that provided this server, when source is plugin. - [JsonPropertyName("sourcePluginVersion")] - public string? SourcePluginVersion { get; set; } + /// Epoch milliseconds when this live-overlay snapshot was observed. + [JsonPropertyName("observedAt")] + public long ObservedAt { get; set; } - /// Connection status: connected, failed, needs-auth, pending, disabled, or not_configured. - [JsonPropertyName("status")] - public McpServerStatus Status { get; set; } -} + /// Monotonic durable run revision. + [JsonPropertyName("revision")] + public long Revision { get; set; } -/// MCP servers configured for the session, with their connection status and host-level state. -[Experimental(Diagnostics.Experimental)] -public sealed class McpServerList -{ - /// Host-level state, omitted when no MCP host is initialized. - [JsonPropertyName("host")] - public McpHostState? Host { get; set; } + /// Factory run identifier. + [JsonPropertyName("runId")] + public string RunId { get; set; } = string.Empty; - /// Configured MCP servers. - [JsonPropertyName("servers")] - public IList Servers { get => field ??= []; set; } -} + /// Epoch milliseconds when execution first started, or null before start. + [JsonPropertyName("startedAt")] + public long? StartedAt { get; set; } -/// Identifies the target session. -[Experimental(Diagnostics.Experimental)] -internal sealed class SessionMcpListRequest -{ - /// Target session identifier. - [JsonPropertyName("sessionId")] - public string SessionId { get; set; } = string.Empty; -} + /// Current factory run status. + [JsonPropertyName("status")] + public FactoryRunStatus Status { get; set; } -/// Normalized MCP Apps discovery metadata from a tool's `_meta.ui` block. -[Experimental(Diagnostics.Experimental)] -public sealed class 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. - [JsonPropertyName("resourceUri")] - public string? ResourceUri { get; set; } + /// Terminal run outcome, or null while nonterminal. + [JsonPropertyName("terminal")] + public FactoryRunTerminal? Terminal { get; set; } - /// Tool visibility advertised by the server. When absent, MCP Apps defaults apply. - [JsonPropertyName("visibility")] - public IList? Visibility { get; set; } + /// Total direct factory agents spawned across all attempts. + [JsonPropertyName("totalSpawnedAgentCount")] + public long TotalSpawnedAgentCount { get; set; } + + /// Epoch milliseconds when the durable run was last updated. + [JsonPropertyName("updatedAt")] + public long UpdatedAt { get; set; } } -/// MCP tool metadata with tool name, optional description, and normalized MCP Apps discovery metadata. +/// A page of factory runs in durable creation order. [Experimental(Diagnostics.Experimental)] -public sealed class McpTools +public sealed class FactoryListRunsResult { - /// Tool description, when provided. - [JsonPropertyName("description")] - public string? Description { get; set; } + /// Whether terminal runs newer than this page exist. + [JsonPropertyName("hasMoreNewer")] + public bool? HasMoreNewer { get; set; } - /// Tool name. - [JsonPropertyName("name")] - public string Name { get; set; } = string.Empty; + /// Newest terminal-run cursor in this page, or null when the terminal window is empty. + [JsonPropertyName("newestSeq")] + public long? NewestSeq { get; set; } - /// 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; } -} + /// Oldest terminal-run cursor in this page, or null when the terminal window is empty. + [JsonPropertyName("oldestSeq")] + public long? OldestSeq { get; set; } -/// Tools exposed by the connected MCP server. Throws when the server is not connected. -[Experimental(Diagnostics.Experimental)] -public sealed class McpListToolsResult -{ - /// Tools exposed by the server. - [JsonPropertyName("tools")] - public IList Tools { get => field ??= []; set; } + /// Number of terminal runs older than this page. + [JsonPropertyName("omittedOlder")] + public long? OmittedOlder { get; set; } + + /// Factory run summaries in durable creation order. + [JsonPropertyName("runs")] + public IList Runs { get => field ??= []; set; } } -/// Server name whose tool list should be returned. +/// Parameters for paging factory runs. [Experimental(Diagnostics.Experimental)] -internal sealed class McpListToolsRequest +internal sealed class FactoryListRunsRequest { - /// 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; + /// Exclusive forward cursor. + [JsonPropertyName("afterSeq")] + public long? AfterSeq { get; set; } - /// Target session identifier. - [JsonPropertyName("sessionId")] - public string SessionId { get; set; } = string.Empty; -} + /// Exclusive backward cursor. + [JsonPropertyName("beforeSeq")] + public long? BeforeSeq { get; set; } -/// Name of the MCP server to enable for the session. -[Experimental(Diagnostics.Experimental)] -internal sealed class McpEnableRequest -{ - /// 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; + /// 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; } -/// Name of the MCP server to disable for the session. +/// Prompt-safe durable identity and live status for a direct factory agent. [Experimental(Diagnostics.Experimental)] -internal sealed class McpDisableRequest +public sealed class FactoryAgentSummary { - /// 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; + /// Accumulated active agent time in milliseconds. + [JsonPropertyName("activeMs")] + public long ActiveMs { get; set; } - /// Target session identifier. - [JsonPropertyName("sessionId")] - public string SessionId { get; set; } = string.Empty; -} + /// Prompt-safe live activity text. + [JsonPropertyName("activity")] + public string? Activity { get; set; } -/// Identifies the target session. -[Experimental(Diagnostics.Experimental)] -internal sealed class SessionMcpReloadRequest -{ - /// Target session identifier. - [JsonPropertyName("sessionId")] - public string SessionId { get; set; } = string.Empty; -} + /// Stable direct-agent identifier. + [JsonPropertyName("agentId")] + public string AgentId { get; set; } = string.Empty; -/// MCP server allowed by policy, with server name and optional PII-free explanatory note. -[Experimental(Diagnostics.Experimental)] -public sealed class McpAllowedServer -{ - /// Allowed server name. - [JsonPropertyName("name")] - public string Name { get; set; } = string.Empty; + /// Registered agent type. + [JsonPropertyName("agentType")] + public string AgentType { get; set; } = string.Empty; - /// PII-free note explaining why the server was allowed. - [JsonPropertyName("redactedNote")] - public string? RedactedNote { get; set; } -} + /// Epoch milliseconds when the agent completed. + [JsonPropertyName("completedAt")] + public long? CompletedAt { get; set; } -/// MCP server filtered by policy, with name, reason, optional redacted reason, and enterprise login. -[Experimental(Diagnostics.Experimental)] -public sealed class McpFilteredServer -{ - /// Enterprise login associated with an allowlist policy. - [JsonPropertyName("enterpriseName")] - public string? EnterpriseName { get; set; } + /// Friendly, non-unique name intended for display. + [JsonPropertyName("displayName")] + public string? DisplayName { get; set; } - /// Filtered server name. - [JsonPropertyName("name")] - public string Name { get; set; } = string.Empty; + /// Friendly, non-unique name intended for display. + [JsonPropertyName("label")] + public string Label { get; set; } = string.Empty; - /// Human-readable filter reason. - [JsonPropertyName("reason")] - public string Reason { get; set; } = string.Empty; + /// Phase identifier active when the agent was launched, or null. + [JsonPropertyName("phaseId")] + public string? PhaseId { get; set; } - /// PII-free filter reason. - [JsonPropertyName("redactedReason")] - public string? RedactedReason { get; set; } -} + /// Model requested when the agent was launched. + [JsonPropertyName("requestedModel")] + public string? RequestedModel { 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; } + /// Concrete model resolved for the agent. + [JsonPropertyName("resolvedModel")] + public string? ResolvedModel { get; set; } - /// Servers filtered out before startup. - [JsonPropertyName("filteredServers")] - public IList FilteredServers { get => field ??= []; set; } + /// Owning factory run identifier. + [JsonPropertyName("runId")] + public string RunId { get; set; } = string.Empty; + + /// Epoch milliseconds when the agent started. + [JsonPropertyName("startedAt")] + public long? StartedAt { get; set; } + + /// Current durable or live agent status. + [JsonPropertyName("status")] + public string Status { get; set; } = string.Empty; + + /// Tool-call identifier that launched the agent. + [JsonPropertyName("toolCallId")] + public string ToolCallId { get; set; } = string.Empty; } -/// Opaque MCP reload configuration. +/// Durable lifecycle and timing for one factory phase. [Experimental(Diagnostics.Experimental)] -internal sealed class McpReloadWithConfigRequest +public sealed class FactoryPhaseObservation { - /// Opaque runtime MCP reload configuration. Marked internal: an in-process runtime shape (reloadMcpServers throws over the wire). - [JsonInclude] - [JsonPropertyName("config")] - internal JsonElement Config { get; set; } + /// Completed active time accumulated by this phase in milliseconds. + [JsonPropertyName("accumulatedActiveMs")] + public long AccumulatedActiveMs { get; set; } - /// Target session identifier. - [JsonPropertyName("sessionId")] - public string SessionId { get; set; } = string.Empty; + /// Epoch milliseconds when this phase completed; for a skipped phase, the synthetic skip timestamp (equal to `startedAt`). + [JsonPropertyName("completedAt")] + public long? CompletedAt { get; set; } + + /// Current live active time for this phase in milliseconds. + [JsonPropertyName("currentActiveMs")] + public long CurrentActiveMs { get; set; } + + /// Optional human-readable phase detail. + [JsonPropertyName("detail")] + public string? Detail { get; set; } + + /// Number of times execution entered this phase. + [JsonPropertyName("entryCount")] + public long EntryCount { get; set; } + + /// Phase identifier. + [JsonPropertyName("id")] + public string Id { get; set; } = string.Empty; + + /// Most recent run attempt that entered this phase, or `0` if the phase has never been entered. + [JsonPropertyName("lastEnteredRunAttempt")] + public long LastEnteredRunAttempt { get; set; } + + /// Direct agents in this phase that are currently live. + [JsonPropertyName("liveAgentCount")] + public long LiveAgentCount { get; set; } + + /// Zero-based declared phase ordinal, or null for an undeclared phase. + [JsonPropertyName("ordinal")] + public long? Ordinal { get; set; } + + /// Epoch milliseconds when this phase first started; for a skipped phase, the synthetic skip timestamp (equal to `completedAt`). + [JsonPropertyName("startedAt")] + public long? StartedAt { get; set; } + + /// Derived lifecycle state of the phase. + [JsonPropertyName("status")] + public FactoryPhaseStatus Status { get; set; } + + /// Human-readable phase title. + [JsonPropertyName("title")] + public string Title { get; set; } = string.Empty; + + /// Total direct agents associated with this phase. + [JsonPropertyName("totalAgentCount")] + public long TotalAgentCount { 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. +/// One durable factory progress record. [Experimental(Diagnostics.Experimental)] -public sealed class McpExecuteSamplingResult +public sealed class FactoryProgressLine { + /// 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; } -/// Outcome of an MCP sampling execution: success result, failure error, or cancellation. +/// A bidirectional page of factory progress. [Experimental(Diagnostics.Experimental)] -public sealed class McpSamplingExecutionResult +public sealed class FactoryProgressPage { - /// 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; } + /// Whether progress records newer than this page exist. + [JsonPropertyName("hasMoreNewer")] + public bool HasMoreNewer { get; set; } - /// Error description, present when action='failure'. - [JsonPropertyName("error")] - public string? Error { get; set; } + /// Whether progress records older than this page exist. + [JsonPropertyName("hasMoreOlder")] + public bool HasMoreOlder { 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; } + /// Newest sequence number in this page, or null when empty. + [JsonPropertyName("newestSeq")] + public long? NewestSeq { get; set; } + + /// Oldest sequence number in this page, or null when empty. + [JsonPropertyName("oldestSeq")] + public long? OldestSeq { get; set; } + + /// Progress records in sequence order. + [JsonPropertyName("records")] + public IList Records { get => field ??= []; set; } + + /// Run revision reflected by this page. + [JsonPropertyName("revision")] + public long Revision { 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. +/// Full factory run observability detail. [Experimental(Diagnostics.Experimental)] -public sealed class McpExecuteSamplingRequest +public sealed class FactoryRunDetail { + /// Epoch milliseconds when the current active segment started, or null while inactive. + [JsonPropertyName("activeSegmentStartedAt")] + public long? ActiveSegmentStartedAt { get; set; } + + /// Durable identities and live statuses for direct factory agents. + [JsonPropertyName("agents")] + public IList Agents { get => field ??= []; set; } + + /// Approved effective resource ceilings, or null until approved. + [JsonPropertyName("approved")] + public FactoryDeclaredLimits? Approved { get; set; } + + /// Epoch milliseconds when the run completed, or null while nonterminal. + [JsonPropertyName("completedAt")] + public long? CompletedAt { get; set; } + + /// Durable resource consumption. + [JsonPropertyName("consumed")] + public FactoryRunConsumed Consumed { get => field ??= new(); set; } + + /// Epoch milliseconds when the run was created. + [JsonPropertyName("createdAt")] + public long CreatedAt { get; set; } + + /// Current phase identity, or null before any phase is entered. + [JsonPropertyName("currentPhase")] + public FactoryCurrentPhase? CurrentPhase { get; set; } + + /// Resource ceilings declared by the factory. + [JsonPropertyName("declaredLimits")] + public FactoryDeclaredLimits DeclaredLimits { get => field ??= new(); set; } + + /// Number of phases declared by the factory. + [JsonPropertyName("declaredPhaseCount")] + public long DeclaredPhaseCount { get; set; } + + /// Human-readable factory description. + [JsonPropertyName("description")] + public string Description { get; set; } = string.Empty; + + /// Registered factory name. + [JsonPropertyName("factoryName")] + public string FactoryName { get; set; } = string.Empty; + + /// Number of direct factory agents currently live. + [JsonPropertyName("liveAgentCount")] + public long LiveAgentCount { get; set; } + + /// Epoch milliseconds when this live-overlay snapshot was observed. + [JsonPropertyName("observedAt")] + public long ObservedAt { get; set; } + + /// Lifecycle and timing observations for each factory phase. + [JsonPropertyName("phases")] + public IList Phases { get => field ??= []; set; } + + /// Bidirectional page of durable factory progress. + [JsonPropertyName("progress")] + public FactoryProgressPage Progress { get => field ??= new(); set; } + + /// Monotonic durable run revision. + [JsonPropertyName("revision")] + public long Revision { get; set; } + + /// Factory run identifier. + [JsonPropertyName("runId")] + public string RunId { get; set; } = string.Empty; + + /// Epoch milliseconds when execution first started, or null before start. + [JsonPropertyName("startedAt")] + public long? StartedAt { get; set; } + + /// Current factory run status. + [JsonPropertyName("status")] + public FactoryRunStatus Status { get; set; } + + /// Terminal run outcome, or null while nonterminal. + [JsonPropertyName("terminal")] + public FactoryRunTerminal? Terminal { get; set; } + + /// Total direct factory agents spawned across all attempts. + [JsonPropertyName("totalSpawnedAgentCount")] + public long TotalSpawnedAgentCount { get; set; } + + /// Epoch milliseconds when the durable run was last updated. + [JsonPropertyName("updatedAt")] + public long UpdatedAt { get; set; } } -/// Identifiers and raw MCP CreateMessageRequest params used to run a sampling inference. +/// Parameters for paging factory progress. [Experimental(Diagnostics.Experimental)] -internal sealed class McpExecuteSamplingParams +internal sealed class FactoryGetRunProgressRequest { - /// 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; } + /// Exclusive forward cursor. + [JsonPropertyName("afterSeq")] + public long? AfterSeq { 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; } + /// Exclusive backward cursor. + [JsonPropertyName("beforeSeq")] + public long? BeforeSeq { 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; + /// Maximum records to return. Defaults to 200 and is capped at 500. + [JsonPropertyName("limit")] + public int? Limit { get; set; } - /// Name of the MCP server that initiated the sampling request. - [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; } -/// Indicates whether an in-flight sampling execution with the given requestId was found and cancelled. -[Experimental(Diagnostics.Experimental)] -public sealed class 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). - [JsonPropertyName("cancelled")] - public bool Cancelled { get; set; } -} - -/// The requestId previously passed to executeSampling that should be cancelled. +/// Parameters for cancelling a factory run. [Experimental(Diagnostics.Experimental)] -internal sealed class McpCancelSamplingExecutionParams +internal sealed class FactoryCancelRequest { - /// The requestId previously passed to executeSampling that should be cancelled. - [JsonPropertyName("requestId")] - public string RequestId { 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; } -/// Env-value mode recorded on the session after the update. +/// Acknowledgement that a factory request was accepted. [Experimental(Diagnostics.Experimental)] -public sealed class McpSetEnvValueModeResult +public sealed class FactoryAckResult { - /// Mode recorded on the session after the update. - [JsonPropertyName("mode")] - public McpSetEnvValueModeDetails Mode { get; set; } } -/// Mode controlling how MCP server env values are resolved (`direct` or `indirect`). +/// One ordered factory progress line. [Experimental(Diagnostics.Experimental)] -internal sealed class McpSetEnvValueModeParams +public sealed class FactoryLogLine { - /// 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; } + /// Progress line kind. + [JsonPropertyName("kind")] + public FactoryLogLineKind Kind { get; set; } - /// Target session identifier. - [JsonPropertyName("sessionId")] - public string SessionId { get; set; } = string.Empty; -} + /// Monotonic sequence number within the factory run. + [JsonPropertyName("seq")] + public long Seq { get; set; } -/// Indicates whether the auto-managed `github` MCP server was removed (false when nothing to remove). -[Experimental(Diagnostics.Experimental)] -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; } + /// Progress text. + [JsonPropertyName("text")] + public string Text { get; set; } = string.Empty; } -/// Identifies the target session. +/// Parameters for recording factory progress. [Experimental(Diagnostics.Experimental)] -internal sealed class SessionMcpRemoveGitHubRequest +internal sealed class FactoryLogRequest { + /// 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; } -/// Result of configuring GitHub MCP. +/// Result of one factory-scoped subagent call. [Experimental(Diagnostics.Experimental)] -internal sealed class McpConfigureGitHubResult +public sealed class FactoryAgentResult { - /// Whether GitHub MCP configuration changed. - [JsonPropertyName("changed")] - public bool Changed { get; set; } + /// Agent result, omitted when the agent produced no result. + [JsonPropertyName("result")] + public JsonElement? Result { get; set; } } -/// Opaque auth info used to configure GitHub MCP. +/// Options for one factory-scoped subagent call. [Experimental(Diagnostics.Experimental)] -internal sealed class McpConfigureGitHubRequest +public sealed class FactoryAgentOptions { - /// Opaque runtime auth info for GitHub MCP configuration. Marked internal: an in-process runtime shape (configureGitHubMcp is a no-op over the wire). - [JsonInclude] - [JsonPropertyName("authInfo")] - internal JsonElement AuthInfo { get; set; } + /// Optional custom agent name for the subagent. This field is accepted but not yet honored. + [JsonPropertyName("agent")] + public string? Agent { get; set; } - /// Target session identifier. - [JsonPropertyName("sessionId")] - public string SessionId { 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; } -/// Server name and configuration for an individual MCP server start. -[Experimental(Diagnostics.Experimental)] -internal sealed class McpStartServerRequest -{ - /// MCP server configuration (stdio process or remote HTTP/SSE). - [JsonPropertyName("config")] - public JsonElement Config { get; set; } + /// Optional label distinguishing otherwise identical memoized agent calls. + [JsonPropertyName("label")] + public string? Label { get; set; } - /// Name of the MCP server to start. - [JsonPropertyName("serverName")] - public string ServerName { get; set; } = string.Empty; + /// Optional model identifier for the subagent. + [JsonPropertyName("model")] + public string? Model { get; set; } - /// Target session identifier. - [JsonPropertyName("sessionId")] - public string SessionId { get; set; } = string.Empty; + /// 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; } } -/// 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. +/// Parameters for one factory-scoped subagent call. [Experimental(Diagnostics.Experimental)] -internal sealed class McpRestartServerRequest +internal sealed class FactoryAgentRequest { - /// 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; } + /// Opaque token identifying the current factory execution attempt. + [JsonPropertyName("executionToken")] + public string ExecutionToken { get; set; } = string.Empty; - /// Name of the MCP server to restart. - [JsonPropertyName("serverName")] - public string ServerName { get; set; } = string.Empty; + /// Factory run identifier that owns the subagent. + [JsonPropertyName("factoryRunId")] + public string FactoryRunId { 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; } -/// Server name for an individual MCP server stop. +/// Result of reading a factory journal entry. [Experimental(Diagnostics.Experimental)] -internal sealed class McpStopServerRequest +public sealed class FactoryJournalGetResult { - /// Name of the MCP server to stop. - [JsonPropertyName("serverName")] - public string ServerName { get; set; } = string.Empty; + /// Whether the journal contained the requested key. + [JsonPropertyName("hit")] + public bool Hit { get; set; } - /// Target session identifier. - [JsonPropertyName("sessionId")] - public string SessionId { get; set; } = string.Empty; + /// Cached JSON result. The hit field distinguishes a cached JSON null from a miss. + [JsonPropertyName("resultJson")] + public JsonElement? ResultJson { get; set; } } -/// Registration parameters for an external MCP client. +/// Parameters for reading a factory journal entry. [Experimental(Diagnostics.Experimental)] -internal sealed class McpRegisterExternalClientRequest +internal sealed class FactoryJournalGetRequest { - /// In-process MCP Client instance. Marked internal: cannot be serialized across the JSON-RPC boundary. - [JsonInclude] - [JsonPropertyName("client")] - internal JsonElement Client { get; set; } + /// Opaque token identifying the current factory execution attempt. + [JsonPropertyName("executionToken")] + public string ExecutionToken { get; set; } = string.Empty; - /// In-process server config (MCPServerConfig) paired with the in-process client/transport. Marked internal alongside its companions. - [JsonInclude] - [JsonPropertyName("config")] - internal JsonElement Config { get; set; } + /// Namespaced journal key. + [JsonPropertyName("key")] + public string Key { get; set; } = string.Empty; - /// Logical server name for the external client. - [JsonPropertyName("serverName")] - public string ServerName { 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; - - /// In-process MCP Transport instance. Marked internal: cannot be serialized across the JSON-RPC boundary. - [JsonInclude] - [JsonPropertyName("transport")] - internal JsonElement Transport { get; set; } } -/// Server name identifying the external client to remove. +/// Parameters for storing a factory journal entry. [Experimental(Diagnostics.Experimental)] -internal sealed class McpUnregisterExternalClientRequest +internal sealed class FactoryJournalPutRequest { - /// Server name of the external client to unregister. - [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; + + /// Namespaced journal key. + [JsonPropertyName("key")] + public string Key { get; set; } = string.Empty; + + /// JSON result to memoize. + [JsonPropertyName("resultJson")] + public JsonElement ResultJson { 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; } -/// Whether the named MCP server is running. +/// 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 McpIsServerRunningResult +public sealed class CurrentModel { - /// True if the server has an active client and transport. - [JsonPropertyName("running")] - public bool Running { get; 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; } } -/// Server name to check running status for. +/// Identifies the target session. [Experimental(Diagnostics.Experimental)] -internal sealed class McpIsServerRunningRequest +internal sealed class SessionModelGetCurrentRequest { - /// 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; } -/// Indicates whether the pending MCP OAuth response was accepted. +/// RPC data type for ModelSwitchConfirmation operations. [Experimental(Diagnostics.Experimental)] -public sealed class McpOauthHandlePendingResult +public sealed class ModelSwitchConfirmation { - /// Whether the response was accepted. False if the request was unknown, timed out, or already resolved. - [JsonPropertyName("success")] - public bool Success { get; set; } + /// Current conversation token count before switching models. + [JsonPropertyName("currentTokens")] + public double CurrentTokens { get; set; } + + /// Target model token limit used by the compaction preflight. + [JsonPropertyName("targetLimit")] + public double TargetLimit { get; set; } + + /// Display name of the model that requires compaction confirmation. + [JsonPropertyName("targetModelDisplayName")] + public string TargetModelDisplayName { get; set; } = string.Empty; } -/// Host response to the pending OAuth request. -/// Polymorphic base type discriminated by kind. +/// The model identifier active on the session after the switch. [Experimental(Diagnostics.Experimental)] -[JsonPolymorphic( - TypeDiscriminatorPropertyName = "kind", - UnknownDerivedTypeHandling = JsonUnknownDerivedTypeHandling.FallBackToBaseType)] -[JsonDerivedType(typeof(McpOauthPendingRequestResponseToken), "token")] -[JsonDerivedType(typeof(McpOauthPendingRequestResponseCancelled), "cancelled")] -public partial class McpOauthPendingRequestResponse +public sealed class ModelSwitchToResult { - /// The type discriminator. - [JsonPropertyName("kind")] - public virtual string Kind { get; set; } = string.Empty; -} + /// Compaction confirmation projection when status is confirmation_required. + [JsonPropertyName("confirmation")] + public ModelSwitchConfirmation? Confirmation { 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; } -/// The token variant of . -[Experimental(Diagnostics.Experimental)] -public partial class McpOauthPendingRequestResponseToken : McpOauthPendingRequestResponse -{ - /// - [JsonIgnore] - public override string Kind => "token"; + /// Deprecation warnings associated with the selected model or options. + [JsonPropertyName("deprecationWarnings")] + public IList? DeprecationWarnings { get; set; } - /// Access token acquired by the SDK host. - [JsonPropertyName("accessToken")] - public required string AccessToken { get; set; } + /// User-facing outcome message for the model switch. + [JsonPropertyName("message")] + public string? Message { get; set; } - /// Token lifetime in seconds, if known. - [JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)] - [JsonPropertyName("expiresIn")] - public long? ExpiresIn { get; set; } + /// Currently active model identifier after the switch. + [JsonPropertyName("modelId")] + public string? ModelId { get; set; } - /// OAuth token type. Defaults to Bearer when omitted. - [JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)] - [JsonPropertyName("tokenType")] - public string? TokenType { get; set; } + /// Persistence failure encountered after applying the model switch. + [JsonPropertyName("persistenceError")] + public string? PersistenceError { get; set; } + + /// Lifecycle result for the requested switch. + [JsonPropertyName("status")] + public string? Status { get; set; } + + /// User-facing warning produced while applying the model switch. + [JsonPropertyName("warning")] + public string? Warning { get; set; } } -/// The cancelled variant of . +/// Vision-specific limits. [Experimental(Diagnostics.Experimental)] -public partial class McpOauthPendingRequestResponseCancelled : McpOauthPendingRequestResponse +public sealed class ModelCapabilitiesOverrideLimitsVision { - /// - [JsonIgnore] - public override string Kind => "cancelled"; + /// 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; } } -/// Pending MCP OAuth request ID and host-provided token or cancellation response. +/// Token limits for prompts, outputs, and context window. [Experimental(Diagnostics.Experimental)] -internal sealed class McpOauthHandlePendingRequest +public sealed class ModelCapabilitiesOverrideLimits { - /// OAuth request identifier from the mcp.oauth_required event. - [JsonPropertyName("requestId")] - public string RequestId { get; set; } = string.Empty; + /// Maximum total context window size in tokens. + [JsonPropertyName("max_context_window_tokens")] + public long? MaxContextWindowTokens { get; set; } - /// Host response to the pending OAuth request. - [JsonPropertyName("result")] - public McpOauthPendingRequestResponse Result { get => field ??= new(); set; } + /// Maximum number of output/completion tokens. + [JsonPropertyName("max_output_tokens")] + public long? MaxOutputTokens { get; set; } - /// Target session identifier. - [JsonPropertyName("sessionId")] - public string SessionId { get; set; } = string.Empty; + /// 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; } } -/// OAuth authorization URL the caller should open, or empty when cached tokens already authenticated the server. +/// Feature flags indicating what the model supports. [Experimental(Diagnostics.Experimental)] -public sealed class McpOauthLoginResult +public sealed class ModelCapabilitiesOverrideSupports { - /// 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; } + /// 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; } + + /// Whether this model supports vision/image input. + [JsonPropertyName("vision")] + public bool? Vision { get; set; } } -/// Remote MCP server name and optional overrides controlling reauthentication, OAuth client display name, callback success-page copy, and static OAuth client selection. +/// Optional capability overrides (vision, tool_calls, reasoning, etc.). [Experimental(Diagnostics.Experimental)] -internal sealed class McpOauthLoginRequest +public sealed class ModelCapabilitiesOverride { - /// 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; } - - /// 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; } + /// Token limits for prompts, outputs, and context window. + [JsonPropertyName("limits")] + public ModelCapabilitiesOverrideLimits? Limits { 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; } - - /// 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; + /// Feature flags indicating what the model supports. + [JsonPropertyName("supports")] + public ModelCapabilitiesOverrideSupports? Supports { get; set; } } -/// Indicates whether the pending MCP headers refresh response was accepted. -[Experimental(Diagnostics.Experimental)] -public sealed class McpHeadersHandlePendingHeadersRefreshRequestResult +/// Environment variables consulted while resolving model-picker settings. +public sealed class ModelPickerSettingsContextEnvironment { - /// 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. +/// Filesystem and environment context used to resolve model-picker settings. [Experimental(Diagnostics.Experimental)] -[JsonPolymorphic( - TypeDiscriminatorPropertyName = "kind", - UnknownDerivedTypeHandling = JsonUnknownDerivedTypeHandling.FallBackToBaseType)] -[JsonDerivedType(typeof(McpHeadersHandlePendingHeadersRefreshRequestHeaders), "headers")] -[JsonDerivedType(typeof(McpHeadersHandlePendingHeadersRefreshRequestNone), "none")] -public partial class McpHeadersHandlePendingHeadersRefreshRequest +public sealed class ModelPickerSettingsContext { - /// The type discriminator. - [JsonPropertyName("kind")] - public virtual string Kind { get; set; } = string.Empty; -} - + /// Optional Copilot configuration directory containing persisted settings. + [JsonPropertyName("configDir")] + public string? ConfigDir { get; set; } -/// The headers variant of . -[Experimental(Diagnostics.Experimental)] -public partial class McpHeadersHandlePendingHeadersRefreshRequestHeaders : McpHeadersHandlePendingHeadersRefreshRequest -{ - /// - [JsonIgnore] - public override string Kind => "headers"; + /// Environment variables consulted while resolving model-picker settings. + [JsonPropertyName("environment")] + public ModelPickerSettingsContextEnvironment Environment { get => field ??= new(); set; } - /// 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; } + /// User home directory used when resolving persisted settings. + [JsonPropertyName("homeDirectory")] + public string HomeDirectory { get; set; } = string.Empty; } -/// The none variant of . +/// RPC data type for ModelPickerPersistence operations. [Experimental(Diagnostics.Experimental)] -public partial class McpHeadersHandlePendingHeadersRefreshRequestNone : McpHeadersHandlePendingHeadersRefreshRequest +public sealed class ModelPickerPersistenceRequest { - /// - [JsonIgnore] - public override string Kind => "none"; + /// Whether context tier was explicitly selected and should be persisted. + [JsonPropertyName("contextTierExplicit")] + public bool? ContextTierExplicit { get; set; } + + /// Whether reasoning effort was explicitly selected and should be persisted. + [JsonPropertyName("reasoningEffortExplicit")] + public bool? ReasoningEffortExplicit { get; set; } + + /// Filesystem and environment context used to resolve settings persistence. + [JsonPropertyName("settingsContext")] + public ModelPickerSettingsContext SettingsContext { get => field ??= new(); set; } } -/// MCP headers refresh request id and the host response. +/// Target model identifier and optional reasoning effort, summary, capability overrides, and context tier. [Experimental(Diagnostics.Experimental)] -internal sealed class McpHeadersHandlePendingHeadersRefreshRequestRequest +internal sealed class ModelSwitchToRequest { - /// Headers refresh request identifier from mcp.headers_refresh_required. - [JsonPropertyName("requestId")] - public string RequestId { get; set; } = string.Empty; + /// Explicit response to a model-switch compaction preflight. Omit to request a confirmation projection when compaction is necessary. + [JsonPropertyName("compactionDecision")] + public string? CompactionDecision { get; set; } - /// Host response: supply dynamic headers or decline this refresh. - [JsonPropertyName("result")] - public McpHeadersHandlePendingHeadersRefreshRequest Result { get => field ??= new(); 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; } + + /// 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; } + + /// Override individual model capabilities resolved by the runtime. + [JsonPropertyName("modelCapabilities")] + public ModelCapabilitiesOverride? ModelCapabilities { get; set; } + + /// Settings scope used when persisting the selected model. + [JsonPropertyName("modelChangeScope")] + public string? ModelChangeScope { get; set; } + + /// 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; + + /// Optional settings context and explicit-override flags used to persist a picker selection. + [JsonPropertyName("pickerPersistence")] + public ModelPickerPersistenceRequest? PickerPersistence { get; set; } + + /// 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; } + + /// Reasoning summary mode to request for supported model clients. + [JsonPropertyName("reasoningSummary")] + public ReasoningSummary? ReasoningSummary { get; set; } + + /// Optional repository settings scope to persist after the switch commits. + [JsonPropertyName("repoScope")] + public string? RepoScope { get; set; } + + /// Require the target to be currently available and enabled before applying the switch. + [JsonPropertyName("requireAvailable")] + public bool? RequireAvailable { get; set; } + + /// When true, evaluate context-window compaction policy before applying the switch. + [JsonPropertyName("runCompactionPreflight")] + public bool? RunCompactionPreflight { get; set; } /// Target session identifier. [JsonPropertyName("sessionId")] public string SessionId { get; set; } = string.Empty; + + /// Origin to record on the effective `session.model_change` event. Defaults to `sdk` when omitted. + [JsonPropertyName("source")] + public ModelChangeSource? Source { get; set; } + + /// Output verbosity level to request for supported models. + [JsonPropertyName("verbosity")] + public Verbosity? Verbosity { get; set; } } -/// MCP Apps resource content with URI, optional MIME type, text or base64 blob, and resource metadata. +/// Managed, repository, and CLI model overrides to overlay onto the session at startup. [Experimental(Diagnostics.Experimental)] -public sealed class McpAppsResourceContent +internal sealed class ModelApplyStartupOverlayRequest { - /// Resource-level metadata (CSP, permissions, etc.). - [JsonPropertyName("_meta")] - public IDictionary? Meta { get; set; } + /// Model explicitly selected by the CLI, when provided. + [JsonPropertyName("cliModel")] + public string? CliModel { get; set; } - /// Base64-encoded binary content. - [JsonPropertyName("blob")] - public string? Blob { get; set; } + /// Whether the overlay is being applied while resuming a deferred session. + [JsonPropertyName("deferredResume")] + public bool? DeferredResume { get; set; } - /// MIME type of the content. - [JsonPropertyName("mimeType")] - public string? MimeType { get; set; } + /// Model required by device-managed policy, when configured. + [JsonPropertyName("deviceManagedModel")] + public string? DeviceManagedModel { get; set; } - /// Text content (e.g. HTML). - [JsonPropertyName("text")] - public string? Text { get; set; } + /// Context tier selected by repository settings, when configured. + [JsonPropertyName("repoContextTier")] + public string? RepoContextTier { get; set; } - /// The resource URI (typically ui://...). - [JsonPropertyName("uri")] - public string Uri { get; set; } = string.Empty; + /// Model selected by repository settings, when configured. + [JsonPropertyName("repoModel")] + public string? RepoModel { get; set; } + + /// Reasoning effort selected by repository settings, when configured. + [JsonPropertyName("repoReasoningEffort")] + public string? RepoReasoningEffort { get; set; } + + /// Model required by server-managed policy, when configured. + [JsonPropertyName("serverManagedModel")] + public string? ServerManagedModel { get; set; } + + /// Target session identifier. + [JsonPropertyName("sessionId")] + public string SessionId { get; set; } = string.Empty; } -/// Resource contents returned by the MCP server. +/// 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)] -public sealed class McpAppsReadResourceResult +public sealed class ModelSetReasoningEffortResult { - /// Resource contents returned by the server. - [JsonPropertyName("contents")] - public IList Contents { get => field ??= []; set; } + /// Reasoning effort level recorded on the session after the update. + [JsonPropertyName("reasoningEffort")] + public string ReasoningEffort { get; set; } = string.Empty; } -/// MCP server and resource URI to fetch. +/// Reasoning effort level to apply to the currently selected model. [Experimental(Diagnostics.Experimental)] -internal sealed class McpAppsReadResourceRequest +internal sealed class ModelSetReasoningEffortRequest { - /// 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; + /// 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; - - /// Resource URI (typically ui://...). - [JsonPropertyName("uri")] - public string Uri { get; set; } = string.Empty; } -/// App-callable tools from the named MCP server. +/// Cost-category metadata for a CAPI model. [Experimental(Diagnostics.Experimental)] -public sealed class McpAppsListToolsResult +public sealed class SessionModelPriceCategory { - /// App-callable tools from the server. - [JsonPropertyName("tools")] - public IList> Tools { get => field ??= []; set; } + /// CAPI model identifier. + [JsonPropertyName("id")] + public string Id { get; set; } = string.Empty; + + /// Cost category assigned to the model. + [JsonPropertyName("priceCategory")] + public ModelPickerPriceCategory PriceCategory { get; set; } } -/// MCP server to list app-callable tools for. +/// The list of models available to this session. [Experimental(Diagnostics.Experimental)] -internal sealed class McpAppsListToolsRequest +public sealed class SessionModelList { - /// **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; + /// 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; } - /// 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; + /// 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; } - /// Target session identifier. - [JsonPropertyName("sessionId")] - public string SessionId { get; set; } = string.Empty; + /// Per-quota snapshots returned alongside the model list, keyed by quota type. + [JsonPropertyName("quotaSnapshots")] + public IDictionary? QuotaSnapshots { get; set; } } -/// MCP server, tool name, and arguments to invoke from an MCP App view. +/// RPC data type for SessionModelList operations. [Experimental(Diagnostics.Experimental)] -internal sealed class McpAppsCallToolRequest +public sealed class SessionModelListRequest { - /// Tool arguments. - [JsonPropertyName("arguments")] - public IDictionary? Arguments { get; set; } + /// If true, bypasses the per-session model list cache and re-fetches from CAPI. + [JsonPropertyName("skipCache")] + public bool? SkipCache { 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; +/// 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; - /// 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; + /// 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. +[Experimental(Diagnostics.Experimental)] +internal sealed class SessionModeGetRequest +{ /// 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. +/// Outcome of a session mode change, including any model switch it triggered and follow-up the host must perform. [Experimental(Diagnostics.Experimental)] -public sealed class McpAppsSetHostContextDetails +public sealed class ModeSetResult { - /// Display modes the host supports. - [JsonPropertyName("availableDisplayModes")] - public IList? AvailableDisplayModes { get; set; } + /// Whether the host should arm an interactive continuation after the mode change. + [JsonPropertyName("armInteractiveContinuation")] + public bool? ArmInteractiveContinuation { get; set; } - /// Current display mode (SEP-1865). - [JsonPropertyName("displayMode")] - public McpAppsSetHostContextDetailsDisplayMode? DisplayMode { get; set; } + /// Compaction confirmation required before the mode change can complete. + [JsonPropertyName("confirmation")] + public ModelSwitchConfirmation? Confirmation { get; set; } - /// BCP-47 locale, e.g. 'en-US'. - [JsonPropertyName("locale")] - public string? Locale { get; set; } + /// Whether the host must defer implementing the requested mode change. + [JsonPropertyName("deferImplementation")] + public bool? DeferImplementation { get; set; } - /// Platform type for responsive design. - [JsonPropertyName("platform")] - public McpAppsSetHostContextDetailsPlatform? Platform { get; set; } + /// Deprecation warnings associated with the model selected by the mode change. + [JsonPropertyName("deprecationWarnings")] + public IList? DeprecationWarnings { get; set; } - /// UI theme preference per SEP-1865. - [JsonPropertyName("theme")] - public McpAppsSetHostContextDetailsTheme? Theme { get; set; } + /// User-facing outcome message for the model switch triggered by the mode change. + [JsonPropertyName("message")] + public string? Message { get; set; } - /// IANA timezone, e.g. 'America/New_York'. - [JsonPropertyName("timeZone")] - public string? TimeZone { get; set; } + /// Whether applying the mode changed the active model. + [JsonPropertyName("modelChanged")] + public bool ModelChanged { get; set; } - /// Host application identifier. - [JsonPropertyName("userAgent")] - public string? UserAgent { get; set; } + /// Lifecycle status of the requested mode change. + [JsonPropertyName("status")] + public string Status { get; set; } = string.Empty; + + /// User-facing warning produced while applying the mode change. + [JsonPropertyName("warning")] + public string? Warning { get; set; } } -/// Host context to advertise to MCP App guests. +/// Agent interaction mode to apply to the session. [Experimental(Diagnostics.Experimental)] -internal sealed class McpAppsSetHostContextRequest +internal sealed class ModeSetRequest { - /// Host context advertised to MCP App guests. - [JsonPropertyName("context")] - public McpAppsSetHostContextDetails Context { get => field ??= new(); set; } + /// Explicit response to a model-switch compaction preflight. + [JsonPropertyName("compactionDecision")] + public string? CompactionDecision { get; set; } - /// Target session identifier. - [JsonPropertyName("sessionId")] - public string SessionId { get; set; } = string.Empty; -} + /// Session whose plan-mode base state should be inherited. + [JsonPropertyName("inheritPlanBaseFromSessionId")] + public string? InheritPlanBaseFromSessionId { get; set; } -/// Current host context. -[Experimental(Diagnostics.Experimental)] -public sealed class McpAppsHostContextDetails -{ - /// Display modes the host supports. - [JsonPropertyName("availableDisplayModes")] - public IList? AvailableDisplayModes { get; set; } + /// The session mode the agent is operating in. + [JsonPropertyName("mode")] + public SessionMode Mode { get; set; } - /// Current display mode (SEP-1865). - [JsonPropertyName("displayMode")] - public McpAppsHostContextDetailsDisplayMode? DisplayMode { get; set; } + /// Whether the selected plan model should be persisted. + [JsonPropertyName("persistPlanSelection")] + public bool? PersistPlanSelection { get; set; } - /// BCP-47 locale, e.g. 'en-US'. - [JsonPropertyName("locale")] - public string? Locale { get; set; } + /// Settings context used when persisting the selected plan model. + [JsonPropertyName("pickerSettingsContext")] + public ModelPickerSettingsContext? PickerSettingsContext { get; set; } - /// Platform type for responsive design. - [JsonPropertyName("platform")] - public McpAppsHostContextDetailsPlatform? Platform { get; set; } + /// Context tier to use with the dedicated plan model. + [JsonPropertyName("planContextTier")] + public string? PlanContextTier { get; set; } - /// UI theme preference per SEP-1865. - [JsonPropertyName("theme")] - public McpAppsHostContextDetailsTheme? Theme { get; set; } + /// Action to perform when leaving plan mode. + [JsonPropertyName("planExitAction")] + public string? PlanExitAction { get; set; } - /// IANA timezone, e.g. 'America/New_York'. - [JsonPropertyName("timeZone")] - public string? TimeZone { get; set; } + /// Dedicated model to use in plan mode, when configured. + [JsonPropertyName("planModel")] + public string? PlanModel { get; set; } - /// Host application identifier. - [JsonPropertyName("userAgent")] - public string? UserAgent { get; set; } + /// Whether a dedicated plan model is configured. + [JsonPropertyName("planModelConfigured")] + public bool? PlanModelConfigured { get; set; } + + /// Reasoning effort to use with the dedicated plan model. + [JsonPropertyName("planReasoningEffort")] + public string? PlanReasoningEffort { get; set; } + + /// Whether leaving plan mode should restore the session's previous model. + [JsonPropertyName("restorePlanModel")] + public bool? RestorePlanModel { get; set; } + + /// Target session identifier. + [JsonPropertyName("sessionId")] + public string SessionId { get; set; } = string.Empty; } -/// Current host context advertised to MCP App guests. +/// The session's friendly name, or null when not yet set. [Experimental(Diagnostics.Experimental)] -public sealed class McpAppsHostContext +public sealed class NameGetResult { - /// Current host context. - [JsonPropertyName("context")] - public McpAppsHostContextDetails Context { get => field ??= new(); set; } + /// The session name (user-set or auto-generated), or null if not yet set. + [JsonPropertyName("name")] + public string? Name { get; set; } } /// Identifies the target session. [Experimental(Diagnostics.Experimental)] -internal sealed class SessionMcpAppsGetHostContextRequest +internal sealed class SessionNameGetRequest { /// Target session identifier. [JsonPropertyName("sessionId")] public string SessionId { get; set; } = string.Empty; } -/// Capability negotiation snapshot. +/// New friendly name to apply to the session. [Experimental(Diagnostics.Experimental)] -public sealed class McpAppsDiagnoseCapability +internal sealed class NameSetRequest { - /// Whether the runtime advertises `extensions.io.modelcontextprotocol/ui` to MCP servers. - [JsonPropertyName("advertised")] - public bool Advertised { get; set; } + /// 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 the MCP_APPS feature flag (or COPILOT_MCP_APPS env override) is on. - [JsonPropertyName("featureFlagEnabled")] - public bool FeatureFlagEnabled { get; set; } + /// Target session identifier. + [JsonPropertyName("sessionId")] + public string SessionId { get; set; } = string.Empty; +} - /// Whether the session has the `mcp-apps` capability. - [JsonPropertyName("sessionHasMcpApps")] - public bool SessionHasMcpApps { 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; } } -/// What the server returned for this session. +/// Auto-generated session summary to apply as the session's name when no user-set name exists. [Experimental(Diagnostics.Experimental)] -public sealed class McpAppsDiagnoseServer +internal sealed class NameSetAutoRequest { - /// Whether the named server is currently connected. - [JsonPropertyName("connected")] - public bool Connected { get; set; } + /// Target session identifier. + [JsonPropertyName("sessionId")] + public string SessionId { get; set; } = string.Empty; - /// Up to 5 tool names with `_meta.ui` for quick inspection. - [JsonPropertyName("sampleToolNames")] - public IList SampleToolNames { 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; +} - /// Total tools returned by the server's tools/list. - [JsonPropertyName("toolCount")] - public double ToolCount { 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; } - /// Tools whose `_meta.ui` is populated (resourceUri and/or visibility set). - [JsonPropertyName("toolsWithUiMeta")] - public double ToolsWithUiMeta { get; set; } + /// Whether the plan file exists in the workspace. + [JsonPropertyName("exists")] + public bool Exists { get; set; } + + /// Absolute file path of the plan file, or null if workspace is not enabled. + [JsonPropertyName("path")] + public string? Path { get; set; } } -/// Diagnostic snapshot of MCP Apps wiring for the named server. +/// Identifies the target session. [Experimental(Diagnostics.Experimental)] -public sealed class McpAppsDiagnoseResult +internal sealed class SessionPlanReadRequest { - /// 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; } + /// Target session identifier. + [JsonPropertyName("sessionId")] + public string SessionId { get; set; } = string.Empty; } -/// MCP server to diagnose MCP Apps wiring for. +/// Replacement contents to write to the session plan file. [Experimental(Diagnostics.Experimental)] -internal sealed class McpAppsDiagnoseRequest +internal sealed class PlanUpdateRequest { - /// 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; + /// 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; } -/// MCP resource content with URI, optional MIME type, text or base64 blob, and resource metadata. +/// Identifies the target session. [Experimental(Diagnostics.Experimental)] -public sealed class McpResourceContent +internal sealed class SessionPlanDeleteRequest { - /// Resource-level metadata (CSP, permissions, etc.). - [JsonPropertyName("_meta")] - public IDictionary? Meta { get; set; } + /// Target session identifier. + [JsonPropertyName("sessionId")] + public string SessionId { get; set; } = string.Empty; +} - /// Base64-encoded binary content. - [JsonPropertyName("blob")] - public string? Blob { 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 creation time, as stored by the session SQL schema's `datetime('now')` default: `YYYY-MM-DD HH:MM:SS` in UTC. Lets clients attribute todos to the work item that created them (e.g. scoping a goal's progress to the todos it produced) rather than to the whole session. + [JsonPropertyName("createdAt")] + public string? CreatedAt { get; set; } - /// MIME type of the content. - [JsonPropertyName("mimeType")] - public string? MimeType { get; set; } + /// Todo description. + [JsonPropertyName("description")] + public string? Description { get; set; } - /// Text content (e.g. HTML). - [JsonPropertyName("text")] - public string? Text { get; set; } + /// Todo identifier. + [JsonPropertyName("id")] + public string? Id { get; set; } - /// The resource URI. - [JsonPropertyName("uri")] - public string Uri { get; set; } = string.Empty; + /// Todo status. + [JsonPropertyName("status")] + public string? Status { get; set; } + + /// Todo title. + [JsonPropertyName("title")] + public string? Title { get; set; } } -/// Resource contents returned by the MCP server. +/// Todo rows read from the session SQL database. Empty when no session database is available. [Experimental(Diagnostics.Experimental)] -public sealed class McpResourcesReadResult +public sealed class PlanReadSqlTodosResult { - /// Resource contents returned by the server. - [JsonPropertyName("contents")] - public IList Contents { get => field ??= []; set; } + /// Rows from the session SQL todos table, ordered by creation time with insertion order used to break ties when available and id used for WITHOUT ROWID tables. + [JsonPropertyName("rows")] + public IList Rows { get => field ??= []; set; } } -/// MCP server and resource URI to fetch. +/// Identifies the target session. [Experimental(Diagnostics.Experimental)] -internal sealed class McpResourcesReadRequest +internal sealed class SessionPlanReadSqlTodosRequest { - /// 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. +/// 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 McpResourceAnnotations +public sealed class PlanSqlTodoDependency { - /// 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; } + /// ID of the todo it depends on. + [JsonPropertyName("dependsOn")] + public string DependsOn { get; set; } = string.Empty; - /// Priority hint for model/client use. - [JsonPropertyName("priority")] - public double? Priority { get; set; } + /// ID of the todo that has the dependency. + [JsonPropertyName("todoId")] + public string TodoId { get; set; } = string.Empty; } -/// A resource icon descriptor plus preserved non-standard icon fields. +/// Todo rows + dependency edges read from the session SQL database. [Experimental(Diagnostics.Experimental)] -public sealed class McpResourceIcon +public sealed class PlanReadSqlTodosWithDependenciesResult { - /// Server-provided non-standard icon fields preserved from the MCP response. - [JsonPropertyName("additionalProperties")] - public IDictionary? AdditionalProperties { get; 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; } - /// 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; } + /// Rows from the session SQL todos table, ordered by creation time with insertion order used to break ties when available and id used for WITHOUT ROWID tables. Empty when no database, no todos table, or the SELECT failed. + [JsonPropertyName("rows")] + public IList Rows { get => field ??= []; 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`. +/// Identifies the target session. [Experimental(Diagnostics.Experimental)] -public sealed class McpResource +internal sealed class SessionPlanReadSqlTodosWithDependenciesRequest { - /// Resource-level metadata. - [JsonPropertyName("_meta")] - public IDictionary? Meta { get; set; } + /// Target session identifier. + [JsonPropertyName("sessionId")] + public string SessionId { get; set; } = string.Empty; +} - /// Server-provided non-standard descriptor fields preserved from the MCP response. - [JsonPropertyName("additionalProperties")] - public IDictionary? AdditionalProperties { get; set; } +/// RPC data type for WorkspacesGetWorkspaceResultWorkspace operations. +public sealed class WorkspacesGetWorkspaceResultWorkspace +{ + /// Current Git branch. + [JsonPropertyName("branch")] + public string? Branch { get; set; } - /// Model/client annotations associated with this resource. - [JsonPropertyName("annotations")] - public McpResourceAnnotations? Annotations { get; set; } + /// Whether the per-session Chronicle upgrade prompt was dismissed for the workspace. + [JsonPropertyName("chronicle_sync_dismissed")] + public bool? ChronicleSyncDismissed { get; set; } - /// Optional description of what this resource represents. - [JsonPropertyName("description")] - public string? Description { get; set; } + /// Name of the client that created the workspace. + [JsonPropertyName("client_name")] + public string? ClientName { get; set; } - /// Icons associated with this resource. - [JsonPropertyName("icons")] - public IList? Icons { get; set; } + /// Timestamp when the workspace was created. + [JsonPropertyName("created_at")] + public DateTimeOffset? CreatedAt { get; set; } - /// MIME type of the resource, if known. - [JsonPropertyName("mimeType")] - public string? MimeType { get; set; } + /// Current working directory associated with the workspace. + [JsonPropertyName("cwd")] + public string? Cwd { get; set; } - /// The programmatic name of the resource. + /// Git repository root associated with the workspace. + [JsonPropertyName("git_root")] + public string? GitRoot { get; set; } + + /// Allowed values for the `WorkspacesWorkspaceDetailsHostType` enumeration. + [JsonPropertyName("host_type")] + public WorkspacesWorkspaceDetailsHostType? HostType { get; set; } + + /// Stable workspace 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("id")] + public string Id { get; set; } = string.Empty; + + /// Most recent Mission Control event identifier observed for the workspace. + [JsonPropertyName("mc_last_event_id")] + public string? McLastEventId { get; set; } + + /// Mission Control session identifier associated with the workspace. + [JsonPropertyName("mc_session_id")] + public string? McSessionId { get; set; } + + /// Mission Control task identifier associated with the workspace. + [JsonPropertyName("mc_task_id")] + public string? McTaskId { get; set; } + + /// Workspace display name. [JsonPropertyName("name")] - public string Name { get; set; } = string.Empty; + public string? Name { get; set; } - /// Resource size in bytes, when known. - [JsonPropertyName("size")] - public long? Size { get; set; } + /// Whether the workspace session can be steered remotely. + [JsonPropertyName("remote_steerable")] + public bool? RemoteSteerable { get; set; } - /// Optional human-readable display title. - [JsonPropertyName("title")] - public string? Title { get; set; } + /// Repository identifier associated with the workspace. + [JsonPropertyName("repository")] + public string? Repository { get; set; } - /// The resource URI (e.g. ui://... or file:///...). - [JsonPropertyName("uri")] - public string Uri { get; set; } = string.Empty; + /// Number of persisted summaries in the workspace. + [JsonPropertyName("summary_count")] + public long? SummaryCount { get; set; } + + /// Timestamp when the workspace was last updated. + [JsonPropertyName("updated_at")] + public DateTimeOffset? UpdatedAt { get; set; } + + /// Whether the workspace name was explicitly chosen by the user. + [JsonPropertyName("user_named")] + public bool? UserNamed { get; set; } } -/// One page of resources advertised by the named MCP server. +/// Current workspace metadata for the session, including its absolute filesystem path when available. [Experimental(Diagnostics.Experimental)] -public sealed class McpResourcesListResult +public sealed class WorkspacesGetWorkspaceResult { - /// Opaque cursor for the next page, if the server has more resources. - [JsonPropertyName("nextCursor")] - public string? NextCursor { get; set; } + /// 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; } - /// Resources advertised by the server (proxied MCP `resources/list`). - [JsonPropertyName("resources")] - public IList Resources { get => field ??= []; set; } + /// Current workspace metadata, or null if not available. + [JsonPropertyName("workspace")] + public WorkspacesGetWorkspaceResultWorkspace? Workspace { get; set; } } -/// MCP server whose resources to enumerate. +/// Identifies the target session. [Experimental(Diagnostics.Experimental)] -internal sealed class McpResourcesListRequest +internal sealed class SessionWorkspacesGetWorkspaceRequest { - /// 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`. +/// Workspace metadata fields to update. [Experimental(Diagnostics.Experimental)] -public sealed class McpResourceTemplate +internal sealed class WorkspacesUpdateMetadataRequest { - /// 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; } + /// Opaque workspace context supplied by the session host. + [JsonPropertyName("context")] + public JsonElement? Context { get; set; } - /// The programmatic name of the resource template. + /// Optional workspace display name override. [JsonPropertyName("name")] - public string Name { get; set; } = string.Empty; - - /// Optional human-readable display title. - [JsonPropertyName("title")] - public string? Title { get; set; } + public string? Name { get; set; } - /// An RFC 6570 URI template for constructing resource URIs. - [JsonPropertyName("uriTemplate")] - public string UriTemplate { get; set; } = string.Empty; + /// Target session identifier. + [JsonPropertyName("sessionId")] + public string SessionId { get; set; } = string.Empty; } -/// One page of resource templates advertised by the named MCP server. +/// Optional session context used when creating a local workspace. [Experimental(Diagnostics.Experimental)] -public sealed class McpResourcesListTemplatesResult +internal sealed class WorkspacesEnsureRequest { - /// Opaque cursor for the next page, if the server has more resource templates. - [JsonPropertyName("nextCursor")] - public string? NextCursor { get; set; } + /// Opaque workspace context supplied by the session host. + [JsonPropertyName("context")] + public JsonElement? Context { get; set; } - /// Resource templates advertised by the server (proxied MCP `resources/templates/list`). - [JsonPropertyName("resourceTemplates")] - public IList ResourceTemplates { get => field ??= []; set; } + /// Target session identifier. + [JsonPropertyName("sessionId")] + public string SessionId { get; set; } = string.Empty; } -/// MCP server whose resource templates to enumerate. +/// Relative paths of files stored in the session workspace files directory. [Experimental(Diagnostics.Experimental)] -internal sealed class McpResourcesListTemplatesRequest +public sealed class WorkspacesListFilesResult { - /// 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; + /// 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 SessionWorkspacesListFilesRequest +{ /// Target session identifier. [JsonPropertyName("sessionId")] public string SessionId { get; set; } = string.Empty; } -/// Session plugin metadata, with name, marketplace, optional version, and enabled state. +/// Contents of the requested workspace file as a UTF-8 string. [Experimental(Diagnostics.Experimental)] -public sealed class Plugin +public sealed class WorkspacesReadFileResult { - /// 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; } + /// File content as a UTF-8 string. + [JsonPropertyName("content")] + public string Content { get; set; } = string.Empty; } -/// Plugins installed for the session, with their enabled state and version metadata. +/// Relative path of the workspace file to read. [Experimental(Diagnostics.Experimental)] -public sealed class PluginList +internal sealed class WorkspacesReadFileRequest { - /// Installed plugins. - [JsonPropertyName("plugins")] - public IList Plugins { get => field ??= []; set; } + /// Relative path within the workspace files directory. + [JsonPropertyName("path")] + public string Path { get; set; } = string.Empty; + + /// Target session identifier. + [JsonPropertyName("sessionId")] + public string SessionId { get; set; } = string.Empty; } -/// Identifies the target session. +/// Relative path and UTF-8 content for the workspace file to create or overwrite. [Experimental(Diagnostics.Experimental)] -internal sealed class SessionPluginsListRequest +internal sealed class WorkspacesCreateFileRequest { + /// File content to write as a UTF-8 string. + [JsonPropertyName("content")] + public string Content { get; set; } = string.Empty; + + /// Relative path within the workspace files directory. + [JsonPropertyName("path")] + public string Path { get; set; } = string.Empty; + /// Target session identifier. [JsonPropertyName("sessionId")] public string SessionId { get; set; } = string.Empty; } -/// Optional flags controlling which side effects the reload performs. +/// Workspace checkpoint metadata with assigned number, human-readable title, and checkpoint filename. [Experimental(Diagnostics.Experimental)] -public sealed class PluginsReloadRequest +public sealed class WorkspacesCheckpoints { - /// 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; } + /// Filename of the checkpoint within the workspace checkpoints directory. + [JsonPropertyName("filename")] + public string Filename { get; set; } = string.Empty; - /// 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; } + /// Checkpoint number assigned by the workspace manager. + [JsonPropertyName("number")] + public long Number { get; set; } - /// Reload MCP server connections after refreshing plugins. Defaults to true. - [JsonPropertyName("reloadMcp")] - public bool? ReloadMcp { get; set; } + /// Human-readable checkpoint title. + [JsonPropertyName("title")] + public string Title { get; set; } = string.Empty; } -/// Optional flags controlling which side effects the reload performs. +/// Workspace checkpoints in chronological order; empty when the workspace is not enabled. [Experimental(Diagnostics.Experimental)] -internal sealed class PluginsReloadRequestWithSession +public sealed class WorkspacesListCheckpointsResult { - /// 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; } + /// 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 SessionWorkspacesListCheckpointsRequest +{ /// 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. +/// Checkpoint content as a UTF-8 string, or null when the checkpoint or workspace is missing. [Experimental(Diagnostics.Experimental)] -public sealed class ProviderSessionToken +public sealed class WorkspacesReadCheckpointResult { - /// 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; + /// Checkpoint content as a UTF-8 string, or null when the checkpoint or workspace is missing. + [JsonPropertyName("content")] + public string? Content { get; set; } } -/// A snapshot of the provider endpoint the session is currently configured to talk to. +/// Checkpoint number to read. [Experimental(Diagnostics.Experimental)] -public sealed class ProviderEndpoint +internal sealed class WorkspacesReadCheckpointRequest { - /// 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; } + /// Checkpoint number to read. + [JsonPropertyName("number")] + public long Number { get; set; } - /// Transport to be used for provider requests. - [JsonPropertyName("transport")] - public ProviderEndpointTransport? Transport { get; set; } + /// Target session identifier. + [JsonPropertyName("sessionId")] + public string SessionId { get; set; } = string.Empty; +} - /// Provider family. Matches the `type` field of a BYOK provider config. - [JsonPropertyName("type")] - public ProviderEndpointType Type { get; set; } +/// Metadata for the persisted summary. +public sealed class WorkspacesAddSummaryResultSummary +{ +} - /// Wire API to be used, when required for the provider type. - [JsonPropertyName("wireApi")] - public ProviderEndpointWireApi? WireApi { get; set; } +/// Refreshed metadata for the containing workspace. +public sealed class WorkspacesAddSummaryResultWorkspace +{ } -/// Optional model identifier to scope the endpoint snapshot to. +/// Persisted summary metadata and refreshed workspace metadata. [Experimental(Diagnostics.Experimental)] -public sealed class ProviderGetEndpointRequest +public sealed class WorkspacesAddSummaryResult { - /// 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; } + /// Metadata for the persisted summary. + [JsonPropertyName("summary")] + public WorkspacesAddSummaryResultSummary? Summary { get; set; } + + /// Refreshed metadata for the containing workspace. + [JsonPropertyName("workspace")] + public WorkspacesAddSummaryResultWorkspace? Workspace { get; set; } } -/// Optional model identifier to scope the endpoint snapshot to. +/// Compaction summary checkpoint to persist. [Experimental(Diagnostics.Experimental)] -internal sealed class ProviderGetEndpointRequestWithSession +internal sealed class WorkspacesAddSummaryRequest { - /// 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; } + /// Markdown summary content to persist. + [JsonPropertyName("content")] + public string Content { get; set; } = string.Empty; /// Target session identifier. [JsonPropertyName("sessionId")] public string SessionId { get; set; } = string.Empty; + + /// Summary title shown in checkpoint listings. + [JsonPropertyName("title")] + public string Title { get; set; } = string.Empty; } -/// The selectable model entries synthesized for the models added by this call. +/// Rollback point for local workspace summaries. [Experimental(Diagnostics.Experimental)] -public sealed class ProviderAddResult +internal sealed class WorkspacesTruncateSummariesRequest { - /// 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; } + /// Number of newest summaries to keep. + [JsonPropertyName("keepCount")] + public long KeepCount { get; set; } + + /// Target session identifier. + [JsonPropertyName("sessionId")] + public string SessionId { get; set; } = string.Empty; } -/// A BYOK model definition referencing a named provider. +/// Autopilot objective file content, or null when missing. [Experimental(Diagnostics.Experimental)] -public sealed class ProviderModelConfig +public sealed class WorkspacesReadAutopilotObjectiveResult { - /// 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; } + /// Autopilot objective file content, or null when missing. + [JsonPropertyName("content")] + public string? Content { get; set; } } -/// Azure-specific provider options. +/// Identifies the target session. [Experimental(Diagnostics.Experimental)] -public sealed class ProviderConfigAzure +internal sealed class SessionWorkspacesReadAutopilotObjectiveRequest { - /// API version. When set, uses the versioned deployment route. When omitted, uses the GA versionless v1 route. - [JsonPropertyName("apiVersion")] - public string? ApiVersion { get; set; } + /// Target session identifier. + [JsonPropertyName("sessionId")] + public string SessionId { get; set; } = string.Empty; } -/// A named BYOK provider connection (transport + credentials). +/// Result of writing the autopilot objective file. [Experimental(Diagnostics.Experimental)] -public sealed class NamedProviderConfig +public sealed class WorkspacesWriteAutopilotObjectiveResult { - /// 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; } + /// Filesystem operation performed. + [JsonPropertyName("operation")] + public string Operation { get; set; } = string.Empty; } -/// BYOK providers and/or models to add to the session's registry at runtime. Both fields are optional; provide providers, models, or both. +/// Autopilot objective file content to persist. [Experimental(Diagnostics.Experimental)] -internal sealed class ProviderAddRequest +internal sealed class WorkspacesWriteAutopilotObjectiveRequest { - /// 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; } + /// 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; } -/// Indicates whether the session options patch was applied successfully. +/// Result of deleting the autopilot objective file. [Experimental(Diagnostics.Experimental)] -public sealed class SessionUpdateOptionsResult +public sealed class WorkspacesDeleteAutopilotObjectiveResult { - /// 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; } + /// True when a file was deleted. + [JsonPropertyName("deleted")] + public bool Deleted { get; set; } } -/// Source descriptor for a `session.options.update` content-exclusion rule, with source name and type. +/// Identifies the target session. [Experimental(Diagnostics.Experimental)] -public sealed class OptionsUpdateAdditionalContentExclusionPolicyRuleSource +internal sealed class SessionWorkspacesDeleteAutopilotObjectiveRequest { - /// Gets or sets the name value. - [JsonPropertyName("name")] - public string Name { get; set; } = string.Empty; + /// Target session identifier. + [JsonPropertyName("sessionId")] + public string SessionId { get; set; } = string.Empty; +} - /// Gets or sets the type value. - [JsonPropertyName("type")] - public string Type { get; set; } = string.Empty; +/// Whether the autopilot objective file exists. +[Experimental(Diagnostics.Experimental)] +public sealed class WorkspacesAutopilotObjectiveExistsResult +{ + /// True when the objective file exists. + [JsonPropertyName("exists")] + public bool Exists { get; set; } } -/// Single content-exclusion rule supplied to `session.options.update`, with paths, match conditions, and source. +/// Identifies the target session. [Experimental(Diagnostics.Experimental)] -public sealed class OptionsUpdateAdditionalContentExclusionPolicyRule +internal sealed class SessionWorkspacesAutopilotObjectiveExistsRequest { - /// 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; } + /// Target session identifier. + [JsonPropertyName("sessionId")] + public string SessionId { get; set; } = string.Empty; } -/// Content-exclusion policy supplied to `session.options.update`, with rules, last-updated data, and scope. -[Experimental(Diagnostics.Experimental)] -public sealed class OptionsUpdateAdditionalContentExclusionPolicy +/// RPC data type for WorkspacesSaveLargePasteResultSaved operations. +public sealed class WorkspacesSaveLargePasteResultSaved { - /// Gets or sets the last_updated_at value. - [JsonPropertyName("last_updated_at")] - public JsonElement LastUpdatedAt { get; set; } + /// Filename within the workspace files directory. + [JsonPropertyName("filename")] + public string Filename { get; set; } = string.Empty; - /// Gets or sets the rules value. - [JsonPropertyName("rules")] - public IList Rules { get => field ??= []; set; } + /// Absolute filesystem path to the saved paste file. + [JsonPropertyName("filePath")] + public string FilePath { get; set; } = string.Empty; - /// Allowed values for the `OptionsUpdateAdditionalContentExclusionPolicyScope` enumeration. - [JsonPropertyName("scope")] - public OptionsUpdateAdditionalContentExclusionPolicyScope Scope { get; set; } + /// Size of the saved file in bytes. + [JsonPropertyName("sizeBytes")] + public long SizeBytes { get; set; } } -/// Options scoped to the built-in CAPI (Copilot API) provider. +/// Descriptor for the saved paste file, or null when the workspace is unavailable. [Experimental(Diagnostics.Experimental)] -public sealed class CapiSessionOptions +public sealed class WorkspacesSaveLargePasteResult { - /// 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; } + /// 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; } } -/// Installed plugin record for a session, with marketplace, version, install time, enabled state, cache path, and source. +/// Pasted content to save as a UTF-8 file in the session workspace. [Experimental(Diagnostics.Experimental)] -public sealed class SessionInstalledPlugin +internal sealed class WorkspacesSaveLargePasteRequest { - /// 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; } + /// Pasted content to save as a UTF-8 file. + [JsonPropertyName("content")] + public string Content { get; set; } = string.Empty; - /// Installed version, if known. - [JsonPropertyName("version")] - public string? Version { get; set; } + /// Target session identifier. + [JsonPropertyName("sessionId")] + public string SessionId { get; set; } = string.Empty; } -/// Custom model-provider configuration (BYOK). +/// A single changed file and its unified diff. [Experimental(Diagnostics.Experimental)] -public sealed class ProviderConfig +public sealed class WorkspaceDiffFileChange { - /// API key. Optional for local providers like Ollama. - [JsonPropertyName("apiKey")] - public string? ApiKey { get; set; } + /// Type of change represented by this file diff. + [JsonPropertyName("changeType")] + public WorkspaceDiffFileChangeType ChangeType { get; set; } - /// Azure-specific provider options. - [JsonPropertyName("azure")] - public ProviderConfigAzure? Azure { get; set; } + /// Unified diff content for the file. Empty when the diff was truncated. + [JsonPropertyName("diff")] + public string Diff { get; set; } = string.Empty; - /// API endpoint URL. - [JsonPropertyName("baseUrl")] - public string BaseUrl { 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; } - /// Bearer token for authentication. Sets the Authorization header directly. Takes precedence over apiKey when both are set. - [JsonPropertyName("bearerToken")] - public string? BearerToken { get; set; } + /// Original file path for renamed files. + [JsonPropertyName("oldPath")] + public string? OldPath { 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; } + /// 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; +} - /// Custom HTTP headers to include in all outbound requests to the provider. - [JsonPropertyName("headers")] - public IDictionary? Headers { get; set; } +/// Workspace diff result for the requested mode. +[Experimental(Diagnostics.Experimental)] +public sealed class WorkspaceDiffResult +{ + /// Default branch used for a branch diff, when branch mode was requested. + [JsonPropertyName("baseBranch")] + public string? BaseBranch { get; set; } - /// Maximum context window tokens for the model. - [JsonPropertyName("maxContextWindowTokens")] - public double? MaxContextWindowTokens { get; set; } + /// Changed files and their unified diffs. + [JsonPropertyName("changes")] + public IList Changes { get => field ??= []; set; } - /// Maximum output tokens for the model. - [JsonPropertyName("maxOutputTokens")] - public double? MaxOutputTokens { 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; } - /// Maximum prompt/input tokens for the model. - [JsonPropertyName("maxPromptTokens")] - public double? MaxPromptTokens { get; set; } + /// Effective mode used for the returned changes. + [JsonPropertyName("mode")] + public WorkspaceDiffMode Mode { 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; } + /// Diff mode requested by the client. + [JsonPropertyName("requestedMode")] + public WorkspaceDiffMode RequestedMode { get; set; } - /// Provider transport. Defaults to "http". - [JsonPropertyName("transport")] - public ProviderConfigTransport? Transport { 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; } +} - /// Provider type. Defaults to "openai" for generic OpenAI-compatible APIs. - [JsonPropertyName("type")] - public ProviderConfigType? Type { get; set; } +/// Parameters for computing a workspace diff. +[Experimental(Diagnostics.Experimental)] +internal sealed class WorkspacesDiffRequest +{ + /// When true, ignore whitespace-only changes (git `--ignore-all-space`). Defaults to false. + [JsonPropertyName("ignoreWhitespace")] + public bool? IgnoreWhitespace { get; set; } - /// Wire API format (openai/azure only). Defaults to "completions". - [JsonPropertyName("wireApi")] - public ProviderConfigWireApi? WireApi { get; set; } + /// Diff mode requested by the client. + [JsonPropertyName("mode")] + public WorkspaceDiffMode Mode { 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; } + /// Target session identifier. + [JsonPropertyName("sessionId")] + public string SessionId { get; set; } = string.Empty; } -/// macOS seatbelt experimental options. +/// 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 SandboxConfigUserPolicyExperimentalSeatbelt +public sealed class CompletionsGetTriggerCharactersResult { - /// Whether the macOS seatbelt profile may access the keychain. - [JsonPropertyName("keychainAccess")] - public bool? KeychainAccess { 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; } } -/// Platform-specific experimental policy fields. +/// Identifies the target session. [Experimental(Diagnostics.Experimental)] -public sealed class SandboxConfigUserPolicyExperimental +internal sealed class SessionCompletionsGetTriggerCharactersRequest { - /// macOS seatbelt experimental options. - [JsonPropertyName("seatbelt")] - public SandboxConfigUserPolicyExperimentalSeatbelt? Seatbelt { get; set; } + /// Target session identifier. + [JsonPropertyName("sessionId")] + public string SessionId { get; set; } = string.Empty; } -/// Filesystem rules to merge into the base policy. +/// 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 SandboxConfigUserPolicyFilesystem +public sealed class SessionCompletionItem { - /// Whether to clear the policy when the session exits. - [JsonPropertyName("clearPolicyOnExit")] - public bool? ClearPolicyOnExit { get; set; } + /// Text spliced into the composer when the item is accepted. + [JsonPropertyName("insertText")] + public string InsertText { get; set; } = string.Empty; - /// Paths explicitly denied. - [JsonPropertyName("deniedPaths")] - public IList? DeniedPaths { get; set; } + /// 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; } - /// Paths granted read-only access. - [JsonPropertyName("readonlyPaths")] - public IList? ReadonlyPaths { get; set; } + /// Primary display label for the picker row. Falls back to `insertText` when absent. + [JsonPropertyName("label")] + public string? Label { get; set; } - /// Paths granted read/write access. - [JsonPropertyName("readwritePaths")] - public IList? ReadwritePaths { 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; } } -/// Network rules to merge into the base policy. +/// Host-driven completion items for the current composer input. Empty when the host returns no items or does not support completions. [Experimental(Diagnostics.Experimental)] -public sealed class SandboxConfigUserPolicyNetwork +public sealed class CompletionsRequestResult { - /// 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; } + /// Completion items in host-ranked order. + [JsonPropertyName("items")] + public IList Items { get => field ??= []; set; } } -/// macOS seatbelt-specific options. +/// Request host-driven completions for the current composer input. [Experimental(Diagnostics.Experimental)] -public sealed class SandboxConfigUserPolicySeatbelt +internal sealed class CompletionsRequestRequest { - /// Whether the macOS seatbelt profile may access the keychain. - [JsonPropertyName("keychainAccess")] - public bool? KeychainAccess { get; set; } + /// 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; } -/// User-managed sandbox policy fragment merged into the auto-discovered base policy. +/// Instruction sources loaded for the session, in merge order. [Experimental(Diagnostics.Experimental)] -public sealed class SandboxConfigUserPolicy +public sealed class InstructionsGetSourcesResult { - /// 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; } + /// Instruction sources for the session. + [JsonPropertyName("sources")] + public IList Sources { get => field ??= []; set; } } -/// Resolved sandbox configuration. +/// Identifies the target session. [Experimental(Diagnostics.Experimental)] -public sealed class SandboxConfig +internal sealed class SessionInstructionsGetSourcesRequest { - /// Whether to auto-add the current working directory to readwritePaths. Default: true. - [JsonPropertyName("addCurrentWorkingDirectory")] - public bool? AddCurrentWorkingDirectory { get; set; } + /// Target session identifier. + [JsonPropertyName("sessionId")] + public string SessionId { get; set; } = string.Empty; +} - /// Whether sandboxing is enabled for the session. - [JsonPropertyName("enabled")] - public bool Enabled { get; set; } +/// 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; } +} - /// 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("ghAuth")] - public bool? GhAuth { 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; } - /// Whether to inject the Copilot GitHub token as an `http.<host>.extraheader` so authenticated HTTPS git works inside the sandbox without the shell-based credential helper the sandbox blocks. Default: false (opt-in). - [JsonPropertyName("gitAuth")] - public bool? GitAuth { get; set; } + /// Target session identifier. + [JsonPropertyName("sessionId")] + public string SessionId { get; set; } = string.Empty; +} - /// User-managed sandbox policy fragment merged into the auto-discovered base policy. - [JsonPropertyName("userPolicy")] - public SandboxConfigUserPolicy? UserPolicy { get; set; } +/// Agents available to the session. +[Experimental(Diagnostics.Experimental)] +public sealed class AgentList +{ + /// Available agents. + [JsonPropertyName("agents")] + public IList Agents { get => field ??= []; set; } } -/// Patch of mutable session options to apply to the running session. +/// RPC data type for SessionAgentList operations. [Experimental(Diagnostics.Experimental)] -internal sealed class SessionUpdateOptionsParams +public sealed class SessionAgentListRequest { - /// Additional content-exclusion policies to merge into the session's policy set. - [Experimental(Diagnostics.Experimental)] - [JsonPropertyName("additionalContentExclusionPolicies")] - public IList? AdditionalContentExclusionPolicies { 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; } - /// Runtime context discriminator (e.g., `cli`, `actions`). - [JsonPropertyName("agentContext")] - public string? AgentContext { 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; } +} - /// Whether to include instructions from every MCP server in the system prompt instead of only allowlisted servers. - [JsonPropertyName("allowAllMcpServerInstructions")] - public bool? AllowAllMcpServerInstructions { get; set; } +/// RPC data type for SessionAgentListRequestWithSession operations. +[Experimental(Diagnostics.Experimental)] +internal sealed class SessionAgentListRequestWithSession +{ + /// 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; } - /// Whether to disable the `ask_user` tool (encourages autonomous behavior). - [JsonPropertyName("askUserDisabled")] - public bool? AskUserDisabled { 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; } - /// Allowlist of tool names available to this session. - [JsonPropertyName("availableTools")] - public IList? AvailableTools { get; set; } + /// Target session identifier. + [JsonPropertyName("sessionId")] + public string SessionId { get; set; } = string.Empty; +} - /// Options scoped to the built-in CAPI (Copilot API) provider. - [JsonPropertyName("capi")] - public CapiSessionOptions? Capi { get; set; } +/// An in-memory authored prompt override for an available agent. +[Experimental(Diagnostics.Experimental)] +internal sealed class AgentSetPromptRequest +{ + /// Stable effective agent id. Plugin namespace separators are normalized. + [JsonPropertyName("id")] + public string Id { get; set; } = string.Empty; - /// Identifier of the client driving the session. - [JsonPropertyName("clientName")] - public string? ClientName { get; set; } + /// Replacement authored prompt. Empty text is valid. + [JsonPropertyName("prompt")] + public string Prompt { get; set; } = string.Empty; - /// Whether to include the `Co-authored-by` trailer in commit messages. - [JsonPropertyName("coauthorEnabled")] - public bool? CoauthorEnabled { get; set; } + /// Target session identifier. + [JsonPropertyName("sessionId")] + public string SessionId { get; set; } = string.Empty; +} - /// 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; } +/// The currently selected custom agent, or null when using the default agent. +[Experimental(Diagnostics.Experimental)] +public sealed class AgentGetCurrentResult +{ + /// Currently selected custom agent, or null if using the default agent. + [JsonPropertyName("agent")] + public AgentInfo? Agent { get; set; } +} - /// Whether to allow auto-mode continuation across turns. - [JsonPropertyName("continueOnAutoMode")] - public bool? ContinueOnAutoMode { get; set; } +/// Identifies the target session. +[Experimental(Diagnostics.Experimental)] +internal sealed class SessionAgentGetCurrentRequest +{ + /// Target session identifier. + [JsonPropertyName("sessionId")] + public string SessionId { get; set; } = string.Empty; +} - /// Override URL for the Copilot API endpoint. - [JsonPropertyName("copilotUrl")] - public string? CopilotUrl { get; set; } +/// The newly selected custom agent. +[Experimental(Diagnostics.Experimental)] +public sealed class AgentSelectResult +{ + /// The newly selected custom agent. + [JsonPropertyName("agent")] + public AgentInfo Agent { get => field ??= new(); set; } +} - /// Whether to default custom agents to local-only execution. - [JsonPropertyName("customAgentsLocalOnly")] - public bool? CustomAgentsLocalOnly { get; set; } +/// Name of the custom agent to select for subsequent turns. +[Experimental(Diagnostics.Experimental)] +internal sealed class AgentSelectRequest +{ + /// Name of the custom agent to select. + [JsonPropertyName("name")] + public string Name { get; set; } = string.Empty; - /// Instruction source IDs to exclude from the system prompt. - [JsonPropertyName("disabledInstructionSources")] - public IList? DisabledInstructionSources { get; set; } + /// 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; } +/// Identifies the target session. +[Experimental(Diagnostics.Experimental)] +internal sealed class SessionAgentDeselectRequest +{ + /// Target session identifier. + [JsonPropertyName("sessionId")] + public string SessionId { get; set; } = string.Empty; +} - /// Whether to enable loading of `.github/hooks/` filesystem hooks. Separate from the SDK callback hook mechanism. - [JsonPropertyName("enableFileHooks")] - public bool? EnableFileHooks { get; set; } +/// Custom agents available to the session after reloading definitions from disk. +[Experimental(Diagnostics.Experimental)] +public sealed class AgentReloadResult +{ + /// Reloaded custom agents. + [JsonPropertyName("agents")] + public IList Agents { get => field ??= []; set; } +} - /// Whether to enable host git operations (context resolution, child repo scanning, git info in system prompt). - [JsonPropertyName("enableHostGitOperations")] - public bool? EnableHostGitOperations { get; set; } +/// Identifies the target session. +[Experimental(Diagnostics.Experimental)] +internal sealed class SessionAgentReloadRequest +{ + /// Target session identifier. + [JsonPropertyName("sessionId")] + public string SessionId { get; set; } = string.Empty; +} - /// 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; } +/// Identifier assigned to the newly started background agent task. +[Experimental(Diagnostics.Experimental)] +public sealed class TasksStartAgentResult +{ + /// Generated agent ID for the background task. + [JsonPropertyName("agentId")] + public string AgentId { get; set; } = string.Empty; +} - /// Whether to surface reasoning-summary events from the model. - [JsonPropertyName("enableReasoningSummaries")] - public bool? EnableReasoningSummaries { get; set; } +/// Agent type, prompt, name, and optional description and model override for the new task. +[Experimental(Diagnostics.Experimental)] +internal sealed class TasksStartAgentRequest +{ + /// Type of agent to start (e.g., 'explore', 'task', 'general-purpose'). + [JsonPropertyName("agentType")] + public string AgentType { get; set; } = string.Empty; - /// Whether shell-script safety heuristics are enabled. - [JsonPropertyName("enableScriptSafety")] - public bool? EnableScriptSafety { get; set; } + /// Short description of the task. + [JsonPropertyName("description")] + public string? Description { get; set; } - /// Whether to enable cross-session store writes and reads. - [JsonPropertyName("enableSessionStore")] - public bool? EnableSessionStore { get; set; } + /// Optional model override. + [JsonPropertyName("model")] + public string? Model { get; set; } - /// Whether to enable skill directory scanning and loading. Falls back to enableConfigDiscovery when unset. - [JsonPropertyName("enableSkills")] - public bool? EnableSkills { get; set; } + /// Friendly, non-unique name used when displaying the agent. + [JsonPropertyName("name")] + public string Name { get; set; } = string.Empty; - /// Whether to stream model responses. - [JsonPropertyName("enableStreaming")] - public bool? EnableStreaming { get; set; } + /// Task prompt for the agent. + [JsonPropertyName("prompt")] + public string Prompt { get; set; } = string.Empty; - /// How env values are passed to MCP servers (`direct` inlines literal values; `indirect` resolves at launch). - [JsonPropertyName("envValueMode")] - public OptionsUpdateEnvValueMode? EnvValueMode { get; set; } + /// 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; } +/// 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)] +[JsonPolymorphic( + TypeDiscriminatorPropertyName = "type", + UnknownDerivedTypeHandling = JsonUnknownDerivedTypeHandling.FallBackToBaseType)] +[JsonDerivedType(typeof(TaskInfoAgent), "agent")] +[JsonDerivedType(typeof(TaskInfoShell), "shell")] +public partial class TaskInfo +{ + /// The type discriminator. + [JsonPropertyName("type")] + public virtual string Type { get; set; } = string.Empty; +} - /// 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; } +/// Tracked background agent task metadata, including IDs, status, timing, agent type, prompt, model, result, and latest response. +/// The agent variant of . +[Experimental(Diagnostics.Experimental)] +public partial class TaskInfoAgent : TaskInfo +{ + /// + [JsonIgnore] + public override string Type => "agent"; - /// Map of feature-flag IDs to their boolean enabled state. - [JsonPropertyName("featureFlags")] - public IDictionary? FeatureFlags { get; set; } + /// ISO 8601 timestamp when the current active period began. + [JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)] + [JsonPropertyName("activeStartedAt")] + public DateTimeOffset? ActiveStartedAt { 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; } + /// Accumulated active execution time in milliseconds. + [JsonConverter(typeof(MillisecondsTimeSpanConverter))] + [JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)] + [JsonPropertyName("activeTimeMs")] + public TimeSpan? ActiveTime { 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; } + /// Type of agent running this task. + [JsonPropertyName("agentType")] + public required string AgentType { get; set; } - /// Stable integration identifier used for analytics and rate-limit attribution. - [JsonPropertyName("integrationId")] - public string? IntegrationId { 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; } - /// Whether experimental capabilities are enabled. - [JsonPropertyName("isExperimentalMode")] - public bool? IsExperimentalMode { get; set; } + /// ISO 8601 timestamp when the task finished. + [JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)] + [JsonPropertyName("completedAt")] + public DateTimeOffset? CompletedAt { get; set; } - /// Whether interactive shell sessions are logged. - [JsonPropertyName("logInteractiveShells")] - public bool? LogInteractiveShells { get; set; } + /// Short description of the task. + [JsonPropertyName("description")] + public required string Description { get; set; } - /// Identifier sent to LSP-style integrations. - [JsonPropertyName("lspClientName")] - public string? LspClientName { get; set; } + /// Friendly, non-unique name intended for display. + [JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)] + [JsonPropertyName("displayName")] + public string? DisplayName { 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; } + /// Error message when the task failed. + [JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)] + [JsonPropertyName("error")] + public string? Error { 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; } + /// Whether task execution is synchronously awaited or managed in the background. + [JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)] + [JsonPropertyName("executionMode")] + public TaskExecutionMode? ExecutionMode { get; set; } - /// The model ID to use for assistant turns. - [JsonPropertyName("model")] - public string? Model { get; set; } + /// Unique task identifier. + [JsonPropertyName("id")] + public required string Id { get; set; } - /// Per-property model capability overrides for the selected model. - [JsonPropertyName("modelCapabilitiesOverrides")] - public ModelCapabilitiesOverride? ModelCapabilitiesOverrides { get; set; } + /// ISO 8601 timestamp when the agent entered idle state. + [JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)] + [JsonPropertyName("idleSince")] + public DateTimeOffset? IdleSince { get; set; } - /// Organization-level custom instructions to inject into the system prompt. - [JsonPropertyName("organizationCustomInstructions")] - public string? OrganizationCustomInstructions { get; set; } + /// Most recent response text from the agent. + [JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)] + [JsonPropertyName("latestResponse")] + public string? LatestResponse { get; set; } - /// Custom model-provider configuration (BYOK). - [JsonPropertyName("provider")] - public ProviderConfig? Provider { get; set; } + /// Requested model override for the task when specified. + [JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)] + [JsonPropertyName("model")] + public string? Model { get; set; } - /// Reasoning effort for the selected model (model-defined enum). - [JsonPropertyName("reasoningEffort")] - public string? ReasoningEffort { 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; } - /// Reasoning summary mode for supported model clients. - [JsonPropertyName("reasoningSummary")] - public OptionsUpdateReasoningSummary? ReasoningSummary { get; set; } + /// Runtime model resolved for the task when available. + [JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)] + [JsonPropertyName("resolvedModel")] + public string? ResolvedModel { get; set; } - /// Whether the session is running in an interactive UI. - [JsonPropertyName("runningInInteractiveMode")] - public bool? RunningInInteractiveMode { get; set; } + /// Result text from the task when available. + [JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)] + [JsonPropertyName("result")] + public string? Result { get; set; } - /// Resolved sandbox configuration. - [JsonPropertyName("sandboxConfig")] - public SandboxConfig? SandboxConfig { get; set; } + /// ISO 8601 timestamp when the task was started. + [JsonPropertyName("startedAt")] + public required DateTimeOffset StartedAt { 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; } + /// Current lifecycle status of the task. + [JsonPropertyName("status")] + public required TaskStatus Status { get; set; } - /// Target session identifier. - [JsonPropertyName("sessionId")] - public string SessionId { get; set; } = string.Empty; + /// Tool call ID associated with this agent task. + [JsonPropertyName("toolCallId")] + public required string ToolCallId { get; set; } +} - /// Optional session limits. Pass null to clear the session limits. - [JsonPropertyName("sessionLimits")] - public SessionLimitsConfig? SessionLimits { get; set; } +/// Tracked shell task metadata, including ID, command, status, timing, attachment/execution mode, log path, and PID. +/// The shell variant of . +[Experimental(Diagnostics.Experimental)] +public partial class TaskInfoShell : TaskInfo +{ + /// + [JsonIgnore] + public override string Type => "shell"; - /// Shell init profile (`None` or `NonInteractive`). - [JsonPropertyName("shellInitProfile")] - public string? ShellInitProfile { 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; } - /// Per-shell process flags (e.g., `pwsh` arguments). - [JsonPropertyName("shellProcessFlags")] - public IList? ShellProcessFlags { get; set; } + /// Whether this shell task can be promoted to background mode. + [JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)] + [JsonPropertyName("canPromoteToBackground")] + public bool? CanPromoteToBackground { get; set; } - /// Additional directories to search for skills. - [JsonPropertyName("skillDirectories")] - public IList? SkillDirectories { get; set; } + /// Command being executed. + [JsonPropertyName("command")] + public required string Command { get; set; } - /// Whether to skip loading custom instruction sources. - [JsonPropertyName("skipCustomInstructions")] - public bool? SkipCustomInstructions { get; set; } + /// ISO 8601 timestamp when the task finished. + [JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)] + [JsonPropertyName("completedAt")] + public DateTimeOffset? CompletedAt { get; set; } - /// Whether to skip embedding retrieval pipeline initialization and execution. - [JsonPropertyName("skipEmbeddingRetrieval")] - public bool? SkipEmbeddingRetrieval { get; set; } + /// Short description of the task. + [JsonPropertyName("description")] + public required string Description { 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; } + /// Whether task execution is synchronously awaited or managed in the background. + [JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)] + [JsonPropertyName("executionMode")] + public TaskExecutionMode? ExecutionMode { get; set; } - /// Controls how availableTools (allowlist) and excludedTools (denylist) combine when both are set. - [JsonPropertyName("toolFilterPrecedence")] - public OptionsUpdateToolFilterPrecedence? ToolFilterPrecedence { get; set; } + /// Unique task identifier. + [JsonPropertyName("id")] + public required string Id { get; set; } - /// Optional path for trajectory output. - [JsonPropertyName("trajectoryFile")] - public string? TrajectoryFile { get; set; } + /// Path to the detached shell log, when available. + [JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)] + [JsonPropertyName("logPath")] + public string? LogPath { get; set; } - /// Output verbosity level for supported models. - [JsonPropertyName("verbosity")] - public Verbosity? Verbosity { get; set; } + /// Process ID when available. + [JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)] + [JsonPropertyName("pid")] + public long? Pid { get; set; } - /// Absolute working-directory path for shell tools. - [JsonPropertyName("workingDirectory")] - public string? WorkingDirectory { 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; } } -/// Parameters for (re)loading the merged LSP configuration set. +/// Background tasks currently tracked by the session. [Experimental(Diagnostics.Experimental)] -internal sealed class LspInitializeRequest +public sealed class TaskList { - /// 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; } + /// 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; - - /// 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. +/// 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 ExtensionList +public sealed class TasksRefreshResult { - /// 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 +internal sealed class SessionTasksRefreshRequest { - /// 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. +/// 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)] -internal sealed class ExtensionsDisableRequest +public sealed class TasksWaitForPendingResult { - /// 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 +internal sealed class SessionTasksWaitForPendingRequest { /// 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)] +/// Polymorphic base type discriminated by type. [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 +[JsonDerivedType(typeof(TasksGetProgressResultProgressAgent), "agent")] +[JsonDerivedType(typeof(TasksGetProgressResultProgressShell), "shell")] +public partial class TasksGetProgressResultProgress { /// The type discriminator. [JsonPropertyName("type")] @@ -8104,1458 +8813,1187 @@ public partial class PushAttachment } -/// Optional line range to scope the attachment to a specific section of the file. +/// Timestamped display line for task progress output or recent agent activity. [Experimental(Diagnostics.Experimental)] -public sealed class PushAttachmentFileLineRange +public sealed class TaskProgressLine { - /// End line number (1-based, inclusive). - [JsonPropertyName("end")] - public long End { get; set; } + /// Display message, e.g., "β–Έ bash", "βœ“ edit src/foo.ts". + [JsonPropertyName("message")] + public string Message { get; set; } = string.Empty; - /// Start line number (1-based). - [JsonPropertyName("start")] - public long Start { get; set; } + /// ISO 8601 timestamp when this event occurred. + [JsonPropertyName("timestamp")] + public DateTimeOffset Timestamp { get; set; } } -/// File attachment. -/// The file variant of . -[Experimental(Diagnostics.Experimental)] -public partial class PushAttachmentFile : PushAttachment +/// 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 Type => "file"; - - /// User-facing display name for the attachment. - [JsonPropertyName("displayName")] - public required string DisplayName { get; set; } + public override string Type => "agent"; - /// Optional line range to scope the attachment to a specific section of the file. + /// The most recent intent reported by the agent. [JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)] - [JsonPropertyName("lineRange")] - public PushAttachmentFileLineRange? LineRange { get; set; } + [JsonPropertyName("latestIntent")] + public string? LatestIntent { get; set; } - /// Absolute file path. - [JsonPropertyName("path")] - public required string Path { get; set; } + /// Recent tool execution events converted to display lines. + [JsonPropertyName("recentActivity")] + public required IList RecentActivity { get; set; } } -/// Directory attachment. -/// The directory variant of . -[Experimental(Diagnostics.Experimental)] -public partial class PushAttachmentDirectory : PushAttachment +/// 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 Type => "directory"; + public override string Type => "shell"; - /// User-facing display name for the attachment. - [JsonPropertyName("displayName")] - public required string DisplayName { get; set; } + /// Process ID when available. + [JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)] + [JsonPropertyName("pid")] + public long? Pid { get; set; } - /// Absolute directory path. - [JsonPropertyName("path")] - public required string Path { get; set; } + /// Recent stdout/stderr lines from the running shell command. + [JsonPropertyName("recentOutput")] + public required string RecentOutput { get; set; } } -/// End position of the selection. +/// Progress information for the task, or null when no task with that ID is tracked. [Experimental(Diagnostics.Experimental)] -public sealed class PushAttachmentSelectionDetailsEnd +public sealed class TasksGetProgressResult { - /// 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; } + /// 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; } } -/// Start position of the selection. +/// Identifier of the background task to fetch progress for. [Experimental(Diagnostics.Experimental)] -public sealed class PushAttachmentSelectionDetailsStart +internal sealed class TasksGetProgressRequest { - /// Start character offset within the line (0-based). - [JsonPropertyName("character")] - public long Character { get; set; } + /// Task identifier (agent ID or shell ID). + [JsonPropertyName("id")] + public string Id { get; set; } = string.Empty; - /// Start line number (0-based). - [JsonPropertyName("line")] - public long Line { get; set; } + /// Target session identifier. + [JsonPropertyName("sessionId")] + public string SessionId { get; set; } = string.Empty; } -/// Position range of the selection within the file. +/// The first sync-waiting task that can currently be promoted to background mode. [Experimental(Diagnostics.Experimental)] -public sealed class PushAttachmentSelectionDetails +public sealed class TasksGetCurrentPromotableResult { - /// 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; } + /// 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; } } -/// Code selection attachment from an editor. -/// The selection variant of . +/// Identifies the target session. [Experimental(Diagnostics.Experimental)] -public partial class PushAttachmentSelection : PushAttachment +internal sealed class SessionTasksGetCurrentPromotableRequest { - /// - [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; } + /// Target session identifier. + [JsonPropertyName("sessionId")] + public string SessionId { get; set; } = string.Empty; } -/// GitHub issue, pull request, or discussion reference. -/// The github_reference variant of . +/// Indicates whether the task was successfully promoted to background mode. [Experimental(Diagnostics.Experimental)] -public partial class PushAttachmentGitHubReference : PushAttachment +public sealed class TasksPromoteToBackgroundResult { - /// - [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; } + /// Whether the task was successfully promoted to background mode. + [JsonPropertyName("promoted")] + public bool Promoted { get; set; } } -/// Pointer to a GitHub repository. +/// Identifier of the task to promote to background mode. [Experimental(Diagnostics.Experimental)] -public sealed class PushGitHubRepoRef +internal sealed class TasksPromoteToBackgroundRequest { - /// Numeric GitHub repository id. + /// Task identifier. [JsonPropertyName("id")] - public long? Id { get; set; } + public string Id { get; set; } = string.Empty; - /// 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; + /// Target session identifier. + [JsonPropertyName("sessionId")] + public string SessionId { get; set; } = string.Empty; } -/// Pointer to a GitHub commit. -/// The github_commit 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 PushAttachmentGitHubCommit : PushAttachment +public sealed class TasksPromoteCurrentToBackgroundResult { - /// - [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; } + /// 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; } +} - /// Repository the commit belongs to. - [JsonPropertyName("repo")] - public required PushGitHubRepoRef Repo { get; set; } +/// Identifies the target session. +[Experimental(Diagnostics.Experimental)] +internal sealed class SessionTasksPromoteCurrentToBackgroundRequest +{ + /// Target session identifier. + [JsonPropertyName("sessionId")] + public string SessionId { get; set; } = string.Empty; +} - /// URL to the commit on GitHub. - [JsonPropertyName("url")] - public required string Url { get; set; } +/// Indicates whether the background task was successfully cancelled. +[Experimental(Diagnostics.Experimental)] +public sealed class TasksCancelResult +{ + /// Whether the task was successfully cancelled. + [JsonPropertyName("cancelled")] + public bool Cancelled { get; set; } } -/// Pointer to a GitHub release. -/// The github_release variant of . +/// Identifier of the background task to cancel. [Experimental(Diagnostics.Experimental)] -public partial class PushAttachmentGitHubRelease : PushAttachment +internal sealed class TasksCancelRequest { - /// - [JsonIgnore] - public override string Type => "github_release"; + /// Task identifier. + [JsonPropertyName("id")] + public string Id { get; set; } = string.Empty; - /// Human-readable release name. - [JsonPropertyName("name")] - public required string Name { get; set; } + /// Target session identifier. + [JsonPropertyName("sessionId")] + public string SessionId { get; set; } = string.Empty; +} - /// Repository the release belongs to. - [JsonPropertyName("repo")] - public required PushGitHubRepoRef Repo { 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; } +} - /// Git tag the release is anchored to. - [JsonPropertyName("tagName")] - public required string TagName { get; set; } +/// Identifier of the completed or cancelled task to remove from tracking. +[Experimental(Diagnostics.Experimental)] +internal sealed class TasksRemoveRequest +{ + /// Task identifier. + [JsonPropertyName("id")] + public string Id { get; set; } = string.Empty; - /// URL to the release on GitHub. - [JsonPropertyName("url")] - public required string Url { get; set; } + /// Target session identifier. + [JsonPropertyName("sessionId")] + public string SessionId { get; set; } = string.Empty; } -/// Pointer to a GitHub Actions job. -/// The github_actions_job variant of . +/// Indicates whether the message was delivered, with an error message when delivery failed. [Experimental(Diagnostics.Experimental)] -public partial class PushAttachmentGitHubActionsJob : PushAttachment +public sealed class TasksSendMessageResult { - /// - [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; } + /// Error message if delivery failed. + [JsonPropertyName("error")] + public string? Error { get; set; } - /// Job id within the workflow run. - [JsonPropertyName("jobId")] - public required long JobId { get; set; } + /// Whether the message was successfully delivered or steered. + [JsonPropertyName("sent")] + public bool Sent { get; set; } +} - /// Display name of the job. - [JsonPropertyName("jobName")] - public required string JobName { get; set; } +/// Identifier of the target agent task, message content, and optional sender agent ID. +[Experimental(Diagnostics.Experimental)] +internal sealed class TasksSendMessageRequest +{ + /// Agent ID of the sender, if sent on behalf of another agent. + [JsonPropertyName("fromAgentId")] + public string? FromAgentId { get; set; } - /// Repository the workflow run belongs to. - [JsonPropertyName("repo")] - public required PushGitHubRepoRef Repo { get; set; } + /// Agent task identifier. + [JsonPropertyName("id")] + public string Id { get; set; } = string.Empty; - /// URL to the job on GitHub. - [JsonPropertyName("url")] - public required string Url { get; set; } + /// Message content to send to the agent. + [JsonPropertyName("message")] + public string Message { get; set; } = string.Empty; - /// Display name of the workflow the job ran in. - [JsonPropertyName("workflowName")] - public required string WorkflowName { get; set; } + /// Target session identifier. + [JsonPropertyName("sessionId")] + public string SessionId { get; set; } = string.Empty; } -/// Pointer to a GitHub repository. -/// The github_repository 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 PushAttachmentGitHubRepository : PushAttachment +public sealed class Skill { - /// - [JsonIgnore] - public override string Type => "github_repository"; + /// Optional freeform hint describing the skill's expected arguments, from the `argument-hint` frontmatter field. + [JsonPropertyName("argumentHint")] + public string? ArgumentHint { get; set; } - /// Short description of the repository. - [JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)] - [JsonPropertyName("description")] - public string? Description { get; set; } + /// Canonical slash command name used to invoke the skill, without the leading '/'. + [JsonPropertyName("commandName")] + public string? CommandName { 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; } + /// Description of what the skill does. + [JsonPropertyName("description")] + public string Description { get; set; } = string.Empty; - /// Repository pointer. - [JsonPropertyName("repo")] - public required PushGitHubRepoRef Repo { get; set; } + /// Whether the skill is currently enabled. + [JsonPropertyName("enabled")] + public bool Enabled { get; set; } - /// URL to the repository on GitHub. - [JsonPropertyName("url")] - public required string Url { get; set; } -} + /// Unique identifier for the skill. + [JsonPropertyName("name")] + public string Name { get; set; } = string.Empty; -/// One side of a file diff (head or base). -[Experimental(Diagnostics.Experimental)] -public sealed class PushAttachmentGitHubFileDiffSide -{ - /// Repository-relative path to the file. + /// Absolute path to the skill file. [JsonPropertyName("path")] - public string Path { get; set; } = string.Empty; + public string? Path { get; set; } - /// Git ref (branch, tag, or commit SHA) the file is read at. - [JsonPropertyName("ref")] - public string Ref { get; set; } = string.Empty; + /// Name of the plugin that provides the skill, when source is 'plugin'. + [JsonPropertyName("pluginName")] + public string? PluginName { get; set; } - /// Repository the file lives in. - [JsonPropertyName("repo")] - public PushGitHubRepoRef Repo { get => field ??= new(); 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; } } -/// Pointer to a single-file diff. At least one of `head` and `base` must be present. -/// The github_file_diff variant of . +/// Skills available to the session, with their enabled state. [Experimental(Diagnostics.Experimental)] -public partial class PushAttachmentGitHubFileDiff : PushAttachment +public sealed class SkillList { - /// - [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; } + /// Available skills. + [JsonPropertyName("skills")] + public IList Skills { get => field ??= []; set; } } -/// One side of a tree comparison (head or base). +/// Identifies the target session. [Experimental(Diagnostics.Experimental)] -public sealed class PushAttachmentGitHubTreeComparisonSide +internal sealed class SessionSkillsListRequest { - /// 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; + /// Target session identifier. + [JsonPropertyName("sessionId")] + public string SessionId { get; set; } = string.Empty; } -/// Pointer to a comparison between two git revisions. -/// The github_tree_comparison variant of . +/// Skill invocation record with name, path, content, allowed tools, and turn number. [Experimental(Diagnostics.Experimental)] -public partial class PushAttachmentGitHubTreeComparison : PushAttachment +public sealed class SkillsInvokedSkill { - /// - [JsonIgnore] - public override string Type => "github_tree_comparison"; + /// Tools that should be auto-approved when this skill is active, captured at invocation time. + [JsonPropertyName("allowedTools")] + public IList? AllowedTools { get; set; } - /// Base side of the comparison. - [JsonPropertyName("base")] - public required PushAttachmentGitHubTreeComparisonSide Base { get; set; } + /// Full content of the skill file. + [JsonPropertyName("content")] + public string Content { get; set; } = string.Empty; - /// Head side of the comparison. - [JsonPropertyName("head")] - public required PushAttachmentGitHubTreeComparisonSide Head { get; set; } + /// Turn number when the skill was invoked. + [JsonPropertyName("invokedAtTurn")] + public long InvokedAtTurn { get; set; } - /// URL to the comparison on GitHub. - [JsonPropertyName("url")] - public required string Url { get; set; } + /// Unique identifier for the skill. + [JsonPropertyName("name")] + public string Name { get; set; } = string.Empty; + + /// Path to the SKILL.md file. + [JsonPropertyName("path")] + public string Path { get; set; } = string.Empty; } -/// Generic GitHub URL reference. -/// The github_url variant of . +/// Skills invoked during this session, ordered by invocation time (most recent last). [Experimental(Diagnostics.Experimental)] -public partial class PushAttachmentGitHubUrl : PushAttachment +public sealed class SkillsGetInvokedResult { - /// - [JsonIgnore] - public override string Type => "github_url"; - - /// URL to the GitHub resource. - [JsonPropertyName("url")] - public required string Url { get; set; } + /// Skills invoked during this session, ordered by invocation time (most recent last). + [JsonPropertyName("skills")] + public IList Skills { get => field ??= []; set; } } -/// Pointer to a file in a GitHub repository at a specific ref. -/// The github_file variant of . +/// Identifies the target session. [Experimental(Diagnostics.Experimental)] -public partial class PushAttachmentGitHubFile : PushAttachment +internal sealed class SessionSkillsGetInvokedRequest { - /// - [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; } + /// Target session identifier. + [JsonPropertyName("sessionId")] + public string SessionId { get; set; } = string.Empty; } -/// Pointer to a line range inside a file in a GitHub repository. -/// The github_snippet variant of . +/// Name of the skill to enable for the session. [Experimental(Diagnostics.Experimental)] -public partial class PushAttachmentGitHubSnippet : PushAttachment +internal sealed class SkillsEnableRequest { - /// - [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; } + /// Name of the skill to enable. + [JsonPropertyName("name")] + public string Name { get; set; } = string.Empty; - /// URL to the snippet on GitHub (with line anchor). - [JsonPropertyName("url")] - public required string Url { get; set; } + /// Target session identifier. + [JsonPropertyName("sessionId")] + public string SessionId { get; set; } = string.Empty; } -/// Blob attachment with inline base64-encoded data. -/// The blob variant of . +/// Name of the skill to disable for the session. [Experimental(Diagnostics.Experimental)] -public partial class PushAttachmentBlob : PushAttachment +internal sealed class SkillsDisableRequest { - /// - [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; } + /// Name of the skill to disable. + [JsonPropertyName("name")] + public string Name { get; set; } = string.Empty; - /// MIME type of the inline data. - [JsonPropertyName("mimeType")] - public required string MimeType { get; set; } + /// Target session identifier. + [JsonPropertyName("sessionId")] + public string SessionId { get; set; } = string.Empty; } -/// Slim input shape for extension_context attachments; identity fields are runtime-derived. -/// The extension_context variant of . +/// Diagnostics from reloading skill definitions, with warnings and errors as separate lists. [Experimental(Diagnostics.Experimental)] -public partial class PushAttachmentExtensionContext : PushAttachment +public sealed class SkillsLoadDiagnostics { - /// - [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; } + /// Errors emitted while loading skills (e.g. skills that failed to load entirely). + [JsonPropertyName("errors")] + public IList Errors { get => field ??= []; 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; } + /// Warnings emitted while loading skills (e.g. skills that loaded but had issues). + [JsonPropertyName("warnings")] + public IList Warnings { get => field ??= []; set; } } -/// Parameters for session.extensions.sendAttachmentsToMessage. +/// Identifies the target session. [Experimental(Diagnostics.Experimental)] -internal sealed class SendAttachmentsToMessageParams +internal sealed class SessionSkillsReloadRequest { - /// 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. +/// Identifies the target session. [Experimental(Diagnostics.Experimental)] -internal sealed class HandlePendingToolCallRequest +internal sealed class SessionSkillsEnsureLoadedRequest { - /// 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. +/// Recorded MCP server connection failure. [Experimental(Diagnostics.Experimental)] -public sealed class ToolsInitializeAndValidateResult +public sealed class McpServerFailureInfo { + /// Failure message produced when the MCP server connection failed. + [JsonPropertyName("message")] + public string Message { get; set; } = string.Empty; + + /// epoch-ms timestamp at which the failure was recorded. + [JsonPropertyName("timestamp")] + public long Timestamp { get; set; } } -/// Identifies the target session. +/// Recorded MCP server pending-auth state. [Experimental(Diagnostics.Experimental)] -internal sealed class SessionToolsInitializeAndValidateRequest +public sealed class McpServerNeedsAuthInfo { - /// Target session identifier. - [JsonPropertyName("sessionId")] - public string SessionId { get; set; } = string.Empty; + /// epoch-ms timestamp at which the server signalled it needs authentication. + [JsonPropertyName("timestamp")] + public long Timestamp { get; set; } } -/// Lightweight metadata for a currently initialized session tool. +/// Host-level state, omitted when no MCP host is initialized. [Experimental(Diagnostics.Experimental)] -public sealed class CurrentToolMetadata +public sealed class McpHostState { - /// Whether the tool is loaded on demand via tool search. - [JsonPropertyName("deferLoading")] - public bool? DeferLoading { get; set; } + /// Names of currently-connected MCP clients. + [JsonPropertyName("clients")] + public IList Clients { get => field ??= []; set; } - /// Tool description. - [JsonPropertyName("description")] - public string Description { get; set; } = string.Empty; + /// Configured servers that are explicitly disabled. + [JsonPropertyName("disabledServers")] + public IList DisabledServers { get => field ??= []; set; } - /// JSON Schema for tool input. - [JsonPropertyName("input_schema")] - public IDictionary? InputSchema { get; set; } + /// Map of server name to recorded connection failure. + [JsonPropertyName("failedServers")] + public IDictionary FailedServers { get => field ??= new Dictionary(); set; } - /// MCP server name for MCP-backed tools. - [JsonPropertyName("mcpServerName")] - public string? McpServerName { get; set; } + /// Configured servers filtered out by MCP server policy. + [JsonPropertyName("filteredServers")] + public IList FilteredServers { get => field ??= []; set; } - /// Raw MCP tool name for MCP-backed tools. - [JsonPropertyName("mcpToolName")] - public string? McpToolName { get; set; } + /// Whether third-party MCP servers are policy-enabled for this session. + [JsonPropertyName("mcp3pEnabled")] + public bool Mcp3pEnabled { get; set; } - /// Model-facing tool name. - [JsonPropertyName("name")] - public string Name { get; set; } = string.Empty; + /// Map of server name to recorded pending-auth state. + [JsonPropertyName("needsAuthServers")] + public IDictionary NeedsAuthServers { get => field ??= new Dictionary(); set; } - /// Optional MCP/config namespaced tool name. - [JsonPropertyName("namespacedName")] - public string? NamespacedName { get; set; } + /// Names of servers with in-flight connection attempts. + [JsonPropertyName("pendingConnections")] + public IList PendingConnections { get => field ??= []; set; } } -/// Current lightweight tool metadata snapshot for the session. +/// MCP server status entry, including config source/plugin source and any connection error. [Experimental(Diagnostics.Experimental)] -public sealed class ToolsGetCurrentMetadataResult +public sealed class McpServer { - /// Current tool metadata, or null when tools have not been initialized yet. - [JsonPropertyName("tools")] - public IList? Tools { get; set; } + /// Error message if the server failed to connect. + [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; + + /// 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; } + + /// Connection status: connected, failed, needs-auth, pending, disabled, stopped, or not_configured. + [JsonPropertyName("status")] + public McpServerStatus Status { get; set; } +} + +/// MCP servers configured for the session, with their connection status and host-level state. +[Experimental(Diagnostics.Experimental)] +public sealed class McpServerList +{ + /// Host-level state, omitted when no MCP host is initialized. + [JsonPropertyName("host")] + public McpHostState? Host { get; set; } + + /// Configured MCP servers. + [JsonPropertyName("servers")] + public IList Servers { get => field ??= []; set; } } /// Identifies the target session. [Experimental(Diagnostics.Experimental)] -internal sealed class SessionToolsGetCurrentMetadataRequest +internal sealed class SessionMcpListRequest { /// Target session identifier. [JsonPropertyName("sessionId")] public string SessionId { get; set; } = string.Empty; } -/// Empty result after applying subagent settings. +/// Normalized MCP Apps discovery metadata from a tool's `_meta.ui` block. [Experimental(Diagnostics.Experimental)] -public sealed class ToolsUpdateSubagentSettingsResult +public sealed class 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. + [JsonPropertyName("resourceUri")] + public string? ResourceUri { get; set; } + + /// Tool visibility advertised by the server. When absent, MCP Apps defaults apply. + [JsonPropertyName("visibility")] + public IList? Visibility { get; set; } } -/// Subagent model, reasoning effort, and context tier settings. +/// MCP tool metadata with tool name, optional description, and normalized MCP Apps discovery metadata. [Experimental(Diagnostics.Experimental)] -public sealed class SubagentSettingsEntry +public sealed class McpTools { - /// Context tier override for matching subagents. - [JsonPropertyName("contextTier")] - public SubagentSettingsEntryContextTier? ContextTier { get; set; } + /// Tool description, when provided. + [JsonPropertyName("description")] + public string? Description { get; set; } - /// Reasoning effort override for matching subagents. - [JsonPropertyName("effortLevel")] - public string? EffortLevel { get; set; } + /// Tool name. + [JsonPropertyName("name")] + public string Name { get; set; } = string.Empty; - /// Model override for matching subagents. - [JsonPropertyName("model")] - public string? Model { get; set; } + /// 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; } } -/// Configured per-agent subagent overrides. -public sealed class UpdateSubagentSettingsRequestSubagents +/// Tools exposed by the connected MCP server. Throws when the server is not connected. +[Experimental(Diagnostics.Experimental)] +public sealed class McpListToolsResult { - /// 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; } + /// Tools exposed by the server. + [JsonPropertyName("tools")] + public IList Tools { get => field ??= []; set; } } -/// Subagent settings to apply to the current session. +/// Server name whose tool list should be returned. [Experimental(Diagnostics.Experimental)] -internal sealed class UpdateSubagentSettingsRequest +internal sealed class McpListToolsRequest { + /// 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; - - /// Subagent settings to apply, or null to clear the live session override. - [JsonPropertyName("subagents")] - public UpdateSubagentSettingsRequestSubagents? Subagents { get; set; } } -/// Optional filters controlling which command sources to include in the listing. +/// Name of the MCP server to enable for the session. [Experimental(Diagnostics.Experimental)] -public sealed class CommandsListRequest +internal sealed class McpEnableRequest { - /// 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; } + /// 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; - /// 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. +/// Name of the MCP server to disable for the session. [Experimental(Diagnostics.Experimental)] -internal sealed class CommandsListRequestWithSession +internal sealed class McpDisableRequest { - /// 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; } + /// 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; } -/// Result of invoking the slash command (text output, prompt to send to the agent, completion, or subcommand selection). -/// Polymorphic base type discriminated by kind. +/// Identifies the target session. [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 +internal sealed class SessionMcpReloadRequest { - /// 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; } - -/// Slash-command invocation result containing text output plus Markdown/ANSI rendering flags. -/// The text variant of . +/// Result of moving in-flight MCP loading to the background. [Experimental(Diagnostics.Experimental)] -public partial class SlashCommandInvocationResultText : SlashCommandInvocationResult +public sealed class MoveMcpLoadingToBackgroundResult { - /// - [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; } + /// Whether an in-flight MCP load was moved to the background, releasing turns that were waiting on it. False when no MCP load was in flight or the waiting turns had already been released. + [JsonPropertyName("movedToBackground")] + public bool MovedToBackground { 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 . +/// Identifies the target session. [Experimental(Diagnostics.Experimental)] -public partial class SlashCommandInvocationResultAgentPrompt : SlashCommandInvocationResult +internal sealed class SessionMcpMoveLoadingToBackgroundRequest { - /// - [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; } + /// Target session identifier. + [JsonPropertyName("sessionId")] + public string SessionId { get; set; } = string.Empty; } -/// Slash-command invocation result indicating completion, with optional message and settings-change flag. -/// The completed variant of . +/// MCP server allowed by policy, with server name and optional PII-free explanatory note. [Experimental(Diagnostics.Experimental)] -public partial class SlashCommandInvocationResultCompleted : SlashCommandInvocationResult +public sealed class McpAllowedServer { - /// - [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; } + /// Allowed server name. + [JsonPropertyName("name")] + public string Name { 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; } + /// PII-free note explaining why the server was allowed. + [JsonPropertyName("redactedNote")] + public string? RedactedNote { get; set; } } -/// Selectable slash-command subcommand option with name, description, and optional group label. +/// MCP server whose connection attempt failed. [Experimental(Diagnostics.Experimental)] -public sealed class SlashCommandSelectSubcommandOption +public sealed class McpFailedServer { - /// 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; } + /// The captured connection failure detail. + [JsonPropertyName("error")] + public string? Error { get; set; } - /// Subcommand name to invoke. + /// The config key of the server that failed to connect. [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 . +/// MCP server filtered by policy, with name, reason, and optional redacted reason. [Experimental(Diagnostics.Experimental)] -public partial class SlashCommandInvocationResultSelectSubcommand : SlashCommandInvocationResult +public sealed class McpFilteredServer { - /// - [JsonIgnore] - public override string Kind => "select-subcommand"; - - /// Parent command name that requires subcommand selection. - [JsonPropertyName("command")] - public required string Command { 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; } - /// Available subcommand options for the client to present. - [JsonPropertyName("options")] - public required IList Options { get; set; } + /// Filtered server name. + [JsonPropertyName("name")] + public string Name { 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; } + /// Human-readable filter reason. + [JsonPropertyName("reason")] + public string Reason { get; set; } = string.Empty; - /// Human-readable title for the selection UI. - [JsonPropertyName("title")] - public required string Title { get; set; } + /// PII-free filter reason. + [JsonPropertyName("redactedReason")] + public string? RedactedReason { get; set; } } -/// Slash command name and optional raw input string to invoke. +/// MCP server startup filtering result. [Experimental(Diagnostics.Experimental)] -internal sealed class CommandsInvokeRequest +internal sealed class McpStartServersResult { - /// Raw input after the command name. - [JsonPropertyName("input")] - public string? Input { get; set; } + /// Non-default servers allowed by policy. + [JsonPropertyName("allowedServers")] + public IList? AllowedServers { get; set; } - /// Command name. Leading slashes are stripped and the name is matched case-insensitively. - [JsonPropertyName("name")] - public string Name { get; set; } = string.Empty; + /// Servers whose connection attempt failed. + [JsonPropertyName("failedServers")] + public IList? FailedServers { 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 pending client-handled command was completed successfully. +/// 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 CommandsHandlePendingCommandResult +public sealed class McpExecuteSamplingResult { - /// 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. +/// Outcome of an MCP sampling execution: success result, failure error, or cancellation. [Experimental(Diagnostics.Experimental)] -internal sealed class CommandsHandlePendingCommandRequest +public sealed class McpSamplingExecutionResult { - /// Error message if the command handler failed. + /// 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; } + + /// Error description, present when action='failure'. [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; + /// 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; } } -/// Error message produced while executing the command, if 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. [Experimental(Diagnostics.Experimental)] -public sealed class ExecuteCommandResult +public sealed class McpExecuteSamplingRequest { - /// 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. +/// Identifiers and raw MCP CreateMessageRequest params used to run a sampling inference. [Experimental(Diagnostics.Experimental)] -internal sealed class ExecuteCommandParams +internal sealed class McpExecuteSamplingParams { - /// Argument string to pass to the command (empty string if none). - [JsonPropertyName("args")] - public string Args { get; set; } = string.Empty; + /// 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; } - /// Name of the slash command to invoke (without the leading '/'). - [JsonPropertyName("commandName")] - public string CommandName { 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; } + + /// 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 command was accepted into the local execution queue. +/// Indicates whether an in-flight sampling execution with the given requestId was found and cancelled. [Experimental(Diagnostics.Experimental)] -public sealed class EnqueueCommandResult +public sealed class McpCancelSamplingExecutionResult { - /// 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; } + /// 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; } } -/// Slash-prefixed command string to enqueue for FIFO processing. +/// The requestId previously passed to executeSampling that should be cancelled. [Experimental(Diagnostics.Experimental)] -internal sealed class EnqueueCommandParams +internal sealed class McpCancelSamplingExecutionParams { - /// 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; + /// 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; } -/// 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. +/// Env-value mode recorded on the session after the update. [Experimental(Diagnostics.Experimental)] -public partial class QueuedCommandResult +public sealed class McpSetEnvValueModeResult { - /// 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; } + /// Mode recorded on the session after the update. + [JsonPropertyName("mode")] + public McpSetEnvValueModeDetails Mode { get; set; } } -/// Queued-command request ID and the result indicating whether the host executed it (and whether to stop processing further queued commands). +/// Mode controlling how MCP server env values are resolved (`direct` or `indirect`). [Experimental(Diagnostics.Experimental)] -internal sealed class CommandsRespondToQueuedCommandRequest +internal sealed class McpSetEnvValueModeParams { - /// 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; } + /// 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; } -/// Telemetry engagement ID for the session, when available. +/// Indicates whether the auto-managed `github` MCP server was removed (false when nothing to remove). [Experimental(Diagnostics.Experimental)] -public sealed class SessionTelemetryEngagement +public sealed class McpRemoveGitHubResult { - /// Current telemetry engagement ID, when available. - [JsonPropertyName("engagementId")] - public string? EngagementId { get; set; } + /// 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 SessionTelemetryGetEngagementIdRequest +internal sealed class SessionMcpRemoveGitHubRequest { /// 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. +/// Result of configuring GitHub MCP. [Experimental(Diagnostics.Experimental)] -internal sealed class TelemetrySetFeatureOverridesRequest +internal sealed class McpConfigureGitHubResult { - /// 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; } + /// Whether GitHub MCP configuration changed. + [JsonPropertyName("changed")] + public bool Changed { get; set; } +} +/// Credential-free authentication identity used to configure GitHub MCP. +[Experimental(Diagnostics.Experimental)] +internal sealed class McpConfigureGitHubRequest +{ /// Target session identifier. [JsonPropertyName("sessionId")] public string SessionId { get; set; } = string.Empty; } -/// Transient answer generated from current conversation context. +/// 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)] -public sealed class UIEphemeralQueryResult +internal sealed class McpStartServerRequest { - /// Full assistant response text. - [JsonPropertyName("answer")] - public string Answer { get; set; } = string.Empty; + /// 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; } -/// Transient question to answer without adding it to conversation history. +/// 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)] -internal sealed class UIEphemeralQueryRequest +internal sealed class McpRestartServerRequest { - /// 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. - [JsonInclude] - [JsonPropertyName("abortSignal")] - internal JsonElement? AbortSignal { get; set; } - - /// 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. - [JsonInclude] - [JsonPropertyName("onChunk")] - internal JsonElement? OnChunk { 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; } - /// Question to answer from the current conversation context. - [JsonPropertyName("question")] - public string Question { get; set; } = string.Empty; + /// 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; } -/// The elicitation response (accept with form values, decline, or cancel). +/// Server name for an individual MCP server stop. [Experimental(Diagnostics.Experimental)] -public sealed class UIElicitationResponse +internal sealed class McpStopServerRequest { - /// The user's response: accept (submitted), decline (rejected), or cancel (dismissed). - [JsonPropertyName("action")] - public UIElicitationResponseAction Action { get; set; } + /// Name of the MCP server to stop. + [JsonPropertyName("serverName")] + public string ServerName { get; set; } = string.Empty; - /// The form values submitted by the user (present when action is 'accept'). - [JsonPropertyName("content")] - public IDictionary? Content { get; set; } + /// Target session identifier. + [JsonPropertyName("sessionId")] + public string SessionId { get; set; } = string.Empty; } -/// JSON Schema describing the form fields to present to the user. +/// Registration parameters for an external MCP client. [Experimental(Diagnostics.Experimental)] -public sealed class UIElicitationSchema +internal sealed class McpRegisterExternalClientRequest { - /// 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; } + /// Logical server name for the external client. + [JsonPropertyName("serverName")] + public string ServerName { get; set; } = string.Empty; - /// Schema type indicator (always 'object'). - [JsonPropertyName("type")] - public string Type { get; set; } = string.Empty; + /// Target session identifier. + [JsonPropertyName("sessionId")] + public string SessionId { get; set; } = string.Empty; } -/// Prompt message and JSON schema describing the form fields to elicit from the user. +/// Server name identifying the external client to remove. [Experimental(Diagnostics.Experimental)] -internal sealed class UIElicitationRequest +internal sealed class McpUnregisterExternalClientRequest { - /// 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; } + /// 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 elicitation response was accepted; false if it was already resolved by another client. +/// Whether the named MCP server is running. [Experimental(Diagnostics.Experimental)] -public sealed class UIElicitationResult +public sealed class McpIsServerRunningResult { - /// Whether the response was accepted. False if the request was already resolved by another client. - [JsonPropertyName("success")] - public bool Success { get; set; } + /// True if the server has an active client and transport. + [JsonPropertyName("running")] + public bool Running { get; set; } } -/// Pending elicitation request ID and the user's response (accept/decline/cancel + form values). +/// Server name to check running status for. [Experimental(Diagnostics.Experimental)] -internal sealed class UIHandlePendingElicitationRequest +internal sealed class McpIsServerRunningRequest { - /// 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 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; } -/// Indicates whether the pending UI request was resolved by this call. +/// Indicates whether the pending MCP OAuth response was accepted. [Experimental(Diagnostics.Experimental)] -public sealed class UIHandlePendingResult +public sealed class McpOauthHandlePendingResult { - /// 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. + /// Whether the response was accepted. False if the request was unknown, timed out, or already resolved. [JsonPropertyName("success")] public bool Success { get; set; } } -/// User response for a pending user-input request, with answer text and whether it was typed freeform. +/// Host response to the pending OAuth request. +/// Polymorphic base type discriminated by kind. [Experimental(Diagnostics.Experimental)] -public sealed class UIUserInputResponse +[JsonPolymorphic( + TypeDiscriminatorPropertyName = "kind", + UnknownDerivedTypeHandling = JsonUnknownDerivedTypeHandling.FallBackToBaseType)] +[JsonDerivedType(typeof(McpOauthPendingRequestResponseToken), "token")] +[JsonDerivedType(typeof(McpOauthPendingRequestResponseCancelled), "cancelled")] +public partial class McpOauthPendingRequestResponse { - /// 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; } + /// The type discriminator. + [JsonPropertyName("kind")] + public virtual string Kind { get; set; } = string.Empty; } -/// Request ID of a pending `user_input.requested` event and the user's response. + +/// The token variant of . [Experimental(Diagnostics.Experimental)] -internal sealed class UIHandlePendingUserInputRequest +public partial class McpOauthPendingRequestResponseToken : McpOauthPendingRequestResponse { - /// The unique request ID from the user_input.requested event. - [JsonPropertyName("requestId")] - public string RequestId { get; set; } = string.Empty; + /// + [JsonIgnore] + public override string Kind => "token"; - /// 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; } + /// Access token acquired by the SDK host. + [JsonPropertyName("accessToken")] + public required string AccessToken { get; set; } - /// Target session identifier. - [JsonPropertyName("sessionId")] - public string SessionId { get; set; } = string.Empty; + /// 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; } } -/// Optional sampling result payload. Omit to reject/cancel the sampling request without providing a result. +/// The cancelled variant of . [Experimental(Diagnostics.Experimental)] -public sealed class UIHandlePendingSamplingResponse +public partial class McpOauthPendingRequestResponseCancelled : McpOauthPendingRequestResponse { + /// + [JsonIgnore] + public override string Kind => "cancelled"; } -/// Request ID of a pending `sampling.requested` event and an optional sampling result payload (omit to reject). +/// Pending MCP OAuth request ID and host-provided token or cancellation response. [Experimental(Diagnostics.Experimental)] -internal sealed class UIHandlePendingSamplingRequest +internal sealed class McpOauthHandlePendingRequest { - /// The unique request ID from the sampling.requested event. + /// OAuth request identifier from the mcp.oauth_required 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; } + /// 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; } -/// Request ID of a pending `auto_mode_switch.requested` event and the user's response. +/// Identifies the MCP server whose persisted OAuth credentials were updated. [Experimental(Diagnostics.Experimental)] -internal sealed class UIHandlePendingAutoModeSwitchRequest +internal sealed class McpOauthAuthenticationStateChangedRequest { - /// The unique request ID from the auto_mode_switch.requested event. - [JsonPropertyName("requestId")] - public string RequestId { get; set; } = string.Empty; + /// 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; } - /// 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; } + /// 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; } -/// The user's selected action for an exhausted session limit. +/// OAuth authorization URL the caller should open, or empty when cached tokens already authenticated the server. [Experimental(Diagnostics.Experimental)] -public sealed class UISessionLimitsExhaustedResponse +public sealed class McpOauthLoginResult { - /// 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; } + /// 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; } } -/// Request ID of a pending `session_limits_exhausted.requested` event and the user's selected limit action. +/// 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 UIHandlePendingSessionLimitsExhaustedRequest +internal sealed class McpOauthLoginRequest { - /// 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; } + /// 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; } - /// Target session identifier. - [JsonPropertyName("sessionId")] - public string SessionId { get; set; } = string.Empty; -} + /// 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; } -/// 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; } + /// 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; } - /// Whether subsequent edits should be auto-approved without confirmation. - [JsonPropertyName("autoApproveEdits")] - public bool? AutoApproveEdits { get; set; } + /// 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; } - /// Feedback from the user when they declined the plan or requested changes. - [JsonPropertyName("feedback")] - public string? Feedback { 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; } - /// The action the user selected. Defaults to 'autopilot' when autoApproveEdits is true, otherwise 'interactive'. - [JsonPropertyName("selectedAction")] - public UIExitPlanModeAction? SelectedAction { 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; } -/// 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; + /// 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; } - /// 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; } + /// 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; } -/// 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). +/// Passive MCP OAuth probe result. `authenticated` means the server accepted the probe request while an OAuth-origin access token was attached; it does not prove the server required or independently validated that token. The probe does not make a second unauthenticated request. Failed is an expected probe-domain outcome; JSON-RPC errors are reserved for API-call failures. +/// Polymorphic base type discriminated by status. [Experimental(Diagnostics.Experimental)] -public sealed class UIRegisterDirectAutoModeSwitchHandlerResult +[JsonPolymorphic( + TypeDiscriminatorPropertyName = "status", + UnknownDerivedTypeHandling = JsonUnknownDerivedTypeHandling.FallBackToBaseType)] +[JsonDerivedType(typeof(McpOauthProbeResultNoAuthRequired), "no-auth-required")] +[JsonDerivedType(typeof(McpOauthProbeResultAuthenticated), "authenticated")] +[JsonDerivedType(typeof(McpOauthProbeResultNeedsAuth), "needs-auth")] +[JsonDerivedType(typeof(McpOauthProbeResultFailed), "failed")] +public partial class McpOauthProbeResult { - /// 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; + /// The type discriminator. + [JsonPropertyName("status")] + public virtual string Status { get; set; } = string.Empty; } -/// Identifies the target session. + +/// The no-auth-required variant of . [Experimental(Diagnostics.Experimental)] -internal sealed class SessionUiRegisterDirectAutoModeSwitchHandlerRequest +public partial class McpOauthProbeResultNoAuthRequired : McpOauthProbeResult { - /// Target session identifier. - [JsonPropertyName("sessionId")] - public string SessionId { get; set; } = string.Empty; + /// + [JsonIgnore] + public override string Status => "no-auth-required"; + + /// HTTP response returned by the server. + [JsonPropertyName("httpResponse")] + public required McpOauthHttpResponse HttpResponse { get; set; } } -/// Indicates whether the handle was active and the registration count was decremented. +/// The authenticated variant of . [Experimental(Diagnostics.Experimental)] -public sealed class UIUnregisterDirectAutoModeSwitchHandlerResult +public partial class McpOauthProbeResultAuthenticated : McpOauthProbeResult { - /// True if the handle was active and decremented the counter; false if the handle was unknown. - [JsonPropertyName("unregistered")] - public bool Unregistered { get; set; } + /// + [JsonIgnore] + public override string Status => "authenticated"; + + /// HTTP response returned by the server. + [JsonPropertyName("httpResponse")] + public required McpOauthHttpResponse HttpResponse { get; set; } } -/// Opaque handle previously returned by `registerDirectAutoModeSwitchHandler` to release. +/// The needs-auth variant of . [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 +public partial class McpOauthProbeResultNeedsAuth : McpOauthProbeResult { - /// 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; } -} + /// + [JsonIgnore] + public override string Status => "needs-auth"; -/// 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; } + /// HTTP 401 or 403 response returned by the server. + [JsonPropertyName("httpResponse")] + public required McpOauthHttpResponse HttpResponse { get; set; } - /// Gets or sets the rules value. - [JsonPropertyName("rules")] - public IList Rules { get => field ??= []; set; } + /// Why authentication is needed. + [JsonPropertyName("reason")] + public required McpOauthProbeNeedsAuthReason Reason { get; set; } - /// Allowed values for the `PermissionsConfigureAdditionalContentExclusionPolicyScope` enumeration. - [JsonPropertyName("scope")] - public PermissionsConfigureAdditionalContentExclusionPolicyScope Scope { get; set; } + /// Parsed WWW-Authenticate challenge parameters, when present and parseable. + [JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)] + [JsonPropertyName("wwwAuthenticateParams")] + public McpOauthWWWAuthenticateParams? WwwAuthenticateParams { 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. +/// The failed variant of . [Experimental(Diagnostics.Experimental)] -public sealed class PermissionPathsConfig +public partial class McpOauthProbeResultFailed : McpOauthProbeResult { - /// 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; } + /// + [JsonIgnore] + public override string Status => "failed"; - /// If true, the runtime allows access to all paths without prompting. Equivalent to constructing an UnrestrictedPathManager. - [JsonPropertyName("unrestricted")] - public bool? Unrestricted { get; set; } + /// Human-readable probe failure detail. + [JsonPropertyName("error")] + public required string Error { 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; } + /// HTTP response returned by the server, when the probe reached the server and captured the complete response. + [JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)] + [JsonPropertyName("httpResponse")] + public McpOauthHttpResponse? HttpResponse { get; set; } } -/// If specified, replaces the session's approved/denied permission rules. Omit to leave the current rules unchanged. +/// Remote MCP server name for a passive OAuth status probe. [Experimental(Diagnostics.Experimental)] -public sealed class PermissionRulesSet +internal sealed class McpOauthProbeRequest { - /// Rules that auto-approve matching requests. - [JsonPropertyName("approved")] - public IList Approved { get => field ??= []; set; } + /// Name of the configured remote 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; - /// Rules that auto-deny matching requests. - [JsonPropertyName("denied")] - public IList Denied { get => field ??= []; 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. +/// Indicates whether the pending MCP OAuth response was accepted. [Experimental(Diagnostics.Experimental)] -public sealed class PermissionUrlsConfig +public sealed class McpOauthRespondResult { - /// 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; } + /// Whether the response was accepted. False if the request was unknown, timed out, or already resolved. + [JsonPropertyName("success")] + public bool Success { get; set; } } -/// Patch of permission policy fields to apply (omit a field to leave it unchanged). +/// Pending MCP OAuth request id to respond to. [Experimental(Diagnostics.Experimental)] -internal sealed class PermissionsConfigureParams +internal sealed class McpOauthRespondRequest { - /// 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; } + /// 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; - - /// 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. +/// Indicates whether the pending MCP headers refresh response was accepted. [Experimental(Diagnostics.Experimental)] -public sealed class PermissionRequestResult +public sealed class McpHeadersHandlePendingHeadersRefreshRequestResult { - /// Whether the permission request was handled successfully. + /// Whether the response was accepted. False if the request was unknown, timed out, or already resolved. [JsonPropertyName("success")] public bool Success { get; set; } } -/// The client's response to the pending permission prompt. +/// 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(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 +[JsonDerivedType(typeof(McpHeadersHandlePendingHeadersRefreshRequestHeaders), "headers")] +[JsonDerivedType(typeof(McpHeadersHandlePendingHeadersRefreshRequestNone), "none")] +public partial class McpHeadersHandlePendingHeadersRefreshRequest { /// The type discriminator. [JsonPropertyName("kind")] @@ -9563,3485 +10001,12766 @@ public partial class PermissionDecision } -/// Permission-decision request variant to approve only the current permission request. -/// The approve-once variant of . +/// The headers variant of . [Experimental(Diagnostics.Experimental)] -public partial class PermissionDecisionApproveOnce : PermissionDecision +public partial class McpHeadersHandlePendingHeadersRefreshRequestHeaders : McpHeadersHandlePendingHeadersRefreshRequest { /// [JsonIgnore] - public override string Kind => "approve-once"; -} + public override string Kind => "headers"; -/// 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(PermissionDecisionApproveForSessionApprovalExtensionPermissionAccess), "extension-permission-access")] -public partial class PermissionDecisionApproveForSessionApproval -{ - /// The type discriminator. - [JsonPropertyName("kind")] - public virtual string Kind { get; set; } = string.Empty; + /// 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; } } - -/// Session-scoped approval details for specific command identifiers. -/// The commands variant of . +/// The none variant of . [Experimental(Diagnostics.Experimental)] -public partial class PermissionDecisionApproveForSessionApprovalCommands : PermissionDecisionApproveForSessionApproval +public partial class McpHeadersHandlePendingHeadersRefreshRequestNone : McpHeadersHandlePendingHeadersRefreshRequest { /// [JsonIgnore] - public override string Kind => "commands"; - - /// Command identifiers covered by this approval. - [JsonPropertyName("commandIdentifiers")] - public required IList CommandIdentifiers { get; set; } + public override string Kind => "none"; } -/// Session-scoped approval details for read-only filesystem operations. -/// The read variant of . +/// MCP headers refresh request id and the host response. [Experimental(Diagnostics.Experimental)] -public partial class PermissionDecisionApproveForSessionApprovalRead : PermissionDecisionApproveForSessionApproval +internal sealed class McpHeadersHandlePendingHeadersRefreshRequestRequest { - /// - [JsonIgnore] - public override string Kind => "read"; -} + /// Headers refresh request identifier from mcp.headers_refresh_required. + [JsonPropertyName("requestId")] + public string RequestId { get; set; } = string.Empty; -/// 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"; + /// 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; } -/// Session-scoped approval details for an MCP server tool, or all tools on the server when `toolName` is null. -/// The mcp variant of . +/// MCP Apps resource content with URI, optional MIME type, text or base64 blob, and resource metadata. [Experimental(Diagnostics.Experimental)] -public partial class PermissionDecisionApproveForSessionApprovalMcp : PermissionDecisionApproveForSessionApproval +public sealed class McpAppsResourceContent { - /// - [JsonIgnore] - public override string Kind => "mcp"; + /// Resource-level metadata (CSP, permissions, etc.). + [JsonPropertyName("_meta")] + public IDictionary? Meta { get; set; } - /// MCP server name. - [JsonPropertyName("serverName")] - public required string ServerName { get; set; } + /// Base64-encoded binary content. + [JsonPropertyName("blob")] + public string? Blob { get; set; } - /// MCP tool name, or null to cover every tool on the server. - [JsonPropertyName("toolName")] - public string? ToolName { get; set; } -} + /// MIME type of the content. + [JsonPropertyName("mimeType")] + public string? MimeType { 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"; + /// Text content (e.g. HTML). + [JsonPropertyName("text")] + public string? Text { get; set; } - /// MCP server name. - [JsonPropertyName("serverName")] - public required string ServerName { get; set; } + /// The resource URI (typically ui://...). + [JsonPropertyName("uri")] + public string Uri { get; set; } = string.Empty; } -/// Session-scoped approval details for writes to long-term memory. -/// The memory variant of . +/// Resource contents returned by the MCP server. [Experimental(Diagnostics.Experimental)] -public partial class PermissionDecisionApproveForSessionApprovalMemory : PermissionDecisionApproveForSessionApproval +public sealed class McpAppsReadResourceResult { - /// - [JsonIgnore] - public override string Kind => "memory"; + /// Resource contents returned by the server. + [JsonPropertyName("contents")] + public IList Contents { get => field ??= []; set; } } -/// Session-scoped approval details for a custom tool, keyed by tool name. -/// The custom-tool variant of . +/// MCP server and resource URI to fetch. [Experimental(Diagnostics.Experimental)] -public partial class PermissionDecisionApproveForSessionApprovalCustomTool : PermissionDecisionApproveForSessionApproval +internal sealed class McpAppsReadResourceRequest { - /// - [JsonIgnore] - public override string Kind => "custom-tool"; - - /// Custom tool name. - [JsonPropertyName("toolName")] - public required string ToolName { get; set; } -} + /// 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; -/// 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"; + /// Target session identifier. + [JsonPropertyName("sessionId")] + public string SessionId { get; set; } = string.Empty; - /// Optional operation identifier; when omitted, the approval covers all extension management operations. - [JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)] - [JsonPropertyName("operation")] - public string? Operation { get; set; } + /// Resource URI (typically ui://...). + [JsonPropertyName("uri")] + public string Uri { get; set; } = string.Empty; } -/// Session-scoped approval details for an extension's permission-gated capability access, keyed by extension name. -/// The extension-permission-access variant of . +/// App-callable tools from the named MCP server. [Experimental(Diagnostics.Experimental)] -public partial class PermissionDecisionApproveForSessionApprovalExtensionPermissionAccess : PermissionDecisionApproveForSessionApproval +public sealed class McpAppsListToolsResult { - /// - [JsonIgnore] - public override string Kind => "extension-permission-access"; - - /// Extension name. - [JsonPropertyName("extensionName")] - public required string ExtensionName { get; set; } + /// App-callable tools from the server. + [JsonPropertyName("tools")] + public IList> Tools { get => field ??= []; 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 . +/// MCP server to list app-callable tools for. [Experimental(Diagnostics.Experimental)] -public partial class PermissionDecisionApproveForSession : PermissionDecision +internal sealed class McpAppsListToolsRequest { - /// - [JsonIgnore] - public override string Kind => "approve-for-session"; + /// **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; - /// Session-scoped approval to remember (tool prompts only; omitted for path/url prompts). - [JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)] - [JsonPropertyName("approval")] - public PermissionDecisionApproveForSessionApproval? Approval { 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; - /// URL domain to approve for the rest of the session (URL prompts only). - [JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)] - [JsonPropertyName("domain")] - public string? Domain { get; set; } + /// Target session identifier. + [JsonPropertyName("sessionId")] + public string SessionId { get; set; } = string.Empty; } -/// Approval to persist for this location. -/// Polymorphic base type discriminated by kind. +/// MCP server, tool name, and arguments to invoke from an MCP App view. [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 McpAppsCallToolRequest { - /// The type discriminator. - [JsonPropertyName("kind")] - public virtual string Kind { get; set; } = string.Empty; -} + /// 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; -/// 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"; + /// 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; - /// Command identifiers covered by this approval. - [JsonPropertyName("commandIdentifiers")] - public required IList CommandIdentifiers { get; set; } -} + /// Target session identifier. + [JsonPropertyName("sessionId")] + public string SessionId { get; set; } = string.Empty; -/// 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"; + /// MCP tool name. + [JsonPropertyName("toolName")] + public string ToolName { get; set; } = string.Empty; } -/// Location-scoped approval details for filesystem write operations. -/// The write variant of . +/// Host context advertised to MCP App guests. [Experimental(Diagnostics.Experimental)] -public partial class PermissionDecisionApproveForLocationApprovalWrite : PermissionDecisionApproveForLocationApproval +public sealed class McpAppsSetHostContextDetails { - /// - [JsonIgnore] - public override string Kind => "write"; -} + /// Display modes the host supports. + [JsonPropertyName("availableDisplayModes")] + public IList? AvailableDisplayModes { get; set; } -/// 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"; + /// Current display mode (SEP-1865). + [JsonPropertyName("displayMode")] + public McpAppsSetHostContextDetailsDisplayMode? DisplayMode { get; set; } - /// MCP server name. - [JsonPropertyName("serverName")] - public required string ServerName { get; set; } + /// BCP-47 locale, e.g. 'en-US'. + [JsonPropertyName("locale")] + public string? Locale { get; set; } - /// MCP tool name, or null to cover every tool on the server. - [JsonPropertyName("toolName")] - public string? ToolName { get; set; } -} + /// Platform type for responsive design. + [JsonPropertyName("platform")] + public McpAppsSetHostContextDetailsPlatform? Platform { 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"; + /// UI theme preference per SEP-1865. + [JsonPropertyName("theme")] + public McpAppsSetHostContextDetailsTheme? Theme { get; set; } - /// MCP server name. - [JsonPropertyName("serverName")] - public required string ServerName { 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; } } -/// Location-scoped approval details for writes to long-term memory. -/// The memory variant of . +/// Host context to advertise to MCP App guests. [Experimental(Diagnostics.Experimental)] -public partial class PermissionDecisionApproveForLocationApprovalMemory : PermissionDecisionApproveForLocationApproval +internal sealed class McpAppsSetHostContextRequest { - /// - [JsonIgnore] - public override string Kind => "memory"; + /// 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; } -/// Location-scoped approval details for a custom tool, keyed by tool name. -/// The custom-tool variant of . +/// Current host context. [Experimental(Diagnostics.Experimental)] -public partial class PermissionDecisionApproveForLocationApprovalCustomTool : PermissionDecisionApproveForLocationApproval +public sealed class McpAppsHostContextDetails { - /// - [JsonIgnore] - public override string Kind => "custom-tool"; + /// Display modes the host supports. + [JsonPropertyName("availableDisplayModes")] + public IList? AvailableDisplayModes { get; set; } - /// Custom tool name. - [JsonPropertyName("toolName")] - public required string ToolName { 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; } } -/// Location-scoped approval details for extension-management operations, optionally narrowed by operation. -/// The extension-management variant of . +/// Current host context advertised to MCP App guests. [Experimental(Diagnostics.Experimental)] -public partial class PermissionDecisionApproveForLocationApprovalExtensionManagement : PermissionDecisionApproveForLocationApproval +public sealed class McpAppsHostContext { - /// - [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; } + /// Current host context. + [JsonPropertyName("context")] + public McpAppsHostContextDetails Context { get => field ??= new(); set; } } -/// Location-scoped approval details for an extension's permission-gated capability access, keyed by extension name. -/// The extension-permission-access variant of . +/// Identifies the target session. [Experimental(Diagnostics.Experimental)] -public partial class PermissionDecisionApproveForLocationApprovalExtensionPermissionAccess : PermissionDecisionApproveForLocationApproval +internal sealed class SessionMcpAppsGetHostContextRequest { - /// - [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; } -/// 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 . +/// Capability negotiation snapshot. [Experimental(Diagnostics.Experimental)] -public partial class PermissionDecisionApproveForLocation : PermissionDecision +public sealed class McpAppsDiagnoseCapability { - /// - [JsonIgnore] - public override string Kind => "approve-for-location"; + /// Whether the runtime advertises `extensions.io.modelcontextprotocol/ui` to MCP servers. + [JsonPropertyName("advertised")] + public bool Advertised { get; set; } - /// Approval to persist for this location. - [JsonPropertyName("approval")] - public required PermissionDecisionApproveForLocationApproval Approval { get; set; } + /// Whether the MCP_APPS feature flag (or COPILOT_MCP_APPS env override) is on. + [JsonPropertyName("featureFlagEnabled")] + public bool FeatureFlagEnabled { get; set; } - /// Location key (git root or cwd) to persist the approval to. - [JsonPropertyName("locationKey")] - public required string LocationKey { get; set; } + /// Whether the session has the `mcp-apps` capability. + [JsonPropertyName("sessionHasMcpApps")] + public bool SessionHasMcpApps { get; set; } } -/// Permission-decision request variant to permanently approve a URL domain across sessions. -/// The approve-permanently variant of . +/// What the server returned for this session. [Experimental(Diagnostics.Experimental)] -public partial class PermissionDecisionApprovePermanently : PermissionDecision +public sealed class McpAppsDiagnoseServer { - /// - [JsonIgnore] - public override string Kind => "approve-permanently"; + /// Whether the named server is currently connected. + [JsonPropertyName("connected")] + public bool Connected { get; set; } - /// URL domain to approve permanently. - [JsonPropertyName("domain")] - public required string Domain { 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; } } -/// Permission-decision request variant to reject a pending permission request, with optional feedback. -/// The reject variant of . +/// Diagnostic snapshot of MCP Apps wiring for the named server. [Experimental(Diagnostics.Experimental)] -public partial class PermissionDecisionReject : PermissionDecision +public sealed class McpAppsDiagnoseResult { - /// - [JsonIgnore] - public override string Kind => "reject"; + /// Capability negotiation snapshot. + [JsonPropertyName("capability")] + public McpAppsDiagnoseCapability Capability { get => field ??= new(); set; } - /// Optional feedback explaining the rejection. - [JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)] - [JsonPropertyName("feedback")] - public string? Feedback { get; set; } + /// What the server returned for this session. + [JsonPropertyName("server")] + public McpAppsDiagnoseServer Server { get => field ??= new(); set; } } -/// Permission-decision variant indicating no user was available to confirm the request. -/// The user-not-available variant of . +/// MCP server to diagnose MCP Apps wiring for. [Experimental(Diagnostics.Experimental)] -public partial class PermissionDecisionUserNotAvailable : PermissionDecision +internal sealed class McpAppsDiagnoseRequest { - /// - [JsonIgnore] - public override string Kind => "user-not-available"; + /// 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; } -/// Permission-decision variant indicating the request was approved. -/// The approved variant of . +/// MCP resource content with URI, optional MIME type, text or base64 blob, and resource metadata. [Experimental(Diagnostics.Experimental)] -public partial class PermissionDecisionApproved : PermissionDecision +public sealed class McpResourceContent { - /// - [JsonIgnore] - public override string Kind => "approved"; + /// 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; } -/// Permission-decision variant indicating approval was remembered for the session, with approval details. -/// The approved-for-session variant of . +/// Resource contents returned by the MCP server. [Experimental(Diagnostics.Experimental)] -public partial class PermissionDecisionApprovedForSession : PermissionDecision +public sealed class McpResourcesReadResult { - /// - [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; } + /// Resource contents returned by the server. + [JsonPropertyName("contents")] + public IList Contents { get => field ??= []; set; } } -/// Permission-decision variant indicating approval was persisted for a project location, with approval details and location key. -/// The approved-for-location variant of . +/// MCP server and resource URI to fetch. [Experimental(Diagnostics.Experimental)] -public partial class PermissionDecisionApprovedForLocation : PermissionDecision +internal sealed class McpResourcesReadRequest { - /// - [JsonIgnore] - public override string Kind => "approved-for-location"; + /// 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; - /// The approval to persist for this location. - [JsonPropertyName("approval")] - public required UserToolSessionApproval Approval { get; set; } + /// Target session identifier. + [JsonPropertyName("sessionId")] + public string SessionId { get; set; } = string.Empty; - /// The location key (git root or cwd) to persist the approval to. - [JsonPropertyName("locationKey")] - public required string LocationKey { get; set; } + /// Resource URI. + [JsonPropertyName("uri")] + public string Uri { get; set; } = string.Empty; } -/// Permission-decision variant indicating the request was cancelled before use, with an optional reason. -/// The cancelled variant of . +/// Standard MCP resource annotations plus preserved non-standard annotation fields. [Experimental(Diagnostics.Experimental)] -public partial class PermissionDecisionCancelled : PermissionDecision +public sealed class McpResourceAnnotations { - /// - [JsonIgnore] - public override string Kind => "cancelled"; + /// Server-provided non-standard annotation fields preserved from the MCP response. + [JsonPropertyName("additionalProperties")] + public IDictionary? AdditionalProperties { get; set; } - /// Optional explanation of why the request was cancelled. - [JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)] - [JsonPropertyName("reason")] - public string? Reason { get; set; } -} + /// Intended audience roles for this resource. + [JsonPropertyName("audience")] + public IList? Audience { 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"; + /// Last-modified timestamp hint. + [JsonPropertyName("lastModified")] + public string? LastModified { get; set; } - /// Rules that denied the request. - [JsonPropertyName("rules")] - public required IList Rules { get; set; } + /// Priority hint for model/client use. + [JsonPropertyName("priority")] + public double? Priority { 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 . +/// A resource icon descriptor plus preserved non-standard icon fields. [Experimental(Diagnostics.Experimental)] -public partial class PermissionDecisionDeniedNoApprovalRuleAndCouldNotRequestFromUser : PermissionDecision +public sealed class McpResourceIcon { - /// - [JsonIgnore] - public override string Kind => "denied-no-approval-rule-and-could-not-request-from-user"; -} + /// Server-provided non-standard icon fields preserved from the MCP response. + [JsonPropertyName("additionalProperties")] + public IDictionary? AdditionalProperties { get; set; } -/// 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"; + /// Icon MIME type, when known. + [JsonPropertyName("mimeType")] + public string? MimeType { get; set; } - /// Optional feedback from the user explaining the denial. - [JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)] - [JsonPropertyName("feedback")] - public string? Feedback { get; set; } + /// Icon sizes hint. + [JsonPropertyName("sizes")] + public string? Sizes { get; set; } - /// Whether to force-reject the current agent turn. - [JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)] - [JsonPropertyName("forceReject")] - public bool? ForceReject { 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; } } -/// Permission-decision variant indicating denial by content-exclusion policy, with path and message. -/// The denied-by-content-exclusion-policy variant of . +/// 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 partial class PermissionDecisionDeniedByContentExclusionPolicy : PermissionDecision +public sealed class McpResource { - /// - [JsonIgnore] - public override string Kind => "denied-by-content-exclusion-policy"; + /// Resource-level metadata. + [JsonPropertyName("_meta")] + public IDictionary? Meta { get; set; } - /// Human-readable explanation of why the path was excluded. - [JsonPropertyName("message")] - public required string Message { get; set; } + /// Server-provided non-standard descriptor fields preserved from the MCP response. + [JsonPropertyName("additionalProperties")] + public IDictionary? AdditionalProperties { get; set; } - /// File path that triggered the exclusion. - [JsonPropertyName("path")] - public required string Path { 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; } -/// Permission-decision variant indicating denial by a permission request hook, with optional message and interrupt flag. -/// The denied-by-permission-request-hook variant of . +/// One page of resources advertised by the named MCP server. [Experimental(Diagnostics.Experimental)] -public partial class PermissionDecisionDeniedByPermissionRequestHook : PermissionDecision +public sealed class McpResourcesListResult { - /// - [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; } + /// Opaque cursor for the next page, if the server has more resources. + [JsonPropertyName("nextCursor")] + public string? NextCursor { get; set; } - /// Optional message from the hook explaining the denial. - [JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)] - [JsonPropertyName("message")] - public string? Message { get; set; } + /// Resources advertised by the server (proxied MCP `resources/list`). + [JsonPropertyName("resources")] + public IList Resources { get => field ??= []; set; } } -/// Pending permission request ID and the decision to apply (approve/reject and scope). +/// MCP server whose resources to enumerate. [Experimental(Diagnostics.Experimental)] -internal sealed class PermissionDecisionRequest +internal sealed class McpResourcesListRequest { - /// Request ID of the pending permission request. - [JsonPropertyName("requestId")] - public string RequestId { get; set; } = string.Empty; + /// Opaque MCP pagination cursor from a prior `nextCursor` value. + [JsonPropertyName("cursor")] + public string? Cursor { get; set; } - /// The client's response to the pending permission prompt. - [JsonPropertyName("result")] - public PermissionDecision Result { get => field ??= new(); 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; } -/// Pending permission prompt reconstructed from event history, with request ID and user-facing prompt details. +/// 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 PendingPermissionRequest +public sealed class McpResourceTemplate { - /// The user-facing permission prompt details (commands, write, read, mcp, url, memory, custom-tool, path, hook). - [JsonPropertyName("request")] - public PermissionPromptRequest Request { get; set; } = null!; + /// Resource-template-level metadata. + [JsonPropertyName("_meta")] + public IDictionary? Meta { get; set; } - /// Unique identifier for the pending permission request. - [JsonPropertyName("requestId")] - public string RequestId { get; set; } = string.Empty; -} + /// Server-provided non-standard descriptor fields preserved from the MCP response. + [JsonPropertyName("additionalProperties")] + public IDictionary? AdditionalProperties { get; set; } -/// 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; } -} + /// Model/client annotations associated with this template. + [JsonPropertyName("annotations")] + public McpResourceAnnotations? Annotations { 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; + /// 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; } -/// Indicates whether the operation succeeded. +/// One page of resource templates advertised by the named MCP server. [Experimental(Diagnostics.Experimental)] -public sealed class PermissionsSetApproveAllResult +public sealed class McpResourcesListTemplatesResult { - /// Whether the operation succeeded. - [JsonPropertyName("success")] - public bool Success { get; set; } + /// 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; } } -/// Allow-all toggle for tool permission requests, with an optional telemetry source. +/// MCP server whose resource templates to enumerate. [Experimental(Diagnostics.Experimental)] -internal sealed class PermissionsSetApproveAllRequest +internal sealed class McpResourcesListTemplatesRequest { - /// Whether to auto-approve all tool permission requests. - [JsonPropertyName("enabled")] - public bool Enabled { get; set; } + /// 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; - - /// 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. +/// Session plugin metadata, with name, marketplace, optional version, and enabled state. [Experimental(Diagnostics.Experimental)] -public sealed class AllowAllPermissionSetResult +public sealed class Plugin { - /// Authoritative full allow-all state after the mutation. + /// Whether the plugin is currently enabled. [JsonPropertyName("enabled")] public bool Enabled { get; set; } - /// Authoritative allow-all mode after the mutation. - [JsonPropertyName("mode")] - public PermissionsAllowAllMode? Mode { get; set; } + /// Marketplace the plugin came from. + [JsonPropertyName("marketplace")] + public string Marketplace { get; set; } = string.Empty; - /// Whether the operation succeeded. - [JsonPropertyName("success")] - public bool Success { get; set; } + /// Plugin name. + [JsonPropertyName("name")] + public string Name { get; set; } = string.Empty; + + /// Installed version. + [JsonPropertyName("version")] + public string? Version { get; set; } } -/// Allow-all mode to apply for the session. +/// Plugins installed for the session, with their enabled state and version metadata. [Experimental(Diagnostics.Experimental)] -internal sealed class PermissionsSetAllowAllRequest +public sealed class PluginList { - /// 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's active model is used. - [JsonPropertyName("model")] - public string? Model { get; set; } + /// 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; - - /// 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. +/// RPC data type for SessionPluginsReload operations. [Experimental(Diagnostics.Experimental)] -public sealed class AllowAllPermissionState +public sealed class SessionPluginsReloadRequest { - /// Whether full allow-all permissions are currently active. - [JsonPropertyName("enabled")] - public bool Enabled { get; set; } + /// 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; } - /// Current allow-all mode. - [JsonPropertyName("mode")] - public PermissionsAllowAllMode? Mode { 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; } } -/// No parameters. +/// RPC data type for SessionPluginsReloadRequestWithSession operations. [Experimental(Diagnostics.Experimental)] -internal sealed class PermissionsGetAllowAllRequest +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; } -/// Indicates whether the operation succeeded. +/// 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 PermissionsModifyRulesResult +public sealed class ProviderSessionToken { - /// Whether the operation succeeded. - [JsonPropertyName("success")] - public bool Success { get; set; } + /// 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; } -/// Scope and add/remove instructions for modifying session- or location-scoped permission rules. +/// A snapshot of the provider endpoint the session is currently configured to talk to. [Experimental(Diagnostics.Experimental)] -internal sealed class PermissionsModifyRulesParams +public sealed class ProviderEndpoint { - /// Rules to add to the scope. Applied before `remove`/`removeAll`. - [JsonPropertyName("add")] - public IList? Add { get; set; } + /// A credential the caller should use with this endpoint. Omitted only when the endpoint accepts unauthenticated requests. + [JsonPropertyName("apiKey")] + public string? ApiKey { get; set; } - /// Specific rules to remove from the scope. Ignored when `removeAll` is true. - [JsonPropertyName("remove")] - public IList? Remove { get; set; } + /// Base URL to pass to the LLM client library. + [Url] + [StringSyntax(StringSyntaxAttribute.Uri)] + [JsonPropertyName("baseUrl")] + public string BaseUrl { 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; } + /// HTTP headers the caller must include on every outbound request. + [JsonPropertyName("headers")] + public IDictionary Headers { get => field ??= new Dictionary(); 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; } + /// 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; } - /// Target session identifier. - [JsonPropertyName("sessionId")] - public string SessionId { get; set; } = string.Empty; + /// 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; } } -/// Indicates whether the operation succeeded. +/// RPC data type for SessionProviderGetEndpoint operations. [Experimental(Diagnostics.Experimental)] -public sealed class PermissionsSetRequiredResult +public sealed class SessionProviderGetEndpointRequest { - /// Whether the operation succeeded. - [JsonPropertyName("success")] - public bool Success { get; set; } + /// 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; } } -/// Toggles whether permission prompts should be bridged into session events for this client. +/// RPC data type for SessionProviderGetEndpointRequestWithSession operations. [Experimental(Diagnostics.Experimental)] -internal sealed class PermissionsSetRequiredRequest +internal sealed class SessionProviderGetEndpointRequestWithSession { - /// 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; } + /// 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; } -/// Indicates whether the operation succeeded. +/// The selectable model entries synthesized for the models added by this call. [Experimental(Diagnostics.Experimental)] -public sealed class PermissionsResetSessionApprovalsResult +public sealed class ProviderAddResult { - /// Whether the operation succeeded. - [JsonPropertyName("success")] - public bool Success { get; set; } + /// 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; } } -/// No parameters; clears all session-scoped tool permission approvals. +/// A BYOK model definition referencing a named provider. [Experimental(Diagnostics.Experimental)] -internal sealed class PermissionsResetSessionApprovalsRequest +public sealed class ProviderModelConfig { - /// Target session identifier. - [JsonPropertyName("sessionId")] - public string SessionId { get; set; } = string.Empty; + /// 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 configured provider 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; } } -/// Indicates whether the operation succeeded. +/// Azure-specific provider options. [Experimental(Diagnostics.Experimental)] -public sealed class PermissionsNotifyPromptShownResult +public sealed class ProviderConfigAzure { - /// Whether the operation succeeded. - [JsonPropertyName("success")] - public bool Success { get; set; } + /// API version. When set, uses the versioned deployment route. When omitted, uses the GA versionless v1 route. + [JsonPropertyName("apiVersion")] + public string? ApiVersion { get; set; } } -/// Notification payload describing the permission prompt that the client just rendered. +/// External SDK input for a named custom model provider. Ingested by the native protocol boundary before host dispatch. [Experimental(Diagnostics.Experimental)] -internal sealed class PermissionPromptShownNotification +public sealed class NamedProviderConfig { - /// 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; + /// Static API key used to authenticate provider requests. + [JsonPropertyName("apiKey")] + public string? ApiKey { get; set; } - /// Target session identifier. - [JsonPropertyName("sessionId")] - public string SessionId { get; set; } = string.Empty; -} + /// Azure authentication configuration for the provider. + [JsonPropertyName("azure")] + public ProviderConfigAzure? Azure { get; set; } -/// 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; } + /// Base URL for provider API requests. + [JsonPropertyName("baseUrl")] + public string BaseUrl { get; set; } = string.Empty; - /// The primary working directory for this session. - [JsonPropertyName("primary")] - public string Primary { get; set; } = string.Empty; + /// Static bearer token used to authenticate provider requests. + [JsonPropertyName("bearerToken")] + public string? BearerToken { get; set; } + + /// Whether the host supplies bearer tokens dynamically. + [JsonPropertyName("hasBearerTokenProvider")] + public bool? HasBearerTokenProvider { get; set; } + + /// Additional HTTP headers included with provider requests. + [JsonPropertyName("headers")] + public IDictionary? Headers { get; set; } + + /// Unique provider name used to qualify model selection IDs. + [JsonPropertyName("name")] + public string Name { get; set; } = string.Empty; + + /// Transport used to communicate with the provider. + [JsonPropertyName("transport")] + public ProviderConfigTransport? Transport { get; set; } + + /// Provider protocol family. + [JsonPropertyName("type")] + public ProviderConfigType? Type { get; set; } + + /// Wire API used to communicate with the provider. + [JsonPropertyName("wireApi")] + public ProviderConfigWireApi? WireApi { get; set; } } -/// No parameters; returns the session's allow-listed directories. +/// 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 PermissionsPathsListRequest +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 operation succeeded. +/// Indicates whether the session options patch was applied successfully. [Experimental(Diagnostics.Experimental)] -public sealed class PermissionsPathsAddResult +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; } } -/// Directory path to add to the session's allowed directories. +/// Source descriptor for a `session.options.update` content-exclusion rule, with source name and type. [Experimental(Diagnostics.Experimental)] -internal sealed class PermissionPathsAddParams +public sealed class OptionsUpdateAdditionalContentExclusionPolicyRuleSource { - /// 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; + /// Name of the policy source. + [JsonPropertyName("name")] + public string Name { get; set; } = string.Empty; + + /// Type of the policy source. + [JsonPropertyName("type")] + public string Type { get; set; } = string.Empty; } -/// Indicates whether the operation succeeded. +/// Single content-exclusion rule supplied to `session.options.update`, with paths, match conditions, and source. [Experimental(Diagnostics.Experimental)] -public sealed class PermissionsPathsUpdatePrimaryResult +public sealed class OptionsUpdateAdditionalContentExclusionPolicyRule { - /// Whether the operation succeeded. - [JsonPropertyName("success")] - public bool Success { get; set; } + /// Conditions of which at least one must match. + [JsonPropertyName("ifAnyMatch")] + public IList? IfAnyMatch { get; set; } + + /// Conditions none of which may match. + [JsonPropertyName("ifNoneMatch")] + public IList? IfNoneMatch { get; set; } + + /// Path patterns covered by this rule. + [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; } } -/// Directory path to set as the session's new primary working directory. +/// Content-exclusion policy supplied to `session.options.update`, with rules, last-updated data, and scope. [Experimental(Diagnostics.Experimental)] -internal sealed class PermissionPathsUpdatePrimaryParams +public sealed class OptionsUpdateAdditionalContentExclusionPolicy { - /// Directory to set as the new primary working directory for the session's permission policy. - [JsonPropertyName("path")] - public string Path { get; set; } = string.Empty; + /// Opaque policy update timestamp supplied by the host. + [JsonPropertyName("last_updated_at")] + public JsonElement LastUpdatedAt { get; set; } - /// Target session identifier. - [JsonPropertyName("sessionId")] - public string SessionId { get; set; } = string.Empty; + /// Content-exclusion rules to apply. + [JsonPropertyName("rules")] + public IList Rules { get => field ??= []; set; } + + /// Allowed values for the `OptionsUpdateAdditionalContentExclusionPolicyScope` enumeration. + [JsonPropertyName("scope")] + public OptionsUpdateAdditionalContentExclusionPolicyScope Scope { get; set; } } -/// Indicates whether the supplied path is within the session's allowed directories. +/// Options scoped to the built-in CAPI (Copilot API) provider. [Experimental(Diagnostics.Experimental)] -public sealed class PermissionPathsAllowedCheckResult +public sealed class CapiSessionOptions { - /// Whether the path is within the session's allowed directories. - [JsonPropertyName("allowed")] - public bool Allowed { get; set; } + /// 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; } } -/// Path to evaluate against the session's allowed directories. +/// Installed plugin record for a session, with marketplace, version, install time, enabled state, cache path, and source. [Experimental(Diagnostics.Experimental)] -internal sealed class PermissionPathsAllowedCheckParams +public sealed class SessionInstalledPlugin { - /// Path to check against the session's allowed directories. - [JsonPropertyName("path")] - public string Path { get; set; } = string.Empty; + /// Path where the plugin is cached locally. + [JsonPropertyName("cache_path")] + public string? CachePath { get; set; } - /// Target session identifier. - [JsonPropertyName("sessionId")] - public string SessionId { get; set; } = string.Empty; + /// 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; + + /// Absolute path of the marketplace directory a live plugin was resolved from. Present only on live, never-persisted records β€” those synthesized at session start for a directory/local marketplace, whose cache_path points at the real plugin directory on disk rather than a copy under the installed-plugins cache. Its presence is what marks a record as live, and no record carrying it is ever written to the persisted installedPlugins key. + [JsonPropertyName("installed_from")] + public string? InstalledFrom { get; set; } + + /// 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; } } -/// Indicates whether the supplied path is within the session's workspace directory. +/// Custom model-provider configuration (BYOK). [Experimental(Diagnostics.Experimental)] -public sealed class PermissionPathsWorkspaceCheckResult +public sealed class ProviderConfig { - /// Whether the path is within the session workspace directory. - [JsonPropertyName("allowed")] - public bool Allowed { get; set; } + /// 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; } + + /// Overrides for model capabilities when they cannot be inferred from modelId. + [JsonPropertyName("modelCapabilities")] + public ModelCapabilitiesOverride? ModelCapabilities { 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 name used for model and telemetry attribution. + [JsonPropertyName("providerName")] + public string? ProviderName { 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; } } -/// Path to evaluate against the session's workspace (primary) directory. +/// Credential-injection capability flags applied while the sandbox is enabled. For the same capability independent of sandboxing, and matched to the credential's GitHub host, see `shell.credentials`; the two are additive. [Experimental(Diagnostics.Experimental)] -internal sealed class PermissionPathsWorkspaceCheckParams +public sealed class SandboxConfigAuth { - /// Path to check against the session workspace directory. - [JsonPropertyName("path")] - public string Path { get; set; } = string.Empty; + /// 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; } - /// Target session identifier. - [JsonPropertyName("sessionId")] - public string SessionId { get; set; } = string.Empty; + /// 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; } } -/// Resolved location-permissions key and type. +/// macOS seatbelt experimental options. [Experimental(Diagnostics.Experimental)] -public sealed class PermissionLocationResolveResult +public sealed class SandboxConfigUserPolicyExperimentalSeatbelt { - /// 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; } + /// Whether the macOS seatbelt profile may access the keychain. + [JsonPropertyName("keychainAccess")] + public bool? KeychainAccess { get; set; } } -/// Working directory to resolve into a location-permissions key. +/// Platform-specific experimental policy fields. [Experimental(Diagnostics.Experimental)] -internal sealed class PermissionLocationResolveParams +public sealed class SandboxConfigUserPolicyExperimental { - /// 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; + /// macOS seatbelt experimental options. + [JsonPropertyName("seatbelt")] + public SandboxConfigUserPolicyExperimentalSeatbelt? Seatbelt { get; set; } } -/// Summary of persisted location permissions applied to the session. +/// Filesystem rules to merge into the base policy. [Experimental(Diagnostics.Experimental)] -public sealed class PermissionLocationApplyResult +public sealed class SandboxConfigUserPolicyFilesystem { - /// 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 to clear the policy when the session exits. + [JsonPropertyName("clearPolicyOnExit")] + public bool? ClearPolicyOnExit { get; set; } - /// Whether a different location was applied since the previous apply call. - [JsonPropertyName("changed")] - public bool Changed { get; set; } + /// Paths explicitly denied. + [JsonPropertyName("deniedPaths")] + public IList? DeniedPaths { get; set; } - /// Location key used in the location-permissions store. - [JsonPropertyName("locationKey")] - public string LocationKey { get; set; } = string.Empty; + /// Paths granted read-only access. + [JsonPropertyName("readonlyPaths")] + public IList? ReadonlyPaths { get; set; } - /// Whether the location is a git repo or directory. - [JsonPropertyName("locationType")] - public PermissionLocationType LocationType { get; set; } + /// Paths granted read/write access. + [JsonPropertyName("readwritePaths")] + public IList? ReadwritePaths { get; set; } } -/// Working directory to load persisted location permissions for. +/// HTTP proxy configuration for sandboxed traffic. [Experimental(Diagnostics.Experimental)] -internal sealed class PermissionLocationApplyParams +public sealed class SandboxConfigUserPolicyNetworkProxy { - /// Target session identifier. - [JsonPropertyName("sessionId")] - public string SessionId { get; set; } = string.Empty; + /// 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; } - /// Working directory whose persisted location permissions should be applied. - [JsonPropertyName("workingDirectory")] - public string WorkingDirectory { get; set; } = string.Empty; + /// 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; } } -/// Indicates whether the operation succeeded. +/// Network rules to merge into the base policy. [Experimental(Diagnostics.Experimental)] -public sealed class PermissionsLocationsAddToolApprovalResult +public sealed class SandboxConfigUserPolicyNetwork { - /// Whether the operation succeeded. - [JsonPropertyName("success")] - public bool Success { get; set; } -} + /// Whether traffic to local/loopback addresses is allowed. + [JsonPropertyName("allowLocalNetwork")] + public bool? AllowLocalNetwork { 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(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"; + /// Whether outbound network traffic is allowed at all. + [JsonPropertyName("allowOutbound")] + public bool? AllowOutbound { get; set; } - /// Command identifiers covered by this approval. - [JsonPropertyName("commandIdentifiers")] - public required IList CommandIdentifiers { 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; } } -/// Location-persisted tool approval details for read-only filesystem operations. -/// The read variant of . +/// macOS seatbelt-specific options. [Experimental(Diagnostics.Experimental)] -public partial class PermissionsLocationsAddToolApprovalDetailsRead : PermissionsLocationsAddToolApprovalDetails +public sealed class SandboxConfigUserPolicySeatbelt { - /// - [JsonIgnore] - public override string Kind => "read"; + /// Whether the macOS seatbelt profile may access the keychain. + [JsonPropertyName("keychainAccess")] + public bool? KeychainAccess { get; set; } } -/// Location-persisted tool approval details for filesystem write operations. -/// The write variant of . +/// User-managed sandbox policy fragment merged into the auto-discovered base policy. [Experimental(Diagnostics.Experimental)] -public partial class PermissionsLocationsAddToolApprovalDetailsWrite : PermissionsLocationsAddToolApprovalDetails +public sealed class SandboxConfigUserPolicy { - /// - [JsonIgnore] - public override string Kind => "write"; -} + /// Deprecated legacy location for `seatbelt`; read only when the top-level `seatbelt` is absent. + [JsonPropertyName("experimental")] + public SandboxConfigUserPolicyExperimental? Experimental { get; set; } -/// 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"; + /// Filesystem rules to merge into the base policy. + [JsonPropertyName("filesystem")] + public SandboxConfigUserPolicyFilesystem? Filesystem { get; set; } - /// MCP server name. - [JsonPropertyName("serverName")] - public required string ServerName { get; set; } + /// Network rules to merge into the base policy. + [JsonPropertyName("network")] + public SandboxConfigUserPolicyNetwork? Network { get; set; } - /// MCP tool name, or null to cover every tool on the server. - [JsonPropertyName("toolName")] - public string? ToolName { get; set; } + /// macOS seatbelt options to merge into the base policy. + [JsonPropertyName("seatbelt")] + public SandboxConfigUserPolicySeatbelt? Seatbelt { get; set; } } -/// Location-persisted tool approval details for MCP sampling requests from a server. -/// The mcp-sampling variant of . +/// Resolved sandbox configuration. [Experimental(Diagnostics.Experimental)] -public partial class PermissionsLocationsAddToolApprovalDetailsMcpSampling : PermissionsLocationsAddToolApprovalDetails +public sealed class SandboxConfig { - /// - [JsonIgnore] - public override string Kind => "mcp-sampling"; + /// Whether to auto-add the current working directory to readwritePaths. Default: true. + [JsonPropertyName("addCurrentWorkingDirectory")] + public bool? AddCurrentWorkingDirectory { get; set; } - /// MCP server name. - [JsonPropertyName("serverName")] - public required string ServerName { get; set; } -} + /// Whether to auto-grant read access to tool directories discovered on PATH and in toolchain environment variables (GOROOT, JAVA_HOME, VIRTUAL_ENV, and similar), and to common developer-tool caches, config, and toolchains. Writable grants cover scratch caches, the Unix GitHub CLI cache, and Cargo's registry, git store, and lock/tracker files. A relocated CARGO_HOME gets the same narrow split: registry and git are read-write; bin is read-only; the home root, config.toml, and credentials.toml stay ungranted. Set to false to disable every grant listed above; user-installed toolchains and caches then need explicit userPolicy.filesystem readonlyPaths and readwritePaths entries. The working directory (see addCurrentWorkingDirectory), temporary storage, session log paths, and system locations follow their own rules and stay granted. Default: true (enabled by default; set to false to opt out). + [JsonPropertyName("allowDevToolAccess")] + public bool? AllowDevToolAccess { 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"; -} + /// Credential-injection capability flags. + [JsonPropertyName("auth")] + public SandboxConfigAuth? Auth { get; set; } -/// 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"; + /// Whether sandboxing is enabled for the session. + [JsonPropertyName("enabled")] + public bool Enabled { get; set; } - /// Custom tool name. - [JsonPropertyName("toolName")] - public required string ToolName { get; set; } + /// User-managed sandbox policy fragment merged into the auto-discovered base policy. + [JsonPropertyName("userPolicy")] + public SandboxConfigUserPolicy? UserPolicy { 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 +/// +/// Command-scoped GitHub credential injection for the shell commands an agent runs. +/// +/// Each channel is opt-in and independent, and injection is scoped to the individual command +/// spawn: the credential is resolved from the session's *current* authentication at every spawn +/// and reaches only spawns whose script actually invokes `git` or `gh`. Because nothing is +/// retained between spawns, replacing the session credential (`session.gitHubAuth.setCredentials`) +/// changes what the next spawned command presents β€” which seeding a credential into the runtime +/// process's own environment cannot do, since a child's environment is fixed at `exec`. +/// +/// The credential is matched to the host it authenticates to, so a github.com credential is never +/// presented to a GitHub Enterprise host and vice versa. Where a channel cannot express that +/// boundary it injects nothing rather than crossing it -- see `gh` below. +/// +/// This is independent of `sandboxConfig`: it is a decision about which identity the agent +/// presents, not about what the agent may touch, and it works on every platform whether or not +/// an OS sandboxing backend is available. `sandboxConfig.auth` remains the sandbox-scoped +/// spelling and is additive with this one. +/// +[Experimental(Diagnostics.Experimental)] +public sealed class ShellCredentials { - /// - [JsonIgnore] - public override string Kind => "extension-management"; + /// + /// Whether to authenticate the agent's `gh` commands as the session's GitHub credential, by + /// exporting `GH_TOKEN` to a spawn that runs `gh`. Any inherited `gh` credential is removed from + /// spawns that do not, so the credential stays command-scoped. + /// + /// Applies to a github.com credential only. `gh` picks its credential variable from the host a + /// command targets rather than the one the credential belongs to, and the command can choose that + /// target, so `GH_ENTERPRISE_TOKEN` would offer a single-tenant enterprise credential to every + /// other enterprise host. A session whose credential is enterprise-scoped therefore runs `gh` + /// unauthenticated; its `git` commands are unaffected, because `http.<host>.extraheader` is scoped + /// to one host by construction. Default: false (opt-in). + /// + [JsonPropertyName("gh")] + public bool? Gh { get; set; } - /// Optional operation identifier; when omitted, the approval covers all extension management operations. - [JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)] - [JsonPropertyName("operation")] - public string? Operation { get; set; } + /// + /// Whether to authenticate the agent's `git` commands as the session's GitHub credential, by + /// injecting an `http.<host>.extraheader` (plus `insteadOf` rewrites so SSH-spelled remotes for + /// that host use the authenticated HTTPS transport). Applied only to a spawn that runs a + /// remote-contacting `git` subcommand. Default: false (opt-in). + /// + [JsonPropertyName("git")] + public bool? Git { 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 . +/// A host-provided script sourced before each built-in shell command when its shell target matches the active shell. [Experimental(Diagnostics.Experimental)] -public partial class PermissionsLocationsAddToolApprovalDetailsExtensionPermissionAccess : PermissionsLocationsAddToolApprovalDetails +public sealed class ShellInitScript { - /// - [JsonIgnore] - public override string Kind => "extension-permission-access"; + /// Path to the script to source. + [JsonPropertyName("path")] + public string Path { get; set; } = string.Empty; - /// Extension name. - [JsonPropertyName("extensionName")] - public required string ExtensionName { get; set; } + /// Built-in shell that may source this script. + [JsonPropertyName("shell")] + public ShellInitScriptShell Shell { get; set; } } -/// Location-scoped tool approval to persist. +/// Per-session settings for built-in shell tools. [Experimental(Diagnostics.Experimental)] -internal sealed class PermissionLocationAddToolApprovalParams +public sealed class ShellOptions { - /// Tool approval to persist and apply. - [JsonPropertyName("approval")] - public PermissionsLocationsAddToolApprovalDetails Approval { get => field ??= new(); set; } + /// Command-scoped GitHub credential injection for shell commands. + [JsonPropertyName("credentials")] + public ShellCredentials? Credentials { get; set; } - /// Location key (git root or cwd) to persist the approval to. - [JsonPropertyName("locationKey")] - public string LocationKey { get; set; } = string.Empty; + /// Controls automatic non-interactive profile loading where supported. Explicit initScripts are unaffected. + [JsonPropertyName("initProfile")] + public ShellInitProfile? InitProfile { get; set; } - /// Target session identifier. - [JsonPropertyName("sessionId")] - public string SessionId { get; set; } = string.Empty; -} + /// + /// 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; } -/// Folder trust check result. -[Experimental(Diagnostics.Experimental)] -public sealed class FolderTrustCheckResult -{ - /// Whether the folder is trusted. - [JsonPropertyName("trusted")] - public bool Trusted { 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; } } -/// Folder path to check for trust. +/// Patch of mutable session options to apply to the running session. [Experimental(Diagnostics.Experimental)] -internal sealed class FolderTrustCheckParams +internal sealed class SessionUpdateOptionsParams { - /// 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; -} + /// Additional content-exclusion policies to merge into the session's policy set. + [Experimental(Diagnostics.Experimental)] + [JsonPropertyName("additionalContentExclusionPolicies")] + public IList? AdditionalContentExclusionPolicies { get; set; } -/// Indicates whether the operation succeeded. -[Experimental(Diagnostics.Experimental)] -public sealed class PermissionsFolderTrustAddTrustedResult -{ - /// Whether the operation succeeded. - [JsonPropertyName("success")] - public bool Success { get; set; } -} + /// Runtime context discriminator (e.g., `cli`, `actions`). + [JsonPropertyName("agentContext")] + public string? AgentContext { 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; + /// Whether to include instructions from every MCP server in the system prompt instead of only allowlisted servers. + [JsonPropertyName("allowAllMcpServerInstructions")] + public bool? AllowAllMcpServerInstructions { get; set; } - /// Target session identifier. - [JsonPropertyName("sessionId")] - public string SessionId { get; set; } = string.Empty; -} + /// Whether to disable the `ask_user` tool (encourages autonomous behavior). + [JsonPropertyName("askUserDisabled")] + public bool? AskUserDisabled { get; set; } -/// Indicates whether the operation succeeded. -[Experimental(Diagnostics.Experimental)] -public sealed class PermissionsUrlsSetUnrestrictedModeResult -{ - /// Whether the operation succeeded. - [JsonPropertyName("success")] - public bool Success { get; set; } -} + /// Allowlist of tool names available to this session. + [JsonPropertyName("availableTools")] + public IList? AvailableTools { 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; } + /// Options scoped to the built-in CAPI (Copilot API) provider. + [JsonPropertyName("capi")] + public CapiSessionOptions? Capi { get; set; } - /// Target session identifier. - [JsonPropertyName("sessionId")] - public string SessionId { get; set; } = string.Empty; -} + /// Identifier of the client driving the session. + [JsonPropertyName("clientName")] + public string? ClientName { get; set; } -/// 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; + /// Whether to include the `Co-authored-by` trailer in commit messages. + [JsonPropertyName("coauthorEnabled")] + public bool? CoauthorEnabled { get; set; } - /// The GitHub repository name (without owner). - [JsonPropertyName("name")] - public string Name { get; set; } = string.Empty; + /// 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; } - /// The GitHub owner (user or organization) of the target repository. - [JsonPropertyName("owner")] - public string Owner { get; set; } = string.Empty; -} + /// Whether to allow auto-mode continuation across turns. + [JsonPropertyName("continueOnAutoMode")] + public bool? ContinueOnAutoMode { get; set; } -/// 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; } + /// Override URL for the Copilot API endpoint. + [JsonPropertyName("copilotUrl")] + public string? CopilotUrl { get; set; } - /// The repository the remote session targets. - [JsonPropertyName("repository")] - public MetadataSnapshotRemoteMetadataRepository Repository { get => field ??= new(); set; } + /// Whether to default custom agents to local-only execution. + [JsonPropertyName("customAgentsLocalOnly")] + public bool? CustomAgentsLocalOnly { get; 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; } + /// Instruction source IDs to exclude from the system prompt. + [JsonPropertyName("disabledInstructionSources")] + public IList? DisabledInstructionSources { get; set; } - /// Whether the remote task originated from Copilot Coding Agent (cca) or a CLI `--remote` invocation. - [JsonPropertyName("taskType")] - public MetadataSnapshotRemoteMetadataTaskType? TaskType { get; set; } -} + /// Skill IDs that should be excluded from this session. + [JsonPropertyName("disabledSkills")] + public IList? DisabledSkills { 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; } + /// Whether to enable loading of `.github/hooks/` filesystem hooks. Separate from the SDK callback hook mechanism. + [JsonPropertyName("enableFileHooks")] + public bool? EnableFileHooks { get; set; } - /// ISO 8601 timestamp when the workspace was created. - [JsonPropertyName("created_at")] - public DateTimeOffset? CreatedAt { 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; } - /// Current working directory at session start. - [JsonPropertyName("cwd")] - public string? Cwd { 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; } - /// Resolved git root for cwd, if any. - [JsonPropertyName("git_root")] - public string? GitRoot { get; set; } + /// Whether to surface reasoning-summary events from the model. + [JsonPropertyName("enableReasoningSummaries")] + public bool? EnableReasoningSummaries { get; set; } - /// Repository host type, if known. - [JsonPropertyName("host_type")] - public WorkspaceSummaryHostType? HostType { get; set; } + /// Whether shell-script safety heuristics are enabled. + [JsonPropertyName("enableScriptSafety")] + public bool? EnableScriptSafety { 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; + /// Whether to enable cross-session store writes and reads. + [JsonPropertyName("enableSessionStore")] + public bool? EnableSessionStore { get; set; } - /// Display name for the session, if set. - [JsonPropertyName("name")] - public string? Name { get; set; } + /// Whether to enable skill directory scanning and loading. Falls back to enableConfigDiscovery when unset. + [JsonPropertyName("enableSkills")] + public bool? EnableSkills { get; set; } - /// Repository identifier in 'owner/repo' or 'org/project/repo' format, if any. - [JsonPropertyName("repository")] - public string? Repository { get; set; } + /// Whether to stream model responses. + [JsonPropertyName("enableStreaming")] + public bool? EnableStreaming { get; set; } - /// ISO 8601 timestamp when the workspace was last updated. - [JsonPropertyName("updated_at")] - public DateTimeOffset? UpdatedAt { 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; } - /// Whether the display name was explicitly set by the user. - [JsonPropertyName("user_named")] - public bool? UserNamed { 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; } -/// 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; } + /// Whether subagent callback events should be forwarded into the session event log sink. + [JsonPropertyName("eventsLogIncludesSubagents")] + public bool? EventsLogIncludesSubagents { get; set; } - /// Runtime client name associated with the session (telemetry identifier). - [JsonPropertyName("clientName")] - public string? ClientName { 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; } - /// The current agent mode for this session (e.g., 'interactive', 'plan', 'autopilot'). - [JsonPropertyName("currentMode")] - public MetadataSnapshotCurrentMode CurrentMode { get; set; } + /// Denylist of tool names for this session. + [JsonPropertyName("excludedTools")] + public IList? ExcludedTools { get; set; } - /// User-provided name supplied at session construction (via `--name`), if any. Immutable after construction. - [JsonPropertyName("initialName")] - public string? InitialName { get; set; } + /// Map of feature-flag IDs to their boolean enabled state. + [JsonPropertyName("featureFlags")] + public IDictionary? FeatureFlags { 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; } + /// 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; } - /// 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; } + /// Built-in skill names to include in this session. When specified, only these runtime-bundled skills are available. Skills from other sources with the same name remain available. Set to null to remove the allowlist restriction. + [JsonPropertyName("includedBuiltinSkills")] + public IList? IncludedBuiltinSkills { 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; } + /// 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; } - /// Currently selected model identifier, if any. - [JsonPropertyName("selectedModel")] - public string? SelectedModel { get; set; } + /// Stable integration identifier used for analytics and rate-limit attribution. + [JsonPropertyName("integrationId")] + public string? IntegrationId { get; set; } - /// The unique identifier of the session. - [JsonPropertyName("sessionId")] - public string SessionId { get; set; } = string.Empty; + /// Whether experimental capabilities are enabled. + [JsonPropertyName("isExperimentalMode")] + public bool? IsExperimentalMode { get; set; } - /// Current session limits, or null when no limits are active. - [JsonPropertyName("sessionLimits")] - public SessionLimitsConfig? SessionLimits { get; set; } + /// Whether interactive shell sessions are logged. + [JsonPropertyName("logInteractiveShells")] + public bool? LogInteractiveShells { get; set; } - /// ISO 8601 timestamp of when the session started. - [JsonPropertyName("startTime")] - public DateTimeOffset StartTime { get; set; } + /// Identifier sent to LSP-style integrations. + [JsonPropertyName("lspClientName")] + public string? LspClientName { 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; } + /// 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; } - /// Absolute path to the session's current working directory. - [JsonPropertyName("workingDirectory")] - public string WorkingDirectory { get; set; } = string.Empty; + /// 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; } - /// 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; } + /// The model ID to use for assistant turns. + [JsonPropertyName("model")] + public string? Model { 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; } -} + /// Per-property model capability overrides for the selected model. + [JsonPropertyName("modelCapabilitiesOverrides")] + public ModelCapabilitiesOverride? ModelCapabilitiesOverrides { 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; -} + /// Organization-level custom instructions to inject into the system prompt. + [JsonPropertyName("organizationCustomInstructions")] + public string? OrganizationCustomInstructions { get; set; } -/// 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; } -} + /// 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; } + + /// Origin of the sandbox choice. The runtime uses this only for internal telemetry provenance; managed policy is derived independently. + [JsonInclude] + [JsonPropertyName("sandboxConfigSource")] + internal SandboxConfigSource? SandboxConfigSource { 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; } -/// 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; } + /// Optional session limits. Pass null to clear the session limits. + [JsonPropertyName("sessionLimits")] + public SessionLimitsConfig? SessionLimits { 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; } + /// Per-session settings for built-in shell tools. + [JsonPropertyName("shell")] + public ShellOptions? Shell { get; set; } - /// Token count at which background compaction starts (configurable percentage of promptTokenLimit). - [JsonPropertyName("compactionThreshold")] - public long CompactionThreshold { 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; } - /// Tokens consumed by user/assistant/tool messages. - [JsonPropertyName("conversationTokens")] - public long ConversationTokens { get; set; } + /// PowerShell process flags applied to built-in and user-requested shell commands. + [JsonPropertyName("shellProcessFlags")] + public IList? ShellProcessFlags { get; set; } - /// Prompt token limit plus the model's full output token limit. - [JsonPropertyName("limit")] - public long Limit { get; set; } + /// Additional directories to search for skills. + [JsonPropertyName("skillDirectories")] + public IList? SkillDirectories { get; set; } - /// Tokens consumed by MCP tool definitions (subset of toolDefinitionsTokens, excludes deferred tools). - [JsonPropertyName("mcpToolsTokens")] - public long McpToolsTokens { get; set; } + /// Whether to skip loading custom instruction sources. + [JsonPropertyName("skipCustomInstructions")] + public bool? SkipCustomInstructions { get; set; } - /// The model used for token counting. - [JsonPropertyName("modelName")] - public string ModelName { get; set; } = string.Empty; + /// Whether to skip embedding retrieval pipeline initialization and execution. + [JsonPropertyName("skipEmbeddingRetrieval")] + public bool? SkipEmbeddingRetrieval { get; set; } - /// Maximum prompt tokens allowed by the model (or DEFAULT_TOKEN_LIMIT if unspecified). - [JsonPropertyName("promptTokenLimit")] - public long PromptTokenLimit { 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; } - /// Tokens consumed by the system prompt. - [JsonPropertyName("systemTokens")] - public long SystemTokens { get; set; } + /// Controls how availableTools (allowlist) and excludedTools (denylist) combine when both are set. + [JsonPropertyName("toolFilterPrecedence")] + public OptionsUpdateToolFilterPrecedence? ToolFilterPrecedence { get; set; } - /// Tokens consumed by tool definitions sent to the model (excludes deferred tools). - [JsonPropertyName("toolDefinitionsTokens")] - public long ToolDefinitionsTokens { get; set; } + /// Optional path for trajectory output. + [JsonPropertyName("trajectoryFile")] + public string? TrajectoryFile { get; set; } - /// Sum of system, conversation and tool-definition tokens. - [JsonPropertyName("totalTokens")] - public long TotalTokens { get; set; } -} + /// Output verbosity level for supported models. + [JsonPropertyName("verbosity")] + public Verbosity? Verbosity { 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; } + /// Absolute working-directory path for shell tools. + [JsonPropertyName("workingDirectory")] + public string? WorkingDirectory { get; set; } } -/// Model identifier and token limits used to compute the context-info breakdown. +/// Parameters for (re)loading the merged LSP configuration set. [Experimental(Diagnostics.Experimental)] -internal sealed class MetadataContextInfoRequest +internal sealed class LspInitializeRequest { - /// 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; } + /// Force re-initialization even when LSP configs were already loaded for the working directory. + [JsonPropertyName("force")] + public bool? Force { 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; } + /// 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; -} -/// Successful compaction history for the session. -public sealed class MetadataContextAttributionResultContextAttributionCompactions -{ - /// Number of successful compactions in this session. - [JsonPropertyName("count")] - public long Count { get; set; } + /// Working directory used to load project-level LSP configs. Defaults to the session working directory when omitted. + [JsonPropertyName("workingDirectory")] + public string? WorkingDirectory { get; set; } } -/// RPC data type for MetadataContextAttributionResultContextAttributionEntry operations. -public sealed class MetadataContextAttributionResultContextAttributionEntry +/// Discovered extension metadata, including source-qualified ID, name, discovery source, status, and optional process ID. +[Experimental(Diagnostics.Experimental)] +public sealed class Extension { - /// 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`. + /// 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; - /// 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; } -} + /// Extension name (directory name). + [JsonPropertyName("name")] + public string Name { get; set; } = string.Empty; -/// Per-source token attribution snapshot for the current context window. The heaviest individual messages are available separately via `metadata.getContextHeaviestMessages`. -public sealed class MetadataContextAttributionResultContextAttribution -{ - /// Successful compaction history for the session. - [JsonPropertyName("compactions")] - public MetadataContextAttributionResultContextAttributionCompactions Compactions { get => field ??= new(); set; } + /// Process ID if the extension is running. + [JsonPropertyName("pid")] + public long? Pid { 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; } + /// Discovery source: project (.github/extensions/), user (~/.copilot/extensions/), plugin (installed plugin), or session (session-state/<id>/extensions/). + [JsonPropertyName("source")] + public ExtensionSource Source { 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; } + /// Current status: running, disabled, failed, or starting. + [JsonPropertyName("status")] + public ExtensionStatus Status { get; set; } } -/// Per-source attribution breakdown for the session's current context window, or null if uninitialized. +/// Extensions discovered for the session, with their current status. [Experimental(Diagnostics.Experimental)] -public sealed class MetadataContextAttributionResult +public sealed class ExtensionList { - /// 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; } + /// Discovered extensions and their current status. + [JsonPropertyName("extensions")] + public IList Extensions { get => field ??= []; set; } } /// Identifies the target session. [Experimental(Diagnostics.Experimental)] -internal sealed class SessionMetadataGetContextAttributionRequest +internal sealed class SessionExtensionsListRequest { /// Target session identifier. [JsonPropertyName("sessionId")] public string SessionId { get; set; } = string.Empty; } -/// A single large message currently in context. +/// Source-qualified extension identifier to enable for the session. [Experimental(Diagnostics.Experimental)] -public sealed class ContextHeaviestMessage +internal sealed class ExtensionsEnableRequest { - /// Stable identifier for this message within the snapshot. + /// Source-qualified extension ID to enable. [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; } + /// Target session identifier. + [JsonPropertyName("sessionId")] + public string SessionId { get; set; } = string.Empty; } -/// The heaviest individual messages in the session's context window, most-expensive first. +/// Source-qualified extension identifier to disable for the session. [Experimental(Diagnostics.Experimental)] -public sealed class MetadataContextHeaviestMessagesResult +internal sealed class ExtensionsDisableRequest { - /// Heaviest messages, most-expensive first. - [JsonPropertyName("messages")] - public IList Messages { get => field ??= []; set; } + /// Source-qualified extension ID to disable. + [JsonPropertyName("id")] + public string Id { get; set; } = string.Empty; - /// 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; } + /// Target session identifier. + [JsonPropertyName("sessionId")] + public string SessionId { get; set; } = string.Empty; } -/// Parameters for the heaviest-messages query. +/// Identifies the target session. [Experimental(Diagnostics.Experimental)] -internal sealed class MetadataContextHeaviestMessagesRequest +internal sealed class SessionExtensionsReloadRequest { - /// 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. +/// 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)] -public sealed class MetadataRecordContextChangeResult +[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; } -/// Updated working directory and git context. Emitted as the new payload of `session.context_changed`. + +/// Optional line range to scope the attachment to a specific section of the file. [Experimental(Diagnostics.Experimental)] -public sealed class SessionWorkingDirectoryContext +public sealed class PushAttachmentFileLineRange { - /// 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; + /// End line number (1-based, inclusive). + [JsonPropertyName("end")] + public long End { get; set; } - /// Root directory of the git repository, resolved via git rev-parse. - [JsonPropertyName("gitRoot")] - public string? GitRoot { get; set; } + /// Start line number (1-based). + [JsonPropertyName("start")] + public long Start { get; set; } +} - /// Head commit of the current git branch. - [JsonPropertyName("headCommit")] - public string? HeadCommit { get; set; } +/// File attachment. +/// The file variant of . +[Experimental(Diagnostics.Experimental)] +public partial class PushAttachmentFile : PushAttachment +{ + /// + [JsonIgnore] + public override string Type => "file"; - /// Hosting platform type of the repository. - [JsonPropertyName("hostType")] - public SessionWorkingDirectoryContextHostType? HostType { get; set; } + /// User-facing display name for the attachment. + [JsonPropertyName("displayName")] + public required string DisplayName { 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; } + /// 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; } - /// Raw host string from the git remote URL (e.g. "github.com", "dev.azure.com"). - [JsonPropertyName("repositoryHost")] - public string? RepositoryHost { get; set; } + /// Absolute file path. + [JsonPropertyName("path")] + public required string Path { get; set; } } -/// Updated working-directory/git context to record on the session. +/// Directory attachment. +/// The directory variant of . [Experimental(Diagnostics.Experimental)] -internal sealed class MetadataRecordContextChangeRequest +public partial class PushAttachmentDirectory : PushAttachment { - /// Updated working directory and git context. Emitted as the new payload of `session.context_changed`. - [JsonPropertyName("context")] - public SessionWorkingDirectoryContext Context { get => field ??= new(); set; } + /// + [JsonIgnore] + public override string Type => "directory"; - /// Target session identifier. - [JsonPropertyName("sessionId")] - public string SessionId { get; set; } = string.Empty; -} + /// User-facing display name for the attachment. + [JsonPropertyName("displayName")] + public required string DisplayName { get; set; } -/// 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 directory path. + [JsonPropertyName("path")] + public required string Path { get; set; } } -/// 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. +/// End position of the selection. [Experimental(Diagnostics.Experimental)] -internal sealed class MetadataSetWorkingDirectoryRequest +public sealed class PushAttachmentSelectionDetailsEnd { - /// Target session identifier. - [JsonPropertyName("sessionId")] - public string SessionId { get; set; } = string.Empty; + /// End character offset within the line (0-based). + [JsonPropertyName("character")] + public long Character { get; set; } - /// 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; + /// End line number (0-based). + [JsonPropertyName("line")] + public long Line { get; set; } } -/// 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. [Experimental(Diagnostics.Experimental)] -public sealed class MetadataRecomputeContextTokensResult +public sealed class PushAttachmentSelectionDetailsStart { - /// 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; } + /// Start character offset within the line (0-based). + [JsonPropertyName("character")] + public long Character { get; set; } - /// Sum of tokens across chat-context and system-context messages currently held by the session. - [JsonPropertyName("totalTokens")] - public long TotalTokens { get; set; } + /// Start line number (0-based). + [JsonPropertyName("line")] + public long Line { get; set; } } -/// Model identifier to use when re-tokenizing the session's existing messages. +/// Position range of the selection within the file. [Experimental(Diagnostics.Experimental)] -internal sealed class MetadataRecomputeContextTokensRequest +public sealed class PushAttachmentSelectionDetails { - /// 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; + /// End position of the selection. + [JsonPropertyName("end")] + public PushAttachmentSelectionDetailsEnd End { get => field ??= new(); set; } - /// Target session identifier. - [JsonPropertyName("sessionId")] - public string SessionId { get; set; } = string.Empty; + /// Start position of the selection. + [JsonPropertyName("start")] + public PushAttachmentSelectionDetailsStart Start { get => field ??= new(); set; } } -/// Availability of built-in job tools surfaced to boundary consumers. +/// Code selection attachment from an editor. +/// The selection variant of . [Experimental(Diagnostics.Experimental)] -public sealed class SessionSettingsBuiltInToolAvailabilitySnapshot +public partial class PushAttachmentSelection : PushAttachment { - /// Gets or sets the createPullRequest value. - [JsonPropertyName("createPullRequest")] - public bool? CreatePullRequest { get; set; } + /// + [JsonIgnore] + public override string Type => "selection"; - /// Gets or sets the reportProgress value. - [JsonPropertyName("reportProgress")] - public bool? ReportProgress { get; set; } -} + /// User-facing display name for the selection. + [JsonPropertyName("displayName")] + public required string DisplayName { 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; } + /// Absolute path to the file containing the selection. + [JsonPropertyName("filePath")] + public required string FilePath { get; set; } - /// Gets or sets the eventType value. - [JsonPropertyName("eventType")] - public string? EventType { get; set; } + /// Position range of the selection within the file. + [JsonPropertyName("selection")] + public required PushAttachmentSelectionDetails Selection { get; set; } - /// Gets or sets the isTriggerJob value. - [JsonPropertyName("isTriggerJob")] - public bool? IsTriggerJob { get; set; } + /// The selected text content. + [JsonPropertyName("text")] + public required string Text { get; set; } } -/// Redacted model routing settings for a session. +/// GitHub issue, pull request, or discussion reference. +/// The github_reference variant of . [Experimental(Diagnostics.Experimental)] -public sealed class SessionSettingsModelSnapshot +public partial class PushAttachmentGitHubReference : PushAttachment { - /// Gets or sets the callbackUrl value. - [JsonPropertyName("callbackUrl")] - public string? CallbackUrl { get; set; } + /// + [JsonIgnore] + public override string Type => "github_reference"; - /// Gets or sets the defaultReasoningEffort value. - [JsonPropertyName("defaultReasoningEffort")] - public string? DefaultReasoningEffort { get; set; } + /// Issue, pull request, or discussion number. + [JsonPropertyName("number")] + public required long Number { get; set; } - /// Gets or sets the instanceId value. - [JsonPropertyName("instanceId")] - public string? InstanceId { get; set; } + /// Type of GitHub reference. + [JsonPropertyName("referenceType")] + public required PushAttachmentGitHubReferenceType ReferenceType { get; set; } - /// Gets or sets the model value. - [JsonPropertyName("model")] - public string? Model { get; set; } -} + /// Current state of the referenced item (e.g., open, closed, merged). + [JsonPropertyName("state")] + public required string State { 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; } + /// Title of the referenced item. + [JsonPropertyName("title")] + public required string Title { get; set; } - /// Gets or sets the enableOnlineEvaluationOutputFile value. - [JsonPropertyName("enableOnlineEvaluationOutputFile")] - public bool? EnableOnlineEvaluationOutputFile { get; set; } + /// URL to the referenced item on GitHub. + [JsonPropertyName("url")] + public required string Url { get; set; } } -/// Redacted repository and GitHub host settings for a session. +/// Pointer to a GitHub repository. [Experimental(Diagnostics.Experimental)] -public sealed class SessionSettingsRepoSnapshot +public sealed class PushGitHubRepoRef { - /// 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. + /// Numeric GitHub repository id. [JsonPropertyName("id")] - public double? Id { get; set; } + public long? Id { get; set; } - /// Gets or sets the name value. + /// Repository name (without owner). [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; } + public string Name { get; set; } = string.Empty; - /// Gets or sets the serverUrl value. - [JsonPropertyName("serverUrl")] - public string? ServerUrl { get; set; } + /// Repository owner login (user or organization). + [JsonPropertyName("owner")] + public string Owner { get; set; } = string.Empty; } -/// Redacted validation and memory-tool settings for a session. +/// Pointer to a GitHub commit. +/// The github_commit variant of . [Experimental(Diagnostics.Experimental)] -public sealed class SessionSettingsValidationSnapshot +public partial class PushAttachmentGitHubCommit : PushAttachment { - /// Gets or sets the advisoryEnabled value. - [JsonPropertyName("advisoryEnabled")] - public bool? AdvisoryEnabled { get; set; } + /// + [JsonIgnore] + public override string Type => "github_commit"; - /// Gets or sets the codeqlEnabled value. - [JsonPropertyName("codeqlEnabled")] - public bool? CodeqlEnabled { get; set; } + /// First line of the commit message. + [JsonPropertyName("message")] + public required string Message { get; set; } - /// Gets or sets the codeReviewEnabled value. - [JsonPropertyName("codeReviewEnabled")] - public bool? CodeReviewEnabled { get; set; } + /// Full commit SHA. + [JsonPropertyName("oid")] + public required string Oid { get; set; } - /// Gets or sets the codeReviewModel value. - [JsonPropertyName("codeReviewModel")] - public string? CodeReviewModel { get; set; } + /// Repository the commit belongs to. + [JsonPropertyName("repo")] + public required PushGitHubRepoRef Repo { get; set; } - /// Gets or sets the dependabotTimeout value. - [JsonPropertyName("dependabotTimeout")] - public double? DependabotTimeout { get; set; } + /// URL to the commit on GitHub. + [JsonPropertyName("url")] + public required string Url { get; set; } +} - /// Gets or sets the memoryStoreEnabled value. - [JsonPropertyName("memoryStoreEnabled")] - public bool? MemoryStoreEnabled { 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"; - /// Gets or sets the memoryVoteEnabled value. - [JsonPropertyName("memoryVoteEnabled")] - public bool? MemoryVoteEnabled { get; set; } + /// Human-readable release name. + [JsonPropertyName("name")] + public required string Name { get; set; } - /// Gets or sets the secretScanningEnabled value. - [JsonPropertyName("secretScanningEnabled")] - public bool? SecretScanningEnabled { get; set; } + /// Repository the release belongs to. + [JsonPropertyName("repo")] + public required PushGitHubRepoRef Repo { get; set; } - /// Gets or sets the timeout value. - [JsonPropertyName("timeout")] - public double? Timeout { 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; } } -/// Redacted, serializable view of session runtime settings for SDK boundary consumers. Secrets and raw feature flags are intentionally excluded. +/// Pointer to a GitHub Actions job. +/// The github_actions_job variant of . [Experimental(Diagnostics.Experimental)] -internal sealed class SessionSettingsSnapshot +public partial class PushAttachmentGitHubActionsJob : PushAttachment { - /// Gets or sets the clientName value. - [JsonPropertyName("clientName")] - public string? ClientName { get; set; } + /// + [JsonIgnore] + public override string Type => "github_actions_job"; - /// Gets or sets the job value. - [JsonPropertyName("job")] - public SessionSettingsJobSnapshot Job { get => field ??= new(); set; } + /// 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; } - /// Gets or sets the model value. - [JsonPropertyName("model")] - public SessionSettingsModelSnapshot Model { get => field ??= new(); set; } + /// Job id within the workflow run. + [JsonPropertyName("jobId")] + public required long JobId { get; set; } - /// Gets or sets the onlineEvaluation value. - [JsonPropertyName("onlineEvaluation")] - public SessionSettingsOnlineEvaluationSnapshot OnlineEvaluation { get => field ??= new(); set; } + /// Display name of the job. + [JsonPropertyName("jobName")] + public required string JobName { get; set; } - /// Gets or sets the repo value. + /// Repository the workflow run belongs to. [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; } + public required PushGitHubRepoRef Repo { get; set; } - /// Gets or sets the validation value. - [JsonPropertyName("validation")] - public SessionSettingsValidationSnapshot Validation { get => field ??= new(); set; } + /// URL to the job on GitHub. + [JsonPropertyName("url")] + public required string Url { get; set; } - /// Gets or sets the version value. - [JsonPropertyName("version")] - public string? Version { get; set; } + /// Display name of the workflow the job ran in. + [JsonPropertyName("workflowName")] + public required string WorkflowName { get; set; } } -/// Identifies the target session. +/// Pointer to a GitHub repository. +/// The github_repository variant of . [Experimental(Diagnostics.Experimental)] -internal sealed class SessionSettingsSnapshotRequest +public partial class PushAttachmentGitHubRepository : PushAttachment { - /// Target session identifier. - [JsonPropertyName("sessionId")] - public string SessionId { get; set; } = string.Empty; + /// + [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; } } -/// Result of evaluating a Rust-owned settings predicate. +/// One side of a file diff (head or base). [Experimental(Diagnostics.Experimental)] -internal sealed class SessionSettingsEvaluatePredicateResult +public sealed class PushAttachmentGitHubFileDiffSide { - /// Gets or sets the enabled value. - [JsonPropertyName("enabled")] - public bool Enabled { get; set; } + /// 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; } } -/// Named Rust-owned settings predicate to evaluate for this session. +/// 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)] -internal sealed class SessionSettingsEvaluatePredicateRequest +public partial class PushAttachmentGitHubFileDiff : PushAttachment { - /// Predicate name. The runtime owns the raw feature-flag names and composition logic. - [JsonPropertyName("name")] - public SessionSettingsPredicateName Name { get; set; } + /// + [JsonIgnore] + public override string Type => "github_file_diff"; - /// Target session identifier. - [JsonPropertyName("sessionId")] - public string SessionId { get; set; } = string.Empty; + /// File location on the base side of the diff. Absent for additions. + [JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)] + [JsonPropertyName("base")] + public PushAttachmentGitHubFileDiffSide? Base { get; set; } - /// Tool name for tool-scoped predicates such as trivial-change handling. - [JsonPropertyName("toolName")] - public string? ToolName { 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; } } -/// Identifier of the spawned process, used to correlate streamed output and exit notifications. +/// One side of a tree comparison (head or base). [Experimental(Diagnostics.Experimental)] -public sealed class ShellExecResult +public sealed class PushAttachmentGitHubTreeComparisonSide { - /// Unique identifier for tracking streamed output. - [JsonPropertyName("processId")] - public string ProcessId { get; set; } = string.Empty; + /// 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; } -/// Shell command to run, with optional working directory and timeout in milliseconds. +/// Pointer to a comparison between two git revisions. +/// The github_tree_comparison variant of . [Experimental(Diagnostics.Experimental)] -internal sealed class ShellExecRequest +public partial class PushAttachmentGitHubTreeComparison : PushAttachment { - /// Shell command to execute. - [JsonPropertyName("command")] - public string Command { get; set; } = string.Empty; + /// + [JsonIgnore] + public override string Type => "github_tree_comparison"; - /// Working directory (defaults to session working directory). - [JsonPropertyName("cwd")] - public string? Cwd { get; set; } + /// Base side of the comparison. + [JsonPropertyName("base")] + public required PushAttachmentGitHubTreeComparisonSide Base { get; set; } - /// Target session identifier. - [JsonPropertyName("sessionId")] - public string SessionId { get; set; } = string.Empty; + /// Head side of the comparison. + [JsonPropertyName("head")] + public required PushAttachmentGitHubTreeComparisonSide Head { get; set; } - /// Timeout in milliseconds (default: 30000). - [JsonConverter(typeof(MillisecondsTimeSpanConverter))] - [JsonPropertyName("timeout")] - public TimeSpan? Timeout { get; set; } + /// URL to the comparison on GitHub. + [JsonPropertyName("url")] + public required string Url { get; set; } } -/// Indicates whether the signal was delivered; false if the process was unknown or already exited. +/// Generic GitHub URL reference. +/// The github_url variant of . [Experimental(Diagnostics.Experimental)] -public sealed class ShellKillResult +public partial class PushAttachmentGitHubUrl : PushAttachment { - /// Whether the signal was sent successfully. - [JsonPropertyName("killed")] - public bool Killed { get; set; } + /// + [JsonIgnore] + public override string Type => "github_url"; + + /// URL to the GitHub resource. + [JsonPropertyName("url")] + public required string Url { get; set; } } -/// Identifier of a process previously returned by "shell.exec" and the signal to send. +/// Pointer to a file in a GitHub repository at a specific ref. +/// The github_file variant of . [Experimental(Diagnostics.Experimental)] -internal sealed class ShellKillRequest +public partial class PushAttachmentGitHubFile : PushAttachment { - /// Process identifier returned by shell.exec. - [JsonPropertyName("processId")] - public string ProcessId { get; set; } = string.Empty; + /// + [JsonIgnore] + public override string Type => "github_file"; - /// Target session identifier. - [JsonPropertyName("sessionId")] - public string SessionId { get; set; } = string.Empty; + /// Repository-relative path to the file. + [JsonPropertyName("path")] + public required string Path { get; set; } - /// Signal to send (default: SIGTERM). - [JsonPropertyName("signal")] - public ShellKillSignal? Signal { get; set; } -} + /// Git ref the file is read at (branch, tag, or commit SHA). + [JsonPropertyName("ref")] + public required string Ref { 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; } + /// Repository the file lives in. + [JsonPropertyName("repo")] + public required PushGitHubRepoRef Repo { get; set; } - /// Tool call id emitted for the shell execution. - [JsonPropertyName("toolCallId")] - public string ToolCallId { get; set; } = string.Empty; + /// URL to the file on GitHub. + [JsonPropertyName("url")] + public required string Url { get; set; } } -/// User-requested shell command and cancellation handle. +/// Pointer to a line range inside a file in a GitHub repository. +/// The github_snippet variant of . [Experimental(Diagnostics.Experimental)] -internal sealed class ShellExecuteUserRequestedRequest +public partial class PushAttachmentGitHubSnippet : PushAttachment { - /// Shell command to execute. - [JsonPropertyName("command")] - public string Command { get; set; } = string.Empty; + /// + [JsonIgnore] + public override string Type => "github_snippet"; - /// Caller-provided cancellation handle for this execution. - [JsonPropertyName("requestId")] - public string RequestId { get; set; } = string.Empty; + /// Line range the snippet covers. + [JsonPropertyName("lineRange")] + public required PushAttachmentFileLineRange LineRange { get; set; } - /// Target session identifier. - [JsonPropertyName("sessionId")] - public string SessionId { get; set; } = string.Empty; -} + /// Repository-relative path to the file. + [JsonPropertyName("path")] + public required string Path { get; set; } -/// 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; } -} + /// Git ref the file is read at (branch, tag, or commit SHA). + [JsonPropertyName("ref")] + public required string Ref { 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; + /// Repository the file lives in. + [JsonPropertyName("repo")] + public required PushGitHubRepoRef Repo { get; set; } - /// Target session identifier. - [JsonPropertyName("sessionId")] - public string SessionId { get; set; } = string.Empty; + /// URL to the snippet on GitHub (with line anchor). + [JsonPropertyName("url")] + public required string Url { get; set; } } -/// Post-compaction context window usage breakdown. +/// Blob attachment with inline base64-encoded data. +/// The blob variant of . [Experimental(Diagnostics.Experimental)] -public sealed class HistoryCompactContextWindow +public partial class PushAttachmentBlob : PushAttachment { - /// 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; } + /// + [JsonIgnore] + public override string Type => "blob"; - /// Token count from system message(s). - [JsonPropertyName("systemTokens")] - public long? SystemTokens { get; set; } + /// Base64-encoded content. + [Base64String] + [JsonPropertyName("data")] + public required string Data { get; set; } - /// Maximum token count for the model's context window. - [JsonPropertyName("tokenLimit")] - public long TokenLimit { get; set; } + /// User-facing display name for the attachment. + [JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)] + [JsonPropertyName("displayName")] + public string? DisplayName { get; set; } - /// Token count from tool definitions. - [JsonPropertyName("toolDefinitionsTokens")] - public long? ToolDefinitionsTokens { get; set; } + /// MIME type of the inline data. + [JsonPropertyName("mimeType")] + public required string MimeType { get; set; } } -/// Compaction outcome with the number of tokens and messages removed, summary text, and the resulting context window breakdown. +/// Slim input shape for extension_context attachments; identity fields are runtime-derived. +/// The extension_context variant of . [Experimental(Diagnostics.Experimental)] -public sealed class HistoryCompactResult +public partial class PushAttachmentExtensionContext : PushAttachment { - /// 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; } + /// + [JsonIgnore] + public override string Type => "extension_context"; - /// Number of tokens freed by compaction. - [JsonPropertyName("tokensRemoved")] - public long TokensRemoved { get; set; } -} + /// Caller-supplied JSON payload (required, may be null but not undefined). + [JsonPropertyName("payload")] + public required JsonElement Payload { get; set; } -/// Optional compaction parameters. -[Experimental(Diagnostics.Experimental)] -public sealed class HistoryCompactRequest -{ - /// Optional user-provided instructions to focus the compaction summary. + /// 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")] - [MaxLength(4000)] - [JsonPropertyName("customInstructions")] - public string? CustomInstructions { get; set; } + [MinLength(1)] + [JsonPropertyName("title")] + public required string Title { get; set; } } -/// Optional compaction parameters. +/// Parameters for session.extensions.sendAttachmentsToMessage. [Experimental(Diagnostics.Experimental)] -internal sealed class HistoryCompactRequestWithSession +internal sealed class SendAttachmentsToMessageParams { - /// 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; } + /// 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; } -/// Number of events that were removed by the truncation. +/// A tool name and arguments to execute through the session's native invocation pipeline. [Experimental(Diagnostics.Experimental)] -public sealed class HistoryTruncateResult +internal sealed class ToolsExecuteRequest { - /// Number of events that were removed. - [JsonPropertyName("eventsRemoved")] - public long EventsRemoved { get; set; } -} + /// Arguments supplied to the tool. + [JsonPropertyName("arguments")] + public JsonElement Arguments { 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; + /// Name of the currently offered tool to execute. + [JsonPropertyName("name")] + public string Name { get; set; } = string.Empty; /// Target session identifier. [JsonPropertyName("sessionId")] public string SessionId { get; set; } = string.Empty; + + /// Optional identifier used to correlate this invocation with its tool call. + [JsonPropertyName("toolCallId")] + public string? ToolCallId { get; set; } } -/// Indicates whether an in-progress background compaction was cancelled. +/// Custom grammar input format accepted by a built-in tool. [Experimental(Diagnostics.Experimental)] -public sealed class HistoryCancelBackgroundCompactionResult +public sealed class BuiltinToolFormat { - /// 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; } + /// Grammar definition accepted by the tool. + [JsonPropertyName("definition")] + public string Definition { get; set; } = string.Empty; + + /// Grammar syntax used by the format definition. + [JsonPropertyName("syntax")] + public string Syntax { get; set; } = string.Empty; + + /// Custom input-format discriminator. + [JsonPropertyName("type")] + public BuiltinToolFormatType Type { get; set; } } -/// Identifies the target session. +/// JSON Schema object accepted by a built-in tool. [Experimental(Diagnostics.Experimental)] -internal sealed class SessionHistoryCancelBackgroundCompactionRequest +public sealed class BuiltinToolInputSchema { - /// Target session identifier. - [JsonPropertyName("sessionId")] - public string SessionId { get; set; } = string.Empty; + /// Root type of the tool input schema. + [JsonPropertyName("type")] + public BuiltinToolInputSchemaType Type { get; set; } } -/// Indicates whether an in-progress manual compaction was aborted. +/// Rust-owned metadata and input schema for a built-in tool. [Experimental(Diagnostics.Experimental)] -public sealed class HistoryAbortManualCompactionResult +public sealed class BuiltinToolDescriptor { - /// 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; } + /// Model-facing description of the tool's behavior. + [JsonPropertyName("description")] + public string Description { get; set; } = string.Empty; + + /// Optional custom input format used instead of a JSON Schema. + [JsonPropertyName("format")] + public BuiltinToolFormat? Format { get; set; } + + /// Whether the tool provides a specialized intention summary. + [JsonPropertyName("hasSummariseIntention")] + public bool HasSummariseIntention { get; set; } + + /// JSON Schema for the tool input, or null when the tool uses a custom format. + [JsonPropertyName("inputSchema")] + public BuiltinToolInputSchema? InputSchema { get; set; } + + /// Optional supplemental usage instructions for the tool. + [JsonPropertyName("instructions")] + public string? Instructions { get; set; } + + /// Whether the tool executes commands in a terminal. + [JsonPropertyName("isTerminal")] + public bool IsTerminal { get; set; } + + /// Stable name used to invoke the built-in tool. + [JsonPropertyName("name")] + public string Name { get; set; } = string.Empty; + + /// Policy describing which tool metadata may be recorded without obfuscation. + [JsonPropertyName("safeForTelemetry")] + public JsonElement SafeForTelemetry { get; set; } + + /// Optional human-readable title for the tool. + [JsonPropertyName("title")] + public string? Title { get; set; } + + /// Optional tool category discriminator. + [JsonPropertyName("type")] + public string? Type { get; set; } } -/// Identifies the target session. +/// Rust-owned built-in tool descriptors for the session. [Experimental(Diagnostics.Experimental)] -internal sealed class SessionHistoryAbortManualCompactionRequest +public sealed class ToolsGetBuiltinDescriptorsResult { - /// Target session identifier. - [JsonPropertyName("sessionId")] - public string SessionId { get; set; } = string.Empty; + /// Built-in tool descriptors materialized for the session. + [JsonPropertyName("tools")] + public IList Tools { get => field ??= []; set; } } -/// Markdown summary of the conversation context (empty when not available). +/// Shell-specific names and description lines used to materialize built-in shell tool descriptors. [Experimental(Diagnostics.Experimental)] -public sealed class HistorySummarizeForHandoffResult +public sealed class ToolsShellDescriptorConfig { - /// 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; + /// Additional model-facing shell description lines. + [JsonPropertyName("descriptionLines")] + public IList DescriptionLines { get => field ??= []; set; } + + /// Human-readable shell name. + [JsonPropertyName("displayName")] + public string DisplayName { get; set; } = string.Empty; + + /// Tool name used to list active shells. + [JsonPropertyName("listShellsToolName")] + public string ListShellsToolName { get; set; } = string.Empty; + + /// Tool name used to read shell output. + [JsonPropertyName("readShellToolName")] + public string ReadShellToolName { get; set; } = string.Empty; + + /// Tool name used to start shell commands. + [JsonPropertyName("shellToolName")] + public string ShellToolName { get; set; } = string.Empty; + + /// Stable shell type identifier. + [JsonPropertyName("shellType")] + public string ShellType { get; set; } = string.Empty; + + /// Tool name used to stop shell commands. + [JsonPropertyName("stopShellToolName")] + public string StopShellToolName { get; set; } = string.Empty; } -/// Identifies the target session. +/// Options controlling how Rust-owned built-in tool descriptors are materialized. [Experimental(Diagnostics.Experimental)] -internal sealed class SessionHistorySummarizeForHandoffRequest +internal sealed class ToolsGetBuiltinDescriptorsRequest { + /// Whether background task completion notifications are enabled. + [JsonPropertyName("backgroundTaskNotificationsEnabled")] + public bool? BackgroundTaskNotificationsEnabled { get; set; } + + /// Whether tool descriptors should include authoring metadata. + [JsonPropertyName("includeAuthor")] + public bool? IncludeAuthor { get; set; } + + /// Whether descriptors should favor fewer user-intervention prompts. + [JsonPropertyName("reduceUserIntervention")] + public bool? ReduceUserIntervention { get; set; } + /// Target session identifier. [JsonPropertyName("sessionId")] public string SessionId { get; set; } = string.Empty; + + /// Shell-specific names and description lines for shell tools. + [JsonPropertyName("shellConfig")] + public ToolsShellDescriptorConfig? ShellConfig { get; set; } + + /// Whether the configured shell supports PowerShell 7 syntax. + [JsonPropertyName("shellSupportsPowerShell7Syntax")] + public bool? ShellSupportsPowerShell7Syntax { get; set; } + + /// Default shell timeout in milliseconds. + [JsonPropertyName("shellTimeoutMs")] + public double? ShellTimeoutMs { get; set; } + + /// Whether semantic skill lookup is available. + [JsonPropertyName("skillEmbeddingEnabled")] + public bool? SkillEmbeddingEnabled { get; set; } } -/// User-facing pending queue entry, with kind and display text for a queued message, slash command, or model change. +/// Task completion notification with summary from the agent. [Experimental(Diagnostics.Experimental)] -public sealed class QueuePendingItems +public sealed class TaskCompleteData { - /// Human-readable text to display for this queue entry in the UI. - [JsonPropertyName("displayText")] - public string DisplayText { get; set; } = string.Empty; + /// Active autopilot objective ID evaluated by the completion reviewer. + [JsonPropertyName("objectiveId")] + public long? ObjectiveId { get; set; } - /// Whether this item is a queued user message or a queued slash command / model change. - [JsonPropertyName("kind")] - public QueuePendingItemsKind Kind { get; set; } -} + /// Semantic completion decision. Absent on legacy events and invalid tool calls. + [JsonPropertyName("outcome")] + public TaskCompletionOutcome? Outcome { 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; } + /// 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. + [JsonPropertyName("reason")] + public string? Reason { get; 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; } -} + /// Whether the task was accepted as complete. False when validation failed or completion was rejected or blocked by the reviewer. + [JsonPropertyName("success")] + public bool? Success { get; set; } -/// Identifies the target session. -[Experimental(Diagnostics.Experimental)] -internal sealed class SessionQueuePendingItemsRequest -{ - /// Target session identifier. - [JsonPropertyName("sessionId")] - public string SessionId { get; set; } = string.Empty; + /// Summary of the completed task, provided by the agent. + [JsonPropertyName("summary")] + public string? Summary { get; set; } } -/// Indicates whether a user-facing pending item was removed. +/// Binary result returned by a tool for the model. [Experimental(Diagnostics.Experimental)] -public sealed class QueueRemoveMostRecentResult +public sealed class ExternalToolTextResultForLlmBinaryResultsForLlm { - /// 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; } + /// Base64-encoded binary data. + [Base64String] + [JsonPropertyName("data")] + public string Data { get; set; } = string.Empty; + + /// Human-readable description of the binary data. + [JsonPropertyName("description")] + public string? Description { get; set; } + + /// Optional metadata from the producing tool. + [JsonPropertyName("metadata")] + public IDictionary? Metadata { get; set; } + + /// MIME type of the binary data. + [JsonPropertyName("mimeType")] + public string MimeType { get; set; } = string.Empty; + + /// Binary result type discriminator. Use "image" for images and "resource" for other binary data. + [JsonPropertyName("type")] + public ExternalToolTextResultForLlmBinaryResultsForLlmType Type { get; set; } } -/// Identifies the target session. +/// A content block within a tool result, which may be text, terminal output, image, audio, or a resource. +/// Polymorphic base type discriminated by type. [Experimental(Diagnostics.Experimental)] -internal sealed class SessionQueueRemoveMostRecentRequest +[JsonPolymorphic( + TypeDiscriminatorPropertyName = "type", + UnknownDerivedTypeHandling = JsonUnknownDerivedTypeHandling.FallBackToBaseType)] +[JsonDerivedType(typeof(ExternalToolTextResultForLlmContentText), "text")] +[JsonDerivedType(typeof(ExternalToolTextResultForLlmContentTerminal), "terminal")] +[JsonDerivedType(typeof(ExternalToolTextResultForLlmContentShellExit), "shell_exit")] +[JsonDerivedType(typeof(ExternalToolTextResultForLlmContentImage), "image")] +[JsonDerivedType(typeof(ExternalToolTextResultForLlmContentAudio), "audio")] +[JsonDerivedType(typeof(ExternalToolTextResultForLlmContentResourceLink), "resource_link")] +[JsonDerivedType(typeof(ExternalToolTextResultForLlmContentResource), "resource")] +public partial class ExternalToolTextResultForLlmContent { - /// 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; } -/// Identifies the target session. + +/// Plain text content block. +/// The text variant of . [Experimental(Diagnostics.Experimental)] -internal sealed class SessionQueueClearRequest +public partial class ExternalToolTextResultForLlmContentText : ExternalToolTextResultForLlmContent { - /// Target session identifier. - [JsonPropertyName("sessionId")] - public string SessionId { get; set; } = string.Empty; + /// + [JsonIgnore] + public override string Type => "text"; + + /// The text content. + [JsonPropertyName("text")] + public required string Text { get; set; } } -/// Batch of session events returned by a read, with cursor and continuation metadata. +/// Terminal/shell output content block with optional exit code and working directory. +/// The terminal variant of . [Experimental(Diagnostics.Experimental)] -public sealed class EventsReadResult +public partial class ExternalToolTextResultForLlmContentTerminal : ExternalToolTextResultForLlmContent { - /// 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; + /// + [JsonIgnore] + public override string Type => "terminal"; - /// 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; } + /// Working directory where the command was executed. + [JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)] + [JsonPropertyName("cwd")] + public string? Cwd { get; set; } - /// 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; } + /// Process exit code, if the command has completed. + [JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)] + [JsonPropertyName("exitCode")] + public long? ExitCode { get; set; } - /// 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; } + /// Terminal/shell output text. + [JsonPropertyName("text")] + public required string Text { get; set; } } -/// Cursor, batch size, and optional long-poll/filter parameters for reading session events. +/// Shell command exit metadata with optional output preview. +/// The shell_exit variant of . [Experimental(Diagnostics.Experimental)] -internal sealed class EventLogReadRequest +public partial class ExternalToolTextResultForLlmContentShellExit : ExternalToolTextResultForLlmContent { - /// 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; } + /// + [JsonIgnore] + public override string Type => "shell_exit"; - /// 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; } + /// Working directory where the shell command was executed. + [JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)] + [JsonPropertyName("cwd")] + public string? Cwd { get; set; } - /// Maximum number of events to return in this batch (1–1000, default 200). - [JsonPropertyName("max")] - public long? Max { get; set; } + /// Exit code from the completed shell command. + [JsonPropertyName("exitCode")] + public required long ExitCode { get; set; } - /// Target session identifier. - [JsonPropertyName("sessionId")] - public string SessionId { get; set; } = string.Empty; + /// Path reported in the shell session's filesystem namespace when shell output exceeded the configured large-output threshold. + [JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)] + [JsonPropertyName("outputFilePath")] + public string? OutputFilePath { get; set; } - /// Either '*' to receive all event types, or a non-empty list of event types to receive. - [JsonPropertyName("types")] - public JsonElement? Types { 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; } - /// 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; } + /// 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; } } -/// 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). +/// Image content block with base64-encoded data. +/// The image variant of . [Experimental(Diagnostics.Experimental)] -public sealed class EventLogTailResult +public partial class ExternalToolTextResultForLlmContentImage : ExternalToolTextResultForLlmContent { - /// 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; + /// + [JsonIgnore] + public override string Type => "image"; + + /// Base64-encoded image data. + [Base64String] + [JsonPropertyName("data")] + public required string Data { get; set; } + + /// MIME type of the image (e.g., image/png, image/jpeg). + [JsonPropertyName("mimeType")] + public required string MimeType { get; set; } } -/// Identifies the target session. +/// Audio content block with base64-encoded data. +/// The audio variant of . [Experimental(Diagnostics.Experimental)] -internal sealed class SessionEventLogTailRequest +public partial class ExternalToolTextResultForLlmContentAudio : ExternalToolTextResultForLlmContent { - /// Target session identifier. - [JsonPropertyName("sessionId")] - public string SessionId { get; set; } = string.Empty; + /// + [JsonIgnore] + public override string Type => "audio"; + + /// Base64-encoded audio data. + [Base64String] + [JsonPropertyName("data")] + public required string Data { get; set; } + + /// MIME type of the audio (e.g., audio/wav, audio/mpeg). + [JsonPropertyName("mimeType")] + public required string MimeType { get; set; } } -/// Opaque handle representing an event-type interest registration. +/// Icon image for a resource. [Experimental(Diagnostics.Experimental)] -public sealed class RegisterEventInterestResult +public sealed class ExternalToolTextResultForLlmContentResourceLinkIcon { - /// 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; + /// MIME type of the icon image. + [JsonPropertyName("mimeType")] + public string? MimeType { get; set; } + + /// Available icon sizes (e.g., ['16x16', '32x32']). + [JsonPropertyName("sizes")] + public IList? Sizes { get; set; } + + /// URL or path to the icon image. + [JsonPropertyName("src")] + public string Src { get; set; } = string.Empty; + + /// Theme variant this icon is intended for. + [JsonPropertyName("theme")] + public ExternalToolTextResultForLlmContentResourceLinkIconTheme? Theme { get; set; } } -/// Event type to register consumer interest for, used by runtime gating logic. +/// Resource link content block referencing an external resource. +/// The resource_link variant of . [Experimental(Diagnostics.Experimental)] -internal sealed class RegisterEventInterestParams +public partial class ExternalToolTextResultForLlmContentResourceLink : ExternalToolTextResultForLlmContent { - /// 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; + /// + [JsonIgnore] + public override string Type => "resource_link"; - /// Target session identifier. - [JsonPropertyName("sessionId")] - public string SessionId { get; set; } = string.Empty; + /// Human-readable description of the resource. + [JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)] + [JsonPropertyName("description")] + public string? Description { get; set; } + + /// Icons associated with this resource. + [JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)] + [JsonPropertyName("icons")] + public IList? Icons { get; set; } + + /// MIME type of the resource content. + [JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)] + [JsonPropertyName("mimeType")] + public string? MimeType { get; set; } + + /// Resource name identifier. + [JsonPropertyName("name")] + public required string Name { get; set; } + + /// Size of the resource in bytes. + [JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)] + [JsonPropertyName("size")] + public long? Size { get; set; } + + /// Human-readable display title for the resource. + [JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)] + [JsonPropertyName("title")] + public string? Title { get; set; } + + /// URI identifying the resource. + [JsonPropertyName("uri")] + public required string Uri { get; set; } } -/// Indicates whether the operation succeeded. +/// Embedded resource content block with inline text or binary data. +/// The resource variant of . [Experimental(Diagnostics.Experimental)] -public sealed class EventLogReleaseInterestResult +public partial class ExternalToolTextResultForLlmContentResource : ExternalToolTextResultForLlmContent { - /// Whether the operation succeeded. - [JsonPropertyName("success")] - public bool Success { get; set; } + /// + [JsonIgnore] + public override string Type => "resource"; + + /// The embedded resource contents, either text or base64-encoded binary. + [JsonPropertyName("resource")] + public required JsonElement Resource { get; set; } } -/// Opaque handle previously returned by `registerInterest` to release. +/// A message injected by a tool result. [Experimental(Diagnostics.Experimental)] -internal sealed class ReleaseEventInterestParams +public sealed class ToolResultNewMessage { - /// 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; + /// Message content to inject after the tool result. + [JsonPropertyName("content")] + public string Content { get; set; } = string.Empty; - /// Target session identifier. - [JsonPropertyName("sessionId")] - public string SessionId { get; set; } = string.Empty; + /// Source attributed to the injected message. + [JsonPropertyName("source")] + public string Source { get; set; } = string.Empty; } -/// Aggregated code change metrics. +/// RPC data type for TaskCompletionDecision operations. [Experimental(Diagnostics.Experimental)] -public sealed class UsageMetricsCodeChanges +public sealed class TaskCompletionDecision { - /// Distinct file paths modified during the session. - [JsonPropertyName("filesModified")] - public IList FilesModified { get => field ??= []; set; } + /// Objective eligibility token captured when the decision was evaluated. + [JsonPropertyName("completionEligibilityToken")] + public long? CompletionEligibilityToken { get; set; } - /// Number of distinct files modified. - [JsonPropertyName("filesModifiedCount")] - public long FilesModifiedCount { get; set; } + /// Whether completion was accepted after the reviewer-rejection budget was exhausted. + [JsonPropertyName("completionRejectionBudgetExhausted")] + public bool? CompletionRejectionBudgetExhausted { get; set; } - /// Total lines of code added. - [JsonPropertyName("linesAdded")] - public long LinesAdded { get; set; } + /// Active autopilot objective evaluated by the completion reviewer. + [JsonPropertyName("objectiveId")] + public long? ObjectiveId { get; set; } - /// Total lines of code removed. - [JsonPropertyName("linesRemoved")] - public long LinesRemoved { get; set; } -} + /// Semantic result of evaluating the task completion request. + [JsonPropertyName("outcome")] + public TaskCompletionOutcome Outcome { 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; } + /// Rationale for the completion decision, when one is available. + [JsonPropertyName("reason")] + public string? Reason { get; set; } - /// Number of API requests made with this model. - [JsonPropertyName("count")] - public long Count { get; set; } -} + /// Whether the rationale was derived from completion-reviewer output. + [JsonPropertyName("reviewerDerived")] + public bool? ReviewerDerived { 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; } + /// Information-flow metadata captured from the completion reviewer. + [JsonPropertyName("reviewerResultMeta")] + public JsonElement? ReviewerResultMeta { get; set; } } -/// Token usage metrics for this model. +/// Expanded canonical result returned by a session tool. [Experimental(Diagnostics.Experimental)] -public sealed class UsageMetricsModelMetricUsage +public sealed class ToolResultExpanded { - /// Total tokens read from prompt cache. - [JsonPropertyName("cacheReadTokens")] - public long CacheReadTokens { get; set; } + /// Base64-encoded binary results returned to the model. + [JsonPropertyName("binaryResultsForLlm")] + public IList? BinaryResultsForLlm { 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; } + /// Sources returned by the tool that the model may cite. + [JsonPropertyName("citableSources")] + public IList? CitableSources { get; set; } - /// Token count details per type. - [JsonPropertyName("tokenDetails")] - public IDictionary? TokenDetails { get; set; } + /// Structured content blocks returned to the model. + [JsonPropertyName("contents")] + public IList? Contents { get; set; } - /// Accumulated nano-AI units cost for this model. - [JsonPropertyName("totalNanoAiu")] - public double? TotalNanoAiu { get; set; } + /// Error message for an unsuccessful execution. + [JsonPropertyName("error")] + public string? Error { get; set; } - /// Token usage metrics for this model. - [JsonPropertyName("usage")] - public UsageMetricsModelMetricUsage Usage { get => field ??= new(); set; } -} + /// Metadata propagated with the tool result, including information-flow labels. + [JsonPropertyName("mcpMeta")] + public IDictionary? McpMeta { get; 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; } -} + /// Messages to inject after the tool result. + [JsonPropertyName("newMessages")] + public IList? NewMessages { 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; } + /// Whether post-tool-use failure hooks have already processed this result. + [JsonPropertyName("postToolUseFailureHooksProcessed")] + public bool? PostToolUseFailureHooksProcessed { get; set; } - /// Currently active model identifier. - [JsonPropertyName("currentModel")] - public string? CurrentModel { get; set; } + /// Execution outcome classification. + [JsonPropertyName("resultType")] + public ToolResultType ResultType { get; set; } - /// Input tokens from the most recent main-agent API call. - [JsonPropertyName("lastCallInputTokens")] - public long LastCallInputTokens { get; set; } + /// Detailed log content available for session display. + [JsonPropertyName("sessionLog")] + public string? SessionLog { get; set; } - /// Output tokens from the most recent main-agent API call. - [JsonPropertyName("lastCallOutputTokens")] - public long LastCallOutputTokens { get; set; } + /// Skill invocation metadata produced by the tool. + [JsonPropertyName("skillInvocation")] + public JsonElement? SkillInvocation { get; set; } - /// Per-model token and request metrics, keyed by model identifier. - [JsonPropertyName("modelMetrics")] - public IDictionary ModelMetrics { get => field ??= new Dictionary(); set; } + /// Whether large-output post-processing should be skipped. + [JsonPropertyName("skipLargeOutputProcessing")] + public bool? SkipLargeOutputProcessing { get; set; } - /// ISO 8601 timestamp when the session started. - [JsonPropertyName("sessionStartTime")] - public DateTimeOffset SessionStartTime { get; set; } + /// Structured result content in addition to the model-facing text. + [JsonPropertyName("structuredContent")] + public JsonElement? StructuredContent { get; set; } - /// Session-wide per-token-type accumulated token counts. - [JsonPropertyName("tokenDetails")] - public IDictionary? TokenDetails { get; set; } + /// Completion-review decision produced by the task-completion tool. + [JsonPropertyName("taskCompletionDecision")] + public TaskCompletionDecision? TaskCompletionDecision { get; set; } - /// Total time spent in model API calls (milliseconds). - [JsonConverter(typeof(MillisecondsTimeSpanConverter))] - [JsonPropertyName("totalApiDurationMs")] - public TimeSpan TotalApiDuration { get; set; } + /// Text result returned to the model. + [JsonPropertyName("textResultForLlm")] + public string TextResultForLlm { get; set; } = string.Empty; - /// Session-wide accumulated nano-AI units cost. - [JsonPropertyName("totalNanoAiu")] - public double? TotalNanoAiu { get; set; } + /// Deferred tool names made available by this result. + [JsonPropertyName("toolReferences")] + public IList? ToolReferences { get; set; } - /// Total user-initiated premium request cost across all models (may be fractional due to multipliers). - [JsonPropertyName("totalPremiumRequestCost")] - public double TotalPremiumRequestCost { get; set; } + /// Tool-specific telemetry payload. + [JsonPropertyName("toolTelemetry")] + public JsonElement? ToolTelemetry { get; set; } - /// Raw count of user-initiated API requests. - [JsonPropertyName("totalUserRequests")] - public long TotalUserRequests { get; set; } + /// Optional UI resource produced by the tool. + [JsonPropertyName("uiResource")] + public JsonElement? UiResource { get; set; } } -/// Identifies the target session. +/// Task-completion tool arguments and final result used to build a label-safe session event payload. [Experimental(Diagnostics.Experimental)] -internal sealed class SessionUsageGetMetricsRequest +internal sealed class ToolsTaskCompleteEventDataRequest { + /// Final expanded result returned by the task_complete tool. + [JsonPropertyName("finalResult")] + public ToolResultExpanded FinalResult { get => field ??= new(); set; } + /// Target session identifier. [JsonPropertyName("sessionId")] public string SessionId { get; set; } = string.Empty; + + /// Arguments supplied to the completed task_complete tool call. + [JsonPropertyName("toolArgs")] + public JsonElement ToolArgs { get; set; } } -/// GitHub URL for the session and a flag indicating whether remote steering is enabled. +/// Indicates whether the external tool call result was handled successfully. [Experimental(Diagnostics.Experimental)] -public sealed class RemoteEnableResult +public sealed class HandlePendingToolCallResult { - /// 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; } + /// Whether the tool call result was handled successfully. + [JsonPropertyName("success")] + public bool Success { get; set; } } -/// Optional remote session mode ("off", "export", or "on"); defaults to enabling both export and remote steering. +/// Pending external tool call request ID, with the tool result or an error describing why it failed. [Experimental(Diagnostics.Experimental)] -internal sealed class RemoteEnableRequest +internal sealed class HandlePendingToolCallRequest { - /// 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; } + /// Error message if the tool call failed. + [JsonPropertyName("error")] + public string? Error { get; set; } - /// Target session identifier. - [JsonPropertyName("sessionId")] - public string SessionId { get; set; } = string.Empty; -} + /// 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; } -/// 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. +/// 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 RemoteNotifySteerableChangedResult +public sealed class ToolsInitializeAndValidateResult { } -/// New remote-steerability state to persist as a `session.remote_steerable_changed` event. +/// Identifies the target session. [Experimental(Diagnostics.Experimental)] -internal sealed class RemoteNotifySteerableChangedRequest +internal sealed class SessionToolsInitializeAndValidateRequest { - /// 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. +/// Lightweight metadata for a currently initialized session tool. [Experimental(Diagnostics.Experimental)] -public sealed class VisibilityGetResult +public sealed class CurrentToolMetadata { - /// 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; } + /// Whether the tool is loaded on demand via tool search. + [JsonPropertyName("deferLoading")] + public bool? DeferLoading { 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; } + /// Tool description. + [JsonPropertyName("description")] + public string Description { get; set; } = string.Empty; - /// 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; } + /// 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 SessionVisibilityGetRequest +internal sealed class SessionToolsGetCurrentMetadataRequest { /// Target session identifier. [JsonPropertyName("sessionId")] public string SessionId { get; set; } = string.Empty; } -/// Effective sharing status and shareable GitHub URL after updating session visibility. +/// Empty result after replacing the calling connection's externally implemented tools. [Experimental(Diagnostics.Experimental)] -public sealed class VisibilitySetResult +public sealed class ToolsSetResult { - /// 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; } +/// Serializable definition of a caller-implemented tool whose execution is handled over the SDK connection. +[Experimental(Diagnostics.Experimental)] +public sealed class ProtocolExternalToolDefinition +{ + /// Tool-loading deferral policy. + [JsonPropertyName("defer")] + public ProtocolExternalToolDefer? Defer { 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; } + /// Model-visible explanation of what the tool does. + [JsonPropertyName("description")] + public string Description { get; set; } = string.Empty; + + /// Whether the tool executes commands in a terminal. + [JsonPropertyName("isTerminal")] + public bool? IsTerminal { get; set; } + + /// Optional caller-defined metadata associated with the tool. + [JsonPropertyName("metadata")] + public IDictionary? Metadata { get; set; } + + /// Unique model-visible tool name. + [JsonPropertyName("name")] + public string Name { get; set; } = string.Empty; + + /// Whether this definition replaces a built-in tool with the same name. + [JsonPropertyName("overridesBuiltInTool")] + public bool? OverridesBuiltInTool { get; set; } + + /// JSON Schema describing the tool's input arguments. + [JsonPropertyName("parameters")] + public IDictionary? Parameters { get; set; } + + /// Whether execution bypasses the normal tool permission prompt. + [JsonPropertyName("skipPermission")] + public bool? SkipPermission { get; set; } + + /// Optional human-readable display title. + [JsonPropertyName("title")] + public string? Title { get; set; } } -/// Desired sharing status for the session. +/// Complete externally implemented tool list for the calling connection. An empty list removes every tool previously supplied by that connection. [Experimental(Diagnostics.Experimental)] -internal sealed class VisibilitySetRequest +internal sealed class ToolsSetRequest { /// 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; } + /// Complete replacement list for the calling connection. + [JsonPropertyName("tools")] + public IList Tools { get => field ??= []; set; } } -/// Scheduled prompt entry with ID, timing (`intervalMs`, `cron`, or `at`), prompt text, recurrence, and next run time. +/// Empty result after applying subagent settings. [Experimental(Diagnostics.Experimental)] -public sealed class ScheduleEntry +public sealed class ToolsUpdateSubagentSettingsResult { - /// 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; } +/// 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; } - /// 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; } + /// Reasoning effort override for matching subagents. + [JsonPropertyName("effortLevel")] + public string? EffortLevel { get; set; } - /// Prompt text that gets enqueued on every tick. - [JsonPropertyName("prompt")] - public string Prompt { get; set; } = string.Empty; + /// Model override for matching subagents. + [JsonPropertyName("model")] + public string? Model { get; set; } +} - /// Whether the schedule re-arms after each tick (`/every`) or fires once (`/after`). - [JsonPropertyName("recurring")] - public bool Recurring { 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; } - /// 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; } + /// Names of subagents the user has turned off; they cannot be dispatched. + [JsonPropertyName("disabledSubagents")] + public IList? DisabledSubagents { get; set; } - /// IANA timezone the `cron` expression is evaluated in. - [JsonPropertyName("tz")] - public string? Tz { get; set; } -} + /// Maximum number of subagents that can run concurrently; applies to usage-based billing users only. + [JsonPropertyName("maxConcurrency")] + public int? MaxConcurrency { 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; } + /// Maximum subagent nesting depth; applies to usage-based billing users only. + [JsonPropertyName("maxDepth")] + public int? MaxDepth { get; set; } } -/// Identifies the target session. +/// Subagent settings to apply to the current session. [Experimental(Diagnostics.Experimental)] -internal sealed class SessionScheduleListRequest +internal sealed class UpdateSubagentSettingsRequest { /// 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; } + /// Subagent settings to apply, or null to clear the live session override. + [JsonPropertyName("subagents")] + public UpdateSubagentSettingsRequestSubagents? Subagents { get; set; } } -/// Identifier of the scheduled prompt to remove. +/// RPC data type for SessionCommandsList operations. [Experimental(Diagnostics.Experimental)] -internal sealed class ScheduleStopRequest +public sealed class SessionCommandsListRequest { - /// Id of the scheduled prompt to remove. - [JsonPropertyName("id")] - public long Id { get; set; } + /// Include runtime built-in commands. + [JsonPropertyName("includeBuiltins")] + public bool? IncludeBuiltins { get; set; } - /// Target session identifier. - [JsonPropertyName("sessionId")] - public string SessionId { get; set; } = string.Empty; -} + /// Include commands registered by protocol clients, including SDK clients and extensions. + [JsonPropertyName("includeClientCommands")] + public bool? IncludeClientCommands { get; set; } -/// 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; + /// Include enabled user-invocable skills and commands. + [JsonPropertyName("includeSkills")] + public bool? IncludeSkills { get; set; } } -/// 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. +/// RPC data type for SessionCommandsListRequestWithSession operations. [Experimental(Diagnostics.Experimental)] -public sealed class ProviderTokenAcquireRequest +internal sealed class SessionCommandsListRequestWithSession { - /// 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; + /// 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 returned by an extension factory closure. +/// 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)] -public sealed class FactoryExecuteResult +[JsonPolymorphic( + TypeDiscriminatorPropertyName = "kind", + UnknownDerivedTypeHandling = JsonUnknownDerivedTypeHandling.FallBackToBaseType)] +[JsonDerivedType(typeof(SlashCommandInvocationResultText), "text")] +[JsonDerivedType(typeof(SlashCommandInvocationResultAgentPrompt), "agent-prompt")] +[JsonDerivedType(typeof(SlashCommandInvocationResultCompleted), "completed")] +[JsonDerivedType(typeof(SlashCommandInvocationResultSelectSubcommand), "select-subcommand")] +[JsonDerivedType(typeof(SlashCommandInvocationResultAddTimelineEntry), "add-timeline-entry")] +[JsonDerivedType(typeof(SlashCommandInvocationResultShowDialog), "show-dialog")] +[JsonDerivedType(typeof(SlashCommandInvocationResultSetModel), "set-model")] +[JsonDerivedType(typeof(SlashCommandInvocationResultSetPlanModel), "set-plan-model")] +public partial class SlashCommandInvocationResult { - /// Factory result value. - [JsonPropertyName("result")] - public JsonElement Result { get; set; } + /// The type discriminator. + [JsonPropertyName("kind")] + public virtual string Kind { get; set; } = string.Empty; } -/// Parameters sent to the owning extension to execute a factory closure. + +/// Slash-command invocation result containing text output plus Markdown/ANSI rendering flags. +/// The text variant of . [Experimental(Diagnostics.Experimental)] -public sealed class FactoryExecuteRequest +public partial class SlashCommandInvocationResultText : SlashCommandInvocationResult { - /// Factory input value. - [JsonPropertyName("args")] - public JsonElement Args { get; set; } + /// + [JsonIgnore] + public override string Kind => "text"; - /// Registered factory name. - [JsonPropertyName("name")] - public string Name { get; set; } = string.Empty; + /// Whether text contains Markdown. + [JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)] + [JsonPropertyName("markdown")] + public bool? Markdown { get; set; } - /// Factory run identifier. - [JsonPropertyName("runId")] - public string RunId { get; set; } = string.Empty; + /// Whether ANSI sequences should be preserved. + [JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)] + [JsonPropertyName("preserveAnsi")] + public bool? PreserveAnsi { get; set; } - /// Target session identifier. - [JsonPropertyName("sessionId")] - public string SessionId { 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; } + + /// Text output for the client to render. + [JsonPropertyName("text")] + public required string Text { get; set; } } -/// Parameters for cooperatively aborting a factory body. +/// 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 sealed class FactoryAbortRequest +public partial class SlashCommandInvocationResultAgentPrompt : SlashCommandInvocationResult { - /// Factory run identifier. - [JsonPropertyName("runId")] - public string RunId { get; set; } = string.Empty; + /// + [JsonIgnore] + public override string Kind => "agent-prompt"; - /// Target session identifier. - [JsonPropertyName("sessionId")] - public string SessionId { get; set; } = string.Empty; + /// 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; } } -/// Describes a filesystem error. +/// Slash-command invocation result indicating completion, with optional message and settings-change flag. +/// The completed variant of . [Experimental(Diagnostics.Experimental)] -public sealed class SessionFsError +public partial class SlashCommandInvocationResultCompleted : SlashCommandInvocationResult { - /// Error classification. - [JsonPropertyName("code")] - public SessionFsErrorCode Code { get; set; } + /// + [JsonIgnore] + public override string Kind => "completed"; - /// Free-form detail about the error, for logging/diagnostics. + /// 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; } } -/// File content as a UTF-8 string, or a filesystem error if the read failed. +/// Selectable slash-command subcommand option with name, description, and optional group label. [Experimental(Diagnostics.Experimental)] -public sealed class SessionFsReadFileResult +public sealed class SlashCommandSelectSubcommandOption { - /// File content as UTF-8 string. - [JsonPropertyName("content")] - public string Content { get; set; } = string.Empty; + /// Human-readable description of the subcommand. + [JsonPropertyName("description")] + public string Description { get; set; } = string.Empty; - /// Describes a filesystem error. - [JsonPropertyName("error")] - public SessionFsError? Error { get; set; } + /// 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; } -/// Path of the file to read from the client-provided session filesystem. +/// Slash-command invocation result asking the client to present subcommand options for a parent command. +/// The select-subcommand variant of . [Experimental(Diagnostics.Experimental)] -public sealed class SessionFsReadFileRequest +public partial class SlashCommandInvocationResultSelectSubcommand : SlashCommandInvocationResult { - /// Path using SessionFs conventions. - [JsonPropertyName("path")] - public string Path { get; set; } = string.Empty; + /// + [JsonIgnore] + public override string Kind => "select-subcommand"; - /// Target session identifier. - [JsonPropertyName("sessionId")] - public string SessionId { get; set; } = string.Empty; -} + /// Parent command name that requires subcommand selection. + [JsonPropertyName("command")] + public required string Command { get; set; } -/// File path, content to write, and optional mode for the client-provided session filesystem. + /// 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; } +} + +/// RPC data type for SlashCommandTimelineEntry operations. [Experimental(Diagnostics.Experimental)] -public sealed class SessionFsWriteFileRequest +public sealed class SlashCommandTimelineEntry { - /// 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; } + /// Text displayed for the timeline entry. + [JsonPropertyName("text")] + public string Text { get; set; } = string.Empty; - /// Path using SessionFs conventions. - [JsonPropertyName("path")] - public string Path { get; set; } = string.Empty; + /// Timeline entry presentation type. + [JsonPropertyName("type")] + public string Type { get; set; } = string.Empty; - /// Target session identifier. - [JsonPropertyName("sessionId")] - public string SessionId { get; set; } = string.Empty; + /// Optional URL associated with the timeline entry. + [JsonPropertyName("url")] + public string? Url { get; set; } } -/// File path, content to append, and optional mode for the client-provided session filesystem. +/// The add-timeline-entry variant of . [Experimental(Diagnostics.Experimental)] -public sealed class SessionFsAppendFileRequest +public partial class SlashCommandInvocationResultAddTimelineEntry : SlashCommandInvocationResult { - /// Content to append. - [JsonPropertyName("content")] - public string Content { get; set; } = string.Empty; + /// + [JsonIgnore] + public override string Kind => "add-timeline-entry"; - /// Optional POSIX-style mode for newly created files. - [JsonPropertyName("mode")] - public long? Mode { get; set; } + /// Timeline entry the host should append. + [JsonPropertyName("entry")] + public required SlashCommandTimelineEntry Entry { get; set; } - /// Path using SessionFs conventions. - [JsonPropertyName("path")] - public string Path { get; set; } = string.Empty; + /// Optional text the host should prefill into the input editor. + [JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)] + [JsonPropertyName("prefillInput")] + public string? PrefillInput { get; set; } - /// Target session identifier. - [JsonPropertyName("sessionId")] - public string SessionId { get; set; } = string.Empty; + /// Whether command execution changed persisted runtime settings. + [JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)] + [JsonPropertyName("runtimeSettingsChanged")] + public bool? RuntimeSettingsChanged { get; set; } } -/// Indicates whether the requested path exists in the client-provided session filesystem. +/// RPC data type for SlashCommandModelPickerDialog operations. [Experimental(Diagnostics.Experimental)] -public sealed class SessionFsExistsResult +public sealed class SlashCommandModelPickerDialog { - /// Whether the path exists. - [JsonPropertyName("exists")] - public bool Exists { get; set; } + /// Discriminator for a model-picker dialog. + [JsonPropertyName("kind")] + public string Kind { get; set; } = string.Empty; + + /// Model that should be enabled before it can be selected. + [JsonPropertyName("modelToEnable")] + public string? ModelToEnable { get; set; } + + /// Settings scope the picker should modify. + [JsonPropertyName("scope")] + public string? Scope { get; set; } + + /// Model-selection target represented by the picker. + [JsonPropertyName("target")] + public string? Target { get; set; } } -/// Path to test for existence in the client-provided session filesystem. +/// The show-dialog variant of . [Experimental(Diagnostics.Experimental)] -public sealed class SessionFsExistsRequest +public partial class SlashCommandInvocationResultShowDialog : SlashCommandInvocationResult { - /// Path using SessionFs conventions. - [JsonPropertyName("path")] - public string Path { get; set; } = string.Empty; + /// + [JsonIgnore] + public override string Kind => "show-dialog"; - /// Target session identifier. - [JsonPropertyName("sessionId")] - public string SessionId { get; set; } = string.Empty; + /// Dialog the host should display. + [JsonPropertyName("dialog")] + public required SlashCommandModelPickerDialog Dialog { get; set; } + + /// Whether command execution changed persisted runtime settings. + [JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)] + [JsonPropertyName("runtimeSettingsChanged")] + public bool? RuntimeSettingsChanged { get; set; } } -/// Filesystem metadata for the requested path, or a filesystem error if the stat failed. +/// User-settings snapshot to restore if the host cancels the model switch. +public sealed class SlashCommandInvocationResultSetModelRevertOnCancel +{ +} + +/// The set-model variant of . [Experimental(Diagnostics.Experimental)] -public sealed class SessionFsStatResult +public partial class SlashCommandInvocationResultSetModel : SlashCommandInvocationResult { - /// ISO 8601 timestamp of creation. - [JsonPropertyName("birthtime")] - public DateTimeOffset Birthtime { get; set; } + /// + [JsonIgnore] + public override string Kind => "set-model"; - /// Describes a filesystem error. - [JsonPropertyName("error")] - public SessionFsError? Error { get; set; } + /// Model selected by the command. + [JsonPropertyName("model")] + public required string Model { get; set; } - /// Whether the path is a directory. - [JsonPropertyName("isDirectory")] - public bool IsDirectory { get; set; } + /// Reasoning effort selected for the model. + [JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)] + [JsonPropertyName("reasoningEffort")] + public string? ReasoningEffort { get; set; } - /// Whether the path is a file. - [JsonPropertyName("isFile")] - public bool IsFile { get; set; } + /// Repository settings scope modified by the command. + [JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)] + [JsonPropertyName("repoScope")] + public string? RepoScope { get; set; } - /// ISO 8601 timestamp of last modification. - [JsonPropertyName("mtime")] - public DateTimeOffset Mtime { get; set; } + /// User-settings snapshot to restore if the host cancels the model switch. + [JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)] + [JsonPropertyName("revertOnCancel")] + public SlashCommandInvocationResultSetModelRevertOnCancel? RevertOnCancel { get; set; } - /// File size in bytes. - [JsonPropertyName("size")] - public long Size { get; set; } + /// Whether command execution changed persisted runtime settings. + [JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)] + [JsonPropertyName("runtimeSettingsChanged")] + public bool? RuntimeSettingsChanged { get; set; } + + /// Settings scope modified by the command. + [JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)] + [JsonPropertyName("scope")] + public string? Scope { get; set; } + + /// User-facing warning produced while selecting the model. + [JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)] + [JsonPropertyName("warning")] + public string? Warning { get; set; } } -/// Path whose metadata should be returned from the client-provided session filesystem. +/// The set-plan-model variant of . [Experimental(Diagnostics.Experimental)] -public sealed class SessionFsStatRequest +public partial class SlashCommandInvocationResultSetPlanModel : SlashCommandInvocationResult { - /// Path using SessionFs conventions. - [JsonPropertyName("path")] - public string Path { get; set; } = string.Empty; + /// + [JsonIgnore] + public override string Kind => "set-plan-model"; - /// Target session identifier. - [JsonPropertyName("sessionId")] - public string SessionId { get; set; } = string.Empty; + /// User-facing confirmation message for the plan-model selection. + [JsonPropertyName("message")] + public required string Message { get; set; } + + /// Dedicated model selected for plan mode. + [JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)] + [JsonPropertyName("planModel")] + public string? PlanModel { get; set; } + + /// Whether command execution changed persisted runtime settings. + [JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)] + [JsonPropertyName("runtimeSettingsChanged")] + public bool? RuntimeSettingsChanged { get; set; } } -/// Directory path to create in the client-provided session filesystem, with options for recursive creation and POSIX mode. +/// Slash command name and optional raw input string to invoke. [Experimental(Diagnostics.Experimental)] -public sealed class SessionFsMkdirRequest +internal sealed class CommandsInvokeRequest { - /// Optional POSIX-style mode for newly created directories. - [JsonPropertyName("mode")] - public long? Mode { get; set; } + /// Raw input after the command name. + [JsonPropertyName("input")] + public string? Input { get; set; } - /// Path using SessionFs conventions. - [JsonPropertyName("path")] - public string Path { get; set; } = string.Empty; + /// Command name. Leading slashes are stripped and the name is matched case-insensitively. + [JsonPropertyName("name")] + public string Name { get; set; } = string.Empty; - /// Create parent directories as needed. - [JsonPropertyName("recursive")] - public bool? Recursive { get; set; } + /// Optional client surface that initiated the invocation. + [JsonPropertyName("origin")] + public CommandsInvocationOrigin? Origin { 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. +/// Whether finalizing the invocation effect succeeded, and the failure reason when it did not. [Experimental(Diagnostics.Experimental)] -public sealed class SessionFsReaddirResult +internal sealed class CommandsFinalizeInvocationEffectResult { - /// Entry names in the directory. - [JsonPropertyName("entries")] - public IList Entries { get => field ??= []; set; } - - /// Describes a filesystem error. + /// Failure reason when the invocation effect could not be finalized. [JsonPropertyName("error")] - public SessionFsError? Error { get; set; } + public string? Error { get; set; } + + /// Whether the pending invocation effect was finalized successfully. + [JsonPropertyName("success")] + public bool Success { get; set; } } -/// Directory path whose entries should be listed from the client-provided session filesystem. +/// The slash-command result object that produced the pending effect, echoed back unchanged. +public sealed class CommandsFinalizeInvocationEffectRequestEffect +{ +} + +/// The pending slash-command invocation effect to finalize, plus whether the host applied or cancelled it. [Experimental(Diagnostics.Experimental)] -public sealed class SessionFsReaddirRequest +internal sealed class CommandsFinalizeInvocationEffectRequest { - /// Path using SessionFs conventions. - [JsonPropertyName("path")] - public string Path { get; set; } = string.Empty; + /// The slash-command result object that produced the pending effect, echoed back unchanged. + [JsonPropertyName("effect")] + public CommandsFinalizeInvocationEffectRequestEffect Effect { get => field ??= new(); set; } + + /// Whether the host applied or cancelled the pending invocation effect. + [JsonPropertyName("outcome")] + public CommandsInvocationEffectOutcome Outcome { get; set; } /// Target session identifier. [JsonPropertyName("sessionId")] public string SessionId { get; set; } = string.Empty; } -/// Directory entry returned by session filesystem `readdirWithTypes`, with name and entry type. +/// Indicates whether the pending client-handled command was completed successfully. [Experimental(Diagnostics.Experimental)] -public sealed class SessionFsReaddirWithTypesEntry +public sealed class CommandsHandlePendingCommandResult { - /// Entry name. - [JsonPropertyName("name")] - public string Name { get; set; } = string.Empty; - - /// Entry type. - [JsonPropertyName("type")] - public SessionFsReaddirWithTypesEntryType Type { get; set; } + /// Whether the command was handled successfully. + [JsonPropertyName("success")] + public bool Success { get; set; } } -/// Entries in the requested directory paired with file/directory type information, or a filesystem error if the read failed. +/// Pending command request ID and an optional error if the client handler failed. [Experimental(Diagnostics.Experimental)] -public sealed class SessionFsReaddirWithTypesResult +internal sealed class CommandsHandlePendingCommandRequest { - /// Directory entries with type information. - [JsonPropertyName("entries")] - public IList Entries { get => field ??= []; set; } - - /// Describes a filesystem error. + /// Error message if the command handler failed. [JsonPropertyName("error")] - public SessionFsError? Error { get; set; } -} + public string? 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; + /// 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; } -/// Path to remove from the client-provided session filesystem, with options for recursive removal and force. +/// Error message produced while executing the command, if any. [Experimental(Diagnostics.Experimental)] -public sealed class SessionFsRmRequest +public sealed class ExecuteCommandResult { - /// 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; + /// Error message produced while executing the command, if any. Omitted when the handler succeeded. + [JsonPropertyName("error")] + public string? Error { get; set; } } -/// Source and destination paths for renaming or moving an entry in the client-provided session filesystem. +/// Slash command name and argument string to execute synchronously. [Experimental(Diagnostics.Experimental)] -public sealed class SessionFsRenameRequest +internal sealed class ExecuteCommandParams { - /// Destination path using SessionFs conventions. - [JsonPropertyName("dest")] - public string Dest { get; set; } = string.Empty; + /// 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; - - /// 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. +/// 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; +} + +/// Completed transient query. Ordered chunks and the terminal outcome are also delivered through `ui.ephemeral_query` session events while it runs. +[Experimental(Diagnostics.Experimental)] +public sealed class UIEphemeralQueryResult +{ + /// Answer returned by the model. + [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; +} + +/// MCP response metadata. +public sealed class UIElicitationResponseMeta +{ +} + +/// The elicitation response (accept with form values, decline, or cancel). +[Experimental(Diagnostics.Experimental)] +public sealed class UIElicitationResponse +{ + /// MCP response metadata. + [JsonPropertyName("_meta")] + public UIElicitationResponseMeta? Meta { get; set; } + + /// 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; } +} + +/// MCP request metadata. +public sealed class UIElicitationRequestMeta +{ +} + +/// 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; +} + +/// Metadata controlling an MCP task's lifetime. +[Experimental(Diagnostics.Experimental)] +public sealed class McpTaskMetadata +{ + /// Task time-to-live. + [JsonPropertyName("ttl")] + public long? Ttl { get; set; } +} + +/// Prompt message and JSON schema describing the form fields to elicit from the user. +[Experimental(Diagnostics.Experimental)] +internal sealed class UIElicitationRequest +{ + /// MCP request metadata. + [JsonPropertyName("_meta")] + public UIElicitationRequestMeta? Meta { get; set; } + + /// Message describing what information is needed from the user. + [JsonPropertyName("message")] + public string Message { get; set; } = string.Empty; + + /// Elicitation mode. Omitted and form are equivalent for structured elicitation. + [JsonPropertyName("mode")] + public McpElicitationFormMode? Mode { get; set; } + + /// 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; + + /// MCP task metadata. + [JsonPropertyName("task")] + public McpTaskMetadata? Task { get; set; } +} + +/// 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 +{ + /// Name of the policy source. + [JsonPropertyName("name")] + public string Name { get; set; } = string.Empty; + + /// Type of the policy source. + [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 +{ + /// Conditions of which at least one must match. + [JsonPropertyName("ifAnyMatch")] + public IList? IfAnyMatch { get; set; } + + /// Conditions none of which may match. + [JsonPropertyName("ifNoneMatch")] + public IList? IfNoneMatch { get; set; } + + /// Path patterns covered by this rule. + [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 +{ + /// Opaque policy update timestamp supplied by the host. + [JsonPropertyName("last_updated_at")] + public JsonElement LastUpdatedAt { get; set; } + + /// Content-exclusion rules to apply. + [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). Conventional `.github/skills/` and `.github/agents/` definitions under them also join the session catalogs when their subsystem gates are enabled, so supplying a directory is a trust decision for configuration stored there. 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; } + + /// Whether the responding client could ask a user interactively, was running headlessly, or had no response path. Omit when the client cannot determine this authoritatively. + [JsonPropertyName("responseCapability")] + public PermissionResponseCapability? ResponseCapability { 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")] +[JsonDerivedType(typeof(PermissionDecisionApproveForSessionApprovalExtensionEnvAccess), "extension-env-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; } +} + +/// Session-scoped approval details for an extension's access to sensitive environment variables, keyed by extension name and the exact set of variable names. +/// The extension-env-access variant of . +[Experimental(Diagnostics.Experimental)] +public partial class PermissionDecisionApproveForSessionApprovalExtensionEnvAccess : PermissionDecisionApproveForSessionApproval +{ + /// + [JsonIgnore] + public override string Kind => "extension-env-access"; + + /// Names of the sensitive environment variables this approval covers. Values are never persisted. + [JsonPropertyName("environmentVariables")] + public required IList EnvironmentVariables { get; set; } + + /// 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")] +[JsonDerivedType(typeof(PermissionDecisionApproveForLocationApprovalExtensionEnvAccess), "extension-env-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; } +} + +/// Location-scoped approval details for an extension's access to sensitive environment variables, keyed by extension name and the exact set of variable names. +/// The extension-env-access variant of . +[Experimental(Diagnostics.Experimental)] +public partial class PermissionDecisionApproveForLocationApprovalExtensionEnvAccess : PermissionDecisionApproveForLocationApproval +{ + /// + [JsonIgnore] + public override string Kind => "extension-env-access"; + + /// Names of the sensitive environment variables this approval covers. Values are never persisted. + [JsonPropertyName("environmentVariables")] + public required IList EnvironmentVariables { get; set; } + + /// 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 requested permission mode was applied and reports the authoritative post-mutation mode. +[Experimental(Diagnostics.Experimental)] +public sealed class PermissionsSetModeResult +{ + /// Authoritative permission mode after the mutation. + [JsonPropertyName("mode")] + public PermissionMode Mode { get; set; } + + /// Whether the operation succeeded. + [JsonPropertyName("success")] + public bool Success { get; set; } +} + +/// Permission mode to apply for the session. +[Experimental(Diagnostics.Experimental)] +internal sealed class PermissionsSetModeRequest +{ + /// Optional judge model id for assisted mode. When omitted, the session resolves the provider default: `gpt-5.5` for CAPI sessions and the active session model for BYOK sessions. + [JsonPropertyName("assistedApprovalModel")] + public string? AssistedApprovalModel { get; set; } + + /// Permission mode to apply. + [JsonPropertyName("mode")] + public PermissionMode Mode { get; set; } + + /// Target session identifier. + [JsonPropertyName("sessionId")] + public string SessionId { get; set; } = string.Empty; + + /// Optional source for permission-mode telemetry. Defaults to `rpc` when omitted for SDK callers. + [JsonPropertyName("source")] + public PermissionModeSource? Source { get; set; } +} + +/// Current permission mode. +[Experimental(Diagnostics.Experimental)] +public sealed class PermissionsGetModeResult +{ + /// Current permission mode. + [JsonPropertyName("mode")] + public PermissionMode Mode { get; set; } +} + +/// No parameters. +[Experimental(Diagnostics.Experimental)] +internal sealed class PermissionsGetModeRequest +{ + /// 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, then loads conventional `.github/skills/` and `.github/agents/` definitions under it when their subsystem gates are enabled. Adding the directory is therefore also a trust decision for configuration stored there. + [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")] +[JsonDerivedType(typeof(PermissionsLocationsAddToolApprovalDetailsExtensionEnvAccess), "extension-env-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-persisted tool approval details for an extension's access to sensitive environment variables, keyed by extension name and the exact set of variable names. +/// The extension-env-access variant of . +[Experimental(Diagnostics.Experimental)] +public partial class PermissionsLocationsAddToolApprovalDetailsExtensionEnvAccess : PermissionsLocationsAddToolApprovalDetails +{ + /// + [JsonIgnore] + public override string Kind => "extension-env-access"; + + /// Names of the sensitive environment variables this approval covers. Values are never persisted. + [JsonPropertyName("environmentVariables")] + public required IList EnvironmentVariables { get; set; } + + /// 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 +{ + /// Whether the create-pull-request tool is available. + [JsonPropertyName("createPullRequest")] + public bool? CreatePullRequest { get; set; } + + /// Whether the report-progress tool is available. + [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 +{ + /// Availability of job-specific built-in tools. + [JsonPropertyName("builtInToolAvailability")] + public SessionSettingsBuiltInToolAvailabilitySnapshot? BuiltInToolAvailability { get; set; } + + /// GitHub Actions event type for the job. + [JsonPropertyName("eventType")] + public string? EventType { get; set; } + + /// Whether this is the workflow's trigger job. + [JsonPropertyName("isTriggerJob")] + public bool? IsTriggerJob { get; set; } +} + +/// Redacted model routing settings for a session. +[Experimental(Diagnostics.Experimental)] +public sealed class SessionSettingsModelSnapshot +{ + /// Agent service callback URL for job and progress updates. + [JsonPropertyName("callbackUrl")] + public string? CallbackUrl { get; set; } + + /// Default reasoning effort for the selected model. + [JsonPropertyName("defaultReasoningEffort")] + public string? DefaultReasoningEffort { get; set; } + + /// Agent job identifier for the session. + [JsonPropertyName("instanceId")] + public string? InstanceId { get; set; } + + /// Selected model identifier. + [JsonPropertyName("model")] + public string? Model { get; set; } +} + +/// Online-evaluation settings safe to expose across the SDK boundary. +[Experimental(Diagnostics.Experimental)] +public sealed class SessionSettingsOnlineEvaluationSnapshot +{ + /// Whether online evaluation is disabled. + [JsonPropertyName("disableOnlineEvaluation")] + public bool? DisableOnlineEvaluation { get; set; } + + /// Whether online-evaluation output-file generation is enabled. + [JsonPropertyName("enableOnlineEvaluationOutputFile")] + public bool? EnableOnlineEvaluationOutputFile { get; set; } +} + +/// Redacted repository and GitHub host settings for a session. +[Experimental(Diagnostics.Experimental)] +public sealed class SessionSettingsRepoSnapshot +{ + /// Checked-out repository branch. + [JsonPropertyName("branch")] + public string? Branch { get; set; } + + /// Checked-out commit SHA. + [JsonPropertyName("commit")] + public string? Commit { get; set; } + + /// GitHub server host name. + [JsonPropertyName("host")] + public string? Host { get; set; } + + /// Protocol used to access the GitHub host. + [JsonPropertyName("hostProtocol")] + public string? HostProtocol { get; set; } + + /// GitHub repository database ID. + [JsonPropertyName("id")] + public double? Id { get; set; } + + /// Repository name. + [JsonPropertyName("name")] + public string? Name { get; set; } + + /// GitHub repository owner database ID. + [JsonPropertyName("ownerId")] + public double? OwnerId { get; set; } + + /// Repository owner login. + [JsonPropertyName("ownerName")] + public string? OwnerName { get; set; } + + /// Number of commits in the pull request. + [JsonPropertyName("prCommitCount")] + public double? PrCommitCount { get; set; } + + /// Whether the repository is writable. + [JsonPropertyName("readWrite")] + public bool? ReadWrite { get; set; } + + /// GitHub secret-scanning service URL. + [JsonPropertyName("secretScanningUrl")] + public string? SecretScanningUrl { get; set; } + + /// GitHub server base URL. + [JsonPropertyName("serverUrl")] + public string? ServerUrl { get; set; } +} + +/// Redacted validation and memory-tool settings for a session. +[Experimental(Diagnostics.Experimental)] +public sealed class SessionSettingsValidationSnapshot +{ + /// Whether advisory validation is enabled. + [JsonPropertyName("advisoryEnabled")] + public bool? AdvisoryEnabled { get; set; } + + /// Whether CodeQL validation is enabled. + [JsonPropertyName("codeqlEnabled")] + public bool? CodeqlEnabled { get; set; } + + /// Whether code-review validation is enabled. + [JsonPropertyName("codeReviewEnabled")] + public bool? CodeReviewEnabled { get; set; } + + /// Model used for code-review validation. + [JsonPropertyName("codeReviewModel")] + public string? CodeReviewModel { get; set; } + + /// Dependabot validation timeout budget in seconds. + [JsonPropertyName("dependabotTimeout")] + public double? DependabotTimeout { get; set; } + + /// Whether the memory-store tool is enabled. + [JsonPropertyName("memoryStoreEnabled")] + public bool? MemoryStoreEnabled { get; set; } + + /// Whether the memory-vote tool is enabled. + [JsonPropertyName("memoryVoteEnabled")] + public bool? MemoryVoteEnabled { get; set; } + + /// Whether secret-scanning validation is enabled. + [JsonPropertyName("secretScanningEnabled")] + public bool? SecretScanningEnabled { get; set; } + + /// General validation timeout budget in seconds. + [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 +{ + /// Name of the SDK client that created the session. + [JsonPropertyName("clientName")] + public string? ClientName { get; set; } + + /// Redacted job settings. + [JsonPropertyName("job")] + public SessionSettingsJobSnapshot Job { get => field ??= new(); set; } + + /// Redacted model routing settings. + [JsonPropertyName("model")] + public SessionSettingsModelSnapshot Model { get => field ??= new(); set; } + + /// Online-evaluation settings safe for SDK consumers. + [JsonPropertyName("onlineEvaluation")] + public SessionSettingsOnlineEvaluationSnapshot OnlineEvaluation { get => field ??= new(); set; } + + /// Redacted repository and host settings. + [JsonPropertyName("repo")] + public SessionSettingsRepoSnapshot Repo { get => field ??= new(); set; } + + /// Session start time as Unix epoch milliseconds. + [JsonPropertyName("startTimeMs")] + public double? StartTimeMs { get; set; } + + /// Session timeout in milliseconds. + [JsonPropertyName("timeoutMs")] + public double? TimeoutMs { get; set; } + + /// Redacted validation and memory-tool settings. + [JsonPropertyName("validation")] + public SessionSettingsValidationSnapshot Validation { get => field ??= new(); set; } + + /// Agent runtime version selector copied from the session settings, such as `latest` or a runtime release identifier. + [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 +{ + /// Whether the named settings predicate evaluated to enabled. + [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 +{ + /// How many leading entries of `steeringMessages` have already been folded into the running turn (and so have an emitted `user.message`), as opposed to still waiting for one. Absent for hosts that do not distinguish the two. + [JsonPropertyName("inFlightSteeringCount")] + public long? InFlightSteeringCount { get; set; } + + /// 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 +{ + /// Queued message contents and delivery metadata. + [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 +{ + /// Stable opaque ID of the queued item to remove. + [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 +{ + /// Optional replacement prompt displayed to the user. + [JsonPropertyName("displayPrompt")] + public string? DisplayPrompt { get; set; } + + /// Stable opaque ID of the queued item to edit. + [JsonPropertyName("id")] + public string Id { get; set; } = string.Empty; + + /// Replacement prompt sent to the model. + [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 +{ + /// Stable opaque ID of the queued item to duplicate. + [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 +{ + /// Whether queued-lane draining should be paused. + [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 +{ + /// Stable opaque ID of the queued item to steer into the live turn. + [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; +} + +/// 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; } +} + +/// Usage attributed to one agent instance, including its identity, API duration, AI units, and per-model breakdown. +[Experimental(Diagnostics.Experimental)] +public sealed class UsageMetricsAgentMetric +{ + /// Human-readable label for this subagent invocation, copied from the originating `subagent.started` event. For task-tool subagents this is the invocation's task description rather than the agent's configured display name, so group by `agentName` for stable per-agent labels. + [JsonPropertyName("agentDisplayName")] + public string? AgentDisplayName { get; set; } + + /// Configured agent name, when this is a subagent. + [JsonPropertyName("agentName")] + public string? AgentName { get; set; } + + /// Per-model usage for this agent, keyed by model identifier. + [JsonPropertyName("modelMetrics")] + public IDictionary ModelMetrics { get => field ??= new Dictionary(); set; } + + /// Time spent in model API calls by this agent, in milliseconds. + [JsonConverter(typeof(MillisecondsTimeSpanConverter))] + [JsonPropertyName("totalApiDurationMs")] + public TimeSpan TotalApiDuration { get; set; } + + /// Accumulated nano-AI units cost for this agent. + [JsonPropertyName("totalNanoAiu")] + public double TotalNanoAiu { get; set; } +} + +/// 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; } +} + +/// 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 +{ + /// Per-agent usage metrics, keyed by agent instance identifier. The main conversation uses the stable key `main`. + [JsonPropertyName("agentMetrics")] + public IDictionary? AgentMetrics { get; set; } + + /// 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; } + + /// Semantic usage tier. + [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 the configured provider 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; } + /// 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 +{ + /// Machine-readable classification of the transaction failure. + [JsonPropertyName("errorClass")] + public SessionFsSqliteTransactionErrorClass ErrorClass { get; set; } + + /// Human-readable transaction failure message. + [JsonPropertyName("message")] + public string Message { get; set; } = string.Empty; +} + +/// Per-statement results, or a classified transaction error. +[Experimental(Diagnostics.Experimental)] +public sealed class SessionFsSqliteTransactionResult +{ + /// Classified transaction failure, when execution did not succeed. + [JsonPropertyName("error")] + public SessionFsSqliteTransactionError? Error { get; set; } + + /// Per-statement query results in input order. + [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; + + /// Ordered SQL statements to execute in one transaction. + [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; } + + /// HTTP request headers, preserving multiple values per name. + [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; } + + /// Number of logical CPU cores on the host. + [JsonPropertyName("cpu_count")] + public long? CpuCount { get; set; } + + /// Distinct CPU model names for the host, comma-separated. + [JsonPropertyName("cpu_model")] + public string? CpuModel { 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; } +} + +/// SDK host response to a GitHub credential request. +/// Polymorphic base type discriminated by kind. +[Experimental(Diagnostics.Experimental)] +[JsonPolymorphic( + TypeDiscriminatorPropertyName = "kind", + UnknownDerivedTypeHandling = JsonUnknownDerivedTypeHandling.FallBackToBaseType)] +[JsonDerivedType(typeof(GitHubTokenAcquireResultToken), "token")] +[JsonDerivedType(typeof(GitHubTokenAcquireResultCancelled), "cancelled")] +public partial class GitHubTokenAcquireResult +{ + /// The type discriminator. + [JsonPropertyName("kind")] + public virtual string Kind { get; set; } = string.Empty; +} + + +/// The token variant of . +[Experimental(Diagnostics.Experimental)] +public partial class GitHubTokenAcquireResultToken : GitHubTokenAcquireResult +{ + /// + [JsonIgnore] + public override string Kind => "token"; + + /// GitHub access token acquired by the SDK host. + [JsonPropertyName("accessToken")] + public required string AccessToken { get; set; } + + /// Remaining token lifetime in seconds when callback execution completes. It must exceed the one-hour preflight refresh threshold. + [JsonPropertyName("expiresIn")] + public required 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 GitHubTokenAcquireResultCancelled : GitHubTokenAcquireResult +{ + /// + [JsonIgnore] + public override string Kind => "cancelled"; +} + +/// Asks the SDK client to acquire a GitHub access token from an opaque callback registration. +[Experimental(Diagnostics.Experimental)] +public sealed class GitHubTokenAcquireRequest +{ + /// Effective GitHub host for which the callback must return a token. + [JsonPropertyName("host")] + public string Host { get; set; } = string.Empty; + + /// Why the runtime is requesting a GitHub credential. + [JsonPropertyName("reason")] + public GitHubTokenAcquireReason Reason { get; set; } + + /// Opaque identifier generated by the SDK for this callback registration. + [JsonPropertyName("registrationId")] + public string RegistrationId { get; set; } = string.Empty; + + /// Session receiving the token. Absent only before a cloud session has been assigned its id. + [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)); + } + } +} + + +/// A wire feature a caller can require of the catalog surface, negotiated per request. A grant means the runtime understands the feature's contract, not that the deployment has enabled the operation; typed unavailable results report availability separately. +[Experimental(Diagnostics.Experimental)] +[JsonConverter(typeof(Converter))] +[DebuggerDisplay("{Value,nq}")] +public readonly struct CatalogCapability : IEquatable +{ + private readonly string? _value; + + /// Initializes a new instance of the struct. + /// The value to associate with this . + [JsonConstructor] + public CatalogCapability(string value) + { + ArgumentException.ThrowIfNullOrWhiteSpace(value); + _value = value; + } + + /// Gets the value associated with this . + public string Value => _value ?? string.Empty; + + /// Understands the current `application/mcp-server-card+json` media type. + public static CatalogCapability McpServerCard { get; } = new("mcp-server-card"); + + /// Understands the legacy `application/mcp-server+json` media type. + public static CatalogCapability LegacyMcpServerCard { get; } = new("legacy-mcp-server-card"); + + /// Understands `application/ai-skill` candidates as discovery-only and typed non-installable. + public static CatalogCapability AiSkillDiscovery { get; } = new("ai-skill-discovery"); + + /// Understands side-effect-free MCP install-plan requests, results, and plan handles; `planning-unavailable` separately reports that planning is not enabled. + public static CatalogCapability McpInstallPlanning { get; } = new("mcp-install-planning"); + + /// Understands plans that enumerate every eligible transport rather than a single preferred one. + public static CatalogCapability MultipleTransportChoice { get; } = new("multiple-transport-choice"); + + /// Returns a value indicating whether two instances are equivalent. + public static bool operator ==(CatalogCapability left, CatalogCapability right) => left.Equals(right); + + /// Returns a value indicating whether two instances are not equivalent. + public static bool operator !=(CatalogCapability left, CatalogCapability right) => !(left == right); + + /// + public override bool Equals(object? obj) => obj is CatalogCapability other && Equals(other); + + /// + public bool Equals(CatalogCapability 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 CatalogCapability Read(ref Utf8JsonReader reader, Type typeToConvert, JsonSerializerOptions options) + { + return new(GeneratedStringEnumJson.ReadValue(ref reader, typeToConvert)); + } + + /// + public override void Write(Utf8JsonWriter writer, CatalogCapability value, JsonSerializerOptions options) + { + GeneratedStringEnumJson.WriteValue(writer, value.Value, typeof(CatalogCapability)); + } + } +} + + +/// Whether a planned configuration change would create or modify an entry. +[Experimental(Diagnostics.Experimental)] +[JsonConverter(typeof(Converter))] +[DebuggerDisplay("{Value,nq}")] +public readonly struct McpPlanConfigurationOperation : IEquatable +{ + private readonly string? _value; + + /// Initializes a new instance of the struct. + /// The value to associate with this . + [JsonConstructor] + public McpPlanConfigurationOperation(string value) + { + ArgumentException.ThrowIfNullOrWhiteSpace(value); + _value = value; + } + + /// Gets the value associated with this . + public string Value => _value ?? string.Empty; + + /// Creates a configuration entry that does not exist yet. + public static McpPlanConfigurationOperation Add { get; } = new("add"); + + /// Modifies a configuration entry that already exists. + public static McpPlanConfigurationOperation Update { get; } = new("update"); + + /// Returns a value indicating whether two instances are equivalent. + public static bool operator ==(McpPlanConfigurationOperation left, McpPlanConfigurationOperation right) => left.Equals(right); + + /// Returns a value indicating whether two instances are not equivalent. + public static bool operator !=(McpPlanConfigurationOperation left, McpPlanConfigurationOperation right) => !(left == right); + + /// + public override bool Equals(object? obj) => obj is McpPlanConfigurationOperation other && Equals(other); + + /// + public bool Equals(McpPlanConfigurationOperation 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 McpPlanConfigurationOperation Read(ref Utf8JsonReader reader, Type typeToConvert, JsonSerializerOptions options) + { + return new(GeneratedStringEnumJson.ReadValue(ref reader, typeToConvert)); + } + + /// + public override void Write(Utf8JsonWriter writer, McpPlanConfigurationOperation value, JsonSerializerOptions options) + { + GeneratedStringEnumJson.WriteValue(writer, value.Value, typeof(McpPlanConfigurationOperation)); + } + } +} + + +/// Configuration scope an MCP install plan targets. +[Experimental(Diagnostics.Experimental)] +[JsonConverter(typeof(Converter))] +[DebuggerDisplay("{Value,nq}")] +public readonly struct McpPlanScope : IEquatable +{ + private readonly string? _value; + + /// Initializes a new instance of the struct. + /// The value to associate with this . + [JsonConstructor] + public McpPlanScope(string value) + { + ArgumentException.ThrowIfNullOrWhiteSpace(value); + _value = value; + } + + /// Gets the value associated with this . + public string Value => _value ?? string.Empty; + + /// The user's own MCP configuration. + public static McpPlanScope User { get; } = new("user"); + + /// Returns a value indicating whether two instances are equivalent. + public static bool operator ==(McpPlanScope left, McpPlanScope right) => left.Equals(right); + + /// Returns a value indicating whether two instances are not equivalent. + public static bool operator !=(McpPlanScope left, McpPlanScope right) => !(left == right); + + /// + public override bool Equals(object? obj) => obj is McpPlanScope other && Equals(other); + + /// + public bool Equals(McpPlanScope 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 McpPlanScope Read(ref Utf8JsonReader reader, Type typeToConvert, JsonSerializerOptions options) + { + return new(GeneratedStringEnumJson.ReadValue(ref reader, typeToConvert)); + } + + /// + public override void Write(Utf8JsonWriter writer, McpPlanScope value, JsonSerializerOptions options) + { + GeneratedStringEnumJson.WriteValue(writer, value.Value, typeof(McpPlanScope)); + } + } +} + + +/// What policy decided for a planned server. +[Experimental(Diagnostics.Experimental)] +[JsonConverter(typeof(Converter))] +[DebuggerDisplay("{Value,nq}")] +public readonly struct McpPlanPolicyDecision : IEquatable +{ + private readonly string? _value; + + /// Initializes a new instance of the struct. + /// The value to associate with this . + [JsonConstructor] + public McpPlanPolicyDecision(string value) + { + ArgumentException.ThrowIfNullOrWhiteSpace(value); + _value = value; + } + + /// Gets the value associated with this . + public string Value => _value ?? string.Empty; + + /// Policy permits the server. + public static McpPlanPolicyDecision Allowed { get; } = new("allowed"); + + /// Policy forbids the server, so the plan cannot be applied. + public static McpPlanPolicyDecision Blocked { get; } = new("blocked"); + + /// Policy permits the server only after an explicit approval. + public static McpPlanPolicyDecision RequiresApproval { get; } = new("requires-approval"); + + /// Returns a value indicating whether two instances are equivalent. + public static bool operator ==(McpPlanPolicyDecision left, McpPlanPolicyDecision right) => left.Equals(right); + + /// Returns a value indicating whether two instances are not equivalent. + public static bool operator !=(McpPlanPolicyDecision left, McpPlanPolicyDecision right) => !(left == right); + + /// + public override bool Equals(object? obj) => obj is McpPlanPolicyDecision other && Equals(other); + + /// + public bool Equals(McpPlanPolicyDecision 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 McpPlanPolicyDecision Read(ref Utf8JsonReader reader, Type typeToConvert, JsonSerializerOptions options) + { + return new(GeneratedStringEnumJson.ReadValue(ref reader, typeToConvert)); + } + + /// + public override void Write(Utf8JsonWriter writer, McpPlanPolicyDecision value, JsonSerializerOptions options) + { + GeneratedStringEnumJson.WriteValue(writer, value.Value, typeof(McpPlanPolicyDecision)); + } + } +} + + +/// Which authority produced a policy decision. +[Experimental(Diagnostics.Experimental)] +[JsonConverter(typeof(Converter))] +[DebuggerDisplay("{Value,nq}")] +public readonly struct McpPlanPolicySource : IEquatable +{ + private readonly string? _value; + + /// Initializes a new instance of the struct. + /// The value to associate with this . + [JsonConstructor] + public McpPlanPolicySource(string value) + { + ArgumentException.ThrowIfNullOrWhiteSpace(value); + _value = value; + } + + /// Gets the value associated with this . + public string Value => _value ?? string.Empty; + + /// No policy applied, so the server is permitted by default. + public static McpPlanPolicySource None { get; } = new("none"); + + /// An enterprise allowlist evaluated the server. + public static McpPlanPolicySource EnterpriseAllowlist { get; } = new("enterprise-allowlist"); + + /// The registry the card came from evaluated the server. + public static McpPlanPolicySource RegistryPolicy { get; } = new("registry-policy"); + + /// Local trust settings evaluated the server. + public static McpPlanPolicySource LocalTrust { get; } = new("local-trust"); + + /// Returns a value indicating whether two instances are equivalent. + public static bool operator ==(McpPlanPolicySource left, McpPlanPolicySource right) => left.Equals(right); + + /// Returns a value indicating whether two instances are not equivalent. + public static bool operator !=(McpPlanPolicySource left, McpPlanPolicySource right) => !(left == right); + + /// + public override bool Equals(object? obj) => obj is McpPlanPolicySource other && Equals(other); + + /// + public bool Equals(McpPlanPolicySource 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 McpPlanPolicySource Read(ref Utf8JsonReader reader, Type typeToConvert, JsonSerializerOptions options) + { + return new(GeneratedStringEnumJson.ReadValue(ref reader, typeToConvert)); + } + + /// + public override void Write(Utf8JsonWriter writer, McpPlanPolicySource value, JsonSerializerOptions options) + { + GeneratedStringEnumJson.WriteValue(writer, value.Value, typeof(McpPlanPolicySource)); + } + } +} + + +/// Canonical digest algorithm for a validated MCP card. +[Experimental(Diagnostics.Experimental)] +[JsonConverter(typeof(Converter))] +[DebuggerDisplay("{Value,nq}")] +public readonly struct CardDigestAlgorithm : IEquatable +{ + private readonly string? _value; + + /// Initializes a new instance of the struct. + /// The value to associate with this . + [JsonConstructor] + public CardDigestAlgorithm(string value) + { + ArgumentException.ThrowIfNullOrWhiteSpace(value); + _value = value; + } + + /// Gets the value associated with this . + public string Value => _value ?? string.Empty; + + /// SHA-256 over RFC 8785 canonical JSON encoded as UTF-8. + public static CardDigestAlgorithm Sha256Rfc8785 { get; } = new("sha256-rfc8785"); + + /// Returns a value indicating whether two instances are equivalent. + public static bool operator ==(CardDigestAlgorithm left, CardDigestAlgorithm right) => left.Equals(right); + + /// Returns a value indicating whether two instances are not equivalent. + public static bool operator !=(CardDigestAlgorithm left, CardDigestAlgorithm right) => !(left == right); + + /// + public override bool Equals(object? obj) => obj is CardDigestAlgorithm other && Equals(other); + + /// + public bool Equals(CardDigestAlgorithm 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 CardDigestAlgorithm Read(ref Utf8JsonReader reader, Type typeToConvert, JsonSerializerOptions options) + { + return new(GeneratedStringEnumJson.ReadValue(ref reader, typeToConvert)); + } + + /// + public override void Write(Utf8JsonWriter writer, CardDigestAlgorithm value, JsonSerializerOptions options) + { + GeneratedStringEnumJson.WriteValue(writer, value.Value, typeof(CardDigestAlgorithm)); + } + } +} + + +/// JSON MCP card media type accepted for install planning. +[Experimental(Diagnostics.Experimental)] +[JsonConverter(typeof(Converter))] +[DebuggerDisplay("{Value,nq}")] +public readonly struct McpServerCardMediaType : IEquatable +{ + private readonly string? _value; + + /// Initializes a new instance of the struct. + /// The value to associate with this . + [JsonConstructor] + public McpServerCardMediaType(string value) + { + ArgumentException.ThrowIfNullOrWhiteSpace(value); + _value = value; + } + + /// Gets the value associated with this . + public string Value => _value ?? string.Empty; + + /// The current MCP server card media type. + public static McpServerCardMediaType ApplicationMcpServerCardJson { get; } = new("application/mcp-server-card+json"); + + /// The legacy MCP server card media type, accepted for compatibility. + public static McpServerCardMediaType ApplicationMcpServerJson { get; } = new("application/mcp-server+json"); + + /// Returns a value indicating whether two instances are equivalent. + public static bool operator ==(McpServerCardMediaType left, McpServerCardMediaType right) => left.Equals(right); + + /// Returns a value indicating whether two instances are not equivalent. + public static bool operator !=(McpServerCardMediaType left, McpServerCardMediaType right) => !(left == right); + + /// + public override bool Equals(object? obj) => obj is McpServerCardMediaType other && Equals(other); + + /// + public bool Equals(McpServerCardMediaType 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 McpServerCardMediaType Read(ref Utf8JsonReader reader, Type typeToConvert, JsonSerializerOptions options) + { + return new(GeneratedStringEnumJson.ReadValue(ref reader, typeToConvert)); + } + + /// + public override void Write(Utf8JsonWriter writer, McpServerCardMediaType value, JsonSerializerOptions options) + { + GeneratedStringEnumJson.WriteValue(writer, value.Value, typeof(McpServerCardMediaType)); + } + } +} + + +/// Where a required value is applied when the planned server is launched. +[Experimental(Diagnostics.Experimental)] +[JsonConverter(typeof(Converter))] +[DebuggerDisplay("{Value,nq}")] +public readonly struct McpPlanValueCategory : IEquatable +{ + private readonly string? _value; + + /// Initializes a new instance of the struct. + /// The value to associate with this . + [JsonConstructor] + public McpPlanValueCategory(string value) + { + ArgumentException.ThrowIfNullOrWhiteSpace(value); + _value = value; + } + + /// Gets the value associated with this . + public string Value => _value ?? string.Empty; + + /// Set as an environment variable on the launched process. + public static McpPlanValueCategory EnvironmentVariable { get; } = new("environment-variable"); + + /// Passed to the runtime that launches the package. + public static McpPlanValueCategory RuntimeArgument { get; } = new("runtime-argument"); + + /// Passed to the packaged server itself. + public static McpPlanValueCategory PackageArgument { get; } = new("package-argument"); + + /// Sent as a request header to a remote endpoint. + public static McpPlanValueCategory Header { get; } = new("header"); + + /// Substituted into the remote endpoint URL. + public static McpPlanValueCategory UrlVariable { get; } = new("url-variable"); + + /// Returns a value indicating whether two instances are equivalent. + public static bool operator ==(McpPlanValueCategory left, McpPlanValueCategory right) => left.Equals(right); + + /// Returns a value indicating whether two instances are not equivalent. + public static bool operator !=(McpPlanValueCategory left, McpPlanValueCategory right) => !(left == right); + + /// + public override bool Equals(object? obj) => obj is McpPlanValueCategory other && Equals(other); + + /// + public bool Equals(McpPlanValueCategory 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 McpPlanValueCategory Read(ref Utf8JsonReader reader, Type typeToConvert, JsonSerializerOptions options) + { + return new(GeneratedStringEnumJson.ReadValue(ref reader, typeToConvert)); + } + + /// + public override void Write(Utf8JsonWriter writer, McpPlanValueCategory value, JsonSerializerOptions options) + { + GeneratedStringEnumJson.WriteValue(writer, value.Value, typeof(McpPlanValueCategory)); + } + } +} + + +/// Scalar type a required value must conform to. +[Experimental(Diagnostics.Experimental)] +[JsonConverter(typeof(Converter))] +[DebuggerDisplay("{Value,nq}")] +public readonly struct McpPlanScalarValueType : IEquatable +{ + private readonly string? _value; + + /// Initializes a new instance of the struct. + /// The value to associate with this . + [JsonConstructor] + public McpPlanScalarValueType(string value) + { + ArgumentException.ThrowIfNullOrWhiteSpace(value); + _value = value; + } + + /// Gets the value associated with this . + public string Value => _value ?? string.Empty; + + /// Free text. + public static McpPlanScalarValueType String { get; } = new("string"); + + /// A number. + public static McpPlanScalarValueType Number { get; } = new("number"); + + /// A boolean. + public static McpPlanScalarValueType Boolean { get; } = new("boolean"); + + /// A filesystem path. + public static McpPlanScalarValueType Path { get; } = new("path"); + + /// Returns a value indicating whether two instances are equivalent. + public static bool operator ==(McpPlanScalarValueType left, McpPlanScalarValueType right) => left.Equals(right); + + /// Returns a value indicating whether two instances are not equivalent. + public static bool operator !=(McpPlanScalarValueType left, McpPlanScalarValueType right) => !(left == right); + + /// + public override bool Equals(object? obj) => obj is McpPlanScalarValueType other && Equals(other); + + /// + public bool Equals(McpPlanScalarValueType 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 McpPlanScalarValueType Read(ref Utf8JsonReader reader, Type typeToConvert, JsonSerializerOptions options) + { + return new(GeneratedStringEnumJson.ReadValue(ref reader, typeToConvert)); + } + + /// + public override void Write(Utf8JsonWriter writer, McpPlanScalarValueType value, JsonSerializerOptions options) + { + GeneratedStringEnumJson.WriteValue(writer, value.Value, typeof(McpPlanScalarValueType)); + } + } +} + + +/// Discriminator for an enumerated required value. +[Experimental(Diagnostics.Experimental)] +[JsonConverter(typeof(Converter))] +[DebuggerDisplay("{Value,nq}")] +public readonly struct McpPlanEnumValueType : IEquatable +{ + private readonly string? _value; + + /// Initializes a new instance of the struct. + /// The value to associate with this . + [JsonConstructor] + public McpPlanEnumValueType(string value) + { + ArgumentException.ThrowIfNullOrWhiteSpace(value); + _value = value; + } + + /// Gets the value associated with this . + public string Value => _value ?? string.Empty; + + /// One of a fixed, non-empty set of permitted values. + public static McpPlanEnumValueType Enum { get; } = new("enum"); + + /// Returns a value indicating whether two instances are equivalent. + public static bool operator ==(McpPlanEnumValueType left, McpPlanEnumValueType right) => left.Equals(right); + + /// Returns a value indicating whether two instances are not equivalent. + public static bool operator !=(McpPlanEnumValueType left, McpPlanEnumValueType right) => !(left == right); + + /// + public override bool Equals(object? obj) => obj is McpPlanEnumValueType other && Equals(other); + + /// + public bool Equals(McpPlanEnumValueType 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 McpPlanEnumValueType Read(ref Utf8JsonReader reader, Type typeToConvert, JsonSerializerOptions options) + { + return new(GeneratedStringEnumJson.ReadValue(ref reader, typeToConvert)); + } + + /// + public override void Write(Utf8JsonWriter writer, McpPlanEnumValueType value, JsonSerializerOptions options) + { + GeneratedStringEnumJson.WriteValue(writer, value.Value, typeof(McpPlanEnumValueType)); + } + } +} + + +/// Transport exposed by a locally launched package. +[Experimental(Diagnostics.Experimental)] +[JsonConverter(typeof(Converter))] +[DebuggerDisplay("{Value,nq}")] +public readonly struct McpPlanPackageTransport : IEquatable +{ + private readonly string? _value; + + /// Initializes a new instance of the struct. + /// The value to associate with this . + [JsonConstructor] + public McpPlanPackageTransport(string value) + { + ArgumentException.ThrowIfNullOrWhiteSpace(value); + _value = value; + } + + /// Gets the value associated with this . + public string Value => _value ?? string.Empty; + + /// A locally launched process spoken to over standard input and output. + public static McpPlanPackageTransport Stdio { get; } = new("stdio"); + + /// Returns a value indicating whether two instances are equivalent. + public static bool operator ==(McpPlanPackageTransport left, McpPlanPackageTransport right) => left.Equals(right); + + /// Returns a value indicating whether two instances are not equivalent. + public static bool operator !=(McpPlanPackageTransport left, McpPlanPackageTransport right) => !(left == right); + + /// + public override bool Equals(object? obj) => obj is McpPlanPackageTransport other && Equals(other); + + /// + public bool Equals(McpPlanPackageTransport 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 McpPlanPackageTransport Read(ref Utf8JsonReader reader, Type typeToConvert, JsonSerializerOptions options) + { + return new(GeneratedStringEnumJson.ReadValue(ref reader, typeToConvert)); + } + + /// + public override void Write(Utf8JsonWriter writer, McpPlanPackageTransport value, JsonSerializerOptions options) + { + GeneratedStringEnumJson.WriteValue(writer, value.Value, typeof(McpPlanPackageTransport)); + } + } +} + + +/// Transport exposed by a remote endpoint. +[Experimental(Diagnostics.Experimental)] +[JsonConverter(typeof(Converter))] +[DebuggerDisplay("{Value,nq}")] +public readonly struct McpPlanRemoteTransport : IEquatable +{ + private readonly string? _value; + + /// Initializes a new instance of the struct. + /// The value to associate with this . + [JsonConstructor] + public McpPlanRemoteTransport(string value) + { + ArgumentException.ThrowIfNullOrWhiteSpace(value); + _value = value; + } + + /// Gets the value associated with this . + public string Value => _value ?? string.Empty; + + /// An HTTP endpoint. + public static McpPlanRemoteTransport Http { get; } = new("http"); + + /// A streamable HTTP endpoint. + public static McpPlanRemoteTransport StreamableHttp { get; } = new("streamable-http"); + + /// A server-sent events endpoint. + public static McpPlanRemoteTransport Sse { get; } = new("sse"); + + /// Returns a value indicating whether two instances are equivalent. + public static bool operator ==(McpPlanRemoteTransport left, McpPlanRemoteTransport right) => left.Equals(right); + + /// Returns a value indicating whether two instances are not equivalent. + public static bool operator !=(McpPlanRemoteTransport left, McpPlanRemoteTransport right) => !(left == right); + + /// + public override bool Equals(object? obj) => obj is McpPlanRemoteTransport other && Equals(other); + + /// + public bool Equals(McpPlanRemoteTransport 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 McpPlanRemoteTransport Read(ref Utf8JsonReader reader, Type typeToConvert, JsonSerializerOptions options) + { + return new(GeneratedStringEnumJson.ReadValue(ref reader, typeToConvert)); + } + + /// + public override void Write(Utf8JsonWriter writer, McpPlanRemoteTransport value, JsonSerializerOptions options) + { + GeneratedStringEnumJson.WriteValue(writer, value.Value, typeof(McpPlanRemoteTransport)); + } + } +} + + +/// Why capability and protocol-version negotiation refused a caller. +[Experimental(Diagnostics.Experimental)] +[JsonConverter(typeof(Converter))] +[DebuggerDisplay("{Value,nq}")] +public readonly struct CatalogNegotiationRefusedReason : IEquatable +{ + private readonly string? _value; + + /// Initializes a new instance of the struct. + /// The value to associate with this . + [JsonConstructor] + public CatalogNegotiationRefusedReason(string value) + { + ArgumentException.ThrowIfNullOrWhiteSpace(value); + _value = value; + } + + /// Gets the value associated with this . + public string Value => _value ?? string.Empty; + + /// The caller's protocol version is below the lowest this runtime serves. + public static CatalogNegotiationRefusedReason UnsupportedProtocolVersion { get; } = new("unsupported-protocol-version"); + + /// The caller requires at least one capability this runtime cannot honour. + public static CatalogNegotiationRefusedReason UnsupportedCapability { get; } = new("unsupported-capability"); + + /// Returns a value indicating whether two instances are equivalent. + public static bool operator ==(CatalogNegotiationRefusedReason left, CatalogNegotiationRefusedReason right) => left.Equals(right); + + /// Returns a value indicating whether two instances are not equivalent. + public static bool operator !=(CatalogNegotiationRefusedReason left, CatalogNegotiationRefusedReason right) => !(left == right); + + /// + public override bool Equals(object? obj) => obj is CatalogNegotiationRefusedReason other && Equals(other); + + /// + public bool Equals(CatalogNegotiationRefusedReason 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 CatalogNegotiationRefusedReason Read(ref Utf8JsonReader reader, Type typeToConvert, JsonSerializerOptions options) + { + return new(GeneratedStringEnumJson.ReadValue(ref reader, typeToConvert)); + } + + /// + public override void Write(Utf8JsonWriter writer, CatalogNegotiationRefusedReason value, JsonSerializerOptions options) + { + GeneratedStringEnumJson.WriteValue(writer, value.Value, typeof(CatalogNegotiationRefusedReason)); + } + } +} + + +/// Which kind of opaque handle was presented. +[Experimental(Diagnostics.Experimental)] +[JsonConverter(typeof(Converter))] +[DebuggerDisplay("{Value,nq}")] +public readonly struct CatalogHandleType : IEquatable +{ + private readonly string? _value; + + /// Initializes a new instance of the struct. + /// The value to associate with this . + [JsonConstructor] + public CatalogHandleType(string value) + { + ArgumentException.ThrowIfNullOrWhiteSpace(value); + _value = value; + } + + /// Gets the value associated with this . + public string Value => _value ?? string.Empty; + + /// A search candidate handle. + public static CatalogHandleType Candidate { get; } = new("candidate"); + + /// An install plan handle. + public static CatalogHandleType Plan { get; } = new("plan"); + + /// Returns a value indicating whether two instances are equivalent. + public static bool operator ==(CatalogHandleType left, CatalogHandleType right) => left.Equals(right); + + /// Returns a value indicating whether two instances are not equivalent. + public static bool operator !=(CatalogHandleType left, CatalogHandleType right) => !(left == right); + + /// + public override bool Equals(object? obj) => obj is CatalogHandleType other && Equals(other); + + /// + public bool Equals(CatalogHandleType 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 CatalogHandleType Read(ref Utf8JsonReader reader, Type typeToConvert, JsonSerializerOptions options) + { + return new(GeneratedStringEnumJson.ReadValue(ref reader, typeToConvert)); + } + + /// + public override void Write(Utf8JsonWriter writer, CatalogHandleType value, JsonSerializerOptions options) + { + GeneratedStringEnumJson.WriteValue(writer, value.Value, typeof(CatalogHandleType)); + } + } +} + + +/// Why a presented handle was rejected. +[Experimental(Diagnostics.Experimental)] +[JsonConverter(typeof(Converter))] +[DebuggerDisplay("{Value,nq}")] +public readonly struct CatalogHandleRejectionReason : IEquatable +{ + private readonly string? _value; + + /// Initializes a new instance of the struct. + /// The value to associate with this . + [JsonConstructor] + public CatalogHandleRejectionReason(string value) + { + ArgumentException.ThrowIfNullOrWhiteSpace(value); + _value = value; + } + + /// Gets the value associated with this . + public string Value => _value ?? string.Empty; + + /// The handle is unparseable, unknown, or was issued for a different operation. + public static CatalogHandleRejectionReason Invalid { get; } = new("invalid"); + + /// The handle's time to live has elapsed. + public static CatalogHandleRejectionReason Stale { get; } = new("stale"); + + /// The handle has already been used, and handles are single-use. + public static CatalogHandleRejectionReason Replayed { get; } = new("replayed"); + + /// The handle was issued by a different runtime instance. + public static CatalogHandleRejectionReason Foreign { get; } = new("foreign"); + + /// Returns a value indicating whether two instances are equivalent. + public static bool operator ==(CatalogHandleRejectionReason left, CatalogHandleRejectionReason right) => left.Equals(right); + + /// Returns a value indicating whether two instances are not equivalent. + public static bool operator !=(CatalogHandleRejectionReason left, CatalogHandleRejectionReason right) => !(left == right); + + /// + public override bool Equals(object? obj) => obj is CatalogHandleRejectionReason other && Equals(other); + + /// + public bool Equals(CatalogHandleRejectionReason 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 CatalogHandleRejectionReason Read(ref Utf8JsonReader reader, Type typeToConvert, JsonSerializerOptions options) + { + return new(GeneratedStringEnumJson.ReadValue(ref reader, typeToConvert)); + } + + /// + public override void Write(Utf8JsonWriter writer, CatalogHandleRejectionReason value, JsonSerializerOptions options) + { + GeneratedStringEnumJson.WriteValue(writer, value.Value, typeof(CatalogHandleRejectionReason)); + } + } +} + + +/// Which request field was rejected before any work was done. +[Experimental(Diagnostics.Experimental)] +[JsonConverter(typeof(Converter))] +[DebuggerDisplay("{Value,nq}")] +public readonly struct CatalogInvalidRequestField : IEquatable +{ + private readonly string? _value; + + /// Initializes a new instance of the struct. + /// The value to associate with this . + [JsonConstructor] + public CatalogInvalidRequestField(string value) + { + ArgumentException.ThrowIfNullOrWhiteSpace(value); + _value = value; + } + + /// Gets the value associated with this . + public string Value => _value ?? string.Empty; + + /// The search query was empty or longer than permitted. + public static CatalogInvalidRequestField Query { get; } = new("query"); + + /// The requested result count fell outside its permitted range. + public static CatalogInvalidRequestField Limit { get; } = new("limit"); + + /// The requested candidate kinds were empty or contained a duplicate. + public static CatalogInvalidRequestField Kinds { get; } = new("kinds"); + + /// The negotiation block was missing or malformed. + public static CatalogInvalidRequestField Contract { get; } = new("contract"); + + /// The plan source was missing or malformed. + public static CatalogInvalidRequestField Source { get; } = new("source"); + + /// The supplied card was missing its media type, URL, or data. + public static CatalogInvalidRequestField Card { get; } = new("card"); + + /// The requested configuration scope is not one this runtime writes. + public static CatalogInvalidRequestField Scope { get; } = new("scope"); + + /// Returns a value indicating whether two instances are equivalent. + public static bool operator ==(CatalogInvalidRequestField left, CatalogInvalidRequestField right) => left.Equals(right); + + /// Returns a value indicating whether two instances are not equivalent. + public static bool operator !=(CatalogInvalidRequestField left, CatalogInvalidRequestField right) => !(left == right); + + /// + public override bool Equals(object? obj) => obj is CatalogInvalidRequestField other && Equals(other); + + /// + public bool Equals(CatalogInvalidRequestField 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 CatalogInvalidRequestField Read(ref Utf8JsonReader reader, Type typeToConvert, JsonSerializerOptions options) + { + return new(GeneratedStringEnumJson.ReadValue(ref reader, typeToConvert)); + } + + /// + public override void Write(Utf8JsonWriter writer, CatalogInvalidRequestField value, JsonSerializerOptions options) + { + GeneratedStringEnumJson.WriteValue(writer, value.Value, typeof(CatalogInvalidRequestField)); + } + } +} + + +/// Why the catalog authority did not accept the caller's identity. +[Experimental(Diagnostics.Experimental)] +[JsonConverter(typeof(Converter))] +[DebuggerDisplay("{Value,nq}")] +public readonly struct CatalogAuthenticationRequiredReason : IEquatable +{ + private readonly string? _value; + + /// Initializes a new instance of the struct. + /// The value to associate with this . + [JsonConstructor] + public CatalogAuthenticationRequiredReason(string value) + { + ArgumentException.ThrowIfNullOrWhiteSpace(value); + _value = value; + } + + /// Gets the value associated with this . + public string Value => _value ?? string.Empty; + + /// No credential was presented, so there is nothing to refresh and the caller must sign in. + public static CatalogAuthenticationRequiredReason NoCredential { get; } = new("no-credential"); + + /// A credential was presented and its lifetime has elapsed. A silent refresh is worth attempting before prompting anyone. + public static CatalogAuthenticationRequiredReason CredentialExpired { get; } = new("credential-expired"); + + /// A credential was presented and the authority refused it, for example because it was revoked, malformed, or issued for another audience. Refreshing the same rejected credential is not useful; the caller must sign in again. + public static CatalogAuthenticationRequiredReason CredentialRejected { get; } = new("credential-rejected"); + + /// Returns a value indicating whether two instances are equivalent. + public static bool operator ==(CatalogAuthenticationRequiredReason left, CatalogAuthenticationRequiredReason right) => left.Equals(right); + + /// Returns a value indicating whether two instances are not equivalent. + public static bool operator !=(CatalogAuthenticationRequiredReason left, CatalogAuthenticationRequiredReason right) => !(left == right); + + /// + public override bool Equals(object? obj) => obj is CatalogAuthenticationRequiredReason other && Equals(other); + + /// + public bool Equals(CatalogAuthenticationRequiredReason 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 CatalogAuthenticationRequiredReason Read(ref Utf8JsonReader reader, Type typeToConvert, JsonSerializerOptions options) + { + return new(GeneratedStringEnumJson.ReadValue(ref reader, typeToConvert)); + } + + /// + public override void Write(Utf8JsonWriter writer, CatalogAuthenticationRequiredReason value, JsonSerializerOptions options) + { + GeneratedStringEnumJson.WriteValue(writer, value.Value, typeof(CatalogAuthenticationRequiredReason)); + } + } +} + + +/// Categorised network failure, low cardinality so it can be aggregated without carrying a URL. +[Experimental(Diagnostics.Experimental)] +[JsonConverter(typeof(Converter))] +[DebuggerDisplay("{Value,nq}")] +public readonly struct CatalogNetworkFailureReason : IEquatable +{ + private readonly string? _value; + + /// Initializes a new instance of the struct. + /// The value to associate with this . + [JsonConstructor] + public CatalogNetworkFailureReason(string value) + { + ArgumentException.ThrowIfNullOrWhiteSpace(value); + _value = value; + } + + /// Gets the value associated with this . + public string Value => _value ?? string.Empty; + + /// No network is available, so nothing was attempted. + public static CatalogNetworkFailureReason Offline { get; } = new("offline"); + + /// The authority's name could not be resolved. + public static CatalogNetworkFailureReason Dns { get; } = new("dns"); + + /// The request exceeded its time budget. + public static CatalogNetworkFailureReason Timeout { get; } = new("timeout"); + + /// The TLS handshake or certificate validation failed. + public static CatalogNetworkFailureReason Tls { get; } = new("tls"); + + /// The connection was refused or reset. + public static CatalogNetworkFailureReason ConnectionRefused { get; } = new("connection-refused"); + + /// The authority returned a status the runtime treats as a failure. + public static CatalogNetworkFailureReason HttpStatus { get; } = new("http-status"); + + /// The response exceeded the permitted size. + public static CatalogNetworkFailureReason ResponseTooLarge { get; } = new("response-too-large"); + + /// A redirect was refused by the runtime's redirect policy. + public static CatalogNetworkFailureReason RedirectRejected { get; } = new("redirect-rejected"); + + /// Returns a value indicating whether two instances are equivalent. + public static bool operator ==(CatalogNetworkFailureReason left, CatalogNetworkFailureReason right) => left.Equals(right); + + /// Returns a value indicating whether two instances are not equivalent. + public static bool operator !=(CatalogNetworkFailureReason left, CatalogNetworkFailureReason right) => !(left == right); + + /// + public override bool Equals(object? obj) => obj is CatalogNetworkFailureReason other && Equals(other); + + /// + public bool Equals(CatalogNetworkFailureReason 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 CatalogNetworkFailureReason Read(ref Utf8JsonReader reader, Type typeToConvert, JsonSerializerOptions options) + { + return new(GeneratedStringEnumJson.ReadValue(ref reader, typeToConvert)); + } + + /// + public override void Write(Utf8JsonWriter writer, CatalogNetworkFailureReason value, JsonSerializerOptions options) + { + GeneratedStringEnumJson.WriteValue(writer, value.Value, typeof(CatalogNetworkFailureReason)); + } + } +} + + +/// Which hardened-fetch control refused a retrieval. +[Experimental(Diagnostics.Experimental)] +[JsonConverter(typeof(Converter))] +[DebuggerDisplay("{Value,nq}")] +public readonly struct CatalogUnsafeRetrievalReason : IEquatable +{ + private readonly string? _value; + + /// Initializes a new instance of the struct. + /// The value to associate with this . + [JsonConstructor] + public CatalogUnsafeRetrievalReason(string value) + { + ArgumentException.ThrowIfNullOrWhiteSpace(value); + _value = value; + } + + /// Gets the value associated with this . + public string Value => _value ?? string.Empty; + + /// The URL used a scheme the runtime refuses to fetch. + public static CatalogUnsafeRetrievalReason BlockedScheme { get; } = new("blocked-scheme"); + + /// The URL embedded credentials. + public static CatalogUnsafeRetrievalReason CredentialsInUrl { get; } = new("credentials-in-url"); + + /// The URL resolved to a loopback, private, link-local, or cloud metadata address. + public static CatalogUnsafeRetrievalReason BlockedAddress { get; } = new("blocked-address"); + + /// A redirect target resolved to a blocked address. + public static CatalogUnsafeRetrievalReason RedirectToBlockedAddress { get; } = new("redirect-to-blocked-address"); + + /// The configured proxy policy refused the request. + public static CatalogUnsafeRetrievalReason ProxyRejected { get; } = new("proxy-rejected"); + + /// The authority is not permitted for card retrieval. + public static CatalogUnsafeRetrievalReason HostNotPermitted { get; } = new("host-not-permitted"); + + /// Returns a value indicating whether two instances are equivalent. + public static bool operator ==(CatalogUnsafeRetrievalReason left, CatalogUnsafeRetrievalReason right) => left.Equals(right); + + /// Returns a value indicating whether two instances are not equivalent. + public static bool operator !=(CatalogUnsafeRetrievalReason left, CatalogUnsafeRetrievalReason right) => !(left == right); + + /// + public override bool Equals(object? obj) => obj is CatalogUnsafeRetrievalReason other && Equals(other); + + /// + public bool Equals(CatalogUnsafeRetrievalReason 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 CatalogUnsafeRetrievalReason Read(ref Utf8JsonReader reader, Type typeToConvert, JsonSerializerOptions options) + { + return new(GeneratedStringEnumJson.ReadValue(ref reader, typeToConvert)); + } + + /// + public override void Write(Utf8JsonWriter writer, CatalogUnsafeRetrievalReason value, JsonSerializerOptions options) + { + GeneratedStringEnumJson.WriteValue(writer, value.Value, typeof(CatalogUnsafeRetrievalReason)); + } + } +} + + +/// Media type a catalog card is interpreted as. +[Experimental(Diagnostics.Experimental)] +[JsonConverter(typeof(Converter))] +[DebuggerDisplay("{Value,nq}")] +public readonly struct CatalogMediaType : IEquatable +{ + private readonly string? _value; + + /// Initializes a new instance of the struct. + /// The value to associate with this . + [JsonConstructor] + public CatalogMediaType(string value) + { + ArgumentException.ThrowIfNullOrWhiteSpace(value); + _value = value; + } + + /// Gets the value associated with this . + public string Value => _value ?? string.Empty; + + /// The current MCP server card media type. + public static CatalogMediaType ApplicationMcpServerCardJson { get; } = new("application/mcp-server-card+json"); + + /// The legacy MCP server card media type, accepted for compatibility. + public static CatalogMediaType ApplicationMcpServerJson { get; } = new("application/mcp-server+json"); + + /// An AI skill card. Representable and searchable, but typed non-installable. + public static CatalogMediaType ApplicationAiSkill { get; } = new("application/ai-skill"); + + /// Returns a value indicating whether two instances are equivalent. + public static bool operator ==(CatalogMediaType left, CatalogMediaType right) => left.Equals(right); + + /// Returns a value indicating whether two instances are not equivalent. + public static bool operator !=(CatalogMediaType left, CatalogMediaType right) => !(left == right); + + /// + public override bool Equals(object? obj) => obj is CatalogMediaType other && Equals(other); + + /// + public bool Equals(CatalogMediaType 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 CatalogMediaType Read(ref Utf8JsonReader reader, Type typeToConvert, JsonSerializerOptions options) + { + return new(GeneratedStringEnumJson.ReadValue(ref reader, typeToConvert)); + } + + /// + public override void Write(Utf8JsonWriter writer, CatalogMediaType value, JsonSerializerOptions options) + { + GeneratedStringEnumJson.WriteValue(writer, value.Value, typeof(CatalogMediaType)); + } + } +} + + +/// How a card failed validation. +[Experimental(Diagnostics.Experimental)] +[JsonConverter(typeof(Converter))] +[DebuggerDisplay("{Value,nq}")] +public readonly struct CatalogMalformedCardReason : IEquatable +{ + private readonly string? _value; + + /// Initializes a new instance of the struct. + /// The value to associate with this . + [JsonConstructor] + public CatalogMalformedCardReason(string value) + { + ArgumentException.ThrowIfNullOrWhiteSpace(value); + _value = value; + } + + /// Gets the value associated with this . + public string Value => _value ?? string.Empty; + + /// The document is not well-formed JSON. + public static CatalogMalformedCardReason InvalidJson { get; } = new("invalid-json"); + + /// The document does not satisfy its media type's schema. + public static CatalogMalformedCardReason SchemaViolation { get; } = new("schema-violation"); + + /// The declared media type is not one this runtime understands. + public static CatalogMalformedCardReason UnsupportedMediaType { get; } = new("unsupported-media-type"); + + /// A field the media type requires is absent. + public static CatalogMalformedCardReason MissingRequiredField { get; } = new("missing-required-field"); + + /// The document exceeded the permitted size. + public static CatalogMalformedCardReason SizeLimitExceeded { get; } = new("size-limit-exceeded"); + + /// Returns a value indicating whether two instances are equivalent. + public static bool operator ==(CatalogMalformedCardReason left, CatalogMalformedCardReason right) => left.Equals(right); + + /// Returns a value indicating whether two instances are not equivalent. + public static bool operator !=(CatalogMalformedCardReason left, CatalogMalformedCardReason right) => !(left == right); + + /// + public override bool Equals(object? obj) => obj is CatalogMalformedCardReason other && Equals(other); + + /// + public bool Equals(CatalogMalformedCardReason 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 CatalogMalformedCardReason Read(ref Utf8JsonReader reader, Type typeToConvert, JsonSerializerOptions options) + { + return new(GeneratedStringEnumJson.ReadValue(ref reader, typeToConvert)); + } + + /// + public override void Write(Utf8JsonWriter writer, CatalogMalformedCardReason value, JsonSerializerOptions options) + { + GeneratedStringEnumJson.WriteValue(writer, value.Value, typeof(CatalogMalformedCardReason)); + } + } +} + + +/// Which wire-contract rule an upstream response broke. +[Experimental(Diagnostics.Experimental)] +[JsonConverter(typeof(Converter))] +[DebuggerDisplay("{Value,nq}")] +public readonly struct CatalogContractViolationReason : IEquatable +{ + private readonly string? _value; + + /// Initializes a new instance of the struct. + /// The value to associate with this . + [JsonConstructor] + public CatalogContractViolationReason(string value) + { + ArgumentException.ThrowIfNullOrWhiteSpace(value); + _value = value; + } + + /// Gets the value associated with this . + public string Value => _value ?? string.Empty; + + /// A result carried both a URL and embedded data, when exactly one is permitted. + public static CatalogContractViolationReason BothUrlAndData { get; } = new("both-url-and-data"); + + /// A result carried neither a URL nor embedded data, when exactly one is required. + public static CatalogContractViolationReason NeitherUrlNorData { get; } = new("neither-url-nor-data"); + + /// Two results claimed the same normalised identity. + public static CatalogContractViolationReason DuplicateIdentity { get; } = new("duplicate-identity"); + + /// A result declared no media type, or one this contract does not model. + public static CatalogContractViolationReason UnknownMediaType { get; } = new("unknown-media-type"); + + /// Returns a value indicating whether two instances are equivalent. + public static bool operator ==(CatalogContractViolationReason left, CatalogContractViolationReason right) => left.Equals(right); + + /// Returns a value indicating whether two instances are not equivalent. + public static bool operator !=(CatalogContractViolationReason left, CatalogContractViolationReason right) => !(left == right); + + /// + public override bool Equals(object? obj) => obj is CatalogContractViolationReason other && Equals(other); + + /// + public bool Equals(CatalogContractViolationReason 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 CatalogContractViolationReason Read(ref Utf8JsonReader reader, Type typeToConvert, JsonSerializerOptions options) + { + return new(GeneratedStringEnumJson.ReadValue(ref reader, typeToConvert)); + } + + /// + public override void Write(Utf8JsonWriter writer, CatalogContractViolationReason value, JsonSerializerOptions options) + { + GeneratedStringEnumJson.WriteValue(writer, value.Value, typeof(CatalogContractViolationReason)); + } + } +} + + +/// Why no usable transport could be offered. +[Experimental(Diagnostics.Experimental)] +[JsonConverter(typeof(Converter))] +[DebuggerDisplay("{Value,nq}")] +public readonly struct CatalogUnavailableTransportReason : IEquatable +{ + private readonly string? _value; + + /// Initializes a new instance of the struct. + /// The value to associate with this . + [JsonConstructor] + public CatalogUnavailableTransportReason(string value) + { + ArgumentException.ThrowIfNullOrWhiteSpace(value); + _value = value; + } + + /// Gets the value associated with this . + public string Value => _value ?? string.Empty; + + /// The card advertises no transport this runtime can use. + public static CatalogUnavailableTransportReason NoEligibleTransport { get; } = new("no-eligible-transport"); + + /// Every advertised transport is of a kind this runtime does not implement. + public static CatalogUnavailableTransportReason TransportNotSupported { get; } = new("transport-not-supported"); + + /// Eligible remotes could not be enumerated, so no explicit choice can be offered. + public static CatalogUnavailableTransportReason RemoteEnumerationUnavailable { get; } = new("remote-enumeration-unavailable"); + + /// Returns a value indicating whether two instances are equivalent. + public static bool operator ==(CatalogUnavailableTransportReason left, CatalogUnavailableTransportReason right) => left.Equals(right); + + /// Returns a value indicating whether two instances are not equivalent. + public static bool operator !=(CatalogUnavailableTransportReason left, CatalogUnavailableTransportReason right) => !(left == right); + + /// + public override bool Equals(object? obj) => obj is CatalogUnavailableTransportReason other && Equals(other); + + /// + public bool Equals(CatalogUnavailableTransportReason 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 CatalogUnavailableTransportReason Read(ref Utf8JsonReader reader, Type typeToConvert, JsonSerializerOptions options) + { + return new(GeneratedStringEnumJson.ReadValue(ref reader, typeToConvert)); + } + + /// + public override void Write(Utf8JsonWriter writer, CatalogUnavailableTransportReason value, JsonSerializerOptions options) + { + GeneratedStringEnumJson.WriteValue(writer, value.Value, typeof(CatalogUnavailableTransportReason)); + } + } +} + + +/// Why a discoverable candidate cannot be installed. +[Experimental(Diagnostics.Experimental)] +[JsonConverter(typeof(Converter))] +[DebuggerDisplay("{Value,nq}")] +public readonly struct CatalogNotInstallableReason : IEquatable +{ + private readonly string? _value; + + /// Initializes a new instance of the struct. + /// The value to associate with this . + [JsonConstructor] + public CatalogNotInstallableReason(string value) + { + ArgumentException.ThrowIfNullOrWhiteSpace(value); + _value = value; + } + + /// Gets the value associated with this . + public string Value => _value ?? string.Empty; + + /// This kind of resource is not installable through this surface. + public static CatalogNotInstallableReason KindNotInstallable { get; } = new("kind-not-installable"); + + /// AI skills are discoverable but have no typed importer in this phase. + public static CatalogNotInstallableReason AiSkillNotInstallable { get; } = new("ai-skill-not-installable"); + + /// Policy forbids installing this candidate. + public static CatalogNotInstallableReason PolicyForbids { get; } = new("policy-forbids"); + + /// Returns a value indicating whether two instances are equivalent. + public static bool operator ==(CatalogNotInstallableReason left, CatalogNotInstallableReason right) => left.Equals(right); + + /// Returns a value indicating whether two instances are not equivalent. + public static bool operator !=(CatalogNotInstallableReason left, CatalogNotInstallableReason right) => !(left == right); + + /// + public override bool Equals(object? obj) => obj is CatalogNotInstallableReason other && Equals(other); + + /// + public bool Equals(CatalogNotInstallableReason 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 CatalogNotInstallableReason Read(ref Utf8JsonReader reader, Type typeToConvert, JsonSerializerOptions options) + { + return new(GeneratedStringEnumJson.ReadValue(ref reader, typeToConvert)); + } + + /// + public override void Write(Utf8JsonWriter writer, CatalogNotInstallableReason value, JsonSerializerOptions options) + { + GeneratedStringEnumJson.WriteValue(writer, value.Value, typeof(CatalogNotInstallableReason)); + } + } +} + + +/// Why a catalog operation is not available on this runtime. +[Experimental(Diagnostics.Experimental)] +[JsonConverter(typeof(Converter))] +[DebuggerDisplay("{Value,nq}")] +public readonly struct CatalogUnavailableReason : IEquatable +{ + private readonly string? _value; + + /// Initializes a new instance of the struct. + /// The value to associate with this . + [JsonConstructor] + public CatalogUnavailableReason(string value) + { + ArgumentException.ThrowIfNullOrWhiteSpace(value); + _value = value; + } + + /// Gets the value associated with this . + public string Value => _value ?? string.Empty; + + /// Bounded search is not wired up on this runtime build. + public static CatalogUnavailableReason SearchUnavailable { get; } = new("search-unavailable"); + + /// Install planning is not wired up on this runtime build. + public static CatalogUnavailableReason PlanningUnavailable { get; } = new("planning-unavailable"); + + /// No catalog authority is configured for this runtime. + public static CatalogUnavailableReason AuthorityNotConfigured { get; } = new("authority-not-configured"); + + /// The surface is disabled by policy on this runtime. + public static CatalogUnavailableReason DisabledByPolicy { get; } = new("disabled-by-policy"); + + /// Returns a value indicating whether two instances are equivalent. + public static bool operator ==(CatalogUnavailableReason left, CatalogUnavailableReason right) => left.Equals(right); + + /// Returns a value indicating whether two instances are not equivalent. + public static bool operator !=(CatalogUnavailableReason left, CatalogUnavailableReason right) => !(left == right); + + /// + public override bool Equals(object? obj) => obj is CatalogUnavailableReason other && Equals(other); + + /// + public bool Equals(CatalogUnavailableReason 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 CatalogUnavailableReason Read(ref Utf8JsonReader reader, Type typeToConvert, JsonSerializerOptions options) + { + return new(GeneratedStringEnumJson.ReadValue(ref reader, typeToConvert)); + } + + /// + public override void Write(Utf8JsonWriter writer, CatalogUnavailableReason value, JsonSerializerOptions options) + { + GeneratedStringEnumJson.WriteValue(writer, value.Value, typeof(CatalogUnavailableReason)); + } + } +} + + +/// 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)); + } + } +} + + +/// Whether an MCP server candidate can be planned for installation. +[Experimental(Diagnostics.Experimental)] +[JsonConverter(typeof(Converter))] +[DebuggerDisplay("{Value,nq}")] +public readonly struct CatalogMcpServerInstallability : IEquatable +{ + private readonly string? _value; + + /// Initializes a new instance of the struct. + /// The value to associate with this . + [JsonConstructor] + public CatalogMcpServerInstallability(string value) + { + ArgumentException.ThrowIfNullOrWhiteSpace(value); + _value = value; + } + + /// Gets the value associated with this . + public string Value => _value ?? string.Empty; + + /// An install plan can be computed for this MCP server candidate. + public static CatalogMcpServerInstallability Installable { get; } = new("installable"); + + /// Policy forbids installing this MCP server candidate. + public static CatalogMcpServerInstallability NotInstallablePolicy { get; } = new("not-installable-policy"); + + /// Returns a value indicating whether two instances are equivalent. + public static bool operator ==(CatalogMcpServerInstallability left, CatalogMcpServerInstallability right) => left.Equals(right); + + /// Returns a value indicating whether two instances are not equivalent. + public static bool operator !=(CatalogMcpServerInstallability left, CatalogMcpServerInstallability right) => !(left == right); + + /// + public override bool Equals(object? obj) => obj is CatalogMcpServerInstallability other && Equals(other); + + /// + public bool Equals(CatalogMcpServerInstallability 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 CatalogMcpServerInstallability Read(ref Utf8JsonReader reader, Type typeToConvert, JsonSerializerOptions options) + { + return new(GeneratedStringEnumJson.ReadValue(ref reader, typeToConvert)); + } + + /// + public override void Write(Utf8JsonWriter writer, CatalogMcpServerInstallability value, JsonSerializerOptions options) + { + GeneratedStringEnumJson.WriteValue(writer, value.Value, typeof(CatalogMcpServerInstallability)); + } + } +} + + +/// What kind of resource a catalog candidate describes. +[Experimental(Diagnostics.Experimental)] +[JsonConverter(typeof(Converter))] +[DebuggerDisplay("{Value,nq}")] +public readonly struct CatalogCandidateKind : IEquatable +{ + private readonly string? _value; + + /// Initializes a new instance of the struct. + /// The value to associate with this . + [JsonConstructor] + public CatalogCandidateKind(string value) + { + ArgumentException.ThrowIfNullOrWhiteSpace(value); + _value = value; + } + + /// Gets the value associated with this . + public string Value => _value ?? string.Empty; + + /// An MCP server, which can be planned for installation. + public static CatalogCandidateKind McpServer { get; } = new("mcp-server"); + + /// An AI skill, which is discoverable but not installable through this surface. + public static CatalogCandidateKind AiSkill { get; } = new("ai-skill"); + + /// Returns a value indicating whether two instances are equivalent. + public static bool operator ==(CatalogCandidateKind left, CatalogCandidateKind right) => left.Equals(right); + + /// Returns a value indicating whether two instances are not equivalent. + public static bool operator !=(CatalogCandidateKind left, CatalogCandidateKind right) => !(left == right); + + /// + public override bool Equals(object? obj) => obj is CatalogCandidateKind other && Equals(other); + + /// + public bool Equals(CatalogCandidateKind 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 CatalogCandidateKind Read(ref Utf8JsonReader reader, Type typeToConvert, JsonSerializerOptions options) + { + return new(GeneratedStringEnumJson.ReadValue(ref reader, typeToConvert)); + } + + /// + public override void Write(Utf8JsonWriter writer, CatalogCandidateKind value, JsonSerializerOptions options) + { + GeneratedStringEnumJson.WriteValue(writer, value.Value, typeof(CatalogCandidateKind)); + } + } +} + + +/// 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)); + } + } +} + + +/// What a remote host says one of its sessions is doing right now. Deliberately coarse: this is what a host can report for EVERY session in a catalogue listing, without a client subscribing to each one. AHP's `SessionSummary.status` is the source today; `input-needed` covers both a permission prompt and an `ask_user` question, since the summary does not say which. +[Experimental(Diagnostics.Experimental)] +[JsonConverter(typeof(Converter))] +[DebuggerDisplay("{Value,nq}")] +public readonly struct RemoteSessionHostStatus : IEquatable +{ + private readonly string? _value; + + /// Initializes a new instance of the struct. + /// The value to associate with this . + [JsonConstructor] + public RemoteSessionHostStatus(string value) + { + ArgumentException.ThrowIfNullOrWhiteSpace(value); + _value = value; + } + + /// Gets the value associated with this . + public string Value => _value ?? string.Empty; + + /// No turn is running. + public static RemoteSessionHostStatus Idle { get; } = new("idle"); + + /// A turn is running. + public static RemoteSessionHostStatus Working { get; } = new("working"); + + /// The session is blocked on the user: a permission prompt or an `ask_user` question. + public static RemoteSessionHostStatus InputNeeded { get; } = new("input-needed"); + + /// The session ended its last turn in an error. + public static RemoteSessionHostStatus Error { get; } = new("error"); + + /// Returns a value indicating whether two instances are equivalent. + public static bool operator ==(RemoteSessionHostStatus left, RemoteSessionHostStatus right) => left.Equals(right); + + /// Returns a value indicating whether two instances are not equivalent. + public static bool operator !=(RemoteSessionHostStatus left, RemoteSessionHostStatus right) => !(left == right); + + /// + public override bool Equals(object? obj) => obj is RemoteSessionHostStatus other && Equals(other); + + /// + public bool Equals(RemoteSessionHostStatus 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 RemoteSessionHostStatus Read(ref Utf8JsonReader reader, Type typeToConvert, JsonSerializerOptions options) + { + return new(GeneratedStringEnumJson.ReadValue(ref reader, typeToConvert)); + } + + /// + public override void Write(Utf8JsonWriter writer, RemoteSessionHostStatus value, JsonSerializerOptions options) + { + GeneratedStringEnumJson.WriteValue(writer, value.Value, typeof(RemoteSessionHostStatus)); + } + } +} + + +/// 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"); - /// Describes a filesystem error. - [JsonPropertyName("error")] - public SessionFsError? Error { get; set; } + /// Headless `--server --managed-server` child spawned by a controller. + public static AgentRegistryLiveTargetEntryKind ManagedServer { get; } = new("managed-server"); - /// SQLite last_insert_rowid() value for INSERT. - [JsonPropertyName("lastInsertRowid")] - public long? LastInsertRowid { get; set; } + /// Returns a value indicating whether two instances are equivalent. + public static bool operator ==(AgentRegistryLiveTargetEntryKind left, AgentRegistryLiveTargetEntryKind right) => left.Equals(right); - /// 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 not equivalent. + public static bool operator !=(AgentRegistryLiveTargetEntryKind left, AgentRegistryLiveTargetEntryKind right) => !(left == right); - /// Number of rows affected (for INSERT/UPDATE/DELETE). - [JsonPropertyName("rowsAffected")] - public long RowsAffected { get; set; } -} + /// + public override bool Equals(object? obj) => obj is AgentRegistryLiveTargetEntryKind other && Equals(other); -/// SQL query, query type, and optional bind parameters for executing a SQLite query against the per-session database. -[Experimental(Diagnostics.Experimental)] -public sealed class SessionFsSqliteQueryRequest -{ - /// Optional named bind parameters. - [JsonPropertyName("params")] - public IDictionary? Params { get; set; } + /// + public bool Equals(AgentRegistryLiveTargetEntryKind other) => string.Equals(Value, other.Value, StringComparison.OrdinalIgnoreCase); - /// SQL query to execute. - [JsonPropertyName("query")] - public string Query { get; set; } = string.Empty; + /// + public override int GetHashCode() => StringComparer.OrdinalIgnoreCase.GetHashCode(Value); - /// 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 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 AgentRegistryLiveTargetEntryKind Read(ref Utf8JsonReader reader, Type typeToConvert, JsonSerializerOptions options) + { + return new(GeneratedStringEnumJson.ReadValue(ref reader, typeToConvert)); + } -/// 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; } + /// + public override void Write(Utf8JsonWriter writer, AgentRegistryLiveTargetEntryKind value, JsonSerializerOptions options) + { + GeneratedStringEnumJson.WriteValue(writer, value.Value, typeof(AgentRegistryLiveTargetEntryKind)); + } + } } -/// 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. +/// How the most recent turn ended (clean vs aborted). Lets the renderer distinguish done from done_cancelled. [Experimental(Diagnostics.Experimental)] -public sealed class CanvasProviderOpenResult +[JsonConverter(typeof(Converter))] +[DebuggerDisplay("{Value,nq}")] +public readonly struct AgentRegistryLiveTargetEntryLastTerminalEvent : 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 AgentRegistryLiveTargetEntryLastTerminalEvent(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; } -} + /// Last turn ended cleanly (model returned a final assistant message). + public static AgentRegistryLiveTargetEntryLastTerminalEvent TurnEnd { get; } = new("turn_end"); -/// Host context supplied by the runtime. -[Experimental(Diagnostics.Experimental)] -public sealed class CanvasHostContext -{ - /// Host capabilities. - [JsonPropertyName("capabilities")] - public CanvasHostContextCapabilities? Capabilities { get; set; } -} + /// Last turn was aborted (e.g. user interrupted). + public static AgentRegistryLiveTargetEntryLastTerminalEvent Abort { get; } = new("abort"); -/// 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; } -} + /// Returns a value indicating whether two instances are equivalent. + public static bool operator ==(AgentRegistryLiveTargetEntryLastTerminalEvent left, AgentRegistryLiveTargetEntryLastTerminalEvent right) => left.Equals(right); -/// 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; + /// Returns a value indicating whether two instances are not equivalent. + public static bool operator !=(AgentRegistryLiveTargetEntryLastTerminalEvent left, AgentRegistryLiveTargetEntryLastTerminalEvent right) => !(left == right); - /// Owning provider identifier. - [JsonPropertyName("extensionId")] - public string ExtensionId { get; set; } = string.Empty; + /// + public override bool Equals(object? obj) => obj is AgentRegistryLiveTargetEntryLastTerminalEvent other && Equals(other); - /// Host context supplied by the runtime. - [JsonPropertyName("host")] - public CanvasHostContext? Host { get; set; } + /// + public bool Equals(AgentRegistryLiveTargetEntryLastTerminalEvent other) => string.Equals(Value, other.Value, StringComparison.OrdinalIgnoreCase); - /// Canvas open input. - [JsonPropertyName("input")] - public JsonElement? Input { get; set; } + /// + public override int GetHashCode() => StringComparer.OrdinalIgnoreCase.GetHashCode(Value); - /// Stable caller-supplied 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 AgentRegistryLiveTargetEntryLastTerminalEvent 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, AgentRegistryLiveTargetEntryLastTerminalEvent value, JsonSerializerOptions options) + { + GeneratedStringEnumJson.WriteValue(writer, value.Value, typeof(AgentRegistryLiveTargetEntryLastTerminalEvent)); + } + } } -/// Canvas close parameters sent to the provider. + +/// Coarse lifecycle status of the foreground session. [Experimental(Diagnostics.Experimental)] -public sealed class CanvasProviderCloseRequest +[JsonConverter(typeof(Converter))] +[DebuggerDisplay("{Value,nq}")] +public readonly struct AgentRegistryLiveTargetEntryStatus : IEquatable { - /// Provider-local canvas identifier. - [JsonPropertyName("canvasId")] - public string CanvasId { get; set; } = string.Empty; + private readonly string? _value; - /// Owning provider identifier. - [JsonPropertyName("extensionId")] - public string ExtensionId { get; set; } = string.Empty; + /// Initializes a new instance of the struct. + /// The value to associate with this . + [JsonConstructor] + public AgentRegistryLiveTargetEntryStatus(string value) + { + ArgumentException.ThrowIfNullOrWhiteSpace(value); + _value = value; + } - /// Host context supplied by the runtime. - [JsonPropertyName("host")] - public CanvasHostContext? Host { get; set; } + /// Gets the value associated with this . + public string Value => _value ?? string.Empty; - /// Canvas instance identifier. - [JsonPropertyName("instanceId")] - public string InstanceId { get; set; } = string.Empty; + /// Session is actively processing a turn. + public static AgentRegistryLiveTargetEntryStatus Working { get; } = new("working"); - /// Session context supplied by the runtime. - [JsonPropertyName("session")] - public CanvasSessionContext? Session { get; set; } + /// Session is idle, waiting for input. + public static AgentRegistryLiveTargetEntryStatus Waiting { get; } = new("waiting"); - /// Target session identifier. - [JsonPropertyName("sessionId")] - public string SessionId { get; set; } = string.Empty; -} + /// Last turn completed successfully. + public static AgentRegistryLiveTargetEntryStatus Done { get; } = new("done"); -/// 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; + /// Session needs user attention (see attentionKind for the specific reason). + public static AgentRegistryLiveTargetEntryStatus Attention { get; } = new("attention"); - /// 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 ==(AgentRegistryLiveTargetEntryStatus left, AgentRegistryLiveTargetEntryStatus 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 !=(AgentRegistryLiveTargetEntryStatus left, AgentRegistryLiveTargetEntryStatus right) => !(left == right); - /// Host context supplied by the runtime. - [JsonPropertyName("host")] - public CanvasHostContext? Host { get; set; } + /// + public override bool Equals(object? obj) => obj is AgentRegistryLiveTargetEntryStatus other && Equals(other); - /// Action input. - [JsonPropertyName("input")] - public JsonElement? Input { get; set; } + /// + public bool Equals(AgentRegistryLiveTargetEntryStatus other) => string.Equals(Value, other.Value, StringComparison.OrdinalIgnoreCase); - /// 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 AgentRegistryLiveTargetEntryStatus Read(ref Utf8JsonReader reader, Type typeToConvert, JsonSerializerOptions options) + { + return new(GeneratedStringEnumJson.ReadValue(ref reader, typeToConvert)); + } -/// 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 -{ + /// + public override void Write(Utf8JsonWriter writer, AgentRegistryLiveTargetEntryStatus value, JsonSerializerOptions options) + { + GeneratedStringEnumJson.WriteValue(writer, value.Value, typeof(AgentRegistryLiveTargetEntryStatus)); + } + } } -/// The head of an outbound model-layer HTTP request. + +/// Categorized reason for log-open failure. [Experimental(Diagnostics.Experimental)] -public sealed class LlmInferenceHttpRequestStartRequest +[JsonConverter(typeof(Converter))] +[DebuggerDisplay("{Value,nq}")] +public readonly struct AgentRegistryLogCaptureOpenErrorReason : IEquatable { - /// 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; } + private readonly string? _value; - /// 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; } + /// Initializes a new instance of the struct. + /// The value to associate with this . + [JsonConstructor] + public AgentRegistryLogCaptureOpenErrorReason(string value) + { + ArgumentException.ThrowIfNullOrWhiteSpace(value); + _value = value; + } - /// Gets or sets the headers value. - [JsonPropertyName("headers")] - public IDictionary> Headers { get => field ??= new Dictionary>(); set; } + /// Gets the value associated with this . + public string Value => _value ?? string.Empty; - /// 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; } + /// Filesystem permission denied opening the log file. + public static AgentRegistryLogCaptureOpenErrorReason Permission { get; } = new("permission"); - /// HTTP method, e.g. GET, POST. - [JsonPropertyName("method")] - public string Method { get; set; } = string.Empty; + /// No space left on device. + public static AgentRegistryLogCaptureOpenErrorReason DiskFull { get; } = new("disk_full"); - /// 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; } + /// Other / uncategorized open failure. + public static AgentRegistryLogCaptureOpenErrorReason Other { get; } = new("other"); - /// 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; + /// Returns a value indicating whether two instances are equivalent. + public static bool operator ==(AgentRegistryLogCaptureOpenErrorReason left, AgentRegistryLogCaptureOpenErrorReason right) => left.Equals(right); - /// 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; } + /// Returns a value indicating whether two instances are not equivalent. + public static bool operator !=(AgentRegistryLogCaptureOpenErrorReason left, AgentRegistryLogCaptureOpenErrorReason right) => !(left == right); - /// 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; } + /// + public override bool Equals(object? obj) => obj is AgentRegistryLogCaptureOpenErrorReason other && Equals(other); - /// Absolute request URL. - [JsonPropertyName("url")] - public string Url { get; set; } = string.Empty; -} + /// + public bool Equals(AgentRegistryLogCaptureOpenErrorReason other) => string.Equals(Value, other.Value, StringComparison.OrdinalIgnoreCase); -/// Acknowledgement. The SDK is free to ignore the ack and treat chunk delivery as fire-and-forget. -[Experimental(Diagnostics.Experimental)] -public sealed class LlmInferenceHttpRequestChunkResult -{ + /// + 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 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)); + } + } } -/// A request body chunk or cancellation signal. + +/// Which parameter field was invalid. Omitted when the rejection is not field-specific. [Experimental(Diagnostics.Experimental)] -public sealed class LlmInferenceHttpRequestChunkRequest +[JsonConverter(typeof(Converter))] +[DebuggerDisplay("{Value,nq}")] +public readonly struct AgentRegistrySpawnValidationErrorField : IEquatable { - /// 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; } + private readonly string? _value; - /// 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; } + /// Initializes a new instance of the struct. + /// The value to associate with this . + [JsonConstructor] + public AgentRegistrySpawnValidationErrorField(string value) + { + ArgumentException.ThrowIfNullOrWhiteSpace(value); + _value = value; + } - /// Optional human-readable reason for the cancellation, propagated for logging. - [JsonPropertyName("cancelReason")] - public string? CancelReason { get; set; } + /// Gets the value associated with this . + public string Value => _value ?? string.Empty; - /// 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; + /// The cwd parameter. + public static AgentRegistrySpawnValidationErrorField Cwd { get; } = new("cwd"); - /// 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; } + /// The session name parameter. + public static AgentRegistrySpawnValidationErrorField Name { get; } = new("name"); - /// Matches the requestId from the originating httpRequestStart frame. - [JsonPropertyName("requestId")] - public string RequestId { get; set; } = string.Empty; -} + /// The agentName parameter. + public static AgentRegistrySpawnValidationErrorField AgentName { get; } = new("agentName"); -/// 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; + /// The model parameter. + public static AgentRegistrySpawnValidationErrorField Model { get; } = new("model"); - /// Name of the client application. - [JsonPropertyName("client_name")] - public string? ClientName { get; set; } + /// The permissionMode parameter. + public static AgentRegistrySpawnValidationErrorField PermissionMode { get; } = new("permissionMode"); - /// Type of client. - [JsonPropertyName("client_type")] - public string? ClientType { get; set; } + /// Returns a value indicating whether two instances are equivalent. + public static bool operator ==(AgentRegistrySpawnValidationErrorField left, AgentRegistrySpawnValidationErrorField right) => left.Equals(right); - /// Copilot subscription plan, when known. - [JsonPropertyName("copilot_plan")] - public string? CopilotPlan { get; set; } + /// Returns a value indicating whether two instances are not equivalent. + public static bool operator !=(AgentRegistrySpawnValidationErrorField left, AgentRegistrySpawnValidationErrorField right) => !(left == right); - /// Stable machine identifier for the device. - [JsonPropertyName("dev_device_id")] - public string? DevDeviceId { get; set; } + /// + public override bool Equals(object? obj) => obj is AgentRegistrySpawnValidationErrorField other && Equals(other); - /// Whether the user is a GitHub/Microsoft staff member. - [JsonPropertyName("is_staff")] - public bool? IsStaff { get; set; } + /// + public bool Equals(AgentRegistrySpawnValidationErrorField other) => string.Equals(Value, other.Value, StringComparison.OrdinalIgnoreCase); - /// Node.js runtime version string. - [JsonPropertyName("node_version")] - public string NodeVersion { get; set; } = string.Empty; + /// + public override int GetHashCode() => StringComparer.OrdinalIgnoreCase.GetHashCode(Value); - /// Operating system architecture (e.g. arm64, x64). - [JsonPropertyName("os_arch")] - public string OsArch { get; set; } = string.Empty; + /// + public override string ToString() => Value; - /// Operating system platform (e.g. darwin, linux, win32). - [JsonPropertyName("os_platform")] - public string OsPlatform { 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)); + } - /// Operating system version string. - [JsonPropertyName("os_version")] - public string OsVersion { get; set; } = string.Empty; + /// + public override void Write(Utf8JsonWriter writer, AgentRegistrySpawnValidationErrorField value, JsonSerializerOptions options) + { + GeneratedStringEnumJson.WriteValue(writer, value.Value, typeof(AgentRegistrySpawnValidationErrorField)); + } + } } -/// 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. + +/// 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)] -public sealed class GitHubTelemetryEvent +[JsonConverter(typeof(Converter))] +[DebuggerDisplay("{Value,nq}")] +public readonly struct AgentRegistrySpawnValidationErrorReason : IEquatable { - /// Client environment metadata. - [JsonPropertyName("client")] - public GitHubTelemetryClientInfo? Client { get; set; } + private readonly string? _value; + + /// Initializes a new instance of the struct. + /// The value to associate with this . + [JsonConstructor] + public AgentRegistrySpawnValidationErrorReason(string value) + { + ArgumentException.ThrowIfNullOrWhiteSpace(value); + _value = value; + } + + /// 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"); - /// Copilot tracking ID for user-level attribution. - [JsonPropertyName("copilot_tracking_id")] - public string? CopilotTrackingId { get; set; } + /// Session name failed validateSessionName. + public static AgentRegistrySpawnValidationErrorReason InvalidName { get; } = new("invalid-name"); - /// Timestamp when the event was created (ISO 8601 format). - [JsonPropertyName("created_at")] - public string? CreatedAt { get; set; } + /// Requested agent name was not found in builtin or custom agents. + public static AgentRegistrySpawnValidationErrorReason UnknownAgent { get; } = new("unknown-agent"); - /// Experiment assignment context. - [JsonPropertyName("exp_assignment_context")] - public string? ExpAssignmentContext { get; set; } + /// Requested model is not available to this session. + public static AgentRegistrySpawnValidationErrorReason UnknownModel { get; } = new("unknown-model"); - /// Feature flags enabled for this session, as a map from flag to value. - [JsonPropertyName("features")] - public IDictionary? Features { get; set; } + /// Caller asked for permissionMode='yolo' but the controller is not currently in allow-all mode. + public static AgentRegistrySpawnValidationErrorReason YoloNotAllowed { get; } = new("yolo-not-allowed"); - /// Event type/kind (e.g. get_completion_with_tools_turn, tool_call_executed). - [JsonPropertyName("kind")] - public string Kind { get; set; } = string.Empty; + /// Returns a value indicating whether two instances are equivalent. + public static bool operator ==(AgentRegistrySpawnValidationErrorReason left, AgentRegistrySpawnValidationErrorReason right) => left.Equals(right); - /// Numeric metrics as a map from key to value. - [JsonPropertyName("metrics")] - public IDictionary Metrics { get => field ??= new Dictionary(); set; } + /// Returns a value indicating whether two instances are not equivalent. + public static bool operator !=(AgentRegistrySpawnValidationErrorReason left, AgentRegistrySpawnValidationErrorReason right) => !(left == right); - /// Reference to the model call that produced this event. - [JsonPropertyName("model_call_id")] - public string? ModelCallId { get; set; } + /// + public override bool Equals(object? obj) => obj is AgentRegistrySpawnValidationErrorReason other && Equals(other); - /// String-valued properties as a map from key to value. - [JsonPropertyName("properties")] - public IDictionary Properties { get => field ??= new Dictionary(); set; } + /// + public bool Equals(AgentRegistrySpawnValidationErrorReason other) => string.Equals(Value, other.Value, StringComparison.OrdinalIgnoreCase); - /// Session identifier the event belongs to. - [JsonPropertyName("session_id")] - public string? SessionId { get; set; } -} + /// + public override int GetHashCode() => StringComparer.OrdinalIgnoreCase.GetHashCode(Value); -/// 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; } + /// + public override string ToString() => Value; - /// 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; } + /// 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)); + } - /// 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; } + /// + public override void Write(Utf8JsonWriter writer, AgentRegistrySpawnValidationErrorReason value, JsonSerializerOptions options) + { + GeneratedStringEnumJson.WriteValue(writer, value.Value, typeof(AgentRegistrySpawnValidationErrorReason)); + } + } } -/// Resolved Anthropic adaptive-thinking capability for a model. + +/// Permission posture for the new session. 'yolo' requires the controller-local session to currently be in allow-all mode. [Experimental(Diagnostics.Experimental)] [JsonConverter(typeof(Converter))] [DebuggerDisplay("{Value,nq}")] -public readonly struct AdaptiveThinkingSupport : IEquatable +public readonly struct AgentRegistrySpawnPermissionMode : 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 AdaptiveThinkingSupport(string value) + public AgentRegistrySpawnPermissionMode(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 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"); + /// Standard permission posture (prompts for each request). + public static AgentRegistrySpawnPermissionMode Default { get; } = new("default"); - /// 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"); + /// Full allow-all (requires the controller-local session to currently be in allow-all mode). + public static AgentRegistrySpawnPermissionMode Yolo { get; } = new("yolo"); - /// 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 equivalent. + public static bool operator ==(AgentRegistrySpawnPermissionMode left, AgentRegistrySpawnPermissionMode right) => left.Equals(right); - /// Returns a value indicating whether two instances are not equivalent. - public static bool operator !=(AdaptiveThinkingSupport left, AdaptiveThinkingSupport right) => !(left == right); + /// Returns a value indicating whether two instances are not equivalent. + public static bool operator !=(AgentRegistrySpawnPermissionMode left, AgentRegistrySpawnPermissionMode right) => !(left == right); /// - public override bool Equals(object? obj) => obj is AdaptiveThinkingSupport other && Equals(other); + public override bool Equals(object? obj) => obj is AgentRegistrySpawnPermissionMode other && Equals(other); /// - public bool Equals(AdaptiveThinkingSupport other) => string.Equals(Value, other.Value, StringComparison.OrdinalIgnoreCase); + public bool Equals(AgentRegistrySpawnPermissionMode other) => string.Equals(Value, other.Value, StringComparison.OrdinalIgnoreCase); /// public override int GetHashCode() => StringComparer.OrdinalIgnoreCase.GetHashCode(Value); @@ -13049,65 +22768,68 @@ public AdaptiveThinkingSupport(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 AdaptiveThinkingSupport Read(ref Utf8JsonReader reader, Type typeToConvert, JsonSerializerOptions options) + public override AgentRegistrySpawnPermissionMode 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) + public override void Write(Utf8JsonWriter writer, AgentRegistrySpawnPermissionMode value, JsonSerializerOptions options) { - GeneratedStringEnumJson.WriteValue(writer, value.Value, typeof(AdaptiveThinkingSupport)); + GeneratedStringEnumJson.WriteValue(writer, value.Value, typeof(AgentRegistrySpawnPermissionMode)); } } } -/// Model capability category for grouping in the model picker. +/// The UI mode the agent was in when this message was sent. Defaults to the session's current mode. [Experimental(Diagnostics.Experimental)] [JsonConverter(typeof(Converter))] [DebuggerDisplay("{Value,nq}")] -public readonly struct ModelPickerCategory : IEquatable +public readonly struct SendAgentMode : 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 SendAgentMode(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 agent is responding interactively to the user. + public static SendAgentMode Interactive { get; } = new("interactive"); - /// Versatile model category suitable for a broad range of tasks. - public static ModelPickerCategory Versatile { get; } = new("versatile"); + /// The agent is preparing a plan before making changes. + public static SendAgentMode Plan { get; } = new("plan"); - /// Powerful model category optimized for complex tasks. - public static ModelPickerCategory Powerful { get; } = new("powerful"); + /// The agent is working autonomously toward task completion. + public static SendAgentMode Autopilot { get; } = new("autopilot"); - /// Returns a value indicating whether two instances are equivalent. - public static bool operator ==(ModelPickerCategory left, ModelPickerCategory right) => left.Equals(right); + /// The agent is in shell-focused UI mode. + public static SendAgentMode Shell { get; } = new("shell"); - /// Returns a value indicating whether two instances are not equivalent. - public static bool operator !=(ModelPickerCategory left, ModelPickerCategory right) => !(left == right); + /// 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 not equivalent. + public static bool operator !=(SendAgentMode left, SendAgentMode right) => !(left == right); /// - public override bool Equals(object? obj) => obj is ModelPickerCategory other && Equals(other); + public override bool Equals(object? obj) => obj is SendAgentMode other && Equals(other); /// - public bool Equals(ModelPickerCategory other) => string.Equals(Value, other.Value, StringComparison.OrdinalIgnoreCase); + public bool Equals(SendAgentMode other) => string.Equals(Value, other.Value, StringComparison.OrdinalIgnoreCase); /// public override int GetHashCode() => StringComparer.OrdinalIgnoreCase.GetHashCode(Value); @@ -13115,68 +22837,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 SendAgentMode 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, SendAgentMode value, JsonSerializerOptions options) { - GeneratedStringEnumJson.WriteValue(writer, value.Value, typeof(ModelPickerCategory)); + GeneratedStringEnumJson.WriteValue(writer, value.Value, typeof(SendAgentMode)); } } } -/// Relative cost tier for token-based billing users. +/// How to deliver the message. `enqueue` (default) appends to the message queue. `immediate` interjects during an in-progress turn. [Experimental(Diagnostics.Experimental)] [JsonConverter(typeof(Converter))] [DebuggerDisplay("{Value,nq}")] -public readonly struct ModelPickerPriceCategory : IEquatable +public readonly struct SendMode : 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 SendMode(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"); + /// Append the message to the normal session queue. + public static SendMode Enqueue { get; } = new("enqueue"); - /// Highest relative token cost tier. - public static ModelPickerPriceCategory VeryHigh { get; } = new("very_high"); + /// Interject the message during the in-progress turn. + public static SendMode Immediate { get; } = new("immediate"); - /// 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 ==(SendMode left, SendMode 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 !=(SendMode left, SendMode right) => !(left == right); /// - public override bool Equals(object? obj) => obj is ModelPickerPriceCategory other && Equals(other); + public override bool Equals(object? obj) => obj is SendMode other && Equals(other); /// - public bool Equals(ModelPickerPriceCategory other) => string.Equals(Value, other.Value, StringComparison.OrdinalIgnoreCase); + public bool Equals(SendMode other) => string.Equals(Value, other.Value, StringComparison.OrdinalIgnoreCase); /// public override int GetHashCode() => StringComparer.OrdinalIgnoreCase.GetHashCode(Value); @@ -13184,65 +22900,65 @@ 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 SendMode 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, SendMode value, JsonSerializerOptions options) { - GeneratedStringEnumJson.WriteValue(writer, value.Value, typeof(ModelPickerPriceCategory)); + GeneratedStringEnumJson.WriteValue(writer, value.Value, typeof(SendMode)); } } } -/// Current policy state for this model. +/// Log severity level. Determines how the message is displayed in the timeline. Defaults to "info". [Experimental(Diagnostics.Experimental)] [JsonConverter(typeof(Converter))] [DebuggerDisplay("{Value,nq}")] -public readonly struct ModelPolicyState : IEquatable +public readonly struct SessionLogLevel : 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 SessionLogLevel(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"); + /// Informational message. + public static SessionLogLevel Info { get; } = new("info"); - /// The model is disabled by policy. - public static ModelPolicyState Disabled { get; } = new("disabled"); + /// Warning message that may require attention. + public static SessionLogLevel Warning { get; } = new("warning"); - /// No explicit policy is configured for the model. - public static ModelPolicyState Unconfigured { get; } = new("unconfigured"); + /// Error message describing a failure. + public static SessionLogLevel Error { get; } = new("error"); - /// 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 ==(SessionLogLevel left, SessionLogLevel 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 !=(SessionLogLevel left, SessionLogLevel right) => !(left == right); /// - public override bool Equals(object? obj) => obj is ModelPolicyState other && Equals(other); + public override bool Equals(object? obj) => obj is SessionLogLevel other && Equals(other); /// - public bool Equals(ModelPolicyState other) => string.Equals(Value, other.Value, StringComparison.OrdinalIgnoreCase); + public bool Equals(SessionLogLevel other) => string.Equals(Value, other.Value, StringComparison.OrdinalIgnoreCase); /// public override int GetHashCode() => StringComparer.OrdinalIgnoreCase.GetHashCode(Value); @@ -13250,68 +22966,80 @@ 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 SessionLogLevel 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, SessionLogLevel value, JsonSerializerOptions options) { - GeneratedStringEnumJson.WriteValue(writer, value.Value, typeof(ModelPolicyState)); + GeneratedStringEnumJson.WriteValue(writer, value.Value, typeof(SessionLogLevel)); } } } -/// Server transport type: stdio, http, sse (deprecated), or memory. +/// Authentication type. [Experimental(Diagnostics.Experimental)] [JsonConverter(typeof(Converter))] [DebuggerDisplay("{Value,nq}")] -public readonly struct DiscoveredMcpServerType : IEquatable +public readonly struct AuthInfoType : 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 AuthInfoType(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"); + /// Authentication provided by a GitHub App HMAC credential. + public static AuthInfoType Hmac { get; } = new("hmac"); - /// Server communicates over streamable HTTP. - public static DiscoveredMcpServerType Http { get; } = new("http"); + /// Authentication resolved from environment-provided credentials. + public static AuthInfoType Env { get; } = new("env"); - /// Server communicates over Server-Sent Events (deprecated). - public static DiscoveredMcpServerType Sse { get; } = new("sse"); + /// Authentication from an interactive user sign-in. + public static AuthInfoType User { get; } = new("user"); - /// Server is backed by an in-memory runtime implementation. - public static DiscoveredMcpServerType Memory { get; } = new("memory"); + /// Authentication delegated to the GitHub CLI. + public static AuthInfoType GhCli { get; } = new("gh-cli"); - /// Returns a value indicating whether two instances are equivalent. - public static bool operator ==(DiscoveredMcpServerType left, DiscoveredMcpServerType right) => left.Equals(right); + /// Authentication from an API key credential. + public static AuthInfoType ApiKey { get; } = new("api-key"); - /// Returns a value indicating whether two instances are not equivalent. - public static bool operator !=(DiscoveredMcpServerType left, DiscoveredMcpServerType right) => !(left == right); + /// Authentication from a GitHub token. + public static AuthInfoType Token { get; } = new("token"); + + /// Authentication from an SDK GitHub token callback. + public static AuthInfoType TokenProvider { get; } = new("token-provider"); + + /// Authentication from a Copilot API token. + public static AuthInfoType CopilotApiToken { get; } = new("copilot-api-token"); + + /// 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 not equivalent. + public static bool operator !=(AuthInfoType left, AuthInfoType right) => !(left == right); /// - public override bool Equals(object? obj) => obj is DiscoveredMcpServerType other && Equals(other); + public override bool Equals(object? obj) => obj is AuthInfoType other && Equals(other); /// - public bool Equals(DiscoveredMcpServerType other) => string.Equals(Value, other.Value, StringComparison.OrdinalIgnoreCase); + public bool Equals(AuthInfoType other) => string.Equals(Value, other.Value, StringComparison.OrdinalIgnoreCase); /// public override int GetHashCode() => StringComparer.OrdinalIgnoreCase.GetHashCode(Value); @@ -13319,68 +23047,68 @@ 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 AuthInfoType 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, AuthInfoType value, JsonSerializerOptions options) { - GeneratedStringEnumJson.WriteValue(writer, value.Value, typeof(DiscoveredMcpServerType)); + GeneratedStringEnumJson.WriteValue(writer, value.Value, typeof(AuthInfoType)); } } } -/// Which tier this directory belongs to. +/// Source category for a collected debug bundle entry. [Experimental(Diagnostics.Experimental)] [JsonConverter(typeof(Converter))] [DebuggerDisplay("{Value,nq}")] -public readonly struct SkillDiscoveryScope : IEquatable +public readonly struct DebugCollectLogsSource : 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 SkillDiscoveryScope(string value) + public DebugCollectLogsSource(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 project's repository skill directory. - public static SkillDiscoveryScope Project { get; } = new("project"); + /// Session event log. + public static DebugCollectLogsSource Events { get; } = new("events"); - /// The user's personal Copilot skill directory. - public static SkillDiscoveryScope PersonalCopilot { get; } = new("personal-copilot"); + /// Process log for the session. + public static DebugCollectLogsSource ProcessLog { get; } = new("process-log"); - /// The user's personal agents skill directory. - public static SkillDiscoveryScope PersonalAgents { get; } = new("personal-agents"); + /// Interactive shell log for the session. + public static DebugCollectLogsSource ShellLog { get; } = new("shell-log"); - /// A configured custom skill directory. - public static SkillDiscoveryScope Custom { get; } = new("custom"); + /// Caller-provided diagnostic entry. + public static DebugCollectLogsSource Additional { get; } = new("additional"); - /// 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 equivalent. + public static bool operator ==(DebugCollectLogsSource left, DebugCollectLogsSource right) => left.Equals(right); - /// Returns a value indicating whether two instances are not equivalent. - public static bool operator !=(SkillDiscoveryScope left, SkillDiscoveryScope right) => !(left == right); + /// Returns a value indicating whether two instances are not equivalent. + public static bool operator !=(DebugCollectLogsSource left, DebugCollectLogsSource right) => !(left == right); /// - public override bool Equals(object? obj) => obj is SkillDiscoveryScope other && Equals(other); + public override bool Equals(object? obj) => obj is DebugCollectLogsSource other && Equals(other); /// - public bool Equals(SkillDiscoveryScope other) => string.Equals(Value, other.Value, StringComparison.OrdinalIgnoreCase); + public bool Equals(DebugCollectLogsSource other) => string.Equals(Value, other.Value, StringComparison.OrdinalIgnoreCase); /// public override int GetHashCode() => StringComparer.OrdinalIgnoreCase.GetHashCode(Value); @@ -13388,74 +23116,62 @@ public SkillDiscoveryScope(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 SkillDiscoveryScope Read(ref Utf8JsonReader reader, Type typeToConvert, JsonSerializerOptions options) + public override DebugCollectLogsSource 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) + public override void Write(Utf8JsonWriter writer, DebugCollectLogsSource value, JsonSerializerOptions options) { - GeneratedStringEnumJson.WriteValue(writer, value.Value, typeof(SkillDiscoveryScope)); + GeneratedStringEnumJson.WriteValue(writer, value.Value, typeof(DebugCollectLogsSource)); } } } -/// Where the agent definition was loaded from. +/// Destination kind that was written. [Experimental(Diagnostics.Experimental)] [JsonConverter(typeof(Converter))] [DebuggerDisplay("{Value,nq}")] -public readonly struct AgentInfoSource : IEquatable +public readonly struct DebugCollectLogsResultKind : 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 DebugCollectLogsResultKind(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"); - - /// 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"); + /// A .tgz archive was written. + public static DebugCollectLogsResultKind Archive { get; } = new("archive"); - /// Agent built into the Copilot runtime. - public static AgentInfoSource Builtin { get; } = new("builtin"); + /// A directory containing redacted files was written. + public static DebugCollectLogsResultKind Directory { get; } = new("directory"); - /// 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 ==(DebugCollectLogsResultKind left, DebugCollectLogsResultKind 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 !=(DebugCollectLogsResultKind left, DebugCollectLogsResultKind right) => !(left == right); /// - public override bool Equals(object? obj) => obj is AgentInfoSource other && Equals(other); + public override bool Equals(object? obj) => obj is DebugCollectLogsResultKind other && Equals(other); /// - public bool Equals(AgentInfoSource other) => string.Equals(Value, other.Value, StringComparison.OrdinalIgnoreCase); + public bool Equals(DebugCollectLogsResultKind other) => string.Equals(Value, other.Value, StringComparison.OrdinalIgnoreCase); /// public override int GetHashCode() => StringComparer.OrdinalIgnoreCase.GetHashCode(Value); @@ -13463,62 +23179,62 @@ 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 DebugCollectLogsResultKind 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, DebugCollectLogsResultKind value, JsonSerializerOptions options) { - GeneratedStringEnumJson.WriteValue(writer, value.Value, typeof(AgentInfoSource)); + GeneratedStringEnumJson.WriteValue(writer, value.Value, typeof(DebugCollectLogsResultKind)); } } } -/// Which tier this directory belongs to. +/// Kind of caller-provided debug log entry. [Experimental(Diagnostics.Experimental)] [JsonConverter(typeof(Converter))] [DebuggerDisplay("{Value,nq}")] -public readonly struct AgentDiscoveryPathScope : IEquatable +public readonly struct DebugCollectLogsEntryKind : 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 AgentDiscoveryPathScope(string value) + public DebugCollectLogsEntryKind(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's personal agent configuration directory. - public static AgentDiscoveryPathScope User { get; } = new("user"); + /// Include a single server-local file. + public static DebugCollectLogsEntryKind File { get; } = new("file"); - /// A project's repository agent directory. - public static AgentDiscoveryPathScope Project { get; } = new("project"); + /// Include files from a server-local directory recursively. + public static DebugCollectLogsEntryKind Directory { get; } = new("directory"); - /// 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 equivalent. + public static bool operator ==(DebugCollectLogsEntryKind left, DebugCollectLogsEntryKind right) => left.Equals(right); - /// Returns a value indicating whether two instances are not equivalent. - public static bool operator !=(AgentDiscoveryPathScope left, AgentDiscoveryPathScope right) => !(left == right); + /// Returns a value indicating whether two instances are not equivalent. + public static bool operator !=(DebugCollectLogsEntryKind left, DebugCollectLogsEntryKind right) => !(left == right); /// - public override bool Equals(object? obj) => obj is AgentDiscoveryPathScope other && Equals(other); + public override bool Equals(object? obj) => obj is DebugCollectLogsEntryKind other && Equals(other); /// - public bool Equals(AgentDiscoveryPathScope other) => string.Equals(Value, other.Value, StringComparison.OrdinalIgnoreCase); + public bool Equals(DebugCollectLogsEntryKind other) => string.Equals(Value, other.Value, StringComparison.OrdinalIgnoreCase); /// public override int GetHashCode() => StringComparer.OrdinalIgnoreCase.GetHashCode(Value); @@ -13526,68 +23242,62 @@ public AgentDiscoveryPathScope(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 AgentDiscoveryPathScope Read(ref Utf8JsonReader reader, Type typeToConvert, JsonSerializerOptions options) + public override DebugCollectLogsEntryKind 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) + public override void Write(Utf8JsonWriter writer, DebugCollectLogsEntryKind value, JsonSerializerOptions options) { - GeneratedStringEnumJson.WriteValue(writer, value.Value, typeof(AgentDiscoveryPathScope)); + GeneratedStringEnumJson.WriteValue(writer, value.Value, typeof(DebugCollectLogsEntryKind)); } } } -/// Where this source lives β€” used for UI grouping. +/// How a collected debug entry should be redacted before being staged. [Experimental(Diagnostics.Experimental)] [JsonConverter(typeof(Converter))] [DebuggerDisplay("{Value,nq}")] -public readonly struct InstructionSourceLocation : IEquatable +public readonly struct DebugCollectLogsRedaction : 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 InstructionSourceLocation(string value) + public DebugCollectLogsRedaction(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 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"); + /// Redact the file as plain UTF-8 log text. + public static DebugCollectLogsRedaction PlainText { get; } = new("plain-text"); - /// Instructions live in plugin-provided configuration. - public static InstructionSourceLocation Plugin { get; } = new("plugin"); + /// 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 ==(InstructionSourceLocation left, InstructionSourceLocation right) => left.Equals(right); + /// 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 !=(InstructionSourceLocation left, InstructionSourceLocation right) => !(left == 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 InstructionSourceLocation other && Equals(other); + public override bool Equals(object? obj) => obj is DebugCollectLogsRedaction other && Equals(other); /// - public bool Equals(InstructionSourceLocation other) => string.Equals(Value, other.Value, StringComparison.OrdinalIgnoreCase); + public bool Equals(DebugCollectLogsRedaction other) => string.Equals(Value, other.Value, StringComparison.OrdinalIgnoreCase); /// public override int GetHashCode() => StringComparer.OrdinalIgnoreCase.GetHashCode(Value); @@ -13595,77 +23305,65 @@ public InstructionSourceLocation(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 InstructionSourceLocation Read(ref Utf8JsonReader reader, Type typeToConvert, JsonSerializerOptions options) + public override DebugCollectLogsRedaction 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) + public override void Write(Utf8JsonWriter writer, DebugCollectLogsRedaction value, JsonSerializerOptions options) { - GeneratedStringEnumJson.WriteValue(writer, value.Value, typeof(InstructionSourceLocation)); + GeneratedStringEnumJson.WriteValue(writer, value.Value, typeof(DebugCollectLogsRedaction)); } } } -/// Category of instruction source β€” used for merge logic. +/// Cumulative resource ceiling that stopped a factory run. [Experimental(Diagnostics.Experimental)] [JsonConverter(typeof(Converter))] [DebuggerDisplay("{Value,nq}")] -public readonly struct InstructionSourceType : IEquatable +public readonly struct FactoryRunFailureKind : 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 InstructionSourceType(string value) + public FactoryRunFailureKind(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 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"); + /// The run admitted the approved maximum total number of subagents. + public static FactoryRunFailureKind MaxTotalSubagents { get; } = new("maxTotalSubagents"); - /// Instructions inherited from child instruction files. - public static InstructionSourceType ChildInstructions { get; } = new("child-instructions"); + /// The run reached the approved accumulated active-execution time in seconds. + public static FactoryRunFailureKind TimeoutSeconds { get; } = new("timeoutSeconds"); - /// Instructions supplied by an installed plugin. - public static InstructionSourceType Plugin { get; } = new("plugin"); + /// 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"); - /// 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 equivalent. + public static bool operator ==(FactoryRunFailureKind left, FactoryRunFailureKind right) => left.Equals(right); - /// Returns a value indicating whether two instances are not equivalent. - public static bool operator !=(InstructionSourceType left, InstructionSourceType right) => !(left == right); + /// Returns a value indicating whether two instances are not equivalent. + public static bool operator !=(FactoryRunFailureKind left, FactoryRunFailureKind right) => !(left == right); /// - public override bool Equals(object? obj) => obj is InstructionSourceType other && Equals(other); + public override bool Equals(object? obj) => obj is FactoryRunFailureKind other && Equals(other); /// - public bool Equals(InstructionSourceType other) => string.Equals(Value, other.Value, StringComparison.OrdinalIgnoreCase); + public bool Equals(FactoryRunFailureKind other) => string.Equals(Value, other.Value, StringComparison.OrdinalIgnoreCase); /// public override int GetHashCode() => StringComparer.OrdinalIgnoreCase.GetHashCode(Value); @@ -13673,62 +23371,89 @@ public InstructionSourceType(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 InstructionSourceType Read(ref Utf8JsonReader reader, Type typeToConvert, JsonSerializerOptions options) + public override FactoryRunFailureKind 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) + public override void Write(Utf8JsonWriter writer, FactoryRunFailureKind value, JsonSerializerOptions options) { - GeneratedStringEnumJson.WriteValue(writer, value.Value, typeof(InstructionSourceType)); + GeneratedStringEnumJson.WriteValue(writer, value.Value, typeof(FactoryRunFailureKind)); } } } -/// Whether the target is a single file or a directory of instruction files. +/// Execution-critical factory storage operation. [Experimental(Diagnostics.Experimental)] [JsonConverter(typeof(Converter))] [DebuggerDisplay("{Value,nq}")] -public readonly struct InstructionDiscoveryPathKind : IEquatable +public readonly struct FactoryDurableOperation : 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 InstructionDiscoveryPathKind(string value) + public FactoryDurableOperation(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 target is a single instruction file. - public static InstructionDiscoveryPathKind File { get; } = new("file"); + /// Creating the durable run and declared phases. + public static FactoryDurableOperation CreateRun { get; } = new("createRun"); - /// The target is a directory that holds instruction files. - public static InstructionDiscoveryPathKind Directory { get; } = new("directory"); + /// Persisting the transition to running. + public static FactoryDurableOperation MarkRunStarted { get; } = new("markRunStarted"); - /// Returns a value indicating whether two instances are equivalent. - public static bool operator ==(InstructionDiscoveryPathKind left, InstructionDiscoveryPathKind right) => left.Equals(right); + /// Persisting the terminal run envelope. + public static FactoryDurableOperation FinishRun { get; } = new("finishRun"); - /// Returns a value indicating whether two instances are not equivalent. - public static bool operator !=(InstructionDiscoveryPathKind left, InstructionDiscoveryPathKind right) => !(left == right); + /// Persisting subagent admission accounting. + public static FactoryDurableOperation ReserveAgent { get; } = new("reserveAgent"); + + /// Rolling back an uncommitted subagent admission. + public static FactoryDurableOperation ReleaseAgent { get; } = new("releaseAgent"); + + /// Persisting an idempotent model-usage charge. + public static FactoryDurableOperation ChargeCredit { get; } = new("chargeCredit"); + + /// Persisting active execution time. + public static FactoryDurableOperation AddElapsed { get; } = new("addElapsed"); + + /// Reading the authoritative AI-credit total. + public static FactoryDurableOperation ReconcileCreditTotal { get; } = new("reconcileCreditTotal"); + + /// Reading a journal entry without treating storage failure as a cache miss. + public static FactoryDurableOperation JournalGet { get; } = new("journalGet"); + + /// Persisting a journal entry before reporting success. + public static FactoryDurableOperation JournalPut { get; } = new("journalPut"); + + /// Renewing the durable owner lease that proves this process still owns the run. + public static FactoryDurableOperation RefreshLease { get; } = new("refreshLease"); + + /// Returns a value indicating whether two instances are equivalent. + public static bool operator ==(FactoryDurableOperation left, FactoryDurableOperation right) => left.Equals(right); + + /// Returns a value indicating whether two instances are not equivalent. + public static bool operator !=(FactoryDurableOperation left, FactoryDurableOperation right) => !(left == right); /// - public override bool Equals(object? obj) => obj is InstructionDiscoveryPathKind other && Equals(other); + public override bool Equals(object? obj) => obj is FactoryDurableOperation other && Equals(other); /// - public bool Equals(InstructionDiscoveryPathKind other) => string.Equals(Value, other.Value, StringComparison.OrdinalIgnoreCase); + public bool Equals(FactoryDurableOperation other) => string.Equals(Value, other.Value, StringComparison.OrdinalIgnoreCase); /// public override int GetHashCode() => StringComparer.OrdinalIgnoreCase.GetHashCode(Value); @@ -13736,68 +23461,74 @@ public InstructionDiscoveryPathKind(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 InstructionDiscoveryPathKind Read(ref Utf8JsonReader reader, Type typeToConvert, JsonSerializerOptions options) + public override FactoryDurableOperation 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) + public override void Write(Utf8JsonWriter writer, FactoryDurableOperation value, JsonSerializerOptions options) { - GeneratedStringEnumJson.WriteValue(writer, value.Value, typeof(InstructionDiscoveryPathKind)); + GeneratedStringEnumJson.WriteValue(writer, value.Value, typeof(FactoryDurableOperation)); } } } -/// Which tier this target belongs to. +/// Current or terminal state of a factory run. [Experimental(Diagnostics.Experimental)] [JsonConverter(typeof(Converter))] [DebuggerDisplay("{Value,nq}")] -public readonly struct InstructionDiscoveryPathLocation : IEquatable +public readonly struct FactoryRunStatus : 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 InstructionDiscoveryPathLocation(string value) + public FactoryRunStatus(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 InstructionDiscoveryPathLocation User { get; } = new("user"); + /// The run was minted and is awaiting approval. + public static FactoryRunStatus Pending { get; } = new("pending"); - /// Instructions live in repository-level configuration. - public static InstructionDiscoveryPathLocation Repository { get; } = new("repository"); + /// The run is executing. + public static FactoryRunStatus Running { get; } = new("running"); - /// Instructions live under the current working directory. - public static InstructionDiscoveryPathLocation WorkingDirectory { get; } = new("working-directory"); + /// The run completed successfully. + public static FactoryRunStatus Completed { get; } = new("completed"); - /// Instructions live in plugin-provided configuration. - public static InstructionDiscoveryPathLocation Plugin { get; } = new("plugin"); + /// The run was interrupted while resource budget remained. + public static FactoryRunStatus Halted { get; } = new("halted"); - /// Returns a value indicating whether two instances are equivalent. - public static bool operator ==(InstructionDiscoveryPathLocation left, InstructionDiscoveryPathLocation right) => left.Equals(right); + /// The run was cancelled before completion. + public static FactoryRunStatus Cancelled { get; } = new("cancelled"); - /// Returns a value indicating whether two instances are not equivalent. - public static bool operator !=(InstructionDiscoveryPathLocation left, InstructionDiscoveryPathLocation right) => !(left == right); + /// 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 InstructionDiscoveryPathLocation other && Equals(other); + public override bool Equals(object? obj) => obj is FactoryRunStatus other && Equals(other); /// - public bool Equals(InstructionDiscoveryPathLocation other) => string.Equals(Value, other.Value, StringComparison.OrdinalIgnoreCase); + public bool Equals(FactoryRunStatus other) => string.Equals(Value, other.Value, StringComparison.OrdinalIgnoreCase); /// public override int GetHashCode() => StringComparer.OrdinalIgnoreCase.GetHashCode(Value); @@ -13805,59 +23536,68 @@ public InstructionDiscoveryPathLocation(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 InstructionDiscoveryPathLocation Read(ref Utf8JsonReader reader, Type typeToConvert, JsonSerializerOptions options) + public override FactoryRunStatus 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) + public override void Write(Utf8JsonWriter writer, FactoryRunStatus value, JsonSerializerOptions options) { - GeneratedStringEnumJson.WriteValue(writer, value.Value, typeof(InstructionDiscoveryPathLocation)); + GeneratedStringEnumJson.WriteValue(writer, value.Value, typeof(FactoryRunStatus)); } } } -/// Optional completion hint for the input (e.g. 'directory' for filesystem path completion). +/// Derived lifecycle state of a factory phase. [Experimental(Diagnostics.Experimental)] [JsonConverter(typeof(Converter))] [DebuggerDisplay("{Value,nq}")] -public readonly struct SlashCommandInputCompletion : IEquatable +public readonly struct FactoryPhaseStatus : 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 FactoryPhaseStatus(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"); + /// The phase has not been entered yet. + public static FactoryPhaseStatus Pending { get; } = new("pending"); - /// Returns a value indicating whether two instances are equivalent. - public static bool operator ==(SlashCommandInputCompletion left, SlashCommandInputCompletion right) => left.Equals(right); + /// The phase is currently entered and accumulating active time. + public static FactoryPhaseStatus Active { get; } = new("active"); - /// Returns a value indicating whether two instances are not equivalent. - public static bool operator !=(SlashCommandInputCompletion left, SlashCommandInputCompletion right) => !(left == right); + /// The phase was entered and has since been closed. + public static FactoryPhaseStatus Completed { get; } = new("completed"); + + /// 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"); + + /// Returns a value indicating whether two instances are equivalent. + public static bool operator ==(FactoryPhaseStatus left, FactoryPhaseStatus right) => left.Equals(right); + + /// Returns a value indicating whether two instances are not equivalent. + public static bool operator !=(FactoryPhaseStatus left, FactoryPhaseStatus right) => !(left == right); /// - public override bool Equals(object? obj) => obj is SlashCommandInputCompletion other && Equals(other); + public override bool Equals(object? obj) => obj is FactoryPhaseStatus other && Equals(other); /// - public bool Equals(SlashCommandInputCompletion other) => string.Equals(Value, other.Value, StringComparison.OrdinalIgnoreCase); + public bool Equals(FactoryPhaseStatus other) => string.Equals(Value, other.Value, StringComparison.OrdinalIgnoreCase); /// public override int GetHashCode() => StringComparer.OrdinalIgnoreCase.GetHashCode(Value); @@ -13865,65 +23605,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 FactoryPhaseStatus 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, FactoryPhaseStatus value, JsonSerializerOptions options) { - GeneratedStringEnumJson.WriteValue(writer, value.Value, typeof(SlashCommandInputCompletion)); + GeneratedStringEnumJson.WriteValue(writer, value.Value, typeof(FactoryPhaseStatus)); } } } -/// Coarse command category for grouping and behavior: runtime built-in, skill-backed command, or SDK/client-owned command. +/// Kind of factory progress line. [Experimental(Diagnostics.Experimental)] [JsonConverter(typeof(Converter))] [DebuggerDisplay("{Value,nq}")] -public readonly struct SlashCommandKind : IEquatable +public readonly struct FactoryLogLineKind : 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 FactoryLogLineKind(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"); + /// A narrator log line. + public static FactoryLogLineKind Log { get; } = new("log"); - /// Command registered by an SDK client or extension. - public static SlashCommandKind Client { get; } = new("client"); + /// A named factory phase marker. + public static FactoryLogLineKind Phase { get; } = new("phase"); - /// 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 ==(FactoryLogLineKind left, FactoryLogLineKind 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 !=(FactoryLogLineKind left, FactoryLogLineKind right) => !(left == right); /// - public override bool Equals(object? obj) => obj is SlashCommandKind other && Equals(other); + public override bool Equals(object? obj) => obj is FactoryLogLineKind other && Equals(other); /// - public bool Equals(SlashCommandKind other) => string.Equals(Value, other.Value, StringComparison.OrdinalIgnoreCase); + public bool Equals(FactoryLogLineKind other) => string.Equals(Value, other.Value, StringComparison.OrdinalIgnoreCase); /// public override int GetHashCode() => StringComparer.OrdinalIgnoreCase.GetHashCode(Value); @@ -13931,62 +23668,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 FactoryLogLineKind 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, FactoryLogLineKind value, JsonSerializerOptions options) { - GeneratedStringEnumJson.WriteValue(writer, value.Value, typeof(SlashCommandKind)); + GeneratedStringEnumJson.WriteValue(writer, value.Value, typeof(FactoryLogLineKind)); } } } -/// Path conventions used by this filesystem. +/// Allowed values for the `WorkspacesWorkspaceDetailsHostType` enumeration. [Experimental(Diagnostics.Experimental)] [JsonConverter(typeof(Converter))] [DebuggerDisplay("{Value,nq}")] -public readonly struct SessionFsSetProviderConventions : IEquatable +public readonly struct WorkspacesWorkspaceDetailsHostType : 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 WorkspacesWorkspaceDetailsHostType(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"); + /// Workspace repository is hosted on GitHub. + public static WorkspacesWorkspaceDetailsHostType GitHub { get; } = new("github"); - /// Paths use POSIX path conventions. - public static SessionFsSetProviderConventions Posix { get; } = new("posix"); + /// Workspace repository is hosted on Azure DevOps. + public static WorkspacesWorkspaceDetailsHostType Ado { get; } = new("ado"); - /// 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 ==(WorkspacesWorkspaceDetailsHostType left, WorkspacesWorkspaceDetailsHostType 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 !=(WorkspacesWorkspaceDetailsHostType left, WorkspacesWorkspaceDetailsHostType right) => !(left == right); /// - public override bool Equals(object? obj) => obj is SessionFsSetProviderConventions other && Equals(other); + public override bool Equals(object? obj) => obj is WorkspacesWorkspaceDetailsHostType other && Equals(other); /// - public bool Equals(SessionFsSetProviderConventions other) => string.Equals(Value, other.Value, StringComparison.OrdinalIgnoreCase); + public bool Equals(WorkspacesWorkspaceDetailsHostType other) => string.Equals(Value, other.Value, StringComparison.OrdinalIgnoreCase); /// public override int GetHashCode() => StringComparer.OrdinalIgnoreCase.GetHashCode(Value); @@ -13994,62 +23731,68 @@ 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 WorkspacesWorkspaceDetailsHostType 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, WorkspacesWorkspaceDetailsHostType value, JsonSerializerOptions options) { - GeneratedStringEnumJson.WriteValue(writer, value.Value, typeof(SessionFsSetProviderConventions)); + GeneratedStringEnumJson.WriteValue(writer, value.Value, typeof(WorkspacesWorkspaceDetailsHostType)); } } } -/// Repository host type. +/// Type of change represented by this file diff. [Experimental(Diagnostics.Experimental)] [JsonConverter(typeof(Converter))] [DebuggerDisplay("{Value,nq}")] -public readonly struct SessionContextHostType : IEquatable +public readonly struct WorkspaceDiffFileChangeType : 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 WorkspaceDiffFileChangeType(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"); + /// The file was added. + public static WorkspaceDiffFileChangeType Added { get; } = new("added"); - /// Session repository is hosted on Azure DevOps. - public static SessionContextHostType Ado { get; } = new("ado"); + /// The file was modified. + public static WorkspaceDiffFileChangeType Modified { get; } = new("modified"); - /// Returns a value indicating whether two instances are equivalent. - public static bool operator ==(SessionContextHostType left, SessionContextHostType right) => left.Equals(right); + /// The file was deleted. + public static WorkspaceDiffFileChangeType Deleted { get; } = new("deleted"); - /// Returns a value indicating whether two instances are not equivalent. - public static bool operator !=(SessionContextHostType left, SessionContextHostType right) => !(left == right); + /// The file was renamed. + public static WorkspaceDiffFileChangeType Renamed { get; } = new("renamed"); + + /// Returns a value indicating whether two instances are equivalent. + public static bool operator ==(WorkspaceDiffFileChangeType left, WorkspaceDiffFileChangeType right) => left.Equals(right); + + /// Returns a value indicating whether two instances are not equivalent. + public static bool operator !=(WorkspaceDiffFileChangeType left, WorkspaceDiffFileChangeType right) => !(left == right); /// - public override bool Equals(object? obj) => obj is SessionContextHostType other && Equals(other); + public override bool Equals(object? obj) => obj is WorkspaceDiffFileChangeType other && Equals(other); /// - public bool Equals(SessionContextHostType other) => string.Equals(Value, other.Value, StringComparison.OrdinalIgnoreCase); + public bool Equals(WorkspaceDiffFileChangeType other) => string.Equals(Value, other.Value, StringComparison.OrdinalIgnoreCase); /// public override int GetHashCode() => StringComparer.OrdinalIgnoreCase.GetHashCode(Value); @@ -14057,62 +23800,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 WorkspaceDiffFileChangeType 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, WorkspaceDiffFileChangeType value, JsonSerializerOptions options) { - GeneratedStringEnumJson.WriteValue(writer, value.Value, typeof(SessionContextHostType)); + GeneratedStringEnumJson.WriteValue(writer, value.Value, typeof(WorkspaceDiffFileChangeType)); } } } -/// Whether the remote task originated from CCA or CLI `--remote`. +/// Diff mode requested by the client. [Experimental(Diagnostics.Experimental)] [JsonConverter(typeof(Converter))] [DebuggerDisplay("{Value,nq}")] -public readonly struct RemoteSessionMetadataTaskType : IEquatable +public readonly struct WorkspaceDiffMode : 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 RemoteSessionMetadataTaskType(string value) + public WorkspaceDiffMode(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 Copilot coding agent task. - public static RemoteSessionMetadataTaskType Cca { get; } = new("cca"); + /// Return staged, unstaged, and untracked working tree changes. + public static WorkspaceDiffMode Unstaged { get; } = new("unstaged"); - /// CLI remote task. - public static RemoteSessionMetadataTaskType Cli { get; } = new("cli"); + /// Return changes compared with the default branch. + public static WorkspaceDiffMode Branch { get; } = new("branch"); - /// Returns a value indicating whether two instances are equivalent. - public static bool operator ==(RemoteSessionMetadataTaskType left, RemoteSessionMetadataTaskType right) => left.Equals(right); + /// Return the cumulative diff of files Copilot changed this session (used in non-git workspaces). + public static WorkspaceDiffMode Session { get; } = new("session"); - /// Returns a value indicating whether two instances are not equivalent. - public static bool operator !=(RemoteSessionMetadataTaskType left, RemoteSessionMetadataTaskType right) => !(left == right); + /// 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 not equivalent. + public static bool operator !=(WorkspaceDiffMode left, WorkspaceDiffMode right) => !(left == right); /// - public override bool Equals(object? obj) => obj is RemoteSessionMetadataTaskType other && Equals(other); + public override bool Equals(object? obj) => obj is WorkspaceDiffMode other && Equals(other); /// - public bool Equals(RemoteSessionMetadataTaskType other) => string.Equals(Value, other.Value, StringComparison.OrdinalIgnoreCase); + public bool Equals(WorkspaceDiffMode other) => string.Equals(Value, other.Value, StringComparison.OrdinalIgnoreCase); /// public override int GetHashCode() => StringComparer.OrdinalIgnoreCase.GetHashCode(Value); @@ -14120,62 +23866,65 @@ public RemoteSessionMetadataTaskType(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 RemoteSessionMetadataTaskType Read(ref Utf8JsonReader reader, Type typeToConvert, JsonSerializerOptions options) + public override WorkspaceDiffMode 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) + public override void Write(Utf8JsonWriter writer, WorkspaceDiffMode value, JsonSerializerOptions options) { - GeneratedStringEnumJson.WriteValue(writer, value.Value, typeof(RemoteSessionMetadataTaskType)); + GeneratedStringEnumJson.WriteValue(writer, value.Value, typeof(WorkspaceDiffMode)); } } } -/// Step status. +/// 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)] [JsonConverter(typeof(Converter))] [DebuggerDisplay("{Value,nq}")] -public readonly struct SessionsOpenProgressStatus : IEquatable +public readonly struct HistoryRewindUnavailableReason : 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 SessionsOpenProgressStatus(string value) + public HistoryRewindUnavailableReason(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 step has started and has not yet finished. - public static SessionsOpenProgressStatus InProgress { get; } = new("in-progress"); + /// The session did not opt into file-change tracking before its first turn. + public static HistoryRewindUnavailableReason FileChangeTrackingDisabled { get; } = new("file-change-tracking-disabled"); - /// The step has completed successfully. - public static SessionsOpenProgressStatus Complete { get; } = new("complete"); + /// 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"); - /// Returns a value indicating whether two instances are equivalent. - public static bool operator ==(SessionsOpenProgressStatus left, SessionsOpenProgressStatus right) => left.Equals(right); + /// Remote-backed rewind routing is not supported. + public static HistoryRewindUnavailableReason UnsupportedRemoteSession { get; } = new("unsupported-remote-session"); - /// Returns a value indicating whether two instances are not equivalent. - public static bool operator !=(SessionsOpenProgressStatus left, SessionsOpenProgressStatus right) => !(left == right); + /// Returns a value indicating whether two instances are equivalent. + public static bool operator ==(HistoryRewindUnavailableReason left, HistoryRewindUnavailableReason right) => left.Equals(right); + + /// Returns a value indicating whether two instances are not equivalent. + public static bool operator !=(HistoryRewindUnavailableReason left, HistoryRewindUnavailableReason right) => !(left == right); /// - public override bool Equals(object? obj) => obj is SessionsOpenProgressStatus other && Equals(other); + public override bool Equals(object? obj) => obj is HistoryRewindUnavailableReason other && Equals(other); /// - public bool Equals(SessionsOpenProgressStatus other) => string.Equals(Value, other.Value, StringComparison.OrdinalIgnoreCase); + public bool Equals(HistoryRewindUnavailableReason other) => string.Equals(Value, other.Value, StringComparison.OrdinalIgnoreCase); /// public override int GetHashCode() => StringComparer.OrdinalIgnoreCase.GetHashCode(Value); @@ -14183,74 +23932,62 @@ public SessionsOpenProgressStatus(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 SessionsOpenProgressStatus Read(ref Utf8JsonReader reader, Type typeToConvert, JsonSerializerOptions options) + public override HistoryRewindUnavailableReason 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) + public override void Write(Utf8JsonWriter writer, HistoryRewindUnavailableReason value, JsonSerializerOptions options) { - GeneratedStringEnumJson.WriteValue(writer, value.Value, typeof(SessionsOpenProgressStatus)); + GeneratedStringEnumJson.WriteValue(writer, value.Value, typeof(HistoryRewindUnavailableReason)); } } } -/// Handoff step. +/// Whether task execution is synchronously awaited or managed in the background. [Experimental(Diagnostics.Experimental)] [JsonConverter(typeof(Converter))] [DebuggerDisplay("{Value,nq}")] -public readonly struct SessionsOpenProgressStep : IEquatable +public readonly struct TaskExecutionMode : 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 SessionsOpenProgressStep(string value) + public TaskExecutionMode(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; - /// 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"); + /// The task was started with synchronous waiting. + public static TaskExecutionMode Sync { get; } = new("sync"); - /// Persisting the newly-created local session to disk. - public static SessionsOpenProgressStep SaveSession { get; } = new("save-session"); + /// The task is managed in the background. + public static TaskExecutionMode Background { get; } = new("background"); - /// 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 equivalent. + public static bool operator ==(TaskExecutionMode left, TaskExecutionMode right) => left.Equals(right); - /// Returns a value indicating whether two instances are not equivalent. - public static bool operator !=(SessionsOpenProgressStep left, SessionsOpenProgressStep right) => !(left == right); + /// Returns a value indicating whether two instances are not equivalent. + public static bool operator !=(TaskExecutionMode left, TaskExecutionMode right) => !(left == right); /// - public override bool Equals(object? obj) => obj is SessionsOpenProgressStep other && Equals(other); + public override bool Equals(object? obj) => obj is TaskExecutionMode other && Equals(other); /// - public bool Equals(SessionsOpenProgressStep other) => string.Equals(Value, other.Value, StringComparison.OrdinalIgnoreCase); + public bool Equals(TaskExecutionMode other) => string.Equals(Value, other.Value, StringComparison.OrdinalIgnoreCase); /// public override int GetHashCode() => StringComparer.OrdinalIgnoreCase.GetHashCode(Value); @@ -14258,71 +23995,71 @@ public SessionsOpenProgressStep(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 SessionsOpenProgressStep Read(ref Utf8JsonReader reader, Type typeToConvert, JsonSerializerOptions options) + public override TaskExecutionMode 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) + public override void Write(Utf8JsonWriter writer, TaskExecutionMode value, JsonSerializerOptions options) { - GeneratedStringEnumJson.WriteValue(writer, value.Value, typeof(SessionsOpenProgressStep)); + GeneratedStringEnumJson.WriteValue(writer, value.Value, typeof(TaskExecutionMode)); } } } -/// Outcome of the open request. +/// Current lifecycle status of the task. [Experimental(Diagnostics.Experimental)] [JsonConverter(typeof(Converter))] [DebuggerDisplay("{Value,nq}")] -public readonly struct SessionsOpenStatus : 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 SessionsOpenStatus(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; - /// A new session was created. - public static SessionsOpenStatus Created { get; } = new("created"); + /// The task is actively executing. + public static TaskStatus Running { get; } = new("running"); - /// An existing session was loaded or reattached. - public static SessionsOpenStatus Resumed { get; } = new("resumed"); + /// The task is waiting for additional input. + public static TaskStatus Idle { get; } = new("idle"); - /// No matching persisted session was found. - public static SessionsOpenStatus NotFound { get; } = new("not_found"); + /// The task finished successfully. + public static TaskStatus Completed { get; } = new("completed"); - /// Connected to an existing remote session. - public static SessionsOpenStatus Connected { get; } = new("connected"); + /// The task finished with an error. + public static TaskStatus Failed { get; } = new("failed"); - /// Remote session was handed off to a new local session. - public static SessionsOpenStatus HandedOff { get; } = new("handed_off"); + /// 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 ==(SessionsOpenStatus left, SessionsOpenStatus right) => left.Equals(right); + /// 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 !=(SessionsOpenStatus left, SessionsOpenStatus right) => !(left == 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 SessionsOpenStatus other && Equals(other); + public override bool Equals(object? obj) => obj is TaskStatus other && Equals(other); /// - public bool Equals(SessionsOpenStatus 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); @@ -14330,62 +24067,62 @@ public SessionsOpenStatus(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 SessionsOpenStatus 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, SessionsOpenStatus value, JsonSerializerOptions options) + public override void Write(Utf8JsonWriter writer, TaskStatus value, JsonSerializerOptions options) { - GeneratedStringEnumJson.WriteValue(writer, value.Value, typeof(SessionsOpenStatus)); + GeneratedStringEnumJson.WriteValue(writer, value.Value, typeof(TaskStatus)); } } } -/// Neutral SDK discriminator for the connected remote session kind. +/// 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 ConnectedRemoteSessionMetadataKind : 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 ConnectedRemoteSessionMetadataKind(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; - /// Remote CLI session. - public static ConnectedRemoteSessionMetadataKind RemoteSession { get; } = new("remote-session"); + /// The shell runs in a managed PTY session. + public static TaskShellInfoAttachmentMode Attached { get; } = new("attached"); - /// GitHub Copilot coding agent session. - public static ConnectedRemoteSessionMetadataKind CodingAgent { get; } = new("coding-agent"); + /// 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 ==(ConnectedRemoteSessionMetadataKind left, ConnectedRemoteSessionMetadataKind 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 !=(ConnectedRemoteSessionMetadataKind left, ConnectedRemoteSessionMetadataKind 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 ConnectedRemoteSessionMetadataKind other && Equals(other); + public override bool Equals(object? obj) => obj is TaskShellInfoAttachmentMode other && Equals(other); /// - public bool Equals(ConnectedRemoteSessionMetadataKind 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); @@ -14393,65 +24130,62 @@ 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 TaskShellInfoAttachmentMode 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, TaskShellInfoAttachmentMode value, JsonSerializerOptions options) { - GeneratedStringEnumJson.WriteValue(writer, value.Value, typeof(ConnectedRemoteSessionMetadataKind)); + GeneratedStringEnumJson.WriteValue(writer, value.Value, typeof(TaskShellInfoAttachmentMode)); } } } -/// Which session sources to include. Defaults to `local` for backward compatibility. +/// Consumer allowed to call an MCP tool. [Experimental(Diagnostics.Experimental)] [JsonConverter(typeof(Converter))] [DebuggerDisplay("{Value,nq}")] -public readonly struct SessionSource : 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 SessionSource(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; - /// Return only local sessions. - public static SessionSource Local { get; } = new("local"); - - /// Return only remote sessions. - public static SessionSource Remote { get; } = new("remote"); + /// The model may call the tool. + public static McpToolUiVisibility Model { get; } = new("model"); - /// Return both local and remote sessions. - public static SessionSource All { get; } = new("all"); + /// 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 ==(SessionSource left, SessionSource 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 !=(SessionSource left, SessionSource 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 SessionSource other && Equals(other); + public override bool Equals(object? obj) => obj is McpToolUiVisibility other && Equals(other); /// - public bool Equals(SessionSource 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); @@ -14459,71 +24193,65 @@ public SessionSource(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 SessionSource 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, SessionSource value, JsonSerializerOptions options) + public override void Write(Utf8JsonWriter writer, McpToolUiVisibility value, JsonSerializerOptions options) { - GeneratedStringEnumJson.WriteValue(writer, value.Value, typeof(SessionSource)); + GeneratedStringEnumJson.WriteValue(writer, value.Value, typeof(McpToolUiVisibility)); } } } -/// Kind of attention required when status === "attention". Meaningful only when status === "attention". +/// 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 AgentRegistryLiveTargetEntryAttentionKind : 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 AgentRegistryLiveTargetEntryAttentionKind(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; - /// 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"); + /// The sampling inference completed and produced a result. + public static McpSamplingExecutionAction Success { get; } = new("success"); - /// Session is waiting on an elicitation prompt. - public static AgentRegistryLiveTargetEntryAttentionKind Elicitation { get; } = new("elicitation"); + /// The sampling inference failed or was rejected. + public static McpSamplingExecutionAction Failure { get; } = new("failure"); - /// Session is waiting for free-form user input. - public static AgentRegistryLiveTargetEntryAttentionKind UserInput { get; } = new("user_input"); + /// 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 ==(AgentRegistryLiveTargetEntryAttentionKind left, AgentRegistryLiveTargetEntryAttentionKind 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 !=(AgentRegistryLiveTargetEntryAttentionKind left, AgentRegistryLiveTargetEntryAttentionKind 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 AgentRegistryLiveTargetEntryAttentionKind other && Equals(other); + public override bool Equals(object? obj) => obj is McpSamplingExecutionAction other && Equals(other); /// - public bool Equals(AgentRegistryLiveTargetEntryAttentionKind 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); @@ -14531,62 +24259,62 @@ 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 McpSamplingExecutionAction 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, McpSamplingExecutionAction value, JsonSerializerOptions options) { - GeneratedStringEnumJson.WriteValue(writer, value.Value, typeof(AgentRegistryLiveTargetEntryAttentionKind)); + GeneratedStringEnumJson.WriteValue(writer, value.Value, typeof(McpSamplingExecutionAction)); } } } -/// Process kind tag for the registry entry. +/// 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 AgentRegistryLiveTargetEntryKind : 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 AgentRegistryLiveTargetEntryKind(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; - /// Interactive Copilot CLI exposing a UI server (legacy/normal CLI process). - public static AgentRegistryLiveTargetEntryKind UiServer { get; } = new("ui-server"); + /// Treat MCP server environment values as literal strings. + public static McpSetEnvValueModeDetails Direct { get; } = new("direct"); - /// Headless `--server --managed-server` child spawned by a controller. - public static AgentRegistryLiveTargetEntryKind ManagedServer { get; } = new("managed-server"); + /// 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 ==(AgentRegistryLiveTargetEntryKind left, AgentRegistryLiveTargetEntryKind 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 !=(AgentRegistryLiveTargetEntryKind left, AgentRegistryLiveTargetEntryKind 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 AgentRegistryLiveTargetEntryKind other && Equals(other); + public override bool Equals(object? obj) => obj is McpSetEnvValueModeDetails other && Equals(other); /// - public bool Equals(AgentRegistryLiveTargetEntryKind 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); @@ -14594,62 +24322,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 McpSetEnvValueModeDetails 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, McpSetEnvValueModeDetails value, JsonSerializerOptions options) { - GeneratedStringEnumJson.WriteValue(writer, value.Value, typeof(AgentRegistryLiveTargetEntryKind)); + GeneratedStringEnumJson.WriteValue(writer, value.Value, typeof(McpSetEnvValueModeDetails)); } } } -/// How the most recent turn ended (clean vs aborted). Lets the renderer distinguish done from done_cancelled. +/// OAuth grant type override for this login. [Experimental(Diagnostics.Experimental)] [JsonConverter(typeof(Converter))] [DebuggerDisplay("{Value,nq}")] -public readonly struct AgentRegistryLiveTargetEntryLastTerminalEvent : 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 AgentRegistryLiveTargetEntryLastTerminalEvent(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; - /// Last turn ended cleanly (model returned a final assistant message). - public static AgentRegistryLiveTargetEntryLastTerminalEvent TurnEnd { get; } = new("turn_end"); + /// Interactive browser-based OAuth flow using an authorization code, typically with PKCE. + public static McpOauthLoginGrantType AuthorizationCode { get; } = new("authorization_code"); - /// Last turn was aborted (e.g. user interrupted). - public static AgentRegistryLiveTargetEntryLastTerminalEvent Abort { get; } = new("abort"); + /// 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 ==(AgentRegistryLiveTargetEntryLastTerminalEvent left, AgentRegistryLiveTargetEntryLastTerminalEvent 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 !=(AgentRegistryLiveTargetEntryLastTerminalEvent left, AgentRegistryLiveTargetEntryLastTerminalEvent 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 AgentRegistryLiveTargetEntryLastTerminalEvent other && Equals(other); + public override bool Equals(object? obj) => obj is McpOauthLoginGrantType other && Equals(other); /// - public bool Equals(AgentRegistryLiveTargetEntryLastTerminalEvent 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); @@ -14657,68 +24385,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 McpOauthLoginGrantType 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, McpOauthLoginGrantType value, JsonSerializerOptions options) { - GeneratedStringEnumJson.WriteValue(writer, value.Value, typeof(AgentRegistryLiveTargetEntryLastTerminalEvent)); + GeneratedStringEnumJson.WriteValue(writer, value.Value, typeof(McpOauthLoginGrantType)); } } } -/// Coarse lifecycle status of the foreground session. +/// Why a passive MCP OAuth probe determined authentication is needed. [Experimental(Diagnostics.Experimental)] [JsonConverter(typeof(Converter))] [DebuggerDisplay("{Value,nq}")] -public readonly struct AgentRegistryLiveTargetEntryStatus : IEquatable +public readonly struct McpOauthProbeNeedsAuthReason : 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 McpOauthProbeNeedsAuthReason(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"); + /// No token was sent and the server requires authentication. + public static McpOauthProbeNeedsAuthReason Initial { get; } = new("initial"); - /// Last turn completed successfully. - public static AgentRegistryLiveTargetEntryStatus Done { get; } = new("done"); + /// A cached token was sent and rejected. + public static McpOauthProbeNeedsAuthReason Refresh { get; } = new("refresh"); - /// Session needs user attention (see attentionKind for the specific reason). - public static AgentRegistryLiveTargetEntryStatus Attention { get; } = new("attention"); + /// The server returned a 403 insufficient_scope challenge, indicating additional scopes or audience are needed. + public static McpOauthProbeNeedsAuthReason Upscope { get; } = new("upscope"); - /// 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 ==(McpOauthProbeNeedsAuthReason left, McpOauthProbeNeedsAuthReason 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 !=(McpOauthProbeNeedsAuthReason left, McpOauthProbeNeedsAuthReason right) => !(left == right); /// - public override bool Equals(object? obj) => obj is AgentRegistryLiveTargetEntryStatus other && Equals(other); + public override bool Equals(object? obj) => obj is McpOauthProbeNeedsAuthReason other && Equals(other); /// - public bool Equals(AgentRegistryLiveTargetEntryStatus other) => string.Equals(Value, other.Value, StringComparison.OrdinalIgnoreCase); + public bool Equals(McpOauthProbeNeedsAuthReason other) => string.Equals(Value, other.Value, StringComparison.OrdinalIgnoreCase); /// public override int GetHashCode() => StringComparer.OrdinalIgnoreCase.GetHashCode(Value); @@ -14726,65 +24451,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 McpOauthProbeNeedsAuthReason 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, McpOauthProbeNeedsAuthReason value, JsonSerializerOptions options) { - GeneratedStringEnumJson.WriteValue(writer, value.Value, typeof(AgentRegistryLiveTargetEntryStatus)); + GeneratedStringEnumJson.WriteValue(writer, value.Value, typeof(McpOauthProbeNeedsAuthReason)); } } } -/// Categorized reason for log-open failure. +/// Allowed values for the `McpAppsSetHostContextDetailsAvailableDisplayMode` enumeration. [Experimental(Diagnostics.Experimental)] [JsonConverter(typeof(Converter))] [DebuggerDisplay("{Value,nq}")] -public readonly struct AgentRegistryLogCaptureOpenErrorReason : 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 AgentRegistryLogCaptureOpenErrorReason(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; - /// Filesystem permission denied opening the log file. - public static AgentRegistryLogCaptureOpenErrorReason Permission { get; } = new("permission"); + /// Rendered inline within the host conversation surface. + public static McpAppsSetHostContextDetailsAvailableDisplayMode Inline { get; } = new("inline"); - /// No space left on device. - public static AgentRegistryLogCaptureOpenErrorReason DiskFull { get; } = new("disk_full"); + /// Rendered as a fullscreen overlay. + public static McpAppsSetHostContextDetailsAvailableDisplayMode 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 McpAppsSetHostContextDetailsAvailableDisplayMode 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 ==(McpAppsSetHostContextDetailsAvailableDisplayMode left, McpAppsSetHostContextDetailsAvailableDisplayMode 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 !=(McpAppsSetHostContextDetailsAvailableDisplayMode left, McpAppsSetHostContextDetailsAvailableDisplayMode right) => !(left == right); /// - public override bool Equals(object? obj) => obj is AgentRegistryLogCaptureOpenErrorReason other && Equals(other); + public override bool Equals(object? obj) => obj is McpAppsSetHostContextDetailsAvailableDisplayMode other && Equals(other); /// - public bool Equals(AgentRegistryLogCaptureOpenErrorReason 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); @@ -14792,71 +24517,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 McpAppsSetHostContextDetailsAvailableDisplayMode 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, McpAppsSetHostContextDetailsAvailableDisplayMode value, JsonSerializerOptions options) { - GeneratedStringEnumJson.WriteValue(writer, value.Value, typeof(AgentRegistryLogCaptureOpenErrorReason)); + GeneratedStringEnumJson.WriteValue(writer, value.Value, typeof(McpAppsSetHostContextDetailsAvailableDisplayMode)); } } } -/// Which parameter field was invalid. Omitted when the rejection is not field-specific. +/// Current display mode (SEP-1865). [Experimental(Diagnostics.Experimental)] [JsonConverter(typeof(Converter))] [DebuggerDisplay("{Value,nq}")] -public readonly struct AgentRegistrySpawnValidationErrorField : 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 AgentRegistrySpawnValidationErrorField(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; - /// 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"); + /// Rendered inline within the host conversation surface. + public static McpAppsSetHostContextDetailsDisplayMode Inline { get; } = new("inline"); - /// The model parameter. - public static AgentRegistrySpawnValidationErrorField Model { get; } = new("model"); + /// Rendered as a fullscreen overlay. + public static McpAppsSetHostContextDetailsDisplayMode Fullscreen { get; } = new("fullscreen"); - /// The permissionMode parameter. - public static AgentRegistrySpawnValidationErrorField PermissionMode { get; } = new("permissionMode"); + /// Rendered as a picture-in-picture floating panel. + public static McpAppsSetHostContextDetailsDisplayMode Pip { get; } = new("pip"); - /// 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 ==(McpAppsSetHostContextDetailsDisplayMode left, McpAppsSetHostContextDetailsDisplayMode 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 !=(McpAppsSetHostContextDetailsDisplayMode left, McpAppsSetHostContextDetailsDisplayMode right) => !(left == right); /// - public override bool Equals(object? obj) => obj is AgentRegistrySpawnValidationErrorField other && Equals(other); + public override bool Equals(object? obj) => obj is McpAppsSetHostContextDetailsDisplayMode other && Equals(other); /// - public bool Equals(AgentRegistrySpawnValidationErrorField 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); @@ -14864,74 +24583,65 @@ 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 McpAppsSetHostContextDetailsDisplayMode 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, McpAppsSetHostContextDetailsDisplayMode value, JsonSerializerOptions options) { - GeneratedStringEnumJson.WriteValue(writer, value.Value, typeof(AgentRegistrySpawnValidationErrorField)); + GeneratedStringEnumJson.WriteValue(writer, value.Value, typeof(McpAppsSetHostContextDetailsDisplayMode)); } } } -/// Categorized reason for the rejection. Low-cardinality enum so telemetry can aggregate by reason without leaking raw paths or agent/model names. +/// Platform type for responsive design. [Experimental(Diagnostics.Experimental)] [JsonConverter(typeof(Converter))] [DebuggerDisplay("{Value,nq}")] -public readonly struct AgentRegistrySpawnValidationErrorReason : 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 AgentRegistrySpawnValidationErrorReason(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; - /// 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"); + /// Host runs in a web browser. + public static McpAppsSetHostContextDetailsPlatform Web { get; } = new("web"); - /// Requested model is not available to this session. - public static AgentRegistrySpawnValidationErrorReason UnknownModel { get; } = new("unknown-model"); + /// Host runs as a desktop application. + public static McpAppsSetHostContextDetailsPlatform Desktop { get; } = new("desktop"); - /// Caller asked for permissionMode='yolo' but the controller is not currently in allow-all mode. - public static AgentRegistrySpawnValidationErrorReason YoloNotAllowed { get; } = new("yolo-not-allowed"); + /// Host runs on a mobile device. + public static McpAppsSetHostContextDetailsPlatform Mobile { get; } = new("mobile"); - /// 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 ==(McpAppsSetHostContextDetailsPlatform left, McpAppsSetHostContextDetailsPlatform 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 !=(McpAppsSetHostContextDetailsPlatform left, McpAppsSetHostContextDetailsPlatform right) => !(left == right); /// - public override bool Equals(object? obj) => obj is AgentRegistrySpawnValidationErrorReason other && Equals(other); + public override bool Equals(object? obj) => obj is McpAppsSetHostContextDetailsPlatform other && Equals(other); /// - public bool Equals(AgentRegistrySpawnValidationErrorReason 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); @@ -14939,62 +24649,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 McpAppsSetHostContextDetailsPlatform 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, McpAppsSetHostContextDetailsPlatform value, JsonSerializerOptions options) { - GeneratedStringEnumJson.WriteValue(writer, value.Value, typeof(AgentRegistrySpawnValidationErrorReason)); + GeneratedStringEnumJson.WriteValue(writer, value.Value, typeof(McpAppsSetHostContextDetailsPlatform)); } } } -/// Permission posture for the new session. 'yolo' requires the controller-local session to currently be in allow-all mode. +/// UI theme preference per SEP-1865. [Experimental(Diagnostics.Experimental)] [JsonConverter(typeof(Converter))] [DebuggerDisplay("{Value,nq}")] -public readonly struct AgentRegistrySpawnPermissionMode : 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 AgentRegistrySpawnPermissionMode(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; - /// Standard permission posture (prompts for each request). - public static AgentRegistrySpawnPermissionMode Default { get; } = new("default"); + /// Light UI theme. + public static McpAppsSetHostContextDetailsTheme Light { get; } = new("light"); - /// Full allow-all (requires the controller-local session to currently be in allow-all mode). - public static AgentRegistrySpawnPermissionMode Yolo { get; } = new("yolo"); + /// Dark UI theme. + public static McpAppsSetHostContextDetailsTheme Dark { get; } = new("dark"); - /// 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 ==(McpAppsSetHostContextDetailsTheme left, McpAppsSetHostContextDetailsTheme 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 !=(McpAppsSetHostContextDetailsTheme left, McpAppsSetHostContextDetailsTheme right) => !(left == right); /// - public override bool Equals(object? obj) => obj is AgentRegistrySpawnPermissionMode other && Equals(other); + public override bool Equals(object? obj) => obj is McpAppsSetHostContextDetailsTheme other && Equals(other); /// - public bool Equals(AgentRegistrySpawnPermissionMode 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); @@ -15002,68 +24712,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 McpAppsSetHostContextDetailsTheme 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, McpAppsSetHostContextDetailsTheme value, JsonSerializerOptions options) { - GeneratedStringEnumJson.WriteValue(writer, value.Value, typeof(AgentRegistrySpawnPermissionMode)); + GeneratedStringEnumJson.WriteValue(writer, value.Value, typeof(McpAppsSetHostContextDetailsTheme)); } } } -/// The UI mode the agent was in when this message was sent. Defaults to the session's current mode. +/// Allowed values for the `McpAppsHostContextDetailsAvailableDisplayMode` enumeration. [Experimental(Diagnostics.Experimental)] [JsonConverter(typeof(Converter))] [DebuggerDisplay("{Value,nq}")] -public readonly struct SendAgentMode : 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 SendAgentMode(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; - /// 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"); + /// Rendered inline within the host conversation surface. + public static McpAppsHostContextDetailsAvailableDisplayMode Inline { get; } = new("inline"); - /// The agent is working autonomously toward task completion. - public static SendAgentMode Autopilot { get; } = new("autopilot"); + /// Rendered as a fullscreen overlay. + public static McpAppsHostContextDetailsAvailableDisplayMode Fullscreen { get; } = new("fullscreen"); - /// The agent is in shell-focused UI mode. - public static SendAgentMode Shell { get; } = new("shell"); + /// 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 ==(SendAgentMode left, SendAgentMode 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 !=(SendAgentMode left, SendAgentMode 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 SendAgentMode other && Equals(other); + public override bool Equals(object? obj) => obj is McpAppsHostContextDetailsAvailableDisplayMode other && Equals(other); /// - public bool Equals(SendAgentMode 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); @@ -15071,62 +24778,65 @@ 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 McpAppsHostContextDetailsAvailableDisplayMode 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, McpAppsHostContextDetailsAvailableDisplayMode value, JsonSerializerOptions options) { - GeneratedStringEnumJson.WriteValue(writer, value.Value, typeof(SendAgentMode)); + GeneratedStringEnumJson.WriteValue(writer, value.Value, typeof(McpAppsHostContextDetailsAvailableDisplayMode)); } } } -/// How to deliver the message. `enqueue` (default) appends to the message queue. `immediate` interjects during an in-progress turn. +/// Current display mode (SEP-1865). [Experimental(Diagnostics.Experimental)] [JsonConverter(typeof(Converter))] [DebuggerDisplay("{Value,nq}")] -public readonly struct SendMode : 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 SendMode(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; - /// Append the message to the normal session queue. - public static SendMode Enqueue { get; } = new("enqueue"); + /// Rendered inline within the host conversation surface. + public static McpAppsHostContextDetailsDisplayMode Inline { get; } = new("inline"); - /// Interject the message during the in-progress turn. - public static SendMode Immediate { get; } = new("immediate"); + /// Rendered as a fullscreen overlay. + public static McpAppsHostContextDetailsDisplayMode Fullscreen { get; } = new("fullscreen"); - /// Returns a value indicating whether two instances are equivalent. - public static bool operator ==(SendMode left, SendMode right) => left.Equals(right); + /// Rendered as a picture-in-picture floating panel. + public static McpAppsHostContextDetailsDisplayMode Pip { get; } = new("pip"); - /// 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 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 !=(McpAppsHostContextDetailsDisplayMode left, McpAppsHostContextDetailsDisplayMode right) => !(left == right); /// - public override bool Equals(object? obj) => obj is SendMode other && Equals(other); + public override bool Equals(object? obj) => obj is McpAppsHostContextDetailsDisplayMode other && Equals(other); /// - public bool Equals(SendMode 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); @@ -15134,65 +24844,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 McpAppsHostContextDetailsDisplayMode 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, McpAppsHostContextDetailsDisplayMode value, JsonSerializerOptions options) { - GeneratedStringEnumJson.WriteValue(writer, value.Value, typeof(SendMode)); + GeneratedStringEnumJson.WriteValue(writer, value.Value, typeof(McpAppsHostContextDetailsDisplayMode)); } } } -/// Log severity level. Determines how the message is displayed in the timeline. Defaults to "info". +/// Platform type for responsive design. [Experimental(Diagnostics.Experimental)] [JsonConverter(typeof(Converter))] [DebuggerDisplay("{Value,nq}")] -public readonly struct SessionLogLevel : 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 SessionLogLevel(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; - /// Informational message. - public static SessionLogLevel Info { get; } = new("info"); + /// Host runs in a web browser. + public static McpAppsHostContextDetailsPlatform Web { get; } = new("web"); - /// Warning message that may require attention. - public static SessionLogLevel Warning { get; } = new("warning"); + /// Host runs as a desktop application. + public static McpAppsHostContextDetailsPlatform Desktop { get; } = new("desktop"); - /// Error message describing a failure. - public static SessionLogLevel Error { get; } = new("error"); + /// 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 ==(SessionLogLevel left, SessionLogLevel 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 !=(SessionLogLevel left, SessionLogLevel 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 SessionLogLevel other && Equals(other); + public override bool Equals(object? obj) => obj is McpAppsHostContextDetailsPlatform other && Equals(other); /// - public bool Equals(SessionLogLevel 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); @@ -15200,77 +24910,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 McpAppsHostContextDetailsPlatform 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, McpAppsHostContextDetailsPlatform value, JsonSerializerOptions options) { - GeneratedStringEnumJson.WriteValue(writer, value.Value, typeof(SessionLogLevel)); + GeneratedStringEnumJson.WriteValue(writer, value.Value, typeof(McpAppsHostContextDetailsPlatform)); } } } -/// Authentication type. +/// UI theme preference per SEP-1865. [Experimental(Diagnostics.Experimental)] [JsonConverter(typeof(Converter))] [DebuggerDisplay("{Value,nq}")] -public readonly struct AuthInfoType : 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 AuthInfoType(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; - /// 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"); + /// Light UI theme. + public static McpAppsHostContextDetailsTheme Light { get; } = new("light"); - /// Authentication from a Copilot API token. - public static AuthInfoType CopilotApiToken { get; } = new("copilot-api-token"); + /// Dark UI theme. + public static McpAppsHostContextDetailsTheme Dark { get; } = new("dark"); - /// 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 ==(McpAppsHostContextDetailsTheme left, McpAppsHostContextDetailsTheme 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 !=(McpAppsHostContextDetailsTheme left, McpAppsHostContextDetailsTheme right) => !(left == right); /// - public override bool Equals(object? obj) => obj is AuthInfoType other && Equals(other); + public override bool Equals(object? obj) => obj is McpAppsHostContextDetailsTheme other && Equals(other); /// - public bool Equals(AuthInfoType 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); @@ -15278,68 +24973,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 McpAppsHostContextDetailsTheme 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, McpAppsHostContextDetailsTheme value, JsonSerializerOptions options) { - GeneratedStringEnumJson.WriteValue(writer, value.Value, typeof(AuthInfoType)); + GeneratedStringEnumJson.WriteValue(writer, value.Value, typeof(McpAppsHostContextDetailsTheme)); } } } -/// Source category for a collected debug bundle entry. +/// Transport to be used for provider requests. [Experimental(Diagnostics.Experimental)] [JsonConverter(typeof(Converter))] [DebuggerDisplay("{Value,nq}")] -public readonly struct DebugCollectLogsSource : 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 DebugCollectLogsSource(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; - /// Session event log. - public static DebugCollectLogsSource Events { get; } = new("events"); - - /// Process log for the session. - public static DebugCollectLogsSource ProcessLog { get; } = new("process-log"); - - /// Interactive shell log for the session. - public static DebugCollectLogsSource ShellLog { get; } = new("shell-log"); + /// HTTP request/streaming transport. + public static ProviderEndpointTransport Http { get; } = new("http"); - /// Caller-provided diagnostic entry. - public static DebugCollectLogsSource Additional { get; } = new("additional"); + /// WebSocket transport. + public static ProviderEndpointTransport Websockets { get; } = new("websockets"); - /// Returns a value indicating whether two instances are equivalent. - public static bool operator ==(DebugCollectLogsSource left, DebugCollectLogsSource 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 !=(DebugCollectLogsSource left, DebugCollectLogsSource 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 DebugCollectLogsSource other && Equals(other); + public override bool Equals(object? obj) => obj is ProviderEndpointTransport other && Equals(other); /// - public bool Equals(DebugCollectLogsSource 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); @@ -15347,62 +25036,65 @@ public DebugCollectLogsSource(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 DebugCollectLogsSource 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, DebugCollectLogsSource value, JsonSerializerOptions options) + public override void Write(Utf8JsonWriter writer, ProviderEndpointTransport value, JsonSerializerOptions options) { - GeneratedStringEnumJson.WriteValue(writer, value.Value, typeof(DebugCollectLogsSource)); + GeneratedStringEnumJson.WriteValue(writer, value.Value, typeof(ProviderEndpointTransport)); } } } -/// Destination kind that was written. +/// Provider family. Matches the `type` field of a BYOK provider config. [Experimental(Diagnostics.Experimental)] [JsonConverter(typeof(Converter))] [DebuggerDisplay("{Value,nq}")] -public readonly struct DebugCollectLogsResultKind : 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 DebugCollectLogsResultKind(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; - /// A .tgz archive was written. - public static DebugCollectLogsResultKind Archive { get; } = new("archive"); + /// OpenAI-compatible endpoint (use the OpenAI client library). + public static ProviderEndpointType Openai { get; } = new("openai"); - /// A directory containing redacted files was written. - public static DebugCollectLogsResultKind Directory { get; } = new("directory"); + /// Azure OpenAI endpoint (use the OpenAI client library with the Azure base URL). + public static ProviderEndpointType Azure { get; } = new("azure"); - /// Returns a value indicating whether two instances are equivalent. - public static bool operator ==(DebugCollectLogsResultKind left, DebugCollectLogsResultKind right) => left.Equals(right); + /// Anthropic endpoint (use the Anthropic client library). + public static ProviderEndpointType Anthropic { get; } = new("anthropic"); - /// Returns a value indicating whether two instances are not equivalent. - public static bool operator !=(DebugCollectLogsResultKind left, DebugCollectLogsResultKind right) => !(left == 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 !=(ProviderEndpointType left, ProviderEndpointType right) => !(left == right); /// - public override bool Equals(object? obj) => obj is DebugCollectLogsResultKind other && Equals(other); + public override bool Equals(object? obj) => obj is ProviderEndpointType other && Equals(other); /// - public bool Equals(DebugCollectLogsResultKind 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); @@ -15410,62 +25102,62 @@ public DebugCollectLogsResultKind(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 DebugCollectLogsResultKind 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, DebugCollectLogsResultKind value, JsonSerializerOptions options) + public override void Write(Utf8JsonWriter writer, ProviderEndpointType value, JsonSerializerOptions options) { - GeneratedStringEnumJson.WriteValue(writer, value.Value, typeof(DebugCollectLogsResultKind)); + GeneratedStringEnumJson.WriteValue(writer, value.Value, typeof(ProviderEndpointType)); } } } -/// Kind of caller-provided debug log entry. +/// Wire API to be used, when required for the provider type. [Experimental(Diagnostics.Experimental)] [JsonConverter(typeof(Converter))] [DebuggerDisplay("{Value,nq}")] -public readonly struct DebugCollectLogsEntryKind : 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 DebugCollectLogsEntryKind(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; - /// Include a single server-local file. - public static DebugCollectLogsEntryKind File { get; } = new("file"); + /// Classic chat-completions request shape. + public static ProviderEndpointWireApi Completions { get; } = new("completions"); - /// Include files from a server-local directory recursively. - public static DebugCollectLogsEntryKind Directory { get; } = new("directory"); + /// Newer responses request shape. + public static ProviderEndpointWireApi Responses { get; } = new("responses"); - /// Returns a value indicating whether two instances are equivalent. - public static bool operator ==(DebugCollectLogsEntryKind left, DebugCollectLogsEntryKind 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 !=(DebugCollectLogsEntryKind left, DebugCollectLogsEntryKind 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 DebugCollectLogsEntryKind other && Equals(other); + public override bool Equals(object? obj) => obj is ProviderEndpointWireApi other && Equals(other); /// - public bool Equals(DebugCollectLogsEntryKind 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); @@ -15473,62 +25165,62 @@ public DebugCollectLogsEntryKind(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 DebugCollectLogsEntryKind 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, DebugCollectLogsEntryKind value, JsonSerializerOptions options) + public override void Write(Utf8JsonWriter writer, ProviderEndpointWireApi value, JsonSerializerOptions options) { - GeneratedStringEnumJson.WriteValue(writer, value.Value, typeof(DebugCollectLogsEntryKind)); + GeneratedStringEnumJson.WriteValue(writer, value.Value, typeof(ProviderEndpointWireApi)); } } } -/// How a collected debug entry should be redacted before being staged. +/// Provider transport. Defaults to "http". [Experimental(Diagnostics.Experimental)] [JsonConverter(typeof(Converter))] [DebuggerDisplay("{Value,nq}")] -public readonly struct DebugCollectLogsRedaction : 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 DebugCollectLogsRedaction(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; - /// Redact the file as plain UTF-8 log text. - public static DebugCollectLogsRedaction PlainText { get; } = new("plain-text"); + /// HTTP request/streaming transport. + public static ProviderConfigTransport Http { get; } = new("http"); - /// 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"); + /// WebSocket transport. + public static ProviderConfigTransport Websockets { get; } = new("websockets"); - /// 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 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 !=(DebugCollectLogsRedaction left, DebugCollectLogsRedaction 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 DebugCollectLogsRedaction other && Equals(other); + public override bool Equals(object? obj) => obj is ProviderConfigTransport other && Equals(other); /// - public bool Equals(DebugCollectLogsRedaction 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); @@ -15536,62 +25228,65 @@ public DebugCollectLogsRedaction(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 DebugCollectLogsRedaction 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, DebugCollectLogsRedaction value, JsonSerializerOptions options) + public override void Write(Utf8JsonWriter writer, ProviderConfigTransport value, JsonSerializerOptions options) { - GeneratedStringEnumJson.WriteValue(writer, value.Value, typeof(DebugCollectLogsRedaction)); + GeneratedStringEnumJson.WriteValue(writer, value.Value, typeof(ProviderConfigTransport)); } } } -/// Cumulative resource ceiling that stopped a factory run. +/// Provider type. Defaults to "openai" for generic OpenAI-compatible APIs. [Experimental(Diagnostics.Experimental)] [JsonConverter(typeof(Converter))] [DebuggerDisplay("{Value,nq}")] -public readonly struct FactoryRunFailureKind : 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 FactoryRunFailureKind(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; - /// The run admitted the approved maximum total number of subagents. - public static FactoryRunFailureKind MaxTotalSubagents { get; } = new("maxTotalSubagents"); + /// Generic OpenAI-compatible API. + public static ProviderConfigType Openai { get; } = new("openai"); - /// The run reached the approved timeout deadline. - public static FactoryRunFailureKind Timeout { get; } = new("timeout"); + /// Azure OpenAI Service endpoint. + public static ProviderConfigType Azure { get; } = new("azure"); - /// Returns a value indicating whether two instances are equivalent. - public static bool operator ==(FactoryRunFailureKind left, FactoryRunFailureKind right) => left.Equals(right); + /// Anthropic API endpoint. + public static ProviderConfigType Anthropic { get; } = new("anthropic"); - /// Returns a value indicating whether two instances are not equivalent. - public static bool operator !=(FactoryRunFailureKind left, FactoryRunFailureKind right) => !(left == 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 !=(ProviderConfigType left, ProviderConfigType right) => !(left == right); /// - public override bool Equals(object? obj) => obj is FactoryRunFailureKind other && Equals(other); + public override bool Equals(object? obj) => obj is ProviderConfigType other && Equals(other); /// - public bool Equals(FactoryRunFailureKind 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); @@ -15599,74 +25294,62 @@ public FactoryRunFailureKind(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 FactoryRunFailureKind 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, FactoryRunFailureKind value, JsonSerializerOptions options) + public override void Write(Utf8JsonWriter writer, ProviderConfigType value, JsonSerializerOptions options) { - GeneratedStringEnumJson.WriteValue(writer, value.Value, typeof(FactoryRunFailureKind)); + GeneratedStringEnumJson.WriteValue(writer, value.Value, typeof(ProviderConfigType)); } } } -/// Current or terminal state of a factory run. +/// Wire API format (openai/azure only). Defaults to "completions". [Experimental(Diagnostics.Experimental)] [JsonConverter(typeof(Converter))] [DebuggerDisplay("{Value,nq}")] -public readonly struct FactoryRunStatus : 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 FactoryRunStatus(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; - /// 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"); + /// OpenAI Chat Completions wire format. + public static ProviderConfigWireApi Completions { get; } = new("completions"); - /// The factory body failed or reached a cumulative resource ceiling. - public static FactoryRunStatus Error { get; } = new("error"); + /// 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 ==(FactoryRunStatus left, FactoryRunStatus 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 !=(FactoryRunStatus left, FactoryRunStatus 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 FactoryRunStatus other && Equals(other); + public override bool Equals(object? obj) => obj is ProviderConfigWireApi other && Equals(other); /// - public bool Equals(FactoryRunStatus 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); @@ -15674,62 +25357,62 @@ public FactoryRunStatus(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 FactoryRunStatus 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, FactoryRunStatus value, JsonSerializerOptions options) + public override void Write(Utf8JsonWriter writer, ProviderConfigWireApi value, JsonSerializerOptions options) { - GeneratedStringEnumJson.WriteValue(writer, value.Value, typeof(FactoryRunStatus)); + GeneratedStringEnumJson.WriteValue(writer, value.Value, typeof(ProviderConfigWireApi)); } } } -/// Kind of factory progress line. +/// Allowed values for the `OptionsUpdateAdditionalContentExclusionPolicyScope` enumeration. [Experimental(Diagnostics.Experimental)] [JsonConverter(typeof(Converter))] [DebuggerDisplay("{Value,nq}")] -public readonly struct FactoryLogLineKind : 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 FactoryLogLineKind(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; - /// A narrator log line. - public static FactoryLogLineKind Log { get; } = new("log"); + /// The content exclusion policy applies to the current repository. + public static OptionsUpdateAdditionalContentExclusionPolicyScope Repo { get; } = new("repo"); - /// A named factory phase marker. - public static FactoryLogLineKind Phase { get; } = new("phase"); + /// 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 ==(FactoryLogLineKind left, FactoryLogLineKind 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 !=(FactoryLogLineKind left, FactoryLogLineKind 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 FactoryLogLineKind other && Equals(other); + public override bool Equals(object? obj) => obj is OptionsUpdateAdditionalContentExclusionPolicyScope other && Equals(other); /// - public bool Equals(FactoryLogLineKind 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); @@ -15737,62 +25420,62 @@ public FactoryLogLineKind(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 FactoryLogLineKind 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, FactoryLogLineKind value, JsonSerializerOptions options) + public override void Write(Utf8JsonWriter writer, OptionsUpdateAdditionalContentExclusionPolicyScope value, JsonSerializerOptions options) { - GeneratedStringEnumJson.WriteValue(writer, value.Value, typeof(FactoryLogLineKind)); + GeneratedStringEnumJson.WriteValue(writer, value.Value, typeof(OptionsUpdateAdditionalContentExclusionPolicyScope)); } } } -/// Allowed values for the `WorkspacesWorkspaceDetailsHostType` enumeration. +/// 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 WorkspacesWorkspaceDetailsHostType : 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 WorkspacesWorkspaceDetailsHostType(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; - /// Workspace repository is hosted on GitHub. - public static WorkspacesWorkspaceDetailsHostType GitHub { get; } = new("github"); + /// Use the model's default context tier and its standard token limits / pricing. + public static OptionsUpdateContextTier Default { get; } = new("default"); - /// Workspace repository is hosted on Azure DevOps. - public static WorkspacesWorkspaceDetailsHostType Ado { get; } = new("ado"); + /// 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 ==(WorkspacesWorkspaceDetailsHostType left, WorkspacesWorkspaceDetailsHostType 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 !=(WorkspacesWorkspaceDetailsHostType left, WorkspacesWorkspaceDetailsHostType 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 WorkspacesWorkspaceDetailsHostType other && Equals(other); + public override bool Equals(object? obj) => obj is OptionsUpdateContextTier other && Equals(other); /// - public bool Equals(WorkspacesWorkspaceDetailsHostType 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); @@ -15800,68 +25483,62 @@ 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 OptionsUpdateContextTier 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, OptionsUpdateContextTier value, JsonSerializerOptions options) { - GeneratedStringEnumJson.WriteValue(writer, value.Value, typeof(WorkspacesWorkspaceDetailsHostType)); + GeneratedStringEnumJson.WriteValue(writer, value.Value, typeof(OptionsUpdateContextTier)); } } } -/// Type of change represented by this file diff. +/// 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 WorkspaceDiffFileChangeType : 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 WorkspaceDiffFileChangeType(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; - /// The file was added. - public static WorkspaceDiffFileChangeType Added { get; } = new("added"); - - /// The file was modified. - public static WorkspaceDiffFileChangeType Modified { get; } = new("modified"); - - /// The file was deleted. - public static WorkspaceDiffFileChangeType Deleted { get; } = new("deleted"); + /// Pass MCP server environment values as literal strings. + public static OptionsUpdateEnvValueMode Direct { get; } = new("direct"); - /// The file was renamed. - public static WorkspaceDiffFileChangeType Renamed { get; } = new("renamed"); + /// 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 ==(WorkspaceDiffFileChangeType left, WorkspaceDiffFileChangeType 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 !=(WorkspaceDiffFileChangeType left, WorkspaceDiffFileChangeType 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 WorkspaceDiffFileChangeType other && Equals(other); + public override bool Equals(object? obj) => obj is OptionsUpdateEnvValueMode other && Equals(other); /// - public bool Equals(WorkspaceDiffFileChangeType 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); @@ -15869,65 +25546,65 @@ 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 OptionsUpdateEnvValueMode 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, OptionsUpdateEnvValueMode value, JsonSerializerOptions options) { - GeneratedStringEnumJson.WriteValue(writer, value.Value, typeof(WorkspaceDiffFileChangeType)); + GeneratedStringEnumJson.WriteValue(writer, value.Value, typeof(OptionsUpdateEnvValueMode)); } } } -/// Diff mode requested by the client. +/// Reasoning summary mode for supported model clients. [Experimental(Diagnostics.Experimental)] [JsonConverter(typeof(Converter))] [DebuggerDisplay("{Value,nq}")] -public readonly struct WorkspaceDiffMode : 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 WorkspaceDiffMode(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; - /// Return staged, unstaged, and untracked working tree changes. - public static WorkspaceDiffMode Unstaged { get; } = new("unstaged"); + /// Do not request reasoning summaries from the model. + public static OptionsUpdateReasoningSummary None { get; } = new("none"); - /// Return changes compared with the default branch. - public static WorkspaceDiffMode Branch { get; } = new("branch"); + /// Request a concise summary of model reasoning. + public static OptionsUpdateReasoningSummary Concise { get; } = new("concise"); - /// Return the cumulative diff of files Copilot changed this session (used in non-git workspaces). - public static WorkspaceDiffMode Session { get; } = new("session"); + /// Request a detailed summary of model reasoning. + public static OptionsUpdateReasoningSummary Detailed { get; } = new("detailed"); - /// 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 ==(OptionsUpdateReasoningSummary left, OptionsUpdateReasoningSummary 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 !=(OptionsUpdateReasoningSummary left, OptionsUpdateReasoningSummary right) => !(left == right); /// - public override bool Equals(object? obj) => obj is WorkspaceDiffMode other && Equals(other); + public override bool Equals(object? obj) => obj is OptionsUpdateReasoningSummary other && Equals(other); /// - public bool Equals(WorkspaceDiffMode 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); @@ -15935,62 +25612,77 @@ 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 OptionsUpdateReasoningSummary 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, OptionsUpdateReasoningSummary value, JsonSerializerOptions options) { - GeneratedStringEnumJson.WriteValue(writer, value.Value, typeof(WorkspaceDiffMode)); + GeneratedStringEnumJson.WriteValue(writer, value.Value, typeof(OptionsUpdateReasoningSummary)); } } } -/// Whether task execution is synchronously awaited or managed in the background. +/// Origin of the sandbox choice supplied by an internal client. [Experimental(Diagnostics.Experimental)] [JsonConverter(typeof(Converter))] [DebuggerDisplay("{Value,nq}")] -public readonly struct TaskExecutionMode : IEquatable +public readonly struct SandboxConfigSource : 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 SandboxConfigSource(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 client applied the default because no sandbox preference was configured. + public static SandboxConfigSource NeverConfigured { get; } = new("never_configured"); - /// The task is managed in the background. - public static TaskExecutionMode Background { get; } = new("background"); + /// The user's persisted settings enabled the sandbox. + public static SandboxConfigSource UserEnabled { get; } = new("user_enabled"); - /// Returns a value indicating whether two instances are equivalent. - public static bool operator ==(TaskExecutionMode left, TaskExecutionMode right) => left.Equals(right); + /// The user's persisted settings disabled the sandbox. + public static SandboxConfigSource UserDisabled { get; } = new("user_disabled"); - /// Returns a value indicating whether two instances are not equivalent. - public static bool operator !=(TaskExecutionMode left, TaskExecutionMode right) => !(left == right); + /// A command-line flag selected the sandbox state for this session. + public static SandboxConfigSource SessionFlag { get; } = new("session_flag"); + + /// The user disabled the sandbox for the current session. + public static SandboxConfigSource SessionDisabled { get; } = new("session_disabled"); + + /// The client disabled the sandbox because the host cannot enforce it. + public static SandboxConfigSource UnsupportedHost { get; } = new("unsupported_host"); + + /// A repository policy selected the sandbox state. + public static SandboxConfigSource RepositoryPolicy { get; } = new("repository_policy"); + + /// Returns a value indicating whether two instances are equivalent. + public static bool operator ==(SandboxConfigSource left, SandboxConfigSource right) => left.Equals(right); + + /// Returns a value indicating whether two instances are not equivalent. + public static bool operator !=(SandboxConfigSource left, SandboxConfigSource right) => !(left == right); /// - public override bool Equals(object? obj) => obj is TaskExecutionMode other && Equals(other); + public override bool Equals(object? obj) => obj is SandboxConfigSource other && Equals(other); /// - public bool Equals(TaskExecutionMode other) => string.Equals(Value, other.Value, StringComparison.OrdinalIgnoreCase); + public bool Equals(SandboxConfigSource other) => string.Equals(Value, other.Value, StringComparison.OrdinalIgnoreCase); /// public override int GetHashCode() => StringComparer.OrdinalIgnoreCase.GetHashCode(Value); @@ -15998,71 +25690,89 @@ 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 SandboxConfigSource 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, SandboxConfigSource value, JsonSerializerOptions options) { - GeneratedStringEnumJson.WriteValue(writer, value.Value, typeof(TaskExecutionMode)); + GeneratedStringEnumJson.WriteValue(writer, value.Value, typeof(SandboxConfigSource)); } } } -/// Current lifecycle status of the task. +/// Session capability enabled for this session. [Experimental(Diagnostics.Experimental)] [JsonConverter(typeof(Converter))] [DebuggerDisplay("{Value,nq}")] -public readonly struct TaskStatus : 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 TaskStatus(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 task is actively executing. - public static TaskStatus Running { get; } = new("running"); + /// TUI-specific prompt hints such as keyboard shortcuts. + public static SessionCapability TuiHints { get; } = new("tui-hints"); - /// The task is waiting for additional input. - public static TaskStatus Idle { get; } = new("idle"); + /// Plan-mode handling and instructions. + public static SessionCapability PlanMode { get; } = new("plan-mode"); - /// The task finished successfully. - public static TaskStatus Completed { get; } = new("completed"); + /// Memory tool and memories prompt section. + public static SessionCapability Memory { get; } = new("memory"); - /// The task finished with an error. - public static TaskStatus Failed { get; } = new("failed"); + /// Copilot CLI documentation tool and prompt section. + public static SessionCapability CliDocumentation { get; } = new("cli-documentation"); - /// The task was cancelled before completion. - public static TaskStatus Cancelled { get; } = new("cancelled"); + /// Interactive ask_user tool support. + public static SessionCapability AskUser { get; } = new("ask-user"); - /// Returns a value indicating whether two instances are equivalent. - public static bool operator ==(TaskStatus left, TaskStatus right) => left.Equals(right); + /// Interactive CLI identity and behavior. + public static SessionCapability InteractiveMode { get; } = new("interactive-mode"); - /// Returns a value indicating whether two instances are not equivalent. - public static bool operator !=(TaskStatus left, TaskStatus right) => !(left == right); + /// 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"); + + /// Host-provided canvas rendering support. + public static SessionCapability CanvasRenderer { get; } = new("canvas-renderer"); + + /// 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 TaskStatus other && Equals(other); + public override bool Equals(object? obj) => obj is SessionCapability other && Equals(other); /// - public bool Equals(TaskStatus 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); @@ -16070,62 +25780,62 @@ 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 SessionCapability 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, SessionCapability value, JsonSerializerOptions options) { - GeneratedStringEnumJson.WriteValue(writer, value.Value, typeof(TaskStatus)); + GeneratedStringEnumJson.WriteValue(writer, value.Value, typeof(SessionCapability)); } } } -/// Whether the shell runs inside a managed PTY session or as an independent background process. +/// Controls automatic non-interactive profile loading where supported. Explicit initScripts are unaffected. [Experimental(Diagnostics.Experimental)] [JsonConverter(typeof(Converter))] [DebuggerDisplay("{Value,nq}")] -public readonly struct TaskShellInfoAttachmentMode : 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 TaskShellInfoAttachmentMode(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; - /// The shell runs in a managed PTY session. - public static TaskShellInfoAttachmentMode Attached { get; } = new("attached"); + /// Disable automatic non-interactive profile loading. Explicit initScripts still run. + public static ShellInitProfile None { get; } = new("none"); - /// The shell runs as an independent background process. - public static TaskShellInfoAttachmentMode Detached { get; } = new("detached"); + /// 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 ==(TaskShellInfoAttachmentMode left, TaskShellInfoAttachmentMode 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 !=(TaskShellInfoAttachmentMode left, TaskShellInfoAttachmentMode 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 TaskShellInfoAttachmentMode other && Equals(other); + public override bool Equals(object? obj) => obj is ShellInitProfile other && Equals(other); /// - public bool Equals(TaskShellInfoAttachmentMode 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); @@ -16133,62 +25843,62 @@ 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 ShellInitProfile 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, ShellInitProfile value, JsonSerializerOptions options) { - GeneratedStringEnumJson.WriteValue(writer, value.Value, typeof(TaskShellInfoAttachmentMode)); + GeneratedStringEnumJson.WriteValue(writer, value.Value, typeof(ShellInitProfile)); } } } -/// Consumer allowed to call an MCP tool. +/// Supported built-in shells for initialization scripts. [Experimental(Diagnostics.Experimental)] [JsonConverter(typeof(Converter))] [DebuggerDisplay("{Value,nq}")] -public readonly struct McpToolUiVisibility : 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 McpToolUiVisibility(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; - /// The model may call the tool. - public static McpToolUiVisibility Model { get; } = new("model"); + /// Source the script in the built-in Bash shell on macOS and Linux. + public static ShellInitScriptShell Bash { get; } = new("bash"); - /// An MCP App view may call the tool. - public static McpToolUiVisibility App { get; } = new("app"); + /// 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 ==(McpToolUiVisibility left, McpToolUiVisibility 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 !=(McpToolUiVisibility left, McpToolUiVisibility 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 McpToolUiVisibility other && Equals(other); + public override bool Equals(object? obj) => obj is ShellInitScriptShell other && Equals(other); /// - public bool Equals(McpToolUiVisibility 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); @@ -16196,65 +25906,62 @@ public McpToolUiVisibility(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 McpToolUiVisibility 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, McpToolUiVisibility value, JsonSerializerOptions options) + public override void Write(Utf8JsonWriter writer, ShellInitScriptShell value, JsonSerializerOptions options) { - GeneratedStringEnumJson.WriteValue(writer, value.Value, typeof(McpToolUiVisibility)); + GeneratedStringEnumJson.WriteValue(writer, value.Value, typeof(ShellInitScriptShell)); } } } -/// 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. +/// Controls how availableTools (allowlist) and excludedTools (denylist) combine when both are set. [Experimental(Diagnostics.Experimental)] [JsonConverter(typeof(Converter))] [DebuggerDisplay("{Value,nq}")] -public readonly struct McpSamplingExecutionAction : 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 McpSamplingExecutionAction(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; - /// 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"); + /// 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"); - /// The sampling inference was cancelled before completion. - public static McpSamplingExecutionAction Cancelled { get; } = new("cancelled"); + /// 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 ==(McpSamplingExecutionAction left, McpSamplingExecutionAction 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 !=(McpSamplingExecutionAction left, McpSamplingExecutionAction 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 McpSamplingExecutionAction other && Equals(other); + public override bool Equals(object? obj) => obj is OptionsUpdateToolFilterPrecedence other && Equals(other); /// - public bool Equals(McpSamplingExecutionAction 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); @@ -16262,62 +25969,68 @@ 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 OptionsUpdateToolFilterPrecedence 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, OptionsUpdateToolFilterPrecedence value, JsonSerializerOptions options) { - GeneratedStringEnumJson.WriteValue(writer, value.Value, typeof(McpSamplingExecutionAction)); + GeneratedStringEnumJson.WriteValue(writer, value.Value, typeof(OptionsUpdateToolFilterPrecedence)); } } } -/// 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". +/// 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 McpSetEnvValueModeDetails : 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 McpSetEnvValueModeDetails(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; - /// Treat MCP server environment values as literal strings. - public static McpSetEnvValueModeDetails Direct { get; } = new("direct"); + /// Extension discovered from the current project's .github/extensions directory. + public static ExtensionSource Project { get; } = new("project"); - /// Treat MCP server environment values as host-side references to resolve before launch. - public static McpSetEnvValueModeDetails Indirect { get; } = new("indirect"); + /// Extension discovered from the user's ~/.copilot/extensions directory. + public static ExtensionSource User { get; } = new("user"); - /// Returns a value indicating whether two instances are equivalent. - public static bool operator ==(McpSetEnvValueModeDetails left, McpSetEnvValueModeDetails right) => left.Equals(right); + /// Extension contributed by an installed plugin. + public static ExtensionSource Plugin { get; } = new("plugin"); - /// Returns a value indicating whether two instances are not equivalent. - public static bool operator !=(McpSetEnvValueModeDetails left, McpSetEnvValueModeDetails right) => !(left == right); + /// 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 ==(ExtensionSource left, ExtensionSource right) => left.Equals(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 McpSetEnvValueModeDetails other && Equals(other); + public override bool Equals(object? obj) => obj is ExtensionSource other && Equals(other); /// - public bool Equals(McpSetEnvValueModeDetails 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); @@ -16325,62 +26038,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 ExtensionSource 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, ExtensionSource value, JsonSerializerOptions options) { - GeneratedStringEnumJson.WriteValue(writer, value.Value, typeof(McpSetEnvValueModeDetails)); + GeneratedStringEnumJson.WriteValue(writer, value.Value, typeof(ExtensionSource)); } } } -/// OAuth grant type override for this login. +/// Current status: running, disabled, failed, or starting. [Experimental(Diagnostics.Experimental)] [JsonConverter(typeof(Converter))] [DebuggerDisplay("{Value,nq}")] -public readonly struct McpOauthLoginGrantType : 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 McpOauthLoginGrantType(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; - /// Interactive browser-based OAuth flow using an authorization code, typically with PKCE. - public static McpOauthLoginGrantType AuthorizationCode { get; } = new("authorization_code"); + /// The extension process is running. + public static ExtensionStatus Running { get; } = new("running"); - /// Headless OAuth flow where a confidential client authenticates directly with a client secret. - public static McpOauthLoginGrantType ClientCredentials { get; } = new("client_credentials"); + /// 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 ==(McpOauthLoginGrantType left, McpOauthLoginGrantType 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 !=(McpOauthLoginGrantType left, McpOauthLoginGrantType 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 McpOauthLoginGrantType other && Equals(other); + public override bool Equals(object? obj) => obj is ExtensionStatus other && Equals(other); /// - public bool Equals(McpOauthLoginGrantType 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); @@ -16388,65 +26107,65 @@ public McpOauthLoginGrantType(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 McpOauthLoginGrantType 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, McpOauthLoginGrantType value, JsonSerializerOptions options) + public override void Write(Utf8JsonWriter writer, ExtensionStatus value, JsonSerializerOptions options) { - GeneratedStringEnumJson.WriteValue(writer, value.Value, typeof(McpOauthLoginGrantType)); + GeneratedStringEnumJson.WriteValue(writer, value.Value, typeof(ExtensionStatus)); } } } -/// Allowed values for the `McpAppsSetHostContextDetailsAvailableDisplayMode` enumeration. +/// Type of GitHub reference. [Experimental(Diagnostics.Experimental)] [JsonConverter(typeof(Converter))] [DebuggerDisplay("{Value,nq}")] -public readonly struct McpAppsSetHostContextDetailsAvailableDisplayMode : 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 McpAppsSetHostContextDetailsAvailableDisplayMode(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; - /// Rendered inline within the host conversation surface. - public static McpAppsSetHostContextDetailsAvailableDisplayMode Inline { get; } = new("inline"); + /// GitHub issue reference. + public static PushAttachmentGitHubReferenceType Issue { get; } = new("issue"); - /// Rendered as a fullscreen overlay. - public static McpAppsSetHostContextDetailsAvailableDisplayMode Fullscreen { get; } = new("fullscreen"); + /// GitHub pull request reference. + public static PushAttachmentGitHubReferenceType Pr { get; } = new("pr"); - /// Rendered as a picture-in-picture floating panel. - public static McpAppsSetHostContextDetailsAvailableDisplayMode Pip { get; } = new("pip"); + /// GitHub discussion reference. + public static PushAttachmentGitHubReferenceType Discussion { get; } = new("discussion"); - /// 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 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 !=(McpAppsSetHostContextDetailsAvailableDisplayMode left, McpAppsSetHostContextDetailsAvailableDisplayMode 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 McpAppsSetHostContextDetailsAvailableDisplayMode other && Equals(other); + public override bool Equals(object? obj) => obj is PushAttachmentGitHubReferenceType other && Equals(other); /// - public bool Equals(McpAppsSetHostContextDetailsAvailableDisplayMode 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); @@ -16454,65 +26173,59 @@ 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 PushAttachmentGitHubReferenceType 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, PushAttachmentGitHubReferenceType value, JsonSerializerOptions options) { - GeneratedStringEnumJson.WriteValue(writer, value.Value, typeof(McpAppsSetHostContextDetailsAvailableDisplayMode)); + GeneratedStringEnumJson.WriteValue(writer, value.Value, typeof(PushAttachmentGitHubReferenceType)); } } } -/// Current display mode (SEP-1865). +/// Custom input-format kind. [Experimental(Diagnostics.Experimental)] [JsonConverter(typeof(Converter))] [DebuggerDisplay("{Value,nq}")] -public readonly struct McpAppsSetHostContextDetailsDisplayMode : IEquatable +public readonly struct BuiltinToolFormatType : 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 BuiltinToolFormatType(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"); - - /// Rendered as a fullscreen overlay. - public static McpAppsSetHostContextDetailsDisplayMode Fullscreen { get; } = new("fullscreen"); - - /// Rendered as a picture-in-picture floating panel. - public static McpAppsSetHostContextDetailsDisplayMode Pip { get; } = new("pip"); + /// The tool input is parsed with the supplied grammar. + public static BuiltinToolFormatType Grammar { get; } = new("grammar"); - /// 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 equivalent. + public static bool operator ==(BuiltinToolFormatType left, BuiltinToolFormatType right) => left.Equals(right); - /// 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 not equivalent. + public static bool operator !=(BuiltinToolFormatType left, BuiltinToolFormatType right) => !(left == right); /// - public override bool Equals(object? obj) => obj is McpAppsSetHostContextDetailsDisplayMode other && Equals(other); + public override bool Equals(object? obj) => obj is BuiltinToolFormatType other && Equals(other); /// - public bool Equals(McpAppsSetHostContextDetailsDisplayMode other) => string.Equals(Value, other.Value, StringComparison.OrdinalIgnoreCase); + public bool Equals(BuiltinToolFormatType other) => string.Equals(Value, other.Value, StringComparison.OrdinalIgnoreCase); /// public override int GetHashCode() => StringComparer.OrdinalIgnoreCase.GetHashCode(Value); @@ -16520,65 +26233,59 @@ 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 BuiltinToolFormatType 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, BuiltinToolFormatType value, JsonSerializerOptions options) { - GeneratedStringEnumJson.WriteValue(writer, value.Value, typeof(McpAppsSetHostContextDetailsDisplayMode)); + GeneratedStringEnumJson.WriteValue(writer, value.Value, typeof(BuiltinToolFormatType)); } } } -/// Platform type for responsive design. +/// Root JSON Schema type for a built-in tool input. [Experimental(Diagnostics.Experimental)] [JsonConverter(typeof(Converter))] [DebuggerDisplay("{Value,nq}")] -public readonly struct McpAppsSetHostContextDetailsPlatform : IEquatable +public readonly struct BuiltinToolInputSchemaType : 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 BuiltinToolInputSchemaType(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"); - - /// Host runs on a mobile device. - public static McpAppsSetHostContextDetailsPlatform Mobile { get; } = new("mobile"); + /// The tool accepts a JSON object. + public static BuiltinToolInputSchemaType Object { get; } = new("object"); - /// 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 ==(BuiltinToolInputSchemaType left, BuiltinToolInputSchemaType 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 !=(BuiltinToolInputSchemaType left, BuiltinToolInputSchemaType right) => !(left == right); /// - public override bool Equals(object? obj) => obj is McpAppsSetHostContextDetailsPlatform other && Equals(other); + public override bool Equals(object? obj) => obj is BuiltinToolInputSchemaType other && Equals(other); /// - public bool Equals(McpAppsSetHostContextDetailsPlatform other) => string.Equals(Value, other.Value, StringComparison.OrdinalIgnoreCase); + public bool Equals(BuiltinToolInputSchemaType other) => string.Equals(Value, other.Value, StringComparison.OrdinalIgnoreCase); /// public override int GetHashCode() => StringComparer.OrdinalIgnoreCase.GetHashCode(Value); @@ -16586,62 +26293,62 @@ 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 BuiltinToolInputSchemaType 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, BuiltinToolInputSchemaType value, JsonSerializerOptions options) { - GeneratedStringEnumJson.WriteValue(writer, value.Value, typeof(McpAppsSetHostContextDetailsPlatform)); + GeneratedStringEnumJson.WriteValue(writer, value.Value, typeof(BuiltinToolInputSchemaType)); } } } -/// UI theme preference per SEP-1865. +/// Binary result type discriminator. Use "image" for images and "resource" for other binary data. [Experimental(Diagnostics.Experimental)] [JsonConverter(typeof(Converter))] [DebuggerDisplay("{Value,nq}")] -public readonly struct McpAppsSetHostContextDetailsTheme : IEquatable +public readonly struct ExternalToolTextResultForLlmBinaryResultsForLlmType : 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 ExternalToolTextResultForLlmBinaryResultsForLlmType(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"); + /// Binary image data. + public static ExternalToolTextResultForLlmBinaryResultsForLlmType Image { get; } = new("image"); - /// Dark UI theme. - public static McpAppsSetHostContextDetailsTheme Dark { get; } = new("dark"); + /// Other binary resource data. + public static ExternalToolTextResultForLlmBinaryResultsForLlmType Resource { get; } = new("resource"); - /// 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 equivalent. + public static bool operator ==(ExternalToolTextResultForLlmBinaryResultsForLlmType left, ExternalToolTextResultForLlmBinaryResultsForLlmType right) => left.Equals(right); - /// 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 not equivalent. + public static bool operator !=(ExternalToolTextResultForLlmBinaryResultsForLlmType left, ExternalToolTextResultForLlmBinaryResultsForLlmType right) => !(left == right); /// - public override bool Equals(object? obj) => obj is McpAppsSetHostContextDetailsTheme other && Equals(other); + public override bool Equals(object? obj) => obj is ExternalToolTextResultForLlmBinaryResultsForLlmType other && Equals(other); /// - public bool Equals(McpAppsSetHostContextDetailsTheme other) => string.Equals(Value, other.Value, StringComparison.OrdinalIgnoreCase); + public bool Equals(ExternalToolTextResultForLlmBinaryResultsForLlmType other) => string.Equals(Value, other.Value, StringComparison.OrdinalIgnoreCase); /// public override int GetHashCode() => StringComparer.OrdinalIgnoreCase.GetHashCode(Value); @@ -16649,65 +26356,62 @@ 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 ExternalToolTextResultForLlmBinaryResultsForLlmType 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, ExternalToolTextResultForLlmBinaryResultsForLlmType value, JsonSerializerOptions options) { - GeneratedStringEnumJson.WriteValue(writer, value.Value, typeof(McpAppsSetHostContextDetailsTheme)); + GeneratedStringEnumJson.WriteValue(writer, value.Value, typeof(ExternalToolTextResultForLlmBinaryResultsForLlmType)); } } } -/// Allowed values for the `McpAppsHostContextDetailsAvailableDisplayMode` enumeration. +/// Theme variant this icon is intended for. [Experimental(Diagnostics.Experimental)] [JsonConverter(typeof(Converter))] [DebuggerDisplay("{Value,nq}")] -public readonly struct McpAppsHostContextDetailsAvailableDisplayMode : IEquatable +public readonly struct ExternalToolTextResultForLlmContentResourceLinkIconTheme : 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 ExternalToolTextResultForLlmContentResourceLinkIconTheme(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"); - - /// Rendered as a fullscreen overlay. - public static McpAppsHostContextDetailsAvailableDisplayMode Fullscreen { get; } = new("fullscreen"); + /// Icon intended for light themes. + public static ExternalToolTextResultForLlmContentResourceLinkIconTheme Light { get; } = new("light"); - /// Rendered as a picture-in-picture floating panel. - public static McpAppsHostContextDetailsAvailableDisplayMode Pip { get; } = new("pip"); + /// Icon intended for dark themes. + public static ExternalToolTextResultForLlmContentResourceLinkIconTheme Dark { get; } = new("dark"); - /// 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 equivalent. + public static bool operator ==(ExternalToolTextResultForLlmContentResourceLinkIconTheme left, ExternalToolTextResultForLlmContentResourceLinkIconTheme right) => left.Equals(right); - /// 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 not equivalent. + public static bool operator !=(ExternalToolTextResultForLlmContentResourceLinkIconTheme left, ExternalToolTextResultForLlmContentResourceLinkIconTheme right) => !(left == right); /// - public override bool Equals(object? obj) => obj is McpAppsHostContextDetailsAvailableDisplayMode other && Equals(other); + public override bool Equals(object? obj) => obj is ExternalToolTextResultForLlmContentResourceLinkIconTheme other && Equals(other); /// - public bool Equals(McpAppsHostContextDetailsAvailableDisplayMode other) => string.Equals(Value, other.Value, StringComparison.OrdinalIgnoreCase); + public bool Equals(ExternalToolTextResultForLlmContentResourceLinkIconTheme other) => string.Equals(Value, other.Value, StringComparison.OrdinalIgnoreCase); /// public override int GetHashCode() => StringComparer.OrdinalIgnoreCase.GetHashCode(Value); @@ -16715,65 +26419,71 @@ 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 ExternalToolTextResultForLlmContentResourceLinkIconTheme 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, ExternalToolTextResultForLlmContentResourceLinkIconTheme value, JsonSerializerOptions options) { - GeneratedStringEnumJson.WriteValue(writer, value.Value, typeof(McpAppsHostContextDetailsAvailableDisplayMode)); + GeneratedStringEnumJson.WriteValue(writer, value.Value, typeof(ExternalToolTextResultForLlmContentResourceLinkIconTheme)); } } } -/// Current display mode (SEP-1865). +/// Execution outcome classification. [Experimental(Diagnostics.Experimental)] [JsonConverter(typeof(Converter))] [DebuggerDisplay("{Value,nq}")] -public readonly struct McpAppsHostContextDetailsDisplayMode : IEquatable +public readonly struct ToolResultType : 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 ToolResultType(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 tool completed successfully. + public static ToolResultType Success { get; } = new("success"); - /// Rendered as a fullscreen overlay. - public static McpAppsHostContextDetailsDisplayMode Fullscreen { get; } = new("fullscreen"); + /// The tool failed. + public static ToolResultType Failure { get; } = new("failure"); - /// Rendered as a picture-in-picture floating panel. - public static McpAppsHostContextDetailsDisplayMode Pip { get; } = new("pip"); + /// The tool exceeded its execution timeout. + public static ToolResultType Timeout { get; } = new("timeout"); - /// Returns a value indicating whether two instances are equivalent. - public static bool operator ==(McpAppsHostContextDetailsDisplayMode left, McpAppsHostContextDetailsDisplayMode right) => left.Equals(right); + /// The tool request was rejected before execution. + public static ToolResultType Rejected { get; } = new("rejected"); - /// Returns a value indicating whether two instances are not equivalent. - public static bool operator !=(McpAppsHostContextDetailsDisplayMode left, McpAppsHostContextDetailsDisplayMode right) => !(left == right); + /// Permission policy denied the tool request. + public static ToolResultType Denied { get; } = new("denied"); + + /// Returns a value indicating whether two instances are equivalent. + public static bool operator ==(ToolResultType left, ToolResultType right) => left.Equals(right); + + /// Returns a value indicating whether two instances are not equivalent. + public static bool operator !=(ToolResultType left, ToolResultType right) => !(left == right); /// - public override bool Equals(object? obj) => obj is McpAppsHostContextDetailsDisplayMode other && Equals(other); + public override bool Equals(object? obj) => obj is ToolResultType other && Equals(other); /// - public bool Equals(McpAppsHostContextDetailsDisplayMode other) => string.Equals(Value, other.Value, StringComparison.OrdinalIgnoreCase); + public bool Equals(ToolResultType other) => string.Equals(Value, other.Value, StringComparison.OrdinalIgnoreCase); /// public override int GetHashCode() => StringComparer.OrdinalIgnoreCase.GetHashCode(Value); @@ -16781,65 +26491,62 @@ 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 ToolResultType 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, ToolResultType value, JsonSerializerOptions options) { - GeneratedStringEnumJson.WriteValue(writer, value.Value, typeof(McpAppsHostContextDetailsDisplayMode)); + GeneratedStringEnumJson.WriteValue(writer, value.Value, typeof(ToolResultType)); } } } -/// Platform type for responsive design. +/// Controls whether the runtime may defer loading an external tool definition. [Experimental(Diagnostics.Experimental)] [JsonConverter(typeof(Converter))] [DebuggerDisplay("{Value,nq}")] -public readonly struct McpAppsHostContextDetailsPlatform : IEquatable +public readonly struct ProtocolExternalToolDefer : 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 ProtocolExternalToolDefer(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"); - - /// Host runs as a desktop application. - public static McpAppsHostContextDetailsPlatform Desktop { get; } = new("desktop"); + /// The runtime may defer the tool according to its tool-loading policy. + public static ProtocolExternalToolDefer Auto { get; } = new("auto"); - /// Host runs on a mobile device. - public static McpAppsHostContextDetailsPlatform Mobile { get; } = new("mobile"); + /// The runtime must include the tool without deferring it. + public static ProtocolExternalToolDefer Never { get; } = new("never"); - /// 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 equivalent. + public static bool operator ==(ProtocolExternalToolDefer left, ProtocolExternalToolDefer right) => left.Equals(right); - /// 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 not equivalent. + public static bool operator !=(ProtocolExternalToolDefer left, ProtocolExternalToolDefer right) => !(left == right); /// - public override bool Equals(object? obj) => obj is McpAppsHostContextDetailsPlatform other && Equals(other); + public override bool Equals(object? obj) => obj is ProtocolExternalToolDefer other && Equals(other); /// - public bool Equals(McpAppsHostContextDetailsPlatform other) => string.Equals(Value, other.Value, StringComparison.OrdinalIgnoreCase); + public bool Equals(ProtocolExternalToolDefer other) => string.Equals(Value, other.Value, StringComparison.OrdinalIgnoreCase); /// public override int GetHashCode() => StringComparer.OrdinalIgnoreCase.GetHashCode(Value); @@ -16847,62 +26554,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 ProtocolExternalToolDefer 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, ProtocolExternalToolDefer value, JsonSerializerOptions options) { - GeneratedStringEnumJson.WriteValue(writer, value.Value, typeof(McpAppsHostContextDetailsPlatform)); + GeneratedStringEnumJson.WriteValue(writer, value.Value, typeof(ProtocolExternalToolDefer)); } } } -/// UI theme preference per SEP-1865. +/// Context tier override for matching subagents. [Experimental(Diagnostics.Experimental)] [JsonConverter(typeof(Converter))] [DebuggerDisplay("{Value,nq}")] -public readonly struct McpAppsHostContextDetailsTheme : 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 McpAppsHostContextDetailsTheme(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; - /// Light UI theme. - public static McpAppsHostContextDetailsTheme Light { get; } = new("light"); + /// Inherit the parent session's effective context tier at dispatch time. + public static SubagentSettingsEntryContextTier Inherit { get; } = new("inherit"); - /// Dark UI theme. - public static McpAppsHostContextDetailsTheme Dark { get; } = new("dark"); + /// 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 ==(McpAppsHostContextDetailsTheme left, McpAppsHostContextDetailsTheme 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 !=(McpAppsHostContextDetailsTheme left, McpAppsHostContextDetailsTheme 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 McpAppsHostContextDetailsTheme other && Equals(other); + public override bool Equals(object? obj) => obj is SubagentSettingsEntryContextTier other && Equals(other); /// - public bool Equals(McpAppsHostContextDetailsTheme 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); @@ -16910,62 +26620,59 @@ 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 SubagentSettingsEntryContextTier 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, SubagentSettingsEntryContextTier value, JsonSerializerOptions options) { - GeneratedStringEnumJson.WriteValue(writer, value.Value, typeof(McpAppsHostContextDetailsTheme)); + GeneratedStringEnumJson.WriteValue(writer, value.Value, typeof(SubagentSettingsEntryContextTier)); } } } -/// Transport to be used for provider requests. +/// Defines the allowed values. [Experimental(Diagnostics.Experimental)] [JsonConverter(typeof(Converter))] [DebuggerDisplay("{Value,nq}")] -public readonly struct ProviderEndpointTransport : IEquatable +public readonly struct CommandsInvocationOrigin : 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 ProviderEndpointTransport(string value) + public CommandsInvocationOrigin(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; - /// HTTP request/streaming transport. - public static ProviderEndpointTransport Http { get; } = new("http"); - - /// WebSocket transport. - public static ProviderEndpointTransport Websockets { get; } = new("websockets"); + /// Gets the settings value. + public static CommandsInvocationOrigin Settings { get; } = new("settings"); - /// 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 equivalent. + public static bool operator ==(CommandsInvocationOrigin left, CommandsInvocationOrigin right) => left.Equals(right); - /// Returns a value indicating whether two instances are not equivalent. - public static bool operator !=(ProviderEndpointTransport left, ProviderEndpointTransport right) => !(left == right); + /// Returns a value indicating whether two instances are not equivalent. + public static bool operator !=(CommandsInvocationOrigin left, CommandsInvocationOrigin right) => !(left == right); /// - public override bool Equals(object? obj) => obj is ProviderEndpointTransport other && Equals(other); + public override bool Equals(object? obj) => obj is CommandsInvocationOrigin other && Equals(other); /// - public bool Equals(ProviderEndpointTransport other) => string.Equals(Value, other.Value, StringComparison.OrdinalIgnoreCase); + public bool Equals(CommandsInvocationOrigin other) => string.Equals(Value, other.Value, StringComparison.OrdinalIgnoreCase); /// public override int GetHashCode() => StringComparer.OrdinalIgnoreCase.GetHashCode(Value); @@ -16973,65 +26680,62 @@ public ProviderEndpointTransport(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 ProviderEndpointTransport Read(ref Utf8JsonReader reader, Type typeToConvert, JsonSerializerOptions options) + public override CommandsInvocationOrigin Read(ref Utf8JsonReader reader, Type typeToConvert, JsonSerializerOptions options) { return new(GeneratedStringEnumJson.ReadValue(ref reader, typeToConvert)); } /// - public override void Write(Utf8JsonWriter writer, ProviderEndpointTransport value, JsonSerializerOptions options) + public override void Write(Utf8JsonWriter writer, CommandsInvocationOrigin value, JsonSerializerOptions options) { - GeneratedStringEnumJson.WriteValue(writer, value.Value, typeof(ProviderEndpointTransport)); + GeneratedStringEnumJson.WriteValue(writer, value.Value, typeof(CommandsInvocationOrigin)); } } } -/// Provider family. Matches the `type` field of a BYOK provider config. +/// Whether a pending slash-command invocation effect was applied or cancelled by the host. [Experimental(Diagnostics.Experimental)] [JsonConverter(typeof(Converter))] [DebuggerDisplay("{Value,nq}")] -public readonly struct ProviderEndpointType : IEquatable +public readonly struct CommandsInvocationEffectOutcome : 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 ProviderEndpointType(string value) + public CommandsInvocationEffectOutcome(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; - /// OpenAI-compatible endpoint (use the OpenAI client library). - public static ProviderEndpointType Openai { get; } = new("openai"); - - /// Azure OpenAI endpoint (use the OpenAI client library with the Azure base URL). - public static ProviderEndpointType Azure { get; } = new("azure"); + /// The host applied the pending invocation effect. + public static CommandsInvocationEffectOutcome Applied { get; } = new("applied"); - /// Anthropic endpoint (use the Anthropic client library). - public static ProviderEndpointType Anthropic { get; } = new("anthropic"); + /// The host cancelled the pending invocation effect, so any provisional state must be reverted. + public static CommandsInvocationEffectOutcome Cancelled { get; } = new("cancelled"); - /// 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 equivalent. + public static bool operator ==(CommandsInvocationEffectOutcome left, CommandsInvocationEffectOutcome right) => left.Equals(right); - /// Returns a value indicating whether two instances are not equivalent. - public static bool operator !=(ProviderEndpointType left, ProviderEndpointType right) => !(left == right); + /// Returns a value indicating whether two instances are not equivalent. + public static bool operator !=(CommandsInvocationEffectOutcome left, CommandsInvocationEffectOutcome right) => !(left == right); /// - public override bool Equals(object? obj) => obj is ProviderEndpointType other && Equals(other); + public override bool Equals(object? obj) => obj is CommandsInvocationEffectOutcome other && Equals(other); /// - public bool Equals(ProviderEndpointType other) => string.Equals(Value, other.Value, StringComparison.OrdinalIgnoreCase); + public bool Equals(CommandsInvocationEffectOutcome other) => string.Equals(Value, other.Value, StringComparison.OrdinalIgnoreCase); /// public override int GetHashCode() => StringComparer.OrdinalIgnoreCase.GetHashCode(Value); @@ -17039,62 +26743,65 @@ public ProviderEndpointType(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 ProviderEndpointType Read(ref Utf8JsonReader reader, Type typeToConvert, JsonSerializerOptions options) + public override CommandsInvocationEffectOutcome Read(ref Utf8JsonReader reader, Type typeToConvert, JsonSerializerOptions options) { return new(GeneratedStringEnumJson.ReadValue(ref reader, typeToConvert)); } /// - public override void Write(Utf8JsonWriter writer, ProviderEndpointType value, JsonSerializerOptions options) + public override void Write(Utf8JsonWriter writer, CommandsInvocationEffectOutcome value, JsonSerializerOptions options) { - GeneratedStringEnumJson.WriteValue(writer, value.Value, typeof(ProviderEndpointType)); + GeneratedStringEnumJson.WriteValue(writer, value.Value, typeof(CommandsInvocationEffectOutcome)); } } } -/// Wire API to be used, when required for the provider type. +/// The user's response: accept (submitted), decline (rejected), or cancel (dismissed). [Experimental(Diagnostics.Experimental)] [JsonConverter(typeof(Converter))] [DebuggerDisplay("{Value,nq}")] -public readonly struct ProviderEndpointWireApi : 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 ProviderEndpointWireApi(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; - /// Classic chat-completions request shape. - public static ProviderEndpointWireApi Completions { get; } = new("completions"); + /// The user submitted the requested form values. + public static UIElicitationResponseAction Accept { get; } = new("accept"); - /// Newer responses request shape. - public static ProviderEndpointWireApi Responses { get; } = new("responses"); + /// 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 ==(ProviderEndpointWireApi left, ProviderEndpointWireApi 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 !=(ProviderEndpointWireApi left, ProviderEndpointWireApi 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 ProviderEndpointWireApi other && Equals(other); + public override bool Equals(object? obj) => obj is UIElicitationResponseAction other && Equals(other); /// - public bool Equals(ProviderEndpointWireApi 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); @@ -17102,62 +26809,59 @@ public ProviderEndpointWireApi(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 ProviderEndpointWireApi 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, ProviderEndpointWireApi value, JsonSerializerOptions options) + public override void Write(Utf8JsonWriter writer, UIElicitationResponseAction value, JsonSerializerOptions options) { - GeneratedStringEnumJson.WriteValue(writer, value.Value, typeof(ProviderEndpointWireApi)); + GeneratedStringEnumJson.WriteValue(writer, value.Value, typeof(UIElicitationResponseAction)); } } } -/// Provider transport. Defaults to "http". +/// Structured MCP elicitation mode. [Experimental(Diagnostics.Experimental)] [JsonConverter(typeof(Converter))] [DebuggerDisplay("{Value,nq}")] -public readonly struct ProviderConfigTransport : IEquatable +public readonly struct McpElicitationFormMode : 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 ProviderConfigTransport(string value) + public McpElicitationFormMode(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; - /// HTTP request/streaming transport. - public static ProviderConfigTransport Http { get; } = new("http"); - - /// WebSocket transport. - public static ProviderConfigTransport Websockets { get; } = new("websockets"); + /// Gets the form value. + public static McpElicitationFormMode Form { get; } = new("form"); - /// 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 equivalent. + public static bool operator ==(McpElicitationFormMode left, McpElicitationFormMode right) => left.Equals(right); - /// Returns a value indicating whether two instances are not equivalent. - public static bool operator !=(ProviderConfigTransport left, ProviderConfigTransport right) => !(left == right); + /// Returns a value indicating whether two instances are not equivalent. + public static bool operator !=(McpElicitationFormMode left, McpElicitationFormMode right) => !(left == right); /// - public override bool Equals(object? obj) => obj is ProviderConfigTransport other && Equals(other); + public override bool Equals(object? obj) => obj is McpElicitationFormMode other && Equals(other); /// - public bool Equals(ProviderConfigTransport other) => string.Equals(Value, other.Value, StringComparison.OrdinalIgnoreCase); + public bool Equals(McpElicitationFormMode other) => string.Equals(Value, other.Value, StringComparison.OrdinalIgnoreCase); /// public override int GetHashCode() => StringComparer.OrdinalIgnoreCase.GetHashCode(Value); @@ -17165,65 +26869,65 @@ public ProviderConfigTransport(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 ProviderConfigTransport Read(ref Utf8JsonReader reader, Type typeToConvert, JsonSerializerOptions options) + public override McpElicitationFormMode Read(ref Utf8JsonReader reader, Type typeToConvert, JsonSerializerOptions options) { return new(GeneratedStringEnumJson.ReadValue(ref reader, typeToConvert)); } /// - public override void Write(Utf8JsonWriter writer, ProviderConfigTransport value, JsonSerializerOptions options) + public override void Write(Utf8JsonWriter writer, McpElicitationFormMode value, JsonSerializerOptions options) { - GeneratedStringEnumJson.WriteValue(writer, value.Value, typeof(ProviderConfigTransport)); + GeneratedStringEnumJson.WriteValue(writer, value.Value, typeof(McpElicitationFormMode)); } } } -/// Provider type. Defaults to "openai" for generic OpenAI-compatible APIs. +/// 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 ProviderConfigType : 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 ProviderConfigType(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; - /// Generic OpenAI-compatible API. - public static ProviderConfigType Openai { get; } = new("openai"); + /// Allow the automatic mode switch for this turn. + public static UIAutoModeSwitchResponse Yes { get; } = new("yes"); - /// Azure OpenAI Service endpoint. - public static ProviderConfigType Azure { get; } = new("azure"); + /// Allow this mode switch and persist the preference. + public static UIAutoModeSwitchResponse YesAlways { get; } = new("yes_always"); - /// Anthropic API endpoint. - public static ProviderConfigType Anthropic { get; } = new("anthropic"); + /// Decline the automatic mode switch. + public static UIAutoModeSwitchResponse No { get; } = new("no"); - /// 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 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 !=(ProviderConfigType left, ProviderConfigType right) => !(left == 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 ProviderConfigType other && Equals(other); + public override bool Equals(object? obj) => obj is UIAutoModeSwitchResponse other && Equals(other); /// - public bool Equals(ProviderConfigType 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); @@ -17231,62 +26935,68 @@ public ProviderConfigType(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 ProviderConfigType 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, ProviderConfigType value, JsonSerializerOptions options) + public override void Write(Utf8JsonWriter writer, UIAutoModeSwitchResponse value, JsonSerializerOptions options) { - GeneratedStringEnumJson.WriteValue(writer, value.Value, typeof(ProviderConfigType)); + GeneratedStringEnumJson.WriteValue(writer, value.Value, typeof(UIAutoModeSwitchResponse)); } } } -/// Wire API format (openai/azure only). Defaults to "completions". +/// User action selected for an exhausted session limit. [Experimental(Diagnostics.Experimental)] [JsonConverter(typeof(Converter))] [DebuggerDisplay("{Value,nq}")] -public readonly struct ProviderConfigWireApi : 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 ProviderConfigWireApi(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; - /// OpenAI Chat Completions wire format. - public static ProviderConfigWireApi Completions { get; } = new("completions"); + /// Increase the current max by an exact AI Credits amount. + public static UISessionLimitsExhaustedResponseAction Add { get; } = new("add"); - /// OpenAI Responses API wire format. - public static ProviderConfigWireApi Responses { get; } = new("responses"); + /// Set a new absolute max AI Credits value. + public static UISessionLimitsExhaustedResponseAction Set { get; } = new("set"); - /// Returns a value indicating whether two instances are equivalent. - public static bool operator ==(ProviderConfigWireApi left, ProviderConfigWireApi right) => left.Equals(right); + /// Remove the current session limit. + public static UISessionLimitsExhaustedResponseAction Unset { get; } = new("unset"); - /// Returns a value indicating whether two instances are not equivalent. - public static bool operator !=(ProviderConfigWireApi left, ProviderConfigWireApi right) => !(left == 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 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 ProviderConfigWireApi other && Equals(other); + public override bool Equals(object? obj) => obj is UISessionLimitsExhaustedResponseAction other && Equals(other); /// - public bool Equals(ProviderConfigWireApi 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); @@ -17294,62 +27004,68 @@ public ProviderConfigWireApi(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 ProviderConfigWireApi 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, ProviderConfigWireApi value, JsonSerializerOptions options) + public override void Write(Utf8JsonWriter writer, UISessionLimitsExhaustedResponseAction value, JsonSerializerOptions options) { - GeneratedStringEnumJson.WriteValue(writer, value.Value, typeof(ProviderConfigWireApi)); + GeneratedStringEnumJson.WriteValue(writer, value.Value, typeof(UISessionLimitsExhaustedResponseAction)); } } } -/// Allowed values for the `OptionsUpdateAdditionalContentExclusionPolicyScope` enumeration. +/// 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 OptionsUpdateAdditionalContentExclusionPolicyScope : 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 OptionsUpdateAdditionalContentExclusionPolicyScope(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; - /// The content exclusion policy applies to the current repository. - public static OptionsUpdateAdditionalContentExclusionPolicyScope Repo { get; } = new("repo"); + /// Exit plan mode without starting implementation. + public static UIExitPlanModeAction ExitOnly { get; } = new("exit_only"); - /// The content exclusion policy applies across all repositories. - public static OptionsUpdateAdditionalContentExclusionPolicyScope All { get; } = new("all"); + /// Exit plan mode and continue interactively. + public static UIExitPlanModeAction Interactive { get; } = new("interactive"); - /// Returns a value indicating whether two instances are equivalent. - public static bool operator ==(OptionsUpdateAdditionalContentExclusionPolicyScope left, OptionsUpdateAdditionalContentExclusionPolicyScope right) => left.Equals(right); + /// Exit plan mode and continue in autopilot mode. + public static UIExitPlanModeAction Autopilot { get; } = new("autopilot"); - /// Returns a value indicating whether two instances are not equivalent. - public static bool operator !=(OptionsUpdateAdditionalContentExclusionPolicyScope left, OptionsUpdateAdditionalContentExclusionPolicyScope right) => !(left == 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 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 OptionsUpdateAdditionalContentExclusionPolicyScope other && Equals(other); + public override bool Equals(object? obj) => obj is UIExitPlanModeAction other && Equals(other); /// - public bool Equals(OptionsUpdateAdditionalContentExclusionPolicyScope 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); @@ -17357,62 +27073,62 @@ public OptionsUpdateAdditionalContentExclusionPolicyScope(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 OptionsUpdateAdditionalContentExclusionPolicyScope 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, OptionsUpdateAdditionalContentExclusionPolicyScope value, JsonSerializerOptions options) + public override void Write(Utf8JsonWriter writer, UIExitPlanModeAction value, JsonSerializerOptions options) { - GeneratedStringEnumJson.WriteValue(writer, value.Value, typeof(OptionsUpdateAdditionalContentExclusionPolicyScope)); + GeneratedStringEnumJson.WriteValue(writer, value.Value, typeof(UIExitPlanModeAction)); } } } -/// 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. +/// Allowed values for the `PermissionsConfigureAdditionalContentExclusionPolicyScope` enumeration. [Experimental(Diagnostics.Experimental)] [JsonConverter(typeof(Converter))] [DebuggerDisplay("{Value,nq}")] -public readonly struct OptionsUpdateContextTier : 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 OptionsUpdateContextTier(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; - /// Use the model's default context tier and its standard token limits / pricing. - public static OptionsUpdateContextTier Default { get; } = new("default"); + /// The content exclusion policy applies to the current repository. + public static PermissionsConfigureAdditionalContentExclusionPolicyScope Repo { get; } = new("repo"); - /// 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"); + /// 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 ==(OptionsUpdateContextTier left, OptionsUpdateContextTier 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 !=(OptionsUpdateContextTier left, OptionsUpdateContextTier 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 OptionsUpdateContextTier other && Equals(other); + public override bool Equals(object? obj) => obj is PermissionsConfigureAdditionalContentExclusionPolicyScope other && Equals(other); /// - public bool Equals(OptionsUpdateContextTier 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); @@ -17420,62 +27136,65 @@ public OptionsUpdateContextTier(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 OptionsUpdateContextTier 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, OptionsUpdateContextTier value, JsonSerializerOptions options) + public override void Write(Utf8JsonWriter writer, PermissionsConfigureAdditionalContentExclusionPolicyScope value, JsonSerializerOptions options) { - GeneratedStringEnumJson.WriteValue(writer, value.Value, typeof(OptionsUpdateContextTier)); + GeneratedStringEnumJson.WriteValue(writer, value.Value, typeof(PermissionsConfigureAdditionalContentExclusionPolicyScope)); } } } -/// How env values are passed to MCP servers (`direct` inlines literal values; `indirect` resolves at launch). +/// Disposition of a permission request as observed by the responding client. [Experimental(Diagnostics.Experimental)] [JsonConverter(typeof(Converter))] [DebuggerDisplay("{Value,nq}")] -public readonly struct OptionsUpdateEnvValueMode : 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 OptionsUpdateEnvValueMode(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; - /// Pass MCP server environment values as literal strings. - public static OptionsUpdateEnvValueMode Direct { get; } = new("direct"); + /// The request was approved automatically without a new human decision. + public static PermissionDecisionOutcome AutoApproved { get; } = new("auto_approved"); - /// Resolve MCP server environment values from host-side references. - public static OptionsUpdateEnvValueMode Indirect { get; } = new("indirect"); + /// 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 ==(OptionsUpdateEnvValueMode left, OptionsUpdateEnvValueMode 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 !=(OptionsUpdateEnvValueMode left, OptionsUpdateEnvValueMode 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 OptionsUpdateEnvValueMode other && Equals(other); + public override bool Equals(object? obj) => obj is PermissionDecisionOutcome other && Equals(other); /// - public bool Equals(OptionsUpdateEnvValueMode 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); @@ -17483,65 +27202,65 @@ 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 PermissionDecisionOutcome 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, PermissionDecisionOutcome value, JsonSerializerOptions options) { - GeneratedStringEnumJson.WriteValue(writer, value.Value, typeof(OptionsUpdateEnvValueMode)); + GeneratedStringEnumJson.WriteValue(writer, value.Value, typeof(PermissionDecisionOutcome)); } } } -/// Reasoning summary mode for supported model clients. +/// Response capability available to the client when it settled a permission request. [Experimental(Diagnostics.Experimental)] [JsonConverter(typeof(Converter))] [DebuggerDisplay("{Value,nq}")] -public readonly struct OptionsUpdateReasoningSummary : IEquatable +public readonly struct PermissionResponseCapability : 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 OptionsUpdateReasoningSummary(string value) + public PermissionResponseCapability(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 OptionsUpdateReasoningSummary None { get; } = new("none"); + /// The client could ask a user for this decision. + public static PermissionResponseCapability Interactive { get; } = new("interactive"); - /// Request a concise summary of model reasoning. - public static OptionsUpdateReasoningSummary Concise { get; } = new("concise"); + /// The client could return an automated response but could not ask a user. + public static PermissionResponseCapability Headless { get; } = new("headless"); - /// Request a detailed summary of model reasoning. - public static OptionsUpdateReasoningSummary Detailed { get; } = new("detailed"); + /// The client had no response path available. + public static PermissionResponseCapability None { get; } = new("none"); - /// 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 equivalent. + public static bool operator ==(PermissionResponseCapability left, PermissionResponseCapability right) => left.Equals(right); - /// Returns a value indicating whether two instances are not equivalent. - public static bool operator !=(OptionsUpdateReasoningSummary left, OptionsUpdateReasoningSummary right) => !(left == right); + /// Returns a value indicating whether two instances are not equivalent. + public static bool operator !=(PermissionResponseCapability left, PermissionResponseCapability right) => !(left == right); /// - public override bool Equals(object? obj) => obj is OptionsUpdateReasoningSummary other && Equals(other); + public override bool Equals(object? obj) => obj is PermissionResponseCapability other && Equals(other); /// - public bool Equals(OptionsUpdateReasoningSummary other) => string.Equals(Value, other.Value, StringComparison.OrdinalIgnoreCase); + public bool Equals(PermissionResponseCapability other) => string.Equals(Value, other.Value, StringComparison.OrdinalIgnoreCase); /// public override int GetHashCode() => StringComparer.OrdinalIgnoreCase.GetHashCode(Value); @@ -17549,89 +27268,68 @@ public OptionsUpdateReasoningSummary(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 OptionsUpdateReasoningSummary Read(ref Utf8JsonReader reader, Type typeToConvert, JsonSerializerOptions options) + public override PermissionResponseCapability Read(ref Utf8JsonReader reader, Type typeToConvert, JsonSerializerOptions options) { return new(GeneratedStringEnumJson.ReadValue(ref reader, typeToConvert)); } /// - public override void Write(Utf8JsonWriter writer, OptionsUpdateReasoningSummary value, JsonSerializerOptions options) + public override void Write(Utf8JsonWriter writer, PermissionResponseCapability value, JsonSerializerOptions options) { - GeneratedStringEnumJson.WriteValue(writer, value.Value, typeof(OptionsUpdateReasoningSummary)); + GeneratedStringEnumJson.WriteValue(writer, value.Value, typeof(PermissionResponseCapability)); } } } -/// Session capability enabled for this session. +/// Controlled reason or actor responsible for a permission response. [Experimental(Diagnostics.Experimental)] [JsonConverter(typeof(Converter))] [DebuggerDisplay("{Value,nq}")] -public readonly struct SessionCapability : 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 SessionCapability(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; - /// TUI-specific prompt hints such as keyboard shortcuts. - public static SessionCapability TuiHints { get; } = new("tui-hints"); - - /// Plan-mode handling and instructions. - public static SessionCapability PlanMode { get; } = new("plan-mode"); - - /// Memory tool and memories prompt section. - public static SessionCapability Memory { get; } = new("memory"); - - /// 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"); + /// The response followed the assisted-approval judge recommendation. + public static PermissionDecisionSource AssistedApproval { get; } = new("assisted_approval"); - /// Cross-session history tools and session-store SQL prompt/tool metadata. - public static SessionCapability SessionStore { get; } = new("session-store"); + /// A human supplied the response through an interactive prompt. + public static PermissionDecisionSource HumanResponse { get; } = new("human_response"); - /// MCP Apps UI passthrough. - public static SessionCapability McpApps { get; } = new("mcp-apps"); + /// The host applied a standing policy or override rather than a judge recommendation or human decision. + public static PermissionDecisionSource HostPolicy { get; } = new("host_policy"); - /// Host-provided canvas rendering support. - public static SessionCapability CanvasRenderer { get; } = new("canvas-renderer"); + /// 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 equivalent. - public static bool operator ==(SessionCapability left, SessionCapability right) => left.Equals(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 !=(SessionCapability left, SessionCapability right) => !(left == 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 SessionCapability other && Equals(other); + public override bool Equals(object? obj) => obj is PermissionDecisionSource other && Equals(other); /// - public bool Equals(SessionCapability 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); @@ -17639,62 +27337,71 @@ public SessionCapability(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 SessionCapability 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, SessionCapability value, JsonSerializerOptions options) + public override void Write(Utf8JsonWriter writer, PermissionDecisionSource value, JsonSerializerOptions options) { - GeneratedStringEnumJson.WriteValue(writer, value.Value, typeof(SessionCapability)); + GeneratedStringEnumJson.WriteValue(writer, value.Value, typeof(PermissionDecisionSource)); } } } -/// Controls how availableTools (allowlist) and excludedTools (denylist) combine when both are set. +/// Client surface that submitted a permission response. [Experimental(Diagnostics.Experimental)] [JsonConverter(typeof(Converter))] [DebuggerDisplay("{Value,nq}")] -public readonly struct OptionsUpdateToolFilterPrecedence : 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 OptionsUpdateToolFilterPrecedence(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; - /// 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"); + /// The interactive Copilot CLI terminal UI. + public static PermissionDecisionSurface Tui { get; } = new("tui"); - /// 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"); + /// The non-interactive Copilot CLI prompt mode. + public static PermissionDecisionSurface PromptMode { get; } = new("prompt_mode"); - /// Returns a value indicating whether two instances are equivalent. - public static bool operator ==(OptionsUpdateToolFilterPrecedence left, OptionsUpdateToolFilterPrecedence right) => left.Equals(right); + /// The Copilot App client. + public static PermissionDecisionSurface CopilotApp { get; } = new("copilot_app"); - /// Returns a value indicating whether two instances are not equivalent. - public static bool operator !=(OptionsUpdateToolFilterPrecedence left, OptionsUpdateToolFilterPrecedence right) => !(left == right); + /// An Agent Client Protocol host. + public static PermissionDecisionSurface Acp { get; } = new("acp"); + + /// A generic Copilot SDK client. + public static PermissionDecisionSurface Sdk { get; } = new("sdk"); + + /// 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 OptionsUpdateToolFilterPrecedence other && Equals(other); + public override bool Equals(object? obj) => obj is PermissionDecisionSurface other && Equals(other); /// - public bool Equals(OptionsUpdateToolFilterPrecedence 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); @@ -17702,68 +27409,71 @@ 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 PermissionDecisionSurface 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, PermissionDecisionSurface value, JsonSerializerOptions options) { - GeneratedStringEnumJson.WriteValue(writer, value.Value, typeof(OptionsUpdateToolFilterPrecedence)); + GeneratedStringEnumJson.WriteValue(writer, value.Value, typeof(PermissionDecisionSurface)); } } } -/// Discovery source: project (.github/extensions/), user (~/.copilot/extensions/), plugin (installed plugin), or session (session-state/<id>/extensions/). +/// 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 ExtensionSource : 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 ExtensionSource(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; - /// Extension discovered from the current project's .github/extensions directory. - public static ExtensionSource Project { get; } = new("project"); + /// Allow-all was enabled from a CLI command-line flag. + public static PermissionsSetApproveAllSource CliFlag { get; } = new("cli_flag"); - /// Extension discovered from the user's ~/.copilot/extensions directory. - public static ExtensionSource User { get; } = new("user"); + /// Allow-all was enabled by a slash command. + public static PermissionsSetApproveAllSource SlashCommand { get; } = new("slash_command"); - /// Extension contributed by an installed plugin. - public static ExtensionSource Plugin { get; } = new("plugin"); + /// Allow-all was enabled by confirming autopilot behavior. + public static PermissionsSetApproveAllSource AutopilotConfirmation { get; } = new("autopilot_confirmation"); - /// Extension discovered from the current session's state directory (loaded only for this session). - public static ExtensionSource Session { get; } = new("session"); + /// Allow-all was enabled at startup by the `defaultPermissionMode` user setting. + public static PermissionsSetApproveAllSource UserSetting { get; } = new("user_setting"); - /// Returns a value indicating whether two instances are equivalent. - public static bool operator ==(ExtensionSource left, ExtensionSource 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 !=(ExtensionSource left, ExtensionSource 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 ExtensionSource other && Equals(other); + public override bool Equals(object? obj) => obj is PermissionsSetApproveAllSource other && Equals(other); /// - public bool Equals(ExtensionSource 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); @@ -17771,68 +27481,71 @@ 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 PermissionsSetApproveAllSource 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, PermissionsSetApproveAllSource value, JsonSerializerOptions options) { - GeneratedStringEnumJson.WriteValue(writer, value.Value, typeof(ExtensionSource)); + GeneratedStringEnumJson.WriteValue(writer, value.Value, typeof(PermissionsSetApproveAllSource)); } } } -/// Current status: running, disabled, failed, or starting. +/// Optional source for permission-mode telemetry. Defaults to `rpc` when omitted for SDK callers. [Experimental(Diagnostics.Experimental)] [JsonConverter(typeof(Converter))] [DebuggerDisplay("{Value,nq}")] -public readonly struct ExtensionStatus : IEquatable +public readonly struct PermissionModeSource : 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 PermissionModeSource(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 mode was set from a CLI command-line flag. + public static PermissionModeSource CliFlag { get; } = new("cli_flag"); - /// The extension is installed but disabled. - public static ExtensionStatus Disabled { get; } = new("disabled"); + /// The mode was set by a slash command. + public static PermissionModeSource SlashCommand { get; } = new("slash_command"); - /// The extension failed to start or crashed. - public static ExtensionStatus Failed { get; } = new("failed"); + /// The mode was set by confirming autopilot behavior. + public static PermissionModeSource AutopilotConfirmation { get; } = new("autopilot_confirmation"); - /// The extension process is starting. - public static ExtensionStatus Starting { get; } = new("starting"); + /// The mode was set at startup by the `defaultPermissionMode` user setting. + public static PermissionModeSource UserSetting { get; } = new("user_setting"); - /// Returns a value indicating whether two instances are equivalent. - public static bool operator ==(ExtensionStatus left, ExtensionStatus right) => left.Equals(right); + /// The mode was set through an RPC caller. + public static PermissionModeSource Rpc { get; } = new("rpc"); - /// 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 equivalent. + public static bool operator ==(PermissionModeSource left, PermissionModeSource right) => left.Equals(right); + + /// Returns a value indicating whether two instances are not equivalent. + public static bool operator !=(PermissionModeSource left, PermissionModeSource right) => !(left == right); /// - public override bool Equals(object? obj) => obj is ExtensionStatus other && Equals(other); + public override bool Equals(object? obj) => obj is PermissionModeSource other && Equals(other); /// - public bool Equals(ExtensionStatus other) => string.Equals(Value, other.Value, StringComparison.OrdinalIgnoreCase); + public bool Equals(PermissionModeSource other) => string.Equals(Value, other.Value, StringComparison.OrdinalIgnoreCase); /// public override int GetHashCode() => StringComparer.OrdinalIgnoreCase.GetHashCode(Value); @@ -17840,65 +27553,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 PermissionModeSource 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, PermissionModeSource value, JsonSerializerOptions options) { - GeneratedStringEnumJson.WriteValue(writer, value.Value, typeof(ExtensionStatus)); + GeneratedStringEnumJson.WriteValue(writer, value.Value, typeof(PermissionModeSource)); } } } -/// Type of GitHub reference. +/// 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 PushAttachmentGitHubReferenceType : 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 PushAttachmentGitHubReferenceType(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; - /// GitHub issue reference. - public static PushAttachmentGitHubReferenceType Issue { get; } = new("issue"); - - /// GitHub pull request reference. - public static PushAttachmentGitHubReferenceType Pr { get; } = new("pr"); + /// Apply the rule change only to this session. + public static PermissionsModifyRulesScope Session { get; } = new("session"); - /// GitHub discussion reference. - public static PushAttachmentGitHubReferenceType Discussion { get; } = new("discussion"); + /// 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 ==(PushAttachmentGitHubReferenceType left, PushAttachmentGitHubReferenceType 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 !=(PushAttachmentGitHubReferenceType left, PushAttachmentGitHubReferenceType 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 PushAttachmentGitHubReferenceType other && Equals(other); + public override bool Equals(object? obj) => obj is PermissionsModifyRulesScope other && Equals(other); /// - public bool Equals(PushAttachmentGitHubReferenceType 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); @@ -17906,65 +27616,62 @@ public PushAttachmentGitHubReferenceType(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 PushAttachmentGitHubReferenceType 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, PushAttachmentGitHubReferenceType value, JsonSerializerOptions options) + public override void Write(Utf8JsonWriter writer, PermissionsModifyRulesScope value, JsonSerializerOptions options) { - GeneratedStringEnumJson.WriteValue(writer, value.Value, typeof(PushAttachmentGitHubReferenceType)); + GeneratedStringEnumJson.WriteValue(writer, value.Value, typeof(PermissionsModifyRulesScope)); } } } -/// Context tier override for matching subagents. +/// Whether the location is a git repo or directory. [Experimental(Diagnostics.Experimental)] [JsonConverter(typeof(Converter))] [DebuggerDisplay("{Value,nq}")] -public readonly struct SubagentSettingsEntryContextTier : 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 SubagentSettingsEntryContextTier(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; - /// Inherit the parent session's effective context tier at dispatch time. - public static SubagentSettingsEntryContextTier Inherit { get; } = new("inherit"); - - /// Use the model's default context window. - public static SubagentSettingsEntryContextTier Default { get; } = new("default"); + /// The permission location is persisted at the git repository root. + public static PermissionLocationType Repo { get; } = new("repo"); - /// Pin the subagent to the long-context tier when supported. - public static SubagentSettingsEntryContextTier LongContext { get; } = new("long_context"); + /// 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 ==(SubagentSettingsEntryContextTier left, SubagentSettingsEntryContextTier 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 !=(SubagentSettingsEntryContextTier left, SubagentSettingsEntryContextTier 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 SubagentSettingsEntryContextTier other && Equals(other); + public override bool Equals(object? obj) => obj is PermissionLocationType other && Equals(other); /// - public bool Equals(SubagentSettingsEntryContextTier 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); @@ -17972,65 +27679,65 @@ public SubagentSettingsEntryContextTier(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 SubagentSettingsEntryContextTier 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, SubagentSettingsEntryContextTier value, JsonSerializerOptions options) + public override void Write(Utf8JsonWriter writer, PermissionLocationType value, JsonSerializerOptions options) { - GeneratedStringEnumJson.WriteValue(writer, value.Value, typeof(SubagentSettingsEntryContextTier)); + GeneratedStringEnumJson.WriteValue(writer, value.Value, typeof(PermissionLocationType)); } } } -/// The user's response: accept (submitted), decline (rejected), or cancel (dismissed). +/// The current agent mode for this session (e.g., 'interactive', 'plan', 'autopilot'). [Experimental(Diagnostics.Experimental)] [JsonConverter(typeof(Converter))] [DebuggerDisplay("{Value,nq}")] -public readonly struct UIElicitationResponseAction : 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 UIElicitationResponseAction(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 user submitted the requested form values. - public static UIElicitationResponseAction Accept { get; } = new("accept"); + /// The agent is responding interactively to the user. + public static MetadataSnapshotCurrentMode Interactive { get; } = new("interactive"); - /// The user explicitly declined to provide the requested input. - public static UIElicitationResponseAction Decline { get; } = new("decline"); + /// The agent is preparing a plan before making changes. + public static MetadataSnapshotCurrentMode Plan { get; } = new("plan"); - /// The user dismissed the elicitation request. - public static UIElicitationResponseAction Cancel { get; } = new("cancel"); + /// 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 ==(UIElicitationResponseAction left, UIElicitationResponseAction 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 !=(UIElicitationResponseAction left, UIElicitationResponseAction 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 UIElicitationResponseAction other && Equals(other); + public override bool Equals(object? obj) => obj is MetadataSnapshotCurrentMode other && Equals(other); /// - public bool Equals(UIElicitationResponseAction 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); @@ -18038,65 +27745,62 @@ 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 MetadataSnapshotCurrentMode 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, MetadataSnapshotCurrentMode value, JsonSerializerOptions options) { - GeneratedStringEnumJson.WriteValue(writer, value.Value, typeof(UIElicitationResponseAction)); + GeneratedStringEnumJson.WriteValue(writer, value.Value, typeof(MetadataSnapshotCurrentMode)); } } } -/// User's choice for auto-mode switching: yes (allow this turn), yes_always (allow + persist as setting), or no (decline). +/// 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 UIAutoModeSwitchResponse : 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 UIAutoModeSwitchResponse(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; - /// Allow the automatic mode switch for this turn. - public static UIAutoModeSwitchResponse Yes { get; } = new("yes"); - - /// Allow this mode switch and persist the preference. - public static UIAutoModeSwitchResponse YesAlways { get; } = new("yes_always"); + /// Remote task originated from Copilot Coding Agent. + public static MetadataSnapshotRemoteMetadataTaskType Cca { get; } = new("cca"); - /// Decline the automatic mode switch. - public static UIAutoModeSwitchResponse No { get; } = new("no"); + /// Remote task originated from a CLI remote-session invocation. + public static MetadataSnapshotRemoteMetadataTaskType Cli { get; } = new("cli"); - /// 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 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 !=(UIAutoModeSwitchResponse left, UIAutoModeSwitchResponse right) => !(left == 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 UIAutoModeSwitchResponse other && Equals(other); + public override bool Equals(object? obj) => obj is MetadataSnapshotRemoteMetadataTaskType other && Equals(other); /// - public bool Equals(UIAutoModeSwitchResponse 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); @@ -18104,68 +27808,62 @@ 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 MetadataSnapshotRemoteMetadataTaskType 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, MetadataSnapshotRemoteMetadataTaskType value, JsonSerializerOptions options) { - GeneratedStringEnumJson.WriteValue(writer, value.Value, typeof(UIAutoModeSwitchResponse)); + GeneratedStringEnumJson.WriteValue(writer, value.Value, typeof(MetadataSnapshotRemoteMetadataTaskType)); } } } -/// User action selected for an exhausted session limit. +/// Repository host type, if known. [Experimental(Diagnostics.Experimental)] [JsonConverter(typeof(Converter))] [DebuggerDisplay("{Value,nq}")] -public readonly struct UISessionLimitsExhaustedResponseAction : 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 UISessionLimitsExhaustedResponseAction(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; - /// Increase the current max by an exact AI Credits amount. - public static UISessionLimitsExhaustedResponseAction Add { get; } = new("add"); - - /// Set a new absolute max AI Credits value. - public static UISessionLimitsExhaustedResponseAction Set { get; } = new("set"); - - /// Remove the current session limit. - public static UISessionLimitsExhaustedResponseAction Unset { get; } = new("unset"); + /// Workspace summary repository is hosted on GitHub. + public static WorkspaceSummaryHostType GitHub { get; } = new("github"); - /// Leave the limit unchanged and cancel the blocked model request. - public static UISessionLimitsExhaustedResponseAction Cancel { get; } = new("cancel"); + /// 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 ==(UISessionLimitsExhaustedResponseAction left, UISessionLimitsExhaustedResponseAction 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 !=(UISessionLimitsExhaustedResponseAction left, UISessionLimitsExhaustedResponseAction 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 UISessionLimitsExhaustedResponseAction other && Equals(other); + public override bool Equals(object? obj) => obj is WorkspaceSummaryHostType other && Equals(other); /// - public bool Equals(UISessionLimitsExhaustedResponseAction 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); @@ -18173,68 +27871,62 @@ public UISessionLimitsExhaustedResponseAction(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 UISessionLimitsExhaustedResponseAction 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, UISessionLimitsExhaustedResponseAction value, JsonSerializerOptions options) + public override void Write(Utf8JsonWriter writer, WorkspaceSummaryHostType value, JsonSerializerOptions options) { - GeneratedStringEnumJson.WriteValue(writer, value.Value, typeof(UISessionLimitsExhaustedResponseAction)); + GeneratedStringEnumJson.WriteValue(writer, value.Value, typeof(WorkspaceSummaryHostType)); } } } -/// The action the user selected. Defaults to 'autopilot' when autoApproveEdits is true, otherwise 'interactive'. +/// Hosting platform type of the repository. [Experimental(Diagnostics.Experimental)] [JsonConverter(typeof(Converter))] [DebuggerDisplay("{Value,nq}")] -public readonly struct UIExitPlanModeAction : 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 UIExitPlanModeAction(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; - /// 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"); - - /// Exit plan mode and continue in autopilot mode. - public static UIExitPlanModeAction Autopilot { get; } = new("autopilot"); + /// The working directory repository is hosted on GitHub. + public static SessionWorkingDirectoryContextHostType GitHub { get; } = new("github"); - /// Exit plan mode and continue in autopilot mode with parallel subagent execution. - public static UIExitPlanModeAction AutopilotFleet { get; } = new("autopilot_fleet"); + /// 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 ==(UIExitPlanModeAction left, UIExitPlanModeAction 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 !=(UIExitPlanModeAction left, UIExitPlanModeAction 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 UIExitPlanModeAction other && Equals(other); + public override bool Equals(object? obj) => obj is SessionWorkingDirectoryContextHostType other && Equals(other); /// - public bool Equals(UIExitPlanModeAction 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); @@ -18242,62 +27934,113 @@ 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 SessionWorkingDirectoryContextHostType 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, SessionWorkingDirectoryContextHostType value, JsonSerializerOptions options) { - GeneratedStringEnumJson.WriteValue(writer, value.Value, typeof(UIExitPlanModeAction)); + GeneratedStringEnumJson.WriteValue(writer, value.Value, typeof(SessionWorkingDirectoryContextHostType)); } } } -/// Allowed values for the `PermissionsConfigureAdditionalContentExclusionPolicyScope` enumeration. +/// 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 PermissionsConfigureAdditionalContentExclusionPolicyScope : 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 PermissionsConfigureAdditionalContentExclusionPolicyScope(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; - /// The content exclusion policy applies to the current repository. - public static PermissionsConfigureAdditionalContentExclusionPolicyScope Repo { get; } = new("repo"); + /// Whether the security-tools feature flag enables security tool wiring. + public static SessionSettingsPredicateName SecurityToolsEnabled { get; } = new("securityToolsEnabled"); - /// The content exclusion policy applies across all repositories. - public static PermissionsConfigureAdditionalContentExclusionPolicyScope All { get; } = new("all"); + /// Whether third-party security tools should receive the security prompt. + public static SessionSettingsPredicateName ThirdPartySecurityPromptEnabled { get; } = new("thirdPartySecurityPromptEnabled"); - /// Returns a value indicating whether two instances are equivalent. - public static bool operator ==(PermissionsConfigureAdditionalContentExclusionPolicyScope left, PermissionsConfigureAdditionalContentExclusionPolicyScope right) => left.Equals(right); + /// Whether validation may run in parallel. + public static SessionSettingsPredicateName ParallelValidationEnabled { get; } = new("parallelValidationEnabled"); - /// Returns a value indicating whether two instances are not equivalent. - public static bool operator !=(PermissionsConfigureAdditionalContentExclusionPolicyScope left, PermissionsConfigureAdditionalContentExclusionPolicyScope right) => !(left == right); + /// Whether runtime timing telemetry is enabled. + public static SessionSettingsPredicateName RuntimeTimingTelemetryEnabled { get; } = new("runtimeTimingTelemetryEnabled"); + + /// 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 PermissionsConfigureAdditionalContentExclusionPolicyScope other && Equals(other); + public override bool Equals(object? obj) => obj is SessionSettingsPredicateName other && Equals(other); /// - public bool Equals(PermissionsConfigureAdditionalContentExclusionPolicyScope 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); @@ -18305,68 +28048,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 SessionSettingsPredicateName 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, SessionSettingsPredicateName value, JsonSerializerOptions options) { - GeneratedStringEnumJson.WriteValue(writer, value.Value, typeof(PermissionsConfigureAdditionalContentExclusionPolicyScope)); + GeneratedStringEnumJson.WriteValue(writer, value.Value, typeof(SessionSettingsPredicateName)); } } } -/// Optional source for allow-all telemetry. Defaults to `rpc` when omitted for SDK callers. +/// Signal to send (default: SIGTERM). [Experimental(Diagnostics.Experimental)] [JsonConverter(typeof(Converter))] [DebuggerDisplay("{Value,nq}")] -public readonly struct PermissionsSetApproveAllSource : 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 PermissionsSetApproveAllSource(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; - /// 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"); + /// Request graceful process termination. + public static ShellKillSignal SIGTERM { get; } = new("SIGTERM"); - /// Allow-all was enabled by confirming autopilot behavior. - public static PermissionsSetApproveAllSource AutopilotConfirmation { get; } = new("autopilot_confirmation"); + /// Forcefully terminate the process. + public static ShellKillSignal SIGKILL { get; } = new("SIGKILL"); - /// Allow-all was enabled through an RPC caller. - public static PermissionsSetApproveAllSource Rpc { get; } = new("rpc"); + /// 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 ==(PermissionsSetApproveAllSource left, PermissionsSetApproveAllSource 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 !=(PermissionsSetApproveAllSource left, PermissionsSetApproveAllSource 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 PermissionsSetApproveAllSource other && Equals(other); + public override bool Equals(object? obj) => obj is ShellKillSignal other && Equals(other); /// - public bool Equals(PermissionsSetApproveAllSource 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); @@ -18374,65 +28114,61 @@ 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 ShellKillSignal 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, ShellKillSignal value, JsonSerializerOptions options) { - GeneratedStringEnumJson.WriteValue(writer, value.Value, typeof(PermissionsSetApproveAllSource)); + GeneratedStringEnumJson.WriteValue(writer, value.Value, typeof(ShellKillSignal)); } } } -/// Current or requested allow-all mode. -[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 PermissionsAllowAllMode : 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 PermissionsAllowAllMode(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; - /// Permission requests follow the normal approval flow. - public static PermissionsAllowAllMode Off { get; } = new("off"); + /// User-requested compaction, e.g. the /compact command or a direct history.compact call. + public static SessionHistoryCompactRequestTrigger Manual { get; } = new("manual"); - /// Tool, path, and URL permission requests are automatically approved. - public static PermissionsAllowAllMode On { get; } = new("on"); + /// Compaction requested while switching to a model with a smaller context window. + public static SessionHistoryCompactRequestTrigger ModelSwitch { get; } = new("model_switch"); - /// 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 equivalent. + public static bool operator ==(SessionHistoryCompactRequestTrigger left, SessionHistoryCompactRequestTrigger right) => left.Equals(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); + /// 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 PermissionsAllowAllMode other && Equals(other); + public override bool Equals(object? obj) => obj is SessionHistoryCompactRequestTrigger other && Equals(other); /// - public bool Equals(PermissionsAllowAllMode 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); @@ -18440,68 +28176,65 @@ public PermissionsAllowAllMode(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 PermissionsAllowAllMode 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, PermissionsAllowAllMode value, JsonSerializerOptions options) + public override void Write(Utf8JsonWriter writer, SessionHistoryCompactRequestTrigger value, JsonSerializerOptions options) { - GeneratedStringEnumJson.WriteValue(writer, value.Value, typeof(PermissionsAllowAllMode)); + 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 PermissionsSetAllowAllSource : 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 PermissionsSetAllowAllSource(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 PermissionsSetAllowAllSource CliFlag { get; } = new("cli_flag"); - - /// Allow-all was enabled by a slash command. - public static PermissionsSetAllowAllSource 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 PermissionsSetAllowAllSource 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 PermissionsSetAllowAllSource 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 ==(PermissionsSetAllowAllSource left, PermissionsSetAllowAllSource 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 !=(PermissionsSetAllowAllSource left, PermissionsSetAllowAllSource 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 PermissionsSetAllowAllSource other && Equals(other); + public override bool Equals(object? obj) => obj is HistoryRewindChangeType other && Equals(other); /// - public bool Equals(PermissionsSetAllowAllSource 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); @@ -18509,62 +28242,83 @@ 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 HistoryRewindChangeType 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, HistoryRewindChangeType value, JsonSerializerOptions options) { - GeneratedStringEnumJson.WriteValue(writer, value.Value, typeof(PermissionsSetAllowAllSource)); + GeneratedStringEnumJson.WriteValue(writer, value.Value, typeof(HistoryRewindChangeType)); } } } -/// 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. +/// Outcome of a rewind request. [Experimental(Diagnostics.Experimental)] [JsonConverter(typeof(Converter))] [DebuggerDisplay("{Value,nq}")] -public readonly struct PermissionsModifyRulesScope : 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 PermissionsModifyRulesScope(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; - /// Apply the rule change only to this session. - public static PermissionsModifyRulesScope Session { get; } = new("session"); + /// The requested rewind completed; reachable in either mode. + public static HistoryRewindOutcome Success { get; } = new("success"); - /// Persist the rule change for this project location. - public static PermissionsModifyRulesScope Location { get; } = new("location"); + /// The session still has work that may mutate files or history; reachable in either mode. + public static HistoryRewindOutcome SessionBusy { get; } = new("session-busy"); - /// Returns a value indicating whether two instances are equivalent. - public static bool operator ==(PermissionsModifyRulesScope left, PermissionsModifyRulesScope right) => left.Equals(right); + /// 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"); - /// Returns a value indicating whether two instances are not equivalent. - public static bool operator !=(PermissionsModifyRulesScope left, PermissionsModifyRulesScope right) => !(left == right); + /// Remote-backed rewind routing is not supported; reachable in either mode. + public static HistoryRewindOutcome UnsupportedRemoteSession { get; } = new("unsupported-remote-session"); + + /// 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"); + + /// 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 PermissionsModifyRulesScope other && Equals(other); + public override bool Equals(object? obj) => obj is HistoryRewindOutcome other && Equals(other); /// - public bool Equals(PermissionsModifyRulesScope 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); @@ -18572,62 +28326,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 HistoryRewindOutcome 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, HistoryRewindOutcome value, JsonSerializerOptions options) { - GeneratedStringEnumJson.WriteValue(writer, value.Value, typeof(PermissionsModifyRulesScope)); + GeneratedStringEnumJson.WriteValue(writer, value.Value, typeof(HistoryRewindOutcome)); } } } -/// Whether the location is a git repo or directory. +/// Reason a captured file was not restored. [Experimental(Diagnostics.Experimental)] [JsonConverter(typeof(Converter))] [DebuggerDisplay("{Value,nq}")] -public readonly struct PermissionLocationType : 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 PermissionLocationType(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; - /// The permission location is persisted at the git repository root. - public static PermissionLocationType Repo { get; } = new("repo"); + /// The file changed after Copilot's last captured write. + public static HistoryFileRestoreSkipReason UserModified { get; } = new("user-modified"); - /// The permission location is persisted at the working directory. - public static PermissionLocationType Dir { get; } = new("dir"); + /// 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 ==(PermissionLocationType left, PermissionLocationType 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 !=(PermissionLocationType left, PermissionLocationType 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 PermissionLocationType other && Equals(other); + public override bool Equals(object? obj) => obj is HistoryFileRestoreSkipReason other && Equals(other); /// - public bool Equals(PermissionLocationType 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); @@ -18635,65 +28389,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 HistoryFileRestoreSkipReason 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, HistoryFileRestoreSkipReason value, JsonSerializerOptions options) { - GeneratedStringEnumJson.WriteValue(writer, value.Value, typeof(PermissionLocationType)); + GeneratedStringEnumJson.WriteValue(writer, value.Value, typeof(HistoryFileRestoreSkipReason)); } } } -/// The current agent mode for this session (e.g., 'interactive', 'plan', 'autopilot'). +/// Scope of a rewind operation. [Experimental(Diagnostics.Experimental)] [JsonConverter(typeof(Converter))] [DebuggerDisplay("{Value,nq}")] -public readonly struct MetadataSnapshotCurrentMode : 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 MetadataSnapshotCurrentMode(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 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"); - - /// The agent is working autonomously toward task completion. - public static MetadataSnapshotCurrentMode Autopilot { get; } = new("autopilot"); + /// Discard conversation events while leaving files unchanged. + public static HistoryRewindMode Conversation { get; } = new("conversation"); - /// Returns a value indicating whether two instances are equivalent. - public static bool operator ==(MetadataSnapshotCurrentMode left, MetadataSnapshotCurrentMode right) => left.Equals(right); + /// 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 not equivalent. - public static bool operator !=(MetadataSnapshotCurrentMode left, MetadataSnapshotCurrentMode right) => !(left == 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 !=(HistoryRewindMode left, HistoryRewindMode right) => !(left == right); /// - public override bool Equals(object? obj) => obj is MetadataSnapshotCurrentMode other && Equals(other); + public override bool Equals(object? obj) => obj is HistoryRewindMode other && Equals(other); /// - public bool Equals(MetadataSnapshotCurrentMode 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); @@ -18701,62 +28452,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 HistoryRewindMode 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, HistoryRewindMode value, JsonSerializerOptions options) { - GeneratedStringEnumJson.WriteValue(writer, value.Value, typeof(MetadataSnapshotCurrentMode)); + GeneratedStringEnumJson.WriteValue(writer, value.Value, typeof(HistoryRewindMode)); } } } -/// Whether the remote task originated from Copilot Coding Agent (cca) or a CLI `--remote` invocation. +/// 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 MetadataSnapshotRemoteMetadataTaskType : 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 MetadataSnapshotRemoteMetadataTaskType(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; - /// Remote task originated from Copilot Coding Agent. - public static MetadataSnapshotRemoteMetadataTaskType Cca { get; } = new("cca"); + /// A queued user message. + public static QueuePendingItemsKind Message { get; } = new("message"); - /// Remote task originated from a CLI remote-session invocation. - public static MetadataSnapshotRemoteMetadataTaskType Cli { get; } = new("cli"); + /// 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 ==(MetadataSnapshotRemoteMetadataTaskType left, MetadataSnapshotRemoteMetadataTaskType 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 !=(MetadataSnapshotRemoteMetadataTaskType left, MetadataSnapshotRemoteMetadataTaskType 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 MetadataSnapshotRemoteMetadataTaskType other && Equals(other); + public override bool Equals(object? obj) => obj is QueuePendingItemsKind other && Equals(other); /// - public bool Equals(MetadataSnapshotRemoteMetadataTaskType 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); @@ -18764,62 +28515,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 QueuePendingItemsKind 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, QueuePendingItemsKind value, JsonSerializerOptions options) { - GeneratedStringEnumJson.WriteValue(writer, value.Value, typeof(MetadataSnapshotRemoteMetadataTaskType)); + GeneratedStringEnumJson.WriteValue(writer, value.Value, typeof(QueuePendingItemsKind)); } } } -/// Repository host type, if known. +/// 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 WorkspaceSummaryHostType : 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 WorkspaceSummaryHostType(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; - /// Workspace summary repository is hosted on GitHub. - public static WorkspaceSummaryHostType GitHub { get; } = new("github"); + /// The cursor was applied successfully. + public static EventsCursorStatus Ok { get; } = new("ok"); - /// Workspace summary repository is hosted on Azure DevOps. - public static WorkspaceSummaryHostType Ado { get; } = new("ado"); + /// 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 ==(WorkspaceSummaryHostType left, WorkspaceSummaryHostType 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 !=(WorkspaceSummaryHostType left, WorkspaceSummaryHostType 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 WorkspaceSummaryHostType other && Equals(other); + public override bool Equals(object? obj) => obj is EventsCursorStatus other && Equals(other); /// - public bool Equals(WorkspaceSummaryHostType 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); @@ -18827,62 +28578,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 EventsCursorStatus 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, EventsCursorStatus value, JsonSerializerOptions options) { - GeneratedStringEnumJson.WriteValue(writer, value.Value, typeof(WorkspaceSummaryHostType)); + GeneratedStringEnumJson.WriteValue(writer, value.Value, typeof(EventsCursorStatus)); } } } -/// Hosting platform type of the repository. +/// 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 SessionWorkingDirectoryContextHostType : 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 SessionWorkingDirectoryContextHostType(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; - /// The working directory repository is hosted on GitHub. - public static SessionWorkingDirectoryContextHostType GitHub { get; } = new("github"); + /// Return main-agent events and typed subagent lifecycle events. + public static EventsAgentScope Primary { get; } = new("primary"); - /// The working directory repository is hosted on Azure DevOps. - public static SessionWorkingDirectoryContextHostType 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 ==(SessionWorkingDirectoryContextHostType left, SessionWorkingDirectoryContextHostType 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 !=(SessionWorkingDirectoryContextHostType left, SessionWorkingDirectoryContextHostType 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 SessionWorkingDirectoryContextHostType other && Equals(other); + public override bool Equals(object? obj) => obj is EventsAgentScope other && Equals(other); /// - public bool Equals(SessionWorkingDirectoryContextHostType 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); @@ -18890,113 +28641,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 EventsAgentScope 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, EventsAgentScope value, JsonSerializerOptions options) { - GeneratedStringEnumJson.WriteValue(writer, value.Value, typeof(SessionWorkingDirectoryContextHostType)); + GeneratedStringEnumJson.WriteValue(writer, value.Value, typeof(EventsAgentScope)); } } } -/// Rust-owned settings predicates exposed across the SDK boundary. Raw feature-flag names are intentionally not part of the contract. +/// 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 SessionSettingsPredicateName : 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 SessionSettingsPredicateName(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; - /// Whether the security-tools feature flag enables security tool wiring. - public static SessionSettingsPredicateName SecurityToolsEnabled { get; } = new("securityToolsEnabled"); - - /// Whether third-party security tools should receive the security prompt. - public static SessionSettingsPredicateName ThirdPartySecurityPromptEnabled { get; } = new("thirdPartySecurityPromptEnabled"); - - /// Whether validation may run in parallel. - public static SessionSettingsPredicateName ParallelValidationEnabled { get; } = new("parallelValidationEnabled"); - - /// Whether runtime timing telemetry is enabled. - public static SessionSettingsPredicateName RuntimeTimingTelemetryEnabled { get; } = new("runtimeTimingTelemetryEnabled"); - - /// 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"); + /// Page from the cursor toward newer events (default). + public static EventsReadDirection Forward { get; } = new("forward"); - /// Whether trivial-change skip behavior is enabled for a specific tool. - public static SessionSettingsPredicateName TrivialChangeSkipEnabledForTool { get; } = new("trivialChangeSkipEnabledForTool"); + /// 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 ==(SessionSettingsPredicateName left, SessionSettingsPredicateName 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 !=(SessionSettingsPredicateName left, SessionSettingsPredicateName 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 SessionSettingsPredicateName other && Equals(other); + public override bool Equals(object? obj) => obj is EventsReadDirection other && Equals(other); /// - public bool Equals(SessionSettingsPredicateName 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); @@ -19004,65 +28704,62 @@ public SessionSettingsPredicateName(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 SessionSettingsPredicateName 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, SessionSettingsPredicateName value, JsonSerializerOptions options) + public override void Write(Utf8JsonWriter writer, EventsReadDirection value, JsonSerializerOptions options) { - GeneratedStringEnumJson.WriteValue(writer, value.Value, typeof(SessionSettingsPredicateName)); + 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); @@ -19070,62 +28767,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"); - /// A queued slash command or model-change command. - public static QueuePendingItemsKind Command { get; } = new("command"); + /// Additional headroom for longer-running sessions. + public static SessionLimitPredictionTier AdditionalHeadroom { get; } = new("additional_headroom"); - /// Returns a value indicating whether two instances are equivalent. - public static bool operator ==(QueuePendingItemsKind left, QueuePendingItemsKind right) => left.Equals(right); + /// Generous headroom for unusually high usage. + public static SessionLimitPredictionTier GenerousHeadroom { get; } = new("generous_headroom"); - /// Returns a value indicating whether two instances are not equivalent. - public static bool operator !=(QueuePendingItemsKind left, QueuePendingItemsKind right) => !(left == right); + /// Maximum available headroom tier. + public static SessionLimitPredictionTier MaximumHeadroom { get; } = new("maximum_headroom"); + + /// 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); @@ -19133,62 +28836,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); @@ -19196,62 +28902,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); @@ -19259,20 +28965,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)); } } } @@ -19599,6 +29305,72 @@ 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))] @@ -19662,6 +29434,69 @@ public override void Write(Utf8JsonWriter writer, LlmInferenceHttpRequestStartTr } +/// Why the runtime is requesting a GitHub credential. +[Experimental(Diagnostics.Experimental)] +[JsonConverter(typeof(Converter))] +[DebuggerDisplay("{Value,nq}")] +public readonly struct GitHubTokenAcquireReason : IEquatable +{ + private readonly string? _value; + + /// Initializes a new instance of the struct. + /// The value to associate with this . + [JsonConstructor] + public GitHubTokenAcquireReason(string value) + { + ArgumentException.ThrowIfNullOrWhiteSpace(value); + _value = value; + } + + /// Gets the value associated with this . + public string Value => _value ?? string.Empty; + + /// The runtime is acquiring the registration's first credential. + public static GitHubTokenAcquireReason Initial { get; } = new("initial"); + + /// The runtime is replacing a credential that is approaching expiry. + public static GitHubTokenAcquireReason Refresh { get; } = new("refresh"); + + /// Returns a value indicating whether two instances are equivalent. + public static bool operator ==(GitHubTokenAcquireReason left, GitHubTokenAcquireReason right) => left.Equals(right); + + /// Returns a value indicating whether two instances are not equivalent. + public static bool operator !=(GitHubTokenAcquireReason left, GitHubTokenAcquireReason right) => !(left == right); + + /// + public override bool Equals(object? obj) => obj is GitHubTokenAcquireReason other && Equals(other); + + /// + public bool Equals(GitHubTokenAcquireReason 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 GitHubTokenAcquireReason Read(ref Utf8JsonReader reader, Type typeToConvert, JsonSerializerOptions options) + { + return new(GeneratedStringEnumJson.ReadValue(ref reader, typeToConvert)); + } + + /// + public override void Write(Utf8JsonWriter writer, GitHubTokenAcquireReason value, JsonSerializerOptions options) + { + GeneratedStringEnumJson.WriteValue(writer, value.Value, typeof(GitHubTokenAcquireReason)); + } + } +} + + /// Provides server-scoped RPC methods (no session required). public sealed class ServerRpc { @@ -19684,17 +29519,26 @@ public async Task PingAsync(string? message = null, CancellationToke } /// 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. + /// 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. + /// Identity of the integrating host. Optional; omit it to keep the default attribution. /// 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, in addition to the runtime's normal GitHub/CTS emission (dual-write). 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. /// The to monitor for cancellation requests. The default is . /// Handshake result reporting the server's protocol version and package version on success. [Experimental(Diagnostics.Experimental)] - internal async Task ConnectAsync(string? token = null, bool? enableGitHubTelemetryForwarding = null, CancellationToken cancellationToken = default) + internal async Task ConnectAsync(bool? enableGitHubTelemetryForwarding = null, ConnectClientInfo? clientInfo = null, string? token = null, CancellationToken cancellationToken = default) { - var request = new ConnectRequest { Token = token, EnableGitHubTelemetryForwarding = enableGitHubTelemetryForwarding }; + var request = new ConnectRequest { EnableGitHubTelemetryForwarding = enableGitHubTelemetryForwarding, ClientInfo = clientInfo, Token = token }; 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 ?? @@ -19725,6 +29569,18 @@ internal async Task ConnectAsync(string? token = null, bool? enab Interlocked.CompareExchange(ref field, new(_rpc), null) ?? field; + /// Extensions APIs. + public ServerExtensionsApi Extensions => + field ?? + Interlocked.CompareExchange(ref field, new(_rpc), null) ?? + field; + + /// Catalog APIs. + public ServerCatalogApi Catalog => + field ?? + Interlocked.CompareExchange(ref field, new(_rpc), null) ?? + field; + /// Plugins APIs. public ServerPluginsApi Plugins => field ?? @@ -19761,6 +29617,12 @@ internal async Task ConnectAsync(string? token = null, bool? enab 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 ?? @@ -19804,14 +29666,23 @@ internal ServerModelsApi(JsonRpc rpc) } /// Lists Copilot models available to the authenticated user. - /// 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. + /// Opaque account identifier returned by `account.getAllUsers`. When omitted, the current account is used. + /// GitHub token accepted for compatibility with existing SDK clients. When provided, resolves this token instead of using the current account. /// The to monitor for cancellation requests. The default is . /// List of Copilot models available to the resolved user, including capabilities and billing metadata. - public async Task ListAsync(string? gitHubToken = null, CancellationToken cancellationToken = default) + public async Task ListAsync(string? selectionId = null, string? gitHubToken = null, CancellationToken cancellationToken = default) { - var request = new ModelsListRequest { GitHubToken = gitHubToken }; + var request = new ModelsListRequest { SelectionId = selectionId, 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. @@ -19847,13 +29718,14 @@ internal ServerAccountApi(JsonRpc 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. + /// Gets Copilot quota usage for the current or opaquely selected authenticated user. + /// Opaque account identifier returned by `account.getAllUsers`. When omitted, the current account is used. + /// GitHub token accepted for compatibility with existing SDK clients. When provided, resolves this token instead of using the current account. /// 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) + public async Task GetQuotaAsync(string? selectionId = null, string? gitHubToken = null, CancellationToken cancellationToken = default) { - var request = new AccountGetQuotaRequest { GitHubToken = gitHubToken }; + var request = new AccountGetQuotaRequest { SelectionId = selectionId, GitHubToken = gitHubToken }; return await CopilotClient.InvokeRpcAsync(_rpc, "account.getQuota", [request], cancellationToken); } @@ -19873,31 +29745,29 @@ public async Task> GetAllUsersAsync(CancellationToken can return await CopilotClient.InvokeRpcAsync>(_rpc, "account.getAllUsers", [], cancellationToken); } - /// Stores authentication credentials after successful login (e.g., device code flow). + /// Validates and stores authentication credentials. When login is omitted, resolves the authenticated user from the token before persistence. /// GitHub host URL. - /// User login/username. /// GitHub authentication token. + /// User login/username. When omitted, the runtime validates the token and resolves the login from GitHub. /// 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) + public async Task LoginAsync(string host, string token, string? login = null, CancellationToken cancellationToken = default) { ArgumentNullException.ThrowIfNull(host); - ArgumentNullException.ThrowIfNull(login); ArgumentNullException.ThrowIfNull(token); - var request = new AccountLoginRequest { Host = host, Login = login, Token = token }; + var request = new AccountLoginRequest { Host = host, Token = token, Login = login }; return await CopilotClient.InvokeRpcAsync(_rpc, "account.login", [request], cancellationToken); } /// Removes user authentication from keychain and persisted state. + /// Opaque account identifier returned by `account.getAllUsers`. /// Authentication information for the user to log out. /// The to monitor for cancellation requests. The default is . /// Logout result indicating if more users remain. - public async Task LogoutAsync(AuthInfo authInfo, CancellationToken cancellationToken = default) + public async Task LogoutAsync(string? selectionId = null, AuthInfo? authInfo = null, CancellationToken cancellationToken = default) { - ArgumentNullException.ThrowIfNull(authInfo); - - var request = new AccountLogoutRequest { AuthInfo = authInfo }; + var request = new AccountLogoutRequest { SelectionId = selectionId, AuthInfo = authInfo }; return await CopilotClient.InvokeRpcAsync(_rpc, "account.logout", [request], cancellationToken); } } @@ -19947,6 +29817,21 @@ public async Task DiscoverAsync(string? workingDirectory = nu return await CopilotClient.InvokeRpcAsync(_rpc, "mcp.discover", [request], cancellationToken); } + /// Requests a side-effect-free MCP install plan from a catalog candidate handle or a caller-supplied card. This host-implemented server method is available through SDK/TUI hosts; standalone and C-ABI runtimes whose host does not implement server-method dispatch return JSON-RPC MethodNotFound. A runtime with planning available returns a normalised plan and opaque single-use plan handle; a runtime without it returns the typed planning-unavailable result. A completed plan reports resource identity, provenance, eligible transport choices, the user-scope target, required typed values and secret placeholders, the policy result, the configuration changes installing would make, and whether a reload would be needed. Planning never writes configuration, stores a secret, or reloads MCP servers, so abandoning a plan needs no call and leaves nothing behind. + /// Protocol version and capabilities the caller requires. + /// What to plan: either a candidate handle from a previous search, or a card supplied directly. + /// Configuration scope the plan targets. Defaults to user scope when omitted. + /// The to monitor for cancellation requests. The default is . + /// Outcome of an mcp.planInstall call: either a normalised plan, or one typed refusal. Nothing is written in either case. + public async Task PlanInstallAsync(CatalogClientContract contract, McpPlanInstallSource source, McpPlanScope? scope = null, CancellationToken cancellationToken = default) + { + ArgumentNullException.ThrowIfNull(contract); + ArgumentNullException.ThrowIfNull(source); + + var request = new McpPlanInstallRequest { Contract = contract, Source = source, Scope = scope }; + return await CopilotClient.InvokeRpcAsync(_rpc, "mcp.planInstall", [request], cancellationToken); + } + /// Config APIs. public ServerMcpConfigApi Config => field ?? @@ -20040,6 +29925,76 @@ 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 Catalog APIs. +[Experimental(Diagnostics.Experimental)] +public sealed class ServerCatalogApi +{ + private readonly JsonRpc _rpc; + + internal ServerCatalogApi(JsonRpc rpc) + { + _rpc = rpc; + } + + /// Requests a bounded catalog search. This host-implemented server method is available through SDK/TUI hosts; standalone and C-ABI runtimes whose host does not implement server-method dispatch return JSON-RPC MethodNotFound. A runtime with search available returns inert candidate summaries, each with an opaque single-use handle scoped to this runtime instance; a runtime without it returns the typed search-unavailable result. Public authorities may be searched anonymously, while an authority that requires credentials yields the typed authentication-required result. All returned text, URLs, and package metadata are untrusted external data and can never trigger instructions, tools, or installation. Read-only: nothing is installed, configured, or persisted. + /// Protocol version and capabilities the caller requires. + /// Free-text search query. Never written to logs or telemetry. + /// Maximum number of candidates to return. Defaults to 10 when omitted. + /// Restrict results to these candidate kinds. When omitted, every kind the runtime supports is searched. + /// The to monitor for cancellation requests. The default is . + /// Outcome of a catalog.search call: either bounded inert candidates, or one typed refusal. Never a partial success. + public async Task SearchAsync(CatalogClientContract contract, string query, int? limit = null, IList? kinds = null, CancellationToken cancellationToken = default) + { + ArgumentNullException.ThrowIfNull(contract); + ArgumentNullException.ThrowIfNull(query); + + var request = new CatalogSearchRequest { Contract = contract, Query = query, Limit = limit, Kinds = kinds }; + return await CopilotClient.InvokeRpcAsync(_rpc, "catalog.search", [request], cancellationToken); + } +} + /// Provides server-scoped Plugins APIs. [Experimental(Diagnostics.Experimental)] public sealed class ServerPluginsApi @@ -20126,6 +30081,12 @@ public async Task DisableAsync(IList names, CancellationToken cancellati await CopilotClient.InvokeRpcAsync(_rpc, "plugins.disable", [request], cancellationToken); } + /// Builtin APIs. + public ServerPluginsBuiltinApi Builtin => + field ?? + Interlocked.CompareExchange(ref field, new(_rpc), null) ?? + field; + /// Marketplaces APIs. public ServerPluginsMarketplacesApi Marketplaces => field ?? @@ -20133,6 +30094,29 @@ public async Task DisableAsync(IList names, CancellationToken cancellati field; } +/// Provides server-scoped PluginsBuiltin APIs. +[Experimental(Diagnostics.Experimental)] +public sealed class ServerPluginsBuiltinApi +{ + private readonly JsonRpc _rpc; + + internal ServerPluginsBuiltinApi(JsonRpc rpc) + { + _rpc = rpc; + } + + /// Replaces this server's trusted built-in plugin directories while no sessions are active. + /// Complete replacement set of trusted built-in plugin directories. Every entry must be an absolute local filesystem path no longer than 4096 characters. + /// The to monitor for cancellation requests. The default is . + public async Task SetAsync(IList paths, CancellationToken cancellationToken = default) + { + ArgumentNullException.ThrowIfNull(paths); + + var request = new PluginsBuiltinSetRequest { Paths = paths }; + await CopilotClient.InvokeRpcAsync(_rpc, "plugins.builtin.set", [request], cancellationToken); + } +} + /// Provides server-scoped PluginsMarketplaces APIs. [Experimental(Diagnostics.Experimental)] public sealed class ServerPluginsMarketplacesApi @@ -20263,6 +30247,18 @@ public async Task SetDisabledSkillsAsync(IList disabledSkills, Cancellat var request = new SkillsConfigSetDisabledSkillsRequest { DisabledSkills = disabledSkills }; await CopilotClient.InvokeRpcAsync(_rpc, "skills.config.setDisabledSkills", [request], cancellationToken); } + + /// Atomically adds or removes one skill from the disabled list. + /// Name of the skill to add to or remove from the disabled list. + /// True to disable the skill, false to enable it. + /// The to monitor for cancellation requests. The default is . + public async Task SetSkillDisabledAsync(string name, bool disabled, CancellationToken cancellationToken = default) + { + ArgumentNullException.ThrowIfNull(name); + + var request = new SkillsConfigSetSkillDisabledRequest { Name = name, Disabled = disabled }; + await CopilotClient.InvokeRpcAsync(_rpc, "skills.config.setSkillDisabled", [request], cancellationToken); + } } /// Provides server-scoped Agents APIs. @@ -20410,6 +30406,26 @@ public async Task SetAsync(object settings, CancellationT } } +/// 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 @@ -20479,7 +30495,7 @@ public async Task SetProviderAsync(CancellationTo /// 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. + /// HTTP response headers, preserving multiple values per name. /// Optional HTTP status reason phrase. /// The to monitor for cancellation requests. The default is . /// Whether the start frame was accepted. @@ -20569,6 +30585,28 @@ public async Task ListAsync(SessionSource? source = null, long? met 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 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 . + /// Recent local session IDs that contain user-visible history. + internal async Task ListNonEmptySessionIdsAsync(long? limit = null, CancellationToken cancellationToken = default) + { + 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. /// GitHub task ID to look up. /// The to monitor for cancellation requests. The default is . @@ -20671,6 +30709,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. @@ -20827,28 +30877,25 @@ public async Task GetRemoteControlStatusAsync(Cancell /// 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. - /// 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. /// 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, object loader, SessionsRegisterExtensionToolsOnSessionOptions? options = null, CancellationToken cancellationToken = default) + internal async Task RegisterExtensionToolsOnSessionAsync(string sessionId, SessionsRegisterExtensionToolsOnSessionOptions? options = null, CancellationToken cancellationToken = default) { ArgumentNullException.ThrowIfNull(sessionId); - ArgumentNullException.ThrowIfNull(loader); - var request = new RegisterExtensionToolsParams { SessionId = sessionId, Loader = CopilotClient.ToJsonElementForWire(loader)!.Value, Options = options }; + 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. - /// 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. /// The to monitor for cancellation requests. The default is . - internal async Task ConfigureSessionExtensionsAsync(string sessionId, object? controller = null, CancellationToken cancellationToken = default) + internal async Task ConfigureSessionExtensionsAsync(string sessionId, CancellationToken cancellationToken = default) { ArgumentNullException.ThrowIfNull(sessionId); - var request = new ConfigureSessionExtensionsParams { SessionId = sessionId, Controller = CopilotClient.ToJsonElementForWire(controller) }; + var request = new ConfigureSessionExtensionsParams { SessionId = sessionId }; await CopilotClient.InvokeRpcAsync(_rpc, "sessions.configureSessionExtensions", [request], cancellationToken); } } @@ -21062,6 +31109,12 @@ internal SessionRpc(CopilotSession session) 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 ?? @@ -21086,8 +31139,14 @@ internal SessionRpc(CopilotSession session) Interlocked.CompareExchange(ref field, new(_session), null) ?? field; - /// Usage APIs. - public UsageApi Usage => + /// Usage APIs. + public UsageApi Usage => + field ?? + Interlocked.CompareExchange(ref field, new(_session), null) ?? + field; + + /// LimitPrediction APIs. + public LimitPredictionApi LimitPrediction => field ?? Interlocked.CompareExchange(ref field, new(_session), null) ?? field; @@ -21129,12 +31188,12 @@ 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. Must match one of three forms: the literal `system`, `command-<command-id>` for messages originating from a command (e.g. slash command, Mission Control command), or `schedule-<numeric-id>` for messages originating from a scheduled job. + /// 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)] @@ -21155,7 +31214,7 @@ public async Task SendAsync(string prompt, string? displayPrompt = n /// 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. + /// 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)] @@ -21168,6 +31227,21 @@ public async Task SendMessagesAsync(IList m 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 . @@ -21181,6 +31255,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'. @@ -21240,13 +31339,112 @@ public async Task GetStatusAsync(CancellationToken cancellati /// 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) + public async Task SetCredentialsAsync(SettableAuthInfo? 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); } + + /// Gets the current authentication information for internal session hosts. + /// The to monitor for cancellation requests. The default is . + /// Current authentication information, or null when no authentication is active. + internal async Task GetCurrentAuthInfoAsync(CancellationToken cancellationToken = default) + { + _session.ThrowIfDisposed(); + + var request = new SessionGitHubAuthGetCurrentAuthInfoRequest { SessionId = _session.SessionId }; + return await CopilotClient.InvokeRpcAsync(_session.Rpc, "session.gitHubAuth.getCurrentAuthInfo", [request], cancellationToken); + } + + /// Gets all authentication accounts available to the internal session host. + /// The to monitor for cancellation requests. The default is . + /// Authentication accounts available to the internal session host. + internal async Task> GetAllAuthAvailableAsync(CancellationToken cancellationToken = default) + { + _session.ThrowIfDisposed(); + + var request = new SessionGitHubAuthGetAllAuthAvailableRequest { SessionId = _session.SessionId }; + return await CopilotClient.InvokeRpcAsync>(_session.Rpc, "session.gitHubAuth.getAllAuthAvailable", [request], cancellationToken); + } + + /// Refreshes Copilot account metadata for the current authentication. + /// The to monitor for cancellation requests. The default is . + /// Current authentication information, or null when no authentication is active. + internal async Task RefreshCopilotUserAsync(CancellationToken cancellationToken = default) + { + _session.ThrowIfDisposed(); + + var request = new SessionGitHubAuthRefreshCopilotUserRequest { SessionId = _session.SessionId }; + return await CopilotClient.InvokeRpcAsync(_session.Rpc, "session.gitHubAuth.refreshCopilotUser", [request], cancellationToken); + } + + /// Logs in a GitHub user through the internal session host. + /// GitHub host URL. + /// GitHub login. + /// GitHub authentication token. + /// Whether to persist the token after login. + /// The to monitor for cancellation requests. The default is . + /// Authentication credentials accepted only at native protocol ingress. Runtime outputs use credential-free `AuthIdentity` metadata. + internal async Task LoginAsync(string host, string login, string token, bool? persist = null, CancellationToken cancellationToken = default) + { + ArgumentNullException.ThrowIfNull(host); + ArgumentNullException.ThrowIfNull(login); + ArgumentNullException.ThrowIfNull(token); + _session.ThrowIfDisposed(); + + var request = new SessionAuthLoginRequest { SessionId = _session.SessionId, Host = host, Login = login, Token = token, Persist = persist }; + return await CopilotClient.InvokeRpcAsync(_session.Rpc, "session.gitHubAuth.login", [request], cancellationToken); + } + + /// Switches the session to another available authentication. + /// Authentication information to activate. + /// Optional token paired with the authentication information. + /// The to monitor for cancellation requests. The default is . + internal async Task SwitchToAuthAsync(AuthInfo authInfo, string? token = null, CancellationToken cancellationToken = default) + { + ArgumentNullException.ThrowIfNull(authInfo); + _session.ThrowIfDisposed(); + + var request = new SessionAuthSwitchRequest { SessionId = _session.SessionId, AuthInfo = authInfo, Token = token }; + await CopilotClient.InvokeRpcAsync(_session.Rpc, "session.gitHubAuth.switchToAuth", [request], cancellationToken); + } + + /// Logs out the session's current GitHub authentication. + /// The to monitor for cancellation requests. The default is . + /// Whether the current authentication was logged out. + internal async Task LogoutAsync(CancellationToken cancellationToken = default) + { + _session.ThrowIfDisposed(); + + var request = new SessionGitHubAuthLogoutRequest { SessionId = _session.SessionId }; + return await CopilotClient.InvokeRpcAsync(_session.Rpc, "session.gitHubAuth.logout", [request], cancellationToken); + } + + /// Logs out a specific GitHub authentication. + /// Authentication information to log out. + /// The to monitor for cancellation requests. The default is . + /// Whether the requested authentication was logged out. + internal async Task LogoutUserAsync(AuthInfo authInfo, CancellationToken cancellationToken = default) + { + ArgumentNullException.ThrowIfNull(authInfo); + _session.ThrowIfDisposed(); + + var request = new SessionAuthLogoutUserRequest { SessionId = _session.SessionId, AuthInfo = authInfo }; + return await CopilotClient.InvokeRpcAsync(_session.Rpc, "session.gitHubAuth.logoutUser", [request], cancellationToken); + } + + /// Gets validation errors from the most recent authentication attempt. + /// The to monitor for cancellation requests. The default is . + /// Validation errors from the most recent authentication attempt. + internal async Task> LastAuthErrorsAsync(CancellationToken cancellationToken = default) + { + _session.ThrowIfDisposed(); + + var request = new SessionGitHubAuthLastAuthErrorsRequest { SessionId = _session.SessionId }; + return await CopilotClient.InvokeRpcAsync>(_session.Rpc, "session.gitHubAuth.lastAuthErrors", [request], cancellationToken); + } } /// Provides session-scoped Debug APIs. @@ -21343,6 +31541,12 @@ public async Task CloseAsync(string instanceId, CancellationToken cancellationTo field ?? Interlocked.CompareExchange(ref field, new(_session), null) ?? field; + + /// Provider APIs. + public CanvasProviderApi Provider => + field ?? + Interlocked.CompareExchange(ref field, new(_session), null) ?? + field; } /// Provides session-scoped CanvasAction APIs. @@ -21373,6 +31577,46 @@ public async Task InvokeAsync(string instanceId, strin } } +/// Provides session-scoped CanvasProvider APIs. +[Experimental(Diagnostics.Experimental)] +public sealed class CanvasProviderApi +{ + private readonly CopilotSession _session; + + internal CanvasProviderApi(CopilotSession session) + { + _session = session; + } + + /// Registers an internal canvas provider connection and its contributions. + /// Connection identifier for callback routing. + /// Provider metadata supplied by the host. + /// Canvas contributions supplied by the provider. + /// The to monitor for cancellation requests. The default is . + internal async Task RegisterAsync(string connectionId, object info, IList canvases, CancellationToken cancellationToken = default) + { + ArgumentNullException.ThrowIfNull(connectionId); + ArgumentNullException.ThrowIfNull(info); + ArgumentNullException.ThrowIfNull(canvases); + _session.ThrowIfDisposed(); + + var request = new CanvasProviderRegisterRequest { SessionId = _session.SessionId, ConnectionId = connectionId, Info = CopilotClient.ToJsonElementForWire(info)!.Value, Canvases = canvases.Select(static v => CopilotClient.ToJsonElementForWire(v)!.Value).ToList() }; + await CopilotClient.InvokeRpcAsync(_session.Rpc, "session.canvas.provider.register", [request], cancellationToken); + } + + /// Unregisters an internal canvas provider connection. + /// Connection identifier to unregister. + /// The to monitor for cancellation requests. The default is . + internal async Task UnregisterAsync(string connectionId, CancellationToken cancellationToken = default) + { + ArgumentNullException.ThrowIfNull(connectionId); + _session.ThrowIfDisposed(); + + var request = new CanvasProviderUnregisterRequest { SessionId = _session.SessionId, ConnectionId = connectionId }; + await CopilotClient.InvokeRpcAsync(_session.Rpc, "session.canvas.provider.unregister", [request], cancellationToken); + } +} + /// Provides session-scoped Factory APIs. [Experimental(Diagnostics.Experimental)] public sealed class FactoryApi @@ -21400,6 +31644,54 @@ public async Task RunAsync(string name, object args, RunOption return await CopilotClient.InvokeRpcAsync(_session.Rpc, "session.factory.run", [request], cancellationToken); } + /// Resumes a factory run using its persisted name, arguments, journal, and accounting. + /// Factory run identifier. + /// Optional per-invocation resource ceiling overrides. + /// Whether to notify the originating session when the factory completes. + /// Whether to emit factory phase names to the session transcript. + /// The to monitor for cancellation requests. The default is . + /// Resolved persisted factory identity and resumed run envelope. + public async Task ResumeAsync(string runId, FactoryRunLimits? limits = null, bool? notifyOnComplete = null, bool? logPhaseNames = null, CancellationToken cancellationToken = default) + { + ArgumentNullException.ThrowIfNull(runId); + _session.ThrowIfDisposed(); + + var request = new FactoryResumeRequest { SessionId = _session.SessionId, RunId = runId, Limits = limits, NotifyOnComplete = notifyOnComplete, LogPhaseNames = logPhaseNames }; + return await CopilotClient.InvokeRpcAsync(_session.Rpc, "session.factory.resume", [request], cancellationToken); + } + + /// Internal tool-originated factory invocation. + /// Registered factory name. + /// Factory input value. + /// Tool-originated factory invocation options. + /// Opaque identifier of the originating tool call. + /// The to monitor for cancellation requests. The default is . + /// Complete current or terminal factory run envelope. + internal async Task RunFromToolAsync(string name, object args, FactoryToolRunOptions? options = null, string? toolCallId = null, CancellationToken cancellationToken = default) + { + ArgumentNullException.ThrowIfNull(name); + ArgumentNullException.ThrowIfNull(args); + _session.ThrowIfDisposed(); + + var request = new FactoryToolRunRequest { SessionId = _session.SessionId, Name = name, Args = CopilotClient.ToJsonElementForWire(args)!.Value, Options = options, ToolCallId = toolCallId }; + return await CopilotClient.InvokeRpcAsync(_session.Rpc, "session.factory.runFromTool", [request], cancellationToken); + } + + /// Internal tool-originated factory resume. + /// Factory run identifier. + /// Optional per-invocation resource ceiling overrides. + /// Opaque identifier of the originating tool call. + /// The to monitor for cancellation requests. The default is . + /// Resolved persisted factory identity and resumed run envelope. + internal async Task ResumeFromToolAsync(string runId, FactoryRunLimits? limits = null, string? toolCallId = null, CancellationToken cancellationToken = default) + { + ArgumentNullException.ThrowIfNull(runId); + _session.ThrowIfDisposed(); + + var request = new FactoryToolResumeRequest { SessionId = _session.SessionId, RunId = runId, Limits = limits, ToolCallId = toolCallId }; + return await CopilotClient.InvokeRpcAsync(_session.Rpc, "session.factory.resumeFromTool", [request], cancellationToken); + } + /// Gets the current or settled envelope for a factory run. /// Factory run identifier. /// The to monitor for cancellation requests. The default is . @@ -21413,6 +31705,50 @@ public async Task GetRunAsync(string runId, CancellationToken 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.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); + } + + /// Gets durable and live observability detail for one factory run. + /// Factory run identifier. + /// The to monitor for cancellation requests. The default is . + /// Full factory run observability detail. + public async Task GetRunDetailAsync(string runId, CancellationToken cancellationToken = default) + { + ArgumentNullException.ThrowIfNull(runId); + _session.ThrowIfDisposed(); + + var request = new FactoryGetRunRequest { SessionId = _session.SessionId, RunId = runId }; + return await CopilotClient.InvokeRpcAsync(_session.Rpc, "session.factory.getRunDetail", [request], cancellationToken); + } + + /// 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 . + /// 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 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); + } + /// Requests cancellation of a factory run and returns its run envelope. /// Factory run identifier. /// The to monitor for cancellation requests. The default is . @@ -21428,33 +31764,37 @@ public async Task CancelAsync(string runId, CancellationToken /// 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 . /// Acknowledgement that a factory request was accepted. - public async Task LogAsync(string runId, IList lines, CancellationToken cancellationToken = default) + public async Task LogAsync(string runId, string executionToken, IList lines, CancellationToken cancellationToken = default) { ArgumentNullException.ThrowIfNull(runId); + ArgumentNullException.ThrowIfNull(executionToken); ArgumentNullException.ThrowIfNull(lines); _session.ThrowIfDisposed(); - var request = new FactoryLogRequest { SessionId = _session.SessionId, RunId = runId, Lines = lines }; + var request = new FactoryLogRequest { SessionId = _session.SessionId, RunId = runId, ExecutionToken = executionToken, Lines = lines }; return await CopilotClient.InvokeRpcAsync(_session.Rpc, "session.factory.log", [request], cancellationToken); } /// 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 prompt, FactoryAgentOptions opts, CancellationToken cancellationToken = default) + 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, Prompt = prompt, Opts = opts }; + 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); } @@ -21478,33 +31818,37 @@ internal FactoryJournalApi(CopilotSession session) /// 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 . /// Result of reading a factory journal entry. - public async Task GetAsync(string runId, string key, CancellationToken cancellationToken = default) + public async Task GetAsync(string runId, string executionToken, string key, CancellationToken cancellationToken = default) { ArgumentNullException.ThrowIfNull(runId); + ArgumentNullException.ThrowIfNull(executionToken); ArgumentNullException.ThrowIfNull(key); _session.ThrowIfDisposed(); - var request = new FactoryJournalGetRequest { SessionId = _session.SessionId, RunId = runId, Key = key }; + 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 key, object resultJson, CancellationToken cancellationToken = default) + 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, Key = key, ResultJson = CopilotClient.ToJsonElementForWire(resultJson)!.Value }; + 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); } } @@ -21533,22 +31877,48 @@ public async Task GetCurrentAsync(CancellationToken cancellationTo /// Switches the session to a model and optional reasoning configuration. /// 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. "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 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"` apply the requested tier; omit this field to use normal model behavior with no explicit tier. + /// Origin to record on the effective `session.model_change` event. Defaults to `sdk` when omitted. + /// 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). + /// Explicit response to a model-switch compaction preflight. Omit to request a confirmation projection when compaction is necessary. + /// When true, evaluate context-window compaction policy before applying the switch. + /// Optional repository settings scope to persist after the switch commits. + /// Settings scope used when persisting the selected model. + /// Require the target to be currently available and enabled before applying the switch. + /// Optional settings context and explicit-override flags used to persist a picker selection. /// 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, Verbosity? verbosity = null, ModelCapabilitiesOverride? modelCapabilities = null, ContextTier? 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, ModelChangeSource? source = null, bool? deferIfModelChangeQueued = null, string? compactionDecision = null, bool? runCompactionPreflight = null, string? repoScope = null, string? modelChangeScope = null, bool? requireAvailable = null, ModelPickerPersistenceRequest? pickerPersistence = null, CancellationToken cancellationToken = default) { ArgumentNullException.ThrowIfNull(modelId); _session.ThrowIfDisposed(); - var request = new ModelSwitchToRequest { SessionId = _session.SessionId, ModelId = modelId, ReasoningEffort = reasoningEffort, ReasoningSummary = reasoningSummary, Verbosity = verbosity, ModelCapabilities = modelCapabilities, ContextTier = contextTier }; + var request = new ModelSwitchToRequest { SessionId = _session.SessionId, ModelId = modelId, ReasoningEffort = reasoningEffort, ReasoningSummary = reasoningSummary, Verbosity = verbosity, ModelCapabilities = modelCapabilities, ContextTier = contextTier, Source = source, DeferIfModelChangeQueued = deferIfModelChangeQueued, CompactionDecision = compactionDecision, RunCompactionPreflight = runCompactionPreflight, RepoScope = repoScope, ModelChangeScope = modelChangeScope, RequireAvailable = requireAvailable, PickerPersistence = pickerPersistence }; return await CopilotClient.InvokeRpcAsync(_session.Rpc, "session.model.switchTo", [request], cancellationToken); } + /// Resolves and applies organization-managed and repository model overlays. + /// Model required by device-managed policy, when configured. + /// Model required by server-managed policy, when configured. + /// Model selected by repository settings, when configured. + /// Reasoning effort selected by repository settings, when configured. + /// Context tier selected by repository settings, when configured. + /// Model explicitly selected by the CLI, when provided. + /// Whether the overlay is being applied while resuming a deferred session. + /// The to monitor for cancellation requests. The default is . + /// The model identifier active on the session after the switch. + internal async Task ApplyStartupOverlayAsync(string? deviceManagedModel = null, string? serverManagedModel = null, string? repoModel = null, string? repoReasoningEffort = null, string? repoContextTier = null, string? cliModel = null, bool? deferredResume = null, CancellationToken cancellationToken = default) + { + _session.ThrowIfDisposed(); + + var request = new ModelApplyStartupOverlayRequest { SessionId = _session.SessionId, DeviceManagedModel = deviceManagedModel, ServerManagedModel = serverManagedModel, RepoModel = repoModel, RepoReasoningEffort = repoReasoningEffort, RepoContextTier = repoContextTier, CliModel = cliModel, DeferredResume = deferredResume }; + return await CopilotClient.InvokeRpcAsync(_session.Rpc, "session.model.applyStartupOverlay", [request], cancellationToken); + } + /// Updates the session's reasoning effort without changing the selected model. /// 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. /// The to monitor for cancellation requests. The default is . @@ -21566,11 +31936,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); } } @@ -21599,13 +31969,24 @@ public async Task GetAsync(CancellationToken cancellationToken = de /// Sets the current agent interaction mode. /// The session mode the agent is operating in. - /// The to monitor for cancellation requests. The default is . - public async Task SetAsync(SessionMode mode, CancellationToken cancellationToken = default) + /// Session whose plan-mode base state should be inherited. + /// Whether a dedicated plan model is configured. + /// Dedicated model to use in plan mode, when configured. + /// Reasoning effort to use with the dedicated plan model. + /// Context tier to use with the dedicated plan model. + /// Explicit response to a model-switch compaction preflight. + /// Whether leaving plan mode should restore the session's previous model. + /// Whether the selected plan model should be persisted. + /// Settings context used when persisting the selected plan model. + /// Action to perform when leaving plan mode. + /// The to monitor for cancellation requests. The default is . + /// Outcome of a session mode change, including any model switch it triggered and follow-up the host must perform. + public async Task SetAsync(SessionMode mode, string? inheritPlanBaseFromSessionId = null, bool? planModelConfigured = null, string? planModel = null, string? planReasoningEffort = null, string? planContextTier = null, string? compactionDecision = null, bool? restorePlanModel = null, bool? persistPlanSelection = null, ModelPickerSettingsContext? pickerSettingsContext = null, string? planExitAction = null, CancellationToken cancellationToken = default) { _session.ThrowIfDisposed(); - var request = new ModeSetRequest { SessionId = _session.SessionId, Mode = mode }; - await CopilotClient.InvokeRpcAsync(_session.Rpc, "session.mode.set", [request], cancellationToken); + var request = new ModeSetRequest { SessionId = _session.SessionId, Mode = mode, InheritPlanBaseFromSessionId = inheritPlanBaseFromSessionId, PlanModelConfigured = planModelConfigured, PlanModel = planModel, PlanReasoningEffort = planReasoningEffort, PlanContextTier = planContextTier, CompactionDecision = compactionDecision, RestorePlanModel = restorePlanModel, PersistPlanSelection = persistPlanSelection, PickerSettingsContext = pickerSettingsContext, PlanExitAction = planExitAction }; + return await CopilotClient.InvokeRpcAsync(_session.Rpc, "session.mode.set", [request], cancellationToken); } } @@ -21746,6 +32127,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. @@ -21807,6 +32213,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 . @@ -21820,7 +32299,7 @@ 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 . @@ -21929,15 +32408,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 . - /// Custom agents available to the session. - public async Task ListAsync(CancellationToken cancellationToken = default) + /// Agents available to the session. + public async Task ListAsync(SessionAgentListRequest? request = null, CancellationToken cancellationToken = default) { _session.ThrowIfDisposed(); - var request = new SessionAgentListRequest { SessionId = _session.SessionId }; - return await CopilotClient.InvokeRpcAsync(_session.Rpc, "session.agent.list", [request], cancellationToken); + 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 . + public async Task SetPromptAsync(string id, string prompt, CancellationToken cancellationToken = default) + { + ArgumentNullException.ThrowIfNull(id); + ArgumentNullException.ThrowIfNull(prompt); + _session.ThrowIfDisposed(); + + 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. @@ -22000,7 +32494,7 @@ internal TasksApi(CopilotSession session) /// Starts a background agent task in the session. /// Type of agent to start (e.g., 'explore', 'task', 'general-purpose'). /// Task prompt for the agent. - /// Short name for the agent, used to generate a human-readable ID. + /// Friendly, non-unique name used when displaying the agent. /// Short description of the task. /// Optional model override. /// The to monitor for cancellation requests. The default is . @@ -22288,16 +32782,25 @@ public async Task ReloadAsync(CancellationToken cancellationToken = default) await CopilotClient.InvokeRpcAsync(_session.Rpc, "session.mcp.reload", [request], cancellationToken); } + /// Releases any turns waiting on an in-flight MCP load without cancelling the load, letting the agent proceed while MCP servers finish connecting in the background. No-op when no MCP load is in flight or waiting turns were already released. + /// The to monitor for cancellation requests. The default is . + /// Result of moving in-flight MCP loading to the background. + public async Task MoveLoadingToBackgroundAsync(CancellationToken cancellationToken = default) + { + _session.ThrowIfDisposed(); + + var request = new SessionMcpMoveLoadingToBackgroundRequest { SessionId = _session.SessionId }; + return await CopilotClient.InvokeRpcAsync(_session.Rpc, "session.mcp.moveLoadingToBackground", [request], cancellationToken); + } + /// Reloads MCP server connections for the session with an explicit host-provided configuration. - /// Opaque runtime MCP reload configuration. Marked internal: an in-process runtime shape (reloadMcpServers throws over the wire). /// The to monitor for cancellation requests. The default is . /// MCP server startup filtering result. - internal async Task ReloadWithConfigAsync(object config, CancellationToken cancellationToken = default) + internal async Task ReloadWithConfigAsync(CancellationToken cancellationToken = default) { - ArgumentNullException.ThrowIfNull(config); _session.ThrowIfDisposed(); - var request = new McpReloadWithConfigRequest { SessionId = _session.SessionId, Config = CopilotClient.ToJsonElementForWire(config)!.Value }; + var request = new McpReloadWithConfigRequest { SessionId = _session.SessionId }; return await CopilotClient.InvokeRpcAsync(_session.Rpc, "session.mcp.reloadWithConfig", [request], cancellationToken); } @@ -22357,29 +32860,26 @@ public async Task RemoveGitHubAsync(CancellationToken can } /// Configures the built-in GitHub MCP server for the session's current auth context. - /// Opaque runtime auth info for GitHub MCP configuration. Marked internal: an in-process runtime shape (configureGitHubMcp is a no-op over the wire). /// The to monitor for cancellation requests. The default is . /// Result of configuring GitHub MCP. - internal async Task ConfigureGitHubAsync(object authInfo, CancellationToken cancellationToken = default) + internal async Task ConfigureGitHubAsync(CancellationToken cancellationToken = default) { - ArgumentNullException.ThrowIfNull(authInfo); _session.ThrowIfDisposed(); - var request = new McpConfigureGitHubRequest { SessionId = _session.SessionId, AuthInfo = CopilotClient.ToJsonElementForWire(authInfo)!.Value }; + 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 from a caller-supplied config. 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. + /// 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). + /// 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, CancellationToken cancellationToken = default) + public async Task StartServerAsync(string serverName, object? config = null, CancellationToken cancellationToken = default) { ArgumentNullException.ThrowIfNull(serverName); - ArgumentNullException.ThrowIfNull(config); _session.ThrowIfDisposed(); - var request = new McpStartServerRequest { SessionId = _session.SessionId, ServerName = serverName, Config = CopilotClient.ToJsonElementForWire(config)!.Value }; + var request = new McpStartServerRequest { SessionId = _session.SessionId, ServerName = serverName, Config = CopilotClient.ToJsonElementForWire(config) }; await CopilotClient.InvokeRpcAsync(_session.Rpc, "session.mcp.startServer", [request], cancellationToken); } @@ -22410,19 +32910,13 @@ public async Task StopServerAsync(string serverName, CancellationToken cancellat /// 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. - /// In-process MCP Client instance. Marked internal: cannot be serialized across the JSON-RPC boundary. - /// In-process MCP Transport instance. Marked internal: cannot be serialized across the JSON-RPC boundary. - /// In-process server config (MCPServerConfig) paired with the in-process client/transport. Marked internal alongside its companions. /// The to monitor for cancellation requests. The default is . - internal async Task RegisterExternalClientAsync(string serverName, object client, object transport, object config, CancellationToken cancellationToken = default) + internal async Task RegisterExternalClientAsync(string serverName, CancellationToken cancellationToken = default) { ArgumentNullException.ThrowIfNull(serverName); - ArgumentNullException.ThrowIfNull(client); - ArgumentNullException.ThrowIfNull(transport); - ArgumentNullException.ThrowIfNull(config); _session.ThrowIfDisposed(); - var request = new McpRegisterExternalClientRequest { SessionId = _session.SessionId, ServerName = serverName, Client = CopilotClient.ToJsonElementForWire(client)!.Value, Transport = CopilotClient.ToJsonElementForWire(transport)!.Value, Config = CopilotClient.ToJsonElementForWire(config)!.Value }; + var request = new McpRegisterExternalClientRequest { SessionId = _session.SessionId, ServerName = serverName }; await CopilotClient.InvokeRpcAsync(_session.Rpc, "session.mcp.registerExternalClient", [request], cancellationToken); } @@ -22502,6 +32996,18 @@ public async Task HandlePendingRequestAsync(string 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. @@ -22521,6 +33027,32 @@ public async Task LoginAsync(string serverName, bool? force 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); } + + /// Passively probes a configured remote MCP server to classify whether OAuth is required or a cached/override token is accepted. Does not start OAuth, emit pending OAuth requests, or mutate MCP connection state. + /// Name of the configured remote MCP server to probe. + /// The to monitor for cancellation requests. The default is . + /// Passive MCP OAuth probe result. `authenticated` means the server accepted the probe request while an OAuth-origin access token was attached; it does not prove the server required or independently validated that token. The probe does not make a second unauthenticated request. Failed is an expected probe-domain outcome; JSON-RPC errors are reserved for API-call failures. + public async Task ProbeAsync(string serverName, CancellationToken cancellationToken = default) + { + ArgumentNullException.ThrowIfNull(serverName); + _session.ThrowIfDisposed(); + + var request = new McpOauthProbeRequest { SessionId = _session.SessionId, ServerName = serverName }; + return await CopilotClient.InvokeRpcAsync(_session.Rpc, "session.mcp.oauth.probe", [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. @@ -22726,11 +33258,11 @@ public async Task ListAsync(CancellationToken cancellationToken = de /// 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(PluginsReloadRequest? request = null, CancellationToken cancellationToken = default) + public async Task ReloadAsync(SessionPluginsReloadRequest? request = null, CancellationToken cancellationToken = default) { _session.ThrowIfDisposed(); - var rpcRequest = new PluginsReloadRequestWithSession { SessionId = _session.SessionId, ReloadMcp = request?.ReloadMcp, ReloadCustomAgents = request?.ReloadCustomAgents, ReloadHooks = request?.ReloadHooks, ReloadExtensions = request?.ReloadExtensions, DeferRepoHooks = request?.DeferRepoHooks }; + 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); } } @@ -22750,11 +33282,11 @@ internal ProviderApi(CopilotSession session) /// 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(ProviderGetEndpointRequest? request = null, CancellationToken cancellationToken = default) + public async Task GetEndpointAsync(SessionProviderGetEndpointRequest? request = null, CancellationToken cancellationToken = default) { _session.ThrowIfDisposed(); - var rpcRequest = new ProviderGetEndpointRequestWithSession { SessionId = _session.SessionId, ModelId = request?.ModelId }; + var rpcRequest = new SessionProviderGetEndpointRequestWithSession { SessionId = _session.SessionId, ModelId = request?.ModelId }; return await CopilotClient.InvokeRpcAsync(_session.Rpc, "session.provider.getEndpoint", [rpcRequest], cancellationToken); } @@ -22786,7 +33318,7 @@ internal OptionsApi(CopilotSession session) /// Patches the genuinely-mutable subset of session options. /// The model ID to use for assistant turns. /// Per-property model capability overrides for the selected model. - /// 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. /// Reasoning summary mode for supported model clients. /// Output verbosity level for supported models. /// Identifier of the client driving the session. @@ -22803,15 +33335,18 @@ internal OptionsApi(CopilotSession session) /// 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). + /// 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. + /// Origin of the sandbox choice. The runtime uses this only for internal telemetry provenance; managed policy is derived independently. /// 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. + /// Built-in skill names to include in this session. When specified, only these runtime-bundled skills are available. Skills from other sources with the same name remain available. Set to null to remove the allowlist restriction. /// 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. @@ -22828,6 +33363,7 @@ 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. + /// 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. @@ -22841,11 +33377,11 @@ internal OptionsApi(CopilotSession session) /// 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, 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, 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, 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) + 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, SandboxConfigSource? sandboxConfigSource = null, bool? logInteractiveShells = null, OptionsUpdateEnvValueMode? envValueMode = null, bool? allowAllMcpServerInstructions = null, IList? skillDirectories = null, IList? includedBuiltinSkills = 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, 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, 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, AdditionalContentExclusionPolicies = additionalContentExclusionPolicies, ManageScheduleEnabled = manageScheduleEnabled, SessionCapabilities = sessionCapabilities, SkipEmbeddingRetrieval = skipEmbeddingRetrieval, OrganizationCustomInstructions = organizationCustomInstructions, EnableFileHooks = enableFileHooks, EnableHostGitOperations = enableHostGitOperations, EnableSessionStore = enableSessionStore, EnableSkills = enableSkills, ContextTier = contextTier, SessionLimits = sessionLimits }; + 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, SandboxConfigSource = sandboxConfigSource, LogInteractiveShells = logInteractiveShells, EnvValueMode = envValueMode, AllowAllMcpServerInstructions = allowAllMcpServerInstructions, SkillDirectories = skillDirectories, IncludedBuiltinSkills = includedBuiltinSkills, 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); } } @@ -22956,6 +33492,55 @@ internal ToolsApi(CopilotSession session) _session = session; } + /// Executes one tool from the session's currently offered tool set through the native invocation pipeline. + /// Name of the currently offered tool to execute. + /// Arguments supplied to the tool. + /// Optional identifier used to correlate this invocation with its tool call. + /// The to monitor for cancellation requests. The default is . + /// Canonical result returned by a session tool. + public async Task ExecuteAsync(string name, object arguments, string? toolCallId = null, CancellationToken cancellationToken = default) + { + ArgumentNullException.ThrowIfNull(name); + ArgumentNullException.ThrowIfNull(arguments); + _session.ThrowIfDisposed(); + + var request = new ToolsExecuteRequest { SessionId = _session.SessionId, Name = name, Arguments = CopilotClient.ToJsonElementForWire(arguments)!.Value, ToolCallId = toolCallId }; + return await CopilotClient.InvokeRpcAsync(_session.Rpc, "session.tools.execute", [request], cancellationToken); + } + + /// Returns the Rust-owned built-in tool descriptors used to construct the session's offered tool set. + /// Whether descriptors should favor fewer user-intervention prompts. + /// Whether tool descriptors should include authoring metadata. + /// Whether semantic skill lookup is available. + /// Shell-specific names and description lines for shell tools. + /// Whether the configured shell supports PowerShell 7 syntax. + /// Default shell timeout in milliseconds. + /// Whether background task completion notifications are enabled. + /// The to monitor for cancellation requests. The default is . + /// Rust-owned built-in tool descriptors for the session. + public async Task GetBuiltinDescriptorsAsync(bool? reduceUserIntervention = null, bool? includeAuthor = null, bool? skillEmbeddingEnabled = null, ToolsShellDescriptorConfig? shellConfig = null, bool? shellSupportsPowerShell7Syntax = null, double? shellTimeoutMs = null, bool? backgroundTaskNotificationsEnabled = null, CancellationToken cancellationToken = default) + { + _session.ThrowIfDisposed(); + + var request = new ToolsGetBuiltinDescriptorsRequest { SessionId = _session.SessionId, ReduceUserIntervention = reduceUserIntervention, IncludeAuthor = includeAuthor, SkillEmbeddingEnabled = skillEmbeddingEnabled, ShellConfig = shellConfig, ShellSupportsPowerShell7Syntax = shellSupportsPowerShell7Syntax, ShellTimeoutMs = shellTimeoutMs, BackgroundTaskNotificationsEnabled = backgroundTaskNotificationsEnabled }; + return await CopilotClient.InvokeRpcAsync(_session.Rpc, "session.tools.getBuiltinDescriptors", [request], cancellationToken); + } + + /// Projects a completed task_complete tool call into its label-safe session event payload. + /// Arguments supplied to the completed task_complete tool call. + /// Final expanded result returned by the task_complete tool. + /// The to monitor for cancellation requests. The default is . + /// Task completion notification with summary from the agent. + public async Task TaskCompleteEventDataAsync(object toolArgs, ToolResultExpanded finalResult, CancellationToken cancellationToken = default) + { + ArgumentNullException.ThrowIfNull(toolArgs); + ArgumentNullException.ThrowIfNull(finalResult); + _session.ThrowIfDisposed(); + + var request = new ToolsTaskCompleteEventDataRequest { SessionId = _session.SessionId, ToolArgs = CopilotClient.ToJsonElementForWire(toolArgs)!.Value, FinalResult = finalResult }; + return await CopilotClient.InvokeRpcAsync(_session.Rpc, "session.tools.taskCompleteEventData", [request], cancellationToken); + } + /// Provides the result for a pending external tool call. /// Request ID of the pending tool call. /// Tool call result (string or expanded result object). @@ -22993,6 +33578,19 @@ public async Task GetCurrentMetadataAsync(Cancell return await CopilotClient.InvokeRpcAsync(_session.Rpc, "session.tools.getCurrentMetadata", [request], cancellationToken); } + /// Atomically replaces the complete externally implemented tool list supplied by the calling connection. Built-in, MCP/plugin, extension-discovered, subagent, and tools supplied by other connections remain unchanged. + /// Complete replacement list for the calling connection. + /// The to monitor for cancellation requests. The default is . + /// Empty result after replacing the calling connection's externally implemented tools. + public async Task SetAsync(IList tools, CancellationToken cancellationToken = default) + { + ArgumentNullException.ThrowIfNull(tools); + _session.ThrowIfDisposed(); + + var request = new ToolsSetRequest { SessionId = _session.SessionId, Tools = tools }; + return await CopilotClient.InvokeRpcAsync(_session.Rpc, "session.tools.set", [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 . @@ -23021,28 +33619,43 @@ 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); } /// Invokes a slash command in the session. /// Command name. Leading slashes are stripped and the name is matched case-insensitively. /// Raw input after the command name. + /// Optional client surface that initiated the invocation. /// The to monitor for cancellation requests. The default is . /// 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) + public async Task InvokeAsync(string name, string? input = null, CommandsInvocationOrigin? origin = null, CancellationToken cancellationToken = default) { ArgumentNullException.ThrowIfNull(name); _session.ThrowIfDisposed(); - var request = new CommandsInvokeRequest { SessionId = _session.SessionId, Name = name, Input = input }; + var request = new CommandsInvokeRequest { SessionId = _session.SessionId, Name = name, Input = input, Origin = origin }; return await CopilotClient.InvokeRpcAsync(_session.Rpc, "session.commands.invoke", [request], cancellationToken); } + /// Finalizes persistence associated with a client-applied slash-command effect. + /// The slash-command result object that produced the pending effect, echoed back unchanged. + /// Whether the host applied or cancelled the pending invocation effect. + /// The to monitor for cancellation requests. The default is . + /// Whether finalizing the invocation effect succeeded, and the failure reason when it did not. + internal async Task FinalizeInvocationEffectAsync(CommandsFinalizeInvocationEffectRequestEffect effect, CommandsInvocationEffectOutcome outcome, CancellationToken cancellationToken = default) + { + ArgumentNullException.ThrowIfNull(effect); + _session.ThrowIfDisposed(); + + var request = new CommandsFinalizeInvocationEffectRequest { SessionId = _session.SessionId, Effect = effect, Outcome = outcome }; + return await CopilotClient.InvokeRpcAsync(_session.Rpc, "session.commands.finalizeInvocationEffect", [request], cancellationToken); + } + /// Reports completion of a pending client-handled slash command. /// Request ID from the command invocation event. /// Error message if the command handler failed. @@ -23149,31 +33762,32 @@ internal UiApi(CopilotSession session) /// Runs a transient no-tools model query against the current conversation context. /// Question to answer from the current conversation context. - /// 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. - /// 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. /// The to monitor for cancellation requests. The default is . - /// Transient answer generated from current conversation context. - public async Task EphemeralQueryAsync(string question, object? onChunk = null, object? abortSignal = null, CancellationToken cancellationToken = default) + /// Completed transient query. Ordered chunks and the terminal outcome are also delivered through `ui.ephemeral_query` session events while it runs. + public async Task EphemeralQueryAsync(string question, CancellationToken cancellationToken = default) { ArgumentNullException.ThrowIfNull(question); _session.ThrowIfDisposed(); - var request = new UIEphemeralQueryRequest { SessionId = _session.SessionId, Question = question, OnChunk = CopilotClient.ToJsonElementForWire(onChunk), AbortSignal = CopilotClient.ToJsonElementForWire(abortSignal) }; + 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. + /// Elicitation mode. Omitted and form are equivalent for structured elicitation. + /// MCP request metadata. + /// MCP task metadata. /// The to monitor for cancellation requests. The default is . /// The elicitation response (accept with form values, decline, or cancel). - public async Task ElicitationAsync(string message, UIElicitationSchema requestedSchema, CancellationToken cancellationToken = default) + public async Task ElicitationAsync(string message, UIElicitationSchema requestedSchema, McpElicitationFormMode? mode = null, UIElicitationRequestMeta? _meta = null, McpTaskMetadata? task = null, CancellationToken cancellationToken = default) { ArgumentNullException.ThrowIfNull(message); ArgumentNullException.ThrowIfNull(requestedSchema); _session.ThrowIfDisposed(); - var request = new UIElicitationRequest { SessionId = _session.SessionId, Message = message, RequestedSchema = requestedSchema }; + var request = new UIElicitationRequest { SessionId = _session.SessionId, Message = message, RequestedSchema = requestedSchema, Mode = mode, Meta = _meta, Task = task }; return await CopilotClient.InvokeRpcAsync(_session.Rpc, "session.ui.elicitation", [request], cancellationToken); } @@ -23321,15 +33935,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); } @@ -23357,30 +33972,29 @@ public async Task SetApproveAllAsync(bool enable return await CopilotClient.InvokeRpcAsync(_session.Rpc, "session.permissions.setApproveAll", [request], cancellationToken); } - /// 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's active model is used. - /// Optional source for allow-all telemetry. Defaults to `rpc` when omitted for SDK callers. + /// Sets the permission mode for the session. `manual` follows the normal approval flow, `assisted` attaches LLM safety recommendations, and `allow-all` automatically approves permission requests. The result returns the authoritative post-mutation mode so callers can update local state without racing the `session.permissions_changed` notification. + /// Permission mode to apply. + /// Optional judge model id for assisted mode. When omitted, the session resolves the provider default: `gpt-5.5` for CAPI sessions and the active session model for BYOK sessions. + /// Optional source for permission-mode 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(PermissionsAllowAllMode? mode = null, bool? enabled = null, string? model = null, PermissionsSetAllowAllSource? source = null, CancellationToken cancellationToken = default) + /// Indicates whether the requested permission mode was applied and reports the authoritative post-mutation mode. + public async Task SetModeAsync(PermissionMode mode, string? assistedApprovalModel = null, PermissionModeSource? source = null, CancellationToken cancellationToken = default) { _session.ThrowIfDisposed(); - 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); + var request = new PermissionsSetModeRequest { SessionId = _session.SessionId, Mode = mode, AssistedApprovalModel = assistedApprovalModel, Source = source }; + return await CopilotClient.InvokeRpcAsync(_session.Rpc, "session.permissions.setMode", [request], cancellationToken); } - /// Returns the current allow-all permission mode for the session. + /// Returns the current permission mode for the session. /// The to monitor for cancellation requests. The default is . - /// Current allow-all permission mode. - public async Task GetAllowAllAsync(CancellationToken cancellationToken = default) + /// Current permission mode. + public async Task GetModeAsync(CancellationToken cancellationToken = default) { _session.ThrowIfDisposed(); - var request = new PermissionsGetAllowAllRequest { SessionId = _session.SessionId }; - return await CopilotClient.InvokeRpcAsync(_session.Rpc, "session.permissions.getAllowAll", [request], cancellationToken); + var request = new PermissionsGetModeRequest { SessionId = _session.SessionId }; + return await CopilotClient.InvokeRpcAsync(_session.Rpc, "session.permissions.getMode", [request], cancellationToken); } /// Adds or removes session-scoped or location-scoped permission rules. @@ -23411,13 +34025,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); } @@ -23481,8 +34096,8 @@ public async Task ListAsync(CancellationToken cancellationT return await CopilotClient.InvokeRpcAsync(_session.Rpc, "session.permissions.paths.list", [request], cancellationToken); } - /// Adds a directory to the session's allow-list. - /// Directory to add to the allow-list. The runtime resolves and validates the path before adding. + /// Adds a directory to the session's allow-list and activates conventional skill and agent definitions under it. + /// Directory to add to the allow-list. The runtime resolves and validates the path before adding, then loads conventional `.github/skills/` and `.github/agents/` definitions under it when their subsystem gates are enabled. Adding the directory is therefore also a trust decision for configuration stored there. /// The to monitor for cancellation requests. The default is . /// Indicates whether the operation succeeded. public async Task AddAsync(string path, CancellationToken cancellationToken = default) @@ -23806,6 +34421,31 @@ internal async Task EvaluatePredicateAsy } } +/// 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 @@ -23817,7 +34457,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). @@ -23832,7 +34472,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 . @@ -23890,11 +34530,11 @@ internal HistoryApi(CopilotSession session) /// 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) + public async Task CompactAsync(SessionHistoryCompactRequest? request = null, CancellationToken cancellationToken = default) { _session.ThrowIfDisposed(); - var rpcRequest = new HistoryCompactRequestWithSession { SessionId = _session.SessionId, CustomInstructions = request?.CustomInstructions }; + 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); } @@ -23911,6 +34551,44 @@ public async Task TruncateAsync(string eventId, Cancellat 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 request = new HistoryPreviewRewindRequest { SessionId = _session.SessionId, EventId = eventId }; + return await CopilotClient.InvokeRpcAsync(_session.Rpc, "session.history.previewRewind", [request], cancellationToken); + } + + /// 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 . + /// 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 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. /// The to monitor for cancellation requests. The default is . /// Indicates whether an in-progress background compaction was cancelled. @@ -23943,6 +34621,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. @@ -23967,6 +34658,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. + /// Queued message contents and delivery metadata. + /// 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. + /// Stable opaque ID of the queued item to remove. + /// 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. + /// Stable opaque ID of the queued item to edit. + /// Replacement prompt sent to the model. + /// Optional replacement prompt displayed to the user. + /// 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. + /// Stable opaque ID of the queued item to duplicate. + /// 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. + /// Whether queued-lane draining should be paused. + /// 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. + /// Stable opaque ID of the queued item to steer into the live turn. + /// 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. @@ -23987,6 +34830,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. @@ -24000,19 +34877,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, long? 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); } @@ -24077,6 +34957,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 @@ -24180,6 +35084,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 . @@ -24274,11 +35277,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 . @@ -24416,6 +35424,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; @@ -24443,6 +35457,17 @@ 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 @@ -24469,14 +35494,31 @@ public interface IGitHubTelemetryHandler Task EventAsync(GitHubTelemetryNotification request, CancellationToken cancellationToken = default); } +/// Handles `gitHubToken` client global API methods. +[Experimental(Diagnostics.Experimental)] +public interface IGitHubTokenHandler +{ + /// Asks the SDK client to mint a GitHub access token for a session whose configuration supplied a GitHub token provider. The runtime acquires the initial token during bootstrap and refreshes it during expiry preflight when one hour or less remains. + /// Asks the SDK client to acquire a GitHub access token from an opaque callback registration. + /// The to monitor for cancellation requests. The default is . + /// SDK host response to a GitHub credential request. + Task GetTokenAsync(GitHubTokenAcquireRequest 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; } + + /// Optional handler for GitHubToken client global API methods. + public IGitHubTokenHandler? GitHubToken { get; set; } } /// Registers client global API handlers on a JSON-RPC connection. @@ -24490,6 +35532,11 @@ internal static class ClientGlobalApiRegistration /// 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"); @@ -24505,6 +35552,11 @@ public static void RegisterClientGlobalApiHandlers(JsonRpc rpc, ClientGlobalApiH var handler = handlers.GitHubTelemetry ?? throw new InvalidOperationException("No gitHubTelemetry client-global handler registered"); await handler.EventAsync(request, cancellationToken); }), singleObjectParam: true); + rpc.SetLocalRpcMethod("gitHubToken.getToken", (Func>)(async (request, cancellationToken) => + { + var handler = handlers.GitHubToken ?? throw new InvalidOperationException("No gitHubToken client-global handler registered"); + return await handler.GetTokenAsync(request, cancellationToken); + }), singleObjectParam: true); } } @@ -24520,6 +35572,13 @@ public static void RegisterClientGlobalApiHandlers(JsonRpc rpc, ClientGlobalApiH [JsonSerializable(typeof(GitHub.Copilot.AbortData), TypeInfoPropertyName = "SessionEventsAbortData")] [JsonSerializable(typeof(GitHub.Copilot.AbortEvent), TypeInfoPropertyName = "SessionEventsAbortEvent")] [JsonSerializable(typeof(GitHub.Copilot.AbortReason), TypeInfoPropertyName = "SessionEventsAbortReason")] +[JsonSerializable(typeof(GitHub.Copilot.AgentInterruptedActivity), TypeInfoPropertyName = "SessionEventsAgentInterruptedActivity")] +[JsonSerializable(typeof(GitHub.Copilot.AgentInterruptedCancelPhase), TypeInfoPropertyName = "SessionEventsAgentInterruptedCancelPhase")] +[JsonSerializable(typeof(GitHub.Copilot.AgentInterruptedData), TypeInfoPropertyName = "SessionEventsAgentInterruptedData")] +[JsonSerializable(typeof(GitHub.Copilot.AgentInterruptedEvent), TypeInfoPropertyName = "SessionEventsAgentInterruptedEvent")] +[JsonSerializable(typeof(GitHub.Copilot.AssistantFusionPhaseCompletedEvent), TypeInfoPropertyName = "SessionEventsAssistantFusionPhaseCompletedEvent")] +[JsonSerializable(typeof(GitHub.Copilot.AssistantFusionPhaseFailedEvent), TypeInfoPropertyName = "SessionEventsAssistantFusionPhaseFailedEvent")] +[JsonSerializable(typeof(GitHub.Copilot.AssistantFusionPhaseStartedEvent), TypeInfoPropertyName = "SessionEventsAssistantFusionPhaseStartedEvent")] [JsonSerializable(typeof(GitHub.Copilot.AssistantIdleData), TypeInfoPropertyName = "SessionEventsAssistantIdleData")] [JsonSerializable(typeof(GitHub.Copilot.AssistantIdleEvent), TypeInfoPropertyName = "SessionEventsAssistantIdleEvent")] [JsonSerializable(typeof(GitHub.Copilot.AssistantIntentData), TypeInfoPropertyName = "SessionEventsAssistantIntentData")] @@ -24528,6 +35587,7 @@ public static void RegisterClientGlobalApiHandlers(JsonRpc rpc, ClientGlobalApiH [JsonSerializable(typeof(GitHub.Copilot.AssistantMessageDeltaData), TypeInfoPropertyName = "SessionEventsAssistantMessageDeltaData")] [JsonSerializable(typeof(GitHub.Copilot.AssistantMessageDeltaEvent), TypeInfoPropertyName = "SessionEventsAssistantMessageDeltaEvent")] [JsonSerializable(typeof(GitHub.Copilot.AssistantMessageEvent), TypeInfoPropertyName = "SessionEventsAssistantMessageEvent")] +[JsonSerializable(typeof(GitHub.Copilot.AssistantMessageReasoningBlocks), TypeInfoPropertyName = "SessionEventsAssistantMessageReasoningBlocks")] [JsonSerializable(typeof(GitHub.Copilot.AssistantMessageServerTools), TypeInfoPropertyName = "SessionEventsAssistantMessageServerTools")] [JsonSerializable(typeof(GitHub.Copilot.AssistantMessageStartData), TypeInfoPropertyName = "SessionEventsAssistantMessageStartData")] [JsonSerializable(typeof(GitHub.Copilot.AssistantMessageStartEvent), TypeInfoPropertyName = "SessionEventsAssistantMessageStartEvent")] @@ -24554,6 +35614,9 @@ public static void RegisterClientGlobalApiHandlers(JsonRpc rpc, ClientGlobalApiH [JsonSerializable(typeof(GitHub.Copilot.AssistantUsageCopilotUsageTokenDetail), TypeInfoPropertyName = "SessionEventsAssistantUsageCopilotUsageTokenDetail")] [JsonSerializable(typeof(GitHub.Copilot.AssistantUsageData), TypeInfoPropertyName = "SessionEventsAssistantUsageData")] [JsonSerializable(typeof(GitHub.Copilot.AssistantUsageEvent), TypeInfoPropertyName = "SessionEventsAssistantUsageEvent")] +[JsonSerializable(typeof(GitHub.Copilot.AssistantUsageTransport), TypeInfoPropertyName = "SessionEventsAssistantUsageTransport")] +[JsonSerializable(typeof(GitHub.Copilot.AssistedApprovalJudgeFailureReason), TypeInfoPropertyName = "SessionEventsAssistedApprovalJudgeFailureReason")] +[JsonSerializable(typeof(GitHub.Copilot.AssistedApprovalRecommendation), TypeInfoPropertyName = "SessionEventsAssistedApprovalRecommendation")] [JsonSerializable(typeof(GitHub.Copilot.Attachment), TypeInfoPropertyName = "SessionEventsAttachment")] [JsonSerializable(typeof(GitHub.Copilot.AttachmentBlob), TypeInfoPropertyName = "SessionEventsAttachmentBlob")] [JsonSerializable(typeof(GitHub.Copilot.AttachmentDirectory), TypeInfoPropertyName = "SessionEventsAttachmentDirectory")] @@ -24577,7 +35640,6 @@ public static void RegisterClientGlobalApiHandlers(JsonRpc rpc, ClientGlobalApiH [JsonSerializable(typeof(GitHub.Copilot.AttachmentSelectionDetails), TypeInfoPropertyName = "SessionEventsAttachmentSelectionDetails")] [JsonSerializable(typeof(GitHub.Copilot.AttachmentSelectionDetailsEnd), TypeInfoPropertyName = "SessionEventsAttachmentSelectionDetailsEnd")] [JsonSerializable(typeof(GitHub.Copilot.AttachmentSelectionDetailsStart), TypeInfoPropertyName = "SessionEventsAttachmentSelectionDetailsStart")] -[JsonSerializable(typeof(GitHub.Copilot.AutoApprovalRecommendation), TypeInfoPropertyName = "SessionEventsAutoApprovalRecommendation")] [JsonSerializable(typeof(GitHub.Copilot.AutoModeResolvedReasoningBucket), TypeInfoPropertyName = "SessionEventsAutoModeResolvedReasoningBucket")] [JsonSerializable(typeof(GitHub.Copilot.AutoModeSwitchCompletedData), TypeInfoPropertyName = "SessionEventsAutoModeSwitchCompletedData")] [JsonSerializable(typeof(GitHub.Copilot.AutoModeSwitchCompletedEvent), TypeInfoPropertyName = "SessionEventsAutoModeSwitchCompletedEvent")] @@ -24615,6 +35677,7 @@ public static void RegisterClientGlobalApiHandlers(JsonRpc rpc, ClientGlobalApiH [JsonSerializable(typeof(GitHub.Copilot.CommandsChangedEvent), TypeInfoPropertyName = "SessionEventsCommandsChangedEvent")] [JsonSerializable(typeof(GitHub.Copilot.CompactionCompleteCompactionTokensUsed), TypeInfoPropertyName = "SessionEventsCompactionCompleteCompactionTokensUsed")] [JsonSerializable(typeof(GitHub.Copilot.CompactionCompleteCompactionTokensUsedCopilotUsageTokenDetail), TypeInfoPropertyName = "SessionEventsCompactionCompleteCompactionTokensUsedCopilotUsageTokenDetail")] +[JsonSerializable(typeof(GitHub.Copilot.CompactionTrigger), TypeInfoPropertyName = "SessionEventsCompactionTrigger")] [JsonSerializable(typeof(GitHub.Copilot.ContextTier), TypeInfoPropertyName = "SessionEventsContextTier")] [JsonSerializable(typeof(GitHub.Copilot.CustomAgentsUpdatedAgent), TypeInfoPropertyName = "SessionEventsCustomAgentsUpdatedAgent")] [JsonSerializable(typeof(GitHub.Copilot.ElicitationCompletedAction), TypeInfoPropertyName = "SessionEventsElicitationCompletedAction")] @@ -24638,6 +35701,27 @@ public static void RegisterClientGlobalApiHandlers(JsonRpc rpc, ClientGlobalApiH [JsonSerializable(typeof(GitHub.Copilot.ExternalToolCompletedEvent), TypeInfoPropertyName = "SessionEventsExternalToolCompletedEvent")] [JsonSerializable(typeof(GitHub.Copilot.ExternalToolRequestedData), TypeInfoPropertyName = "SessionEventsExternalToolRequestedData")] [JsonSerializable(typeof(GitHub.Copilot.ExternalToolRequestedEvent), TypeInfoPropertyName = "SessionEventsExternalToolRequestedEvent")] +[JsonSerializable(typeof(GitHub.Copilot.FactoryPermissionOperation), TypeInfoPropertyName = "SessionEventsFactoryPermissionOperation")] +[JsonSerializable(typeof(GitHub.Copilot.FactoryPermissionPhase), TypeInfoPropertyName = "SessionEventsFactoryPermissionPhase")] +[JsonSerializable(typeof(GitHub.Copilot.FactoryRunSettledData), TypeInfoPropertyName = "SessionEventsFactoryRunSettledData")] +[JsonSerializable(typeof(GitHub.Copilot.FactoryRunSettledEvent), TypeInfoPropertyName = "SessionEventsFactoryRunSettledEvent")] +[JsonSerializable(typeof(GitHub.Copilot.FactoryRunSettledStatus), TypeInfoPropertyName = "SessionEventsFactoryRunSettledStatus")] +[JsonSerializable(typeof(GitHub.Copilot.FactoryRunStartedData), TypeInfoPropertyName = "SessionEventsFactoryRunStartedData")] +[JsonSerializable(typeof(GitHub.Copilot.FactoryRunStartedEvent), TypeInfoPropertyName = "SessionEventsFactoryRunStartedEvent")] +[JsonSerializable(typeof(GitHub.Copilot.FactoryRunUpdatedData), TypeInfoPropertyName = "SessionEventsFactoryRunUpdatedData")] +[JsonSerializable(typeof(GitHub.Copilot.FactoryRunUpdatedEvent), TypeInfoPropertyName = "SessionEventsFactoryRunUpdatedEvent")] +[JsonSerializable(typeof(GitHub.Copilot.FusionAttribution), TypeInfoPropertyName = "SessionEventsFusionAttribution")] +[JsonSerializable(typeof(GitHub.Copilot.FusionConversationScope), TypeInfoPropertyName = "SessionEventsFusionConversationScope")] +[JsonSerializable(typeof(GitHub.Copilot.FusionFollowUpAction), TypeInfoPropertyName = "SessionEventsFusionFollowUpAction")] +[JsonSerializable(typeof(GitHub.Copilot.FusionFollowUpRecommendation), TypeInfoPropertyName = "SessionEventsFusionFollowUpRecommendation")] +[JsonSerializable(typeof(GitHub.Copilot.FusionPattern), TypeInfoPropertyName = "SessionEventsFusionPattern")] +[JsonSerializable(typeof(GitHub.Copilot.FusionPhaseKind), TypeInfoPropertyName = "SessionEventsFusionPhaseKind")] +[JsonSerializable(typeof(GitHub.Copilot.FusionPhaseStatus), TypeInfoPropertyName = "SessionEventsFusionPhaseStatus")] +[JsonSerializable(typeof(GitHub.Copilot.FusionPhaseUsage), TypeInfoPropertyName = "SessionEventsFusionPhaseUsage")] +[JsonSerializable(typeof(GitHub.Copilot.FusionProjectionMode), TypeInfoPropertyName = "SessionEventsFusionProjectionMode")] +[JsonSerializable(typeof(GitHub.Copilot.FusionScores), TypeInfoPropertyName = "SessionEventsFusionScores")] +[JsonSerializable(typeof(GitHub.Copilot.FusionTurnKind), TypeInfoPropertyName = "SessionEventsFusionTurnKind")] +[JsonSerializable(typeof(GitHub.Copilot.GitHubMcpToolConfig), TypeInfoPropertyName = "SessionEventsGitHubMcpToolConfig")] [JsonSerializable(typeof(GitHub.Copilot.GitHubRepoRef), TypeInfoPropertyName = "SessionEventsGitHubRepoRef")] [JsonSerializable(typeof(GitHub.Copilot.HandoffRepository), TypeInfoPropertyName = "SessionEventsHandoffRepository")] [JsonSerializable(typeof(GitHub.Copilot.HandoffSourceType), TypeInfoPropertyName = "SessionEventsHandoffSourceType")] @@ -24686,22 +35770,28 @@ public static void RegisterClientGlobalApiHandlers(JsonRpc rpc, ClientGlobalApiH [JsonSerializable(typeof(GitHub.Copilot.ModelCallFailureRequestFingerprint), TypeInfoPropertyName = "SessionEventsModelCallFailureRequestFingerprint")] [JsonSerializable(typeof(GitHub.Copilot.ModelCallFailureSource), TypeInfoPropertyName = "SessionEventsModelCallFailureSource")] [JsonSerializable(typeof(GitHub.Copilot.ModelCallFailureTransport), TypeInfoPropertyName = "SessionEventsModelCallFailureTransport")] +[JsonSerializable(typeof(GitHub.Copilot.ModelCallFinishedData), TypeInfoPropertyName = "SessionEventsModelCallFinishedData")] +[JsonSerializable(typeof(GitHub.Copilot.ModelCallFinishedEvent), TypeInfoPropertyName = "SessionEventsModelCallFinishedEvent")] +[JsonSerializable(typeof(GitHub.Copilot.ModelCallFinishedOutcome), TypeInfoPropertyName = "SessionEventsModelCallFinishedOutcome")] [JsonSerializable(typeof(GitHub.Copilot.ModelCallStartData), TypeInfoPropertyName = "SessionEventsModelCallStartData")] [JsonSerializable(typeof(GitHub.Copilot.ModelCallStartEvent), TypeInfoPropertyName = "SessionEventsModelCallStartEvent")] +[JsonSerializable(typeof(GitHub.Copilot.ModelChangeSource), TypeInfoPropertyName = "SessionEventsModelChangeSource")] [JsonSerializable(typeof(GitHub.Copilot.OmittedBinaryOmittedReason), TypeInfoPropertyName = "SessionEventsOmittedBinaryOmittedReason")] [JsonSerializable(typeof(GitHub.Copilot.OmittedBinaryResult), TypeInfoPropertyName = "SessionEventsOmittedBinaryResult")] [JsonSerializable(typeof(GitHub.Copilot.OmittedBinaryType), TypeInfoPropertyName = "SessionEventsOmittedBinaryType")] [JsonSerializable(typeof(GitHub.Copilot.PendingMessagesModifiedData), TypeInfoPropertyName = "SessionEventsPendingMessagesModifiedData")] [JsonSerializable(typeof(GitHub.Copilot.PendingMessagesModifiedEvent), TypeInfoPropertyName = "SessionEventsPendingMessagesModifiedEvent")] -[JsonSerializable(typeof(GitHub.Copilot.PermissionAllowAllMode), TypeInfoPropertyName = "SessionEventsPermissionAllowAllMode")] -[JsonSerializable(typeof(GitHub.Copilot.PermissionAutoApproval), TypeInfoPropertyName = "SessionEventsPermissionAutoApproval")] +[JsonSerializable(typeof(GitHub.Copilot.PermissionAssistedApproval), TypeInfoPropertyName = "SessionEventsPermissionAssistedApproval")] [JsonSerializable(typeof(GitHub.Copilot.PermissionCompletedData), TypeInfoPropertyName = "SessionEventsPermissionCompletedData")] [JsonSerializable(typeof(GitHub.Copilot.PermissionCompletedEvent), TypeInfoPropertyName = "SessionEventsPermissionCompletedEvent")] +[JsonSerializable(typeof(GitHub.Copilot.PermissionMode), TypeInfoPropertyName = "SessionEventsPermissionMode")] [JsonSerializable(typeof(GitHub.Copilot.PermissionPromptRequest), TypeInfoPropertyName = "SessionEventsPermissionPromptRequest")] [JsonSerializable(typeof(GitHub.Copilot.PermissionPromptRequestCommands), TypeInfoPropertyName = "SessionEventsPermissionPromptRequestCommands")] [JsonSerializable(typeof(GitHub.Copilot.PermissionPromptRequestCustomTool), TypeInfoPropertyName = "SessionEventsPermissionPromptRequestCustomTool")] +[JsonSerializable(typeof(GitHub.Copilot.PermissionPromptRequestExtensionEnvAccess), TypeInfoPropertyName = "SessionEventsPermissionPromptRequestExtensionEnvAccess")] [JsonSerializable(typeof(GitHub.Copilot.PermissionPromptRequestExtensionManagement), TypeInfoPropertyName = "SessionEventsPermissionPromptRequestExtensionManagement")] [JsonSerializable(typeof(GitHub.Copilot.PermissionPromptRequestExtensionPermissionAccess), TypeInfoPropertyName = "SessionEventsPermissionPromptRequestExtensionPermissionAccess")] +[JsonSerializable(typeof(GitHub.Copilot.PermissionPromptRequestFactory), TypeInfoPropertyName = "SessionEventsPermissionPromptRequestFactory")] [JsonSerializable(typeof(GitHub.Copilot.PermissionPromptRequestHook), TypeInfoPropertyName = "SessionEventsPermissionPromptRequestHook")] [JsonSerializable(typeof(GitHub.Copilot.PermissionPromptRequestMcp), TypeInfoPropertyName = "SessionEventsPermissionPromptRequestMcp")] [JsonSerializable(typeof(GitHub.Copilot.PermissionPromptRequestMemory), TypeInfoPropertyName = "SessionEventsPermissionPromptRequestMemory")] @@ -24710,18 +35800,23 @@ public static void RegisterClientGlobalApiHandlers(JsonRpc rpc, ClientGlobalApiH [JsonSerializable(typeof(GitHub.Copilot.PermissionPromptRequestRead), TypeInfoPropertyName = "SessionEventsPermissionPromptRequestRead")] [JsonSerializable(typeof(GitHub.Copilot.PermissionPromptRequestUrl), TypeInfoPropertyName = "SessionEventsPermissionPromptRequestUrl")] [JsonSerializable(typeof(GitHub.Copilot.PermissionPromptRequestWrite), TypeInfoPropertyName = "SessionEventsPermissionPromptRequestWrite")] +[JsonSerializable(typeof(GitHub.Copilot.PermissionRecommendation), TypeInfoPropertyName = "SessionEventsPermissionRecommendation")] [JsonSerializable(typeof(GitHub.Copilot.PermissionRequest), TypeInfoPropertyName = "SessionEventsPermissionRequest")] [JsonSerializable(typeof(GitHub.Copilot.PermissionRequestCustomTool), TypeInfoPropertyName = "SessionEventsPermissionRequestCustomTool")] +[JsonSerializable(typeof(GitHub.Copilot.PermissionRequestExtensionEnvAccess), TypeInfoPropertyName = "SessionEventsPermissionRequestExtensionEnvAccess")] [JsonSerializable(typeof(GitHub.Copilot.PermissionRequestExtensionManagement), TypeInfoPropertyName = "SessionEventsPermissionRequestExtensionManagement")] [JsonSerializable(typeof(GitHub.Copilot.PermissionRequestExtensionPermissionAccess), TypeInfoPropertyName = "SessionEventsPermissionRequestExtensionPermissionAccess")] +[JsonSerializable(typeof(GitHub.Copilot.PermissionRequestFactory), TypeInfoPropertyName = "SessionEventsPermissionRequestFactory")] [JsonSerializable(typeof(GitHub.Copilot.PermissionRequestHook), TypeInfoPropertyName = "SessionEventsPermissionRequestHook")] [JsonSerializable(typeof(GitHub.Copilot.PermissionRequestMcp), TypeInfoPropertyName = "SessionEventsPermissionRequestMcp")] [JsonSerializable(typeof(GitHub.Copilot.PermissionRequestMemory), TypeInfoPropertyName = "SessionEventsPermissionRequestMemory")] [JsonSerializable(typeof(GitHub.Copilot.PermissionRequestMemoryAction), TypeInfoPropertyName = "SessionEventsPermissionRequestMemoryAction")] [JsonSerializable(typeof(GitHub.Copilot.PermissionRequestMemoryDirection), TypeInfoPropertyName = "SessionEventsPermissionRequestMemoryDirection")] +[JsonSerializable(typeof(GitHub.Copilot.PermissionRequestMemoryScope), TypeInfoPropertyName = "SessionEventsPermissionRequestMemoryScope")] [JsonSerializable(typeof(GitHub.Copilot.PermissionRequestRead), TypeInfoPropertyName = "SessionEventsPermissionRequestRead")] [JsonSerializable(typeof(GitHub.Copilot.PermissionRequestShell), TypeInfoPropertyName = "SessionEventsPermissionRequestShell")] [JsonSerializable(typeof(GitHub.Copilot.PermissionRequestShellCommand), TypeInfoPropertyName = "SessionEventsPermissionRequestShellCommand")] +[JsonSerializable(typeof(GitHub.Copilot.PermissionRequestShellCommandSegment), TypeInfoPropertyName = "SessionEventsPermissionRequestShellCommandSegment")] [JsonSerializable(typeof(GitHub.Copilot.PermissionRequestShellPossibleUrl), TypeInfoPropertyName = "SessionEventsPermissionRequestShellPossibleUrl")] [JsonSerializable(typeof(GitHub.Copilot.PermissionRequestUrl), TypeInfoPropertyName = "SessionEventsPermissionRequestUrl")] [JsonSerializable(typeof(GitHub.Copilot.PermissionRequestWrite), TypeInfoPropertyName = "SessionEventsPermissionRequestWrite")] @@ -24733,11 +35828,16 @@ public static void RegisterClientGlobalApiHandlers(JsonRpc rpc, ClientGlobalApiH [JsonSerializable(typeof(GitHub.Copilot.PersistedBinaryImageType), TypeInfoPropertyName = "SessionEventsPersistedBinaryImageType")] [JsonSerializable(typeof(GitHub.Copilot.PersistedBinaryResult), TypeInfoPropertyName = "SessionEventsPersistedBinaryResult")] [JsonSerializable(typeof(GitHub.Copilot.PlanChangedOperation), TypeInfoPropertyName = "SessionEventsPlanChangedOperation")] +[JsonSerializable(typeof(GitHub.Copilot.PromptCacheBreakData), TypeInfoPropertyName = "SessionEventsPromptCacheBreakData")] +[JsonSerializable(typeof(GitHub.Copilot.PromptCacheBreakEvent), TypeInfoPropertyName = "SessionEventsPromptCacheBreakEvent")] [JsonSerializable(typeof(GitHub.Copilot.ReasoningSummary), TypeInfoPropertyName = "SessionEventsReasoningSummary")] [JsonSerializable(typeof(GitHub.Copilot.SamplingCompletedData), TypeInfoPropertyName = "SessionEventsSamplingCompletedData")] [JsonSerializable(typeof(GitHub.Copilot.SamplingCompletedEvent), TypeInfoPropertyName = "SessionEventsSamplingCompletedEvent")] [JsonSerializable(typeof(GitHub.Copilot.SamplingRequestedData), TypeInfoPropertyName = "SessionEventsSamplingRequestedData")] [JsonSerializable(typeof(GitHub.Copilot.SamplingRequestedEvent), TypeInfoPropertyName = "SessionEventsSamplingRequestedEvent")] +[JsonSerializable(typeof(GitHub.Copilot.SandboxDecisionData), TypeInfoPropertyName = "SessionEventsSandboxDecisionData")] +[JsonSerializable(typeof(GitHub.Copilot.SandboxDecisionEvent), TypeInfoPropertyName = "SessionEventsSandboxDecisionEvent")] +[JsonSerializable(typeof(GitHub.Copilot.ScheduleOrigin), TypeInfoPropertyName = "SessionEventsScheduleOrigin")] [JsonSerializable(typeof(GitHub.Copilot.SessionEvent), TypeInfoPropertyName = "SessionEventsSessionEvent")] [JsonSerializable(typeof(GitHub.Copilot.SessionLimitsConfig), TypeInfoPropertyName = "SessionEventsSessionLimitsConfig")] [JsonSerializable(typeof(GitHub.Copilot.SessionLimitsExhaustedCompletedData), TypeInfoPropertyName = "SessionEventsSessionLimitsExhaustedCompletedData")] @@ -24747,6 +35847,7 @@ public static void RegisterClientGlobalApiHandlers(JsonRpc rpc, ClientGlobalApiH [JsonSerializable(typeof(GitHub.Copilot.SessionLimitsExhaustedResponse), TypeInfoPropertyName = "SessionEventsSessionLimitsExhaustedResponse")] [JsonSerializable(typeof(GitHub.Copilot.SessionLimitsExhaustedResponseAction), TypeInfoPropertyName = "SessionEventsSessionLimitsExhaustedResponseAction")] [JsonSerializable(typeof(GitHub.Copilot.SessionMode), TypeInfoPropertyName = "SessionEventsSessionMode")] +[JsonSerializable(typeof(GitHub.Copilot.ShutdownAgentMetric), TypeInfoPropertyName = "SessionEventsShutdownAgentMetric")] [JsonSerializable(typeof(GitHub.Copilot.ShutdownCodeChanges), TypeInfoPropertyName = "SessionEventsShutdownCodeChanges")] [JsonSerializable(typeof(GitHub.Copilot.ShutdownModelMetric), TypeInfoPropertyName = "SessionEventsShutdownModelMetric")] [JsonSerializable(typeof(GitHub.Copilot.ShutdownModelMetricRequests), TypeInfoPropertyName = "SessionEventsShutdownModelMetricRequests")] @@ -24761,6 +35862,8 @@ public static void RegisterClientGlobalApiHandlers(JsonRpc rpc, ClientGlobalApiH [JsonSerializable(typeof(GitHub.Copilot.SkillsLoadedSkill), TypeInfoPropertyName = "SessionEventsSkillsLoadedSkill")] [JsonSerializable(typeof(GitHub.Copilot.SubagentCompletedData), TypeInfoPropertyName = "SessionEventsSubagentCompletedData")] [JsonSerializable(typeof(GitHub.Copilot.SubagentCompletedEvent), TypeInfoPropertyName = "SessionEventsSubagentCompletedEvent")] +[JsonSerializable(typeof(GitHub.Copilot.SubagentConfiguredData), TypeInfoPropertyName = "SessionEventsSubagentConfiguredData")] +[JsonSerializable(typeof(GitHub.Copilot.SubagentConfiguredEvent), TypeInfoPropertyName = "SessionEventsSubagentConfiguredEvent")] [JsonSerializable(typeof(GitHub.Copilot.SubagentDeselectedData), TypeInfoPropertyName = "SessionEventsSubagentDeselectedData")] [JsonSerializable(typeof(GitHub.Copilot.SubagentDeselectedEvent), TypeInfoPropertyName = "SessionEventsSubagentDeselectedEvent")] [JsonSerializable(typeof(GitHub.Copilot.SubagentFailedData), TypeInfoPropertyName = "SessionEventsSubagentFailedData")] @@ -24779,10 +35882,14 @@ public static void RegisterClientGlobalApiHandlers(JsonRpc rpc, ClientGlobalApiH [JsonSerializable(typeof(GitHub.Copilot.SystemNotificationAgentIdle), TypeInfoPropertyName = "SessionEventsSystemNotificationAgentIdle")] [JsonSerializable(typeof(GitHub.Copilot.SystemNotificationData), TypeInfoPropertyName = "SessionEventsSystemNotificationData")] [JsonSerializable(typeof(GitHub.Copilot.SystemNotificationEvent), TypeInfoPropertyName = "SessionEventsSystemNotificationEvent")] +[JsonSerializable(typeof(GitHub.Copilot.SystemNotificationFactoryCompleted), TypeInfoPropertyName = "SessionEventsSystemNotificationFactoryCompleted")] +[JsonSerializable(typeof(GitHub.Copilot.SystemNotificationFactoryCompletedStatus), TypeInfoPropertyName = "SessionEventsSystemNotificationFactoryCompletedStatus")] [JsonSerializable(typeof(GitHub.Copilot.SystemNotificationInstructionDiscovered), TypeInfoPropertyName = "SessionEventsSystemNotificationInstructionDiscovered")] [JsonSerializable(typeof(GitHub.Copilot.SystemNotificationNewInboxMessage), TypeInfoPropertyName = "SessionEventsSystemNotificationNewInboxMessage")] [JsonSerializable(typeof(GitHub.Copilot.SystemNotificationShellCompleted), TypeInfoPropertyName = "SessionEventsSystemNotificationShellCompleted")] [JsonSerializable(typeof(GitHub.Copilot.SystemNotificationShellDetachedCompleted), TypeInfoPropertyName = "SessionEventsSystemNotificationShellDetachedCompleted")] +[JsonSerializable(typeof(GitHub.Copilot.SystemNotificationUnclassified), TypeInfoPropertyName = "SessionEventsSystemNotificationUnclassified")] +[JsonSerializable(typeof(GitHub.Copilot.TaskCompletionOutcome), TypeInfoPropertyName = "SessionEventsTaskCompletionOutcome")] [JsonSerializable(typeof(GitHub.Copilot.ToolExecutionCompleteContent), TypeInfoPropertyName = "SessionEventsToolExecutionCompleteContent")] [JsonSerializable(typeof(GitHub.Copilot.ToolExecutionCompleteContentAudio), TypeInfoPropertyName = "SessionEventsToolExecutionCompleteContentAudio")] [JsonSerializable(typeof(GitHub.Copilot.ToolExecutionCompleteContentImage), TypeInfoPropertyName = "SessionEventsToolExecutionCompleteContentImage")] @@ -24825,6 +35932,7 @@ public static void RegisterClientGlobalApiHandlers(JsonRpc rpc, ClientGlobalApiH [JsonSerializable(typeof(GitHub.Copilot.ToolSearchActivatedEvent), TypeInfoPropertyName = "SessionEventsToolSearchActivatedEvent")] [JsonSerializable(typeof(GitHub.Copilot.ToolUserRequestedData), TypeInfoPropertyName = "SessionEventsToolUserRequestedData")] [JsonSerializable(typeof(GitHub.Copilot.ToolUserRequestedEvent), TypeInfoPropertyName = "SessionEventsToolUserRequestedEvent")] +[JsonSerializable(typeof(GitHub.Copilot.UIEphemeralQueryPhase), TypeInfoPropertyName = "SessionEventsUIEphemeralQueryPhase")] [JsonSerializable(typeof(GitHub.Copilot.UserInputCompletedData), TypeInfoPropertyName = "SessionEventsUserInputCompletedData")] [JsonSerializable(typeof(GitHub.Copilot.UserInputCompletedEvent), TypeInfoPropertyName = "SessionEventsUserInputCompletedEvent")] [JsonSerializable(typeof(GitHub.Copilot.UserInputRequestedData), TypeInfoPropertyName = "SessionEventsUserInputRequestedData")] @@ -24836,8 +35944,10 @@ public static void RegisterClientGlobalApiHandlers(JsonRpc rpc, ClientGlobalApiH [JsonSerializable(typeof(GitHub.Copilot.UserToolSessionApproval), TypeInfoPropertyName = "SessionEventsUserToolSessionApproval")] [JsonSerializable(typeof(GitHub.Copilot.UserToolSessionApprovalCommands), TypeInfoPropertyName = "SessionEventsUserToolSessionApprovalCommands")] [JsonSerializable(typeof(GitHub.Copilot.UserToolSessionApprovalCustomTool), TypeInfoPropertyName = "SessionEventsUserToolSessionApprovalCustomTool")] +[JsonSerializable(typeof(GitHub.Copilot.UserToolSessionApprovalExtensionEnvAccess), TypeInfoPropertyName = "SessionEventsUserToolSessionApprovalExtensionEnvAccess")] [JsonSerializable(typeof(GitHub.Copilot.UserToolSessionApprovalExtensionManagement), TypeInfoPropertyName = "SessionEventsUserToolSessionApprovalExtensionManagement")] [JsonSerializable(typeof(GitHub.Copilot.UserToolSessionApprovalExtensionPermissionAccess), TypeInfoPropertyName = "SessionEventsUserToolSessionApprovalExtensionPermissionAccess")] +[JsonSerializable(typeof(GitHub.Copilot.UserToolSessionApprovalFactory), TypeInfoPropertyName = "SessionEventsUserToolSessionApprovalFactory")] [JsonSerializable(typeof(GitHub.Copilot.UserToolSessionApprovalMcp), TypeInfoPropertyName = "SessionEventsUserToolSessionApprovalMcp")] [JsonSerializable(typeof(GitHub.Copilot.UserToolSessionApprovalMemory), TypeInfoPropertyName = "SessionEventsUserToolSessionApprovalMemory")] [JsonSerializable(typeof(GitHub.Copilot.UserToolSessionApprovalRead), TypeInfoPropertyName = "SessionEventsUserToolSessionApprovalRead")] @@ -24869,11 +35979,17 @@ public static void RegisterClientGlobalApiHandlers(JsonRpc rpc, ClientGlobalApiH [JsonSerializable(typeof(AgentReloadResult))] [JsonSerializable(typeof(AgentSelectRequest))] [JsonSerializable(typeof(AgentSelectResult))] +[JsonSerializable(typeof(AgentSetPromptRequest))] [JsonSerializable(typeof(AgentsDiscoverRequest))] [JsonSerializable(typeof(AgentsGetDiscoveryPathsRequest))] -[JsonSerializable(typeof(AllowAllPermissionSetResult))] -[JsonSerializable(typeof(AllowAllPermissionState))] +[JsonSerializable(typeof(AuthIdentity))] [JsonSerializable(typeof(AuthInfo))] +[JsonSerializable(typeof(AuthValidationError))] +[JsonSerializable(typeof(BuiltInModelCatalog))] +[JsonSerializable(typeof(BuiltInModelCatalogEntry))] +[JsonSerializable(typeof(BuiltinToolDescriptor))] +[JsonSerializable(typeof(BuiltinToolFormat))] +[JsonSerializable(typeof(BuiltinToolInputSchema))] [JsonSerializable(typeof(CancelUserRequestedShellCommandResult))] [JsonSerializable(typeof(CanvasAction))] [JsonSerializable(typeof(CanvasActionInvokeRequest))] @@ -24888,25 +36004,41 @@ public static void RegisterClientGlobalApiHandlers(JsonRpc rpc, ClientGlobalApiH [JsonSerializable(typeof(CanvasProviderInvokeActionRequest))] [JsonSerializable(typeof(CanvasProviderOpenRequest))] [JsonSerializable(typeof(CanvasProviderOpenResult))] +[JsonSerializable(typeof(CanvasProviderRegisterRequest))] +[JsonSerializable(typeof(CanvasProviderUnregisterRequest))] [JsonSerializable(typeof(CanvasSessionContext))] [JsonSerializable(typeof(CapiSessionOptions))] +[JsonSerializable(typeof(CardDigest))] +[JsonSerializable(typeof(CatalogAiSkillCandidateProvenance))] +[JsonSerializable(typeof(CatalogCandidate))] +[JsonSerializable(typeof(CatalogCandidateSource))] +[JsonSerializable(typeof(CatalogClientContract))] +[JsonSerializable(typeof(CatalogMcpServerCandidateProvenance))] +[JsonSerializable(typeof(CatalogNegotiatedContract))] +[JsonSerializable(typeof(CatalogSearchRequest))] +[JsonSerializable(typeof(CatalogSearchResult))] [JsonSerializable(typeof(CommandList))] +[JsonSerializable(typeof(CommandsFinalizeInvocationEffectRequest))] +[JsonSerializable(typeof(CommandsFinalizeInvocationEffectRequestEffect))] +[JsonSerializable(typeof(CommandsFinalizeInvocationEffectResult))] [JsonSerializable(typeof(CommandsHandlePendingCommandRequest))] [JsonSerializable(typeof(CommandsHandlePendingCommandResult))] [JsonSerializable(typeof(CommandsInvokeRequest))] -[JsonSerializable(typeof(CommandsListRequest))] -[JsonSerializable(typeof(CommandsListRequestWithSession))] [JsonSerializable(typeof(CommandsRespondToQueuedCommandRequest))] [JsonSerializable(typeof(CommandsRespondToQueuedCommandResult))] [JsonSerializable(typeof(CompletionsGetTriggerCharactersResult))] [JsonSerializable(typeof(CompletionsRequestRequest))] [JsonSerializable(typeof(CompletionsRequestResult))] [JsonSerializable(typeof(ConfigureSessionExtensionsParams))] +[JsonSerializable(typeof(ConnectClientInfo))] [JsonSerializable(typeof(ConnectRemoteSessionParams))] [JsonSerializable(typeof(ConnectRequest))] [JsonSerializable(typeof(ConnectResult))] [JsonSerializable(typeof(ConnectedRemoteSessionMetadata))] [JsonSerializable(typeof(ConnectedRemoteSessionMetadataRepository))] +[JsonSerializable(typeof(ContentExclusionCheckPathsRequest))] +[JsonSerializable(typeof(ContentExclusionCheckPathsResult))] +[JsonSerializable(typeof(ContentExclusionPathCheck))] [JsonSerializable(typeof(ContextHeaviestMessage))] [JsonSerializable(typeof(CopilotUserResponse))] [JsonSerializable(typeof(CopilotUserResponseEndpoints))] @@ -24925,6 +36057,11 @@ public static void RegisterClientGlobalApiHandlers(JsonRpc rpc, ClientGlobalApiH [JsonSerializable(typeof(DebugCollectLogsResult))] [JsonSerializable(typeof(DebugCollectLogsSkippedEntry))] [JsonSerializable(typeof(DiscoveredCanvas))] +[JsonSerializable(typeof(DiscoveredExtension))] +[JsonSerializable(typeof(DiscoveredExtensionPlugin))] +[JsonSerializable(typeof(DiscoveredExtensions))] +[JsonSerializable(typeof(DiscoveredExtensionsDisableRequest))] +[JsonSerializable(typeof(DiscoveredExtensionsEnableRequest))] [JsonSerializable(typeof(DiscoveredMcpServer))] [JsonSerializable(typeof(EnqueueCommandParams))] [JsonSerializable(typeof(EnqueueCommandResult))] @@ -24935,27 +36072,51 @@ public static void RegisterClientGlobalApiHandlers(JsonRpc rpc, ClientGlobalApiH [JsonSerializable(typeof(ExecuteCommandParams))] [JsonSerializable(typeof(ExecuteCommandResult))] [JsonSerializable(typeof(Extension))] +[JsonSerializable(typeof(ExtensionLaunchProfile))] +[JsonSerializable(typeof(ExtensionLaunchProviderResolveRequest))] +[JsonSerializable(typeof(ExtensionLaunchProviderResolveResult))] [JsonSerializable(typeof(ExtensionList))] [JsonSerializable(typeof(ExtensionsDisableRequest))] [JsonSerializable(typeof(ExtensionsEnableRequest))] +[JsonSerializable(typeof(ExternalToolTextResultForLlmBinaryResultsForLlm))] +[JsonSerializable(typeof(ExternalToolTextResultForLlmContent))] +[JsonSerializable(typeof(ExternalToolTextResultForLlmContentResourceLinkIcon))] [JsonSerializable(typeof(FactoryAbortRequest))] [JsonSerializable(typeof(FactoryAckResult))] [JsonSerializable(typeof(FactoryAgentOptions))] [JsonSerializable(typeof(FactoryAgentRequest))] [JsonSerializable(typeof(FactoryAgentResult))] +[JsonSerializable(typeof(FactoryAgentSummary))] [JsonSerializable(typeof(FactoryCancelRequest))] +[JsonSerializable(typeof(FactoryCurrentPhase))] +[JsonSerializable(typeof(FactoryDeclaredLimits))] [JsonSerializable(typeof(FactoryExecuteRequest))] [JsonSerializable(typeof(FactoryExecuteResult))] +[JsonSerializable(typeof(FactoryGetRunProgressRequest))] [JsonSerializable(typeof(FactoryGetRunRequest))] [JsonSerializable(typeof(FactoryJournalGetRequest))] [JsonSerializable(typeof(FactoryJournalGetResult))] [JsonSerializable(typeof(FactoryJournalPutRequest))] +[JsonSerializable(typeof(FactoryListRunsRequest))] +[JsonSerializable(typeof(FactoryListRunsResult))] [JsonSerializable(typeof(FactoryLogLine))] [JsonSerializable(typeof(FactoryLogRequest))] +[JsonSerializable(typeof(FactoryPhaseObservation))] +[JsonSerializable(typeof(FactoryProgressLine))] +[JsonSerializable(typeof(FactoryProgressPage))] +[JsonSerializable(typeof(FactoryResumeRequest))] +[JsonSerializable(typeof(FactoryResumeResult))] +[JsonSerializable(typeof(FactoryRunConsumed))] +[JsonSerializable(typeof(FactoryRunDetail))] [JsonSerializable(typeof(FactoryRunFailure))] [JsonSerializable(typeof(FactoryRunLimits))] [JsonSerializable(typeof(FactoryRunRequest))] [JsonSerializable(typeof(FactoryRunResult))] +[JsonSerializable(typeof(FactoryRunSummary))] +[JsonSerializable(typeof(FactoryRunTerminal))] +[JsonSerializable(typeof(FactoryToolResumeRequest))] +[JsonSerializable(typeof(FactoryToolRunOptions))] +[JsonSerializable(typeof(FactoryToolRunRequest))] [JsonSerializable(typeof(FleetStartRequest))] [JsonSerializable(typeof(FleetStartResult))] [JsonSerializable(typeof(FolderTrustAddParams))] @@ -24964,19 +36125,31 @@ public static void RegisterClientGlobalApiHandlers(JsonRpc rpc, ClientGlobalApiH [JsonSerializable(typeof(GitHubTelemetryClientInfo))] [JsonSerializable(typeof(GitHubTelemetryEvent))] [JsonSerializable(typeof(GitHubTelemetryNotification))] +[JsonSerializable(typeof(GitHubTokenAcquireRequest))] +[JsonSerializable(typeof(GitHubTokenAcquireResult))] [JsonSerializable(typeof(HandlePendingToolCallRequest))] [JsonSerializable(typeof(HandlePendingToolCallResult))] [JsonSerializable(typeof(HistoryAbortManualCompactionResult))] [JsonSerializable(typeof(HistoryCancelBackgroundCompactionResult))] +[JsonSerializable(typeof(HistoryClearContextRequest))] +[JsonSerializable(typeof(HistoryClearContextResult))] [JsonSerializable(typeof(HistoryCompactContextWindow))] -[JsonSerializable(typeof(HistoryCompactRequest))] -[JsonSerializable(typeof(HistoryCompactRequestWithSession))] [JsonSerializable(typeof(HistoryCompactResult))] +[JsonSerializable(typeof(HistoryListRewindPointsResult))] +[JsonSerializable(typeof(HistoryPreviewRewindRequest))] +[JsonSerializable(typeof(HistoryPreviewRewindResult))] +[JsonSerializable(typeof(HistoryRewindFilePreview))] +[JsonSerializable(typeof(HistoryRewindPoint))] +[JsonSerializable(typeof(HistoryRewindRequest))] +[JsonSerializable(typeof(HistoryRewindResult))] +[JsonSerializable(typeof(HistorySkippedFileRestore))] [JsonSerializable(typeof(HistorySummarizeForHandoffResult))] [JsonSerializable(typeof(HistoryTruncateRequest))] [JsonSerializable(typeof(HistoryTruncateResult))] [JsonSerializable(typeof(IDictionary))] [JsonSerializable(typeof(IList))] +[JsonSerializable(typeof(IList))] +[JsonSerializable(typeof(IList))] [JsonSerializable(typeof(InstalledPlugin))] [JsonSerializable(typeof(InstalledPluginInfo))] [JsonSerializable(typeof(InstructionDiscoveryPath))] @@ -24985,6 +36158,8 @@ public static void RegisterClientGlobalApiHandlers(JsonRpc rpc, ClientGlobalApiH [JsonSerializable(typeof(InstructionsDiscoverRequest))] [JsonSerializable(typeof(InstructionsGetDiscoveryPathsRequest))] [JsonSerializable(typeof(InstructionsGetSourcesResult))] +[JsonSerializable(typeof(InterruptMainTurnRequest))] +[JsonSerializable(typeof(InterruptMainTurnResult))] [JsonSerializable(typeof(LlmInferenceHttpRequestChunkRequest))] [JsonSerializable(typeof(LlmInferenceHttpRequestChunkResult))] [JsonSerializable(typeof(LlmInferenceHttpRequestStartRequest))] @@ -24999,6 +36174,7 @@ public static void RegisterClientGlobalApiHandlers(JsonRpc rpc, ClientGlobalApiH [JsonSerializable(typeof(LogRequest))] [JsonSerializable(typeof(LogResult))] [JsonSerializable(typeof(LspInitializeRequest))] +[JsonSerializable(typeof(ManagedSettingsReadResult))] [JsonSerializable(typeof(MarketplaceAddResult))] [JsonSerializable(typeof(MarketplaceBrowseResult))] [JsonSerializable(typeof(MarketplaceInfo))] @@ -25039,20 +36215,38 @@ public static void RegisterClientGlobalApiHandlers(JsonRpc rpc, ClientGlobalApiH [JsonSerializable(typeof(McpExecuteSamplingParams))] [JsonSerializable(typeof(McpExecuteSamplingRequest))] [JsonSerializable(typeof(McpExecuteSamplingResult))] +[JsonSerializable(typeof(McpFailedServer))] [JsonSerializable(typeof(McpFilteredServer))] [JsonSerializable(typeof(McpHeadersHandlePendingHeadersRefreshRequest))] [JsonSerializable(typeof(McpHeadersHandlePendingHeadersRefreshRequestRequest))] [JsonSerializable(typeof(McpHeadersHandlePendingHeadersRefreshRequestResult))] [JsonSerializable(typeof(McpHostState))] +[JsonSerializable(typeof(McpInstallPlan))] [JsonSerializable(typeof(McpIsServerRunningRequest))] [JsonSerializable(typeof(McpIsServerRunningResult))] [JsonSerializable(typeof(McpListToolsRequest))] [JsonSerializable(typeof(McpListToolsResult))] +[JsonSerializable(typeof(McpOauthAuthenticationStateChangedRequest))] [JsonSerializable(typeof(McpOauthHandlePendingRequest))] [JsonSerializable(typeof(McpOauthHandlePendingResult))] [JsonSerializable(typeof(McpOauthLoginRequest))] [JsonSerializable(typeof(McpOauthLoginResult))] [JsonSerializable(typeof(McpOauthPendingRequestResponse))] +[JsonSerializable(typeof(McpOauthProbeRequest))] +[JsonSerializable(typeof(McpOauthProbeResult))] +[JsonSerializable(typeof(McpOauthRespondRequest))] +[JsonSerializable(typeof(McpOauthRespondResult))] +[JsonSerializable(typeof(McpPlanConfigurationChange))] +[JsonSerializable(typeof(McpPlanInstallRequest))] +[JsonSerializable(typeof(McpPlanInstallResult))] +[JsonSerializable(typeof(McpPlanInstallSource))] +[JsonSerializable(typeof(McpPlanPolicyResult))] +[JsonSerializable(typeof(McpPlanProvenance))] +[JsonSerializable(typeof(McpPlanRequiredValue))] +[JsonSerializable(typeof(McpPlanResourceIdentity))] +[JsonSerializable(typeof(McpPlanSecretPlaceholder))] +[JsonSerializable(typeof(McpPlanTarget))] +[JsonSerializable(typeof(McpPlanTransportChoice))] [JsonSerializable(typeof(McpRegisterExternalClientRequest))] [JsonSerializable(typeof(McpReloadWithConfigRequest))] [JsonSerializable(typeof(McpRemoveGitHubResult))] @@ -25070,6 +36264,7 @@ public static void RegisterClientGlobalApiHandlers(JsonRpc rpc, ClientGlobalApiH [JsonSerializable(typeof(McpRestartServerRequest))] [JsonSerializable(typeof(McpSamplingExecutionResult))] [JsonSerializable(typeof(McpServer))] +[JsonSerializable(typeof(McpServerCardReference))] [JsonSerializable(typeof(McpServerFailureInfo))] [JsonSerializable(typeof(McpServerList))] [JsonSerializable(typeof(McpServerNeedsAuthInfo))] @@ -25078,11 +36273,13 @@ public static void RegisterClientGlobalApiHandlers(JsonRpc rpc, ClientGlobalApiH [JsonSerializable(typeof(McpStartServerRequest))] [JsonSerializable(typeof(McpStartServersResult))] [JsonSerializable(typeof(McpStopServerRequest))] +[JsonSerializable(typeof(McpTaskMetadata))] [JsonSerializable(typeof(McpToolUi))] [JsonSerializable(typeof(McpTools))] [JsonSerializable(typeof(McpUnregisterExternalClientRequest))] [JsonSerializable(typeof(MetadataContextAttributionResult))] [JsonSerializable(typeof(MetadataContextAttributionResultContextAttribution))] +[JsonSerializable(typeof(MetadataContextAttributionResultContextAttributionCategories))] [JsonSerializable(typeof(MetadataContextAttributionResultContextAttributionCompactions))] [JsonSerializable(typeof(MetadataContextAttributionResultContextAttributionEntry))] [JsonSerializable(typeof(MetadataContextHeaviestMessagesRequest))] @@ -25100,7 +36297,9 @@ public static void RegisterClientGlobalApiHandlers(JsonRpc rpc, ClientGlobalApiH [JsonSerializable(typeof(MetadataSnapshotRemoteMetadata))] [JsonSerializable(typeof(MetadataSnapshotRemoteMetadataRepository))] [JsonSerializable(typeof(ModeSetRequest))] +[JsonSerializable(typeof(ModeSetResult))] [JsonSerializable(typeof(Model))] +[JsonSerializable(typeof(ModelApplyStartupOverlayRequest))] [JsonSerializable(typeof(ModelBilling))] [JsonSerializable(typeof(ModelBillingPromo))] [JsonSerializable(typeof(ModelBillingTokenPrices))] @@ -25114,14 +36313,19 @@ public static void RegisterClientGlobalApiHandlers(JsonRpc rpc, ClientGlobalApiH [JsonSerializable(typeof(ModelCapabilitiesOverrideSupports))] [JsonSerializable(typeof(ModelCapabilitiesSupports))] [JsonSerializable(typeof(ModelList))] -[JsonSerializable(typeof(ModelListRequest))] -[JsonSerializable(typeof(ModelListRequestWithSession))] +[JsonSerializable(typeof(ModelMessage))] +[JsonSerializable(typeof(ModelPickerPersistenceRequest))] +[JsonSerializable(typeof(ModelPickerSettingsContext))] +[JsonSerializable(typeof(ModelPickerSettingsContextEnvironment))] [JsonSerializable(typeof(ModelPolicy))] [JsonSerializable(typeof(ModelSetReasoningEffortRequest))] [JsonSerializable(typeof(ModelSetReasoningEffortResult))] +[JsonSerializable(typeof(ModelSwitchConfirmation))] [JsonSerializable(typeof(ModelSwitchToRequest))] [JsonSerializable(typeof(ModelSwitchToResult))] +[JsonSerializable(typeof(ModelWarningText))] [JsonSerializable(typeof(ModelsListRequest))] +[JsonSerializable(typeof(MoveMcpLoadingToBackgroundResult))] [JsonSerializable(typeof(NameGetResult))] [JsonSerializable(typeof(NameSetAutoRequest))] [JsonSerializable(typeof(NameSetAutoResult))] @@ -25136,6 +36340,7 @@ public static void RegisterClientGlobalApiHandlers(JsonRpc rpc, ClientGlobalApiH [JsonSerializable(typeof(PermissionDecision))] [JsonSerializable(typeof(PermissionDecisionApproveForLocationApproval))] [JsonSerializable(typeof(PermissionDecisionApproveForSessionApproval))] +[JsonSerializable(typeof(PermissionDecisionContext))] [JsonSerializable(typeof(PermissionDecisionRequest))] [JsonSerializable(typeof(PermissionLocationAddToolApprovalParams))] [JsonSerializable(typeof(PermissionLocationApplyParams))] @@ -25161,7 +36366,8 @@ public static void RegisterClientGlobalApiHandlers(JsonRpc rpc, ClientGlobalApiH [JsonSerializable(typeof(PermissionsConfigureParams))] [JsonSerializable(typeof(PermissionsConfigureResult))] [JsonSerializable(typeof(PermissionsFolderTrustAddTrustedResult))] -[JsonSerializable(typeof(PermissionsGetAllowAllRequest))] +[JsonSerializable(typeof(PermissionsGetModeRequest))] +[JsonSerializable(typeof(PermissionsGetModeResult))] [JsonSerializable(typeof(PermissionsLocationsAddToolApprovalDetails))] [JsonSerializable(typeof(PermissionsLocationsAddToolApprovalResult))] [JsonSerializable(typeof(PermissionsModifyRulesParams))] @@ -25173,9 +36379,10 @@ public static void RegisterClientGlobalApiHandlers(JsonRpc rpc, ClientGlobalApiH [JsonSerializable(typeof(PermissionsPendingRequestsRequest))] [JsonSerializable(typeof(PermissionsResetSessionApprovalsRequest))] [JsonSerializable(typeof(PermissionsResetSessionApprovalsResult))] -[JsonSerializable(typeof(PermissionsSetAllowAllRequest))] [JsonSerializable(typeof(PermissionsSetApproveAllRequest))] [JsonSerializable(typeof(PermissionsSetApproveAllResult))] +[JsonSerializable(typeof(PermissionsSetModeRequest))] +[JsonSerializable(typeof(PermissionsSetModeResult))] [JsonSerializable(typeof(PermissionsSetRequiredRequest))] [JsonSerializable(typeof(PermissionsSetRequiredResult))] [JsonSerializable(typeof(PermissionsUrlsSetUnrestrictedModeResult))] @@ -25194,6 +36401,7 @@ public static void RegisterClientGlobalApiHandlers(JsonRpc rpc, ClientGlobalApiH [JsonSerializable(typeof(PluginUpdateAllEntry))] [JsonSerializable(typeof(PluginUpdateAllResult))] [JsonSerializable(typeof(PluginUpdateResult))] +[JsonSerializable(typeof(PluginsBuiltinSetRequest))] [JsonSerializable(typeof(PluginsDisableRequest))] [JsonSerializable(typeof(PluginsEnableRequest))] [JsonSerializable(typeof(PluginsInstallRequest))] @@ -25201,17 +36409,14 @@ public static void RegisterClientGlobalApiHandlers(JsonRpc rpc, ClientGlobalApiH [JsonSerializable(typeof(PluginsMarketplacesBrowseRequest))] [JsonSerializable(typeof(PluginsMarketplacesRefreshRequest))] [JsonSerializable(typeof(PluginsMarketplacesRemoveRequest))] -[JsonSerializable(typeof(PluginsReloadRequest))] -[JsonSerializable(typeof(PluginsReloadRequestWithSession))] [JsonSerializable(typeof(PluginsUninstallRequest))] [JsonSerializable(typeof(PluginsUpdateRequest))] +[JsonSerializable(typeof(ProtocolExternalToolDefinition))] [JsonSerializable(typeof(ProviderAddRequest))] [JsonSerializable(typeof(ProviderAddResult))] [JsonSerializable(typeof(ProviderConfig))] [JsonSerializable(typeof(ProviderConfigAzure))] [JsonSerializable(typeof(ProviderEndpoint))] -[JsonSerializable(typeof(ProviderGetEndpointRequest))] -[JsonSerializable(typeof(ProviderGetEndpointRequestWithSession))] [JsonSerializable(typeof(ProviderModelConfig))] [JsonSerializable(typeof(ProviderSessionToken))] [JsonSerializable(typeof(ProviderTokenAcquireRequest))] @@ -25224,9 +36429,32 @@ public static void RegisterClientGlobalApiHandlers(JsonRpc rpc, ClientGlobalApiH [JsonSerializable(typeof(PushAttachmentSelectionDetailsEnd))] [JsonSerializable(typeof(PushAttachmentSelectionDetailsStart))] [JsonSerializable(typeof(PushGitHubRepoRef))] +[JsonSerializable(typeof(QueueBeginDeferredIdleDrainRequest))] +[JsonSerializable(typeof(QueueBeginDeferredIdleDrainResult))] +[JsonSerializable(typeof(QueueConsumeSystemNotificationsRequest))] +[JsonSerializable(typeof(QueueDeferSessionIdleRequest))] +[JsonSerializable(typeof(QueueDuplicateAtRequest))] +[JsonSerializable(typeof(QueueDuplicateAtResult))] +[JsonSerializable(typeof(QueueEnqueueResumePendingResult))] +[JsonSerializable(typeof(QueueFinishDeferredIdleDrainRequest))] +[JsonSerializable(typeof(QueueFinishDeferredIdleDrainResult))] +[JsonSerializable(typeof(QueueHasPendingResult))] +[JsonSerializable(typeof(QueueInsertAtRequest))] +[JsonSerializable(typeof(QueueInsertAtResult))] +[JsonSerializable(typeof(QueueInsertMessage))] +[JsonSerializable(typeof(QueueMoveItemRequest))] +[JsonSerializable(typeof(QueueMoveItemResult))] [JsonSerializable(typeof(QueuePendingItems))] [JsonSerializable(typeof(QueuePendingItemsResult))] +[JsonSerializable(typeof(QueueRemoveAtRequest))] +[JsonSerializable(typeof(QueueRemoveAtResult))] [JsonSerializable(typeof(QueueRemoveMostRecentResult))] +[JsonSerializable(typeof(QueueSendNowRequest))] +[JsonSerializable(typeof(QueueSendNowResult))] +[JsonSerializable(typeof(QueueSetDrainPausedRequest))] +[JsonSerializable(typeof(QueueSnapshotResult))] +[JsonSerializable(typeof(QueueUpdateTextRequest))] +[JsonSerializable(typeof(QueueUpdateTextResult))] [JsonSerializable(typeof(QueuedCommandResult))] [JsonSerializable(typeof(RegisterEventInterestParams))] [JsonSerializable(typeof(RegisterEventInterestResult))] @@ -25248,14 +36476,23 @@ public static void RegisterClientGlobalApiHandlers(JsonRpc rpc, ClientGlobalApiH [JsonSerializable(typeof(RemoteSessionMetadataValue))] [JsonSerializable(typeof(RunOptions))] [JsonSerializable(typeof(SandboxConfig))] +[JsonSerializable(typeof(SandboxConfigAuth))] [JsonSerializable(typeof(SandboxConfigUserPolicy))] [JsonSerializable(typeof(SandboxConfigUserPolicyExperimental))] [JsonSerializable(typeof(SandboxConfigUserPolicyExperimentalSeatbelt))] [JsonSerializable(typeof(SandboxConfigUserPolicyFilesystem))] [JsonSerializable(typeof(SandboxConfigUserPolicyNetwork))] +[JsonSerializable(typeof(SandboxConfigUserPolicyNetworkProxy))] [JsonSerializable(typeof(SandboxConfigUserPolicySeatbelt))] +[JsonSerializable(typeof(ScheduleAddAtRequest))] +[JsonSerializable(typeof(ScheduleAddCronRequest))] +[JsonSerializable(typeof(ScheduleAddRequest))] +[JsonSerializable(typeof(ScheduleAddResult))] +[JsonSerializable(typeof(ScheduleAddSelfPacedRequest))] [JsonSerializable(typeof(ScheduleEntry))] +[JsonSerializable(typeof(ScheduleHasSelfPacedResult))] [JsonSerializable(typeof(ScheduleList))] +[JsonSerializable(typeof(ScheduleRearmSelfPacedRequest))] [JsonSerializable(typeof(ScheduleStopRequest))] [JsonSerializable(typeof(ScheduleStopResult))] [JsonSerializable(typeof(SecretsAddFilterValuesRequest))] @@ -25266,6 +36503,7 @@ public static void RegisterClientGlobalApiHandlers(JsonRpc rpc, ClientGlobalApiH [JsonSerializable(typeof(SendMessagesResult))] [JsonSerializable(typeof(SendRequest))] [JsonSerializable(typeof(SendResult))] +[JsonSerializable(typeof(SendSystemNotificationRequest))] [JsonSerializable(typeof(ServerAgentList))] [JsonSerializable(typeof(ServerInstructionSourceList))] [JsonSerializable(typeof(ServerSkill))] @@ -25274,11 +36512,18 @@ public static void RegisterClientGlobalApiHandlers(JsonRpc rpc, ClientGlobalApiH [JsonSerializable(typeof(SessionAgentDeselectRequest))] [JsonSerializable(typeof(SessionAgentGetCurrentRequest))] [JsonSerializable(typeof(SessionAgentListRequest))] +[JsonSerializable(typeof(SessionAgentListRequestWithSession))] [JsonSerializable(typeof(SessionAgentReloadRequest))] +[JsonSerializable(typeof(SessionAuthLoginRequest))] +[JsonSerializable(typeof(SessionAuthLogoutUserRequest))] [JsonSerializable(typeof(SessionAuthStatus))] +[JsonSerializable(typeof(SessionAuthSwitchRequest))] [JsonSerializable(typeof(SessionBulkDeleteResult))] +[JsonSerializable(typeof(SessionCancelAllBackgroundAgentsRequest))] [JsonSerializable(typeof(SessionCanvasListOpenRequest))] [JsonSerializable(typeof(SessionCanvasListRequest))] +[JsonSerializable(typeof(SessionCommandsListRequest))] +[JsonSerializable(typeof(SessionCommandsListRequestWithSession))] [JsonSerializable(typeof(SessionCompletionItem))] [JsonSerializable(typeof(SessionCompletionsGetTriggerCharactersRequest))] [JsonSerializable(typeof(SessionContext))] @@ -25307,21 +36552,40 @@ public static void RegisterClientGlobalApiHandlers(JsonRpc rpc, ClientGlobalApiH [JsonSerializable(typeof(SessionFsSqliteExistsResult))] [JsonSerializable(typeof(SessionFsSqliteQueryRequest))] [JsonSerializable(typeof(SessionFsSqliteQueryResult))] +[JsonSerializable(typeof(SessionFsSqliteTransactionError))] +[JsonSerializable(typeof(SessionFsSqliteTransactionRequest))] +[JsonSerializable(typeof(SessionFsSqliteTransactionResult))] +[JsonSerializable(typeof(SessionFsSqliteTransactionStatement))] [JsonSerializable(typeof(SessionFsStatRequest))] [JsonSerializable(typeof(SessionFsStatResult))] [JsonSerializable(typeof(SessionFsWriteFileRequest))] +[JsonSerializable(typeof(SessionGitHubAuthGetAllAuthAvailableRequest))] +[JsonSerializable(typeof(SessionGitHubAuthGetCurrentAuthInfoRequest))] [JsonSerializable(typeof(SessionGitHubAuthGetStatusRequest))] +[JsonSerializable(typeof(SessionGitHubAuthLastAuthErrorsRequest))] +[JsonSerializable(typeof(SessionGitHubAuthLogoutRequest))] +[JsonSerializable(typeof(SessionGitHubAuthRefreshCopilotUserRequest))] [JsonSerializable(typeof(SessionHistoryAbortManualCompactionRequest))] [JsonSerializable(typeof(SessionHistoryCancelBackgroundCompactionRequest))] +[JsonSerializable(typeof(SessionHistoryCompactRequest))] +[JsonSerializable(typeof(SessionHistoryCompactRequestWithSession))] +[JsonSerializable(typeof(SessionHistoryListRewindPointsRequest))] [JsonSerializable(typeof(SessionHistorySummarizeForHandoffRequest))] [JsonSerializable(typeof(SessionInstalledPlugin))] [JsonSerializable(typeof(SessionInstructionsGetSourcesRequest))] +[JsonSerializable(typeof(SessionLimitPredictionBaselineData))] +[JsonSerializable(typeof(SessionLimitPredictionDetails))] +[JsonSerializable(typeof(SessionLimitPredictionPredictRequest))] +[JsonSerializable(typeof(SessionLimitPredictionPredictRequestWithSession))] +[JsonSerializable(typeof(SessionLimitPredictionResult))] +[JsonSerializable(typeof(SessionLimitPredictionTierOption))] [JsonSerializable(typeof(SessionList))] [JsonSerializable(typeof(SessionListEntry))] [JsonSerializable(typeof(SessionListFilter))] [JsonSerializable(typeof(SessionLoadDeferredRepoHooksResult))] [JsonSerializable(typeof(SessionMcpAppsGetHostContextRequest))] [JsonSerializable(typeof(SessionMcpListRequest))] +[JsonSerializable(typeof(SessionMcpMoveLoadingToBackgroundRequest))] [JsonSerializable(typeof(SessionMcpReloadRequest))] [JsonSerializable(typeof(SessionMcpRemoveGitHubRequest))] [JsonSerializable(typeof(SessionMetadataActivityRequest))] @@ -25333,6 +36597,8 @@ public static void RegisterClientGlobalApiHandlers(JsonRpc rpc, ClientGlobalApiH [JsonSerializable(typeof(SessionModeGetRequest))] [JsonSerializable(typeof(SessionModelGetCurrentRequest))] [JsonSerializable(typeof(SessionModelList))] +[JsonSerializable(typeof(SessionModelListRequest))] +[JsonSerializable(typeof(SessionModelListRequestWithSession))] [JsonSerializable(typeof(SessionModelPriceCategory))] [JsonSerializable(typeof(SessionNameGetRequest))] [JsonSerializable(typeof(SessionOpenResult))] @@ -25341,11 +36607,21 @@ public static void RegisterClientGlobalApiHandlers(JsonRpc rpc, ClientGlobalApiH [JsonSerializable(typeof(SessionPlanReadSqlTodosRequest))] [JsonSerializable(typeof(SessionPlanReadSqlTodosWithDependenciesRequest))] [JsonSerializable(typeof(SessionPluginsListRequest))] +[JsonSerializable(typeof(SessionPluginsReloadRequest))] +[JsonSerializable(typeof(SessionPluginsReloadRequestWithSession))] +[JsonSerializable(typeof(SessionProviderGetEndpointRequest))] +[JsonSerializable(typeof(SessionProviderGetEndpointRequestWithSession))] [JsonSerializable(typeof(SessionPruneResult))] [JsonSerializable(typeof(SessionQueueClearRequest))] +[JsonSerializable(typeof(SessionQueueEnqueueResumePendingRequest))] +[JsonSerializable(typeof(SessionQueueHasPendingRequest))] [JsonSerializable(typeof(SessionQueuePendingItemsRequest))] +[JsonSerializable(typeof(SessionQueueProcessRequest))] [JsonSerializable(typeof(SessionQueueRemoveMostRecentRequest))] +[JsonSerializable(typeof(SessionQueueSnapshotRequest))] [JsonSerializable(typeof(SessionRemoteDisableRequest))] +[JsonSerializable(typeof(SessionScheduleHasSelfPacedRequest))] +[JsonSerializable(typeof(SessionScheduleHydrateRequest))] [JsonSerializable(typeof(SessionScheduleListRequest))] [JsonSerializable(typeof(SessionSetCredentialsParams))] [JsonSerializable(typeof(SessionSetCredentialsResult))] @@ -25380,14 +36656,18 @@ public static void RegisterClientGlobalApiHandlers(JsonRpc rpc, ClientGlobalApiH [JsonSerializable(typeof(SessionUsageGetMetricsRequest))] [JsonSerializable(typeof(SessionVisibilityGetRequest))] [JsonSerializable(typeof(SessionWorkingDirectoryContext))] +[JsonSerializable(typeof(SessionWorkspacesAutopilotObjectiveExistsRequest))] +[JsonSerializable(typeof(SessionWorkspacesDeleteAutopilotObjectiveRequest))] [JsonSerializable(typeof(SessionWorkspacesGetWorkspaceRequest))] [JsonSerializable(typeof(SessionWorkspacesListCheckpointsRequest))] [JsonSerializable(typeof(SessionWorkspacesListFilesRequest))] +[JsonSerializable(typeof(SessionWorkspacesReadAutopilotObjectiveRequest))] [JsonSerializable(typeof(SessionsBulkDeleteRequest))] [JsonSerializable(typeof(SessionsCheckInUseRequest))] [JsonSerializable(typeof(SessionsCheckInUseResult))] [JsonSerializable(typeof(SessionsCloseRequest))] [JsonSerializable(typeof(SessionsCloseResult))] +[JsonSerializable(typeof(SessionsDeleteRequest))] [JsonSerializable(typeof(SessionsEnrichMetadataRequest))] [JsonSerializable(typeof(SessionsFindByPrefixRequest))] [JsonSerializable(typeof(SessionsFindByPrefixResult))] @@ -25401,8 +36681,12 @@ public static void RegisterClientGlobalApiHandlers(JsonRpc rpc, ClientGlobalApiH [JsonSerializable(typeof(SessionsGetEventFilePathResult))] [JsonSerializable(typeof(SessionsGetLastForContextRequest))] [JsonSerializable(typeof(SessionsGetLastForContextResult))] +[JsonSerializable(typeof(SessionsGetMetadataRequest))] +[JsonSerializable(typeof(SessionsGetMetadataResult))] [JsonSerializable(typeof(SessionsGetPersistedRemoteSteerableRequest))] [JsonSerializable(typeof(SessionsGetPersistedRemoteSteerableResult))] +[JsonSerializable(typeof(SessionsListNonEmptySessionIdsRequest))] +[JsonSerializable(typeof(SessionsListNonEmptySessionIdsResult))] [JsonSerializable(typeof(SessionsListRequest))] [JsonSerializable(typeof(SessionsLoadDeferredRepoHooksRequest))] [JsonSerializable(typeof(SessionsOpenProgress))] @@ -25420,18 +36704,23 @@ public static void RegisterClientGlobalApiHandlers(JsonRpc rpc, ClientGlobalApiH [JsonSerializable(typeof(SessionsStartRemoteControlRequest))] [JsonSerializable(typeof(SessionsStopRemoteControlRequest))] [JsonSerializable(typeof(SessionsTransferRemoteControlRequest))] +[JsonSerializable(typeof(SettableAuthInfo))] [JsonSerializable(typeof(ShellCancelUserRequestedRequest))] +[JsonSerializable(typeof(ShellCredentials))] [JsonSerializable(typeof(ShellExecRequest))] [JsonSerializable(typeof(ShellExecResult))] [JsonSerializable(typeof(ShellExecuteUserRequestedRequest))] +[JsonSerializable(typeof(ShellInitScript))] [JsonSerializable(typeof(ShellKillRequest))] [JsonSerializable(typeof(ShellKillResult))] +[JsonSerializable(typeof(ShellOptions))] [JsonSerializable(typeof(ShutdownRequest))] [JsonSerializable(typeof(Skill))] [JsonSerializable(typeof(SkillDiscoveryPath))] [JsonSerializable(typeof(SkillDiscoveryPathList))] [JsonSerializable(typeof(SkillList))] [JsonSerializable(typeof(SkillsConfigSetDisabledSkillsRequest))] +[JsonSerializable(typeof(SkillsConfigSetSkillDisabledRequest))] [JsonSerializable(typeof(SkillsDisableRequest))] [JsonSerializable(typeof(SkillsDiscoverRequest))] [JsonSerializable(typeof(SkillsEnableRequest))] @@ -25443,8 +36732,13 @@ public static void RegisterClientGlobalApiHandlers(JsonRpc rpc, ClientGlobalApiH [JsonSerializable(typeof(SlashCommandInput))] [JsonSerializable(typeof(SlashCommandInputChoice))] [JsonSerializable(typeof(SlashCommandInvocationResult))] +[JsonSerializable(typeof(SlashCommandInvocationResultSetModelRevertOnCancel))] +[JsonSerializable(typeof(SlashCommandModelPickerDialog))] [JsonSerializable(typeof(SlashCommandSelectSubcommandOption))] +[JsonSerializable(typeof(SlashCommandTimelineEntry))] [JsonSerializable(typeof(SubagentSettingsEntry))] +[JsonSerializable(typeof(TaskCompleteData))] +[JsonSerializable(typeof(TaskCompletionDecision))] [JsonSerializable(typeof(TaskInfo))] [JsonSerializable(typeof(TaskList))] [JsonSerializable(typeof(TaskProgressLine))] @@ -25468,12 +36762,23 @@ public static void RegisterClientGlobalApiHandlers(JsonRpc rpc, ClientGlobalApiH [JsonSerializable(typeof(TelemetrySetFeatureOverridesRequest))] [JsonSerializable(typeof(Tool))] [JsonSerializable(typeof(ToolList))] +[JsonSerializable(typeof(ToolResultExpanded))] +[JsonSerializable(typeof(ToolResultNewMessage))] +[JsonSerializable(typeof(ToolsExecuteRequest))] +[JsonSerializable(typeof(ToolsGetBuiltinDescriptorsRequest))] +[JsonSerializable(typeof(ToolsGetBuiltinDescriptorsResult))] [JsonSerializable(typeof(ToolsGetCurrentMetadataResult))] [JsonSerializable(typeof(ToolsInitializeAndValidateResult))] [JsonSerializable(typeof(ToolsListRequest))] +[JsonSerializable(typeof(ToolsSetRequest))] +[JsonSerializable(typeof(ToolsSetResult))] +[JsonSerializable(typeof(ToolsShellDescriptorConfig))] +[JsonSerializable(typeof(ToolsTaskCompleteEventDataRequest))] [JsonSerializable(typeof(ToolsUpdateSubagentSettingsResult))] [JsonSerializable(typeof(UIElicitationRequest))] +[JsonSerializable(typeof(UIElicitationRequestMeta))] [JsonSerializable(typeof(UIElicitationResponse))] +[JsonSerializable(typeof(UIElicitationResponseMeta))] [JsonSerializable(typeof(UIElicitationResult))] [JsonSerializable(typeof(UIElicitationSchema))] [JsonSerializable(typeof(UIEphemeralQueryRequest))] @@ -25495,6 +36800,7 @@ public static void RegisterClientGlobalApiHandlers(JsonRpc rpc, ClientGlobalApiH [JsonSerializable(typeof(UpdateSubagentSettingsRequest))] [JsonSerializable(typeof(UpdateSubagentSettingsRequestSubagents))] [JsonSerializable(typeof(UsageGetMetricsResult))] +[JsonSerializable(typeof(UsageMetricsAgentMetric))] [JsonSerializable(typeof(UsageMetricsCodeChanges))] [JsonSerializable(typeof(UsageMetricsModelMetric))] [JsonSerializable(typeof(UsageMetricsModelMetricRequests))] @@ -25511,13 +36817,21 @@ public static void RegisterClientGlobalApiHandlers(JsonRpc rpc, ClientGlobalApiH [JsonSerializable(typeof(VisibilitySetResult))] [JsonSerializable(typeof(WorkspaceDiffFileChange))] [JsonSerializable(typeof(WorkspaceDiffResult))] +[JsonSerializable(typeof(WorkspacesAddSummaryRequest))] +[JsonSerializable(typeof(WorkspacesAddSummaryResult))] +[JsonSerializable(typeof(WorkspacesAddSummaryResultSummary))] +[JsonSerializable(typeof(WorkspacesAddSummaryResultWorkspace))] +[JsonSerializable(typeof(WorkspacesAutopilotObjectiveExistsResult))] [JsonSerializable(typeof(WorkspacesCheckpoints))] [JsonSerializable(typeof(WorkspacesCreateFileRequest))] +[JsonSerializable(typeof(WorkspacesDeleteAutopilotObjectiveResult))] [JsonSerializable(typeof(WorkspacesDiffRequest))] +[JsonSerializable(typeof(WorkspacesEnsureRequest))] [JsonSerializable(typeof(WorkspacesGetWorkspaceResult))] [JsonSerializable(typeof(WorkspacesGetWorkspaceResultWorkspace))] [JsonSerializable(typeof(WorkspacesListCheckpointsResult))] [JsonSerializable(typeof(WorkspacesListFilesResult))] +[JsonSerializable(typeof(WorkspacesReadAutopilotObjectiveResult))] [JsonSerializable(typeof(WorkspacesReadCheckpointRequest))] [JsonSerializable(typeof(WorkspacesReadCheckpointResult))] [JsonSerializable(typeof(WorkspacesReadFileRequest))] @@ -25525,4 +36839,8 @@ public static void RegisterClientGlobalApiHandlers(JsonRpc rpc, ClientGlobalApiH [JsonSerializable(typeof(WorkspacesSaveLargePasteRequest))] [JsonSerializable(typeof(WorkspacesSaveLargePasteResult))] [JsonSerializable(typeof(WorkspacesSaveLargePasteResultSaved))] +[JsonSerializable(typeof(WorkspacesTruncateSummariesRequest))] +[JsonSerializable(typeof(WorkspacesUpdateMetadataRequest))] +[JsonSerializable(typeof(WorkspacesWriteAutopilotObjectiveRequest))] +[JsonSerializable(typeof(WorkspacesWriteAutopilotObjectiveResult))] internal partial class RpcJsonContext : JsonSerializerContext; \ No newline at end of file diff --git a/dotnet/src/Generated/SessionEvents.cs b/dotnet/src/Generated/SessionEvents.cs index a8c70df7cc..b4351c8f2e 100644 --- a/dotnet/src/Generated/SessionEvents.cs +++ b/dotnet/src/Generated/SessionEvents.cs @@ -25,6 +25,10 @@ namespace GitHub.Copilot; TypeDiscriminatorPropertyName = "type", IgnoreUnrecognizedTypeDiscriminators = true)] [JsonDerivedType(typeof(AbortEvent), "abort")] +[JsonDerivedType(typeof(AgentInterruptedEvent), "agent.interrupted")] +[JsonDerivedType(typeof(AssistantFusionPhaseCompletedEvent), "assistant.fusion_phase_completed")] +[JsonDerivedType(typeof(AssistantFusionPhaseFailedEvent), "assistant.fusion_phase_failed")] +[JsonDerivedType(typeof(AssistantFusionPhaseStartedEvent), "assistant.fusion_phase_started")] [JsonDerivedType(typeof(AssistantIdleEvent), "assistant.idle")] [JsonDerivedType(typeof(AssistantIntentEvent), "assistant.intent")] [JsonDerivedType(typeof(AssistantMessageEvent), "assistant.message")] @@ -52,6 +56,9 @@ namespace GitHub.Copilot; [JsonDerivedType(typeof(ExitPlanModeRequestedEvent), "exit_plan_mode.requested")] [JsonDerivedType(typeof(ExternalToolCompletedEvent), "external_tool.completed")] [JsonDerivedType(typeof(ExternalToolRequestedEvent), "external_tool.requested")] +[JsonDerivedType(typeof(FactoryRunSettledEvent), "factory.run_settled")] +[JsonDerivedType(typeof(FactoryRunStartedEvent), "factory.run_started")] +[JsonDerivedType(typeof(FactoryRunUpdatedEvent), "factory.run_updated")] [JsonDerivedType(typeof(HookEndEvent), "hook.end")] [JsonDerivedType(typeof(HookProgressEvent), "hook.progress")] [JsonDerivedType(typeof(HookStartEvent), "hook.start")] @@ -64,12 +71,15 @@ namespace GitHub.Copilot; [JsonDerivedType(typeof(McpResourcesListChangedEvent), "mcp.resources.list_changed")] [JsonDerivedType(typeof(McpToolsListChangedEvent), "mcp.tools.list_changed")] [JsonDerivedType(typeof(ModelCallFailureEvent), "model.call_failure")] +[JsonDerivedType(typeof(ModelCallFinishedEvent), "model.call_finished")] [JsonDerivedType(typeof(ModelCallStartEvent), "model.call_start")] [JsonDerivedType(typeof(PendingMessagesModifiedEvent), "pending_messages.modified")] [JsonDerivedType(typeof(PermissionCompletedEvent), "permission.completed")] [JsonDerivedType(typeof(PermissionRequestedEvent), "permission.requested")] +[JsonDerivedType(typeof(PromptCacheBreakEvent), "prompt_cache_break")] [JsonDerivedType(typeof(SamplingCompletedEvent), "sampling.completed")] [JsonDerivedType(typeof(SamplingRequestedEvent), "sampling.requested")] +[JsonDerivedType(typeof(SandboxDecisionEvent), "sandbox.decision")] [JsonDerivedType(typeof(SessionLimitsExhaustedCompletedEvent), "session_limits_exhausted.completed")] [JsonDerivedType(typeof(SessionLimitsExhaustedRequestedEvent), "session_limits_exhausted.requested")] [JsonDerivedType(typeof(SessionAutoModeResolvedEvent), "session.auto_mode_resolved")] @@ -85,11 +95,16 @@ namespace GitHub.Copilot; [JsonDerivedType(typeof(SessionCompactionCompleteEvent), "session.compaction_complete")] [JsonDerivedType(typeof(SessionCompactionStartEvent), "session.compaction_start")] [JsonDerivedType(typeof(SessionContextChangedEvent), "session.context_changed")] +[JsonDerivedType(typeof(SessionContextClearedEvent), "session.context_cleared")] [JsonDerivedType(typeof(SessionCustomAgentsUpdatedEvent), "session.custom_agents_updated")] [JsonDerivedType(typeof(SessionCustomNotificationEvent), "session.custom_notification")] [JsonDerivedType(typeof(SessionErrorEvent), "session.error")] [JsonDerivedType(typeof(SessionExtensionsLoadedEvent), "session.extensions_loaded")] [JsonDerivedType(typeof(SessionExtensionsAttachmentsPushedEvent), "session.extensions.attachments_pushed")] +[JsonDerivedType(typeof(SessionFusionCompletedEvent), "session.fusion_completed")] +[JsonDerivedType(typeof(SessionFusionResolvedEvent), "session.fusion_resolved")] +[JsonDerivedType(typeof(SessionFusionRouteFailedEvent), "session.fusion_route_failed")] +[JsonDerivedType(typeof(SessionFusionRouteStartedEvent), "session.fusion_route_started")] [JsonDerivedType(typeof(SessionHandoffEvent), "session.handoff")] [JsonDerivedType(typeof(SessionIdleEvent), "session.idle")] [JsonDerivedType(typeof(SessionInfoEvent), "session.info")] @@ -122,6 +137,7 @@ namespace GitHub.Copilot; [JsonDerivedType(typeof(SessionWorkspaceFileChangedEvent), "session.workspace_file_changed")] [JsonDerivedType(typeof(SkillInvokedEvent), "skill.invoked")] [JsonDerivedType(typeof(SubagentCompletedEvent), "subagent.completed")] +[JsonDerivedType(typeof(SubagentConfiguredEvent), "subagent.configured")] [JsonDerivedType(typeof(SubagentDeselectedEvent), "subagent.deselected")] [JsonDerivedType(typeof(SubagentFailedEvent), "subagent.failed")] [JsonDerivedType(typeof(SubagentSelectedEvent), "subagent.selected")] @@ -134,6 +150,7 @@ namespace GitHub.Copilot; [JsonDerivedType(typeof(ToolExecutionProgressEvent), "tool.execution_progress")] [JsonDerivedType(typeof(ToolExecutionStartEvent), "tool.execution_start")] [JsonDerivedType(typeof(ToolUserRequestedEvent), "tool.user_requested")] +[JsonDerivedType(typeof(UiEphemeralQueryEvent), "ui.ephemeral_query")] [JsonDerivedType(typeof(UserInputCompletedEvent), "user_input.completed")] [JsonDerivedType(typeof(UserInputRequestedEvent), "user_input.requested")] [JsonDerivedType(typeof(UserMessageEvent), "user.message")] @@ -374,8 +391,9 @@ public sealed partial class SessionSessionLimitsChangedEvent : SessionEvent public required SessionSessionLimitsChangedData Data { get; set; } } -/// Permissions change details carrying the aggregate allow-all transition. +/// Permission-mode transition details. /// Represents the session.permissions_changed event. +[Experimental(Diagnostics.Experimental)] public sealed partial class SessionPermissionsChangedEvent : SessionEvent { /// @@ -517,6 +535,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 @@ -556,6 +587,62 @@ public sealed partial class SessionTaskCompleteEvent : SessionEvent public required SessionTaskCompleteData Data { get; set; } } +/// Experimental transient signal that HydraFusion routing has started for an eligible turn. +/// Represents the session.fusion_route_started event. +[Experimental(Diagnostics.Experimental)] +public sealed partial class SessionFusionRouteStartedEvent : SessionEvent +{ + /// + [JsonIgnore] + public override string Type => "session.fusion_route_started"; + + /// The session.fusion_route_started event payload. + [JsonPropertyName("data")] + public required SessionFusionRouteStartedData Data { get; set; } +} + +/// Experimental durable HydraFusion routing failure and the deterministic concrete fallback selected for the turn. +/// Represents the session.fusion_route_failed event. +[Experimental(Diagnostics.Experimental)] +public sealed partial class SessionFusionRouteFailedEvent : SessionEvent +{ + /// + [JsonIgnore] + public override string Type => "session.fusion_route_failed"; + + /// The session.fusion_route_failed event payload. + [JsonPropertyName("data")] + public required SessionFusionRouteFailedData Data { get; set; } +} + +/// Experimental durable validated HydraFusion route and turn policy. +/// Represents the session.fusion_resolved event. +[Experimental(Diagnostics.Experimental)] +public sealed partial class SessionFusionResolvedEvent : SessionEvent +{ + /// + [JsonIgnore] + public override string Type => "session.fusion_resolved"; + + /// The session.fusion_resolved event payload. + [JsonPropertyName("data")] + public required SessionFusionResolvedData Data { get; set; } +} + +/// Experimental durable aggregate outcome of a HydraFusion turn. +/// Represents the session.fusion_completed event. +[Experimental(Diagnostics.Experimental)] +public sealed partial class SessionFusionCompletedEvent : SessionEvent +{ + /// + [JsonIgnore] + public override string Type => "session.fusion_completed"; + + /// The session.fusion_completed event payload. + [JsonPropertyName("data")] + public required SessionFusionCompletedData Data { get; set; } +} + /// 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 @@ -608,6 +695,19 @@ public sealed partial class AssistantTurnRetryEvent : SessionEvent public required AssistantTurnRetryData Data { get; set; } } +/// Metadata for work the user interrupted while the agent was running. +/// Represents the agent.interrupted event. +public sealed partial class AgentInterruptedEvent : SessionEvent +{ + /// + [JsonIgnore] + public override string Type => "agent.interrupted"; + + /// The agent.interrupted event payload. + [JsonPropertyName("data")] + public required AgentInterruptedData Data { get; set; } +} + /// Agent intent description for current activity or plan. /// Represents the assistant.intent event. public sealed partial class AssistantIntentEvent : SessionEvent @@ -621,6 +721,48 @@ public sealed partial class AssistantIntentEvent : SessionEvent public required AssistantIntentData Data { get; set; } } +/// Experimental transient HydraFusion phase/model/role signal. +/// Represents the assistant.fusion_phase_started event. +[Experimental(Diagnostics.Experimental)] +public sealed partial class AssistantFusionPhaseStartedEvent : SessionEvent +{ + /// + [JsonIgnore] + public override string Type => "assistant.fusion_phase_started"; + + /// The assistant.fusion_phase_started event payload. + [JsonPropertyName("data")] + public required AssistantFusionPhaseStartedData Data { get; set; } +} + +/// Experimental durable HydraFusion phase output and lossless replay checkpoint. +/// Represents the assistant.fusion_phase_completed event. +[Experimental(Diagnostics.Experimental)] +public sealed partial class AssistantFusionPhaseCompletedEvent : SessionEvent +{ + /// + [JsonIgnore] + public override string Type => "assistant.fusion_phase_completed"; + + /// The assistant.fusion_phase_completed event payload. + [JsonPropertyName("data")] + public required AssistantFusionPhaseCompletedData Data { get; set; } +} + +/// Experimental durable typed HydraFusion phase failure and degradation transition. +/// Represents the assistant.fusion_phase_failed event. +[Experimental(Diagnostics.Experimental)] +public sealed partial class AssistantFusionPhaseFailedEvent : SessionEvent +{ + /// + [JsonIgnore] + public override string Type => "assistant.fusion_phase_failed"; + + /// The assistant.fusion_phase_failed event payload. + [JsonPropertyName("data")] + public required AssistantFusionPhaseFailedData 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 @@ -764,6 +906,19 @@ public sealed partial class AssistantUsageEvent : SessionEvent public required AssistantUsageData Data { get; set; } } +/// A detected loss of a previously cached prompt prefix. +/// Represents the prompt_cache_break event. +public sealed partial class PromptCacheBreakEvent : SessionEvent +{ + /// + [JsonIgnore] + public override string Type => "prompt_cache_break"; + + /// The prompt_cache_break event payload. + [JsonPropertyName("data")] + public required PromptCacheBreakData Data { get; set; } +} + /// Failed LLM API call metadata for telemetry. /// Represents the model.call_failure event. public sealed partial class ModelCallFailureEvent : SessionEvent @@ -777,6 +932,19 @@ public sealed partial class ModelCallFailureEvent : SessionEvent public required ModelCallFailureData Data { get; set; } } +/// Final lifecycle outcome for one logical model dispatch. A logical dispatch may include internal reconnect or fallback work, so event count is not provider HTTP-request count. +/// Represents the model.call_finished event. +public sealed partial class ModelCallFinishedEvent : SessionEvent +{ + /// + [JsonIgnore] + public override string Type => "model.call_finished"; + + /// The model.call_finished event payload. + [JsonPropertyName("data")] + public required ModelCallFinishedData Data { get; set; } +} + /// Model API dispatch metadata for internal telemetry. /// Represents the model.call_start event. public sealed partial class ModelCallStartEvent : SessionEvent @@ -894,6 +1062,19 @@ public sealed partial class SkillInvokedEvent : SessionEvent public required SkillInvokedData Data { get; set; } } +/// Payload of `sandbox.decision`, a bounded governance record of what the process sandbox was configured to do and whether it took effect. Discriminated by `kind`. +/// Represents the sandbox.decision event. +public sealed partial class SandboxDecisionEvent : SessionEvent +{ + /// + [JsonIgnore] + public override string Type => "sandbox.decision"; + + /// The sandbox.decision event payload. + [JsonPropertyName("data")] + public required SandboxDecisionData Data { get; set; } +} + /// Sub-agent startup details including parent tool call and agent information. /// Represents the subagent.started event. public sealed partial class SubagentStartedEvent : SessionEvent @@ -907,6 +1088,19 @@ public sealed partial class SubagentStartedEvent : SessionEvent public required SubagentStartedData Data { get; set; } } +/// Resolved runtime configuration for a configured sub-agent. +/// Represents the subagent.configured event. +public sealed partial class SubagentConfiguredEvent : SessionEvent +{ + /// + [JsonIgnore] + public override string Type => "subagent.configured"; + + /// The subagent.configured event payload. + [JsonPropertyName("data")] + public required SubagentConfiguredData Data { get; set; } +} + /// Sub-agent completion details for successful execution. /// Represents the subagent.completed event. public sealed partial class SubagentCompletedEvent : SessionEvent @@ -1207,6 +1401,20 @@ public sealed partial class SessionCustomNotificationEvent : SessionEvent public required SessionCustomNotificationData Data { get; set; } } +/// Ordered output and terminal state for a transient query that does not modify conversation history. +/// Represents the ui.ephemeral_query event. +[Experimental(Diagnostics.Experimental)] +public sealed partial class UiEphemeralQueryEvent : SessionEvent +{ + /// + [JsonIgnore] + public override string Type => "ui.ephemeral_query"; + + /// The ui.ephemeral_query event payload. + [JsonPropertyName("data")] + public required UiEphemeralQueryData Data { get; set; } +} + /// External tool invocation request for client-side tool execution. /// Represents the external_tool.requested event. public sealed partial class ExternalToolRequestedEvent : SessionEvent @@ -1338,7 +1546,7 @@ public sealed partial class SessionAutoModeResolvedEvent : SessionEvent public required SessionAutoModeResolvedData Data { get; set; } } -/// Enterprise managed-settings resolution: the effective managed settings the session applied and where they came from, so SDK clients can show users what is enterprise-managed and by which authority. 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; for a session-independent pull, use the SDK `getManagedSettings()` API, which returns the identical payload. Managed settings have a single authoritative source, so the highest-authority present layer (server > device) wins wholesale; `bypassPermissionsDisabled` is deny-wins across layers. Marked experimental while the managed-settings surface stabilizes. +/// 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 @@ -1444,6 +1652,48 @@ public sealed partial class SessionBackgroundTasksChangedEvent : SessionEvent public required SessionBackgroundTasksChangedData Data { get; set; } } +/// 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; } +} + +/// Ephemeral signal that a factory run attempt began executing. +/// Represents the factory.run_started event. +[Experimental(Diagnostics.Experimental)] +public sealed partial class FactoryRunStartedEvent : SessionEvent +{ + /// + [JsonIgnore] + public override string Type => "factory.run_started"; + + /// The factory.run_started event payload. + [JsonPropertyName("data")] + public required FactoryRunStartedData Data { get; set; } +} + +/// Ephemeral signal that a factory run reached a terminal status. +/// Represents the factory.run_settled event. +[Experimental(Diagnostics.Experimental)] +public sealed partial class FactoryRunSettledEvent : SessionEvent +{ + /// + [JsonIgnore] + public override string Type => "factory.run_settled"; + + /// The factory.run_settled event payload. + [JsonPropertyName("data")] + public required FactoryRunSettledData Data { get; set; } +} + /// Payload of `session.skills_loaded` listing resolved skill metadata. /// Represents the session.skills_loaded event. public sealed partial class SessionSkillsLoadedEvent : SessionEvent @@ -1685,6 +1935,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; } @@ -1750,7 +2005,7 @@ public sealed partial class SessionResumeData [JsonPropertyName("contextTier")] 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; } @@ -1793,7 +2048,7 @@ public sealed partial class SessionResumeData [JsonPropertyName("sessionLimits")] public SessionLimitsConfig? SessionLimits { 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. + /// 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; } @@ -1866,6 +2121,11 @@ public sealed partial class SessionIdleData [JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)] [JsonPropertyName("aborted")] public bool? Aborted { get; set; } + + /// The session mode the agent was operating in when it went idle, when the mode is known. Lets turn-scoped consumers distinguish an autopilot continuation boundary (where the agent keeps working after this idle) from a genuine turn completion. + [JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)] + [JsonPropertyName("mode")] + public SessionMode? Mode { get; set; } } /// Session title change payload containing the new display title. @@ -1904,6 +2164,11 @@ public sealed partial class SessionScheduleCreatedData [JsonPropertyName("intervalMs")] 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")] public required string Prompt { get; set; } @@ -2004,7 +2269,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; } @@ -2048,6 +2313,11 @@ public sealed partial class SessionModelChangeData [JsonPropertyName("reasoningSummary")] public ReasoningSummary? ReasoningSummary { get; set; } + /// Origin of the effective model change, when known. + [JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)] + [JsonPropertyName("source")] + public ModelChangeSource? Source { get; set; } + /// Output verbosity level after the model change, if applicable. [JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)] [JsonPropertyName("verbosity")] @@ -2074,28 +2344,25 @@ public sealed partial class SessionSessionLimitsChangedData public SessionLimitsConfig? SessionLimits { get; set; } } -/// Permissions change details carrying the aggregate allow-all transition. +/// Permission-mode transition details. +[Experimental(Diagnostics.Experimental)] public sealed partial class SessionPermissionsChangedData { - /// Allow-all mode after the change. + /// Explicit LLM judge model override used by assisted mode; omitted when the provider default applies. [Experimental(Diagnostics.Experimental)] [JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)] - [JsonPropertyName("allowAllPermissionMode")] - public PermissionAllowAllMode? AllowAllPermissionMode { get; set; } + [JsonPropertyName("assistedApprovalModel")] + public string? AssistedApprovalModel { get; set; } - /// Aggregate allow-all flag after the change. - [JsonPropertyName("allowAllPermissions")] - public required bool AllowAllPermissions { get; set; } - - /// Allow-all mode before the change. + /// Permission mode after the change. [Experimental(Diagnostics.Experimental)] - [JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)] - [JsonPropertyName("previousAllowAllPermissionMode")] - public PermissionAllowAllMode? PreviousAllowAllPermissionMode { get; set; } + [JsonPropertyName("mode")] + public required PermissionMode Mode { get; set; } - /// Aggregate allow-all flag before the change. - [JsonPropertyName("previousAllowAllPermissions")] - public required bool PreviousAllowAllPermissions { get; set; } + /// Permission mode before the change. + [Experimental(Diagnostics.Experimental)] + [JsonPropertyName("previousMode")] + public required PermissionMode PreviousMode { get; set; } } /// Plan file operation details indicating what changed. @@ -2211,6 +2478,11 @@ public sealed partial class SessionSnapshotRewindData /// Session termination metrics including usage statistics, code changes, and shutdown reason. public sealed partial class SessionShutdownData { + /// Per-agent usage breakdown, keyed by agent instance identifier. The main conversation uses the stable key `main`. + [JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)] + [JsonPropertyName("agentMetrics")] + public IDictionary? AgentMetrics { get; set; } + /// Aggregate code change metrics for the session. [JsonPropertyName("codeChanges")] public required ShutdownCodeChanges CodeChanges { get; set; } @@ -2294,6 +2566,12 @@ public sealed partial class SessionUsageCheckpointData [JsonPropertyName("modelCacheState")] internal UsageCheckpointModelCacheState[]? ModelCacheState { get; set; } + /// Internal per-conversation prompt-cache-break detector baselines restored on resume. + [JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)] + [JsonInclude] + [JsonPropertyName("promptCacheBreakState")] + internal JsonElement[]? PromptCacheBreakState { get; set; } + /// Session-wide accumulated nano-AI units cost at checkpoint time. [JsonPropertyName("totalNanoAiu")] public required double TotalNanoAiu { get; set; } @@ -2337,6 +2615,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")] @@ -2384,6 +2667,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 { @@ -2392,6 +2688,11 @@ 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")] @@ -2402,15 +2703,30 @@ public sealed partial class SessionCompactionStartData [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. public sealed partial class SessionCompactionCompleteData { + /// Canonical model identifier used for model-specific behavior when replaying compaction. + [JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)] + [JsonPropertyName("behaviorModelId")] + public string? BehaviorModelId { get; set; } + /// Checkpoint snapshot number created for recovery. [JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)] [JsonPropertyName("checkpointNumber")] @@ -2490,6 +2806,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")] @@ -2499,12 +2820,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; } @@ -2515,78 +2856,314 @@ public sealed partial class SessionTaskCompleteData public string? Summary { get; set; } } -/// Payload of `user.message` with displayed and model-transformed content, attachments, source/delivery metadata, mode, and telemetry IDs. -public sealed partial class UserMessageData +/// Experimental transient signal that HydraFusion routing has started for an eligible turn. +[Experimental(Diagnostics.Experimental)] +public sealed partial class SessionFusionRouteStartedData { - /// The agent mode that was active when this message was sent. + /// Identifier for this routing attempt before a durable Fusion turn exists. + [JsonPropertyName("attemptId")] + public required string AttemptId { get; set; } + + /// HydraFusion routing policy requested for the turn. [JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)] - [JsonPropertyName("agentMode")] - public UserMessageAgentMode? AgentMode { get; set; } + [JsonPropertyName("policy")] + public string? Policy { get; set; } - /// Files, selections, or GitHub references attached to the message. + /// Synthetic HydraFusion model selected for the session. [JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)] - [JsonPropertyName("attachments")] - public Attachment[]? Attachments { get; set; } + [JsonPropertyName("syntheticModel")] + public string? SyntheticModel { get; set; } - /// The user's message text as displayed in the timeline. - [JsonPropertyName("content")] - public required string Content { get; set; } + /// Kind of turn being routed. + [JsonPropertyName("turnKind")] + public required FusionTurnKind TurnKind { 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. +/// Experimental durable HydraFusion routing failure and the deterministic concrete fallback selected for the turn. +[Experimental(Diagnostics.Experimental)] +public sealed partial class SessionFusionRouteFailedData +{ + /// Identifier of the routing attempt that failed. + [JsonPropertyName("attemptId")] + public required string AttemptId { get; set; } + + /// Provider or validation error detail, when available. [JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)] - [JsonPropertyName("delivery")] - public UserMessageDelivery? Delivery { get; set; } + [JsonPropertyName("errorMessage")] + public string? ErrorMessage { get; set; } - /// CAPI interaction ID for correlating this user message with its turn. + /// Concrete model selected as the deterministic fallback. + [JsonPropertyName("fallbackModel")] + public required string FallbackModel { get; set; } + + /// HydraFusion routing policy requested for the turn. + [JsonPropertyName("policy")] + public required string Policy { get; set; } + + /// Stable machine-readable reason for the routing failure. + [JsonPropertyName("reason")] + public required string Reason { get; set; } + + /// Elapsed routing time in milliseconds before the failure. [JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)] - [JsonPropertyName("interactionId")] - public string? InteractionId { get; set; } + [JsonPropertyName("routingLatencyMs")] + public double? RoutingLatencyMs { get; set; } - /// 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. + /// Synthetic HydraFusion model selected for the session. + [JsonPropertyName("syntheticModel")] + public required string SyntheticModel { get; set; } +} + +/// Experimental durable validated HydraFusion route and turn policy. +[Experimental(Diagnostics.Experimental)] +public sealed partial class SessionFusionResolvedData +{ + /// Version of the validated HydraFusion event contract. + [JsonPropertyName("contractVersion")] + public required long ContractVersion { get; set; } + + /// Concrete model used when the planned primary model cannot execute. + [JsonPropertyName("fallbackModel")] + public required string FallbackModel { get; set; } + + /// Router recommendation controlling reuse or rerouting on later turns. [JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)] - [JsonPropertyName("isAutopilotContinuation")] - public bool? IsAutopilotContinuation { get; set; } + [JsonPropertyName("followUp")] + public FusionFollowUpRecommendation? FollowUp { get; set; } - /// 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. + /// Concrete model recommended for eligible follow-up turns. + [JsonPropertyName("followUpModel")] + public required string FollowUpModel { get; set; } + + /// Stable identifier for the resolved HydraFusion turn. + [JsonPropertyName("fusionId")] + public required string FusionId { get; set; } + + /// Version of the executable model universe used for selection. [JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)] - [JsonPropertyName("nativeDocumentPathFallbackPaths")] - public string[]? NativeDocumentPathFallbackPaths { get; set; } + [JsonPropertyName("modelUniverseVersion")] + public string? ModelUniverseVersion { get; set; } - /// Parent agent task ID for background telemetry correlated to this user turn. + /// Validated orchestration pattern selected for the turn. + [JsonPropertyName("pattern")] + public required FusionPattern Pattern { get; set; } + + /// Version of the validated execution-plan format. [JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)] - [JsonPropertyName("parentAgentTaskId")] - public string? ParentAgentTaskId { get; set; } + [JsonPropertyName("planVersion")] + public string? PlanVersion { get; set; } + + /// HydraFusion routing policy used to resolve the plan. + [JsonPropertyName("policy")] + public required string Policy { 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). + /// Version of the local routing policy. [JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)] - [JsonPropertyName("source")] - public string? Source { get; set; } + [JsonPropertyName("policyVersion")] + public string? PolicyVersion { get; set; } - /// Normalized document MIME types that were sent natively instead of through tagged_files XML. + /// Concrete model selected for the primary solver phase. + [JsonPropertyName("primaryModel")] + public required string PrimaryModel { get; set; } + + /// Router implementation that supplied the plan. [JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)] - [JsonPropertyName("supportedNativeDocumentMimeTypes")] - public string[]? SupportedNativeDocumentMimeTypes { get; set; } + [JsonPropertyName("routeSource")] + public string? RouteSource { get; set; } - /// Transformed version of the message sent to the model, with XML wrapping, timestamps, and other augmentations for prompt caching. + /// Elapsed time in milliseconds required to resolve and validate the route. [JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)] - [JsonPropertyName("transformedContent")] - public string? TransformedContent { get; set; } -} + [JsonPropertyName("routingLatencyMs")] + public double? RoutingLatencyMs { get; set; } -/// Empty payload; the event signals that the pending message queue has changed. -public sealed partial class PendingMessagesModifiedData -{ -} + /// Identifier of the local policy rule that matched. + [JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)] + [JsonPropertyName("ruleId")] + public string? RuleId { get; set; } -/// Turn initialization metadata including identifier and interaction tracking. -public sealed partial class AssistantTurnStartData -{ - /// CAPI interaction ID for correlating this turn with upstream telemetry. + /// Zero-based index of the local policy rule that matched. [JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)] - [JsonPropertyName("interactionId")] - public string? InteractionId { get; set; } + [JsonPropertyName("ruleIndex")] + public long? RuleIndex { get; set; } - /// Model identifier used for this turn, when known. + /// Human-readable name of the local policy rule that matched. + [JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)] + [JsonPropertyName("ruleName")] + public string? RuleName { get; set; } + + /// Validated capability scores used to select the route. + [JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)] + [JsonPropertyName("scores")] + public FusionScores? Scores { get; set; } + + /// Concrete model selected for the review or judge phase, when required. + [JsonPropertyName("secondaryModel")] + public string? SecondaryModel { get; set; } + + /// Synthetic HydraFusion model selected for the session. + [JsonPropertyName("syntheticModel")] + public required string SyntheticModel { get; set; } + + /// Identifier of the session turn associated with the route. + [JsonPropertyName("turnId")] + public required string TurnId { get; set; } +} + +/// Experimental durable aggregate outcome of a HydraFusion turn. +[Experimental(Diagnostics.Experimental)] +public sealed partial class SessionFusionCompletedData +{ + /// Total cached input tokens reported across all phases. + [JsonPropertyName("cachedTokens")] + public required long CachedTokens { get; set; } + + /// Total tokens written to prompt cache across all phases. + [JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)] + [JsonPropertyName("cacheWriteTokens")] + public long? CacheWriteTokens { get; set; } + + /// Idempotency identifier for the authoritative final commit. + [JsonPropertyName("commitId")] + public required string CommitId { get; set; } + + /// Reason the turn used a degraded route, when applicable. + [JsonPropertyName("degradedReason")] + public string? DegradedReason { get; set; } + + /// Total elapsed execution time for the HydraFusion turn in milliseconds. + [JsonPropertyName("durationMs")] + public required double DurationMs { get; set; } + + /// Concrete model that supplied the authoritative final content. + [JsonPropertyName("finalSourceModel")] + public string? FinalSourceModel { get; set; } + + /// Phase whose output supplied the authoritative final content. + [JsonPropertyName("finalSourcePhaseId")] + public string? FinalSourcePhaseId { get; set; } + + /// Concrete model recommended for eligible follow-up turns. + [JsonPropertyName("followUpModel")] + public required string FollowUpModel { get; set; } + + /// Stable identifier for the completed HydraFusion turn. + [JsonPropertyName("fusionId")] + public required string FusionId { get; set; } + + /// Total input tokens consumed across all phases. + [JsonPropertyName("inputTokens")] + public required long InputTokens { get; set; } + + /// Stable aggregate outcome of the HydraFusion turn. + [JsonPropertyName("outcome")] + public required string Outcome { get; set; } + + /// Total output tokens produced across all phases. + [JsonPropertyName("outputTokens")] + public required long OutputTokens { get; set; } + + /// HydraFusion orchestration pattern executed for the turn. + [JsonPropertyName("pattern")] + public required FusionPattern Pattern { get; set; } + + /// Number of concrete phases attempted by the turn. + [JsonPropertyName("phaseCount")] + public required long PhaseCount { get; set; } + + /// Total concrete model requests made across all phases. + [JsonPropertyName("requestCount")] + public required long RequestCount { get; set; } + + /// Synthetic HydraFusion model selected for the session. + [JsonPropertyName("syntheticModel")] + public required string SyntheticModel { get; set; } + + /// Total normalized AI-unit cost reported across all phases, in nano-AIU. + [JsonPropertyName("totalNanoAiu")] + public required double TotalNanoAiu { get; set; } + + /// Identifier of the session turn associated with the completion. + [JsonPropertyName("turnId")] + public required string TurnId { get; set; } +} + +/// 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. + [JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)] + [JsonPropertyName("agentMode")] + public UserMessageAgentMode? AgentMode { get; set; } + + /// Files, selections, or GitHub references attached to the message. + [JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)] + [JsonPropertyName("attachments")] + 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")] + public string? InteractionId { get; set; } + + /// 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. + [JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)] + [JsonPropertyName("isAutopilotContinuation")] + public bool? IsAutopilotContinuation { get; set; } + + /// 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. + [JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)] + [JsonPropertyName("nativeDocumentPathFallbackPaths")] + public string[]? NativeDocumentPathFallbackPaths { get; set; } + + /// Parent agent task ID for background telemetry correlated to this user turn. + [JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)] + [JsonPropertyName("parentAgentTaskId")] + public string? ParentAgentTaskId { get; set; } + + /// 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; } + + /// Normalized document MIME types that were sent natively instead of through tagged_files XML. + [JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)] + [JsonPropertyName("supportedNativeDocumentMimeTypes")] + public string[]? SupportedNativeDocumentMimeTypes { get; set; } + + /// Transformed version of the message sent to the model, with XML wrapping, timestamps, and other augmentations for prompt caching. + [JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)] + [JsonPropertyName("transformedContent")] + public string? TransformedContent { get; set; } + + /// The agent-loop turn ID that consumed this message; absent when no agent-loop turn consumed it. + [JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)] + [JsonPropertyName("turnId")] + public string? TurnId { get; set; } +} + +/// Empty payload; the event signals that the pending message queue has changed. +public sealed partial class PendingMessagesModifiedData +{ +} + +/// Turn initialization metadata including identifier and interaction tracking. +public sealed partial class AssistantTurnStartData +{ + /// CAPI interaction ID for correlating this turn with upstream telemetry. + [JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)] + [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; } @@ -2614,6 +3191,74 @@ public sealed partial class AssistantTurnRetryData public required string TurnId { get; set; } } +/// Metadata for work the user interrupted while the agent was running. +public sealed partial class AgentInterruptedData +{ + /// What the agent was doing when the user interrupted it. + [JsonPropertyName("activity")] + public required AgentInterruptedActivity Activity { get; set; } + + /// For an interrupted model call: the provider endpoint the request targeted. + [JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)] + [JsonPropertyName("apiEndpoint")] + public string? ApiEndpoint { get; set; } + + /// For an interrupted model call: whether the user interrupted before any token arrived or while the response was streaming. + [JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)] + [JsonPropertyName("cancelPhase")] + public AgentInterruptedCancelPhase? CancelPhase { get; set; } + + /// How long the interrupted work had been running, in milliseconds. + [JsonConverter(typeof(MillisecondsTimeSpanConverter))] + [JsonPropertyName("elapsedMs")] + public required TimeSpan Elapsed { get; set; } + + /// For an interrupted background-agent batch: how many background sub-agents the stop swept. Counts accepted cancellations, so an agent cancelled as a cascade of its interrupted parent is covered by that parent rather than counted again. + [JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)] + [JsonPropertyName("interruptedAgentCount")] + public long? InterruptedAgentCount { get; set; } + + /// For an interrupted model call: the model the request targeted. + [JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)] + [JsonPropertyName("model")] + public string? Model { get; set; } + + /// For a mid-stream interrupt: the observed time to first observable output, in milliseconds. Deliberately distinct from the `ttftMs` reported on a successful model call, which measures time to first stream event. + [JsonConverter(typeof(MillisecondsTimeSpanConverter))] + [JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)] + [JsonPropertyName("outputTtftMs")] + public TimeSpan? OutputTtft { get; set; } + + /// For an interrupted model call: the reasoning effort the request asked for. + [JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)] + [JsonPropertyName("reasoningEffort")] + public string? ReasoningEffort { get; set; } + + /// Subset of `toolNames` whose tool metadata marks the tool name as safe to record unhashed in telemetry. + [JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)] + [JsonPropertyName("safeToolNames")] + public string[]? SafeToolNames { get; set; } + + /// Tool call identifiers that were still running. + [JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)] + [JsonPropertyName("toolCallIds")] + public string[]? ToolCallIds { get; set; } + + /// Names of the tools that were still running. More than one when the model requested a parallel fan-out. + [JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)] + [JsonPropertyName("toolNames")] + public string[]? ToolNames { get; set; } + + /// For an interrupted model call: the transport the request used. + [JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)] + [JsonPropertyName("transport")] + public ModelCallFailureTransport? Transport { get; set; } + + /// Zero-based agentic-loop iteration the interrupt landed in. + [JsonPropertyName("turn")] + public required long Turn { get; set; } +} + /// Agent intent description for current activity or plan. public sealed partial class AssistantIntentData { @@ -2622,6 +3267,161 @@ public sealed partial class AssistantIntentData public required string Intent { get; set; } } +/// Experimental transient HydraFusion phase/model/role signal. +[Experimental(Diagnostics.Experimental)] +public sealed partial class AssistantFusionPhaseStartedData +{ + /// Conversation scope in which the phase executes. + [JsonPropertyName("conversationScope")] + public required FusionConversationScope ConversationScope { get; set; } + + /// Identifier of the HydraFusion turn containing the phase. + [JsonPropertyName("fusionId")] + public required string FusionId { get; set; } + + /// Concrete model executing the phase. + [JsonPropertyName("model")] + public required string Model { get; set; } + + /// HydraFusion orchestration pattern containing the phase. + [JsonPropertyName("pattern")] + public required FusionPattern Pattern { get; set; } + + /// Stable identifier for the concrete phase. + [JsonPropertyName("phaseId")] + public required string PhaseId { get; set; } + + /// Kind of phase being executed. + [JsonPropertyName("phaseKind")] + public required FusionPhaseKind PhaseKind { get; set; } + + /// Semantic role assigned to the phase. + [JsonPropertyName("role")] + public required string Role { get; set; } +} + +/// Experimental durable HydraFusion phase output and lossless replay checkpoint. +[Experimental(Diagnostics.Experimental)] +public sealed partial class AssistantFusionPhaseCompletedData +{ + /// Provider-normalized textual output produced by the phase. + [JsonPropertyName("content")] + public required string Content { get; set; } + + /// Conversation scope in which the phase executed. + [JsonPropertyName("conversationScope")] + public required FusionConversationScope ConversationScope { get; set; } + + /// Elapsed execution time for the phase in milliseconds. + [JsonPropertyName("durationMs")] + public required double DurationMs { get; set; } + + /// Identifier of the HydraFusion turn containing the phase. + [JsonPropertyName("fusionId")] + public required string FusionId { get; set; } + + /// Concrete model that executed the phase. + [JsonPropertyName("model")] + public required string Model { get; set; } + + /// Stable identifier for the completed phase. + [JsonPropertyName("phaseId")] + public required string PhaseId { get; set; } + + /// Kind of phase that completed. + [JsonPropertyName("phaseKind")] + public required FusionPhaseKind PhaseKind { get; set; } + + /// Exact provider-normalized message used to reconstruct canonical model history. + [JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)] + [JsonInclude] + [JsonPropertyName("projectionMessage")] + internal JsonElement? ProjectionMessage { get; set; } + + /// Projection action for the exact internal message. + [JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)] + [JsonInclude] + [JsonPropertyName("projectionMode")] + internal FusionProjectionMode? ProjectionMode { get; set; } + + /// Semantic role assigned to the completed phase. + [JsonPropertyName("role")] + public required string Role { get; set; } + + /// Terminal request held outside canonical state until selected by the final commit. + [JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)] + [JsonInclude] + [JsonPropertyName("stagedTerminal")] + internal FusionStagedTerminal? StagedTerminal { get; set; } + + /// Durable outcome status of the phase. + [JsonPropertyName("status")] + public required FusionPhaseStatus Status { get; set; } + + /// Aggregate concrete-model usage consumed by the phase. + [JsonPropertyName("usage")] + public required FusionPhaseUsage Usage { get; set; } + + /// Structured judge or critic verdict, when the phase produces one. + [JsonPropertyName("verdict")] + public string? Verdict { get; set; } +} + +/// Experimental durable typed HydraFusion phase failure and degradation transition. +[Experimental(Diagnostics.Experimental)] +public sealed partial class AssistantFusionPhaseFailedData +{ + /// Conversation scope in which the phase executed. + [JsonPropertyName("conversationScope")] + public required FusionConversationScope ConversationScope { get; set; } + + /// Identifier of the fallback phase used to continue the turn after degradation. + [JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)] + [JsonPropertyName("degradedToPhaseId")] + public string? DegradedToPhaseId { get; set; } + + /// Elapsed execution time before the phase failed, in milliseconds. + [JsonPropertyName("durationMs")] + public required double DurationMs { get; set; } + + /// Provider or execution error detail, when available. + [JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)] + [JsonPropertyName("errorMessage")] + public string? ErrorMessage { get; set; } + + /// Identifier of the HydraFusion turn containing the phase. + [JsonPropertyName("fusionId")] + public required string FusionId { get; set; } + + /// Concrete model that attempted the phase. + [JsonPropertyName("model")] + public required string Model { get; set; } + + /// Stable identifier for the failed phase. + [JsonPropertyName("phaseId")] + public required string PhaseId { get; set; } + + /// Kind of phase that failed. + [JsonPropertyName("phaseKind")] + public required FusionPhaseKind PhaseKind { get; set; } + + /// Stable machine-readable reason for the phase failure. + [JsonPropertyName("reason")] + public required string Reason { get; set; } + + /// Semantic role assigned to the failed phase. + [JsonPropertyName("role")] + public required string Role { get; set; } + + /// Durable outcome status of the phase. + [JsonPropertyName("status")] + public required FusionPhaseStatus Status { get; set; } + + /// Aggregate concrete-model usage consumed before the failure. + [JsonPropertyName("usage")] + public required FusionPhaseUsage Usage { 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 { @@ -2648,6 +3448,11 @@ public sealed partial class AssistantReasoningData /// Unique identifier for this reasoning block. [JsonPropertyName("reasoningId")] public required string ReasoningId { get; set; } + + /// Per-request treatment/eligibility signal returned by the Copilot API in the `X-GitHub-Copilot-Request-TE` response header for the associated model call; `false` when the header was absent or unparseable. + [JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)] + [JsonPropertyName("rte")] + public bool? Rte { get; set; } } /// Streaming reasoning delta for incremental extended thinking updates. @@ -2700,6 +3505,16 @@ public sealed partial class AssistantMessageData [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; } + + /// 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)] @@ -2720,6 +3535,12 @@ public sealed partial class AssistantMessageData [JsonPropertyName("encryptedContent")] public string? EncryptedContent { get; set; } + /// Experimental HydraFusion source attribution for this ordinary authoritative assistant message. + [Experimental(Diagnostics.Experimental)] + [JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)] + [JsonPropertyName("fusion")] + public FusionAttribution? Fusion { get; set; } + /// CAPI interaction ID for correlating this message with upstream telemetry. [JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)] [JsonPropertyName("interactionId")] @@ -2753,6 +3574,11 @@ public sealed partial class AssistantMessageData [JsonPropertyName("phase")] public string? Phase { get; set; } + /// Neutral provider-tagged reasoning content blocks preserved verbatim for round-tripping. `reasoningText` and `reasoningOpaque` are a lossy derived view of these blocks, retained for display. + [JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)] + [JsonPropertyName("reasoningBlocks")] + public AssistantMessageReasoningBlocks? ReasoningBlocks { get; set; } + /// Opaque/encrypted extended thinking data from Anthropic models. Session-bound and stripped on resume. [JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)] [JsonPropertyName("reasoningOpaque")] @@ -2773,6 +3599,11 @@ public sealed partial class AssistantMessageData [JsonPropertyName("requestId")] public string? RequestId { get; set; } + /// Per-request treatment/eligibility signal returned by the Copilot API in the `X-GitHub-Copilot-Request-TE` response header for the associated model call; `false` when the header was absent or unparseable. + [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")] @@ -2853,6 +3684,11 @@ public sealed partial class AssistantIdleData /// LLM API call usage metrics including tokens, costs, quotas, and billing information. public sealed partial class AssistantUsageData { + /// Number of accepted speculative prediction tokens. + [JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)] + [JsonPropertyName("acceptedPredictionTokens")] + public long? AcceptedPredictionTokens { get; set; } + /// Completion ID from the model provider (e.g., chatcmpl-abc123). [JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)] [JsonPropertyName("apiCallId")] @@ -2863,6 +3699,18 @@ 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; } + + /// Whether the provider reported prompt-cache usage details for this call. + [JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)] + [JsonInclude] + [JsonPropertyName("cacheDetailsReported")] + internal bool? CacheDetailsReported { 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")] @@ -2873,6 +3721,12 @@ public sealed partial class AssistantUsageData [JsonPropertyName("cacheReadTokens")] public long? CacheReadTokens { get; set; } + /// Effective prompt-cache lifetime in seconds for this call. + [JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)] + [JsonInclude] + [JsonPropertyName("cacheTtlSeconds")] + internal long? CacheTtlSeconds { get; set; } + /// Number of tokens written to prompt cache. [JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)] [JsonPropertyName("cacheWriteTokens")] @@ -2905,31 +3759,80 @@ public sealed partial class AssistantUsageData [JsonPropertyName("finishReason")] public string? FinishReason { get; set; } - /// What initiated this API call (e.g., "sub-agent", "mcp-sampling"); absent for user-initiated calls. + /// How the prompt-cache frontier was determined for this call. [JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)] - [JsonPropertyName("initiator")] - public string? Initiator { get; set; } + [JsonInclude] + [JsonPropertyName("frontierSource")] + internal string? FrontierSource { get; set; } + + /// Experimental HydraFusion attribution for this concrete model call's usage. + [Experimental(Diagnostics.Experimental)] + [JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)] + [JsonPropertyName("fusion")] + public FusionAttribution? Fusion { 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; } /// Number of input tokens consumed. [JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)] [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)] [JsonPropertyName("interTokenLatencyMs")] public TimeSpan? InterTokenLatency { get; set; } + /// Whether Auto mode was selected for this model call. + [JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)] + [JsonPropertyName("isAuto")] + public bool? IsAuto { get; set; } + + /// Whether this model call used a bring-your-own-key provider. + [JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)] + [JsonPropertyName("isByok")] + public bool? IsByok { get; set; } + + /// Requested maximum output tokens used for this model call. + [JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)] + [JsonPropertyName("maxOutputTokens")] + public long? MaxOutputTokens { get; set; } + + /// Effective maximum prompt-token limit used for this model call. + [JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)] + [JsonPropertyName("maxPromptTokens")] + public long? MaxPromptTokens { get; set; } + /// Model identifier used for this API call. [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")] public long? OutputTokens { get; set; } + /// Time to first observable model output in milliseconds. Includes text, reasoning, and tool-call output; only available for streaming requests that produce observable output. + [JsonConverter(typeof(MillisecondsTimeSpanConverter))] + [JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)] + [JsonPropertyName("outputTtftMs")] + public TimeSpan? OutputTtft { get; set; } + /// Parent tool call ID when this usage originates from a sub-agent. [EditorBrowsable(EditorBrowsableState.Never)] #if NET5_0_OR_GREATER @@ -2955,11 +3858,26 @@ public sealed partial class AssistantUsageData [JsonPropertyName("reasoningEffort")] public string? ReasoningEffort { get; set; } + /// Reasoning summary mode used for this model call, if applicable. + [JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)] + [JsonPropertyName("reasoningSummary")] + public ReasoningSummary? ReasoningSummary { get; set; } + /// Number of output tokens used for reasoning (e.g., chain-of-thought). [JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)] [JsonPropertyName("reasoningTokens")] public long? ReasoningTokens { get; set; } + /// Number of rejected speculative prediction tokens. + [JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)] + [JsonPropertyName("rejectedPredictionTokens")] + public long? RejectedPredictionTokens { get; set; } + + /// Per-request treatment/eligibility signal returned by the Copilot API in the `X-GitHub-Copilot-Request-TE` response header for the associated model call; `false` when the header was absent or unparseable. + [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")] @@ -2970,6 +3888,153 @@ 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; } + + /// Transport used for this model call (http or websocket). + [JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)] + [JsonPropertyName("transport")] + public AssistantUsageTransport? Transport { get; set; } +} + +/// A detected loss of a previously cached prompt prefix. +public sealed partial class PromptCacheBreakData +{ + /// Request state whose cached prefix fell short. + [JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)] + [JsonInclude] + [JsonPropertyName("afterRequest")] + internal JsonElement? AfterRequest { get; set; } + + /// Name of the sub-agent whose conversation broke, stamped by the parent bridge. + [JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)] + [JsonInclude] + [JsonPropertyName("agentName")] + internal string? AgentName { get; set; } + + /// Request state that established the prior cache frontier. + [JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)] + [JsonInclude] + [JsonPropertyName("beforeRequest")] + internal JsonElement? BeforeRequest { get; set; } + + /// Names of the cache-configuration fields that changed. + [JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)] + [JsonInclude] + [JsonPropertyName("cacheConfigChangedFields")] + internal string[]? CacheConfigChangedFields { get; set; } + + /// All reasons that contributed to the cache break, ordered by precedence. + [JsonPropertyName("contributingReasons")] + public required string[] ContributingReasons { get; set; } + + /// Prior cached prompt frontier in tokens. + [JsonPropertyName("frontierTokens")] + public required long FrontierTokens { get; set; } + + /// Model that held the prior cache frontier, when the call changed models. + [JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)] + [JsonInclude] + [JsonPropertyName("modelFrom")] + internal string? ModelFrom { get; set; } + + /// Model this call targeted, when the call changed models. + [JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)] + [JsonInclude] + [JsonPropertyName("modelTo")] + internal string? ModelTo { get; set; } + + /// The highest-precedence reason for the cache break. + [JsonPropertyName("primaryReason")] + public required string PrimaryReason { get; set; } + + /// Fraction of the prior cache frontier that survived. + [JsonPropertyName("retentionRatio")] + public required double RetentionRatio { get; set; } + + /// Index of the first conversation message whose content changed. + [JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)] + [JsonInclude] + [JsonPropertyName("rewriteMessageIndex")] + internal long? RewriteMessageIndex { get; set; } + + /// Shape of the history rewrite, for example whether the history grew or shrank. + [JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)] + [JsonInclude] + [JsonPropertyName("rewriteShape")] + internal string? RewriteShape { get; set; } + + /// Subsystems that announced a history rewrite before this call, for example compaction or truncation. + [JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)] + [JsonInclude] + [JsonPropertyName("rewriteSource")] + internal string[]? RewriteSource { get; set; } + + /// Cached prefix tokens lost since the prior call. + [JsonPropertyName("shortfallTokens")] + public required long ShortfallTokens { get; set; } + + /// Number of cached prefix tokens that survived. + [JsonPropertyName("survivedTokens")] + public required long SurvivedTokens { get; set; } + + /// Names of the system-prompt segments whose content changed. + [JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)] + [JsonInclude] + [JsonPropertyName("systemSegmentsChanged")] + internal string[]? SystemSegmentsChanged { get; set; } + + /// Telemetry-safe names of tools added since the prior call. + [JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)] + [JsonInclude] + [JsonPropertyName("toolsAdded")] + internal string[]? ToolsAdded { get; set; } + + /// Raw names of tools added since the prior call, restricted because a tool name can be user-authored. + [JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)] + [JsonInclude] + [JsonPropertyName("toolsAddedRaw")] + internal string[]? ToolsAddedRaw { get; set; } + + /// Telemetry-safe names of tools whose definition changed since the prior call. + [JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)] + [JsonInclude] + [JsonPropertyName("toolsRedefined")] + internal string[]? ToolsRedefined { get; set; } + + /// Raw names of tools redefined since the prior call, restricted because a tool name can be user-authored. + [JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)] + [JsonInclude] + [JsonPropertyName("toolsRedefinedRaw")] + internal string[]? ToolsRedefinedRaw { get; set; } + + /// Telemetry-safe names of tools removed since the prior call. + [JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)] + [JsonInclude] + [JsonPropertyName("toolsRemoved")] + internal string[]? ToolsRemoved { get; set; } + + /// Raw names of tools removed since the prior call, restricted because a tool name can be user-authored. + [JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)] + [JsonInclude] + [JsonPropertyName("toolsRemovedRaw")] + internal string[]? ToolsRemovedRaw { get; set; } + + /// Whether the tool list kept its members but changed their order. + [JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)] + [JsonInclude] + [JsonPropertyName("toolsReordered")] + internal bool? ToolsReordered { get; set; } } /// Failed LLM API call metadata for telemetry. @@ -3016,11 +4081,22 @@ public sealed partial class ModelCallFailureData [JsonPropertyName("failureKind")] public ModelCallFailureKind? FailureKind { get; set; } + /// Experimental HydraFusion attribution for this failed concrete model call. + [Experimental(Diagnostics.Experimental)] + [JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)] + [JsonPropertyName("fusion")] + public FusionAttribution? Fusion { 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; } + /// Authoritative interaction classification for the failed call, matching `assistant.usage.interactionType` (for example `conversation-agent`, `conversation-subagent`, or `conversation-sampling`). Absent when the producer cannot classify the interaction. + [JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)] + [JsonPropertyName("interactionType")] + public string? InteractionType { get; set; } + /// Whether the session selected Auto mode for the failed call. [JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)] [JsonPropertyName("isAuto")] @@ -3067,6 +4143,11 @@ public sealed partial class ModelCallFailureData [JsonPropertyName("requestFingerprint")] public ModelCallFailureRequestFingerprint? RequestFingerprint { get; set; } + /// Per-request treatment/eligibility signal returned by the Copilot API in the `X-GitHub-Copilot-Request-TE` response header for the associated model call; `false` when the header was absent or unparseable. + [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")] @@ -3087,14 +4168,57 @@ public sealed partial class ModelCallFailureData public ModelCallFailureTransport? Transport { get; set; } } +/// Final lifecycle outcome for one logical model dispatch. A logical dispatch may include internal reconnect or fallback work, so event count is not provider HTTP-request count. +public sealed partial class ModelCallFinishedData +{ + /// Whether an accepted successful response requested the exact name and command semantics of a built-in file edit tool, including an external tool explicitly replacing that built-in name. Absent when the logical dispatch did not produce an accepted response. + [JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)] + [JsonPropertyName("containsBuiltInFileEditRequest")] + public bool? ContainsBuiltInFileEditRequest { get; set; } + + /// Monotonic elapsed time spent in the logical model dispatch, including any internal transport reconnect or fallback and excluding orchestrator retry backoff, tool execution, confirmations, and post-response processing. + [JsonConverter(typeof(MillisecondsTimeSpanConverter))] + [JsonPropertyName("dispatchDurationMs")] + public required TimeSpan DispatchDuration { get; set; } + + /// Version of the built-in file-edit semantic classifier used for this event. + [JsonPropertyName("editClassifierVersion")] + public required long EditClassifierVersion { get; set; } + + /// Identifier of the user interaction that owns the model dispatch, matching assistant.turn_start.interactionId when available. + [JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)] + [JsonPropertyName("interactionId")] + public string? InteractionId { get; set; } + + /// Final outcome after post-response acceptance processing. + [JsonPropertyName("outcome")] + public required ModelCallFinishedOutcome Outcome { get; set; } + + /// Agent-loop iteration within the interaction that initiated the model dispatch. + [JsonPropertyName("turnId")] + public required string TurnId { get; set; } +} + /// Model API dispatch metadata for internal telemetry. public sealed partial class ModelCallStartData { + /// Experimental HydraFusion attribution for this concrete model call. + [Experimental(Diagnostics.Experimental)] + [JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)] + [JsonPropertyName("fusion")] + public FusionAttribution? Fusion { get; set; } + /// 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; } @@ -3138,6 +4262,12 @@ public sealed partial class ToolExecutionStartData [JsonPropertyName("displayVerbatim")] public bool? DisplayVerbatim { get; set; } + /// Experimental HydraFusion attribution for this tool execution. + [Experimental(Diagnostics.Experimental)] + [JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)] + [JsonPropertyName("fusion")] + public FusionAttribution? Fusion { get; set; } + /// Name of the MCP server hosting this tool, when the tool is an MCP tool. [JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)] [JsonPropertyName("mcpServerName")] @@ -3162,6 +4292,11 @@ public sealed partial class ToolExecutionStartData [JsonPropertyName("parentToolCallId")] public string? ParentToolCallId { get; set; } + /// Per-request treatment/eligibility signal returned by the Copilot API in the `X-GitHub-Copilot-Request-TE` response header for the associated model call; `false` when the header was absent or unparseable. + [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")] @@ -3218,6 +4353,12 @@ public sealed partial class ToolExecutionCompleteData [JsonPropertyName("error")] public ToolExecutionCompleteError? Error { get; set; } + /// Experimental HydraFusion attribution for this tool completion. + [Experimental(Diagnostics.Experimental)] + [JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)] + [JsonPropertyName("fusion")] + public FusionAttribution? Fusion { get; set; } + /// CAPI interaction ID for correlating this tool execution with upstream telemetry. [JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)] [JsonPropertyName("interactionId")] @@ -3253,6 +4394,11 @@ public sealed partial class ToolExecutionCompleteData [JsonPropertyName("result")] public ToolExecutionCompleteResult? Result { get; set; } + /// Per-request treatment/eligibility signal returned by the Copilot API in the `X-GitHub-Copilot-Request-TE` response header for the associated model call; `false` when the header was absent or unparseable. + [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")] @@ -3345,6 +4491,9 @@ public sealed partial class SkillInvokedData public SkillInvokedTrigger? Trigger { get; set; } } +/// Payload of `sandbox.decision`, a bounded governance record of what the process sandbox was configured to do and whether it took effect. Discriminated by `kind`. +public sealed partial class SandboxDecisionData { } + /// Sub-agent startup details including parent tool call and agent information. public sealed partial class SubagentStartedData { @@ -3360,16 +4509,63 @@ public sealed partial class SubagentStartedData [JsonPropertyName("agentName")] public required string AgentName { get; set; } + /// Type of the sub-agent selected at spawn time. + [JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)] + [JsonPropertyName("agentType")] + public string? AgentType { get; set; } + + /// Whether the sub-agent runs synchronously or in the background. + [JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)] + [JsonPropertyName("executionMode")] + public string? ExecutionMode { get; set; } + + /// Root id of the factory run that spawned this sub-agent, when it was spawned by one. + [JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)] + [JsonPropertyName("factoryRunId")] + public string? FactoryRunId { get; set; } + /// Model the sub-agent will run with, when known at start. [JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)] [JsonPropertyName("model")] public string? Model { get; set; } + /// Task-registry ID of the spawning sub-agent. Absent when the root session spawned this child. + [JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)] + [JsonPropertyName("parentId")] + public string? ParentId { get; set; } + + /// Whether this sub-agent can be resumed. Currently always false. + [JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)] + [JsonPropertyName("resumable")] + public bool? Resumable { get; set; } + /// Tool call ID of the parent tool invocation that spawned this sub-agent. [JsonPropertyName("toolCallId")] public required string ToolCallId { get; set; } } +/// Resolved runtime configuration for a configured sub-agent. +public sealed partial class SubagentConfiguredData +{ + /// Resolved context tier, when configured for the model. + [JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)] + [JsonPropertyName("contextTier")] + public string? ContextTier { get; set; } + + /// Resolved model the sub-agent will run with. + [JsonPropertyName("model")] + public required string Model { get; set; } + + /// Whether the sub-agent accepts follow-up turns. + [JsonPropertyName("multiTurn")] + public required bool MultiTurn { get; set; } + + /// Resolved reasoning effort, when configured for the model. + [JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)] + [JsonPropertyName("reasoningEffort")] + public string? ReasoningEffort { get; set; } +} + /// Sub-agent completion details for successful execution. public sealed partial class SubagentCompletedData { @@ -3381,12 +4577,42 @@ 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; } + + /// Whether the first model actually dispatched matched the user's configured preference. + [JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)] + [JsonPropertyName("configuredModelMatchesActual")] + public bool? ConfiguredModelMatchesActual { get; set; } + + /// Concrete model the user configured for this sub-agent via `/subagents`, when present. + [JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)] + [JsonPropertyName("configuredModelPreference")] + public string? ConfiguredModelPreference { get; set; } + /// Wall-clock duration of the sub-agent execution in milliseconds. [JsonConverter(typeof(MillisecondsTimeSpanConverter))] [JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)] [JsonPropertyName("durationMs")] public TimeSpan? Duration { get; set; } + /// Whether the explicit task-call model matched the user's configured preference. + [JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)] + [JsonPropertyName("explicitModelMatchesPreference")] + public bool? ExplicitModelMatchesPreference { get; set; } + + /// Explicit model supplied by the parent agent on the task call, when present. + [JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)] + [JsonPropertyName("explicitModelOverride")] + public string? ExplicitModelOverride { get; set; } + + /// First model for which the sub-agent started an inference request, when one was dispatched. + [JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)] + [JsonPropertyName("firstDispatchedModel")] + public string? FirstDispatchedModel { get; set; } + /// Model used by the sub-agent. [JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)] [JsonPropertyName("model")] @@ -3418,6 +4644,16 @@ public sealed partial class SubagentFailedData [JsonPropertyName("agentName")] public required string AgentName { get; set; } + /// Whether the first model actually dispatched matched the user's configured preference. + [JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)] + [JsonPropertyName("configuredModelMatchesActual")] + public bool? ConfiguredModelMatchesActual { get; set; } + + /// Concrete model the user configured for this sub-agent via `/subagents`, when present. + [JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)] + [JsonPropertyName("configuredModelPreference")] + public string? ConfiguredModelPreference { get; set; } + /// Wall-clock duration of the sub-agent execution in milliseconds. [JsonConverter(typeof(MillisecondsTimeSpanConverter))] [JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)] @@ -3428,6 +4664,21 @@ public sealed partial class SubagentFailedData [JsonPropertyName("error")] public required string Error { get; set; } + /// Whether the explicit task-call model matched the user's configured preference. + [JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)] + [JsonPropertyName("explicitModelMatchesPreference")] + public bool? ExplicitModelMatchesPreference { get; set; } + + /// Explicit model supplied by the parent agent on the task call, when present. + [JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)] + [JsonPropertyName("explicitModelOverride")] + public string? ExplicitModelOverride { get; set; } + + /// First model for which the sub-agent started an inference request, when one was dispatched. + [JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)] + [JsonPropertyName("firstDispatchedModel")] + public string? FirstDispatchedModel { get; set; } + /// Model selected for the sub-agent, when known. [JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)] [JsonPropertyName("model")] @@ -3484,6 +4735,11 @@ public sealed partial class HookStartData [JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)] [JsonPropertyName("input")] public JsonElement? Input { get; set; } + + /// Tool call ID of the parent tool invocation when this event originates from a sub-agent. + [JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)] + [JsonPropertyName("parentToolCallId")] + public string? ParentToolCallId { get; set; } } /// Hook invocation completion details including output, success status, and error information. @@ -3507,6 +4763,11 @@ public sealed partial class HookEndData [JsonPropertyName("output")] public JsonElement? Output { get; set; } + /// Tool call ID of the parent tool invocation when this event originates from a sub-agent. + [JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)] + [JsonPropertyName("parentToolCallId")] + public string? ParentToolCallId { get; set; } + /// Whether the hook completed successfully. [JsonPropertyName("success")] public required bool Success { get; set; } @@ -3567,6 +4828,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")] @@ -3614,6 +4880,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. @@ -3871,6 +5142,34 @@ public sealed partial class SessionCustomNotificationData public long? Version { get; set; } } +/// Ordered output and terminal state for a transient query that does not modify conversation history. +[Experimental(Diagnostics.Experimental)] +public sealed partial class UiEphemeralQueryData +{ + /// Full response text, present for the `completed` phase. + [JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)] + [JsonPropertyName("answer")] + public string? Answer { get; set; } + + /// Ordered text delta, present for the `chunk` phase. + [JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)] + [JsonPropertyName("chunk")] + public string? Chunk { get; set; } + + /// Model or transport failure message, present for the `failed` phase. + [JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)] + [JsonPropertyName("error")] + public string? Error { get; set; } + + /// Current query lifecycle phase. + [JsonPropertyName("phase")] + public required UIEphemeralQueryPhase Phase { get; set; } + + /// Runtime-minted query identifier. + [JsonPropertyName("requestId")] + public required string RequestId { get; set; } +} + /// External tool invocation request for client-side tool execution. public sealed partial class ExternalToolRequestedData { @@ -3879,6 +5178,11 @@ public sealed partial class ExternalToolRequestedData [JsonPropertyName("arguments")] public JsonElement? Arguments { get; set; } + /// Stable provider identity captured with an extension-owned tool definition; hosts use it to route the request to the same provider that was offered to the model. + [JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)] + [JsonPropertyName("providerId")] + public string? ProviderId { get; set; } + /// Unique identifier for this request; used to respond via session.respondToExternalTool(). [JsonPropertyName("requestId")] public required string RequestId { get; set; } @@ -4021,6 +5325,11 @@ public sealed partial class SessionLimitsExhaustedCompletedData [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")] @@ -4035,11 +5344,36 @@ public sealed partial class SessionAutoModeResolvedData [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")] @@ -4049,9 +5383,24 @@ public sealed partial class SessionAutoModeResolvedData [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 where they came from, so SDK clients can show users what is enterprise-managed and by which authority. 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; for a session-independent pull, use the SDK `getManagedSettings()` API, which returns the identical payload. Managed settings have a single authoritative source, so the highest-authority present layer (server > device) wins wholesale; `bypassPermissionsDisabled` is deny-wins across layers. Marked experimental while the managed-settings surface stabilizes. +/// 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 { @@ -4059,7 +5408,12 @@ public sealed partial class SessionManagedSettingsResolvedData [JsonPropertyName("bypassPermissionsDisabled")] public required bool BypassPermissionsDisabled { get; set; } - /// Whether the device (MDM/plist/registry/file) managed-settings layer was present. + /// 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; } @@ -4071,6 +5425,16 @@ public sealed partial class SessionManagedSettingsResolvedData [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 effective sandbox policy forces the sandbox on *only* because managed policy could not be determined, rather than because the policy requires it. Lets clients tell a user whose `--no-sandbox` was overridden that the sandbox stayed on as a fail-closed fallback, instead of attributing it to an administrator who set no such policy. + [JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)] + [JsonPropertyName("sandboxEnabledByUndeterminedPolicy")] + public bool? SandboxEnabledByUndeterminedPolicy { get; set; } + /// Whether the server (account/org) managed-settings layer was present. [JsonPropertyName("serverManaged")] public required bool ServerManaged { get; set; } @@ -4080,7 +5444,7 @@ public sealed partial class SessionManagedSettingsResolvedData [JsonPropertyName("settings")] public JsonElement? Settings { get; set; } - /// Which channel supplied the effective managed settings (the winning layer), or `none` when no policy is in force. + /// 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; } } @@ -4135,6 +5499,11 @@ public sealed partial class ExitPlanModeRequestedData [JsonPropertyName("actions")] public required ExitPlanModeAction[] Actions { get; set; } + /// Model the session had selected when the plan was authored, when one is known. + [JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)] + [JsonPropertyName("model")] + public string? Model { get; set; } + /// Full content of the plan file. [JsonPropertyName("planContent")] public required string PlanContent { get; set; } @@ -4193,6 +5562,66 @@ public sealed partial class SessionBackgroundTasksChangedData { } +/// 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; } + + /// Factory run identifier. + [JsonPropertyName("runId")] + public required string RunId { get; set; } +} + +/// Ephemeral signal that a factory run attempt began executing. +[Experimental(Diagnostics.Experimental)] +public sealed partial class FactoryRunStartedData +{ + /// Attempt number this start committed; a resumed run increments it. + [JsonPropertyName("attempt")] + public required long Attempt { get; set; } + + /// Name of the factory this run executes. Low cardinality by construction. + [JsonPropertyName("factoryName")] + public required string FactoryName { get; set; } + + /// Identifier of the factory run that started. + [JsonPropertyName("runId")] + public required string RunId { get; set; } +} + +/// Ephemeral signal that a factory run reached a terminal status. +[Experimental(Diagnostics.Experimental)] +public sealed partial class FactoryRunSettledData +{ + /// AI credits this run consumed, in nano-AIU. + [JsonPropertyName("consumedNanoAiu")] + public required long ConsumedNanoAiu { get; set; } + + /// Subagents this run consumed against its limits. + [JsonPropertyName("consumedSubagents")] + public required long ConsumedSubagents { get; set; } + + /// Active milliseconds accumulated across every attempt of this run. + [JsonPropertyName("elapsedMs")] + public required long ElapsedMs { get; set; } + + /// Typed failure class recorded on the run, when it failed with one (e.g. `factory_limit_reached`). + [JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)] + [JsonPropertyName("failureType")] + public string? FailureType { get; set; } + + /// Identifier of the factory run that settled. + [JsonPropertyName("runId")] + public required string RunId { get; set; } + + /// Terminal status the run committed. + [JsonPropertyName("status")] + public required FactoryRunSettledStatus Status { get; set; } +} + /// Payload of `session.skills_loaded` listing resolved skill metadata. public sealed partial class SessionSkillsLoadedData { @@ -4237,7 +5666,7 @@ 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; } } @@ -4497,6 +5926,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")] @@ -4536,23 +5970,6 @@ public sealed partial class HandoffRepository public required string Owner { get; set; } } -/// Aggregate code change metrics for the session. -/// Nested data type for ShutdownCodeChanges. -public sealed partial class ShutdownCodeChanges -{ - /// List of file paths that were modified during the session. - [JsonPropertyName("filesModified")] - public required string[] FilesModified { get; set; } - - /// Total number of lines added during the session. - [JsonPropertyName("linesAdded")] - public required long LinesAdded { get; set; } - - /// Total number of lines removed during the session. - [JsonPropertyName("linesRemoved")] - public required long LinesRemoved { get; set; } -} - /// Request count and cost metrics. /// Nested data type for ShutdownModelMetricRequests. public sealed partial class ShutdownModelMetricRequests @@ -4629,6 +6046,51 @@ public sealed partial class ShutdownModelMetric public required ShutdownModelMetricUsage Usage { get; set; } } +/// Usage attributed to one agent instance at session shutdown. +/// Nested data type for ShutdownAgentMetric. +public sealed partial class ShutdownAgentMetric +{ + /// Human-readable label for this subagent invocation, copied from the originating `subagent.started` event. For task-tool subagents this is the invocation's task description rather than the agent's configured display name, so group by `agentName` for stable per-agent labels. + [JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)] + [JsonPropertyName("agentDisplayName")] + public string? AgentDisplayName { get; set; } + + /// Configured agent name, when this is a subagent. + [JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)] + [JsonPropertyName("agentName")] + public string? AgentName { get; set; } + + /// Per-model usage for this agent, keyed by model identifier. + [JsonPropertyName("modelMetrics")] + public required IDictionary ModelMetrics { get; set; } + + /// Time spent in model API calls by this agent, in milliseconds. + [JsonConverter(typeof(MillisecondsTimeSpanConverter))] + [JsonPropertyName("totalApiDurationMs")] + public required TimeSpan TotalApiDuration { get; set; } + + /// Accumulated nano-AI units cost for this agent. + [JsonPropertyName("totalNanoAiu")] + public required double TotalNanoAiu { get; set; } +} + +/// Aggregate code change metrics for the session. +/// Nested data type for ShutdownCodeChanges. +public sealed partial class ShutdownCodeChanges +{ + /// List of file paths that were modified during the session. + [JsonPropertyName("filesModified")] + public required string[] FilesModified { get; set; } + + /// Total number of lines added during the session. + [JsonPropertyName("linesAdded")] + public required long LinesAdded { get; set; } + + /// Total number of lines removed during the session. + [JsonPropertyName("linesRemoved")] + public required long LinesRemoved { get; set; } +} + /// A session-wide shutdown token-type entry storing the accumulated token count. /// Nested data type for ShutdownTokenDetail. public sealed partial class ShutdownTokenDetail @@ -4734,6 +6196,42 @@ public sealed partial class CompactionCompleteCompactionTokensUsed public long? OutputTokens { get; set; } } +/// Durable server recommendation for subsequent HydraFusion turns. +/// Nested data type for FusionFollowUpRecommendation. +[Experimental(Diagnostics.Experimental)] +public sealed partial class FusionFollowUpRecommendation +{ + /// Recommended routing action for the next compaction turn. + [JsonPropertyName("compactionTurn")] + public required FusionFollowUpAction CompactionTurn { get; set; } + + /// Recommended routing action for the next user-message turn. + [JsonPropertyName("userTurn")] + public required FusionFollowUpAction UserTurn { get; set; } +} + +/// Validated HydraFusion routing capability scores. +/// Nested data type for FusionScores. +[Experimental(Diagnostics.Experimental)] +public sealed partial class FusionScores +{ + /// Code-generation capability score returned by the authenticated router. + [JsonPropertyName("codeGen")] + public required double CodeGen { get; set; } + + /// Debugging capability score returned by the authenticated router. + [JsonPropertyName("debugging")] + public required double Debugging { get; set; } + + /// Reasoning capability score returned by the authenticated router. + [JsonPropertyName("reasoning")] + public required double Reasoning { get; set; } + + /// Tool-use capability score returned by the authenticated router. + [JsonPropertyName("toolUse")] + public required double ToolUse { get; set; } +} + /// Optional line range to scope the attachment to a specific section of the file. /// Nested data type for AttachmentFileLineRange. public sealed partial class AttachmentFileLineRange @@ -5284,6 +6782,63 @@ public partial class Attachment } +/// Internal durable terminal request staged by a HydraFusion phase until an idempotent final commit selects it. +/// Nested data type for FusionStagedTerminal. +[Experimental(Diagnostics.Experimental)] +internal sealed partial class FusionStagedTerminal +{ + /// Gets or sets the arguments value. + [JsonPropertyName("arguments")] + public required string Arguments { get; set; } + + /// Gets or sets the assistantMessage value. + [JsonPropertyName("assistantMessage")] + public required JsonElement AssistantMessage { get; set; } + + /// Gets or sets the phaseId value. + [JsonPropertyName("phaseId")] + public required string PhaseId { get; set; } + + /// Gets or sets the toolCallId value. + [JsonPropertyName("toolCallId")] + public required string ToolCallId { get; set; } + + /// Gets or sets the toolName value. + [JsonPropertyName("toolName")] + public required string ToolName { get; set; } +} + +/// Aggregate concrete-model usage for one HydraFusion phase. +/// Nested data type for FusionPhaseUsage. +[Experimental(Diagnostics.Experimental)] +public sealed partial class FusionPhaseUsage +{ + /// Total cached input tokens reported for the phase. + [JsonPropertyName("cachedTokens")] + public required long CachedTokens { get; set; } + + /// Total tokens written to prompt cache during the phase. + [JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)] + [JsonPropertyName("cacheWriteTokens")] + public long? CacheWriteTokens { get; set; } + + /// Total input tokens consumed by the phase. + [JsonPropertyName("inputTokens")] + public required long InputTokens { get; set; } + + /// Total output tokens produced by the phase. + [JsonPropertyName("outputTokens")] + public required long OutputTokens { get; set; } + + /// Number of concrete model requests made by the phase. + [JsonPropertyName("requestCount")] + public required long RequestCount { get; set; } + + /// Total normalized AI-unit cost reported for the phase, in nano-AIU. + [JsonPropertyName("totalNanoAiu")] + public required double TotalNanoAiu { get; set; } +} + /// A source that backs one or more cited spans in the assistant's response. /// Nested data type for CitationSource. [Experimental(Diagnostics.Experimental)] @@ -5441,31 +6996,103 @@ public sealed partial class Citations public required CitationSpan[] Spans { get; set; } } +/// Experimental attribution linking an ordinary event to the HydraFusion turn, phase, and concrete source that produced it. +/// Nested data type for FusionAttribution. +[Experimental(Diagnostics.Experimental)] +public sealed partial class FusionAttribution +{ + /// Idempotency identifier for the authoritative commit, when the event belongs to the selected output. + [JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)] + [JsonPropertyName("commitId")] + public string? CommitId { get; set; } + + /// Conversation scope in which the concrete phase executed. + [JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)] + [JsonPropertyName("conversationScope")] + public string? ConversationScope { get; set; } + + /// Stable identifier for the HydraFusion turn that produced the event. + [JsonPropertyName("fusionId")] + public required string FusionId { get; set; } + + /// HydraFusion orchestration pattern selected for the turn. + [JsonPropertyName("pattern")] + public required string Pattern { get; set; } + + /// Identifier of the concrete phase that produced the event. + [JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)] + [JsonPropertyName("phaseId")] + public string? PhaseId { get; set; } + + /// Kind of concrete phase that produced the event. + [JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)] + [JsonPropertyName("phaseKind")] + public string? PhaseKind { get; set; } + + /// HydraFusion routing policy used for the turn. + [JsonPropertyName("policy")] + public required string Policy { get; set; } + + /// Semantic role assigned to the concrete phase. + [JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)] + [JsonPropertyName("role")] + public string? Role { get; set; } + + /// Concrete model that produced the attributed event. + [JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)] + [JsonPropertyName("sourceModel")] + public string? SourceModel { get; set; } + + /// Phase whose output supplied the authoritative content, when different from the executing phase. + [JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)] + [JsonPropertyName("sourcePhaseId")] + public string? SourcePhaseId { get; set; } + + /// Synthetic HydraFusion model selected for the session. + [JsonPropertyName("syntheticModel")] + public required string SyntheticModel { get; set; } +} + +/// Neutral provider-tagged reasoning content blocks preserved verbatim for round-tripping. +/// Nested data type for AssistantMessageReasoningBlocks. +[Experimental(Diagnostics.Experimental)] +public sealed partial class AssistantMessageReasoningBlocks +{ + /// Provider-native reasoning content blocks (e.g. Anthropic `thinking` / `redacted_thinking`) preserved verbatim, in order. A single response can carry several, each signed over the content preceding it, so dropping or reordering any of them invalidates the rest. + [JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)] + [JsonPropertyName("blocks")] + public JsonElement[]? Blocks { get; set; } + + /// Model provider that produced these reasoning blocks. + [JsonPropertyName("provider")] + public required string Provider { 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. + /// Advisor model identifier associated with the server-tool payload. [JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)] [JsonPropertyName("advisorModel")] public string? AdvisorModel { get; set; } - /// Gets or sets the functionCallNamespaces value. + /// Provider function-call namespaces keyed by function-call identifier. [JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)] [JsonPropertyName("functionCallNamespaces")] public IDictionary? FunctionCallNamespaces { get; set; } - /// Gets or sets the items value. + /// Provider-native server-tool call and output items preserved verbatim for replay. [JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)] [JsonPropertyName("items")] public JsonElement[]? Items { get; set; } - /// Gets or sets the provider value. + /// Model provider that produced this server-tool payload. [JsonPropertyName("provider")] public required string Provider { get; set; } - /// Gets or sets the rawContentBlocks value. + /// Raw provider content blocks retained for verbatim round-tripping. [JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)] [JsonPropertyName("rawContentBlocks")] public JsonElement[]? RawContentBlocks { get; set; } @@ -5652,6 +7279,12 @@ public sealed partial class ModelCallFailureRequestFingerprint /// 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; } @@ -5998,6 +7631,11 @@ public sealed partial class ToolExecutionCompleteContentShellExit : ToolExecutio [JsonPropertyName("exitCode")] public required long ExitCode { get; set; } + /// Path reported in the shell session's filesystem namespace when shell output exceeded the configured large-output threshold. + [JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)] + [JsonPropertyName("outputFilePath")] + public string? OutputFilePath { 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")] @@ -6267,22 +7905,22 @@ public partial class ToolExecutionCompleteContent /// Nested data type for ToolExecutionCompleteUIResourceMetaUICsp. public sealed partial class ToolExecutionCompleteUIResourceMetaUICsp { - /// Gets or sets the baseUriDomains value. + /// Domains the UI resource may use as document base URIs. [JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)] [JsonPropertyName("baseUriDomains")] public string[]? BaseUriDomains { get; set; } - /// Gets or sets the connectDomains value. + /// Domains the UI resource may connect to. [JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)] [JsonPropertyName("connectDomains")] public string[]? ConnectDomains { get; set; } - /// Gets or sets the frameDomains value. + /// Domains the UI resource may embed as nested frames. [JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)] [JsonPropertyName("frameDomains")] public string[]? FrameDomains { get; set; } - /// Gets or sets the resourceDomains value. + /// Domains from which the UI resource may load scripts, styles, images, and other resources. [JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)] [JsonPropertyName("resourceDomains")] public string[]? ResourceDomains { get; set; } @@ -6346,7 +7984,7 @@ public sealed partial class ToolExecutionCompleteUIResourceMetaUI [JsonPropertyName("csp")] public ToolExecutionCompleteUIResourceMetaUICsp? Csp { get; set; } - /// Gets or sets the domain value. + /// Optional dedicated origin for the rendered MCP Apps UI resource. [JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)] [JsonPropertyName("domain")] public string? Domain { get; set; } @@ -6356,7 +7994,7 @@ public sealed partial class ToolExecutionCompleteUIResourceMetaUI [JsonPropertyName("permissions")] public ToolExecutionCompleteUIResourceMetaUIPermissions? Permissions { get; set; } - /// Gets or sets the prefersBorder value. + /// Whether the host should render a border around the MCP Apps UI resource. [JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)] [JsonPropertyName("prefersBorder")] public bool? PrefersBorder { get; set; } @@ -6533,7 +8171,7 @@ public sealed partial class SystemNotificationAgentCompleted : SystemNotificatio [JsonIgnore] public override string Type => "agent_completed"; - /// Unique identifier of the background agent. + /// Unique task identifier. [JsonPropertyName("agentId")] public required string AgentId { get; set; } @@ -6546,6 +8184,11 @@ public sealed partial class SystemNotificationAgentCompleted : SystemNotificatio [JsonPropertyName("description")] public string? Description { get; set; } + /// Friendly, non-unique name intended for display. + [JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)] + [JsonPropertyName("displayName")] + public string? DisplayName { get; set; } + /// The full prompt given to the background agent. [JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)] [JsonPropertyName("prompt")] @@ -6564,7 +8207,7 @@ public sealed partial class SystemNotificationAgentIdle : SystemNotification [JsonIgnore] public override string Type => "agent_idle"; - /// Unique identifier of the background agent. + /// Unique task identifier. [JsonPropertyName("agentId")] public required string AgentId { get; set; } @@ -6576,6 +8219,11 @@ public sealed partial class SystemNotificationAgentIdle : SystemNotification [JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)] [JsonPropertyName("description")] public string? Description { get; set; } + + /// Friendly, non-unique name intended for display. + [JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)] + [JsonPropertyName("displayName")] + public string? DisplayName { get; set; } } /// System notification metadata for a new inbox message, including entry ID, sender details, and summary. @@ -6670,6 +8318,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( @@ -6681,6 +8397,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. @@ -6702,6 +8420,19 @@ public sealed partial class PermissionRequestShellCommand public required bool ReadOnly { get; set; } } +/// 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 @@ -6727,6 +8458,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; } @@ -6739,6 +8475,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; } @@ -6792,6 +8537,15 @@ 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")] @@ -6825,6 +8579,15 @@ 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; } @@ -6858,6 +8621,12 @@ public sealed partial class PermissionRequestMcp : PermissionRequest [JsonPropertyName("args")] public JsonElement? Args { get; set; } + /// Advisory runtime permission recommendation. The SDK host remains responsible for deciding the request and may reject it. + [Experimental(Diagnostics.Experimental)] + [JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)] + [JsonPropertyName("permissionRecommendation")] + public PermissionRecommendation? PermissionRecommendation { get; set; } + /// Whether this MCP tool is read-only (no side effects). [JsonPropertyName("readOnly")] public required bool ReadOnly { get; set; } @@ -6892,6 +8661,20 @@ 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")] @@ -6912,6 +8695,31 @@ public sealed partial class PermissionRequestUrl : PermissionRequest public required string Url { get; set; } } +/// Assisted-approval judge information attached to a permission request. Present only in assisted mode; its absence means the judge did not evaluate the request. The `recommendation` conveys the judge's disposition for this request. +/// Nested data type for PermissionAssistedApproval. +[Experimental(Diagnostics.Experimental)] +public sealed partial class PermissionAssistedApproval +{ + /// Classified cause of an `error` recommendation. Absent for every other recommendation. + [JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)] + [JsonPropertyName("failureReason")] + public AssistedApprovalJudgeFailureReason? 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 assisted-approval safety judge's outcome for this request. + [JsonPropertyName("recommendation")] + public required AssistedApprovalRecommendation Recommendation { get; set; } +} + /// Memory operation permission request. /// The memory variant of . public sealed partial class PermissionRequestMemory : PermissionRequest @@ -6925,6 +8733,12 @@ public sealed partial class PermissionRequestMemory : PermissionRequest [JsonPropertyName("action")] public PermissionRequestMemoryAction? Action { get; set; } + /// Assisted-approval judge information for this request; present only in assisted mode. + [Experimental(Diagnostics.Experimental)] + [JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)] + [JsonPropertyName("assistedApproval")] + public PermissionAssistedApproval? AssistedApproval { get; set; } + /// Source references for the stored fact (store only). [JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)] [JsonPropertyName("citations")] @@ -6944,6 +8758,16 @@ public sealed partial class PermissionRequestMemory : PermissionRequest [JsonPropertyName("reason")] public string? Reason { get; set; } + /// Repository name with owner associated with the stored memory (store only). + [JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)] + [JsonPropertyName("repoNwo")] + public string? RepoNwo { get; set; } + + /// Scope of the stored memory (store only). + [JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)] + [JsonPropertyName("scope")] + public PermissionRequestMemoryScope? Scope { get; set; } + /// Topic or subject of the memory (store only). [JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)] [JsonPropertyName("subject")] @@ -6968,7 +8792,12 @@ public sealed partial class PermissionRequestCustomTool : PermissionRequest [JsonPropertyName("args")] public JsonElement? Args { get; set; } - /// Tool call ID that triggered this permission request. + /// Whether the tool declared that permission may be skipped unless a deny rule matches. + [JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)] + [JsonPropertyName("skipPermission")] + public bool? SkipPermission { get; set; } + + /// Tool call ID that triggered this permission request. [JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)] [JsonPropertyName("toolCallId")] public string? ToolCallId { get; set; } @@ -7033,6 +8862,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; } + + /// Factory-declared AI-credit limit before any run/resume caller override is applied. + [JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)] + [JsonPropertyName("declaredMaxAiCredits")] + public double? DeclaredMaxAiCredits { get; set; } + + /// Factory-declared concurrent-subagent limit before any run/resume caller override is applied. + [JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)] + [JsonPropertyName("declaredMaxConcurrentSubagents")] + public long? DeclaredMaxConcurrentSubagents { get; set; } + + /// Factory-declared total-subagent limit before any run/resume caller override is applied. + [JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)] + [JsonPropertyName("declaredMaxTotalSubagents")] + public long? DeclaredMaxTotalSubagents { get; set; } + + /// Factory-declared active-time limit in seconds before any run/resume caller override is applied. + [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 @@ -7055,6 +8976,28 @@ public sealed partial class PermissionRequestExtensionPermissionAccess : Permiss public string? ToolCallId { get; set; } } +/// Extension sensitive environment variable access request. +/// The extension-env-access variant of . +public sealed partial class PermissionRequestExtensionEnvAccess : PermissionRequest +{ + /// + [JsonIgnore] + public override string Kind => "extension-env-access"; + + /// Names of the sensitive environment variables the extension is requesting. Values never appear here. + [JsonPropertyName("environmentVariables")] + public required string[] EnvironmentVariables { get; set; } + + /// Name of the extension requesting environment variable access. + [JsonPropertyName("extensionName")] + public required string ExtensionName { get; set; } + + /// Tool call ID that triggered this permission request. + [JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)] + [JsonPropertyName("toolCallId")] + public string? ToolCallId { get; set; } +} + /// Details of the permission being requested. /// Polymorphic base type discriminated by kind. [JsonPolymorphic( @@ -7069,30 +9012,22 @@ 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")] +[JsonDerivedType(typeof(PermissionRequestExtensionEnvAccess), "extension-env-access")] public partial class PermissionRequest { /// The type discriminator. [JsonPropertyName("kind")] public virtual string Kind { get; set; } = string.Empty; -} - -/// 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 -{ - /// Human-readable reason for the judge's recommendation, when available. + /// Whether managed policy requires a human response and forbids host auto-approval. [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; } + [JsonPropertyName("managedApprovalRequired")] + public virtual bool? ManagedApprovalRequired { get; set; } } + /// Shell command permission prompt. /// The commands variant of . public sealed partial class PermissionPromptRequestCommands : PermissionPromptRequest @@ -7101,11 +9036,11 @@ 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. + /// Assisted-approval judge information for this request; present only in assisted mode. [Experimental(Diagnostics.Experimental)] [JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)] - [JsonPropertyName("autoApproval")] - public PermissionAutoApproval? AutoApproval { get; set; } + [JsonPropertyName("assistedApproval")] + public PermissionAssistedApproval? AssistedApproval { get; set; } /// Whether the UI can offer session-wide approval for this command pattern. [JsonPropertyName("canOfferSessionApproval")] @@ -7123,6 +9058,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")] @@ -7142,11 +9082,11 @@ 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. + /// Assisted-approval judge information for this request; present only in assisted mode. [Experimental(Diagnostics.Experimental)] [JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)] - [JsonPropertyName("autoApproval")] - public PermissionAutoApproval? AutoApproval { get; set; } + [JsonPropertyName("assistedApproval")] + public PermissionAssistedApproval? AssistedApproval { get; set; } /// Whether the UI can offer session-wide approval for file write operations. [JsonPropertyName("canOfferSessionApproval")] @@ -7164,6 +9104,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")] @@ -7183,16 +9128,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. + /// Assisted-approval judge information for this request; present only in assisted mode. [Experimental(Diagnostics.Experimental)] [JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)] - [JsonPropertyName("autoApproval")] - public PermissionAutoApproval? AutoApproval { get; set; } + [JsonPropertyName("assistedApproval")] + public PermissionAssistedApproval? AssistedApproval { 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; } @@ -7216,11 +9166,22 @@ 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. + /// Assisted-approval judge information for this request; present only in assisted mode. + [Experimental(Diagnostics.Experimental)] + [JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)] + [JsonPropertyName("assistedApproval")] + public PermissionAssistedApproval? AssistedApproval { get; set; } + + /// Whether the host may offer a server-wide "approve all tools from this server" blanket. Absent is treated as true; the runtime sends false when managed policy disables bypass-permissions mode, which forbids the server-wide escalation while still allowing per-tool approval. + [JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)] + [JsonPropertyName("canOfferServerWideApproval")] + public bool? CanOfferServerWideApproval { get; set; } + + /// Advisory runtime permission recommendation. The host remains responsible for deciding the request and may reject it. [Experimental(Diagnostics.Experimental)] [JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)] - [JsonPropertyName("autoApproval")] - public PermissionAutoApproval? AutoApproval { get; set; } + [JsonPropertyName("permissionRecommendation")] + public PermissionRecommendation? PermissionRecommendation { get; set; } /// Name of the MCP server providing the tool. [JsonPropertyName("serverName")] @@ -7248,16 +9209,26 @@ 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. + /// Assisted-approval judge information for this request; present only in assisted mode. [Experimental(Diagnostics.Experimental)] [JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)] - [JsonPropertyName("autoApproval")] - public PermissionAutoApproval? AutoApproval { get; set; } + [JsonPropertyName("assistedApproval")] + public PermissionAssistedApproval? AssistedApproval { 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")] @@ -7291,11 +9262,11 @@ 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. + /// Assisted-approval judge information for this request; present only in assisted mode. [Experimental(Diagnostics.Experimental)] [JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)] - [JsonPropertyName("autoApproval")] - public PermissionAutoApproval? AutoApproval { get; set; } + [JsonPropertyName("assistedApproval")] + public PermissionAssistedApproval? AssistedApproval { get; set; } /// Source references for the stored fact (store only). [JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)] @@ -7340,11 +9311,11 @@ 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. + /// Assisted-approval judge information for this request; present only in assisted mode. [Experimental(Diagnostics.Experimental)] [JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)] - [JsonPropertyName("autoApproval")] - public PermissionAutoApproval? AutoApproval { get; set; } + [JsonPropertyName("assistedApproval")] + public PermissionAssistedApproval? AssistedApproval { get; set; } /// Tool call ID that triggered this permission request. [JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)] @@ -7372,11 +9343,11 @@ 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. + /// Assisted-approval judge information for this request; present only in assisted mode. [Experimental(Diagnostics.Experimental)] [JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)] - [JsonPropertyName("autoApproval")] - public PermissionAutoApproval? AutoApproval { get; set; } + [JsonPropertyName("assistedApproval")] + public PermissionAssistedApproval? AssistedApproval { get; set; } /// File paths that require explicit approval. [JsonPropertyName("paths")] @@ -7396,11 +9367,11 @@ 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. + /// Assisted-approval judge information for this request; present only in assisted mode. [Experimental(Diagnostics.Experimental)] [JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)] - [JsonPropertyName("autoApproval")] - public PermissionAutoApproval? AutoApproval { get; set; } + [JsonPropertyName("assistedApproval")] + public PermissionAssistedApproval? AssistedApproval { get; set; } /// Optional message from the hook explaining why confirmation is needed. [JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)] @@ -7430,11 +9401,11 @@ 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. + /// Assisted-approval judge information for this request; present only in assisted mode. [Experimental(Diagnostics.Experimental)] [JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)] - [JsonPropertyName("autoApproval")] - public PermissionAutoApproval? AutoApproval { get; set; } + [JsonPropertyName("assistedApproval")] + public PermissionAssistedApproval? AssistedApproval { get; set; } /// Name of the extension being managed. [JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)] @@ -7451,6 +9422,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; } + + /// Assisted-approval judge information for this request; present only in assisted mode. + [Experimental(Diagnostics.Experimental)] + [JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)] + [JsonPropertyName("assistedApproval")] + public PermissionAssistedApproval? AssistedApproval { get; set; } + + /// Whether this factory is eligible for persistent approval. + [JsonPropertyName("canPersistApproval")] + public required bool CanPersistApproval { get; set; } + + /// Factory-declared AI-credit limit before any run/resume caller override is applied. + [JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)] + [JsonPropertyName("declaredMaxAiCredits")] + public double? DeclaredMaxAiCredits { get; set; } + + /// Factory-declared concurrent-subagent limit before any run/resume caller override is applied. + [JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)] + [JsonPropertyName("declaredMaxConcurrentSubagents")] + public long? DeclaredMaxConcurrentSubagents { get; set; } + + /// Factory-declared total-subagent limit before any run/resume caller override is applied. + [JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)] + [JsonPropertyName("declaredMaxTotalSubagents")] + public long? DeclaredMaxTotalSubagents { get; set; } + + /// Factory-declared active-time limit in seconds before any run/resume caller override is applied. + [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 @@ -7459,11 +9519,11 @@ 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. + /// Assisted-approval judge information for this request; present only in assisted mode. [Experimental(Diagnostics.Experimental)] [JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)] - [JsonPropertyName("autoApproval")] - public PermissionAutoApproval? AutoApproval { get; set; } + [JsonPropertyName("assistedApproval")] + public PermissionAssistedApproval? AssistedApproval { get; set; } /// Capabilities the extension is requesting. [JsonPropertyName("capabilities")] @@ -7479,6 +9539,34 @@ public sealed partial class PermissionPromptRequestExtensionPermissionAccess : P public string? ToolCallId { get; set; } } +/// Extension sensitive environment variable access prompt. +/// The extension-env-access variant of . +public sealed partial class PermissionPromptRequestExtensionEnvAccess : PermissionPromptRequest +{ + /// + [JsonIgnore] + public override string Kind => "extension-env-access"; + + /// Assisted-approval judge information for this request; present only in assisted mode. + [Experimental(Diagnostics.Experimental)] + [JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)] + [JsonPropertyName("assistedApproval")] + public PermissionAssistedApproval? AssistedApproval { get; set; } + + /// Names of the sensitive environment variables the extension is requesting. Values never appear here. + [JsonPropertyName("environmentVariables")] + public required string[] EnvironmentVariables { get; set; } + + /// Name of the extension requesting environment variable access. + [JsonPropertyName("extensionName")] + public required string ExtensionName { get; set; } + + /// Tool call ID that triggered this permission request. + [JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)] + [JsonPropertyName("toolCallId")] + public string? ToolCallId { get; set; } +} + /// Derived user-facing permission prompt details for UI consumers. /// Polymorphic base type discriminated by kind. [JsonPolymorphic( @@ -7494,7 +9582,9 @@ 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")] +[JsonDerivedType(typeof(PermissionPromptRequestExtensionEnvAccess), "extension-env-access")] public partial class PermissionPromptRequest { /// The type discriminator. @@ -7510,6 +9600,11 @@ public sealed partial class PermissionResultApproved : PermissionResult /// [JsonIgnore] public override string Kind => "approved"; + + /// Whether a managed approval policy already handled this request. + [JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)] + [JsonPropertyName("managedApprovalHandled")] + public bool? ManagedApprovalHandled { get; set; } } /// Session-scoped tool-approval rule for specific shell command identifiers. @@ -7596,6 +9691,20 @@ public sealed partial class UserToolSessionApprovalExtensionManagement : UserToo public string? Operation { get; set; } } +/// 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 @@ -7609,6 +9718,23 @@ public sealed partial class UserToolSessionApprovalExtensionPermissionAccess : U public required string ExtensionName { get; set; } } +/// Session-scoped tool-approval rule for an extension's access to sensitive environment variables, keyed by extension name and the exact set of variable names. +/// The extension-env-access variant of . +public sealed partial class UserToolSessionApprovalExtensionEnvAccess : UserToolSessionApproval +{ + /// + [JsonIgnore] + public override string Kind => "extension-env-access"; + + /// Names of the sensitive environment variables this approval covers. Values are never persisted. + [JsonPropertyName("environmentVariables")] + public required string[] EnvironmentVariables { get; set; } + + /// Extension name. + [JsonPropertyName("extensionName")] + public required string ExtensionName { get; set; } +} + /// The approval to add as a session-scoped rule. /// Polymorphic base type discriminated by kind. [JsonPolymorphic( @@ -7621,7 +9747,9 @@ 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")] +[JsonDerivedType(typeof(UserToolSessionApprovalExtensionEnvAccess), "extension-env-access")] public partial class UserToolSessionApproval { /// The type discriminator. @@ -7641,6 +9769,11 @@ public sealed partial class PermissionResultApprovedForSession : PermissionResul /// The approval to add as a session-scoped rule. [JsonPropertyName("approval")] public required UserToolSessionApproval Approval { get; set; } + + /// Whether a managed approval policy already handled this request. + [JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)] + [JsonPropertyName("managedApprovalHandled")] + public bool? ManagedApprovalHandled { get; set; } } /// Permission response variant that approves a request and persists the provided approval to a project location key. @@ -7658,6 +9791,11 @@ public sealed partial class PermissionResultApprovedForLocation : PermissionResu /// The location key (git root or cwd) to persist the approval to. [JsonPropertyName("locationKey")] public required string LocationKey { get; set; } + + /// Whether a managed approval policy already handled this request. + [JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)] + [JsonPropertyName("managedApprovalHandled")] + public bool? ManagedApprovalHandled { get; set; } } /// Permission response variant indicating the request was cancelled before use, with an optional reason. @@ -7941,6 +10079,11 @@ public sealed partial class SkillsLoadedSkill [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; } @@ -8033,7 +10176,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; } @@ -8181,23 +10324,938 @@ public WorkingDirectoryContextHostType(string 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 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)); + } + } +} + +/// 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)); + } + } +} + +/// 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)); + } + } +} + +/// Origin of an effective session model change. +[JsonConverter(typeof(Converter))] +[DebuggerDisplay("{Value,nq}")] +public readonly struct ModelChangeSource : IEquatable +{ + private readonly string? _value; + + /// Initializes a new instance of the struct. + /// The value to associate with this . + [JsonConstructor] + public ModelChangeSource(string value) + { + ArgumentException.ThrowIfNullOrWhiteSpace(value); + _value = value; + } + + /// Gets the value associated with this . + public string Value => _value ?? string.Empty; + + /// The user selected a model directly with `/model <id>`. + public static ModelChangeSource ModelCommand { get; } = new("model_command"); + + /// The user selected the model with `/settings`. + public static ModelChangeSource SettingsCommand { get; } = new("settings_command"); + + /// The user selected the model with the `/config` alias. + public static ModelChangeSource ConfigCommand { get; } = new("config_command"); + + /// The user selected the model in the model picker, including the picker opened by bare `/model`. + public static ModelChangeSource ModelPicker { get; } = new("model_picker"); + + /// Organization-managed settings selected the model. + public static ModelChangeSource ManagedSettings { get; } = new("managed_settings"); + + /// Repository settings selected the model. + public static ModelChangeSource RepoSettings { get; } = new("repo_settings"); + + /// Startup model resolution selected the model. + public static ModelChangeSource Startup { get; } = new("startup"); + + /// Selecting an agent selected its configured model. + public static ModelChangeSource Agent { get; } = new("agent"); + + /// Entering, leaving, or reconfiguring plan mode selected the model. + public static ModelChangeSource PlanMode { get; } = new("plan_mode"); + + /// The runtime selected the model automatically, such as rate-limit recovery or refusal fallback. + public static ModelChangeSource Automatic { get; } = new("automatic"); + + /// An SDK or RPC caller selected the model. + public static ModelChangeSource Sdk { get; } = new("sdk"); + + /// Returns a value indicating whether two instances are equivalent. + public static bool operator ==(ModelChangeSource left, ModelChangeSource right) => left.Equals(right); + + /// Returns a value indicating whether two instances are not equivalent. + public static bool operator !=(ModelChangeSource left, ModelChangeSource right) => !(left == right); + + /// + public override bool Equals(object? obj) => obj is ModelChangeSource other && Equals(other); + + /// + public bool Equals(ModelChangeSource 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 ModelChangeSource Read(ref Utf8JsonReader reader, Type typeToConvert, JsonSerializerOptions options) + { + return new(GeneratedStringEnumJson.ReadValue(ref reader, typeToConvert)); + } + + /// + public override void Write(Utf8JsonWriter writer, ModelChangeSource value, JsonSerializerOptions options) + { + GeneratedStringEnumJson.WriteValue(writer, value.Value, typeof(ModelChangeSource)); + } + } +} + +/// Permission mode for the session. +[Experimental(Diagnostics.Experimental)] +[JsonConverter(typeof(Converter))] +[DebuggerDisplay("{Value,nq}")] +public readonly struct PermissionMode : IEquatable +{ + private readonly string? _value; + + /// Initializes a new instance of the struct. + /// The value to associate with this . + [JsonConstructor] + public PermissionMode(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 PermissionMode Manual { get; } = new("manual"); + + /// Permission requests include an LLM safety recommendation; clients may automatically approve requests judged acceptable. + public static PermissionMode Assisted { get; } = new("assisted"); + + /// Tool, path, and URL permission requests are automatically approved. + public static PermissionMode AllowAll { get; } = new("allow-all"); + + /// Returns a value indicating whether two instances are equivalent. + public static bool operator ==(PermissionMode left, PermissionMode right) => left.Equals(right); + + /// Returns a value indicating whether two instances are not equivalent. + public static bool operator !=(PermissionMode left, PermissionMode right) => !(left == right); + + /// + public override bool Equals(object? obj) => obj is PermissionMode other && Equals(other); + + /// + public bool Equals(PermissionMode 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 PermissionMode Read(ref Utf8JsonReader reader, Type typeToConvert, JsonSerializerOptions options) + { + return new(GeneratedStringEnumJson.ReadValue(ref reader, typeToConvert)); + } + + /// + public override void Write(Utf8JsonWriter writer, PermissionMode value, JsonSerializerOptions options) + { + GeneratedStringEnumJson.WriteValue(writer, value.Value, typeof(PermissionMode)); + } + } +} + +/// 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"); - /// Repository is hosted on Azure DevOps. - public static WorkingDirectoryContextHostType Ado { get; } = new("ado"); + /// Emergency compaction triggered by high process memory usage. + public static CompactionTrigger MemoryPressure { get; } = new("memory_pressure"); - /// Returns a value indicating whether two instances are equivalent. - public static bool operator ==(WorkingDirectoryContextHostType left, WorkingDirectoryContextHostType right) => left.Equals(right); + /// 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 not equivalent. - public static bool operator !=(WorkingDirectoryContextHostType left, WorkingDirectoryContextHostType right) => !(left == right); + /// 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 WorkingDirectoryContextHostType other && Equals(other); + public override bool Equals(object? obj) => obj is CompactionTrigger other && Equals(other); /// - public bool Equals(WorkingDirectoryContextHostType other) => string.Equals(Value, other.Value, StringComparison.OrdinalIgnoreCase); + public bool Equals(CompactionTrigger other) => string.Equals(Value, other.Value, StringComparison.OrdinalIgnoreCase); /// public override int GetHashCode() => StringComparer.OrdinalIgnoreCase.GetHashCode(Value); @@ -8205,60 +11263,63 @@ 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 CompactionTrigger 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, CompactionTrigger value, JsonSerializerOptions options) { - GeneratedStringEnumJson.WriteValue(writer, value.Value, typeof(WorkingDirectoryContextHostType)); + GeneratedStringEnumJson.WriteValue(writer, value.Value, typeof(CompactionTrigger)); } } } -/// Allowed values for the `ContextTier` enumeration. +/// Semantic result of evaluating a task completion request. [JsonConverter(typeof(Converter))] [DebuggerDisplay("{Value,nq}")] -public readonly struct ContextTier : IEquatable +public readonly struct TaskCompletionOutcome : 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 ContextTier(string value) + public TaskCompletionOutcome(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 ContextTier Default { get; } = new("default"); + /// The completion request was accepted and the objective is complete. + public static TaskCompletionOutcome Completed { get; } = new("completed"); - /// Extended context tier with a larger context window. - public static ContextTier LongContext { get; } = new("long_context"); + /// The completion request was rejected because more work or validation remains. + public static TaskCompletionOutcome Continue { get; } = new("continue"); - /// Returns a value indicating whether two instances are equivalent. - public static bool operator ==(ContextTier left, ContextTier right) => left.Equals(right); + /// 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 not equivalent. - public static bool operator !=(ContextTier left, ContextTier right) => !(left == right); + /// 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 ContextTier other && Equals(other); + public override bool Equals(object? obj) => obj is TaskCompletionOutcome other && Equals(other); /// - public bool Equals(ContextTier other) => string.Equals(Value, other.Value, StringComparison.OrdinalIgnoreCase); + public bool Equals(TaskCompletionOutcome other) => string.Equals(Value, other.Value, StringComparison.OrdinalIgnoreCase); /// public override int GetHashCode() => StringComparer.OrdinalIgnoreCase.GetHashCode(Value); @@ -8266,63 +11327,61 @@ public ContextTier(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 ContextTier Read(ref Utf8JsonReader reader, Type typeToConvert, JsonSerializerOptions options) + public override TaskCompletionOutcome 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) + public override void Write(Utf8JsonWriter writer, TaskCompletionOutcome value, JsonSerializerOptions options) { - GeneratedStringEnumJson.WriteValue(writer, value.Value, typeof(ContextTier)); + GeneratedStringEnumJson.WriteValue(writer, value.Value, typeof(TaskCompletionOutcome)); } } } -/// Reasoning summary mode used for model calls, if applicable (e.g. "none", "concise", "detailed"). +/// Kind of turn for which HydraFusion routing is running. +[Experimental(Diagnostics.Experimental)] [JsonConverter(typeof(Converter))] [DebuggerDisplay("{Value,nq}")] -public readonly struct ReasoningSummary : IEquatable +public readonly struct FusionTurnKind : 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 FusionTurnKind(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"); + /// A user-message turn. + public static FusionTurnKind User { get; } = new("user"); - /// Request a detailed summary of the model's reasoning. - public static ReasoningSummary Detailed { get; } = new("detailed"); + /// A conversation-compaction turn. + public static FusionTurnKind Compaction { get; } = new("compaction"); - /// 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 ==(FusionTurnKind left, FusionTurnKind 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 !=(FusionTurnKind left, FusionTurnKind right) => !(left == right); /// - public override bool Equals(object? obj) => obj is ReasoningSummary other && Equals(other); + public override bool Equals(object? obj) => obj is FusionTurnKind other && Equals(other); /// - public bool Equals(ReasoningSummary other) => string.Equals(Value, other.Value, StringComparison.OrdinalIgnoreCase); + public bool Equals(FusionTurnKind other) => string.Equals(Value, other.Value, StringComparison.OrdinalIgnoreCase); /// public override int GetHashCode() => StringComparer.OrdinalIgnoreCase.GetHashCode(Value); @@ -8330,63 +11389,61 @@ 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 FusionTurnKind 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, FusionTurnKind value, JsonSerializerOptions options) { - GeneratedStringEnumJson.WriteValue(writer, value.Value, typeof(ReasoningSummary)); + GeneratedStringEnumJson.WriteValue(writer, value.Value, typeof(FusionTurnKind)); } } } -/// Output verbosity level used for supported model calls (e.g. "low", "medium", "high"). +/// Server-recommended routing behavior for a later HydraFusion turn. +[Experimental(Diagnostics.Experimental)] [JsonConverter(typeof(Converter))] [DebuggerDisplay("{Value,nq}")] -public readonly struct Verbosity : IEquatable +public readonly struct FusionFollowUpAction : 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 Verbosity(string value) + public FusionFollowUpAction(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 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"); + /// Reuse the durable primary model without routing. + public static FusionFollowUpAction ReusePrimary { get; } = new("reuse_primary"); - /// A more detailed response was requested. - public static Verbosity High { get; } = new("high"); + /// Request a new routing decision. + public static FusionFollowUpAction Reroute { get; } = new("reroute"); - /// 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 equivalent. + public static bool operator ==(FusionFollowUpAction left, FusionFollowUpAction right) => left.Equals(right); - /// Returns a value indicating whether two instances are not equivalent. - public static bool operator !=(Verbosity left, Verbosity right) => !(left == right); + /// Returns a value indicating whether two instances are not equivalent. + public static bool operator !=(FusionFollowUpAction left, FusionFollowUpAction right) => !(left == right); /// - public override bool Equals(object? obj) => obj is Verbosity other && Equals(other); + public override bool Equals(object? obj) => obj is FusionFollowUpAction other && Equals(other); /// - public bool Equals(Verbosity other) => string.Equals(Value, other.Value, StringComparison.OrdinalIgnoreCase); + public bool Equals(FusionFollowUpAction other) => string.Equals(Value, other.Value, StringComparison.OrdinalIgnoreCase); /// public override int GetHashCode() => StringComparer.OrdinalIgnoreCase.GetHashCode(Value); @@ -8394,63 +11451,64 @@ public Verbosity(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 Verbosity Read(ref Utf8JsonReader reader, Type typeToConvert, JsonSerializerOptions options) + public override FusionFollowUpAction 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) + public override void Write(Utf8JsonWriter writer, FusionFollowUpAction value, JsonSerializerOptions options) { - GeneratedStringEnumJson.WriteValue(writer, value.Value, typeof(Verbosity)); + GeneratedStringEnumJson.WriteValue(writer, value.Value, typeof(FusionFollowUpAction)); } } } -/// The type of operation performed on the autopilot objective state file. +/// Validated HydraFusion execution pattern. +[Experimental(Diagnostics.Experimental)] [JsonConverter(typeof(Converter))] [DebuggerDisplay("{Value,nq}")] -public readonly struct AutopilotObjectiveChangedOperation : IEquatable +public readonly struct FusionPattern : 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 FusionPattern(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"); + /// Run one primary solver phase. + public static FusionPattern Single { get; } = new("single"); - /// Autopilot objective state file was updated for an existing objective. - public static AutopilotObjectiveChangedOperation Update { get; } = new("update"); + /// Run a primary phase, a judge, and an optional repair. + public static FusionPattern Cascade { get; } = new("cascade"); - /// Autopilot objective state file was deleted or cleared. - public static AutopilotObjectiveChangedOperation Delete { get; } = new("delete"); + /// Run a primary draft, a read-only critique, and a revision. + public static FusionPattern Critique { get; } = new("critique"); - /// 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 ==(FusionPattern left, FusionPattern 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 !=(FusionPattern left, FusionPattern right) => !(left == right); /// - public override bool Equals(object? obj) => obj is AutopilotObjectiveChangedOperation other && Equals(other); + public override bool Equals(object? obj) => obj is FusionPattern other && Equals(other); /// - public bool Equals(AutopilotObjectiveChangedOperation other) => string.Equals(Value, other.Value, StringComparison.OrdinalIgnoreCase); + public bool Equals(FusionPattern other) => string.Equals(Value, other.Value, StringComparison.OrdinalIgnoreCase); /// public override int GetHashCode() => StringComparer.OrdinalIgnoreCase.GetHashCode(Value); @@ -8458,66 +11516,66 @@ 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 FusionPattern 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, FusionPattern value, JsonSerializerOptions options) { - GeneratedStringEnumJson.WriteValue(writer, value.Value, typeof(AutopilotObjectiveChangedOperation)); + GeneratedStringEnumJson.WriteValue(writer, value.Value, typeof(FusionPattern)); } } } -/// Current autopilot objective status, if one exists. +/// The agent mode that was active when this message was sent. [JsonConverter(typeof(Converter))] [DebuggerDisplay("{Value,nq}")] -public readonly struct AutopilotObjectiveChangedStatus : IEquatable +public readonly struct UserMessageAgentMode : 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 UserMessageAgentMode(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"); + /// The agent is responding interactively to the user. + public static UserMessageAgentMode Interactive { get; } = new("interactive"); - /// Objective is paused and will not drive autopilot continuations. - public static AutopilotObjectiveChangedStatus Paused { get; } = new("paused"); + /// The agent is preparing a plan before making changes. + public static UserMessageAgentMode Plan { get; } = new("plan"); - /// Legacy objective state indicating the previous continuation cap was reached. - public static AutopilotObjectiveChangedStatus CapReached { get; } = new("cap_reached"); + /// The agent is working autonomously toward task completion. + public static UserMessageAgentMode Autopilot { get; } = new("autopilot"); - /// Objective was completed by the agent. - public static AutopilotObjectiveChangedStatus Completed { get; } = new("completed"); + /// 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 ==(AutopilotObjectiveChangedStatus left, AutopilotObjectiveChangedStatus right) => left.Equals(right); + /// 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 !=(AutopilotObjectiveChangedStatus left, AutopilotObjectiveChangedStatus right) => !(left == 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 AutopilotObjectiveChangedStatus other && Equals(other); + public override bool Equals(object? obj) => obj is UserMessageAgentMode other && Equals(other); /// - public bool Equals(AutopilotObjectiveChangedStatus other) => string.Equals(Value, other.Value, StringComparison.OrdinalIgnoreCase); + public bool Equals(UserMessageAgentMode other) => string.Equals(Value, other.Value, StringComparison.OrdinalIgnoreCase); /// public override int GetHashCode() => StringComparer.OrdinalIgnoreCase.GetHashCode(Value); @@ -8525,63 +11583,60 @@ 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 UserMessageAgentMode 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, UserMessageAgentMode value, JsonSerializerOptions options) { - GeneratedStringEnumJson.WriteValue(writer, value.Value, typeof(AutopilotObjectiveChangedStatus)); + GeneratedStringEnumJson.WriteValue(writer, value.Value, typeof(UserMessageAgentMode)); } } } -/// The session mode the agent is operating in. +/// 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 SessionMode : IEquatable +public readonly struct OmittedBinaryOmittedReason : 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 OmittedBinaryOmittedReason(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"); + /// Bytes exceeded the session's inline size limit. + public static OmittedBinaryOmittedReason TooLarge { get; } = new("too_large"); - /// The agent is working autonomously toward task completion. - public static SessionMode Autopilot { get; } = new("autopilot"); + /// 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 ==(SessionMode left, SessionMode right) => left.Equals(right); + /// 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 !=(SessionMode left, SessionMode right) => !(left == 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 SessionMode other && Equals(other); + public override bool Equals(object? obj) => obj is OmittedBinaryOmittedReason other && Equals(other); /// - public bool Equals(SessionMode other) => string.Equals(Value, other.Value, StringComparison.OrdinalIgnoreCase); + public bool Equals(OmittedBinaryOmittedReason other) => string.Equals(Value, other.Value, StringComparison.OrdinalIgnoreCase); /// public override int GetHashCode() => StringComparer.OrdinalIgnoreCase.GetHashCode(Value); @@ -8589,64 +11644,63 @@ 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 OmittedBinaryOmittedReason 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, OmittedBinaryOmittedReason value, JsonSerializerOptions options) { - GeneratedStringEnumJson.WriteValue(writer, value.Value, typeof(SessionMode)); + GeneratedStringEnumJson.WriteValue(writer, value.Value, typeof(OmittedBinaryOmittedReason)); } } } -/// Allow-all mode for the session. -[Experimental(Diagnostics.Experimental)] +/// Type of GitHub reference. [JsonConverter(typeof(Converter))] [DebuggerDisplay("{Value,nq}")] -public readonly struct PermissionAllowAllMode : IEquatable +public readonly struct AttachmentGitHubReferenceType : 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 PermissionAllowAllMode(string value) + public AttachmentGitHubReferenceType(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; - /// Permission requests follow the normal approval flow. - public static PermissionAllowAllMode Off { get; } = new("off"); + /// GitHub issue reference. + public static AttachmentGitHubReferenceType Issue { get; } = new("issue"); - /// Tool, path, and URL permission requests are automatically approved. - public static PermissionAllowAllMode On { get; } = new("on"); + /// GitHub pull request reference. + public static AttachmentGitHubReferenceType Pr { get; } = new("pr"); - /// 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"); + /// GitHub discussion reference. + public static AttachmentGitHubReferenceType Discussion { get; } = new("discussion"); - /// 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 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 !=(PermissionAllowAllMode left, PermissionAllowAllMode right) => !(left == 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 PermissionAllowAllMode other && Equals(other); + public override bool Equals(object? obj) => obj is AttachmentGitHubReferenceType other && Equals(other); /// - public bool Equals(PermissionAllowAllMode other) => string.Equals(Value, other.Value, StringComparison.OrdinalIgnoreCase); + public bool Equals(AttachmentGitHubReferenceType other) => string.Equals(Value, other.Value, StringComparison.OrdinalIgnoreCase); /// public override int GetHashCode() => StringComparer.OrdinalIgnoreCase.GetHashCode(Value); @@ -8654,63 +11708,63 @@ public PermissionAllowAllMode(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 PermissionAllowAllMode Read(ref Utf8JsonReader reader, Type typeToConvert, JsonSerializerOptions options) + public override AttachmentGitHubReferenceType 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) + public override void Write(Utf8JsonWriter writer, AttachmentGitHubReferenceType value, JsonSerializerOptions options) { - GeneratedStringEnumJson.WriteValue(writer, value.Value, typeof(PermissionAllowAllMode)); + GeneratedStringEnumJson.WriteValue(writer, value.Value, typeof(AttachmentGitHubReferenceType)); } } } -/// The type of operation performed on the plan file. +/// 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 PlanChangedOperation : IEquatable +public readonly struct UserMessageDelivery : 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 UserMessageDelivery(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"); + /// 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"); - /// The plan file was updated. - public static PlanChangedOperation Update { get; } = new("update"); + /// Injected into the current in-flight run while the agent was busy (immediate mode). + public static UserMessageDelivery Steering { get; } = new("steering"); - /// The plan file was deleted. - public static PlanChangedOperation Delete { get; } = new("delete"); + /// 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 ==(PlanChangedOperation left, PlanChangedOperation right) => left.Equals(right); + /// 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 !=(PlanChangedOperation left, PlanChangedOperation right) => !(left == 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 PlanChangedOperation other && Equals(other); + public override bool Equals(object? obj) => obj is UserMessageDelivery other && Equals(other); /// - public bool Equals(PlanChangedOperation other) => string.Equals(Value, other.Value, StringComparison.OrdinalIgnoreCase); + public bool Equals(UserMessageDelivery other) => string.Equals(Value, other.Value, StringComparison.OrdinalIgnoreCase); /// public override int GetHashCode() => StringComparer.OrdinalIgnoreCase.GetHashCode(Value); @@ -8718,60 +11772,66 @@ 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 UserMessageDelivery 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, UserMessageDelivery value, JsonSerializerOptions options) { - GeneratedStringEnumJson.WriteValue(writer, value.Value, typeof(PlanChangedOperation)); + GeneratedStringEnumJson.WriteValue(writer, value.Value, typeof(UserMessageDelivery)); } } } -/// Whether the file was newly created or updated. +/// What the agent was doing when the user interrupted it. [JsonConverter(typeof(Converter))] [DebuggerDisplay("{Value,nq}")] -public readonly struct WorkspaceFileChangedOperation : IEquatable +public readonly struct AgentInterruptedActivity : 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 AgentInterruptedActivity(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"); + /// A request to the model was open. + public static AgentInterruptedActivity ModelCall { get; } = new("model_call"); - /// The workspace file was updated. - public static WorkspaceFileChangedOperation Update { get; } = new("update"); + /// The turn was sleeping between retry attempts. + public static AgentInterruptedActivity RetryBackoff { get; } = new("retry_backoff"); - /// Returns a value indicating whether two instances are equivalent. - public static bool operator ==(WorkspaceFileChangedOperation left, WorkspaceFileChangedOperation right) => left.Equals(right); + /// One or more tools were executing. + public static AgentInterruptedActivity ToolCall { get; } = new("tool_call"); - /// Returns a value indicating whether two instances are not equivalent. - public static bool operator !=(WorkspaceFileChangedOperation left, WorkspaceFileChangedOperation right) => !(left == right); + /// Background sub-agents were running while the main loop was idle. + public static AgentInterruptedActivity BackgroundAgent { get; } = new("background_agent"); + + /// Returns a value indicating whether two instances are equivalent. + public static bool operator ==(AgentInterruptedActivity left, AgentInterruptedActivity right) => left.Equals(right); + + /// Returns a value indicating whether two instances are not equivalent. + public static bool operator !=(AgentInterruptedActivity left, AgentInterruptedActivity right) => !(left == right); /// - public override bool Equals(object? obj) => obj is WorkspaceFileChangedOperation other && Equals(other); + public override bool Equals(object? obj) => obj is AgentInterruptedActivity other && Equals(other); /// - public bool Equals(WorkspaceFileChangedOperation other) => string.Equals(Value, other.Value, StringComparison.OrdinalIgnoreCase); + public bool Equals(AgentInterruptedActivity other) => string.Equals(Value, other.Value, StringComparison.OrdinalIgnoreCase); /// public override int GetHashCode() => StringComparer.OrdinalIgnoreCase.GetHashCode(Value); @@ -8779,60 +11839,60 @@ 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 AgentInterruptedActivity 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, AgentInterruptedActivity value, JsonSerializerOptions options) { - GeneratedStringEnumJson.WriteValue(writer, value.Value, typeof(WorkspaceFileChangedOperation)); + GeneratedStringEnumJson.WriteValue(writer, value.Value, typeof(AgentInterruptedActivity)); } } } -/// Origin type of the session being handed off. +/// Where the interruption landed relative to the first streamed token. [JsonConverter(typeof(Converter))] [DebuggerDisplay("{Value,nq}")] -public readonly struct HandoffSourceType : IEquatable +public readonly struct AgentInterruptedCancelPhase : 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 AgentInterruptedCancelPhase(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"); + /// No output had been produced when the request was cancelled. + public static AgentInterruptedCancelPhase PreFirstToken { get; } = new("pre_first_token"); - /// The handoff originated from a local session. - public static HandoffSourceType Local { get; } = new("local"); + /// The response was already streaming when the request was cancelled. + public static AgentInterruptedCancelPhase MidStream { get; } = new("mid_stream"); - /// 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 equivalent. + public static bool operator ==(AgentInterruptedCancelPhase left, AgentInterruptedCancelPhase right) => left.Equals(right); - /// Returns a value indicating whether two instances are not equivalent. - public static bool operator !=(HandoffSourceType left, HandoffSourceType right) => !(left == right); + /// Returns a value indicating whether two instances are not equivalent. + public static bool operator !=(AgentInterruptedCancelPhase left, AgentInterruptedCancelPhase right) => !(left == right); /// - public override bool Equals(object? obj) => obj is HandoffSourceType other && Equals(other); + public override bool Equals(object? obj) => obj is AgentInterruptedCancelPhase other && Equals(other); /// - public bool Equals(HandoffSourceType other) => string.Equals(Value, other.Value, StringComparison.OrdinalIgnoreCase); + public bool Equals(AgentInterruptedCancelPhase other) => string.Equals(Value, other.Value, StringComparison.OrdinalIgnoreCase); /// public override int GetHashCode() => StringComparer.OrdinalIgnoreCase.GetHashCode(Value); @@ -8840,60 +11900,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 AgentInterruptedCancelPhase 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, AgentInterruptedCancelPhase value, JsonSerializerOptions options) { - GeneratedStringEnumJson.WriteValue(writer, value.Value, typeof(HandoffSourceType)); + GeneratedStringEnumJson.WriteValue(writer, value.Value, typeof(AgentInterruptedCancelPhase)); } } } -/// Whether the session ended normally ("routine") or due to a crash/fatal error ("error"). +/// Transport used for a failed model call. [JsonConverter(typeof(Converter))] [DebuggerDisplay("{Value,nq}")] -public readonly struct ShutdownType : IEquatable +public readonly struct ModelCallFailureTransport : 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 ModelCallFailureTransport(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"); + /// HTTP transport, including SSE streams. + public static ModelCallFailureTransport Http { get; } = new("http"); - /// The session ended because of a crash or fatal error. - public static ShutdownType Error { get; } = new("error"); + /// WebSocket transport. + public static ModelCallFailureTransport Websocket { get; } = new("websocket"); - /// 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 ==(ModelCallFailureTransport left, ModelCallFailureTransport 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 !=(ModelCallFailureTransport left, ModelCallFailureTransport right) => !(left == right); /// - public override bool Equals(object? obj) => obj is ShutdownType other && Equals(other); + public override bool Equals(object? obj) => obj is ModelCallFailureTransport other && Equals(other); /// - public bool Equals(ShutdownType other) => string.Equals(Value, other.Value, StringComparison.OrdinalIgnoreCase); + public bool Equals(ModelCallFailureTransport other) => string.Equals(Value, other.Value, StringComparison.OrdinalIgnoreCase); /// public override int GetHashCode() => StringComparer.OrdinalIgnoreCase.GetHashCode(Value); @@ -8901,66 +11961,61 @@ 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 ModelCallFailureTransport 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, ModelCallFailureTransport value, JsonSerializerOptions options) { - GeneratedStringEnumJson.WriteValue(writer, value.Value, typeof(ShutdownType)); + GeneratedStringEnumJson.WriteValue(writer, value.Value, typeof(ModelCallFailureTransport)); } } } -/// The agent mode that was active when this message was sent. +/// Conversation scope in which a HydraFusion phase executes. +[Experimental(Diagnostics.Experimental)] [JsonConverter(typeof(Converter))] [DebuggerDisplay("{Value,nq}")] -public readonly struct UserMessageAgentMode : IEquatable +public readonly struct FusionConversationScope : 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 FusionConversationScope(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"); + /// Canonical root conversation history. + public static FusionConversationScope Root { get; } = new("root"); - /// The agent is in shell-focused UI mode. - public static UserMessageAgentMode Shell { get; } = new("shell"); + /// Isolated read-only review history that does not enter the root conversation. + public static FusionConversationScope Review { get; } = new("review"); - /// 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 ==(FusionConversationScope left, FusionConversationScope 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 !=(FusionConversationScope left, FusionConversationScope right) => !(left == right); /// - public override bool Equals(object? obj) => obj is UserMessageAgentMode other && Equals(other); + public override bool Equals(object? obj) => obj is FusionConversationScope other && Equals(other); /// - public bool Equals(UserMessageAgentMode other) => string.Equals(Value, other.Value, StringComparison.OrdinalIgnoreCase); + public bool Equals(FusionConversationScope other) => string.Equals(Value, other.Value, StringComparison.OrdinalIgnoreCase); /// public override int GetHashCode() => StringComparer.OrdinalIgnoreCase.GetHashCode(Value); @@ -8968,60 +12023,76 @@ 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 FusionConversationScope 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, FusionConversationScope value, JsonSerializerOptions options) { - GeneratedStringEnumJson.WriteValue(writer, value.Value, typeof(UserMessageAgentMode)); + GeneratedStringEnumJson.WriteValue(writer, value.Value, typeof(FusionConversationScope)); } } } -/// Why the binary data is absent: it exceeded the inline size limit, or its asset was unavailable. +/// HydraFusion phase kind. +[Experimental(Diagnostics.Experimental)] [JsonConverter(typeof(Converter))] [DebuggerDisplay("{Value,nq}")] -public readonly struct OmittedBinaryOmittedReason : IEquatable +public readonly struct FusionPhaseKind : 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 OmittedBinaryOmittedReason(string value) + public FusionPhaseKind(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; - /// Bytes exceeded the session's inline size limit. - public static OmittedBinaryOmittedReason TooLarge { get; } = new("too_large"); + /// Primary solver phase. + public static FusionPhaseKind Primary { get; } = new("primary"); - /// The referenced binary asset could not be found (e.g. a truncated log). - public static OmittedBinaryOmittedReason AssetUnavailable { get; } = new("asset_unavailable"); + /// Read-only cascade judge phase. + public static FusionPhaseKind Judge { get; } = new("judge"); - /// Returns a value indicating whether two instances are equivalent. - public static bool operator ==(OmittedBinaryOmittedReason left, OmittedBinaryOmittedReason right) => left.Equals(right); + /// Cascade repair phase. + public static FusionPhaseKind Repair { get; } = new("repair"); - /// Returns a value indicating whether two instances are not equivalent. - public static bool operator !=(OmittedBinaryOmittedReason left, OmittedBinaryOmittedReason right) => !(left == right); + /// Initial critique-pattern draft phase. + public static FusionPhaseKind Draft { get; } = new("draft"); + + /// Read-only critique phase. + public static FusionPhaseKind Critic { get; } = new("critic"); + + /// Critique-pattern revision phase. + public static FusionPhaseKind Revision { get; } = new("revision"); + + /// Follow-up phase continuing from the resolved model. + public static FusionPhaseKind FollowUp { get; } = new("follow_up"); + + /// Returns a value indicating whether two instances are equivalent. + public static bool operator ==(FusionPhaseKind left, FusionPhaseKind right) => left.Equals(right); + + /// Returns a value indicating whether two instances are not equivalent. + public static bool operator !=(FusionPhaseKind left, FusionPhaseKind right) => !(left == right); /// - public override bool Equals(object? obj) => obj is OmittedBinaryOmittedReason other && Equals(other); + public override bool Equals(object? obj) => obj is FusionPhaseKind other && Equals(other); /// - public bool Equals(OmittedBinaryOmittedReason other) => string.Equals(Value, other.Value, StringComparison.OrdinalIgnoreCase); + public bool Equals(FusionPhaseKind other) => string.Equals(Value, other.Value, StringComparison.OrdinalIgnoreCase); /// public override int GetHashCode() => StringComparer.OrdinalIgnoreCase.GetHashCode(Value); @@ -9029,63 +12100,64 @@ public OmittedBinaryOmittedReason(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 OmittedBinaryOmittedReason Read(ref Utf8JsonReader reader, Type typeToConvert, JsonSerializerOptions options) + public override FusionPhaseKind 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) + public override void Write(Utf8JsonWriter writer, FusionPhaseKind value, JsonSerializerOptions options) { - GeneratedStringEnumJson.WriteValue(writer, value.Value, typeof(OmittedBinaryOmittedReason)); + GeneratedStringEnumJson.WriteValue(writer, value.Value, typeof(FusionPhaseKind)); } } } -/// Type of GitHub reference. +/// How a durable phase checkpoint contributes its exact message to canonical root history. +[Experimental(Diagnostics.Experimental)] [JsonConverter(typeof(Converter))] [DebuggerDisplay("{Value,nq}")] -public readonly struct AttachmentGitHubReferenceType : IEquatable +public readonly struct FusionProjectionMode : 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 AttachmentGitHubReferenceType(string value) + public FusionProjectionMode(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 AttachmentGitHubReferenceType Issue { get; } = new("issue"); + /// Append the exact root message immediately. + public static FusionProjectionMode Append { get; } = new("append"); - /// GitHub pull request reference. - public static AttachmentGitHubReferenceType Pr { get; } = new("pr"); + /// Hold a terminal message outside canonical history until the final commit selects it. + public static FusionProjectionMode Staged { get; } = new("staged"); - /// GitHub discussion reference. - public static AttachmentGitHubReferenceType Discussion { get; } = new("discussion"); + /// Do not project the checkpoint into root history. + public static FusionProjectionMode None { get; } = new("none"); - /// 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 equivalent. + public static bool operator ==(FusionProjectionMode left, FusionProjectionMode right) => left.Equals(right); - /// Returns a value indicating whether two instances are not equivalent. - public static bool operator !=(AttachmentGitHubReferenceType left, AttachmentGitHubReferenceType right) => !(left == right); + /// Returns a value indicating whether two instances are not equivalent. + public static bool operator !=(FusionProjectionMode left, FusionProjectionMode right) => !(left == right); /// - public override bool Equals(object? obj) => obj is AttachmentGitHubReferenceType other && Equals(other); + public override bool Equals(object? obj) => obj is FusionProjectionMode other && Equals(other); /// - public bool Equals(AttachmentGitHubReferenceType other) => string.Equals(Value, other.Value, StringComparison.OrdinalIgnoreCase); + public bool Equals(FusionProjectionMode other) => string.Equals(Value, other.Value, StringComparison.OrdinalIgnoreCase); /// public override int GetHashCode() => StringComparer.OrdinalIgnoreCase.GetHashCode(Value); @@ -9093,63 +12165,64 @@ public AttachmentGitHubReferenceType(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 AttachmentGitHubReferenceType Read(ref Utf8JsonReader reader, Type typeToConvert, JsonSerializerOptions options) + public override FusionProjectionMode 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) + public override void Write(Utf8JsonWriter writer, FusionProjectionMode value, JsonSerializerOptions options) { - GeneratedStringEnumJson.WriteValue(writer, value.Value, typeof(AttachmentGitHubReferenceType)); + GeneratedStringEnumJson.WriteValue(writer, value.Value, typeof(FusionProjectionMode)); } } } -/// 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. +/// Durable outcome status of a HydraFusion phase. +[Experimental(Diagnostics.Experimental)] [JsonConverter(typeof(Converter))] [DebuggerDisplay("{Value,nq}")] -public readonly struct UserMessageDelivery : IEquatable +public readonly struct FusionPhaseStatus : 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 UserMessageDelivery(string value) + public FusionPhaseStatus(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; - /// 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"); + /// The phase completed successfully. + public static FusionPhaseStatus Succeeded { get; } = new("succeeded"); - /// Injected into the current in-flight run while the agent was busy (immediate mode). - public static UserMessageDelivery Steering { get; } = new("steering"); + /// The phase failed. + public static FusionPhaseStatus Failed { get; } = new("failed"); - /// Enqueued while the agent was busy; processed as its own run afterward. - public static UserMessageDelivery Queued { get; } = new("queued"); + /// The phase was cancelled. + public static FusionPhaseStatus Cancelled { get; } = new("cancelled"); - /// 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 equivalent. + public static bool operator ==(FusionPhaseStatus left, FusionPhaseStatus right) => left.Equals(right); - /// Returns a value indicating whether two instances are not equivalent. - public static bool operator !=(UserMessageDelivery left, UserMessageDelivery right) => !(left == right); + /// Returns a value indicating whether two instances are not equivalent. + public static bool operator !=(FusionPhaseStatus left, FusionPhaseStatus right) => !(left == right); /// - public override bool Equals(object? obj) => obj is UserMessageDelivery other && Equals(other); + public override bool Equals(object? obj) => obj is FusionPhaseStatus other && Equals(other); /// - public bool Equals(UserMessageDelivery other) => string.Equals(Value, other.Value, StringComparison.OrdinalIgnoreCase); + public bool Equals(FusionPhaseStatus other) => string.Equals(Value, other.Value, StringComparison.OrdinalIgnoreCase); /// public override int GetHashCode() => StringComparer.OrdinalIgnoreCase.GetHashCode(Value); @@ -9157,20 +12230,20 @@ public UserMessageDelivery(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 UserMessageDelivery Read(ref Utf8JsonReader reader, Type typeToConvert, JsonSerializerOptions options) + public override FusionPhaseStatus 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) + public override void Write(Utf8JsonWriter writer, FusionPhaseStatus value, JsonSerializerOptions options) { - GeneratedStringEnumJson.WriteValue(writer, value.Value, typeof(UserMessageDelivery)); + GeneratedStringEnumJson.WriteValue(writer, value.Value, typeof(FusionPhaseStatus)); } } } @@ -9368,6 +12441,67 @@ public override void Write(Utf8JsonWriter writer, AssistantUsageApiEndpoint valu } } +/// Transport used for a successful model call. +[JsonConverter(typeof(Converter))] +[DebuggerDisplay("{Value,nq}")] +public readonly struct AssistantUsageTransport : IEquatable +{ + private readonly string? _value; + + /// Initializes a new instance of the struct. + /// The value to associate with this . + [JsonConstructor] + public AssistantUsageTransport(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 AssistantUsageTransport Http { get; } = new("http"); + + /// WebSocket transport. + public static AssistantUsageTransport Websocket { get; } = new("websocket"); + + /// Returns a value indicating whether two instances are equivalent. + public static bool operator ==(AssistantUsageTransport left, AssistantUsageTransport right) => left.Equals(right); + + /// Returns a value indicating whether two instances are not equivalent. + public static bool operator !=(AssistantUsageTransport left, AssistantUsageTransport right) => !(left == right); + + /// + public override bool Equals(object? obj) => obj is AssistantUsageTransport other && Equals(other); + + /// + public bool Equals(AssistantUsageTransport 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 AssistantUsageTransport Read(ref Utf8JsonReader reader, Type typeToConvert, JsonSerializerOptions options) + { + return new(GeneratedStringEnumJson.ReadValue(ref reader, typeToConvert)); + } + + /// + public override void Write(Utf8JsonWriter writer, AssistantUsageTransport value, JsonSerializerOptions options) + { + GeneratedStringEnumJson.WriteValue(writer, value.Value, typeof(AssistantUsageTransport)); + } + } +} + /// 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}")] @@ -9554,42 +12688,48 @@ public override void Write(Utf8JsonWriter writer, ModelCallFailureSource value, } } -/// Transport used for a failed model call. +/// Final outcome of one logical model dispatch after response acceptance processing. [JsonConverter(typeof(Converter))] [DebuggerDisplay("{Value,nq}")] -public readonly struct ModelCallFailureTransport : IEquatable +public readonly struct ModelCallFinishedOutcome : 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 ModelCallFailureTransport(string value) + public ModelCallFinishedOutcome(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; - /// HTTP transport, including SSE streams. - public static ModelCallFailureTransport Http { get; } = new("http"); + /// The provider response was accepted for continued agent processing. + public static ModelCallFinishedOutcome Success { get; } = new("success"); - /// WebSocket transport. - public static ModelCallFailureTransport Websocket { get; } = new("websocket"); + /// The dispatch ended with a provider or transport error. + public static ModelCallFinishedOutcome Error { get; } = new("error"); - /// Returns a value indicating whether two instances are equivalent. - public static bool operator ==(ModelCallFailureTransport left, ModelCallFailureTransport right) => left.Equals(right); + /// The dispatch was cancelled before an accepted response was produced. + public static ModelCallFinishedOutcome Cancelled { get; } = new("cancelled"); - /// Returns a value indicating whether two instances are not equivalent. - public static bool operator !=(ModelCallFailureTransport left, ModelCallFailureTransport right) => !(left == right); + /// The provider response was rejected during post-response acceptance processing. + public static ModelCallFinishedOutcome Rejected { get; } = new("rejected"); + + /// Returns a value indicating whether two instances are equivalent. + public static bool operator ==(ModelCallFinishedOutcome left, ModelCallFinishedOutcome right) => left.Equals(right); + + /// Returns a value indicating whether two instances are not equivalent. + public static bool operator !=(ModelCallFinishedOutcome left, ModelCallFinishedOutcome right) => !(left == right); /// - public override bool Equals(object? obj) => obj is ModelCallFailureTransport other && Equals(other); + public override bool Equals(object? obj) => obj is ModelCallFinishedOutcome other && Equals(other); /// - public bool Equals(ModelCallFailureTransport other) => string.Equals(Value, other.Value, StringComparison.OrdinalIgnoreCase); + public bool Equals(ModelCallFinishedOutcome other) => string.Equals(Value, other.Value, StringComparison.OrdinalIgnoreCase); /// public override int GetHashCode() => StringComparer.OrdinalIgnoreCase.GetHashCode(Value); @@ -9597,20 +12737,20 @@ public ModelCallFailureTransport(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 ModelCallFailureTransport Read(ref Utf8JsonReader reader, Type typeToConvert, JsonSerializerOptions options) + public override ModelCallFinishedOutcome 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) + public override void Write(Utf8JsonWriter writer, ModelCallFinishedOutcome value, JsonSerializerOptions options) { - GeneratedStringEnumJson.WriteValue(writer, value.Value, typeof(ModelCallFailureTransport)); + GeneratedStringEnumJson.WriteValue(writer, value.Value, typeof(ModelCallFinishedOutcome)); } } } @@ -9643,6 +12783,9 @@ public AbortReason(string value) /// An MCP server delivered a user.abort notification. public static AbortReason UserAbort { get; } = new("user_abort"); + /// 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"); + /// Returns a value indicating whether two instances are equivalent. public static bool operator ==(AbortReason left, AbortReason right) => left.Equals(right); @@ -10076,14 +13219,264 @@ public SkillInvokedTrigger(string value) /// 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 !=(SkillInvokedTrigger left, SkillInvokedTrigger 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 SkillInvokedTrigger other && Equals(other); + + /// + public bool Equals(SkillInvokedTrigger 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 SkillInvokedTrigger 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) + { + GeneratedStringEnumJson.WriteValue(writer, value.Value, typeof(SkillInvokedTrigger)); + } + } +} + +/// Binary asset type discriminator. Use "image" for images and "resource" otherwise. +[JsonConverter(typeof(Converter))] +[DebuggerDisplay("{Value,nq}")] +public readonly struct BinaryAssetType : IEquatable +{ + private readonly string? _value; + + /// Initializes a new instance of the struct. + /// The value to associate with this . + [JsonConstructor] + public BinaryAssetType(string value) + { + ArgumentException.ThrowIfNullOrWhiteSpace(value); + _value = value; + } + + /// Gets the value associated with this . + public string Value => _value ?? string.Empty; + + /// Binary image data. + public static BinaryAssetType Image { get; } = new("image"); + + /// Other binary resource data. + public static BinaryAssetType Resource { get; } = new("resource"); + + /// 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 !=(BinaryAssetType left, BinaryAssetType right) => !(left == right); + + /// + public override bool Equals(object? obj) => obj is BinaryAssetType other && Equals(other); + + /// + public bool Equals(BinaryAssetType 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 BinaryAssetType Read(ref Utf8JsonReader reader, Type typeToConvert, JsonSerializerOptions options) + { + return new(GeneratedStringEnumJson.ReadValue(ref reader, typeToConvert)); + } + + /// + public override void Write(Utf8JsonWriter writer, BinaryAssetType value, JsonSerializerOptions options) + { + GeneratedStringEnumJson.WriteValue(writer, value.Value, typeof(BinaryAssetType)); + } + } +} + +/// Message role: "system" for system prompts, "developer" for developer-injected instructions. +[JsonConverter(typeof(Converter))] +[DebuggerDisplay("{Value,nq}")] +public readonly struct SystemMessageRole : IEquatable +{ + private readonly string? _value; + + /// Initializes a new instance of the struct. + /// The value to associate with this . + [JsonConstructor] + public SystemMessageRole(string value) + { + ArgumentException.ThrowIfNullOrWhiteSpace(value); + _value = value; + } + + /// Gets the value associated with this . + public string Value => _value ?? string.Empty; + + /// System prompt message. + public static SystemMessageRole System { get; } = new("system"); + + /// Developer instruction message. + public static SystemMessageRole Developer { get; } = new("developer"); + + /// 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 !=(SystemMessageRole left, SystemMessageRole right) => !(left == right); + + /// + public override bool Equals(object? obj) => obj is SystemMessageRole other && Equals(other); + + /// + public bool Equals(SystemMessageRole 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 SystemMessageRole 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) + { + GeneratedStringEnumJson.WriteValue(writer, value.Value, typeof(SystemMessageRole)); + } + } +} + +/// Whether the agent completed successfully or failed. +[JsonConverter(typeof(Converter))] +[DebuggerDisplay("{Value,nq}")] +public readonly struct SystemNotificationAgentCompletedStatus : IEquatable +{ + private readonly string? _value; + + /// Initializes a new instance of the struct. + /// The value to associate with this . + [JsonConstructor] + public SystemNotificationAgentCompletedStatus(string value) + { + ArgumentException.ThrowIfNullOrWhiteSpace(value); + _value = value; + } + + /// Gets the value associated with this . + public string Value => _value ?? string.Empty; + + /// The agent completed successfully. + public static SystemNotificationAgentCompletedStatus Completed { get; } = new("completed"); + + /// The agent failed. + public static SystemNotificationAgentCompletedStatus Failed { get; } = new("failed"); + + /// 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 !=(SystemNotificationAgentCompletedStatus left, SystemNotificationAgentCompletedStatus right) => !(left == right); + + /// + public override bool Equals(object? obj) => obj is SystemNotificationAgentCompletedStatus other && Equals(other); + + /// + public bool Equals(SystemNotificationAgentCompletedStatus 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 SystemNotificationAgentCompletedStatus 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) + { + GeneratedStringEnumJson.WriteValue(writer, value.Value, typeof(SystemNotificationAgentCompletedStatus)); + } + } +} + +/// Terminal status reached by a factory execution attempt. +[JsonConverter(typeof(Converter))] +[DebuggerDisplay("{Value,nq}")] +public readonly struct SystemNotificationFactoryCompletedStatus : IEquatable +{ + private readonly string? _value; + + /// Initializes a new instance of the struct. + /// The value to associate with this . + [JsonConstructor] + public SystemNotificationFactoryCompletedStatus(string value) + { + ArgumentException.ThrowIfNullOrWhiteSpace(value); + _value = value; + } + + /// Gets the value associated with this . + public string Value => _value ?? string.Empty; + + /// The factory completed successfully. + public static SystemNotificationFactoryCompletedStatus Completed { get; } = new("completed"); + + /// The factory was halted. + public static SystemNotificationFactoryCompletedStatus Halted { get; } = new("halted"); + + /// The factory was cancelled. + public static SystemNotificationFactoryCompletedStatus Cancelled { get; } = new("cancelled"); + + /// 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 SkillInvokedTrigger other && Equals(other); + public override bool Equals(object? obj) => obj is SystemNotificationFactoryCompletedStatus other && Equals(other); /// - public bool Equals(SkillInvokedTrigger 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); @@ -10091,60 +13484,58 @@ 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 SystemNotificationFactoryCompletedStatus 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, SystemNotificationFactoryCompletedStatus value, JsonSerializerOptions options) { - GeneratedStringEnumJson.WriteValue(writer, value.Value, typeof(SkillInvokedTrigger)); + GeneratedStringEnumJson.WriteValue(writer, value.Value, typeof(SystemNotificationFactoryCompletedStatus)); } } } -/// Binary asset type discriminator. Use "image" for images and "resource" otherwise. +/// Advisory recommendation the runtime attaches to a permission request whose origin it can vouch for by construction. Unlike the auto-approval judge this does not depend on auto mode and does not evaluate what the tool call does; its absence simply means the runtime has no opinion and the request follows the host's normal approval flow. +[Experimental(Diagnostics.Experimental)] [JsonConverter(typeof(Converter))] [DebuggerDisplay("{Value,nq}")] -public readonly struct BinaryAssetType : IEquatable +public readonly struct PermissionRecommendation : 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 BinaryAssetType(string value) + public PermissionRecommendation(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; - /// Binary image data. - public static BinaryAssetType Image { get; } = new("image"); - - /// Other binary resource data. - public static BinaryAssetType Resource { get; } = new("resource"); + /// The runtime vouches for the request's origin and recommends approving it without prompting. The host still owns the decision and may deny it; deny rules, managed policy, and the auto-approval safety judge all outrank this recommendation. + public static PermissionRecommendation Approve { get; } = new("approve"); - /// 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 equivalent. + public static bool operator ==(PermissionRecommendation left, PermissionRecommendation right) => left.Equals(right); - /// Returns a value indicating whether two instances are not equivalent. - public static bool operator !=(BinaryAssetType left, BinaryAssetType right) => !(left == right); + /// Returns a value indicating whether two instances are not equivalent. + public static bool operator !=(PermissionRecommendation left, PermissionRecommendation right) => !(left == right); /// - public override bool Equals(object? obj) => obj is BinaryAssetType other && Equals(other); + public override bool Equals(object? obj) => obj is PermissionRecommendation other && Equals(other); /// - public bool Equals(BinaryAssetType other) => string.Equals(Value, other.Value, StringComparison.OrdinalIgnoreCase); + public bool Equals(PermissionRecommendation other) => string.Equals(Value, other.Value, StringComparison.OrdinalIgnoreCase); /// public override int GetHashCode() => StringComparer.OrdinalIgnoreCase.GetHashCode(Value); @@ -10152,60 +13543,60 @@ public BinaryAssetType(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 BinaryAssetType Read(ref Utf8JsonReader reader, Type typeToConvert, JsonSerializerOptions options) + public override PermissionRecommendation Read(ref Utf8JsonReader reader, Type typeToConvert, JsonSerializerOptions options) { return new(GeneratedStringEnumJson.ReadValue(ref reader, typeToConvert)); } /// - public override void Write(Utf8JsonWriter writer, BinaryAssetType value, JsonSerializerOptions options) + public override void Write(Utf8JsonWriter writer, PermissionRecommendation value, JsonSerializerOptions options) { - GeneratedStringEnumJson.WriteValue(writer, value.Value, typeof(BinaryAssetType)); + GeneratedStringEnumJson.WriteValue(writer, value.Value, typeof(PermissionRecommendation)); } } } -/// Message role: "system" for system prompts, "developer" for developer-injected instructions. +/// Whether this is a store or vote memory operation. [JsonConverter(typeof(Converter))] [DebuggerDisplay("{Value,nq}")] -public readonly struct SystemMessageRole : 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 SystemMessageRole(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; - /// System prompt message. - public static SystemMessageRole System { get; } = new("system"); + /// Store a new memory. + public static PermissionRequestMemoryAction Store { get; } = new("store"); - /// Developer instruction message. - public static SystemMessageRole Developer { get; } = new("developer"); + /// 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 ==(SystemMessageRole left, SystemMessageRole 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 !=(SystemMessageRole left, SystemMessageRole 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 SystemMessageRole other && Equals(other); + public override bool Equals(object? obj) => obj is PermissionRequestMemoryAction other && Equals(other); /// - public bool Equals(SystemMessageRole 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); @@ -10213,60 +13604,70 @@ 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 PermissionRequestMemoryAction 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, PermissionRequestMemoryAction value, JsonSerializerOptions options) { - GeneratedStringEnumJson.WriteValue(writer, value.Value, typeof(SystemMessageRole)); + GeneratedStringEnumJson.WriteValue(writer, value.Value, typeof(PermissionRequestMemoryAction)); } } } -/// Whether the agent completed successfully or failed. +/// Why the assisted-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 SystemNotificationAgentCompletedStatus : IEquatable +public readonly struct AssistedApprovalJudgeFailureReason : 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 AssistedApprovalJudgeFailureReason(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 judge model call exceeded its deadline. + public static AssistedApprovalJudgeFailureReason Timeout { get; } = new("timeout"); - /// The agent failed. - public static SystemNotificationAgentCompletedStatus Failed { get; } = new("failed"); + /// The judge model call was cancelled before it returned. + public static AssistedApprovalJudgeFailureReason Abort { get; } = new("abort"); - /// Returns a value indicating whether two instances are equivalent. - public static bool operator ==(SystemNotificationAgentCompletedStatus left, SystemNotificationAgentCompletedStatus right) => left.Equals(right); + /// The judge model call completed but returned no content. + public static AssistedApprovalJudgeFailureReason EmptyResponse { get; } = new("empty_response"); - /// Returns a value indicating whether two instances are not equivalent. - public static bool operator !=(SystemNotificationAgentCompletedStatus left, SystemNotificationAgentCompletedStatus right) => !(left == right); + /// The judge model call failed (for example a transport, authentication, or rate-limit error). + public static AssistedApprovalJudgeFailureReason ModelError { get; } = new("model_error"); + + /// The judge model replied, but the reply carried no ALLOW/DENY verdict. + public static AssistedApprovalJudgeFailureReason ParseError { get; } = new("parse_error"); + + /// Returns a value indicating whether two instances are equivalent. + public static bool operator ==(AssistedApprovalJudgeFailureReason left, AssistedApprovalJudgeFailureReason right) => left.Equals(right); + + /// Returns a value indicating whether two instances are not equivalent. + public static bool operator !=(AssistedApprovalJudgeFailureReason left, AssistedApprovalJudgeFailureReason right) => !(left == right); /// - public override bool Equals(object? obj) => obj is SystemNotificationAgentCompletedStatus other && Equals(other); + public override bool Equals(object? obj) => obj is AssistedApprovalJudgeFailureReason other && Equals(other); /// - public bool Equals(SystemNotificationAgentCompletedStatus other) => string.Equals(Value, other.Value, StringComparison.OrdinalIgnoreCase); + public bool Equals(AssistedApprovalJudgeFailureReason other) => string.Equals(Value, other.Value, StringComparison.OrdinalIgnoreCase); /// public override int GetHashCode() => StringComparer.OrdinalIgnoreCase.GetHashCode(Value); @@ -10274,60 +13675,67 @@ 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 AssistedApprovalJudgeFailureReason 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, AssistedApprovalJudgeFailureReason value, JsonSerializerOptions options) { - GeneratedStringEnumJson.WriteValue(writer, value.Value, typeof(SystemNotificationAgentCompletedStatus)); + GeneratedStringEnumJson.WriteValue(writer, value.Value, typeof(AssistedApprovalJudgeFailureReason)); } } } -/// Whether this is a store or vote memory operation. +/// Outcome of the assisted-approval safety judge for a permission request. Present only in assisted mode; its absence means the judge did not evaluate the request. +[Experimental(Diagnostics.Experimental)] [JsonConverter(typeof(Converter))] [DebuggerDisplay("{Value,nq}")] -public readonly struct PermissionRequestMemoryAction : IEquatable +public readonly struct AssistedApprovalRecommendation : 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 AssistedApprovalRecommendation(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"); + /// The judge evaluated the request and recommends automatically approving it. + public static AssistedApprovalRecommendation Approve { get; } = new("approve"); - /// Vote on an existing memory. - public static PermissionRequestMemoryAction Vote { get; } = new("vote"); + /// The judge evaluated the request and does not recommend automatically approving it; explicit approval is required. Whether that means prompting, denying, or something else is the consumer's decision. + public static AssistedApprovalRecommendation RequireApproval { get; } = new("requireApproval"); - /// Returns a value indicating whether two instances are equivalent. - public static bool operator ==(PermissionRequestMemoryAction left, PermissionRequestMemoryAction right) => left.Equals(right); + /// Assisted mode is enabled, but this request category is never automatically approvable (for example, sandbox-bypass requests), so the judge was not consulted. + public static AssistedApprovalRecommendation Excluded { get; } = new("excluded"); - /// Returns a value indicating whether two instances are not equivalent. - public static bool operator !=(PermissionRequestMemoryAction left, PermissionRequestMemoryAction right) => !(left == right); + /// The judge was consulted but did not return a usable recommendation, so the request requires explicit approval. + public static AssistedApprovalRecommendation Error { get; } = new("error"); + + /// Returns a value indicating whether two instances are equivalent. + public static bool operator ==(AssistedApprovalRecommendation left, AssistedApprovalRecommendation right) => left.Equals(right); + + /// Returns a value indicating whether two instances are not equivalent. + public static bool operator !=(AssistedApprovalRecommendation left, AssistedApprovalRecommendation right) => !(left == right); /// - public override bool Equals(object? obj) => obj is PermissionRequestMemoryAction other && Equals(other); + public override bool Equals(object? obj) => obj is AssistedApprovalRecommendation other && Equals(other); /// - public bool Equals(PermissionRequestMemoryAction other) => string.Equals(Value, other.Value, StringComparison.OrdinalIgnoreCase); + public bool Equals(AssistedApprovalRecommendation other) => string.Equals(Value, other.Value, StringComparison.OrdinalIgnoreCase); /// public override int GetHashCode() => StringComparer.OrdinalIgnoreCase.GetHashCode(Value); @@ -10335,20 +13743,20 @@ 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 AssistedApprovalRecommendation 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, AssistedApprovalRecommendation value, JsonSerializerOptions options) { - GeneratedStringEnumJson.WriteValue(writer, value.Value, typeof(PermissionRequestMemoryAction)); + GeneratedStringEnumJson.WriteValue(writer, value.Value, typeof(AssistedApprovalRecommendation)); } } } @@ -10414,49 +13822,103 @@ public override void Write(Utf8JsonWriter writer, PermissionRequestMemoryDirecti } } -/// 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)] +/// Scope of a stored memory. [JsonConverter(typeof(Converter))] [DebuggerDisplay("{Value,nq}")] -public readonly struct AutoApprovalRecommendation : IEquatable +public readonly struct PermissionRequestMemoryScope : 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 AutoApprovalRecommendation(string value) + public PermissionRequestMemoryScope(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 judge evaluated the request and recommends automatically approving it. - public static AutoApprovalRecommendation Approve { get; } = new("approve"); + /// Store the memory for the current repository. + public static PermissionRequestMemoryScope Repository { get; } = new("repository"); - /// 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"); + /// Store the memory for the current user. + public static PermissionRequestMemoryScope User { get; } = new("user"); - /// 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"); + /// Returns a value indicating whether two instances are equivalent. + public static bool operator ==(PermissionRequestMemoryScope left, PermissionRequestMemoryScope right) => left.Equals(right); - /// 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 not equivalent. + public static bool operator !=(PermissionRequestMemoryScope left, PermissionRequestMemoryScope right) => !(left == right); - /// Returns a value indicating whether two instances are equivalent. - public static bool operator ==(AutoApprovalRecommendation left, AutoApprovalRecommendation right) => left.Equals(right); + /// + public override bool Equals(object? obj) => obj is PermissionRequestMemoryScope other && Equals(other); + + /// + public bool Equals(PermissionRequestMemoryScope 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 PermissionRequestMemoryScope Read(ref Utf8JsonReader reader, Type typeToConvert, JsonSerializerOptions options) + { + return new(GeneratedStringEnumJson.ReadValue(ref reader, typeToConvert)); + } + + /// + public override void Write(Utf8JsonWriter writer, PermissionRequestMemoryScope value, JsonSerializerOptions options) + { + GeneratedStringEnumJson.WriteValue(writer, value.Value, typeof(PermissionRequestMemoryScope)); + } + } +} + +/// Operation gated by a factory permission request. +[JsonConverter(typeof(Converter))] +[DebuggerDisplay("{Value,nq}")] +public readonly struct FactoryPermissionOperation : IEquatable +{ + private readonly string? _value; + + /// Initializes a new instance of the struct. + /// The value to associate with this . + [JsonConstructor] + public FactoryPermissionOperation(string value) + { + ArgumentException.ThrowIfNullOrWhiteSpace(value); + _value = value; + } + + /// Gets the value associated with this . + public string Value => _value ?? string.Empty; + + /// Running a registered factory, which spends subagents, active time, and AI credits under the approved limits. + public static FactoryPermissionOperation Run { get; } = new("run"); - /// Returns a value indicating whether two instances are not equivalent. - public static bool operator !=(AutoApprovalRecommendation left, AutoApprovalRecommendation right) => !(left == right); + /// 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 ==(FactoryPermissionOperation left, FactoryPermissionOperation right) => left.Equals(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 AutoApprovalRecommendation other && Equals(other); + public override bool Equals(object? obj) => obj is FactoryPermissionOperation other && Equals(other); /// - public bool Equals(AutoApprovalRecommendation 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); @@ -10464,20 +13926,20 @@ public AutoApprovalRecommendation(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 AutoApprovalRecommendation 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, AutoApprovalRecommendation value, JsonSerializerOptions options) + public override void Write(Utf8JsonWriter writer, FactoryPermissionOperation value, JsonSerializerOptions options) { - GeneratedStringEnumJson.WriteValue(writer, value.Value, typeof(AutoApprovalRecommendation)); + GeneratedStringEnumJson.WriteValue(writer, value.Value, typeof(FactoryPermissionOperation)); } } } @@ -10927,6 +14389,77 @@ public override void Write(Utf8JsonWriter writer, McpHeadersRefreshCompletedOutc } } +/// Lifecycle phase for a Rust-owned ephemeral query stream. +[Experimental(Diagnostics.Experimental)] +[JsonConverter(typeof(Converter))] +[DebuggerDisplay("{Value,nq}")] +public readonly struct UIEphemeralQueryPhase : IEquatable +{ + private readonly string? _value; + + /// Initializes a new instance of the struct. + /// The value to associate with this . + [JsonConstructor] + public UIEphemeralQueryPhase(string value) + { + ArgumentException.ThrowIfNullOrWhiteSpace(value); + _value = value; + } + + /// Gets the value associated with this . + public string Value => _value ?? string.Empty; + + /// The ephemeral query stream has begun. + public static UIEphemeralQueryPhase Started { get; } = new("started"); + + /// A partial result chunk was produced by the stream. + public static UIEphemeralQueryPhase Chunk { get; } = new("chunk"); + + /// The ephemeral query stream finished successfully. + public static UIEphemeralQueryPhase Completed { get; } = new("completed"); + + /// The ephemeral query stream ended with an error. + public static UIEphemeralQueryPhase Failed { get; } = new("failed"); + + /// The ephemeral query stream was cancelled before completing. + public static UIEphemeralQueryPhase Aborted { get; } = new("aborted"); + + /// Returns a value indicating whether two instances are equivalent. + public static bool operator ==(UIEphemeralQueryPhase left, UIEphemeralQueryPhase right) => left.Equals(right); + + /// Returns a value indicating whether two instances are not equivalent. + public static bool operator !=(UIEphemeralQueryPhase left, UIEphemeralQueryPhase right) => !(left == right); + + /// + public override bool Equals(object? obj) => obj is UIEphemeralQueryPhase other && Equals(other); + + /// + public bool Equals(UIEphemeralQueryPhase 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 UIEphemeralQueryPhase Read(ref Utf8JsonReader reader, Type typeToConvert, JsonSerializerOptions options) + { + return new(GeneratedStringEnumJson.ReadValue(ref reader, typeToConvert)); + } + + /// + public override void Write(Utf8JsonWriter writer, UIEphemeralQueryPhase value, JsonSerializerOptions options) + { + GeneratedStringEnumJson.WriteValue(writer, value.Value, typeof(UIEphemeralQueryPhase)); + } + } +} + /// The user's auto-mode-switch choice. [JsonConverter(typeof(Converter))] [DebuggerDisplay("{Value,nq}")] @@ -11122,7 +14655,7 @@ public override void Write(Utf8JsonWriter writer, AutoModeResolvedReasoningBucke } } -/// Which channel supplied the effective enterprise managed settings (highest-authority present layer wins wholesale). +/// 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 ManagedSettingsResolvedSource : IEquatable @@ -11141,13 +14674,19 @@ public ManagedSettingsResolvedSource(string value) /// Gets the value associated with this . public string Value => _value ?? string.Empty; - /// Account/org policy self-fetched from the GitHub managed-settings endpoint (higher authority). + /// Only the server/account channel contributed. public static ManagedSettingsResolvedSource Server { get; } = new("server"); - /// Device-level MDM policy discovered from plist/registry/file (lower authority). + /// Only the device MDM/plist/registry/file channel contributed. public static ManagedSettingsResolvedSource Device { get; } = new("device"); - /// No managed policy is in force (no layer contributed). + /// Only session-local SDK-host injection contributed. + public static ManagedSettingsResolvedSource Client { get; } = new("client"); + + /// 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. @@ -11263,14 +14802,14 @@ public ManagedSettingsEnforcedEscalation(string value) /// Gets the value associated with this . public string Value => _value ?? string.Empty; - /// Full allow-all ("/allow-all on") permissions β€” auto-approving tools, paths, and URLs. + /// Full allow-all permissions β€” automatically approving tools, paths, and URLs. public static ManagedSettingsEnforcedEscalation AllowAll { get; } = new("allow_all"); - /// Auto-approval of all tool permission requests. + /// Automatic approval of all tool permission requests. public static ManagedSettingsEnforcedEscalation ApproveAll { get; } = new("approve_all"); - /// 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"); + /// Assisted mode β€” keeps normal prompt paths and adds an LLM recommendation, distinct from allow-all. + public static ManagedSettingsEnforcedEscalation AssistedApproval { get; } = new("assisted_approval"); /// Unrestricted filesystem access outside the session's allowed directories. public static ManagedSettingsEnforcedEscalation UnrestrictedPaths { get; } = new("unrestricted_paths"); @@ -11278,6 +14817,9 @@ public ManagedSettingsEnforcedEscalation(string value) /// Unrestricted URL fetch access. public static ManagedSettingsEnforcedEscalation UnrestrictedUrls { get; } = new("unrestricted_urls"); + /// A server-wide MCP "Always Allow" (or `--allow-tool <server>`) blanket that would auto-approve every tool from an MCP server. Capped to per-tool approval; each tool still prompts. + public static ManagedSettingsEnforcedEscalation ServerWideMcpApproval { get; } = new("server_wide_mcp_approval"); + /// Returns a value indicating whether two instances are equivalent. public static bool operator ==(ManagedSettingsEnforcedEscalation left, ManagedSettingsEnforcedEscalation right) => left.Equals(right); @@ -11381,6 +14923,73 @@ public override void Write(Utf8JsonWriter writer, ExitPlanModeAction value, Json } } +/// Terminal status a factory run committed. A settled run is never `pending` or `running`, so those two members of the run-status domain are deliberately absent. +[JsonConverter(typeof(Converter))] +[DebuggerDisplay("{Value,nq}")] +public readonly struct FactoryRunSettledStatus : IEquatable +{ + private readonly string? _value; + + /// Initializes a new instance of the struct. + /// The value to associate with this . + [JsonConstructor] + public FactoryRunSettledStatus(string value) + { + ArgumentException.ThrowIfNullOrWhiteSpace(value); + _value = value; + } + + /// Gets the value associated with this . + public string Value => _value ?? string.Empty; + + /// The factory body resolved and its result was committed. + public static FactoryRunSettledStatus Completed { get; } = new("completed"); + + /// The run was stopped by a limit, an approval refusal or another policy decision. + public static FactoryRunSettledStatus Halted { get; } = new("halted"); + + /// The run was cancelled by its caller or by session disposal. + public static FactoryRunSettledStatus Cancelled { get; } = new("cancelled"); + + /// The run failed, with `failureType` carrying the class when it has one. + public static FactoryRunSettledStatus Error { get; } = new("error"); + + /// Returns a value indicating whether two instances are equivalent. + public static bool operator ==(FactoryRunSettledStatus left, FactoryRunSettledStatus right) => left.Equals(right); + + /// Returns a value indicating whether two instances are not equivalent. + public static bool operator !=(FactoryRunSettledStatus left, FactoryRunSettledStatus right) => !(left == right); + + /// + public override bool Equals(object? obj) => obj is FactoryRunSettledStatus other && Equals(other); + + /// + public bool Equals(FactoryRunSettledStatus 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 FactoryRunSettledStatus Read(ref Utf8JsonReader reader, Type typeToConvert, JsonSerializerOptions options) + { + return new(GeneratedStringEnumJson.ReadValue(ref reader, typeToConvert)); + } + + /// + public override void Write(Utf8JsonWriter writer, FactoryRunSettledStatus value, JsonSerializerOptions options) + { + GeneratedStringEnumJson.WriteValue(writer, value.Value, typeof(FactoryRunSettledStatus)); + } + } +} + /// Source location type (e.g., project, personal-copilot, plugin, builtin). [JsonConverter(typeof(Converter))] [DebuggerDisplay("{Value,nq}")] @@ -11524,7 +15133,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 @@ -11558,6 +15167,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"); @@ -11805,6 +15417,14 @@ public override void Write(Utf8JsonWriter writer, ExtensionsLoadedExtensionStatu DefaultIgnoreCondition = JsonIgnoreCondition.WhenWritingNull)] [JsonSerializable(typeof(AbortData))] [JsonSerializable(typeof(AbortEvent))] +[JsonSerializable(typeof(AgentInterruptedData))] +[JsonSerializable(typeof(AgentInterruptedEvent))] +[JsonSerializable(typeof(AssistantFusionPhaseCompletedData))] +[JsonSerializable(typeof(AssistantFusionPhaseCompletedEvent))] +[JsonSerializable(typeof(AssistantFusionPhaseFailedData))] +[JsonSerializable(typeof(AssistantFusionPhaseFailedEvent))] +[JsonSerializable(typeof(AssistantFusionPhaseStartedData))] +[JsonSerializable(typeof(AssistantFusionPhaseStartedEvent))] [JsonSerializable(typeof(AssistantIdleData))] [JsonSerializable(typeof(AssistantIdleEvent))] [JsonSerializable(typeof(AssistantIntentData))] @@ -11813,6 +15433,7 @@ public override void Write(Utf8JsonWriter writer, ExtensionsLoadedExtensionStatu [JsonSerializable(typeof(AssistantMessageDeltaData))] [JsonSerializable(typeof(AssistantMessageDeltaEvent))] [JsonSerializable(typeof(AssistantMessageEvent))] +[JsonSerializable(typeof(AssistantMessageReasoningBlocks))] [JsonSerializable(typeof(AssistantMessageServerTools))] [JsonSerializable(typeof(AssistantMessageStartData))] [JsonSerializable(typeof(AssistantMessageStartEvent))] @@ -11908,6 +15529,19 @@ public override void Write(Utf8JsonWriter writer, ExtensionsLoadedExtensionStatu [JsonSerializable(typeof(ExternalToolCompletedEvent))] [JsonSerializable(typeof(ExternalToolRequestedData))] [JsonSerializable(typeof(ExternalToolRequestedEvent))] +[JsonSerializable(typeof(FactoryPermissionPhase))] +[JsonSerializable(typeof(FactoryRunSettledData))] +[JsonSerializable(typeof(FactoryRunSettledEvent))] +[JsonSerializable(typeof(FactoryRunStartedData))] +[JsonSerializable(typeof(FactoryRunStartedEvent))] +[JsonSerializable(typeof(FactoryRunUpdatedData))] +[JsonSerializable(typeof(FactoryRunUpdatedEvent))] +[JsonSerializable(typeof(FusionAttribution))] +[JsonSerializable(typeof(FusionFollowUpRecommendation))] +[JsonSerializable(typeof(FusionPhaseUsage))] +[JsonSerializable(typeof(FusionScores))] +[JsonSerializable(typeof(FusionStagedTerminal))] +[JsonSerializable(typeof(GitHubMcpToolConfig))] [JsonSerializable(typeof(GitHubRepoRef))] [JsonSerializable(typeof(HandoffRepository))] [JsonSerializable(typeof(HeaderEntry))] @@ -11944,19 +15578,23 @@ public override void Write(Utf8JsonWriter writer, ExtensionsLoadedExtensionStatu [JsonSerializable(typeof(ModelCallFailureData))] [JsonSerializable(typeof(ModelCallFailureEvent))] [JsonSerializable(typeof(ModelCallFailureRequestFingerprint))] +[JsonSerializable(typeof(ModelCallFinishedData))] +[JsonSerializable(typeof(ModelCallFinishedEvent))] [JsonSerializable(typeof(ModelCallStartData))] [JsonSerializable(typeof(ModelCallStartEvent))] [JsonSerializable(typeof(OmittedBinaryResult))] [JsonSerializable(typeof(PendingMessagesModifiedData))] [JsonSerializable(typeof(PendingMessagesModifiedEvent))] -[JsonSerializable(typeof(PermissionAutoApproval))] +[JsonSerializable(typeof(PermissionAssistedApproval))] [JsonSerializable(typeof(PermissionCompletedData))] [JsonSerializable(typeof(PermissionCompletedEvent))] [JsonSerializable(typeof(PermissionPromptRequest))] [JsonSerializable(typeof(PermissionPromptRequestCommands))] [JsonSerializable(typeof(PermissionPromptRequestCustomTool))] +[JsonSerializable(typeof(PermissionPromptRequestExtensionEnvAccess))] [JsonSerializable(typeof(PermissionPromptRequestExtensionManagement))] [JsonSerializable(typeof(PermissionPromptRequestExtensionPermissionAccess))] +[JsonSerializable(typeof(PermissionPromptRequestFactory))] [JsonSerializable(typeof(PermissionPromptRequestHook))] [JsonSerializable(typeof(PermissionPromptRequestMcp))] [JsonSerializable(typeof(PermissionPromptRequestMemory))] @@ -11966,14 +15604,17 @@ public override void Write(Utf8JsonWriter writer, ExtensionsLoadedExtensionStatu [JsonSerializable(typeof(PermissionPromptRequestWrite))] [JsonSerializable(typeof(PermissionRequest))] [JsonSerializable(typeof(PermissionRequestCustomTool))] +[JsonSerializable(typeof(PermissionRequestExtensionEnvAccess))] [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))] @@ -11992,10 +15633,14 @@ public override void Write(Utf8JsonWriter writer, ExtensionsLoadedExtensionStatu [JsonSerializable(typeof(PermissionRule))] [JsonSerializable(typeof(PersistedBinaryImage))] [JsonSerializable(typeof(PersistedBinaryResult))] +[JsonSerializable(typeof(PromptCacheBreakData))] +[JsonSerializable(typeof(PromptCacheBreakEvent))] [JsonSerializable(typeof(SamplingCompletedData))] [JsonSerializable(typeof(SamplingCompletedEvent))] [JsonSerializable(typeof(SamplingRequestedData))] [JsonSerializable(typeof(SamplingRequestedEvent))] +[JsonSerializable(typeof(SandboxDecisionData))] +[JsonSerializable(typeof(SandboxDecisionEvent))] [JsonSerializable(typeof(SessionAutoModeResolvedData))] [JsonSerializable(typeof(SessionAutoModeResolvedEvent))] [JsonSerializable(typeof(SessionAutopilotObjectiveChangedData))] @@ -12022,6 +15667,8 @@ public override void Write(Utf8JsonWriter writer, ExtensionsLoadedExtensionStatu [JsonSerializable(typeof(SessionCompactionStartEvent))] [JsonSerializable(typeof(SessionContextChangedData))] [JsonSerializable(typeof(SessionContextChangedEvent))] +[JsonSerializable(typeof(SessionContextClearedData))] +[JsonSerializable(typeof(SessionContextClearedEvent))] [JsonSerializable(typeof(SessionCustomAgentsUpdatedData))] [JsonSerializable(typeof(SessionCustomAgentsUpdatedEvent))] [JsonSerializable(typeof(SessionCustomNotificationData))] @@ -12033,6 +15680,14 @@ public override void Write(Utf8JsonWriter writer, ExtensionsLoadedExtensionStatu [JsonSerializable(typeof(SessionExtensionsAttachmentsPushedEvent))] [JsonSerializable(typeof(SessionExtensionsLoadedData))] [JsonSerializable(typeof(SessionExtensionsLoadedEvent))] +[JsonSerializable(typeof(SessionFusionCompletedData))] +[JsonSerializable(typeof(SessionFusionCompletedEvent))] +[JsonSerializable(typeof(SessionFusionResolvedData))] +[JsonSerializable(typeof(SessionFusionResolvedEvent))] +[JsonSerializable(typeof(SessionFusionRouteFailedData))] +[JsonSerializable(typeof(SessionFusionRouteFailedEvent))] +[JsonSerializable(typeof(SessionFusionRouteStartedData))] +[JsonSerializable(typeof(SessionFusionRouteStartedEvent))] [JsonSerializable(typeof(SessionHandoffData))] [JsonSerializable(typeof(SessionHandoffEvent))] [JsonSerializable(typeof(SessionIdleData))] @@ -12099,6 +15754,7 @@ public override void Write(Utf8JsonWriter writer, ExtensionsLoadedExtensionStatu [JsonSerializable(typeof(SessionWarningEvent))] [JsonSerializable(typeof(SessionWorkspaceFileChangedData))] [JsonSerializable(typeof(SessionWorkspaceFileChangedEvent))] +[JsonSerializable(typeof(ShutdownAgentMetric))] [JsonSerializable(typeof(ShutdownCodeChanges))] [JsonSerializable(typeof(ShutdownModelMetric))] [JsonSerializable(typeof(ShutdownModelMetricRequests))] @@ -12110,6 +15766,8 @@ public override void Write(Utf8JsonWriter writer, ExtensionsLoadedExtensionStatu [JsonSerializable(typeof(SkillsLoadedSkill))] [JsonSerializable(typeof(SubagentCompletedData))] [JsonSerializable(typeof(SubagentCompletedEvent))] +[JsonSerializable(typeof(SubagentConfiguredData))] +[JsonSerializable(typeof(SubagentConfiguredEvent))] [JsonSerializable(typeof(SubagentDeselectedData))] [JsonSerializable(typeof(SubagentDeselectedEvent))] [JsonSerializable(typeof(SubagentFailedData))] @@ -12126,10 +15784,12 @@ public override void Write(Utf8JsonWriter writer, ExtensionsLoadedExtensionStatu [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))] @@ -12170,6 +15830,8 @@ public override void Write(Utf8JsonWriter writer, ExtensionsLoadedExtensionStatu [JsonSerializable(typeof(ToolSearchActivatedEvent))] [JsonSerializable(typeof(ToolUserRequestedData))] [JsonSerializable(typeof(ToolUserRequestedEvent))] +[JsonSerializable(typeof(UiEphemeralQueryData))] +[JsonSerializable(typeof(UiEphemeralQueryEvent))] [JsonSerializable(typeof(UsageCheckpointModelCacheState))] [JsonSerializable(typeof(UserInputCompletedData))] [JsonSerializable(typeof(UserInputCompletedEvent))] @@ -12180,8 +15842,10 @@ public override void Write(Utf8JsonWriter writer, ExtensionsLoadedExtensionStatu [JsonSerializable(typeof(UserToolSessionApproval))] [JsonSerializable(typeof(UserToolSessionApprovalCommands))] [JsonSerializable(typeof(UserToolSessionApprovalCustomTool))] +[JsonSerializable(typeof(UserToolSessionApprovalExtensionEnvAccess))] [JsonSerializable(typeof(UserToolSessionApprovalExtensionManagement))] [JsonSerializable(typeof(UserToolSessionApprovalExtensionPermissionAccess))] +[JsonSerializable(typeof(UserToolSessionApprovalFactory))] [JsonSerializable(typeof(UserToolSessionApprovalMcp))] [JsonSerializable(typeof(UserToolSessionApprovalMemory))] [JsonSerializable(typeof(UserToolSessionApprovalRead))] diff --git a/dotnet/src/GitHubTokenProvider.cs b/dotnet/src/GitHubTokenProvider.cs new file mode 100644 index 0000000000..3a79d09662 --- /dev/null +++ b/dotnet/src/GitHubTokenProvider.cs @@ -0,0 +1,77 @@ +/*--------------------------------------------------------------------------------------------- + * Copyright (c) Microsoft Corporation. All rights reserved. + *--------------------------------------------------------------------------------------------*/ + +using System.Diagnostics.CodeAnalysis; + +namespace GitHub.Copilot; + +/// Why the runtime is requesting a GitHub token. +[Experimental(Diagnostics.Experimental)] +public enum GitHubTokenRequestReason +{ + /// The session needs its initial token. + Initial, + + /// The session needs a refreshed token. + Refresh, +} + +/// Arguments passed to a session-scoped GitHub token provider. +[Experimental(Diagnostics.Experimental)] +public sealed class GitHubTokenProviderArgs +{ + /// Gets the effective GitHub host for which a token is needed. + public required string Host { get; init; } + + /// + /// Gets the session receiving the token, or before a + /// cloud session has been assigned an identifier. + /// + public string? SessionId { get; init; } + + /// Gets whether the runtime needs an initial or refreshed token. + public required GitHubTokenRequestReason Reason { get; init; } +} + +/// A GitHub access token returned by a session-scoped provider. +[Experimental(Diagnostics.Experimental)] +public sealed class GitHubToken +{ + /// Gets or sets the GitHub access token. + public required string AccessToken { get; set; } + + /// Gets or sets the OAuth token type. The runtime defaults it to bearer. + public string? TokenType { get; set; } + + /// + /// Gets or sets the required positive number of seconds remaining when the + /// callback completes. Production GitHub tokens typically last eight hours. + /// + public required long ExpiresIn { get; set; } + + /// + public override string ToString() + => $"{nameof(GitHubToken)} {{ {nameof(TokenType)} = {TokenType}, {nameof(ExpiresIn)} = {ExpiresIn}, {nameof(AccessToken)} = }}"; +} + +/// The result returned by a session-scoped GitHub token provider. +[Experimental(Diagnostics.Experimental)] +public sealed class GitHubTokenProviderResult +{ + /// Gets whether token acquisition was cancelled. + public bool Cancelled { get; private init; } + + /// Gets the acquired token, if acquisition was not cancelled. + public GitHubToken? Token { get; private init; } + + /// Creates a successful token result. + public static GitHubTokenProviderResult FromToken(GitHubToken token) + { + ArgumentNullException.ThrowIfNull(token); + return new() { Token = token }; + } + + /// Creates a cancelled result. + public static GitHubTokenProviderResult Cancel() => new() { Cancelled = true }; +} diff --git a/dotnet/src/JsonRpc.cs b/dotnet/src/JsonRpc.cs index 36289d2e68..c5c444ea70 100644 --- a/dotnet/src/JsonRpc.cs +++ b/dotnet/src/JsonRpc.cs @@ -548,7 +548,11 @@ private async Task HandleIncomingMethodAsync(string methodName, JsonElement mess if (requestId.HasValue) { - await SendResultResponseAsync(requestId.Value, result, cancellationToken).ConfigureAwait(false); + await SendResultResponseAsync( + requestId.Value, + result, + registration.ResultType, + cancellationToken).ConfigureAwait(false); } } catch (Exception ex) when (ex is not OperationCanceledException) @@ -772,18 +776,20 @@ private static bool TryGetPropertyCaseInsensitive(JsonElement obj, string name, return doc.RootElement.Clone(); } - private async Task SendResultResponseAsync(JsonElement id, object? result, CancellationToken cancellationToken) + private async Task SendResultResponseAsync( + JsonElement id, + object? result, + Type? declaredResultType, + CancellationToken cancellationToken) { try { - // Convert the result to a JsonElement using the runtime type, looked up via - // the merged resolver. Source-gen serialization of an `object`-typed property - // would otherwise have no way to find metadata for the actual response type - // (e.g. SystemMessageTransformRpcResponse, SessionFsReadFileResult, ...). + // Prefer the handler's declared result type so polymorphic base types emit + // their discriminator. Fall back to the runtime type for untyped handlers. JsonElement? resultElement = null; if (result is not null) { - var typeInfo = _serializerOptions.GetTypeInfo(result.GetType()); + var typeInfo = _serializerOptions.GetTypeInfo(declaredResultType ?? result.GetType()); resultElement = JsonSerializer.SerializeToElement(result, typeInfo); } @@ -863,6 +869,11 @@ public MethodRegistration(Delegate handler, bool singleObjectParam) { ValueTaskAsTaskMethod = GetMethodFromGenericMethodDefinition(returnType, s_valueTaskAsTask); TaskResultGetter = GetMethodFromGenericMethodDefinition(ValueTaskAsTaskMethod.ReturnType, s_taskGetResult); + ResultType = returnType.GetGenericArguments()[0]; + } + else if (returnType != typeof(void) && returnType != typeof(Task) && returnType != typeof(ValueTask)) + { + ResultType = returnType; } } @@ -871,6 +882,7 @@ public MethodRegistration(Delegate handler, bool singleObjectParam) public ParameterInfo[] Parameters { get; } public MethodInfo? ValueTaskAsTaskMethod { get; } public MethodInfo? TaskResultGetter { get; } + public Type? ResultType { get; } } private static MethodInfo GetMethodFromGenericMethodDefinition(Type specializedType, MethodInfo genericMethodDefinition) diff --git a/dotnet/src/PermissionDecision.cs b/dotnet/src/PermissionDecision.cs index 54e1237917..3eb1d0e08a 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 4386e8ba64..6ff3abbda3 100644 --- a/dotnet/src/PermissionHandlers.cs +++ b/dotnet/src/PermissionHandlers.cs @@ -9,7 +9,39 @@ 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; + } + + // Only reached for a request that did not deserialize into a generated + // variant. Keep this list in sync with the PermissionRequest discriminators + // so a known kind is never treated as requiring managed approval. + 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 "factory" + or "extension-permission-access" + or "extension-env-access"); + } } diff --git a/dotnet/src/Session.cs b/dotnet/src/Session.cs index de25b78256..7d076d14b0 100644 --- a/dotnet/src/Session.cs +++ b/dotnet/src/Session.cs @@ -1,4 +1,4 @@ -ο»Ώ/*--------------------------------------------------------------------------------------------- +/*--------------------------------------------------------------------------------------------- * Copyright (c) Microsoft Corporation. All rights reserved. *--------------------------------------------------------------------------------------------*/ @@ -63,6 +63,7 @@ public sealed partial class CopilotSession : IAsyncDisposable private readonly CopilotClient _parentClient; private volatile Func>? _permissionHandler; + private bool _managedSettingsEnabled; private volatile Func>? _mcpAuthHandler; private volatile Func>? _userInputHandler; private volatile Func>? _elicitationHandler; @@ -81,6 +82,7 @@ private sealed record EventSubscription(Type EventType, Action Han private IReadOnlyList _openCanvases = Array.Empty(); private int _isDisposed; + private string? _gitHubTokenProviderRegistrationId; /// /// Channel that serializes event dispatch. enqueues; @@ -202,6 +204,19 @@ internal void RemoveFromClient() ((ICollection>)_parentClient._sessions).Remove(new(SessionId, this)); } + internal void SetGitHubTokenProviderRegistration(string registrationId) + { + _gitHubTokenProviderRegistrationId = registrationId; + } + + internal void ReleaseGitHubTokenProviderRegistration() + { + if (Interlocked.Exchange(ref _gitHubTokenProviderRegistrationId, null) is { } registrationId) + { + _parentClient.UnregisterGitHubTokenProvider(registrationId); + } + } + internal void StartProcessingEvents() { _ = ProcessEventsAsync(); @@ -262,7 +277,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" } /// } /// }); /// @@ -356,7 +371,7 @@ void Handler(SessionEvent evt) } break; - case SessionIdleEvent: + case SessionIdleEvent idleEvent when idleEvent.Data.Mode != SessionMode.Autopilot: LoggingHelpers.LogTiming(_logger, LogLevel.Debug, null, "CopilotSession.SendAndWaitAsync idle received. Elapsed={Elapsed}, SessionId={SessionId}", totalTimestamp, @@ -557,13 +572,17 @@ 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) @@ -590,7 +609,8 @@ internal async Task HandlePermissionRequestAsync(JsonElement var invocation = new PermissionInvocation { - SessionId = SessionId + SessionId = SessionId, + ManagedSettingsEnabled = _managedSettingsEnabled }; var permissionTimestamp = Stopwatch.GetTimestamp(); @@ -932,7 +952,8 @@ private async Task ExecutePermissionAndRespondAsync(string requestId, Permission { var invocation = new PermissionInvocation { - SessionId = SessionId + SessionId = SessionId, + ManagedSettingsEnabled = _managedSettingsEnabled }; var permissionTimestamp = Stopwatch.GetTimestamp(); @@ -947,15 +968,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()); @@ -1145,7 +1167,7 @@ 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) { @@ -1356,7 +1378,10 @@ public async Task ElicitAsync(ElicitationParams elicitationPa Required = elicitationParams.RequestedSchema.Required }; - var result = await session.Rpc.Ui.ElicitationAsync(elicitationParams.Message, schema, cancellationToken); + var result = await session.Rpc.Ui.ElicitationAsync( + elicitationParams.Message, + schema, + cancellationToken: cancellationToken); return new ElicitationResult { Action = result.Action, @@ -1380,7 +1405,7 @@ public async Task ConfirmAsync(string message, CancellationToken cancellat Required = ["confirmed"] }; - var result = await session.Rpc.Ui.ElicitationAsync(message, schema, cancellationToken); + var result = await session.Rpc.Ui.ElicitationAsync(message, schema, cancellationToken: cancellationToken); if (result.Action == UIElicitationResponseAction.Accept && result.Content != null && result.Content.TryGetValue("confirmed", out var val)) @@ -1414,7 +1439,7 @@ public async Task ConfirmAsync(string message, CancellationToken cancellat Required = ["selection"] }; - var result = await session.Rpc.Ui.ElicitationAsync(message, schema, cancellationToken); + var result = await session.Rpc.Ui.ElicitationAsync(message, schema, cancellationToken: cancellationToken); if (result.Action == UIElicitationResponseAction.Accept && result.Content != null && result.Content.TryGetValue("selection", out var val)) @@ -1449,7 +1474,7 @@ public async Task ConfirmAsync(string message, CancellationToken cancellat Required = ["value"] }; - var result = await session.Rpc.Ui.ElicitationAsync(message, schema, cancellationToken); + var result = await session.Rpc.Ui.ElicitationAsync(message, schema, cancellationToken: cancellationToken); if (result.Action == UIElicitationResponseAction.Accept && result.Content != null && result.Content.TryGetValue("value", out var val)) @@ -1605,6 +1630,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)!, @@ -1782,7 +1812,7 @@ public async Task AbortAsync(CancellationToken cancellationToken = default) /// The new model takes effect for the next message. Conversation history is preserved. /// /// Model ID to switch to (e.g., "gpt-5.4"). - /// Reasoning effort level (e.g., "low", "medium", "high", "xhigh"). + /// Reasoning effort level (e.g., "low", "medium", "high", "xhigh", "max"). /// Per-property overrides for model capabilities, deep-merged over runtime defaults. /// Optional cancellation token. /// @@ -1817,13 +1847,14 @@ public async Task SetModelAsync(string model, SetModelOptions options, Cancellat ThrowIfDisposed(); await Rpc.Model.SwitchToAsync( - model, - options.ReasoningEffort, - options.ReasoningSummary, - null, - options.ModelCapabilities, - options.ContextTier, - cancellationToken); + modelId: model, + reasoningEffort: options.ReasoningEffort, + reasoningSummary: options.ReasoningSummary, + verbosity: null, + modelCapabilities: options.ModelCapabilities, + contextTier: options.ContextTier, + source: null, + cancellationToken: cancellationToken); } /// @@ -1919,6 +1950,7 @@ await InvokeRpcAsync( } finally { + ReleaseGitHubTokenProviderRegistration(); RemoveFromClient(); GC.SuppressFinalize(this); } @@ -2024,5 +2056,7 @@ internal void ThrowIfDisposed() [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 fbb8df507d..a353c93ad0 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 85248707fd..6ed05e3064 100644 --- a/dotnet/src/Types.cs +++ b/dotnet/src/Types.cs @@ -309,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; @@ -358,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 /// (, @@ -833,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; } } // ============================================================================ @@ -1653,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. /// @@ -1964,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. /// @@ -2957,6 +3022,100 @@ public sealed class CopilotExpAssignmentResponse 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; } +} + +/// Well-known managed bypass-permissions policies. +public static class DisableBypassPermissionsModes +{ + /// Turns off bypass-permissions mode entirely. + public const string Disable = "disable"; + + /// Permits automatic bypass but blocks full allow-all. + public const string AllowAutoOnly = "allow-auto-only"; +} + +/// +/// 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 policies compose to +/// the most restrictive setting. +/// +public sealed class ManagedSettingsPermissions +{ + /// + /// Restricts bypass-permissions mode for the session regardless of other + /// layers. See for well-known + /// values. Unknown values are forwarded so newer runtime policies fail closed. + /// Serialized as disableBypassPermissionsMode. + /// + [JsonPropertyName("disableBypassPermissionsMode")] + public string? 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; } +} + /// /// Shared configuration properties for creating or resuming a Copilot session. /// Use when creating a new session, or @@ -2983,7 +3142,10 @@ protected SessionConfigBase(SessionConfigBase? other) DefaultAgent = other.DefaultAgent; Agent = other.Agent; DisabledSkills = other.DisabledSkills is not null ? [.. other.DisabledSkills] : null; + IncludedBuiltinSkills = other.IncludedBuiltinSkills is not null ? [.. other.IncludedBuiltinSkills] : 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; @@ -2994,6 +3156,20 @@ 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; @@ -3021,6 +3197,7 @@ protected SessionConfigBase(SessionConfigBase? other) 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; @@ -3030,9 +3207,11 @@ protected SessionConfigBase(SessionConfigBase? other) ContextTier = other.ContextTier; CreateSessionFsProvider = other.CreateSessionFsProvider; GitHubToken = other.GitHubToken; + GitHubTokenProvider = other.GitHubTokenProvider; 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; @@ -3051,6 +3230,7 @@ protected SessionConfigBase(SessionConfigBase? other) 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. @@ -3061,7 +3241,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; } @@ -3094,6 +3274,17 @@ protected SessionConfigBase(SessionConfigBase? other) [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. @@ -3101,15 +3292,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; } @@ -3170,6 +3354,14 @@ protected SessionConfigBase(SessionConfigBase? other) /// public bool? EnableSkills { get; set; } + /// + /// Built-in skill names to include in the session. In + /// , omitting this option excludes all + /// runtime-bundled skills; specifying names opts those built-ins back in. + /// Skills from other sources remain eligible. + /// + public IList? IncludedBuiltinSkills { get; set; } + /// /// Custom tool declarations available to the language model during the session. /// Declarations backed by an are invoked automatically; declarations without one @@ -3230,6 +3422,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. @@ -3309,12 +3510,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 @@ -3382,6 +3596,13 @@ 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. @@ -3438,6 +3659,16 @@ protected SessionConfigBase(SessionConfigBase? other) /// public string? GitHubToken { get; set; } + /// + /// Gets or sets a callback that acquires session-scoped GitHub tokens on + /// demand. Initial cancellation, callback errors, and invalid token responses + /// reject session creation or resume instead of falling back to ambient + /// authentication. This cannot be combined with . + /// + [Experimental(Diagnostics.Experimental)] + [JsonIgnore] + public Func>? GitHubTokenProvider { get; set; } + /// /// Per-session remote behavior control: /// @@ -3475,6 +3706,17 @@ protected SessionConfigBase(SessionConfigBase? other) /// 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 diff --git a/dotnet/test/E2E/BuiltinToolsE2ETests.cs b/dotnet/test/E2E/BuiltinToolsE2ETests.cs index 5fc0314171..37067ecc60 100644 --- a/dotnet/test/E2E/BuiltinToolsE2ETests.cs +++ b/dotnet/test/E2E/BuiltinToolsE2ETests.cs @@ -2,6 +2,7 @@ * Copyright (c) Microsoft Corporation. All rights reserved. *--------------------------------------------------------------------------------------------*/ +using GitHub.Copilot.Test.Harness; using Xunit; using Xunit.Abstractions; @@ -111,9 +112,21 @@ public async Task Should_Create_A_New_File() Assert.Contains("Created by test", msg?.Data.Content ?? string.Empty); } + // TODO(cli-1.0.81-2): the grep and glob built-in tools shell out to the CLI's + // bundled ripgrep, which the runtime cannot locate when it is loaded in-process + // over FFI ("Failed to execute ripgrep: No such file or directory"). The tool + // then returns an error the recorded snapshots do not cover. Re-enable once the + // in-process runtime resolves its bundled binaries. + private static bool RipgrepUnavailable => E2ETestContext.UsesInProcessTransport; + [Fact] public async Task Should_Search_For_Patterns_In_Files() { + if (RipgrepUnavailable) + { + return; + } + await File.WriteAllTextAsync(Path.Join(Ctx.WorkDir, "data.txt"), "apple\nbanana\napricot\ncherry\n"); var session = await CreateSessionAsync(); var msg = await session.SendAndWaitAsync(new MessageOptions @@ -128,6 +141,11 @@ public async Task Should_Search_For_Patterns_In_Files() [Fact] public async Task Should_Find_Files_By_Pattern() { + if (RipgrepUnavailable) + { + return; + } + Directory.CreateDirectory(Path.Join(Ctx.WorkDir, "src")); await File.WriteAllTextAsync(Path.Join(Ctx.WorkDir, "src", "index.ts"), "export const index = 1;"); await File.WriteAllTextAsync(Path.Join(Ctx.WorkDir, "README.md"), "# Readme"); diff --git a/dotnet/test/E2E/ClientE2ETests.cs b/dotnet/test/E2E/ClientE2ETests.cs index d166223d65..b6bdfd90fd 100644 --- a/dotnet/test/E2E/ClientE2ETests.cs +++ b/dotnet/test/E2E/ClientE2ETests.cs @@ -11,6 +11,9 @@ namespace GitHub.Copilot.Test.E2E; // Other test classes should instead inherit from E2ETestBase 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] @@ -177,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()); diff --git a/dotnet/test/E2E/ClientOptionsE2ETests.cs b/dotnet/test/E2E/ClientOptionsE2ETests.cs index bf995563c4..5391e4bdbc 100644 --- a/dotnet/test/E2E/ClientOptionsE2ETests.cs +++ b/dotnet/test/E2E/ClientOptionsE2ETests.cs @@ -179,6 +179,65 @@ public async Task Should_Omit_EnableSessionTelemetry_When_Not_Set() await session.DisposeAsync(); } + [Fact] + public async Task Should_Forward_CustomAgentsLocalOnly_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 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() { @@ -451,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(); @@ -725,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(); diff --git a/dotnet/test/E2E/CommandsE2ETests.cs b/dotnet/test/E2E/CommandsE2ETests.cs index 20db2d7cb4..5b778f9cce 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/HookLifecycleAndOutputE2ETests.cs b/dotnet/test/E2E/HookLifecycleAndOutputE2ETests.cs index cd94a2ebd6..decdb3190a 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, OnAgentStop. 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() { diff --git a/dotnet/test/E2E/InMemorySessionFsSqliteHandler.cs b/dotnet/test/E2E/InMemorySessionFsSqliteHandler.cs index 4e573ff5ca..caf49fa6d9 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/RewindE2ETests.cs b/dotnet/test/E2E/RewindE2ETests.cs new file mode 100644 index 0000000000..74c0b8ab9f --- /dev/null +++ b/dotnet/test/E2E/RewindE2ETests.cs @@ -0,0 +1,88 @@ +// 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() + { + // TODO(cli-1.0.81): Re-enable when Windows file-change tracking records built-in create tool writes. + if (OperatingSystem.IsWindows()) + return; + + 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 + && rewindPoints.Points.Count == 1 + && rewindPoints.Points[0].CanRestoreFiles + && rewindPoints.Points[0].FileCount == 1; + }, + timeout: TimeSpan.FromSeconds(30), + timeoutMessage: "Timed out waiting for a restorable file rewind point.", + 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/RpcServerMiscE2ETests.cs b/dotnet/test/E2E/RpcServerMiscE2ETests.cs index 29e560100e..20993e2ec0 100644 --- a/dotnet/test/E2E/RpcServerMiscE2ETests.cs +++ b/dotnet/test/E2E/RpcServerMiscE2ETests.cs @@ -92,7 +92,7 @@ public async Task Should_Login_List_GetCurrentAuth_And_Logout_Account() var initial = await client.Rpc.Account.GetCurrentAuthAsync(); Assert.Null(initial.AuthInfo); - var loginResult = await client.Rpc.Account.LoginAsync("https://github.com", login, token); + var loginResult = await client.Rpc.Account.LoginAsync("https://github.com", token, login); Assert.NotNull(loginResult); var current = await client.Rpc.Account.GetCurrentAuthAsync(); @@ -111,7 +111,7 @@ user.AuthInfo is AuthInfoUser userAuth Assert.Equal(token, account.Token); } - var logout = await client.Rpc.Account.LogoutAsync(authInfo); + var logout = await client.Rpc.Account.LogoutAsync(authInfo: authInfo); Assert.False(logout.HasMoreUsers); var afterLogout = await client.Rpc.Account.GetCurrentAuthAsync(); diff --git a/dotnet/test/E2E/RpcSessionStateE2ETests.cs b/dotnet/test/E2E/RpcSessionStateE2ETests.cs index 6dce3c250f..803c1c602b 100644 --- a/dotnet/test/E2E/RpcSessionStateE2ETests.cs +++ b/dotnet/test/E2E/RpcSessionStateE2ETests.cs @@ -451,7 +451,7 @@ public async Task Should_Set_Auth_Credentials() }); var login = $"sdk-rpc-{Guid.NewGuid():N}"; - var setCredentials = await session.Rpc.GitHubAuth.SetCredentialsAsync(new AuthInfoUser + var setCredentials = await session.Rpc.GitHubAuth.SetCredentialsAsync(new SettableAuthInfoUser { CopilotUser = new CopilotUserResponse { diff --git a/dotnet/test/E2E/RpcSessionStateExtrasE2ETests.cs b/dotnet/test/E2E/RpcSessionStateExtrasE2ETests.cs index 28ec9b7cfe..72663c35a4 100644 --- a/dotnet/test/E2E/RpcSessionStateExtrasE2ETests.cs +++ b/dotnet/test/E2E/RpcSessionStateExtrasE2ETests.cs @@ -12,7 +12,7 @@ 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, +/// permissions.getMode/setMode, plan.readSqlTodos, provider.add, /// telemetry.getEngagementId, tools.getCurrentMetadata/updateSubagentSettings, /// session visibility, and the session-scoped plugins.reload. /// @@ -158,22 +158,22 @@ public async Task Should_Get_And_Set_AllowAll_Permissions() try { - var initial = await session.Rpc.Permissions.GetAllowAllAsync(); - Assert.False(initial.Enabled, "Allow-all should be disabled on a fresh session."); + var initial = await session.Rpc.Permissions.GetModeAsync(); + Assert.Equal(PermissionMode.Manual, initial.Mode); - var enable = await session.Rpc.Permissions.SetAllowAllAsync(enabled: true); + var enable = await session.Rpc.Permissions.SetModeAsync(PermissionMode.AllowAll); Assert.True(enable.Success); - Assert.True(enable.Enabled); - Assert.True((await session.Rpc.Permissions.GetAllowAllAsync()).Enabled); + Assert.Equal(PermissionMode.AllowAll, enable.Mode); + Assert.Equal(PermissionMode.AllowAll, (await session.Rpc.Permissions.GetModeAsync()).Mode); - var disable = await session.Rpc.Permissions.SetAllowAllAsync(enabled: false); + var disable = await session.Rpc.Permissions.SetModeAsync(PermissionMode.Manual); Assert.True(disable.Success); - Assert.False(disable.Enabled); - Assert.False((await session.Rpc.Permissions.GetAllowAllAsync()).Enabled); + Assert.Equal(PermissionMode.Manual, disable.Mode); + Assert.Equal(PermissionMode.Manual, (await session.Rpc.Permissions.GetModeAsync()).Mode); } finally { - await session.Rpc.Permissions.SetAllowAllAsync(enabled: false); + await session.Rpc.Permissions.SetModeAsync(PermissionMode.Manual); } } diff --git a/dotnet/test/E2E/RpcTasksAndHandlersE2ETests.cs b/dotnet/test/E2E/RpcTasksAndHandlersE2ETests.cs index 989fef7c55..640e4f72f5 100644 --- a/dotnet/test/E2E/RpcTasksAndHandlersE2ETests.cs +++ b/dotnet/test/E2E/RpcTasksAndHandlersE2ETests.cs @@ -152,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); + + 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); - Assert.True(remove.Removed); + 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] diff --git a/dotnet/test/E2E/RpcUiEphemeralQueryE2ETests.cs b/dotnet/test/E2E/RpcUiEphemeralQueryE2ETests.cs index 76043fd73c..a6b7877868 100644 --- a/dotnet/test/E2E/RpcUiEphemeralQueryE2ETests.cs +++ b/dotnet/test/E2E/RpcUiEphemeralQueryE2ETests.cs @@ -19,7 +19,10 @@ namespace GitHub.Copilot.Test.E2E; public class RpcUiEphemeralQueryE2ETests(E2ETestFixture fixture, ITestOutputHelper output) : E2ETestBase(fixture, "rpc_ui_ephemeral_query", output) { - [Fact] + // TODO(cli-1.0.81-2): CLI 1.0.81-5 still fails session.ui.ephemeralQuery against the + // recorded snapshot on macOS ("Failed to get response from the AI model"). Re-enable + // once the runtime fix ships. + [Fact(Skip = "Blocked on CLI 1.0.81-5 session.ui.ephemeralQuery regression on macOS")] public async Task Should_Answer_Ephemeral_Query() { await using var session = await CreateSessionAsync(); diff --git a/dotnet/test/E2E/RpcWorkspaceCheckpointsE2ETests.cs b/dotnet/test/E2E/RpcWorkspaceCheckpointsE2ETests.cs index ea4ae15b42..092b28971d 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 ad313b116d..1bc4c52eb9 100644 --- a/dotnet/test/E2E/SessionConfigE2ETests.cs +++ b/dotnet/test/E2E/SessionConfigE2ETests.cs @@ -173,9 +173,11 @@ public async Task Should_Apply_All_ReasoningEffort_Values_On_Session_Create(stri [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"), @@ -187,7 +189,6 @@ public async Task Should_Apply_ReasoningEffort_On_Session_Resume() Assert.Equal("high", resumeEvent.Data.ReasoningEffort); await resumedSession.DisposeAsync(); - await originalSession.DisposeAsync(); } [Fact] @@ -233,8 +234,9 @@ public async Task Should_Forward_Custom_Provider_Headers_On_Create() [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 { @@ -339,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 { @@ -360,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 @@ -422,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], @@ -438,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 { @@ -493,8 +499,10 @@ public async Task Should_Apply_Session_Limits_On_Create() [Fact] public async Task Should_Apply_Session_Limits_On_Resume() { - var session1 = await CreateSessionAsync(); - var session2 = await ResumeSessionAsync(session1.SessionId, new ResumeSessionConfig + await using var session1 = await CreateSessionAsync(); + var sessionId = session1.SessionId; + await SuspendAndUntrackSessionForResumeAsync(session1); + var session2 = await ResumeSessionAsync(sessionId, new ResumeSessionConfig { SessionLimits = new SessionLimitsConfig { @@ -513,7 +521,6 @@ public async Task Should_Apply_Session_Limits_On_Resume() finally { await session2.DisposeAsync(); - await session1.DisposeAsync(); } } @@ -558,8 +565,10 @@ public async Task Should_Apply_Excluded_Built_In_Agents_On_Resume() { const string excludedAgent = "explore"; - var session1 = await CreateSessionAsync(); - var session2 = await ResumeSessionAsync(session1.SessionId, new ResumeSessionConfig + await using var session1 = await CreateSessionAsync(); + var sessionId = session1.SessionId; + await SuspendAndUntrackSessionForResumeAsync(session1); + var session2 = await ResumeSessionAsync(sessionId, new ResumeSessionConfig { ExcludedBuiltInAgents = [excludedAgent], }); @@ -575,7 +584,6 @@ public async Task Should_Apply_Excluded_Built_In_Agents_On_Resume() finally { await session2.DisposeAsync(); - await session1.DisposeAsync(); } } diff --git a/dotnet/test/E2E/SessionE2ETests.cs b/dotnet/test/E2E/SessionE2ETests.cs index e47b6b21b4..27ef7437f7 100644 --- a/dotnet/test/E2E/SessionE2ETests.cs +++ b/dotnet/test/E2E/SessionE2ETests.cs @@ -228,7 +228,7 @@ 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(() => @@ -611,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); } @@ -983,8 +986,9 @@ public async Task Should_Create_Session_With_Azure_Provider() [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 { @@ -1006,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 cf91e3ddc8..146e47d808 100644 --- a/dotnet/test/E2E/SessionFsE2ETests.cs +++ b/dotnet/test/E2E/SessionFsE2ETests.cs @@ -337,6 +337,8 @@ await session.SendAndWaitAsync(new MessageOptions var messages = await session.GetEventsAsync(); var toolResult = FindToolCallResult(messages, "get_big_string"); Assert.NotNull(toolResult); + // Windows reports the spilled file path with backslash separators. + toolResult = toolResult!.Replace('\\', '/'); Assert.Contains($"{SessionFsConfig.SessionStatePath}/temp/", toolResult); var match = System.Text.RegularExpressions.Regex.Match( @@ -581,7 +583,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); @@ -616,6 +619,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/SkillsE2ETests.cs b/dotnet/test/E2E/SkillsE2ETests.cs index 76f84106f6..3b005fc018 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 4df9ca4420..bea4760c86 100644 --- a/dotnet/test/E2E/StreamingFidelityE2ETests.cs +++ b/dotnet/test/E2E/StreamingFidelityE2ETests.cs @@ -150,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", }); @@ -177,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/TelemetryExportE2ETests.cs b/dotnet/test/E2E/TelemetryExportE2ETests.cs index 48e3b53ad6..e2ad447e26 100644 --- a/dotnet/test/E2E/TelemetryExportE2ETests.cs +++ b/dotnet/test/E2E/TelemetryExportE2ETests.cs @@ -54,9 +54,6 @@ public async Task Should_Export_File_Telemetry_For_Sdk_Interactions() Assert.NotEmpty(spans); Assert.All(spans, span => Assert.Equal(sourceName, GetInstrumentationScopeName(span))); - // All spans for one SDK turn must share the same trace id and must not be in error state. - var traceIds = spans.Select(GetTraceId).Where(id => !string.IsNullOrEmpty(id)).Distinct().ToList(); - Assert.Single(traceIds); Assert.All(spans, span => Assert.NotEqual(2, GetStatusCode(span))); var invokeAgentSpan = AssertSpanWithOperation(spans, "invoke_agent"); @@ -65,10 +62,13 @@ public async Task Should_Export_File_Telemetry_For_Sdk_Interactions() "invoke_agent should be the root of the SDK turn trace."); var invokeAgentSpanId = GetSpanId(invokeAgentSpan); Assert.False(string.IsNullOrEmpty(invokeAgentSpanId)); + var invokeAgentTraceId = GetTraceId(invokeAgentSpan); + Assert.False(string.IsNullOrEmpty(invokeAgentTraceId)); var chatSpans = spans.Where(span => IsSpanWithOperation(span, "chat")).ToList(); Assert.NotEmpty(chatSpans); Assert.All(chatSpans, chat => Assert.Equal(invokeAgentSpanId, GetParentSpanId(chat))); + Assert.All(chatSpans, chat => Assert.Equal(invokeAgentTraceId, GetTraceId(chat))); Assert.Contains( chatSpans, span => (GetStringAttribute(span, "gen_ai.input.messages") ?? string.Empty).Contains(prompt, StringComparison.Ordinal)); @@ -78,6 +78,7 @@ public async Task Should_Export_File_Telemetry_For_Sdk_Interactions() var toolSpan = AssertSpanWithOperation(spans, "execute_tool"); Assert.Equal(invokeAgentSpanId, GetParentSpanId(toolSpan)); + Assert.Equal(invokeAgentTraceId, GetTraceId(toolSpan)); Assert.Equal(toolName, GetStringAttribute(toolSpan, "gen_ai.tool.name")); Assert.False(string.IsNullOrWhiteSpace(GetStringAttribute(toolSpan, "gen_ai.tool.call.id")), "execute_tool span should carry gen_ai.tool.call.id."); diff --git a/dotnet/test/Harness/E2ETestBase.cs b/dotnet/test/Harness/E2ETestBase.cs index a3006389bb..3eb0f0e97a 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); } @@ -88,17 +89,40 @@ 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), - }); + 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) { return exchange.Request.Messages.FirstOrDefault(m => m.Role == "system")?.StringContent ?? string.Empty; diff --git a/dotnet/test/Harness/E2ETestContext.cs b/dotnet/test/Harness/E2ETestContext.cs index 809ab55a3e..0080cbc609 100644 --- a/dotnet/test/Harness/E2ETestContext.cs +++ b/dotnet/test/Harness/E2ETestContext.cs @@ -13,10 +13,12 @@ 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; } @@ -38,6 +40,12 @@ private E2ETestContext(string homeDir, string workDir, string proxyUrl, ReplayPr public static async Task CreateAsync() { + // A previous in-process context may have left this process's cwd inside a work + // directory that has since been deleted. getcwd() then fails, which breaks + // Process.Start below while it resolves the proxy executable. Repoint the cwd at + // the ambient value first; SetCurrentDirectory succeeds even if the old cwd is gone. + InProcessEnvIsolation.RestoreAmbientWorkingDirectory(); + var repoRoot = FindRepoRoot(); var homeDir = Path.Combine(Path.GetTempPath(), $"copilot-test-config-{Guid.NewGuid()}"); @@ -322,22 +330,8 @@ public CopilotClient CreateClient( if (IsInProcess(options.Connection)) { - // In-process hosting: runtime code runs host-side in this process (the - // loaded cdylib) and reads the ambient process environment rather than - // the environment passed to copilot_runtime_host_start, so the per-test - // redirects, cleared tokens/HMAC, and isolated home must be mirrored - // onto this process's real environment. Restored after each test by - // InProcessEnvIsolationAttribute. - foreach (var (name, value) in env) - { - InProcessEnvIsolation.Apply(name, value); - } - - // A per-client WorkingDirectory is rejected in-process; instead point this - // process's cwd at the desired directory so the worker inherits it at spawn - // (restored after the test by InProcessEnvIsolationAttribute). options.WorkingDirectory = null; - InProcessEnvIsolation.SetWorkingDirectory(desiredWorkingDirectory); + ApplyInProcessEnvironment(env, desiredWorkingDirectory); } else if (options.Connection is ChildProcessRuntimeConnection child) { @@ -395,6 +389,29 @@ public Task ResumeSessionAsync( 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) @@ -467,6 +484,14 @@ public async ValueTask DisposeAsync() var isCI = !string.IsNullOrEmpty(Environment.GetEnvironmentVariable("GITHUB_ACTIONS")); try { await _proxy.StopAsync(skipWritingCache: isCI); } catch (Exception ex) when (IsTransientCleanupException(ex)) { errors.Add(ex); } + // The in-process worker inherits this process's cwd, so ApplyInProcessEnvironment + // may have pointed it at WorkDir. The assembly-level isolation attribute only + // restores it around tests that actually execute, so a statically skipped test + // can leave the cwd inside a directory this method is about to delete. Every + // later Process.Start would then fail resolving its executable because getcwd() + // returns ENOENT. Repoint the cwd before deleting anything. + InProcessEnvIsolation.RestoreAmbientWorkingDirectory(); + try { await DeleteDirectoryAsync(HomeDir); } catch (Exception ex) when (IsTransientCleanupException(ex)) { errors.Add(ex); } try { await DeleteDirectoryAsync(WorkDir); } catch (Exception ex) when (IsTransientCleanupException(ex)) { errors.Add(ex); } @@ -539,7 +564,6 @@ private static bool IsInProcess(RuntimeConnection? connection) return false; } - // Inproc holds the session-store SQLite handle in-process; graceful StopAsync releases it so the temp-dir delete succeeds on Windows. private static async Task StopClientForCleanupAsync(CopilotClient client) { var isInProcess = string.Equals( @@ -548,7 +572,21 @@ private static async Task StopClientForCleanupAsync(CopilotClient client) StringComparison.OrdinalIgnoreCase); if (isInProcess) { - await client.StopAsync(); + 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 { diff --git a/dotnet/test/Harness/E2ETestFixture.cs b/dotnet/test/Harness/E2ETestFixture.cs index 95bebc1391..e29f5f7f6c 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 index af06001eda..e7a9c98235 100644 --- a/dotnet/test/Harness/InProcessEnvIsolation.cs +++ b/dotnet/test/Harness/InProcessEnvIsolation.cs @@ -67,6 +67,14 @@ public static void NeutralizeAmbientCredentials() public static void SetWorkingDirectory(string path) => Directory.SetCurrentDirectory(path); + // Repoints the process working directory at its load-time value. Callers 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. + public static void RestoreAmbientWorkingDirectory() => + Directory.SetCurrentDirectory(s_ambientCwd); + public static void RestoreAmbient() { // Unconditionally repoint the process cwd at its load-time value. We must @@ -74,7 +82,7 @@ public static void RestoreAmbient() // 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); + RestoreAmbientWorkingDirectory(); foreach (DictionaryEntry entry in Environment.GetEnvironmentVariables()) { diff --git a/dotnet/test/Unit/ClientSessionLifetimeTests.cs b/dotnet/test/Unit/ClientSessionLifetimeTests.cs index e1143db17c..b61546c650 100644 --- a/dotnet/test/Unit/ClientSessionLifetimeTests.cs +++ b/dotnet/test/Unit/ClientSessionLifetimeTests.cs @@ -3,6 +3,7 @@ *--------------------------------------------------------------------------------------------*/ #if NET8_0_OR_GREATER +using System.Collections.Concurrent; using System.Net; using System.Net.Sockets; using System.Diagnostics; @@ -10,6 +11,7 @@ using System.Runtime.CompilerServices; using System.Text; using System.Text.Json; +using GitHub.Copilot.Rpc; using Xunit; namespace GitHub.Copilot.Test.Unit; @@ -18,6 +20,192 @@ public sealed class ClientSessionLifetimeTests { private sealed record RpcRequestRecord(string Method, JsonElement Params); + [Theory] + [InlineData("static")] + [InlineData("")] + public async Task GitHubTokenProvider_Is_Mutually_Exclusive_With_Static_Token(string staticToken) + { + await using var client = new CopilotClient(); + var config = new SessionConfig + { + GitHubToken = staticToken, + GitHubTokenProvider = _ => Task.FromResult(GitHubTokenProviderResult.Cancel()) + }; + + var error = await Assert.ThrowsAsync(() => client.CreateSessionAsync(config)); + + Assert.Contains("cannot be used together", error.Message); + } + + [Fact] + public async Task GitHubTokenProvider_Is_Released_When_Session_Is_Deleted() + { + await using var server = await FakeCopilotServer.StartAsync(); + await using var client = new CopilotClient(new CopilotClientOptions { Connection = RuntimeConnection.ForUri(server.Url) }); + var session = await client.CreateSessionAsync(new SessionConfig + { + GitHubTokenProvider = _ => Task.FromResult(GitHubTokenProviderResult.Cancel()) + }); + var registrationId = Assert.Single(server.Requests, request => request.Method == "session.create") + .Params.GetProperty("gitHubTokenProviderRegistrationId").GetString(); + + await client.DeleteSessionAsync(session.SessionId); + + var error = await Assert.ThrowsAsync(() => + server.SendRequestAsync("gitHubToken.getToken", TokenRequest(registrationId))); + Assert.Contains("Unknown GitHub token provider registration ID", error.Message); + await session.DisposeAsync(); + } + + [Fact] + public async Task GitHubTokenProvider_Is_Serialized_And_Maps_Callbacks() + { + await using var server = await FakeCopilotServer.StartAsync(); + await using var client = new CopilotClient(new CopilotClientOptions { Connection = RuntimeConnection.ForUri(server.Url) }); + GitHubTokenProviderArgs? callbackArgs = null; + var session = await client.CreateSessionAsync(new SessionConfig + { + GitHubTokenProvider = args => + { + callbackArgs = args; + return Task.FromResult(GitHubTokenProviderResult.FromToken(new GitHubToken + { + AccessToken = "secret-token", + TokenType = "bearer", + ExpiresIn = 8 * 60 * 60 + })); + } + }); + var request = Assert.Single(server.Requests, request => request.Method == "session.create"); + var registrationId = request.Params.GetProperty("gitHubTokenProviderRegistrationId").GetString(); + Assert.False(string.IsNullOrEmpty(registrationId)); + Assert.False(request.Params.TryGetProperty("gitHubToken", out _)); + + var result = await server.SendRequestAsync("gitHubToken.getToken", new Dictionary + { + ["registrationId"] = registrationId, + ["host"] = "github.example.com", + ["sessionId"] = session.SessionId, + ["reason"] = "refresh" + }); + + Assert.True(result.TryGetProperty("kind", out var kind), result.ToString()); + Assert.Equal("token", kind.GetString()); + Assert.Equal("secret-token", result.GetProperty("accessToken").GetString()); + Assert.Equal(8 * 60 * 60, result.GetProperty("expiresIn").GetInt64()); + Assert.NotNull(callbackArgs); + Assert.Equal("github.example.com", callbackArgs.Host); + Assert.Equal(session.SessionId, callbackArgs.SessionId); + Assert.Equal(GitHubTokenRequestReason.Refresh, callbackArgs.Reason); + Assert.DoesNotContain("secret-token", new GitHubToken + { + AccessToken = "secret-token", + ExpiresIn = 8 * 60 * 60 + }.ToString()); + + await session.DisposeAsync(); + var error = await Assert.ThrowsAsync(() => + server.SendRequestAsync("gitHubToken.getToken", new Dictionary + { + ["registrationId"] = registrationId, + ["host"] = "github.com", + ["reason"] = "initial" + })); + Assert.Contains("Unknown GitHub token provider registration ID", error.Message); + + server.ClearRequests(); + var resumed = await client.ResumeSessionAsync("resumed-session", new ResumeSessionConfig + { + GitHubTokenProvider = _ => Task.FromResult(GitHubTokenProviderResult.Cancel()) + }); + var resumeRequest = Assert.Single(server.Requests, request => request.Method == "session.resume"); + Assert.False(string.IsNullOrEmpty( + resumeRequest.Params.GetProperty("gitHubTokenProviderRegistrationId").GetString())); + await resumed.DisposeAsync(); + } + + [Fact] + public async Task GitHubTokenProvider_Handles_Cancellation_Errors_And_Rollback() + { + await using var server = await FakeCopilotServer.StartAsync(); + await using var client = new CopilotClient(new CopilotClientOptions { Connection = RuntimeConnection.ForUri(server.Url) }); + var cancelledSession = await client.CreateSessionAsync(new SessionConfig + { + GitHubTokenProvider = _ => Task.FromResult(GitHubTokenProviderResult.Cancel()) + }); + var cancelledId = Assert.Single(server.Requests, request => request.Method == "session.create") + .Params.GetProperty("gitHubTokenProviderRegistrationId").GetString(); + var cancelled = await server.SendRequestAsync("gitHubToken.getToken", TokenRequest(cancelledId)); + Assert.True(cancelled.TryGetProperty("kind", out var cancelledKind), cancelled.ToString()); + Assert.Equal("cancelled", cancelledKind.GetString()); + await cancelledSession.DisposeAsync(); + + server.ClearRequests(); + var providerSession = await client.CreateSessionAsync(new SessionConfig + { + GitHubTokenProvider = _ => Task.FromException( + new InvalidOperationException("provider failed")) + }); + var providerId = Assert.Single(server.Requests, request => request.Method == "session.create") + .Params.GetProperty("gitHubTokenProviderRegistrationId").GetString(); + var callbackError = await Assert.ThrowsAsync(() => + server.SendRequestAsync("gitHubToken.getToken", TokenRequest(providerId))); + Assert.Contains("provider failed", callbackError.Message); + await providerSession.DisposeAsync(); + + server.ClearRequests(); + server.FailSessionCreate(); + await Assert.ThrowsAsync(() => client.CreateSessionAsync(new SessionConfig + { + GitHubTokenProvider = _ => Task.FromResult(GitHubTokenProviderResult.Cancel()) + })); + var rolledBackId = Assert.Single(server.Requests, request => request.Method == "session.create") + .Params.GetProperty("gitHubTokenProviderRegistrationId").GetString(); + var rollbackError = await Assert.ThrowsAsync(() => + server.SendRequestAsync("gitHubToken.getToken", TokenRequest(rolledBackId))); + Assert.Contains("Unknown GitHub token provider registration ID", rollbackError.Message); + } + + [Fact] + public async Task GitHubTokenProvider_Resume_Replaces_Ownership() + { + await using var server = await FakeCopilotServer.StartAsync(); + await using var client = new CopilotClient(new CopilotClientOptions { Connection = RuntimeConnection.ForUri(server.Url) }); + var first = await client.CreateSessionAsync(new SessionConfig + { + SessionId = "replacement-session", + GitHubTokenProvider = _ => Task.FromResult(GitHubTokenProviderResult.Cancel()) + }); + var firstId = Assert.Single(server.Requests, request => request.Method == "session.create") + .Params.GetProperty("gitHubTokenProviderRegistrationId").GetString(); + + await first.DisposeAsync(); + await Assert.ThrowsAsync(() => + server.SendRequestAsync("gitHubToken.getToken", TokenRequest(firstId))); + + server.ClearRequests(); + var resumed = await client.ResumeSessionAsync("replacement-session", new ResumeSessionConfig + { + GitHubTokenProvider = _ => Task.FromResult(GitHubTokenProviderResult.Cancel()) + }); + var secondId = Assert.Single(server.Requests, request => request.Method == "session.resume") + .Params.GetProperty("gitHubTokenProviderRegistrationId").GetString(); + + var result = await server.SendRequestAsync("gitHubToken.getToken", TokenRequest(secondId)); + Assert.Equal("cancelled", result.GetProperty("kind").GetString()); + + await resumed.DisposeAsync(); + await Assert.ThrowsAsync(() => + server.SendRequestAsync("gitHubToken.getToken", TokenRequest(secondId))); + } + + private static Dictionary TokenRequest(string? registrationId) => new() + { + ["registrationId"] = registrationId, + ["host"] = "github.com", + ["reason"] = "initial" + }; + [Fact] public async Task StopAsync_Requests_Runtime_Shutdown_For_Owned_Process() { @@ -182,6 +370,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() { @@ -255,6 +464,211 @@ public async Task CreateSessionAsync_Omits_CustomAgent_ReasoningEffort_When_Unse 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 EmptyMode_Create_Sends_Empty_IncludedBuiltinSkills() + { + await using var server = await FakeCopilotServer.StartAsync(); + await using var client = new CopilotClient(new CopilotClientOptions + { + Connection = RuntimeConnection.ForUri(server.Url), + Mode = CopilotClientMode.Empty, + BaseDirectory = Path.GetTempPath(), + }); + + await using var created = await client.CreateSessionAsync(new SessionConfig + { + AvailableTools = [], + OnPermissionRequest = PermissionHandler.ApproveAll + }); + + var update = Assert.Single(server.Requests, request => request.Method == "session.options.update"); + Assert.True(update.Params.TryGetProperty("includedBuiltinSkills", out var skills)); + Assert.Equal(JsonValueKind.Array, skills.ValueKind); + Assert.Equal(0, skills.GetArrayLength()); + // Adjacent unconditional plugin isolation is still present. + Assert.True(update.Params.TryGetProperty("installedPlugins", out var plugins)); + Assert.Equal(0, plugins.GetArrayLength()); + } + + [Fact] + public async Task EmptyMode_Resume_Sends_Empty_IncludedBuiltinSkills() + { + await using var server = await FakeCopilotServer.StartAsync(); + await using var client = new CopilotClient(new CopilotClientOptions + { + Connection = RuntimeConnection.ForUri(server.Url), + Mode = CopilotClientMode.Empty, + BaseDirectory = Path.GetTempPath(), + }); + + await using var resumed = await client.ResumeSessionAsync("resume-empty-skills", new ResumeSessionConfig + { + AvailableTools = [], + OnPermissionRequest = PermissionHandler.ApproveAll + }); + + var update = Assert.Single(server.Requests, request => request.Method == "session.options.update"); + Assert.True(update.Params.TryGetProperty("includedBuiltinSkills", out var skills)); + Assert.Equal(JsonValueKind.Array, skills.ValueKind); + Assert.Equal(0, skills.GetArrayLength()); + } + + [Fact] + public async Task EmptyMode_Resume_Preserves_Explicit_IncludedBuiltinSkills() + { + await using var server = await FakeCopilotServer.StartAsync(); + await using var client = new CopilotClient(new CopilotClientOptions + { + Connection = RuntimeConnection.ForUri(server.Url), + Mode = CopilotClientMode.Empty, + BaseDirectory = Path.GetTempPath(), + }); + + await using var resumed = await client.ResumeSessionAsync("resume-selected-skills", new ResumeSessionConfig + { + AvailableTools = [], + IncludedBuiltinSkills = ["code-review"], + OnPermissionRequest = PermissionHandler.ApproveAll + }); + + var update = Assert.Single(server.Requests, request => request.Method == "session.options.update"); + var skills = update.Params.GetProperty("includedBuiltinSkills"); + Assert.Equal(["code-review"], skills.EnumerateArray().Select(value => value.GetString())); + } + + [Fact] + public async Task EmptyMode_Create_With_EnableSkills_Still_Sends_Empty_IncludedBuiltinSkills() + { + await using var server = await FakeCopilotServer.StartAsync(); + await using var client = new CopilotClient(new CopilotClientOptions + { + Connection = RuntimeConnection.ForUri(server.Url), + Mode = CopilotClientMode.Empty, + BaseDirectory = Path.GetTempPath(), + }); + + // Caller opts into their own custom skills. Runtime-bundled built-ins must + // still be excluded: the empty post-patch cannot be weakened by the caller. + await using var created = await client.CreateSessionAsync(new SessionConfig + { + AvailableTools = [], + EnableSkills = true, + SkillDirectories = [Path.Combine(Path.GetTempPath(), "skills")], + OnPermissionRequest = PermissionHandler.ApproveAll + }); + + var update = Assert.Single(server.Requests, request => request.Method == "session.options.update"); + Assert.True(update.Params.TryGetProperty("includedBuiltinSkills", out var skills)); + Assert.Equal(JsonValueKind.Array, skills.ValueKind); + Assert.Equal(0, skills.GetArrayLength()); + } + + [Fact] + public async Task EmptyMode_Create_Preserves_Explicit_IncludedBuiltinSkills() + { + await using var server = await FakeCopilotServer.StartAsync(); + await using var client = new CopilotClient(new CopilotClientOptions + { + Connection = RuntimeConnection.ForUri(server.Url), + Mode = CopilotClientMode.Empty, + BaseDirectory = Path.GetTempPath(), + }); + + await using var created = await client.CreateSessionAsync(new SessionConfig + { + AvailableTools = [], + IncludedBuiltinSkills = ["code-review"], + OnPermissionRequest = PermissionHandler.ApproveAll + }); + + var update = Assert.Single(server.Requests, request => request.Method == "session.options.update"); + var skills = update.Params.GetProperty("includedBuiltinSkills"); + Assert.Equal(["code-review"], skills.EnumerateArray().Select(value => value.GetString())); + } + + [Fact] + public async Task CopilotCliMode_Create_Does_Not_Inject_IncludedBuiltinSkills() + { + 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 + { + OnPermissionRequest = PermissionHandler.ApproveAll + }); + + // In the default copilot-cli mode with no overridable options set, no + // options patch is sent at all, so the field is never injected. + Assert.DoesNotContain(server.Requests, request => + request.Method == "session.options.update" + && request.Params.TryGetProperty("includedBuiltinSkills", out _)); + } + [Fact] public async Task CreateSessionAsync_Registers_McpAuth_Interest_Only_When_Handler_Configured() { @@ -415,6 +829,66 @@ public async Task Generated_Session_Rpc_Throws_When_Session_Disposed() await Assert.ThrowsAsync(() => session.Rpc.Model.GetCurrentAsync()); } + [Fact] + public async Task SendAndWaitAsync_Skips_Autopilot_Continuation_Idle() + { + 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 + }); + + var sendTask = session.SendAndWaitAsync(new MessageOptions { Prompt = "keep going" }); + await WaitForRequestAsync(server, "session.send"); + + var continuationIdleProcessed = new TaskCompletionSource(TaskCreationOptions.RunContinuationsAsynchronously); + using var subscription = session.On(idle => + { + if (idle.Data.Mode == SessionMode.Autopilot) + { + continuationIdleProcessed.TrySetResult(); + } + }); + + DispatchEvent(session, new AssistantMessageEvent + { + Id = Guid.NewGuid(), + Data = new AssistantMessageData + { + Content = "intermediate", + MessageId = "assistant-1" + } + }); + DispatchEvent(session, new SessionIdleEvent + { + Id = Guid.NewGuid(), + Data = new SessionIdleData { Mode = SessionMode.Autopilot } + }); + + await continuationIdleProcessed.Task.WaitAsync(TimeSpan.FromSeconds(5)); + Assert.False(sendTask.IsCompleted); + + DispatchEvent(session, new AssistantMessageEvent + { + Id = Guid.NewGuid(), + Data = new AssistantMessageData + { + Content = "final", + MessageId = "assistant-2" + } + }); + DispatchEvent(session, new SessionIdleEvent + { + Id = Guid.NewGuid(), + Data = new SessionIdleData { Mode = SessionMode.Interactive } + }); + + var result = await sendTask.WaitAsync(TimeSpan.FromSeconds(5)); + Assert.NotNull(result); + Assert.Equal("final", result.Data.Content); + } + [MethodImpl(MethodImplOptions.NoInlining)] private static async Task> CreateDroppedSessionAsync(CopilotClient client) { @@ -450,6 +924,322 @@ 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 = DisableBypassPermissionsModes.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 CreateSessionAsync_Serializes_Future_ManagedSettings_Bypass_Mode() + { + 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 + { + ManagedSettings = new ManagedSettings + { + Permissions = new ManagedSettingsPermissions + { + DisableBypassPermissionsMode = "future-fail-closed-mode" + } + }, + OnPermissionRequest = PermissionHandler.ApproveAll + }); + + var request = Assert.Single(server.Requests, request => request.Method == "session.create"); + var permissions = request.Params.GetProperty("managedSettings").GetProperty("permissions"); + Assert.Equal( + "future-fail-closed-mode", + permissions.GetProperty("disableBypassPermissionsMode").GetString()); + } + + [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) @@ -515,9 +1305,13 @@ private sealed class FakeCopilotServer : IAsyncDisposable private readonly Task _serverTask; private readonly List _requests = []; private readonly object _requestsLock = new(); + private readonly ConcurrentDictionary> _pendingRequests = new(); + private NetworkStream? _stream; + private int _nextRequestId; private string? _lastSessionId; private bool _delayDestroy; private bool _failRuntimeShutdown; + private bool _failSessionCreate; private FakeCopilotServer(TcpListener listener) { @@ -579,6 +1373,31 @@ public void FailRuntimeShutdown() _failRuntimeShutdown = true; } + public void FailSessionCreate() + { + _failSessionCreate = true; + } + + public async Task SendRequestAsync(string method, Dictionary parameters) + { + var stream = _stream ?? throw new InvalidOperationException("Client is not connected."); + var id = Interlocked.Increment(ref _nextRequestId); + var completion = new TaskCompletionSource(TaskCreationOptions.RunContinuationsAsynchronously); + if (!_pendingRequests.TryAdd(id, completion)) + { + throw new InvalidOperationException("Failed to track callback request."); + } + + await WriteMessageAsync(stream, new Dictionary + { + ["jsonrpc"] = "2.0", + ["id"] = id, + ["method"] = method, + ["params"] = parameters + }, _cts.Token); + return await completion.Task.WaitAsync(_cts.Token); + } + public async ValueTask DisposeAsync() { _allowDestroy.TrySetResult(); @@ -601,16 +1420,37 @@ private async Task RunAsync() { using var tcpClient = await _listener.AcceptTcpClientAsync(_cts.Token); using var stream = tcpClient.GetStream(); + _stream = stream; while (!_cts.Token.IsCancellationRequested) { - using var request = await ReadMessageAsync(stream, _cts.Token); - if (request is null) + using var message = await ReadMessageAsync(stream, _cts.Token); + if (message is null) { return; } - await HandleRequestAsync(stream, request.RootElement, _cts.Token); + var root = message.RootElement; + if (root.TryGetProperty("method", out _)) + { + await HandleRequestAsync(stream, root, _cts.Token); + continue; + } + + if (root.TryGetProperty("id", out var responseId) + && responseId.TryGetInt32(out var id) + && _pendingRequests.TryRemove(id, out var completion)) + { + if (root.TryGetProperty("error", out var error)) + { + completion.TrySetException(new InvalidOperationException( + error.GetProperty("message").GetString())); + } + else + { + completion.TrySetResult(root.GetProperty("result").Clone()); + } + } } } @@ -646,6 +1486,21 @@ private async Task HandleRequestAsync(Stream stream, JsonElement request, Cancel { _requests.Add(new RpcRequestRecord(method!, paramsElement)); } + if (method == "session.create" && _failSessionCreate) + { + _failSessionCreate = false; + await WriteMessageAsync(stream, new Dictionary + { + ["jsonrpc"] = "2.0", + ["id"] = id, + ["error"] = new Dictionary + { + ["code"] = -32000, + ["message"] = "session create failed" + } + }, cancellationToken); + return; + } object? result = method switch { "connect" => new Dictionary @@ -664,10 +1519,18 @@ private async Task HandleRequestAsync(Stream stream, JsonElement request, Cancel { ["messageId"] = "message-1" }, + "session.options.update" => new Dictionary + { + ["success"] = true + }, "session.mcp.oauth.handlePendingRequest" => new Dictionary { ["success"] = true }, + "session.permissions.handlePendingPermissionRequest" => new Dictionary + { + ["success"] = true + }, "session.delete" => new Dictionary { ["success"] = true diff --git a/dotnet/test/Unit/CloneTests.cs b/dotnet/test/Unit/CloneTests.cs index ec509ab169..4bacdfe33d 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); } @@ -75,9 +78,12 @@ public void SessionConfig_Clone_CopiesAllProperties() 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" } }, @@ -98,6 +104,7 @@ 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 }, @@ -119,9 +126,12 @@ public void SessionConfig_Clone_CopiesAllProperties() 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); @@ -136,6 +146,7 @@ public void SessionConfig_Clone_CopiesAllProperties() 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); @@ -154,9 +165,11 @@ public void SessionConfig_Clone_CollectionsAreIndependent() 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(); @@ -167,9 +180,11 @@ public void SessionConfig_Clone_CollectionsAreIndependent() 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!); @@ -177,9 +192,11 @@ public void SessionConfig_Clone_CollectionsAreIndependent() 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] @@ -203,9 +220,11 @@ public void ResumeSessionConfig_Clone_CollectionsAreIndependent() 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(); @@ -216,9 +235,11 @@ public void ResumeSessionConfig_Clone_CollectionsAreIndependent() 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!); @@ -226,9 +247,11 @@ public void ResumeSessionConfig_Clone_CollectionsAreIndependent() 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] @@ -289,6 +312,7 @@ public void Clone_WithNullCollections_ReturnsNullCollections() 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); @@ -373,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() { @@ -460,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() { diff --git a/dotnet/test/Unit/CopilotToolTests.cs b/dotnet/test/Unit/CopilotToolTests.cs index c3f5861492..19fa6258be 100644 --- a/dotnet/test/Unit/CopilotToolTests.cs +++ b/dotnet/test/Unit/CopilotToolTests.cs @@ -34,6 +34,28 @@ public void DefineTool_Sets_Name_Description_And_Copilot_Metadata() 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] public void DefineTool_Omits_Copilot_Metadata_When_Flags_Are_False() { diff --git a/dotnet/test/Unit/E2ETestFixtureTests.cs b/dotnet/test/Unit/E2ETestFixtureTests.cs new file mode 100644 index 0000000000..f7dee3ce0a --- /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/GitHubTelemetryTests.cs b/dotnet/test/Unit/GitHubTelemetryTests.cs index f82e0db6e0..a4a241e38d 100644 --- a/dotnet/test/Unit/GitHubTelemetryTests.cs +++ b/dotnet/test/Unit/GitHubTelemetryTests.cs @@ -17,6 +17,60 @@ namespace GitHub.Copilot.Test.Unit; 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() { @@ -193,6 +247,50 @@ await server.SendGitHubTelemetryEventAsync(new Dictionary 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; @@ -222,6 +320,10 @@ public string Url 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); @@ -303,10 +405,12 @@ private async Task HandleRequestAsync(Stream stream, JsonElement request, Cancel 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}'."), }; @@ -330,6 +434,13 @@ private async Task HandleRequestAsync(Stream stream, JsonElement request, Cancel }; } + 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; diff --git a/dotnet/test/Unit/PermissionHandlerTests.cs b/dotnet/test/Unit/PermissionHandlerTests.cs new file mode 100644 index 0000000000..675ea12828 --- /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/SerializationTests.cs b/dotnet/test/Unit/SerializationTests.cs index 6aaee01e77..6edf168093 100644 --- a/dotnet/test/Unit/SerializationTests.cs +++ b/dotnet/test/Unit/SerializationTests.cs @@ -299,6 +299,51 @@ public void SessionRequests_OmitCapiOptions_WhenUnset() 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() { @@ -366,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()); @@ -383,12 +430,14 @@ 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()); @@ -434,6 +483,7 @@ public void SessionRequests_CanSerializeCitationAgentExclusionAndLimits_WithSdkO createRequestType, ("SessionId", "session-id"), ("EnableCitations", true), + ("EnableFileChangeTracking", true), ("ExcludedBuiltInAgents", excludedAgents), ("SessionLimits", new SessionLimitsConfig { MaxAiCredits = 12.5 })); @@ -441,6 +491,7 @@ public void SessionRequests_CanSerializeCitationAgentExclusionAndLimits_WithSdkO 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()); @@ -449,6 +500,7 @@ public void SessionRequests_CanSerializeCitationAgentExclusionAndLimits_WithSdkO resumeRequestType, ("SessionId", "session-id"), ("EnableCitations", true), + ("EnableFileChangeTracking", true), ("ExcludedBuiltInAgents", excludedAgents), ("SessionLimits", new SessionLimitsConfig { MaxAiCredits = 7.25 })); @@ -456,6 +508,7 @@ public void SessionRequests_CanSerializeCitationAgentExclusionAndLimits_WithSdkO 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()); } @@ -593,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() { @@ -609,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() { diff --git a/dotnet/test/Unit/SessionEventSerializationTests.cs b/dotnet/test/Unit/SessionEventSerializationTests.cs index 64e28a5aee..326ac3f3c7 100644 --- a/dotnet/test/Unit/SessionEventSerializationTests.cs +++ b/dotnet/test/Unit/SessionEventSerializationTests.cs @@ -368,4 +368,65 @@ public void McpOauthRequiredData_Preserves_Static_Client_Secret() 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/go/README.md b/go/README.md index 78350c86a4..ddd74b91aa 100644 --- a/go/README.md +++ b/go/README.md @@ -55,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, @@ -89,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. @@ -193,7 +198,7 @@ Event types: `SessionLifecycleCreated`, `SessionLifecycleDeleted`, `SessionLifec When `Path` is empty for stdio/tcp, the SDK uses the bundled CLI (or `COPILOT_CLI_PATH` env var). `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 +- `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) @@ -205,7 +210,7 @@ Event types: `SessionLifecycleCreated`, `SessionLifecycleDeleted`, `SessionLifec **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: @@ -215,7 +220,10 @@ Event types: `SessionLifecycleCreated`, `SessionLifecycleDeleted`, `SessionLifec - `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. +- `GitHubTokenProvider` (GitHubTokenProvider): Acquires session-scoped GitHub tokens on demand. Return `GitHubTokenResult` with a positive `ExpiresIn` value (production GitHub tokens typically use `8 * 60 * 60` seconds), or `GitHubTokenCancelled`. Cannot be combined with `GitHubToken`. +- `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. @@ -230,6 +238,24 @@ Event types: `SessionLifecycleCreated`, `SessionLifecycleDeleted`, `SessionLifec - `Streaming` (*bool): Enable streaming delta events (nil = runtime default) - `Commands` ([]CommandDefinition): Slash-commands. See [Commands](#commands) section. - `OnElicitationRequest` (ElicitationHandler): Elicitation handler. See [Elicitation Requests](#elicitation-requests-serverclient) section. +- `GitHubTokenProvider` (GitHubTokenProvider): Replaces the session-scoped token provider when resuming. Cannot be combined with `GitHubToken`. + +```go +session, err := client.CreateSession(ctx, &copilot.SessionConfig{ + GitHubTokenProvider: func(args copilot.GitHubTokenProviderArgs) (*copilot.GitHubTokenProviderResult, error) { + token, err := acquireToken(args.Host) + if err != nil { + return nil, err + } + return copilot.GitHubTokenResult(&copilot.GitHubToken{ + AccessToken: token, + ExpiresIn: 8 * 60 * 60, + }), nil + }, +}) +``` + +Initial acquisition runs during session creation or resume. Cancellation, provider errors, and invalid token responses reject that operation instead of falling back to ambient authentication. Idle sessions refresh only before their next credential-consuming operation; there is no background refresh timer. ### Session @@ -674,7 +700,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{ @@ -683,9 +709,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 ( @@ -698,6 +726,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 { @@ -965,6 +997,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/client.go b/go/client.go index 0d07e21f54..4e44696a55 100644 --- a/go/client.go +++ b/go/client.go @@ -38,6 +38,7 @@ import ( "net" "os" "os/exec" + "path/filepath" "regexp" "strconv" "strings" @@ -144,19 +145,23 @@ func validateEnvironmentOptions(connection RuntimeConnection, opts *ClientOption // } // defer client.Stop() type Client struct { - options ClientOptions - process *exec.Cmd - client *jsonrpc2.Client - actualPort int - actualHost string - state connectionState - sessions map[string]*Session - sessionsMux sync.Mutex - isExternalServer bool - conn net.Conn // stores net.Conn for external TCP connections - useStdio bool // resolved value from options - useInProcess bool // true for InProcessConnection (FFI transport) - ffiHost inProcessHost + options ClientOptions + process *exec.Cmd + client *jsonrpc2.Client + actualPort int + actualHost string + state connectionState + sessions map[string]*Session + sessionsMux sync.Mutex + gitHubTokenProviders map[string]GitHubTokenProvider + gitHubTokenProvidersMux sync.RWMutex + sessionOperations map[string]*sessionOperation + sessionOperationsMux sync.Mutex + isExternalServer bool + conn net.Conn // stores net.Conn for external TCP connections + useStdio bool // resolved value from options + useInProcess bool // true for InProcessConnection (FFI transport) + ffiHost inProcessHost // resolved process options for the spawned runtime (zero values for URIConnection) cliPath string cliArgs []string @@ -188,6 +193,11 @@ type Client struct { internalRPC *rpc.InternalServerRPC } +type sessionOperation struct { + mutex sync.Mutex + users int +} + // NewClient creates a new Copilot runtime client with the given options. // // If options is nil, default options are used (spawns the bundled runtime over @@ -214,17 +224,24 @@ func NewClient(options *ClientOptions) *Client { opts := ClientOptions{} client := &Client{ - options: opts, - state: stateDisconnected, - sessions: make(map[string]*Session), - actualHost: "localhost", - isExternalServer: false, - useStdio: true, + options: opts, + state: stateDisconnected, + sessions: make(map[string]*Session), + gitHubTokenProviders: make(map[string]GitHubTokenProvider), + actualHost: "localhost", + isExternalServer: false, + useStdio: true, } 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. An explicit connection always wins; otherwise // honor the same process/environment override as the other SDKs. @@ -453,6 +470,21 @@ 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{ @@ -526,6 +558,7 @@ func (c *Client) Stop() error { c.sessionsMux.Lock() c.sessions = make(map[string]*Session) c.sessionsMux.Unlock() + c.clearGitHubTokenProviders() c.startStopMux.Lock() defer c.startStopMux.Unlock() @@ -641,6 +674,7 @@ func (c *Client) ForceStop() { c.sessionsMux.Lock() c.sessions = make(map[string]*Session) c.sessionsMux.Unlock() + c.clearGitHubTokenProviders() c.startStopMux.Lock() defer c.startStopMux.Unlock() @@ -750,10 +784,17 @@ 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{} } + if config.GitHubToken != "" && config.GitHubTokenProvider != nil { + return nil, fmt.Errorf("GitHubToken and GitHubTokenProvider cannot be used together") + } if err := c.ensureConnected(ctx); err != nil { return nil, err @@ -761,6 +802,14 @@ func (c *Client) CreateSession(ctx context.Context, config *SessionConfig) (*Ses c.applyConfigDefaultsForMode(config) + registrationID := c.registerGitHubTokenProvider(config.GitHubTokenProvider) + registrationTransferred := false + defer func() { + if !registrationTransferred { + c.unregisterGitHubTokenProvider(registrationID) + } + }() + req := createSessionRequest{} req.Model = config.Model req.ClientName = config.ClientName @@ -795,13 +844,16 @@ func (c *Client) CreateSession(ctx context.Context, config *SessionConfig) (*Ses 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" @@ -812,11 +864,15 @@ 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.GitHubTokenProviderRegistrationID = registrationID req.RemoteSession = config.RemoteSession req.Cloud = config.Cloud req.Canvases = config.Canvases @@ -828,6 +884,7 @@ func (c *Client) CreateSession(ctx context.Context, config *SessionConfig) (*Ses 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)) @@ -848,6 +905,7 @@ func (c *Client) CreateSession(ctx context.Context, config *SessionConfig) (*Ses if config.EnableMCPApps { req.RequestMCPApps = Bool(true) } + req.GitHubMCPToolConfig = config.GitHubMCPToolConfig if config.Streaming != nil { req.Streaming = config.Streaming @@ -868,6 +926,7 @@ func (c *Client) CreateSession(ctx context.Context, config *SessionConfig) (*Ses 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 || @@ -906,7 +965,12 @@ 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) @@ -1059,10 +1123,17 @@ func (c *Client) CreateSession(ctx context.Context, config *SessionConfig) (*Ses CustomAgentsLocalOnly: config.CustomAgentsLocalOnly, CoauthorEnabled: config.CoauthorEnabled, ManageScheduleEnabled: config.ManageScheduleEnabled, + IncludedBuiltinSkills: config.IncludedBuiltinSkills, }); err != nil { return nil, err } + if registrationID != "" { + session.setGitHubTokenProviderRegistrationRelease(func() { + c.unregisterGitHubTokenProvider(registrationID) + }) + registrationTransferred = true + } return session, nil } @@ -1090,9 +1161,15 @@ func (c *Client) ResumeSession(ctx context.Context, sessionID string, config *Re // Tools: []copilot.Tool{myNewTool}, // }) func (c *Client) ResumeSessionWithOptions(ctx context.Context, sessionID string, config *ResumeSessionConfig) (*Session, error) { + unlockSession := c.lockSessionOperation(sessionID) + defer unlockSession() + if config == nil { config = &ResumeSessionConfig{} } + if config.GitHubToken != "" && config.GitHubTokenProvider != nil { + return nil, fmt.Errorf("GitHubToken and GitHubTokenProvider cannot be used together") + } if err := c.ensureConnected(ctx); err != nil { return nil, err @@ -1100,6 +1177,14 @@ func (c *Client) ResumeSessionWithOptions(ctx context.Context, sessionID string, c.applyResumeDefaultsForMode(config) + registrationID := c.registerGitHubTokenProvider(config.GitHubTokenProvider) + registrationTransferred := false + defer func() { + if !registrationTransferred { + c.unregisterGitHubTokenProvider(registrationID) + } + }() + var req resumeSessionRequest req.SessionID = sessionID req.ClientName = config.ClientName @@ -1116,6 +1201,7 @@ func (c *Client) ResumeSessionWithOptions(ctx context.Context, sessionID string, 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 @@ -1130,6 +1216,7 @@ func (c *Client) ResumeSessionWithOptions(ctx context.Context, sessionID string, 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 @@ -1150,6 +1237,7 @@ func (c *Client) ResumeSessionWithOptions(ctx context.Context, sessionID string, 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 || @@ -1157,6 +1245,7 @@ func (c *Client) ResumeSessionWithOptions(ctx context.Context, sessionID string, req.Hooks = Bool(true) } req.WorkingDirectory = config.WorkingDirectory + req.AdditionalDirectories = config.AdditionalDirectories req.ConfigDir = config.ConfigDirectory req.EnableConfigDiscovery = config.EnableConfigDiscovery req.SkipEmbeddingRetrieval = config.SkipEmbeddingRetrieval @@ -1181,11 +1270,15 @@ 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.GitHubTokenProviderRegistrationID = registrationID req.RemoteSession = config.RemoteSession req.Canvases = config.Canvases req.OpenCanvases = config.OpenCanvases @@ -1197,6 +1290,7 @@ func (c *Client) ResumeSessionWithOptions(ctx context.Context, sessionID string, req.ExtensionInfo = config.ExtensionInfo req.ExpAssignments = config.ExpAssignments req.EnableManagedSettings = config.EnableManagedSettings + req.ManagedSettings = config.ManagedSettings if config.OnPermissionRequest != nil { req.RequestPermission = Bool(true) } @@ -1220,6 +1314,7 @@ func (c *Client) ResumeSessionWithOptions(ctx context.Context, sessionID string, if config.EnableMCPApps { req.RequestMCPApps = Bool(true) } + req.GitHubMCPToolConfig = config.GitHubMCPToolConfig traceparent, tracestate := getTraceContext(ctx) req.Traceparent = traceparent @@ -1227,7 +1322,12 @@ 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) @@ -1264,22 +1364,31 @@ func (c *Client) ResumeSessionWithOptions(ctx context.Context, sessionID string, } c.sessionsMux.Lock() + replacedSession := c.sessions[sessionID] c.sessions[sessionID] = session c.sessionsMux.Unlock() + restoreReplacedSession := func() { + c.sessionsMux.Lock() + if current := c.sessions[sessionID]; current == nil || current == session { + if replacedSession != nil { + c.sessions[sessionID] = replacedSession + } else { + delete(c.sessions, sessionID) + } + } + c.sessionsMux.Unlock() + } + if c.options.SessionFS != nil { if config.CreateSessionFSProvider == nil { - c.sessionsMux.Lock() - delete(c.sessions, sessionID) - c.sessionsMux.Unlock() + restoreReplacedSession() 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 { - c.sessionsMux.Lock() - delete(c.sessions, sessionID) - c.sessionsMux.Unlock() + restoreReplacedSession() return nil, fmt.Errorf("SessionFS capabilities declare SQLite support but the provider does not implement SessionFSSqliteProvider") } } @@ -1288,17 +1397,13 @@ func (c *Client) ResumeSessionWithOptions(ctx context.Context, sessionID string, result, err := c.client.Request(ctx, "session.resume", req) if err != nil { - c.sessionsMux.Lock() - delete(c.sessions, sessionID) - c.sessionsMux.Unlock() + restoreReplacedSession() return nil, fmt.Errorf("failed to resume session: %w", err) } var response resumeSessionResponse if err := json.Unmarshal(result, &response); err != nil { - c.sessionsMux.Lock() - delete(c.sessions, sessionID) - c.sessionsMux.Unlock() + restoreReplacedSession() return nil, fmt.Errorf("failed to unmarshal response: %w", err) } @@ -1307,9 +1412,7 @@ func (c *Client) ResumeSessionWithOptions(ctx context.Context, sessionID string, "sessionId": sessionID, "eventType": "mcp.oauth_required", }); err != nil { - c.sessionsMux.Lock() - delete(c.sessions, sessionID) - c.sessionsMux.Unlock() + restoreReplacedSession() return nil, err } } @@ -1323,10 +1426,21 @@ func (c *Client) ResumeSessionWithOptions(ctx context.Context, sessionID string, CustomAgentsLocalOnly: config.CustomAgentsLocalOnly, CoauthorEnabled: config.CoauthorEnabled, ManageScheduleEnabled: config.ManageScheduleEnabled, + IncludedBuiltinSkills: config.IncludedBuiltinSkills, }); err != nil { + restoreReplacedSession() return nil, err } + if registrationID != "" { + session.setGitHubTokenProviderRegistrationRelease(func() { + c.unregisterGitHubTokenProvider(registrationID) + }) + registrationTransferred = true + } + if replacedSession != nil && replacedSession != session { + replacedSession.releaseGitHubTokenProviderRegistration() + } return session, nil } @@ -1418,6 +1532,9 @@ func (c *Client) GetSessionMetadata(ctx context.Context, sessionID string) (*Ses // log.Fatal(err) // } func (c *Client) DeleteSession(ctx context.Context, sessionID string) error { + unlockSession := c.lockSessionOperation(sessionID) + defer unlockSession() + if err := c.ensureConnected(ctx); err != nil { return err } @@ -1442,8 +1559,12 @@ func (c *Client) DeleteSession(ctx context.Context, sessionID string) error { // Remove from local sessions map if present c.sessionsMux.Lock() + session := c.sessions[sessionID] delete(c.sessions, sessionID) c.sessionsMux.Unlock() + if session != nil { + session.releaseGitHubTokenProviderRegistration() + } return nil } @@ -1985,15 +2106,7 @@ func (c *Client) startCLIServer(ctx context.Context) error { // Create JSON-RPC client immediately c.client = jsonrpc2.NewClient(stdin, stdout) c.client.SetProcessDone(c.processDone, c.processErrorPtr) - 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.client.SetOnClose(c.handleConnectionClose) c.RPC = rpc.NewServerRPC(c.client) c.internalRPC = rpc.NewInternalServerRPC(c.client) c.setupNotificationHandler() @@ -2112,15 +2225,7 @@ func (c *Client) startInProcess(ctx context.Context) error { } 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.client.SetOnClose(c.handleConnectionClose) c.RPC = rpc.NewServerRPC(c.client) c.internalRPC = rpc.NewInternalServerRPC(c.client) c.setupNotificationHandler() @@ -2270,13 +2375,7 @@ func (c *Client) connectViaTCP(ctx context.Context) error { if c.processDone != nil { c.client.SetProcessDone(c.processDone, c.processErrorPtr) } - c.client.SetOnClose(func() { - go func() { - c.startStopMux.Lock() - defer c.startStopMux.Unlock() - c.state = stateDisconnected - }() - }) + c.client.SetOnClose(c.handleConnectionClose) c.RPC = rpc.NewServerRPC(c.client) c.internalRPC = rpc.NewInternalServerRPC(c.client) c.setupNotificationHandler() @@ -2307,8 +2406,10 @@ func (c *Client) setupNotificationHandler() { // 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}, + Hooks: &hooksAdapter{client: c}, + GitHubToken: &gitHubTokenAdapter{client: c}, } + if c.options.RequestHandler != nil { handlers.LlmInference = newCopilotRequestAdapter(c.options.RequestHandler, func() *rpc.ServerLlmInferenceAPI { if c.RPC == nil { @@ -2323,6 +2424,107 @@ func (c *Client) setupNotificationHandler() { rpc.RegisterClientGlobalAPIHandlers(c.client, handlers) } +func (c *Client) registerGitHubTokenProvider(provider GitHubTokenProvider) string { + if provider == nil { + return "" + } + registrationID := uuid.NewString() + c.gitHubTokenProvidersMux.Lock() + if c.gitHubTokenProviders == nil { + c.gitHubTokenProviders = make(map[string]GitHubTokenProvider) + } + c.gitHubTokenProviders[registrationID] = provider + c.gitHubTokenProvidersMux.Unlock() + return registrationID +} + +func (c *Client) unregisterGitHubTokenProvider(registrationID string) { + if registrationID == "" { + return + } + c.gitHubTokenProvidersMux.Lock() + delete(c.gitHubTokenProviders, registrationID) + c.gitHubTokenProvidersMux.Unlock() +} + +func (c *Client) clearGitHubTokenProviders() { + c.gitHubTokenProvidersMux.Lock() + c.gitHubTokenProviders = make(map[string]GitHubTokenProvider) + c.gitHubTokenProvidersMux.Unlock() +} + +func (c *Client) handleConnectionClose() { + c.clearGitHubTokenProviders() + // Avoid deadlocking with Stop/ForceStop, which hold startStopMux while + // waiting for the JSON-RPC read loop to finish. + go func() { + c.startStopMux.Lock() + defer c.startStopMux.Unlock() + c.state = stateDisconnected + }() +} + +func (c *Client) lockSessionOperation(sessionID string) func() { + c.sessionOperationsMux.Lock() + if c.sessionOperations == nil { + c.sessionOperations = make(map[string]*sessionOperation) + } + operation := c.sessionOperations[sessionID] + if operation == nil { + operation = &sessionOperation{} + c.sessionOperations[sessionID] = operation + } + operation.users++ + c.sessionOperationsMux.Unlock() + + operation.mutex.Lock() + return func() { + operation.mutex.Unlock() + c.sessionOperationsMux.Lock() + operation.users-- + if operation.users == 0 { + delete(c.sessionOperations, sessionID) + } + c.sessionOperationsMux.Unlock() + } +} + +type gitHubTokenAdapter struct { + client *Client +} + +func (a *gitHubTokenAdapter) GetToken(request *rpc.GitHubTokenAcquireRequest) (rpc.GitHubTokenAcquireResult, error) { + if request == nil { + return nil, fmt.Errorf("missing GitHub token acquire request") + } + a.client.gitHubTokenProvidersMux.RLock() + provider := a.client.gitHubTokenProviders[request.RegistrationID] + a.client.gitHubTokenProvidersMux.RUnlock() + if provider == nil { + return nil, fmt.Errorf("unknown GitHub token provider registration ID %q", request.RegistrationID) + } + + result, err := provider(GitHubTokenProviderArgs{ + Host: request.Host, + SessionID: request.SessionID, + Reason: request.Reason, + }) + if err != nil { + return nil, err + } + if result != nil && result.Cancelled { + return &rpc.GitHubTokenAcquireResultCancelled{}, nil + } + if result == nil || result.Token == nil { + return nil, fmt.Errorf("GitHub token provider returned neither a token nor cancellation") + } + return &rpc.GitHubTokenAcquireResultToken{ + AccessToken: result.Token.AccessToken, + TokenType: result.Token.TokenType, + ExpiresIn: result.Token.ExpiresIn, + }, nil +} + // gitHubTelemetryAdapter adapts the OnGitHubTelemetry option to the generated // rpc.GitHubTelemetryHandler interface. type gitHubTelemetryAdapter struct { diff --git a/go/client_test.go b/go/client_test.go index 3e4675d0b3..c6ab0808cb 100644 --- a/go/client_test.go +++ b/go/client_test.go @@ -139,6 +139,200 @@ func TestClient_URLParsing(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{ @@ -251,6 +445,60 @@ func TestClient_ForwardsCapiOptionsToSessionRequests(t *testing.T) { 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) @@ -344,14 +592,15 @@ func TestClient_ForwardsNewSessionOptionsToSessionRequests(t *testing.T) { }) _, err := client.CreateSession(t.Context(), &SessionConfig{ - ExcludedBuiltInAgents: []string{"explore"}, - EnableCitations: Bool(true), - SessionLimits: &rpc.SessionLimitsConfig{MaxAiCredits: float64Ptr(30)}, + 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, "explore", 30) + 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) { @@ -360,14 +609,15 @@ func TestClient_ForwardsNewSessionOptionsToSessionRequests(t *testing.T) { }) _, err = client.ResumeSessionWithOptions(t.Context(), "resumed-options", &ResumeSessionConfig{ - ExcludedBuiltInAgents: []string{"task"}, - EnableCitations: Bool(false), - SessionLimits: &rpc.SessionLimitsConfig{MaxAiCredits: float64Ptr(15)}, + 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, "task", 15) + assertNewSessionOptions(t, <-resumeParams, false, false, "task", 15) } func assertCapiEnableWebSocketResponses(t *testing.T, params json.RawMessage) { @@ -391,6 +641,7 @@ func assertNewSessionOptions( t *testing.T, params json.RawMessage, expectedCitations bool, + expectedFileChangeTracking bool, expectedAgent string, expectedCredits float64, ) { @@ -403,6 +654,9 @@ func assertNewSessionOptions( 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"]) @@ -1049,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) @@ -1063,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) @@ -1081,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) @@ -1099,10 +1383,28 @@ 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) { @@ -1837,6 +2139,175 @@ func TestClient_MCPAuthInterestRegistration(t *testing.T) { }) } +func findRequest(requests []recordedRequest, method string) (recordedRequest, bool) { + for _, r := range requests { + if r.Method == method { + return r, true + } + } + return recordedRequest{}, false +} + +func TestClient_EmptyModeIncludedBuiltinSkills(t *testing.T) { + t.Run("create post-patch sends empty includedBuiltinSkills", func(t *testing.T) { + client, requests, cleanup := newInMemoryClientWithOptions(t, &ClientOptions{ + Mode: ModeEmpty, + BaseDirectory: "/tmp/copilot-test", + }) + defer cleanup() + + session, err := client.CreateSession(t.Context(), &SessionConfig{ + OnPermissionRequest: PermissionHandler.ApproveAll, + OnEvent: func(SessionEvent) {}, + AvailableTools: []string{}, + }) + if err != nil { + t.Fatalf("CreateSession failed: %v", err) + } + defer session.Disconnect() + + update, ok := findRequest(requests.snapshot(), "session.options.update") + if !ok { + t.Fatalf("expected session.options.update in %+v", requests.snapshot()) + } + skills, present := update.Params["includedBuiltinSkills"] + if !present { + t.Fatalf("expected includedBuiltinSkills in patch, got %+v", update.Params) + } + if arr, isArr := skills.([]any); !isArr || len(arr) != 0 { + t.Fatalf("expected includedBuiltinSkills=[], got %#v", skills) + } + }) + + t.Run("resume post-patch sends empty includedBuiltinSkills", func(t *testing.T) { + client, requests, cleanup := newInMemoryClientWithOptions(t, &ClientOptions{ + Mode: ModeEmpty, + BaseDirectory: "/tmp/copilot-test", + }) + defer cleanup() + + session, err := client.ResumeSession(t.Context(), "session-empty", &ResumeSessionConfig{ + OnPermissionRequest: PermissionHandler.ApproveAll, + OnEvent: func(SessionEvent) {}, + AvailableTools: []string{}, + }) + if err != nil { + t.Fatalf("ResumeSession failed: %v", err) + } + defer session.Disconnect() + + update, ok := findRequest(requests.snapshot(), "session.options.update") + if !ok { + t.Fatalf("expected session.options.update in %+v", requests.snapshot()) + } + if arr, isArr := update.Params["includedBuiltinSkills"].([]any); !isArr || len(arr) != 0 { + t.Fatalf("expected includedBuiltinSkills=[], got %#v", update.Params["includedBuiltinSkills"]) + } + }) + + t.Run("resume preserves explicit built-in skill allowlist", func(t *testing.T) { + client, requests, cleanup := newInMemoryClientWithOptions(t, &ClientOptions{ + Mode: ModeEmpty, + BaseDirectory: "/tmp/copilot-test", + }) + defer cleanup() + + session, err := client.ResumeSessionWithOptions(t.Context(), "resume-skills", &ResumeSessionConfig{ + OnPermissionRequest: PermissionHandler.ApproveAll, + AvailableTools: []string{}, + IncludedBuiltinSkills: []string{"code-review"}, + }) + if err != nil { + t.Fatalf("ResumeSessionWithOptions failed: %v", err) + } + defer session.Disconnect() + + update, ok := findRequest(requests.snapshot(), "session.options.update") + if !ok { + t.Fatalf("expected session.options.update in %+v", requests.snapshot()) + } + skills, ok := update.Params["includedBuiltinSkills"].([]any) + if !ok || len(skills) != 1 || skills[0] != "code-review" { + t.Fatalf("expected includedBuiltinSkills=[code-review], got %#v", update.Params["includedBuiltinSkills"]) + } + }) + + t.Run("caller opting into custom skills keeps includedBuiltinSkills empty", func(t *testing.T) { + client, requests, cleanup := newInMemoryClientWithOptions(t, &ClientOptions{ + Mode: ModeEmpty, + BaseDirectory: "/tmp/copilot-test", + }) + defer cleanup() + + session, err := client.CreateSession(t.Context(), &SessionConfig{ + OnPermissionRequest: PermissionHandler.ApproveAll, + OnEvent: func(SessionEvent) {}, + AvailableTools: []string{}, + EnableSkills: Bool(true), + SkillDirectories: []string{"/tmp/custom-skills"}, + }) + if err != nil { + t.Fatalf("CreateSession failed: %v", err) + } + defer session.Disconnect() + + update, ok := findRequest(requests.snapshot(), "session.options.update") + if !ok { + t.Fatalf("expected session.options.update in %+v", requests.snapshot()) + } + if arr, isArr := update.Params["includedBuiltinSkills"].([]any); !isArr || len(arr) != 0 { + t.Fatalf("expected includedBuiltinSkills=[], got %#v", update.Params["includedBuiltinSkills"]) + } + }) + + t.Run("explicit built-in skill allowlist is preserved in empty mode", func(t *testing.T) { + client, requests, cleanup := newInMemoryClientWithOptions(t, &ClientOptions{ + Mode: ModeEmpty, + BaseDirectory: "/tmp/copilot-test", + }) + defer cleanup() + + session, err := client.CreateSession(t.Context(), &SessionConfig{ + OnPermissionRequest: PermissionHandler.ApproveAll, + AvailableTools: []string{}, + IncludedBuiltinSkills: []string{"code-review"}, + }) + if err != nil { + t.Fatalf("CreateSession failed: %v", err) + } + defer session.Disconnect() + + update, ok := findRequest(requests.snapshot(), "session.options.update") + if !ok { + t.Fatalf("expected session.options.update in %+v", requests.snapshot()) + } + skills, ok := update.Params["includedBuiltinSkills"].([]any) + if !ok || len(skills) != 1 || skills[0] != "code-review" { + t.Fatalf("expected includedBuiltinSkills=[code-review], got %#v", update.Params["includedBuiltinSkills"]) + } + }) + + t.Run("copilot-cli mode does not inject includedBuiltinSkills", 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() + + for _, r := range requests.snapshot() { + if _, present := r.Params["includedBuiltinSkills"]; present { + t.Fatalf("did not expect includedBuiltinSkills in %s params %+v", r.Method, r.Params) + } + } + }) +} + type recordedRequest struct { Method string Params map[string]any @@ -1869,13 +2340,18 @@ func (r *requestRecorder) clear() { func newInMemoryClient(t *testing.T) (*Client, *requestRecorder, func()) { t.Helper() + return newInMemoryClientWithOptions(t, &ClientOptions{}) +} + +func newInMemoryClientWithOptions(t *testing.T, opts *ClientOptions) (*Client, *requestRecorder, func()) { + t.Helper() stdinR, stdinW := io.Pipe() stdoutR, stdoutW := io.Pipe() rpcClient := jsonrpc2.NewClient(stdinW, stdoutR) rpcClient.Start() - client := NewClient(&ClientOptions{}) + client := NewClient(opts) client.client = rpcClient client.RPC = rpc.NewServerRPC(rpcClient) client.state = stateConnected @@ -2174,7 +2650,7 @@ func TestResumeSessionRequest_Commands(t *testing.T) { req := resumeSessionRequest{ SessionID: "s1", Commands: []wireCommand{ - {Name: "deploy", Description: "Deploy the app"}, + {Name: "deploy"}, }, } data, err := json.Marshal(req) @@ -2196,6 +2672,9 @@ func TestResumeSessionRequest_Commands(t *testing.T) { if cmd0["name"] != "deploy" { t.Errorf("Expected command name 'deploy', got %v", cmd0["name"]) } + if description, ok := cmd0["description"]; !ok || description != "" { + t.Errorf("Expected empty command description, got %v", description) + } }) t.Run("omits commands from JSON when empty", func(t *testing.T) { @@ -2333,6 +2812,63 @@ func TestCreateSessionRequest_RequestMCPApps(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{ @@ -2363,6 +2899,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", @@ -3305,3 +3903,219 @@ func TestResumeSessionRequest_ExpAssignments(t *testing.T) { } }) } + +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("accepts future bypass-permissions modes", func(t *testing.T) { + req := createSessionRequest{ManagedSettings: &ManagedSettings{ + Permissions: &ManagedSettingsPermissions{ + DisableBypassPermissionsMode: DisableBypassPermissionsMode("future-fail-closed-mode"), + }, + }} + 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) + } + perms := m["managedSettings"].(map[string]any)["permissions"].(map[string]any) + if perms["disableBypassPermissionsMode"] != "future-fail-closed-mode" { + t.Errorf("Expected future mode preserved, got %v", perms["disableBypassPermissionsMode"]) + } + }) + + 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/github_token_provider.go b/go/github_token_provider.go new file mode 100644 index 0000000000..8f1233b7cd --- /dev/null +++ b/go/github_token_provider.go @@ -0,0 +1,84 @@ +package copilot + +import ( + "fmt" + + "github.com/github/copilot-sdk/go/rpc" +) + +// GitHubTokenRequestReason describes why the runtime needs a GitHub token. +// +// Experimental: GitHubTokenRequestReason may change or be removed. +type GitHubTokenRequestReason = rpc.GitHubTokenAcquireReason + +const ( + // GitHubTokenRequestReasonInitial indicates the session needs its initial token. + GitHubTokenRequestReasonInitial = rpc.GitHubTokenAcquireReasonInitial + // GitHubTokenRequestReasonRefresh indicates the session needs a refreshed token. + GitHubTokenRequestReasonRefresh = rpc.GitHubTokenAcquireReasonRefresh +) + +// GitHubTokenProviderArgs contains the context for a GitHub token request. +// +// Experimental: GitHubTokenProviderArgs may change or be removed. +type GitHubTokenProviderArgs struct { + // Host is the effective GitHub host for which a token is needed. + Host string + // SessionID identifies the session receiving the token. It is nil before a + // cloud session has been assigned an ID. + SessionID *string + // Reason indicates whether this is the initial token or a refresh. + Reason GitHubTokenRequestReason +} + +// GitHubToken contains a GitHub access token returned by a provider. +// +// Experimental: GitHubToken may change or be removed. +type GitHubToken struct { + // AccessToken is the GitHub access token. + AccessToken string + // TokenType is the OAuth token type. The runtime defaults it to "bearer". + TokenType *string + // ExpiresIn is the required positive number of seconds remaining when the + // callback completes. Production GitHub tokens typically last eight hours. + ExpiresIn int64 +} + +// String returns a redacted description that never includes the access token. +func (t GitHubToken) String() string { + tokenType := "" + if t.TokenType != nil { + tokenType = *t.TokenType + } + return fmt.Sprintf("GitHubToken{TokenType:%q, ExpiresIn:%d, AccessToken:}", tokenType, t.ExpiresIn) +} + +// GoString returns a redacted Go-syntax description that never includes the access token. +func (t GitHubToken) GoString() string { + return t.String() +} + +// GitHubTokenProviderResult is the result of a GitHub token request. +// +// Experimental: GitHubTokenProviderResult may change or be removed. +type GitHubTokenProviderResult struct { + Cancelled bool + Token *GitHubToken +} + +// GitHubTokenResult returns a successful token-provider result. +func GitHubTokenResult(token *GitHubToken) *GitHubTokenProviderResult { + return &GitHubTokenProviderResult{Token: token} +} + +// GitHubTokenCancelled returns a result indicating that token acquisition was cancelled. +func GitHubTokenCancelled() *GitHubTokenProviderResult { + return &GitHubTokenProviderResult{Cancelled: true} +} + +// GitHubTokenProvider acquires session-scoped GitHub tokens on demand. Initial +// cancellation, errors, and invalid token responses reject session creation or +// resume instead of falling back to ambient authentication. +// +// Experimental: GitHubTokenProvider may change or be removed. +type GitHubTokenProvider func(args GitHubTokenProviderArgs) (*GitHubTokenProviderResult, error) diff --git a/go/github_token_provider_test.go b/go/github_token_provider_test.go new file mode 100644 index 0000000000..f00837379f --- /dev/null +++ b/go/github_token_provider_test.go @@ -0,0 +1,344 @@ +package copilot + +import ( + "encoding/json" + "errors" + "fmt" + "strings" + "sync" + "testing" + "time" + + "github.com/github/copilot-sdk/go/internal/jsonrpc2" + "github.com/github/copilot-sdk/go/rpc" +) + +func TestGitHubTokenProviderConfigValidation(t *testing.T) { + provider := func(GitHubTokenProviderArgs) (*GitHubTokenProviderResult, error) { + return GitHubTokenCancelled(), nil + } + + if _, err := NewClient(nil).CreateSession(t.Context(), &SessionConfig{ + GitHubToken: "static", + GitHubTokenProvider: provider, + }); err == nil || !strings.Contains(err.Error(), "cannot be used together") { + t.Fatalf("CreateSession error = %v", err) + } + if _, err := NewClient(nil).ResumeSession(t.Context(), "session", &ResumeSessionConfig{ + GitHubToken: "static", + GitHubTokenProvider: provider, + }); err == nil || !strings.Contains(err.Error(), "cannot be used together") { + t.Fatalf("ResumeSession error = %v", err) + } +} + +func TestGitHubTokenProviderCreateRequestAndCallback(t *testing.T) { + rpcClient, server, _ := newRuntimeShutdownRpcPair(t) + t.Cleanup(server.Stop) + client := &Client{ + client: rpcClient, + RPC: rpc.NewServerRPC(rpcClient), + sessions: make(map[string]*Session), + } + client.setupNotificationHandler() + + var createParams json.RawMessage + 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 + }) + server.SetRequestHandler("session.destroy", func(json.RawMessage) (json.RawMessage, *jsonrpc2.Error) { + return []byte(`{}`), nil + }) + + var gotArgs GitHubTokenProviderArgs + session, err := client.CreateSession(t.Context(), &SessionConfig{ + GitHubTokenProvider: func(args GitHubTokenProviderArgs) (*GitHubTokenProviderResult, error) { + gotArgs = args + return GitHubTokenResult(&GitHubToken{ + AccessToken: "secret-token", + TokenType: String("bearer"), + ExpiresIn: 8 * 60 * 60, + }), nil + }, + }) + if err != nil { + t.Fatalf("CreateSession failed: %v", err) + } + + var wire struct { + RegistrationID string `json:"gitHubTokenProviderRegistrationId"` + GitHubToken string `json:"gitHubToken"` + } + if err := json.Unmarshal(createParams, &wire); err != nil { + t.Fatal(err) + } + if wire.RegistrationID == "" { + t.Fatal("gitHubTokenProviderRegistrationId was not serialized") + } + if wire.GitHubToken != "" { + t.Fatal("static gitHubToken should not be serialized") + } + + sessionID := session.SessionID + raw, rpcErr := server.Request(t.Context(), "gitHubToken.getToken", &rpc.GitHubTokenAcquireRequest{ + RegistrationID: wire.RegistrationID, + Host: "github.example.com", + SessionID: &sessionID, + Reason: rpc.GitHubTokenAcquireReasonRefresh, + }) + if rpcErr != nil { + t.Fatalf("getToken failed: %v", rpcErr) + } + var tokenResult struct { + Kind string `json:"kind"` + AccessToken string `json:"accessToken"` + ExpiresIn int64 `json:"expiresIn"` + } + if err := json.Unmarshal(raw, &tokenResult); err != nil { + t.Fatal(err) + } + if tokenResult.Kind != "token" || tokenResult.AccessToken != "secret-token" || tokenResult.ExpiresIn != 8*60*60 { + t.Fatalf("unexpected token result: %+v", tokenResult) + } + if gotArgs.Host != "github.example.com" || gotArgs.SessionID == nil || + *gotArgs.SessionID != sessionID || gotArgs.Reason != GitHubTokenRequestReasonRefresh { + t.Fatalf("unexpected callback args: %+v", gotArgs) + } + + if err := session.Disconnect(); err != nil { + t.Fatal(err) + } + if len(client.gitHubTokenProviders) != 0 { + t.Fatal("provider registration was not removed on disconnect") + } + if _, rpcErr := server.Request(t.Context(), "gitHubToken.getToken", &rpc.GitHubTokenAcquireRequest{ + RegistrationID: wire.RegistrationID, + Host: "github.com", + Reason: rpc.GitHubTokenAcquireReasonInitial, + }); rpcErr == nil { + t.Fatal("unknown registration ID should return a handler error") + } + + var resumeParams json.RawMessage + server.SetRequestHandler("session.resume", func(params json.RawMessage) (json.RawMessage, *jsonrpc2.Error) { + resumeParams = append(json.RawMessage(nil), params...) + return []byte(`{"sessionId":"resumed-session","workspacePath":"/workspace"}`), nil + }) + resumed, err := client.ResumeSession(t.Context(), "resumed-session", &ResumeSessionConfig{ + GitHubTokenProvider: func(GitHubTokenProviderArgs) (*GitHubTokenProviderResult, error) { + return GitHubTokenCancelled(), nil + }, + }) + if err != nil { + t.Fatal(err) + } + if err := json.Unmarshal(resumeParams, &wire); err != nil { + t.Fatal(err) + } + if wire.RegistrationID == "" { + t.Fatal("resume did not serialize gitHubTokenProviderRegistrationId") + } + if err := resumed.Disconnect(); err != nil { + t.Fatal(err) + } +} + +func TestGitHubTokenProviderResultsErrorsAndRollback(t *testing.T) { + client := &Client{} + adapter := &gitHubTokenAdapter{client: client} + + cancelID := client.registerGitHubTokenProvider(func(GitHubTokenProviderArgs) (*GitHubTokenProviderResult, error) { + return GitHubTokenCancelled(), nil + }) + result, err := adapter.GetToken(&rpc.GitHubTokenAcquireRequest{RegistrationID: cancelID}) + if err != nil { + t.Fatal(err) + } + if _, ok := result.(*rpc.GitHubTokenAcquireResultCancelled); !ok { + t.Fatalf("result type = %T", result) + } + + sentinel := errors.New("provider failed") + errorID := client.registerGitHubTokenProvider(func(GitHubTokenProviderArgs) (*GitHubTokenProviderResult, error) { + return nil, sentinel + }) + if _, err := adapter.GetToken(&rpc.GitHubTokenAcquireRequest{RegistrationID: errorID}); !errors.Is(err, sentinel) { + t.Fatalf("provider error = %v", err) + } + + rpcClient, server, _ := newRuntimeShutdownRpcPair(t) + t.Cleanup(server.Stop) + rollbackClient := &Client{ + client: rpcClient, + RPC: rpc.NewServerRPC(rpcClient), + sessions: make(map[string]*Session), + } + server.SetRequestHandler("session.create", func(json.RawMessage) (json.RawMessage, *jsonrpc2.Error) { + return nil, &jsonrpc2.Error{Code: -32000, Message: "create failed"} + }) + if _, err := rollbackClient.CreateSession(t.Context(), &SessionConfig{ + GitHubTokenProvider: func(GitHubTokenProviderArgs) (*GitHubTokenProviderResult, error) { + return GitHubTokenCancelled(), nil + }, + }); err == nil { + t.Fatal("expected create failure") + } + if len(rollbackClient.gitHubTokenProviders) != 0 { + t.Fatal("provider registration was not rolled back") + } +} + +func TestGitHubTokenStringRedactsAccessToken(t *testing.T) { + token := GitHubToken{AccessToken: "secret-token", ExpiresIn: 28_800} + + if got := fmt.Sprintf("%v %#v", token, token); strings.Contains(got, token.AccessToken) { + t.Fatalf("GitHubToken formatting exposed the access token: %s", got) + } +} + +func TestGitHubTokenProviderCleanupOnDisconnectError(t *testing.T) { + rpcClient, server, _ := newRuntimeShutdownRpcPair(t) + t.Cleanup(server.Stop) + server.SetRequestHandler("session.destroy", func(json.RawMessage) (json.RawMessage, *jsonrpc2.Error) { + return nil, &jsonrpc2.Error{Code: -32000, Message: "destroy failed"} + }) + client := &Client{} + registrationID := client.registerGitHubTokenProvider(func(GitHubTokenProviderArgs) (*GitHubTokenProviderResult, error) { + return GitHubTokenCancelled(), nil + }) + session := newSession("cleanup-session", rpcClient, "", false) + session.setGitHubTokenProviderRegistrationRelease(func() { + client.unregisterGitHubTokenProvider(registrationID) + }) + + if err := session.Disconnect(); err == nil || !strings.Contains(err.Error(), "destroy failed") { + t.Fatalf("Disconnect error = %v", err) + } + if len(client.gitHubTokenProviders) != 0 { + t.Fatal("provider registration was not removed after disconnect failed") + } +} + +func TestGitHubTokenProviderReleaseBeforeOwnershipTransfer(t *testing.T) { + client := &Client{} + registrationID := client.registerGitHubTokenProvider(func(GitHubTokenProviderArgs) (*GitHubTokenProviderResult, error) { + return GitHubTokenCancelled(), nil + }) + session := &Session{} + + session.releaseGitHubTokenProviderRegistration() + session.setGitHubTokenProviderRegistrationRelease(func() { + client.unregisterGitHubTokenProvider(registrationID) + }) + + if len(client.gitHubTokenProviders) != 0 { + t.Fatal("provider registration was not removed after a pending session had already been retired") + } +} + +func TestGitHubTokenProviderCleanupOnDelete(t *testing.T) { + rpcClient, server, _ := newRuntimeShutdownRpcPair(t) + t.Cleanup(server.Stop) + server.SetRequestHandler("session.delete", func(json.RawMessage) (json.RawMessage, *jsonrpc2.Error) { + return []byte(`{"success":true}`), nil + }) + client := &Client{ + client: rpcClient, + sessions: make(map[string]*Session), + state: stateConnected, + } + registrationID := client.registerGitHubTokenProvider(func(GitHubTokenProviderArgs) (*GitHubTokenProviderResult, error) { + return GitHubTokenCancelled(), nil + }) + session := newSession("delete-session", rpcClient, "", false) + session.setGitHubTokenProviderRegistrationRelease(func() { + client.unregisterGitHubTokenProvider(registrationID) + }) + client.sessions[session.SessionID] = session + + if err := client.DeleteSession(t.Context(), session.SessionID); err != nil { + t.Fatal(err) + } + if len(client.gitHubTokenProviders) != 0 { + t.Fatal("provider registration was not removed after session deletion") + } +} + +func TestSessionOperationsSerializeBySessionID(t *testing.T) { + client := &Client{} + unlockFirst := client.lockSessionOperation("same-session") + sameSessionAcquired := make(chan struct{}) + go func() { + unlock := client.lockSessionOperation("same-session") + close(sameSessionAcquired) + unlock() + }() + + select { + case <-sameSessionAcquired: + t.Fatal("same-session operation was not serialized") + case <-time.After(25 * time.Millisecond): + } + + otherSessionAcquired := make(chan struct{}) + go func() { + unlock := client.lockSessionOperation("other-session") + close(otherSessionAcquired) + unlock() + }() + select { + case <-otherSessionAcquired: + case <-time.After(time.Second): + t.Fatal("different-session operation was unnecessarily blocked") + } + + unlockFirst() + select { + case <-sameSessionAcquired: + case <-time.After(time.Second): + t.Fatal("same-session operation did not proceed after release") + } +} + +func TestGitHubTokenProvidersClearedOnConnectionClose(t *testing.T) { + client := &Client{state: stateConnected} + client.registerGitHubTokenProvider(func(GitHubTokenProviderArgs) (*GitHubTokenProviderResult, error) { + return GitHubTokenCancelled(), nil + }) + + client.handleConnectionClose() + + if len(client.gitHubTokenProviders) != 0 { + t.Fatal("provider registrations were not cleared after connection closure") + } +} + +func TestGitHubTokenProviderConcurrentRegistrationsAreIsolated(t *testing.T) { + client := &Client{} + adapter := &gitHubTokenAdapter{client: client} + idA := client.registerGitHubTokenProvider(func(GitHubTokenProviderArgs) (*GitHubTokenProviderResult, error) { + return GitHubTokenResult(&GitHubToken{AccessToken: "a", ExpiresIn: 1}), nil + }) + idB := client.registerGitHubTokenProvider(func(GitHubTokenProviderArgs) (*GitHubTokenProviderResult, error) { + return GitHubTokenResult(&GitHubToken{AccessToken: "b", ExpiresIn: 1}), nil + }) + + var wg sync.WaitGroup + for id, want := range map[string]string{idA: "a", idB: "b"} { + wg.Add(1) + go func() { + defer wg.Done() + result, err := adapter.GetToken(&rpc.GitHubTokenAcquireRequest{RegistrationID: id}) + if err != nil { + t.Error(err) + return + } + if got := result.(*rpc.GitHubTokenAcquireResultToken).AccessToken; got != want { + t.Errorf("token = %q, want %q", got, want) + } + }() + } + wg.Wait() +} diff --git a/go/inprocess_disabled.go b/go/inprocess_disabled.go index b86ed5ca36..d0626a74d3 100644 --- a/go/inprocess_disabled.go +++ b/go/inprocess_disabled.go @@ -6,6 +6,8 @@ import "errors" const inProcessAvailable = false +var errInProcessUnavailable = errors.New("in-process transport unavailable") + func createInProcessHost(string, inProcessHostConfig) (inProcessHost, error) { - return nil, errors.New("in-process transport unavailable") + return nil, errInProcessUnavailable } diff --git a/go/internal/e2e/abort_e2e_test.go b/go/internal/e2e/abort_e2e_test.go index 0953456888..569518bca7 100644 --- a/go/internal/e2e/abort_e2e_test.go +++ b/go/internal/e2e/abort_e2e_test.go @@ -32,6 +32,7 @@ func TestAbortE2E(t *testing.T) { var mu sync.Mutex var events []copilot.SessionEvent firstDelta := make(chan *copilot.AssistantMessageDeltaData, 1) + sessionIdle := make(chan struct{}, 1) session.On(func(event copilot.SessionEvent) { mu.Lock() @@ -43,6 +44,12 @@ func TestAbortE2E(t *testing.T) { default: } } + if _, ok := event.Data.(*copilot.SessionIdleData); ok { + select { + case sessionIdle <- struct{}{}: + default: + } + } }) // Fire-and-forget β€” we'll abort before it finishes @@ -67,6 +74,11 @@ func TestAbortE2E(t *testing.T) { if err := session.Abort(t.Context()); err != nil { t.Fatalf("Abort failed: %v", err) } + select { + case <-sessionIdle: + case <-time.After(60 * time.Second): + t.Fatal("Timed out waiting for session to become idle after abort") + } mu.Lock() snapshot := make([]copilot.SessionEvent, len(events)) @@ -85,33 +97,15 @@ func TestAbortE2E(t *testing.T) { t.Error("Expected at least one assistant.message_delta event before abort") } - // Session should be usable after abort. Wait for the specific recovery - // message rather than racing against a late idle from the aborted turn. - recoveryReceived := make(chan *copilot.AssistantMessageData, 1) - session.On(func(event copilot.SessionEvent) { - if d, ok := event.Data.(*copilot.AssistantMessageData); ok { - if strings.Contains(strings.ToLower(d.Content), "abort_recovery_ok") { - select { - case recoveryReceived <- d: - default: - } - } - } + // Session should be usable after abort. + msg, err := session.SendAndWait(t.Context(), copilot.MessageOptions{ + Prompt: "Say 'abort_recovery_ok'.", }) - - go func() { - _, _ = session.Send(t.Context(), copilot.MessageOptions{ - Prompt: "Say 'abort_recovery_ok'.", - }) - }() - - select { - case msg := <-recoveryReceived: - if !strings.Contains(strings.ToLower(msg.Content), "abort_recovery_ok") { - t.Errorf("Expected recovery message to contain 'abort_recovery_ok', got %q", msg.Content) - } - case <-time.After(60 * time.Second): - t.Fatal("Timed out waiting for recovery message after abort") + if err != nil { + t.Fatalf("Recovery SendAndWait failed after abort: %v", err) + } + if content := assistantContent(t, msg); !strings.Contains(strings.ToLower(content), "abort_recovery_ok") { + t.Errorf("Expected recovery message to contain 'abort_recovery_ok', got %q", content) } }) @@ -144,6 +138,16 @@ func TestAbortE2E(t *testing.T) { } t.Cleanup(func() { _ = session.Disconnect() }) + sessionIdle := make(chan struct{}, 1) + session.On(func(event copilot.SessionEvent) { + if _, ok := event.Data.(*copilot.SessionIdleData); ok { + select { + case sessionIdle <- struct{}{}: + default: + } + } + }) + // Fire-and-forget go func() { _, _ = session.Send(t.Context(), copilot.MessageOptions{ @@ -172,33 +176,21 @@ func TestAbortE2E(t *testing.T) { case releaseTool <- "RELEASED_AFTER_ABORT": default: } - - // Session should be usable after abort - recoveryReceived := make(chan *copilot.AssistantMessageData, 1) - session.On(func(event copilot.SessionEvent) { - if d, ok := event.Data.(*copilot.AssistantMessageData); ok { - if strings.Contains(d.Content, "tool_abort_recovery_ok") { - select { - case recoveryReceived <- d: - default: - } - } - } - }) - - go func() { - _, _ = session.Send(t.Context(), copilot.MessageOptions{ - Prompt: "Say 'tool_abort_recovery_ok'.", - }) - }() - select { - case msg := <-recoveryReceived: - if !strings.Contains(msg.Content, "tool_abort_recovery_ok") { - t.Errorf("Expected recovery message to contain 'tool_abort_recovery_ok', got %q", msg.Content) - } + case <-sessionIdle: case <-time.After(60 * time.Second): - t.Fatal("Timed out waiting for recovery message after abort") + t.Fatal("Timed out waiting for session to become idle after tool abort") + } + + // Session should be usable after abort. + msg, err := session.SendAndWait(t.Context(), copilot.MessageOptions{ + Prompt: "Say 'tool_abort_recovery_ok'.", + }) + if err != nil { + t.Fatalf("Recovery SendAndWait failed after tool abort: %v", err) + } + if content := assistantContent(t, msg); !strings.Contains(content, "tool_abort_recovery_ok") { + t.Errorf("Expected recovery message to contain 'tool_abort_recovery_ok', got %q", content) } }) } diff --git a/go/internal/e2e/client_options_e2e_test.go b/go/internal/e2e/client_options_e2e_test.go index 1a4879cc57..86332eb6f1 100644 --- a/go/internal/e2e/client_options_e2e_test.go +++ b/go/internal/e2e/client_options_e2e_test.go @@ -165,12 +165,12 @@ func TestClientOptionsE2E(t *testing.T) { 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 @@ -197,6 +197,107 @@ 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) { @@ -763,7 +864,7 @@ 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; diff --git a/go/internal/e2e/commands_and_elicitation_e2e_test.go b/go/internal/e2e/commands_and_elicitation_e2e_test.go index 8d2d40f2f0..af7520a4cc 100644 --- a/go/internal/e2e/commands_and_elicitation_e2e_test.go +++ b/go/internal/e2e/commands_and_elicitation_e2e_test.go @@ -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), diff --git a/go/internal/e2e/github_telemetry_e2e_test.go b/go/internal/e2e/github_telemetry_e2e_test.go index aa26ba31f2..6e1a36383f 100644 --- a/go/internal/e2e/github_telemetry_e2e_test.go +++ b/go/internal/e2e/github_telemetry_e2e_test.go @@ -12,6 +12,11 @@ import ( func TestGitHubTelemetryE2E(t *testing.T) { t.Run("should forward github telemetry for a live session", func(t *testing.T) { + // TODO(cli-1.0.81-2): CLI 1.0.81-2 does not forward GitHub telemetry notifications + // over the in-process (FFI) host, mirroring the existing telemetry-configuration + // limitation. Still covered by the default (stdio) transport. + testharness.SkipIfInProcess(t, "GitHub telemetry forwarding is not honored in-process") + ctx := testharness.NewTestContext(t) ctx.ConfigureForTest(t) diff --git a/go/internal/e2e/hooks_extended_e2e_test.go b/go/internal/e2e/hooks_extended_e2e_test.go index 1afb05a133..5cbba38566 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, OnAgentStop. 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) diff --git a/go/internal/e2e/mcp_and_agents_e2e_test.go b/go/internal/e2e/mcp_and_agents_e2e_test.go index 71a152ecaf..0cc57810ed 100644 --- a/go/internal/e2e/mcp_and_agents_e2e_test.go +++ b/go/internal/e2e/mcp_and_agents_e2e_test.go @@ -88,11 +88,6 @@ func TestMCPServersE2E(t *testing.T) { } sessionID := session1.SessionID - _, err = session1.SendAndWait(t.Context(), copilot.MessageOptions{Prompt: "What is 1+1?"}) - if err != nil { - t.Fatalf("Failed to send message: %v", err) - } - // Resume with MCP servers mcpServers := testMCPServers(t, "test-server") diff --git a/go/internal/e2e/rewind_e2e_test.go b/go/internal/e2e/rewind_e2e_test.go new file mode 100644 index 0000000000..5fc29a13e8 --- /dev/null +++ b/go/internal/e2e/rewind_e2e_test.go @@ -0,0 +1,159 @@ +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) { + if runtime.GOOS == "windows" { + t.Skip("blocked on CLI 1.0.81 file-change tracking regression on Windows") + } + + 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(30 * time.Second) + for { + result, err := session.RPC.History.ListRewindPoints(t.Context()) + if err != nil { + t.Fatalf("ListRewindPoints failed: %v", err) + } + if result.UnavailableReason == nil && + len(result.Points) == 1 && + result.Points[0].CanRestoreFiles && + result.Points[0].FileCount == 1 { + return result + } + if time.Now().After(deadline) { + t.Fatalf("Timed out waiting for a restorable rewind point: %+v", result) + } + 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_server_misc_e2e_test.go b/go/internal/e2e/rpc_server_misc_e2e_test.go index 37ec57e1ba..9607994676 100644 --- a/go/internal/e2e/rpc_server_misc_e2e_test.go +++ b/go/internal/e2e/rpc_server_misc_e2e_test.go @@ -131,7 +131,7 @@ func TestRpcServerMisc(t *testing.T) { login, err := client.RPC.Account.Login(t.Context(), &rpc.AccountLoginRequest{ Host: "https://github.com", - Login: "go-account-user", + Login: rpcPtr("go-account-user"), Token: "go-account-token", }) if err != nil { diff --git a/go/internal/e2e/rpc_session_state_e2e_test.go b/go/internal/e2e/rpc_session_state_e2e_test.go index 00c2e9ef63..88673a9ba9 100644 --- a/go/internal/e2e/rpc_session_state_e2e_test.go +++ b/go/internal/e2e/rpc_session_state_e2e_test.go @@ -566,6 +566,10 @@ func TestRPCSessionStateE2E(t *testing.T) { }) t.Run("should update options and initialize session services", func(t *testing.T) { + // TODO(cli-1.0.81-2): under CLI 1.0.81-2 this subtest issues model traffic before the + // replaying proxy is configured, so the proxy rejects it with "not yet initialized". + // Re-enable once the runtime restores the previous option-update ordering. + t.Skip("blocked on CLI 1.0.81-2 session option/service initialization ordering") initialDirectory := createUniqueRPCWorkDirectory(t, ctx, "rpc-session-state-initial") optionsDirectory := createUniqueRPCWorkDirectory(t, ctx, "rpc-session-state-options") featureName := "rpc-session-state-" + randomHex(t) @@ -1083,7 +1087,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) } diff --git a/go/internal/e2e/rpc_session_state_extras_e2e_test.go b/go/internal/e2e/rpc_session_state_extras_e2e_test.go index 1e33e8a8bc..99dc0b7572 100644 --- a/go/internal/e2e/rpc_session_state_extras_e2e_test.go +++ b/go/internal/e2e/rpc_session_state_extras_e2e_test.go @@ -70,45 +70,45 @@ func TestRpcSessionStateExtras(t *testing.T) { session := createPortedSession(t, client, nil) defer session.Disconnect() defer func() { - _, _ = session.RPC.Permissions.SetAllowAll(t.Context(), &rpc.PermissionsSetAllowAllRequest{Enabled: copilot.Bool(false)}) + _, _ = session.RPC.Permissions.SetMode(t.Context(), &rpc.PermissionsSetModeRequest{Mode: rpc.PermissionModeManual}) }() - initial, err := session.RPC.Permissions.GetAllowAll(t.Context()) + initial, err := session.RPC.Permissions.GetMode(t.Context()) if err != nil { - t.Fatalf("Permissions.GetAllowAll initial failed: %v", err) + t.Fatalf("Permissions.GetMode initial failed: %v", err) } - if initial.Enabled { - t.Fatal("Allow-all should be disabled on a fresh session") + if initial.Mode != rpc.PermissionModeManual { + t.Fatalf("Expected manual mode on a fresh session, got %q", initial.Mode) } - enable, err := session.RPC.Permissions.SetAllowAll(t.Context(), &rpc.PermissionsSetAllowAllRequest{Enabled: copilot.Bool(true)}) + enable, err := session.RPC.Permissions.SetMode(t.Context(), &rpc.PermissionsSetModeRequest{Mode: rpc.PermissionModeAllowAll}) if err != nil { - t.Fatalf("Permissions.SetAllowAll(true) failed: %v", err) + t.Fatalf("Permissions.SetMode(allow-all) failed: %v", err) } - if !enable.Success || !enable.Enabled { - t.Fatalf("Expected successful enable, got %+v", enable) + if !enable.Success || enable.Mode != rpc.PermissionModeAllowAll { + t.Fatalf("Expected successful allow-all mode change, got %+v", enable) } - afterEnable, err := session.RPC.Permissions.GetAllowAll(t.Context()) + afterEnable, err := session.RPC.Permissions.GetMode(t.Context()) if err != nil { - t.Fatalf("Permissions.GetAllowAll after enable failed: %v", err) + t.Fatalf("Permissions.GetMode after allow-all failed: %v", err) } - if !afterEnable.Enabled { - t.Fatal("Expected allow-all to be enabled") + if afterEnable.Mode != rpc.PermissionModeAllowAll { + t.Fatalf("Expected allow-all mode, got %q", afterEnable.Mode) } - disable, err := session.RPC.Permissions.SetAllowAll(t.Context(), &rpc.PermissionsSetAllowAllRequest{Enabled: copilot.Bool(false)}) + disable, err := session.RPC.Permissions.SetMode(t.Context(), &rpc.PermissionsSetModeRequest{Mode: rpc.PermissionModeManual}) if err != nil { - t.Fatalf("Permissions.SetAllowAll(false) failed: %v", err) + t.Fatalf("Permissions.SetMode(manual) failed: %v", err) } - if !disable.Success || disable.Enabled { - t.Fatalf("Expected successful disable, got %+v", disable) + if !disable.Success || disable.Mode != rpc.PermissionModeManual { + t.Fatalf("Expected successful manual mode change, got %+v", disable) } - afterDisable, err := session.RPC.Permissions.GetAllowAll(t.Context()) + afterDisable, err := session.RPC.Permissions.GetMode(t.Context()) if err != nil { - t.Fatalf("Permissions.GetAllowAll after disable failed: %v", err) + t.Fatalf("Permissions.GetMode after manual failed: %v", err) } - if afterDisable.Enabled { - t.Fatal("Expected allow-all to be disabled") + if afterDisable.Mode != rpc.PermissionModeManual { + t.Fatalf("Expected manual mode, got %q", afterDisable.Mode) } }) 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 0267f8d042..648855e5a3 100644 --- a/go/internal/e2e/rpc_tasks_and_handlers_e2e_test.go +++ b/go/internal/e2e/rpc_tasks_and_handlers_e2e_test.go @@ -127,6 +127,7 @@ func TestRPCTasksAndHandlersE2E(t *testing.T) { }) t.Run("should report implemented error for invalid task agent model", func(t *testing.T) { + ctx.ConfigureForTest(t) session, err := client.CreateSession(t.Context(), &copilot.SessionConfig{ OnPermissionRequest: copilot.PermissionHandler.ApproveAll, }) diff --git a/go/internal/e2e/rpc_ui_ephemeral_query_e2e_test.go b/go/internal/e2e/rpc_ui_ephemeral_query_e2e_test.go index 2669faea9a..a431aaee04 100644 --- a/go/internal/e2e/rpc_ui_ephemeral_query_e2e_test.go +++ b/go/internal/e2e/rpc_ui_ephemeral_query_e2e_test.go @@ -14,6 +14,11 @@ func TestRpcUiEphemeralQuery(t *testing.T) { t.Cleanup(func() { client.ForceStop() }) t.Run("should_answer_ephemeral_query", func(t *testing.T) { + // TODO(cli-1.0.81-2): CLI 1.0.81-5 still fails session.ui.ephemeralQuery against the + // recorded snapshot on macOS ("Failed to get response from the AI model"). Re-enable + // once the runtime fix ships. + t.Skip("blocked on CLI 1.0.81-5 session.ui.ephemeralQuery regression on macOS") + ctx.ConfigureForTest(t) session := createPortedSession(t, client, nil) defer session.Disconnect() diff --git a/go/internal/e2e/session_config_e2e_test.go b/go/internal/e2e/session_config_e2e_test.go index 672a905dc0..2ce48e3b33 100644 --- a/go/internal/e2e/session_config_e2e_test.go +++ b/go/internal/e2e/session_config_e2e_test.go @@ -5,10 +5,12 @@ 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" @@ -988,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 13ed75750f..cf39b6784c 100644 --- a/go/internal/e2e/session_e2e_test.go +++ b/go/internal/e2e/session_e2e_test.go @@ -448,6 +448,10 @@ func TestSessionE2E(t *testing.T) { }) t.Run("should resume a session using a new client", func(t *testing.T) { + // TODO(cli-1.0.81-2): resuming a session over the in-process transport no longer + // routes model traffic through COPILOT_API_URL, so the CLI reaches the real + // api.githubcopilot.com and macOS rejects the proxy certificate with an EKU error. + testharness.SkipIfInProcessOnMacOS(t, "session resume ignores COPILOT_API_URL") ctx.ConfigureForTest(t) // Create initial session @@ -1047,7 +1051,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() }) @@ -1072,15 +1081,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) diff --git a/go/internal/e2e/session_fs_e2e_test.go b/go/internal/e2e/session_fs_e2e_test.go index 3ba91c7993..4236e8e529 100644 --- a/go/internal/e2e/session_fs_e2e_test.go +++ b/go/internal/e2e/session_fs_e2e_test.go @@ -196,6 +196,8 @@ func TestSessionFSE2E(t *testing.T) { t.Fatalf("Failed to get messages: %v", err) } toolResult := findToolCallResult(messages, "get_big_string") + // Windows reports the spilled file with backslash separators. + toolResult = strings.ReplaceAll(toolResult, "\\", "/") if !strings.Contains(toolResult, sessionStatePath+"/temp/") { t.Fatalf("Expected tool result to reference %s/temp/, got %q", sessionStatePath, toolResult) } diff --git a/go/internal/e2e/session_fs_sqlite_e2e_test.go b/go/internal/e2e/session_fs_sqlite_e2e_test.go index fa3b49e488..8042614496 100644 --- a/go/internal/e2e/session_fs_sqlite_e2e_test.go +++ b/go/internal/e2e/session_fs_sqlite_e2e_test.go @@ -3,6 +3,7 @@ package e2e import ( "encoding/json" "fmt" + "os" "sort" "strings" "sync" @@ -54,7 +55,7 @@ func (p *inMemorySqliteProvider) ReadFile(path string) (string, error) { defer p.mu.Unlock() content, ok := p.files[path] if !ok { - return "", fmt.Errorf("file not found: %s", path) + return "", fmt.Errorf("%s: %w", path, os.ErrNotExist) } return content, nil } @@ -97,7 +98,7 @@ func (p *inMemorySqliteProvider) Stat(path string) (*copilot.SessionFSFileInfo, IsFile: true, IsDirectory: false, Size: int64(len(content)), Mtime: now, Birthtime: now, }, nil } - return nil, fmt.Errorf("not found: %s", path) + return nil, fmt.Errorf("%s: %w", path, os.ErrNotExist) } func (p *inMemorySqliteProvider) MakeDirectory(path string, recursive bool, mode *int) error { @@ -198,6 +199,26 @@ func (p *inMemorySqliteProvider) Rename(src string, dest string) 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,14 +226,10 @@ 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 + return &copilot.SessionFSSqliteQueryResult{Columns: []string{}, Rows: []map[string]any{}} case rpc.SessionFSSqliteQueryTypeRun: lastID := int64(1) return &copilot.SessionFSSqliteQueryResult{ @@ -220,17 +237,34 @@ func (p *inMemorySqliteProvider) SqliteQuery(queryType rpc.SessionFSSqliteQueryT Rows: []map[string]any{}, RowsAffected: 1, LastInsertRowid: &lastID, - }, nil + } case rpc.SessionFSSqliteQueryTypeQuery: - if strings.Contains(upper, "SELECT") { + // 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) { diff --git a/go/internal/e2e/streaming_fidelity_e2e_test.go b/go/internal/e2e/streaming_fidelity_e2e_test.go index 189b61bf2f..23b1d91a46 100644 --- a/go/internal/e2e/streaming_fidelity_e2e_test.go +++ b/go/internal/e2e/streaming_fidelity_e2e_test.go @@ -142,6 +142,10 @@ func TestStreamingFidelityE2E(t *testing.T) { }) t.Run("should produce deltas after session resume", func(t *testing.T) { + // TODO(cli-1.0.81-2): resuming a session over the in-process transport no longer + // routes model traffic through COPILOT_API_URL, so the CLI reaches the real + // api.githubcopilot.com and macOS rejects the proxy certificate with an EKU error. + testharness.SkipIfInProcessOnMacOS(t, "session resume ignores COPILOT_API_URL") ctx.ConfigureForTest(t) session, err := client.CreateSession(t.Context(), &copilot.SessionConfig{ @@ -212,6 +216,10 @@ func TestStreamingFidelityE2E(t *testing.T) { }) t.Run("should not produce deltas after session resume with streaming disabled", func(t *testing.T) { + // TODO(cli-1.0.81-2): resuming a session over the in-process transport no longer + // routes model traffic through COPILOT_API_URL, so the CLI reaches the real + // api.githubcopilot.com and macOS rejects the proxy certificate with an EKU error. + testharness.SkipIfInProcessOnMacOS(t, "session resume ignores COPILOT_API_URL") ctx.ConfigureForTest(t) session, err := client.CreateSession(t.Context(), &copilot.SessionConfig{ @@ -285,12 +293,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/telemetry_e2e_test.go b/go/internal/e2e/telemetry_e2e_test.go index 4567817fd9..77f8bec8ea 100644 --- a/go/internal/e2e/telemetry_e2e_test.go +++ b/go/internal/e2e/telemetry_e2e_test.go @@ -96,17 +96,6 @@ func TestTelemetryE2E(t *testing.T) { } } - traceIDs := map[string]struct{}{} - for _, span := range spans { - id := stringProp(span, "traceId") - if id != "" { - traceIDs[id] = struct{}{} - } - } - if len(traceIDs) != 1 { - t.Errorf("Expected exactly 1 trace id across spans, got %d (%v)", len(traceIDs), traceIDs) - } - invokeAgent := findSpanWithOperation(spans, "invoke_agent") if invokeAgent == nil { t.Fatal("Expected an invoke_agent span") @@ -121,6 +110,10 @@ func TestTelemetryE2E(t *testing.T) { if invokeAgentSpanID == "" { t.Fatal("invoke_agent span has empty spanId") } + invokeAgentTraceID := stringProp(invokeAgent, "traceId") + if invokeAgentTraceID == "" { + t.Fatal("invoke_agent span has empty traceId") + } var chatSpans []map[string]any for _, span := range spans { @@ -135,6 +128,9 @@ func TestTelemetryE2E(t *testing.T) { if got := stringProp(chat, "parentSpanId"); got != invokeAgentSpanID { t.Errorf("Expected chat span parentSpanId=%q, got %q", invokeAgentSpanID, got) } + if got := stringProp(chat, "traceId"); got != invokeAgentTraceID { + t.Errorf("Expected chat span traceId=%q, got %q", invokeAgentTraceID, got) + } } var sawPromptInput, sawDoneOutput bool for _, chat := range chatSpans { @@ -159,6 +155,9 @@ func TestTelemetryE2E(t *testing.T) { if got := stringProp(toolSpan, "parentSpanId"); got != invokeAgentSpanID { t.Errorf("Expected execute_tool parentSpanId=%q, got %q", invokeAgentSpanID, got) } + if got := stringProp(toolSpan, "traceId"); got != invokeAgentTraceID { + t.Errorf("Expected execute_tool traceId=%q, got %q", invokeAgentTraceID, got) + } if got := stringAttr(toolSpan, "gen_ai.tool.name"); got != toolName { t.Errorf("Expected gen_ai.tool.name=%q, got %q", toolName, got) } diff --git a/go/internal/e2e/testharness/context.go b/go/internal/e2e/testharness/context.go index b73153dfff..037265f9de 100644 --- a/go/internal/e2e/testharness/context.go +++ b/go/internal/e2e/testharness/context.go @@ -114,6 +114,16 @@ func SkipIfInProcess(t *testing.T, reason string) { } } +// SkipIfInProcessOnMacOS skips the test when E2E tests run under the in-process +// (FFI) transport on macOS. Coverage is retained over stdio on every OS and +// in-process on Linux and Windows. +func SkipIfInProcessOnMacOS(t *testing.T, reason string) { + t.Helper() + if isInProcessTransport() && runtime.GOOS == "darwin" { + t.Skipf("unsupported over the in-process (FFI) transport on macOS: %s", reason) + } +} + // NewTestContext creates a new test context with isolated directories and a replaying proxy. func NewTestContext(t *testing.T) *TestContext { t.Helper() @@ -312,6 +322,11 @@ 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() diff --git a/go/internal/e2e/testharness/proxy.go b/go/internal/e2e/testharness/proxy.go index ec16124bc6..2545882bce 100644 --- a/go/internal/e2e/testharness/proxy.go +++ b/go/internal/e2e/testharness/proxy.go @@ -188,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"` diff --git a/go/mode_empty.go b/go/mode_empty.go index 51fc34a4a8..6e238c58c4 100644 --- a/go/mode_empty.go +++ b/go/mode_empty.go @@ -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 @@ -160,12 +164,20 @@ func (c *Client) applyConfigDefaultsForMode(config *SessionConfig) { 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 @@ -204,12 +216,17 @@ func (c *Client) applyResumeDefaultsForMode(config *ResumeSessionConfig) { 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 // session.options.update after create/resume succeeds. In empty mode the // four overridable feature flags default to safe values; caller values win. -// installedPlugins=[] is unconditional in empty mode. +// installedPlugins=[] is unconditional in empty mode. IncludedBuiltinSkills +// defaults to [] but callers can explicitly allow selected runtime-bundled skills. func (c *Client) updateSessionOptionsForMode(ctx context.Context, session *Session, base optBackInFields) error { patch := &rpc.SessionUpdateOptionsParams{} hasAny := false @@ -239,6 +256,11 @@ func (c *Client) updateSessionOptionsForMode(ctx context.Context, session *Sessi patch.ManageScheduleEnabled = &f } patch.InstalledPlugins = []rpc.SessionInstalledPlugin{} + if base.IncludedBuiltinSkills != nil { + patch.IncludedBuiltinSkills = base.IncludedBuiltinSkills + } else { + patch.IncludedBuiltinSkills = []string{} + } hasAny = true } else { if base.SkipCustomInstructions != nil { @@ -257,6 +279,10 @@ func (c *Client) updateSessionOptionsForMode(ctx context.Context, session *Sessi patch.ManageScheduleEnabled = base.ManageScheduleEnabled hasAny = true } + if base.IncludedBuiltinSkills != nil { + patch.IncludedBuiltinSkills = base.IncludedBuiltinSkills + hasAny = true + } } if !hasAny { return nil @@ -281,4 +307,5 @@ type optBackInFields struct { CustomAgentsLocalOnly *bool CoauthorEnabled *bool ManageScheduleEnabled *bool + IncludedBuiltinSkills []string } diff --git a/go/permission_context_test.go b/go/permission_context_test.go new file mode 100644 index 0000000000..16c6d2d592 --- /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 f86a726834..f27f9b6e62 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 0000000000..517450dbfa --- /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 a6b357d54f..05774f4847 100644 --- a/go/rpc/generated_rpc_api_shape_test.go +++ b/go/rpc/generated_rpc_api_shape_test.go @@ -35,9 +35,9 @@ func TestGeneratedRPCAPIShape(t *testing.T) { 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, "MCPConfigAddRequest", "Config", "MCPSerializableServerConfig") + assertStructFieldType(t, file, fileSet, "MCPConfigList", "Servers", "map[string]MCPSerializableServerConfig") + assertStructFieldType(t, file, fileSet, "MCPConfigUpdateRequest", "Config", "MCPSerializableServerConfig") assertStructFieldType(t, file, fileSet, "MCPServerConfigHTTP", "FilterMapping", "FilterMapping") assertStructFieldType(t, file, fileSet, "MCPServerConfigStdio", "FilterMapping", "FilterMapping") diff --git a/go/rpc/permission_request_managed_approval.go b/go/rpc/permission_request_managed_approval.go new file mode 100644 index 0000000000..d1bfa37356 --- /dev/null +++ b/go/rpc/permission_request_managed_approval.go @@ -0,0 +1,93 @@ +// 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 PermissionRequestExtensionEnvAccess) 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 634efbca23..edd5f925fe 100644 --- a/go/rpc/zrpc.go +++ b/go/rpc/zrpc.go @@ -28,12 +28,13 @@ type AbortResult struct { Success bool `json:"success"` } -// Authenticated account entry returned by `account.getAllUsers`, with auth info and an -// optional associated token. +// Authenticated account entry returned by `account.getAllUsers`. // 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"` + // Opaque identifier accepted by account and model selection APIs + SelectionID *string `json:"selectionId,omitempty"` // Associated token, if available Token *string `json:"token,omitempty"` } @@ -56,9 +57,12 @@ type AccountGetCurrentAuthResult struct { // 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. + // GitHub token accepted for compatibility with existing SDK clients. When provided, + // resolves this token instead of using the current account. GitHubToken *string `json:"gitHubToken,omitempty"` + // Opaque account identifier returned by `account.getAllUsers`. When omitted, the current + // account is used. + SelectionID *string `json:"selectionId,omitempty"` } // Quota usage snapshots for the resolved user, keyed by quota type. @@ -69,14 +73,16 @@ type AccountGetQuotaResult struct { QuotaSnapshots map[string]AccountQuotaSnapshot `json:"quotaSnapshots"` } -// Credentials to store after successful authentication +// Credentials to validate and store. Omit login to resolve the authenticated user from the +// token. // 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"` + // User login/username. When omitted, the runtime validates the token and resolves the login + // from GitHub. + Login *string `json:"login,omitempty"` // GitHub authentication token Token string `json:"token"` } @@ -96,7 +102,9 @@ type AccountLoginResult struct { // removed. type AccountLogoutRequest struct { // Authentication information for the user to log out - AuthInfo AuthInfo `json:"authInfo"` + AuthInfo AuthInfo `json:"authInfo,omitempty"` + // Opaque account identifier returned by `account.getAllUsers` + SelectionID *string `json:"selectionId,omitempty"` } // Logout result indicating if more users remain @@ -162,7 +170,7 @@ type AgentGetCurrentResult struct { Agent *AgentInfo `json:"agent,omitempty"` } -// Custom agent metadata, including identifiers, display details, source, tools, model, MCP +// 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 { @@ -178,13 +186,17 @@ type AgentInfo struct { // 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,omitzero"` - // 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. 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,omitzero"` // Where the agent definition was loaded from @@ -196,13 +208,25 @@ type AgentInfo struct { 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). @@ -417,6 +441,16 @@ 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. @@ -429,28 +463,6 @@ type AgentsGetDiscoveryPathsRequest struct { 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 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 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. @@ -843,7 +855,26 @@ type AttachmentSelectionDetailsStart struct { Line int64 `json:"line"` } -// Initial authentication info for the session. +// Credential-free authentication identity safe to expose to hosts and user interfaces. +// Experimental: AuthIdentity is part of an experimental API and may change or be removed. +type AuthIdentity struct { + // Snapshot of the authenticated user's Copilot subscription info, if known + CopilotUser *CopilotUserResponse `json:"copilotUser,omitempty"` + // Name of the environment variable that supplied the credential, when applicable + EnvVar *string `json:"envVar,omitempty"` + // Authentication host + Host string `json:"host"` + // Authenticated login, when available + Login *string `json:"login,omitempty"` + // Opaque SDK GitHub credential registration backing this identity. Routing metadata only; + // never a credential. + RegistrationID *string `json:"registrationId,omitempty"` + // Authentication type + Type AuthInfoType `json:"type"` +} + +// Authentication credentials accepted only at native protocol ingress. Runtime outputs use +// credential-free `AuthIdentity` metadata. // Experimental: AuthInfo is part of an experimental API and may change or be removed. type AuthInfo interface { authInfo() @@ -860,8 +891,8 @@ func (r RawAuthInfoData) Type() AuthInfoType { return r.Discriminator } -// Authentication-info variant for API-key authentication to a non-GitHub LLM provider, -// carrying the secret `apiKey` and host. +// Authentication-info input 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. @@ -897,8 +928,8 @@ func (CopilotAPITokenAuthInfo) Type() AuthInfoType { return AuthInfoTypeCopilotAPIToken } -// Authentication-info variant for a token sourced from an environment variable, with host, -// optional login, token, and env var name. +// Authentication-info input 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 @@ -921,8 +952,8 @@ func (EnvAuthInfo) Type() AuthInfoType { return AuthInfoTypeEnv } -// Authentication-info variant for GitHub CLI credentials, carrying host, login, and the `gh -// auth token` value. +// Authentication-info input 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 @@ -942,8 +973,8 @@ func (GhCLIAuthInfo) Type() AuthInfoType { return AuthInfoTypeGhCLI } -// Authentication-info variant for GitHub-internal HMAC auth, carrying the public GitHub -// host and HMAC secret. +// Authentication-info input 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 @@ -961,8 +992,8 @@ func (HMACAuthInfo) Type() AuthInfoType { return AuthInfoTypeHMAC } -// Authentication-info variant for SDK-configured token authentication, carrying host and -// the secret token value. +// Authentication-info input 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 @@ -971,6 +1002,8 @@ type TokenAuthInfo struct { CopilotUser *CopilotUserResponse `json:"copilotUser,omitempty"` // Authentication host. Host string `json:"host"` + // Opaque native GitHub credential registration backing this token identity, when applicable. + RegistrationID *string `json:"registrationId,omitempty"` // The token value itself. Treat as a secret. Token string `json:"token"` } @@ -980,6 +1013,24 @@ func (TokenAuthInfo) Type() AuthInfoType { return AuthInfoTypeToken } +// Authentication-info variant backed by an SDK GitHub token callback. It carries routing +// metadata but never a plaintext token. +// Experimental: TokenProviderAuthInfo is part of an experimental API and may change or be +// removed. +type TokenProviderAuthInfo struct { + // Snapshot of the authenticated user's Copilot subscription info, if known. + CopilotUser *CopilotUserResponse `json:"copilotUser,omitempty"` + // Authentication host. + Host string `json:"host"` + // Opaque SDK callback registration identifier. + RegistrationID string `json:"registrationId"` +} + +func (TokenProviderAuthInfo) authInfo() {} +func (TokenProviderAuthInfo) Type() AuthInfoType { + return AuthInfoTypeTokenProvider +} + // 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. @@ -999,6 +1050,109 @@ func (UserAuthInfo) Type() AuthInfoType { return AuthInfoTypeUser } +// Validation error from an authentication attempt. +// Experimental: AuthValidationError is part of an experimental API and may change or be +// removed. +type AuthValidationError struct { + // Optional message returned by GitHub + GitHubMessage *string `json:"githubMessage,omitempty"` + // Authentication validation error message + Message string `json:"message"` +} + +// Validation errors from the most recent authentication attempt. +// Experimental: AuthValidationErrors is part of an experimental API and may change or be +// removed. +type AuthValidationErrors []AuthValidationError + +// 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 provider or provider-model metadata. This is not + // necessarily the provider-facing deployment or model name and does not indicate CAPI + // entitlement or provider availability. + ID string `json:"id"` +} + +// Rust-owned metadata and input schema for a built-in tool. +// Experimental: BuiltinToolDescriptor is part of an experimental API and may change or be +// removed. +type BuiltinToolDescriptor struct { + // Model-facing description of the tool's behavior. + Description string `json:"description"` + // Optional custom input format used instead of a JSON Schema. + Format *BuiltinToolFormat `json:"format"` + // Whether the tool provides a specialized intention summary. + HasSummariseIntention bool `json:"hasSummariseIntention"` + // JSON Schema for the tool input, or null when the tool uses a custom format. + InputSchema *BuiltinToolInputSchema `json:"inputSchema"` + // Optional supplemental usage instructions for the tool. + Instructions *string `json:"instructions"` + // Whether the tool executes commands in a terminal. + IsTerminal bool `json:"isTerminal"` + // Stable name used to invoke the built-in tool. + Name string `json:"name"` + // Policy describing which tool metadata may be recorded without obfuscation. + SafeForTelemetry BuiltinToolSafeForTelemetry `json:"safeForTelemetry"` + // Optional human-readable title for the tool. + Title *string `json:"title"` + // Optional tool category discriminator. + Type *string `json:"type"` +} + +// Custom grammar input format accepted by a built-in tool. +// Experimental: BuiltinToolFormat is part of an experimental API and may change or be +// removed. +type BuiltinToolFormat struct { + // Grammar definition accepted by the tool. + Definition string `json:"definition"` + // Grammar syntax used by the format definition. + Syntax string `json:"syntax"` + // Custom input-format discriminator. + Type BuiltinToolFormatType `json:"type"` +} + +// JSON Schema object accepted by a built-in tool. +// Experimental: BuiltinToolInputSchema is part of an experimental API and may change or be +// removed. +type BuiltinToolInputSchema struct { + // Root type of the tool input schema. + Type BuiltinToolInputSchemaType `json:"type"` +} + +// Telemetry-safety policy for a built-in tool. +// Experimental: BuiltinToolSafeForTelemetry is part of an experimental API and may change +// or be removed. +type BuiltinToolSafeForTelemetry interface { + builtinToolSafeForTelemetry() +} + +type BuiltinToolSafeForTelemetryBoolean bool + +func (BuiltinToolSafeForTelemetryBoolean) builtinToolSafeForTelemetry() {} + +func (BuiltinToolSafeTelemetryFields) builtinToolSafeForTelemetry() {} + +// Per-field telemetry-safety policy for a built-in tool. +// Experimental: BuiltinToolSafeTelemetryFields is part of an experimental API and may +// change or be removed. +type BuiltinToolSafeTelemetryFields struct { + // Whether tool input names may be included in telemetry without obfuscation. + InputsNames *bool `json:"inputsNames,omitempty"` + // Whether the tool name may be included in telemetry without obfuscation. + Name *bool `json:"name,omitempty"` +} + // Cancellation result for a user-requested shell command. // Experimental: CancelUserRequestedShellCommandResult is part of an experimental API and // may change or be removed. @@ -1175,6 +1329,26 @@ type CanvasProviderOpenResult struct { URL *string `json:"url,omitempty"` } +// Internal canvas provider registration parameters. +// Experimental: CanvasProviderRegisterRequest is part of an experimental API and may change +// or be removed. +type CanvasProviderRegisterRequest struct { + // Canvas contributions supplied by the provider + Canvases []any `json:"canvases"` + // Connection identifier for callback routing + ConnectionID string `json:"connectionId"` + // Provider metadata supplied by the host + Info any `json:"info"` +} + +// Internal canvas provider unregistration parameters. +// Experimental: CanvasProviderUnregisterRequest is part of an experimental API and may +// change or be removed. +type CanvasProviderUnregisterRequest struct { + // Connection identifier to unregister + ConnectionID string `json:"connectionId"` +} + // Session context supplied by the runtime. // Experimental: CanvasSessionContext is part of an experimental API and may change or be // removed. @@ -1195,6 +1369,473 @@ type CapiSessionOptions struct { EnableWebSocketResponses *bool `json:"enableWebSocketResponses,omitempty"` } +// Semantic digest of a strictly parsed and schema-validated JSON MCP card. Both URL-backed +// and embedded cards are canonicalised with RFC 8785 JSON Canonicalization Scheme, encoded +// as UTF-8, and hashed with SHA-256. +// Experimental: CardDigest is part of an experimental API and may change or be removed. +type CardDigest struct { + // Digest algorithm and canonical representation + Algorithm CardDigestAlgorithm `json:"algorithm"` + // SHA-256 digest of the RFC 8785 canonical UTF-8 bytes, encoded as exactly 64 lowercase + // hexadecimal characters. + Value string `json:"value"` +} + +// SHA-256 digest encoded as exactly 64 lowercase hexadecimal characters. +// Experimental: CardDigestValue is part of an experimental API and may change or be removed. +type CardDigestValue string + +// Where and when an AI skill catalog reference was observed. Discovery provenance +// deliberately carries no content digest because search does not establish the exact +// validated content a later plan will bind. +// Experimental: CatalogAiSkillCandidateProvenance is part of an experimental API and may +// change or be removed. +type CatalogAiSkillCandidateProvenance struct { + // Host of the catalog authority that advertised the reference, without path, query, or + // credentials. Inert untrusted data. + Authority string `json:"authority"` + // Media type advertised for the referenced AI skill card + MediaType CatalogAiSkillCandidateProvenanceMediaType `json:"mediaType"` + // ISO 8601 timestamp at which the runtime observed the catalog reference. This is not a + // retrieval or validation timestamp. + ObservedAt string `json:"observedAt"` +} + +// One inert catalog result, represented as an MCP server or discovery-only AI skill variant +// so kind, media type, provenance, and installability cannot contradict each other. +// Experimental: CatalogCandidate is part of an experimental API and may change or be +// removed. +type CatalogCandidate interface { + catalogCandidate() + Kind() CatalogCandidateKind +} + +type RawCatalogCandidateData struct { + Discriminator CatalogCandidateKind + Raw json.RawMessage +} + +func (RawCatalogCandidateData) catalogCandidate() {} +func (r RawCatalogCandidateData) Kind() CatalogCandidateKind { + return r.Discriminator +} + +// An inert AI skill catalog result. AI skills are discovery-only and cannot be represented +// as installable through this surface. +// Experimental: CatalogAiSkillCandidate is part of an experimental API and may change or be +// removed. +type CatalogAiSkillCandidate struct { + // Description taken verbatim from the card. Inert untrusted text. + Description *string `json:"description,omitempty"` + // Display name taken verbatim from the card. Inert untrusted text. + DisplayName string `json:"displayName"` + // Opaque, runtime-instance scoped, TTL-bound, single-use handle for this candidate. Carries + // no readable information and is rejected when stale, replayed, or presented to a different + // runtime instance. Never logged. + Handle string `json:"handle"` + // ISO 8601 timestamp after which the handle is stale and will be rejected. + HandleExpiresAt string `json:"handleExpiresAt"` + // AI skills are discovery-only and cannot be installed through this surface + Installability CatalogAiSkillCandidateInstallability `json:"installability"` + // Media type of the underlying AI skill card + MediaType CatalogAiSkillCandidateMediaType `json:"mediaType"` + // Where the catalog reference was observed, without the card itself or any content digest. + Provenance CatalogAiSkillCandidateProvenance `json:"provenance"` + // Publisher taken verbatim from the card. Inert untrusted text. + Publisher *string `json:"publisher,omitempty"` + // Where the card came from: exactly one of a URL or embedded data, encoded as a tagged + // union so neither both nor neither can be represented. + Source CatalogCandidateSource `json:"source"` +} + +func (CatalogAiSkillCandidate) catalogCandidate() {} +func (CatalogAiSkillCandidate) Kind() CatalogCandidateKind { + return CatalogCandidateKindAiSkill +} + +// An inert MCP server catalog result. Every free-text field is untrusted external data and +// must never be treated as an instruction, and the handle is the only way to refer to the +// candidate in a later operation. +// Experimental: CatalogMCPServerCandidate is part of an experimental API and may change or +// be removed. +type CatalogMCPServerCandidate struct { + // Description taken verbatim from the card. Inert untrusted text. + Description *string `json:"description,omitempty"` + // Display name taken verbatim from the card. Inert untrusted text. + DisplayName string `json:"displayName"` + // Opaque, runtime-instance scoped, TTL-bound, single-use handle for this candidate. Carries + // no readable information and is rejected when stale, replayed, or presented to a different + // runtime instance. Never logged. + Handle string `json:"handle"` + // ISO 8601 timestamp after which the handle is stale and will be rejected. + HandleExpiresAt string `json:"handleExpiresAt"` + // Whether this MCP server can be planned for installation, and if policy prevents it. + Installability CatalogMCPServerInstallability `json:"installability"` + // JSON MCP media type of the underlying card. + MediaType MCPServerCardMediaType `json:"mediaType"` + // Where the catalog reference was observed, without the card itself or any content digest. + Provenance CatalogMCPServerCandidateProvenance `json:"provenance"` + // Publisher taken verbatim from the card. Inert untrusted text. + Publisher *string `json:"publisher,omitempty"` + // Where the card came from: exactly one of a URL or embedded data, encoded as a tagged + // union so neither both nor neither can be represented. + Source CatalogCandidateSource `json:"source"` +} + +func (CatalogMCPServerCandidate) catalogCandidate() {} +func (CatalogMCPServerCandidate) Kind() CatalogCandidateKind { + return CatalogCandidateKindMCPServer +} + +// Where a candidate's card came from. Exactly one of a URL or embedded data: the union has +// no variant carrying both, and no variant carrying neither, so the rule holds structurally +// rather than by validation. +// Experimental: CatalogCandidateSource is part of an experimental API and may change or be +// removed. +type CatalogCandidateSource interface { + catalogCandidateSource() + Kind() CatalogCandidateSourceKind +} + +type RawCatalogCandidateSourceData struct { + Discriminator CatalogCandidateSourceKind + Raw json.RawMessage +} + +func (RawCatalogCandidateSourceData) catalogCandidateSource() {} +func (r RawCatalogCandidateSourceData) Kind() CatalogCandidateSourceKind { + return r.Discriminator +} + +// Candidate whose card reference arrived inline. The document and its content-derived +// properties stay behind the runtime boundary. +// Experimental: CatalogCandidateSourceEmbedded is part of an experimental API and may +// change or be removed. +type CatalogCandidateSourceEmbedded struct { +} + +func (CatalogCandidateSourceEmbedded) catalogCandidateSource() {} +func (CatalogCandidateSourceEmbedded) Kind() CatalogCandidateSourceKind { + return CatalogCandidateSourceKindEmbedded +} + +// Candidate whose card is retrieved from a URL through the runtime's hardened fetch +// boundary. +// Experimental: CatalogCandidateSourceURL is part of an experimental API and may change or +// be removed. +type CatalogCandidateSourceURL struct { + // Card URL as advertised. Inert untrusted data: the runtime retrieves it only through its + // own hardened boundary, and it is never logged. + URL string `json:"url"` +} + +func (CatalogCandidateSourceURL) catalogCandidateSource() {} +func (CatalogCandidateSourceURL) Kind() CatalogCandidateSourceKind { + return CatalogCandidateSourceKindURL +} + +// Bounded extensible wire-feature identifier. Known values are described by +// `CatalogCapability`; newer callers may send future identifiers so an older runtime can +// return a typed negotiation refusal instead of failing schema validation. Capability +// negotiation establishes contract understanding, while each operation's result separately +// reports runtime availability. +// Experimental: CatalogCapabilityID is part of an experimental API and may change or be +// removed. +type CatalogCapabilityID string + +// The protocol version and capability set a caller requires, supplied on every catalog +// request so negotiation cannot be skipped by omission. +// Experimental: CatalogClientContract is part of an experimental API and may change or be +// removed. +type CatalogClientContract struct { + // SDK protocol version the caller was generated against. A caller below the runtime's + // minimum supported version is refused rather than served a partial result. + ProtocolVersion int64 `json:"protocolVersion"` + // Wire features the caller requires the runtime to understand. Identifiers are bounded but + // extensible so a newer caller can negotiate with an older runtime. Requiring an unknown + // feature yields a typed refusal listing what is understood, never a partial grant. A grant + // does not promise that a deployment has enabled the operation; typed unavailable results + // report that separately. + RequiredCapabilities []string `json:"requiredCapabilities"` +} + +// Where and when an MCP server catalog reference was observed. Discovery provenance +// deliberately carries no content digest because search does not establish the exact +// validated content a later plan will bind. +// Experimental: CatalogMCPServerCandidateProvenance is part of an experimental API and may +// change or be removed. +type CatalogMCPServerCandidateProvenance struct { + // Host of the catalog authority that advertised the reference, without path, query, or + // credentials. Inert untrusted data. + Authority string `json:"authority"` + // JSON MCP media type advertised for the referenced card. + MediaType MCPServerCardMediaType `json:"mediaType"` + // ISO 8601 timestamp at which the runtime observed the catalog reference. This is not a + // retrieval or validation timestamp. + ObservedAt string `json:"observedAt"` +} + +// The protocol version and capability set the runtime actually honoured for a successful +// catalog operation. +// Experimental: CatalogNegotiatedContract is part of an experimental API and may change or +// be removed. +type CatalogNegotiatedContract struct { + // Wire features the runtime understood for this operation. Always a superset of the + // caller's required features, because any shortfall is a refusal instead. Operation + // availability remains a separate typed result. + GrantedCapabilities []CatalogCapability `json:"grantedCapabilities"` + // Protocol version of the runtime that served the request. + RuntimeProtocolVersion int64 `json:"runtimeProtocolVersion"` +} + +// A bounded catalog search. Both the query length and the result count are capped by the +// schema so a caller cannot request an unbounded scan. +// Experimental: CatalogSearchRequest is part of an experimental API and may change or be +// removed. +type CatalogSearchRequest struct { + // Protocol version and capabilities the caller requires. + Contract CatalogClientContract `json:"contract"` + // Restrict results to these candidate kinds. When omitted, every kind the runtime supports + // is searched. + Kinds []CatalogCandidateKind `json:"kinds,omitzero"` + // Maximum number of candidates to return. Defaults to 10 when omitted. + Limit *int32 `json:"limit,omitempty"` + // Free-text search query. Never written to logs or telemetry. + Query string `json:"query"` +} + +// Outcome of a catalog.search call: either bounded inert candidates, or one typed refusal. +// Never a partial success. +// Experimental: CatalogSearchResult is part of an experimental API and may change or be +// removed. +type CatalogSearchResult interface { + catalogSearchResult() + Kind() CatalogSearchResultKind +} + +type RawCatalogSearchResultData struct { + Discriminator CatalogSearchResultKind + Raw json.RawMessage +} + +func (RawCatalogSearchResultData) catalogSearchResult() {} +func (r RawCatalogSearchResultData) Kind() CatalogSearchResultKind { + return r.Discriminator +} + +// An optional catalog authentication exchange did not establish the caller's identity. +// Anonymous search remains supported; this refusal is reserved for an operation that cannot +// continue after the attempted exchange. It is distinct from `policy-rejected` and from a +// network failure, and the reason identifies the recovery action. +// Experimental: CatalogAuthenticationRequiredError is part of an experimental API and may +// change or be removed. +type CatalogAuthenticationRequiredError struct { + // Human-readable explanation, safe to surface. Never contains a credential or token, nor a + // query, URL, handle, or secret. + Message string `json:"message"` + // Why authentication failed. Only an expired credential justifies attempting a silent + // refresh; an absent or rejected credential requires sign-in. + Reason CatalogAuthenticationRequiredReason `json:"reason"` +} + +func (CatalogAuthenticationRequiredError) catalogSearchResult() {} +func (CatalogAuthenticationRequiredError) Kind() CatalogSearchResultKind { + return CatalogSearchResultKindAuthenticationRequired +} + +// An upstream catalog response broke the wire contract. Most importantly, every result must +// carry exactly one of a URL or embedded data: a result carrying both, or neither, is +// refused here rather than being guessed at. +// Experimental: CatalogContractViolationError is part of an experimental API and may change +// or be removed. +type CatalogContractViolationError struct { + // Human-readable explanation, safe to surface. Never echoes response content, nor a query, + // URL, handle, or secret. + Message string `json:"message"` + // Which rule the response broke. + Reason CatalogContractViolationReason `json:"reason"` +} + +func (CatalogContractViolationError) catalogSearchResult() {} +func (CatalogContractViolationError) Kind() CatalogSearchResultKind { + return CatalogSearchResultKindContractViolation +} + +// The request was rejected before any work was done, because a bounded field fell outside +// its permitted range or a required field was unusable. +// Experimental: CatalogInvalidRequestError is part of an experimental API and may change or +// be removed. +type CatalogInvalidRequestError struct { + // Which request field was rejected. + Field CatalogInvalidRequestField `json:"field"` + // Human-readable explanation, safe to surface. Never echoes the offending value, nor a + // query, URL, handle, or secret. + Message string `json:"message"` +} + +func (CatalogInvalidRequestError) catalogSearchResult() {} +func (CatalogInvalidRequestError) Kind() CatalogSearchResultKind { + return CatalogSearchResultKindInvalidRequest +} + +// A card could not be parsed or did not satisfy its declared media type's schema. +// Experimental: CatalogMalformedCardError is part of an experimental API and may change or +// be removed. +type CatalogMalformedCardError struct { + // Media type the card was interpreted as, when it declared one this runtime recognises. + MediaType *CatalogMediaType `json:"mediaType,omitempty"` + // Human-readable explanation, safe to surface. Never echoes card content, nor a query, URL, + // handle, or secret. + Message string `json:"message"` + // How the card failed validation. + Reason CatalogMalformedCardReason `json:"reason"` +} + +func (CatalogMalformedCardError) catalogSearchResult() {} +func (CatalogMalformedCardError) Kind() CatalogSearchResultKind { + return CatalogSearchResultKindMalformedCard +} + +// The caller's protocol version or required capabilities cannot be honoured. Returned +// instead of a partial or ambiguous success. +// Experimental: CatalogNegotiationRefusedError is part of an experimental API and may +// change or be removed. +type CatalogNegotiationRefusedError struct { + // Human-readable explanation, safe to surface. Never contains a query, URL, handle, or + // secret. + Message string `json:"message"` + // Lowest caller protocol version this runtime will serve. + MinimumSupportedProtocolVersion int64 `json:"minimumSupportedProtocolVersion"` + // Whether the version or the capability set was the problem. + Reason CatalogNegotiationRefusedReason `json:"reason"` + // Protocol version of the runtime that refused the request. + RuntimeProtocolVersion int64 `json:"runtimeProtocolVersion"` + // Every wire feature this runtime understands, so the caller can retry within that + // contract. This list does not imply that every deployment has enabled every operation. + SupportedCapabilities []CatalogCapability `json:"supportedCapabilities"` + // The subset of the caller's bounded extensible capability identifiers this runtime cannot + // honour. + UnsupportedCapabilities []string `json:"unsupportedCapabilities"` +} + +func (CatalogNegotiationRefusedError) catalogSearchResult() {} +func (CatalogNegotiationRefusedError) Kind() CatalogSearchResultKind { + return CatalogSearchResultKindNegotiationRefused +} + +// The runtime could not reach the catalog authority or retrieve a card. Covers being +// offline as well as transport-level failure. +// Experimental: CatalogNetworkFailureError is part of an experimental API and may change or +// be removed. +type CatalogNetworkFailureError struct { + // Human-readable explanation, safe to surface. Never contains a query, URL, handle, or + // secret. + Message string `json:"message"` + // Categorised failure, low cardinality so it can be aggregated without carrying a URL. + Reason CatalogNetworkFailureReason `json:"reason"` + // HTTP status code, when the failure was a rejected response. + StatusCode *int32 `json:"statusCode,omitempty"` +} + +func (CatalogNetworkFailureError) catalogSearchResult() {} +func (CatalogNetworkFailureError) Kind() CatalogSearchResultKind { + return CatalogSearchResultKindNetworkFailure +} + +// Registry or enterprise policy refused the operation. +// Experimental: CatalogPolicyRejectedError is part of an experimental API and may change or +// be removed. +type CatalogPolicyRejectedError struct { + // Human-readable explanation, safe to surface. Never contains a query, URL, handle, or + // secret. + Message string `json:"message"` + // Which authority produced the decision. + Source MCPPlanPolicySource `json:"source"` +} + +func (CatalogPolicyRejectedError) catalogSearchResult() {} +func (CatalogPolicyRejectedError) Kind() CatalogSearchResultKind { + return CatalogSearchResultKindPolicyRejected +} + +// A completed catalog search: inert candidate summaries, each carrying a single-use handle. +// Experimental: CatalogSearchSucceeded is part of an experimental API and may change or be +// removed. +type CatalogSearchSucceeded struct { + // Matching candidates, never more than the requested limit. All text is inert untrusted + // data. + Candidates []CatalogCandidate `json:"candidates"` + // Protocol version and capabilities the runtime honoured. + Negotiated CatalogNegotiatedContract `json:"negotiated"` + // Pseudonymous identifier for this search, issued by the runtime or by the catalog + // authority it queried and never by the caller, so it cannot be forged or replayed to + // attribute an install to a search that never happened. Always present on a success, so a + // result set can be tied to the installs it leads to. It identifies a search rather than a + // person: it is derived from no user, account, device, or query data, and must never be + // joined with user identity to re-identify anyone. + SearchID string `json:"searchId"` + // Whether further matches existed beyond the requested limit. + Truncated bool `json:"truncated"` +} + +func (CatalogSearchSucceeded) catalogSearchResult() {} +func (CatalogSearchSucceeded) Kind() CatalogSearchResultKind { + return CatalogSearchResultKindSucceeded +} + +// The operation is not available on this runtime. Distinct from a network failure: nothing +// was attempted. +// Experimental: CatalogUnavailableError is part of an experimental API and may change or be +// removed. +type CatalogUnavailableError struct { + // Human-readable explanation, safe to surface. Never contains a query, URL, handle, or + // secret. + Message string `json:"message"` + // Why the operation is unavailable. + Reason CatalogUnavailableReason `json:"reason"` +} + +func (CatalogUnavailableError) catalogSearchResult() {} +func (CatalogUnavailableError) Kind() CatalogSearchResultKind { + return CatalogSearchResultKindUnavailable +} + +// Retrieval was refused by the runtime's hardened fetch boundary before any request left +// the process, or before a redirect was followed. +// Experimental: CatalogUnsafeRetrievalError is part of an experimental API and may change +// or be removed. +type CatalogUnsafeRetrievalError struct { + // Human-readable explanation, safe to surface. Never contains the refused URL, nor a query, + // handle, or secret. + Message string `json:"message"` + // Which control refused the retrieval, low cardinality so it can be aggregated without + // carrying a URL. + Reason CatalogUnsafeRetrievalReason `json:"reason"` +} + +func (CatalogUnsafeRetrievalError) catalogSearchResult() {} +func (CatalogUnsafeRetrievalError) Kind() CatalogSearchResultKind { + return CatalogSearchResultKindUnsafeRetrieval +} + +// The request asked for a candidate kind this runtime does not serve. +// Experimental: CatalogUnsupportedKindError is part of an experimental API and may change +// or be removed. +type CatalogUnsupportedKindError struct { + // Human-readable explanation, safe to surface. Never contains a query, URL, handle, or + // secret. + Message string `json:"message"` + // The kinds from the request that are not supported. + RequestedKinds []CatalogCandidateKind `json:"requestedKinds"` + // Every candidate kind this runtime can serve. + SupportedKinds []CatalogCandidateKind `json:"supportedKinds"` +} + +func (CatalogUnsupportedKindError) catalogSearchResult() {} +func (CatalogUnsupportedKindError) Kind() CatalogSearchResultKind { + return CatalogSearchResultKindUnsupportedKind +} + // 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 { @@ -1202,6 +1843,28 @@ type CommandList struct { Commands []SlashCommandInfo `json:"commands"` } +// The pending slash-command invocation effect to finalize, plus whether the host applied or +// cancelled it. +// Experimental: CommandsFinalizeInvocationEffectRequest is part of an experimental API and +// may change or be removed. +type CommandsFinalizeInvocationEffectRequest struct { + // The slash-command result object that produced the pending effect, echoed back unchanged. + Effect any `json:"effect"` + // Whether the host applied or cancelled the pending invocation effect. + Outcome CommandsInvocationEffectOutcome `json:"outcome"` +} + +// Whether finalizing the invocation effect succeeded, and the failure reason when it did +// not. +// Experimental: CommandsFinalizeInvocationEffectResult is part of an experimental API and +// may change or be removed. +type CommandsFinalizeInvocationEffectResult struct { + // Failure reason when the invocation effect could not be finalized. + Error *string `json:"error,omitempty"` + // Whether the pending invocation effect was finalized successfully. + Success bool `json:"success"` +} + // Pending command request ID and an optional error if the client handler failed. // Experimental: CommandsHandlePendingCommandRequest is part of an experimental API and may // change or be removed. @@ -1228,9 +1891,10 @@ type CommandsInvokeRequest struct { Input *string `json:"input,omitempty"` // Command name. Leading slashes are stripped and the name is matched case-insensitively. Name string `json:"name"` + // Optional client surface that initiated the invocation + Origin *CommandsInvocationOrigin `json:"origin,omitempty"` } -// 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 { @@ -1308,6 +1972,25 @@ type ConfigureSessionExtensionsParams struct { SessionID string `json:"sessionId"` } +// Identity of the integrating host, declared once on the `server.connect` handshake so +// telemetry from this connection is attributed to a single, consistent surface. All fields +// are optional; omit them to keep the default attribution. +// Experimental: ConnectClientInfo is part of an experimental API and may change or be +// removed. +// Internal: ConnectClientInfo is an internal SDK API and is not part of the public surface. +type ConnectClientInfo struct { + // Name of the host editor, e.g. `"vscode"`. + EditorName *string `json:"editorName,omitempty"` + // Version of the host editor, e.g. `"1.124.2"`. Ignored unless it looks like a version + // string. + EditorVersion *string `json:"editorVersion,omitempty"` + // Name of the Copilot extension within the host, e.g. `"copilot-chat"`. + ExtensionName *string `json:"extensionName,omitempty"` + // Version of the Copilot extension within the host, e.g. `"0.54.0"`. Ignored unless it + // looks like a version string. + ExtensionVersion *string `json:"extensionVersion,omitempty"` +} + // Metadata for a connected remote session. // Experimental: ConnectedRemoteSessionMetadata is part of an experimental API and may // change or be removed. @@ -1356,18 +2039,25 @@ type ConnectRemoteSessionParams struct { SessionID string `json:"sessionId"` } -// Parameters for the `server.connect` handshake: an optional connection token and optional -// connection-level opt-ins (e.g. GitHub telemetry forwarding). +// Connection-level opt-ins for the `server.connect` handshake. Transport authentication is +// consumed by the native protocol boundary before dispatch. // 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 { + // Identity of the integrating host. Optional; omit it to keep the default attribution. + // Internal: ClientInfo is part of the SDK's internal API surface and is not intended for + // external use. + ClientInfo *ConnectClientInfo `json:"clientInfo,omitempty"` // 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, in - // addition to the runtime's normal GitHub/CTS emission (dual-write). 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. + // 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"` @@ -1385,6 +2075,38 @@ type ConnectResult struct { Version string `json:"version"` } +// 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. @@ -1468,15 +2190,23 @@ type CopilotUserResponse struct { // Experimental: CopilotUserResponseEndpoints is part of an experimental API and may change // or be removed. type CopilotUserResponseEndpoints struct { - API *string `json:"api,omitempty"` + // Copilot API endpoint URL. + API *string `json:"api,omitempty"` + // Experimental-service endpoint URL. + Exp *string `json:"exp,omitempty"` + // Origin-tracker endpoint URL. OriginTracker *string `json:"origin-tracker,omitempty"` - Proxy *string `json:"proxy,omitempty"` - Telemetry *string `json:"telemetry,omitempty"` + // Copilot proxy endpoint URL. + Proxy *string `json:"proxy,omitempty"` + // Copilot telemetry endpoint URL. + Telemetry *string `json:"telemetry,omitempty"` } type CopilotUserResponseOrganizationListItem struct { + // GitHub login of the organization. Login *string `json:"login,omitempty"` - Name *string `json:"name,omitempty"` + // Display name of the organization. + Name *string `json:"name,omitempty"` } // Quota snapshot map from the raw Copilot user-response passthrough, with chat, @@ -1790,6 +2520,59 @@ type DiscoveredCanvas struct { InputSchema any `json:"inputSchema,omitempty"` } +// 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 @@ -1831,6 +2614,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 @@ -1839,6 +2627,24 @@ 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 *int64 `json:"max,omitempty"` // Either '*' to receive all event types, or a non-empty list of event types to receive @@ -1847,7 +2653,10 @@ type EventLogReadRequest struct { // (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"` } @@ -1885,20 +2694,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"` } @@ -1939,6 +2759,44 @@ type Extension struct { 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 { @@ -1954,6 +2812,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. @@ -1962,6 +2825,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. @@ -2112,6 +2980,9 @@ type ExternalToolTextResultForLlmContentShellExit struct { Cwd *string `json:"cwd,omitempty"` // Exit code from the completed shell command ExitCode int64 `json:"exitCode"` + // Path reported in the shell session's filesystem namespace when shell output exceeded the + // configured large-output threshold. + OutputFilePath *string `json:"outputFilePath,omitempty"` // 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"` @@ -2234,10 +3105,16 @@ type FactoryAckResult struct { // 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"` } @@ -2246,6 +3123,8 @@ type FactoryAgentOptions struct { // 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. @@ -2262,6 +3141,40 @@ type FactoryAgentResult struct { 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 { + // Accumulated active agent time in milliseconds. + ActiveMs int64 `json:"activeMs"` + // Prompt-safe live activity text. + Activity *string `json:"activity,omitempty"` + // Stable direct-agent identifier. + AgentID string `json:"agentId"` + // Registered agent type. + AgentType string `json:"agentType"` + // Epoch milliseconds when the agent completed. + CompletedAt *int64 `json:"completedAt,omitempty"` + // Friendly, non-unique name intended for display + DisplayName *string `json:"displayName,omitempty"` + // Friendly, non-unique name intended for display + Label string `json:"label"` + // Phase identifier active when the agent was launched, or null. + PhaseID *string `json:"phaseId"` + // Model requested when the agent was launched. + RequestedModel *string `json:"requestedModel,omitempty"` + // Concrete model resolved for the agent. + ResolvedModel *string `json:"resolvedModel,omitempty"` + // Owning factory run identifier. + RunID string `json:"runId"` + // Epoch milliseconds when the agent started. + StartedAt *int64 `json:"startedAt,omitempty"` + // Current durable or live agent status. + Status string `json:"status"` + // Tool-call identifier that launched the agent. + ToolCallID string `json:"toolCallId"` +} + // Parameters for cancelling a factory run. // Experimental: FactoryCancelRequest is part of an experimental API and may change or be // removed. @@ -2270,12 +3183,38 @@ type FactoryCancelRequest struct { 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 { + // Current phase identifier. + ID string `json:"id"` + // Zero-based declared phase ordinal, or null for an undeclared phase. + 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 { + // Maximum AI credits consumed by subagents and descendants. + MaxAiCredits *float64 `json:"maxAiCredits,omitempty"` + // Maximum concurrently active subagents. + MaxConcurrentSubagents *int64 `json:"maxConcurrentSubagents,omitempty"` + // Maximum total subagents spawned by the run. + MaxTotalSubagents *int64 `json:"maxTotalSubagents,omitempty"` + // Maximum accumulated active execution time in seconds. + 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. @@ -2289,7 +3228,23 @@ type FactoryExecuteRequest struct { // removed. type FactoryExecuteResult struct { // Factory result value. - Result any `json:"result"` + 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. @@ -2304,6 +3259,8 @@ type FactoryGetRunRequest struct { // 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. @@ -2324,6 +3281,8 @@ type FactoryJournalGetResult struct { // 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. @@ -2332,6 +3291,34 @@ type FactoryJournalPutRequest struct { 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"` + // Factory run summaries in durable creation order. + 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 { @@ -2347,12 +3334,171 @@ type FactoryLogLine struct { // 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 { + // Completed active time accumulated by this phase in milliseconds. + AccumulatedActiveMs int64 `json:"accumulatedActiveMs"` + // Epoch milliseconds when this phase completed; for a skipped phase, the synthetic skip + // timestamp (equal to `startedAt`). + CompletedAt *int64 `json:"completedAt,omitempty"` + // Current live active time for this phase in milliseconds. + CurrentActiveMs int64 `json:"currentActiveMs"` + // Optional human-readable phase detail. + Detail *string `json:"detail,omitempty"` + // Number of times execution entered this phase. + EntryCount int64 `json:"entryCount"` + // Phase identifier. + ID string `json:"id"` + // Most recent run attempt that entered this phase, or `0` if the phase has never been + // entered. + LastEnteredRunAttempt int64 `json:"lastEnteredRunAttempt"` + // Direct agents in this phase that are currently live. + LiveAgentCount int64 `json:"liveAgentCount"` + // Zero-based declared phase ordinal, or null for an undeclared phase. + Ordinal *int64 `json:"ordinal"` + // Epoch milliseconds when this phase first started; for a skipped phase, the synthetic skip + // timestamp (equal to `completedAt`). + StartedAt *int64 `json:"startedAt,omitempty"` + // Derived lifecycle state of the phase. + Status FactoryPhaseStatus `json:"status"` + // Human-readable phase title. + Title string `json:"title"` + // Total direct agents associated with this phase. + 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 { + // Whether progress records newer than this page exist. + HasMoreNewer bool `json:"hasMoreNewer"` + // Whether progress records older than this page exist. + HasMoreOlder bool `json:"hasMoreOlder"` + // Newest sequence number in this page, or null when empty. + NewestSeq *int64 `json:"newestSeq"` + // Oldest sequence number in this page, or null when empty. + OldestSeq *int64 `json:"oldestSeq"` + // Progress records in sequence order. + 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"` + // Whether to emit factory phase names to the session transcript. + LogPhaseNames *bool `json:"logPhaseNames,omitempty"` + // Whether to notify the originating session when the factory completes. + NotifyOnComplete *bool `json:"notifyOnComplete,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 { + // Accumulated active execution time in milliseconds. + ActiveMs int64 `json:"activeMs"` + // AI usage consumed by the run in nano-AIU. + NanoAiu int64 `json:"nanoAiu"` + // Total subagents spawned by the run. + 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 { + // Epoch milliseconds when the current active segment started, or null while inactive. + ActiveSegmentStartedAt *int64 `json:"activeSegmentStartedAt"` + // Durable identities and live statuses for direct factory agents. + Agents []FactoryAgentSummary `json:"agents"` + // Approved effective resource ceilings, or null until approved. + Approved *FactoryDeclaredLimits `json:"approved"` + // Epoch milliseconds when the run completed, or null while nonterminal. + CompletedAt *int64 `json:"completedAt"` + // Durable resource consumption. + Consumed FactoryRunConsumed `json:"consumed"` + // Epoch milliseconds when the run was created. + CreatedAt int64 `json:"createdAt"` + // Current phase identity, or null before any phase is entered. + CurrentPhase *FactoryCurrentPhase `json:"currentPhase"` + // Resource ceilings declared by the factory. + DeclaredLimits FactoryDeclaredLimits `json:"declaredLimits"` + // Number of phases declared by the factory. + DeclaredPhaseCount int64 `json:"declaredPhaseCount"` + // Human-readable factory description. + Description string `json:"description"` + // Registered factory name. + FactoryName string `json:"factoryName"` + // Number of direct factory agents currently live. + LiveAgentCount int64 `json:"liveAgentCount"` + // Epoch milliseconds when this live-overlay snapshot was observed. + ObservedAt int64 `json:"observedAt"` + // Lifecycle and timing observations for each factory phase. + Phases []FactoryPhaseObservation `json:"phases"` + // Bidirectional page of durable factory progress. + Progress FactoryProgressPage `json:"progress"` + // Monotonic durable run revision. + Revision int64 `json:"revision"` + // Factory run identifier. + RunID string `json:"runId"` + // Epoch milliseconds when execution first started, or null before start. + StartedAt *int64 `json:"startedAt"` + // Current factory run status. + Status FactoryRunStatus `json:"status"` + // Terminal run outcome, or null while nonterminal. + Terminal *FactoryRunTerminal `json:"terminal"` + // Total direct factory agents spawned across all attempts. + TotalSpawnedAgentCount int64 `json:"totalSpawnedAgentCount"` + // Epoch milliseconds when the durable run was last updated. + UpdatedAt int64 `json:"updatedAt"` +} + // Machine-readable factory run failure. // Experimental: FactoryRunFailure is part of an experimental API and may change or be // removed. @@ -2371,6 +3517,33 @@ 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"` @@ -2401,12 +3574,17 @@ func (FactoryRunFailureFactoryResumeDeclined) Type() FactoryRunFailureType { // 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"` - // Factory active-run timeout in milliseconds. - Timeout *float64 `json:"timeout,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. @@ -2441,6 +3619,106 @@ type FactoryRunResult struct { 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 { + // Epoch milliseconds when the current active segment started, or null while inactive. + ActiveSegmentStartedAt *int64 `json:"activeSegmentStartedAt"` + // Approved effective resource ceilings, or null until approved. + Approved *FactoryDeclaredLimits `json:"approved"` + // Epoch milliseconds when the run completed, or null while nonterminal. + CompletedAt *int64 `json:"completedAt"` + // Durable resource consumption. + Consumed FactoryRunConsumed `json:"consumed"` + // Epoch milliseconds when the run was created. + CreatedAt int64 `json:"createdAt"` + // Current phase identity, or null before any phase is entered. + CurrentPhase *FactoryCurrentPhase `json:"currentPhase"` + // Resource ceilings declared by the factory. + DeclaredLimits FactoryDeclaredLimits `json:"declaredLimits"` + // Number of phases declared by the factory. + DeclaredPhaseCount int64 `json:"declaredPhaseCount"` + // Human-readable factory description. + Description string `json:"description"` + // Registered factory name. + FactoryName string `json:"factoryName"` + // Number of direct factory agents currently live. + LiveAgentCount int64 `json:"liveAgentCount"` + // Epoch milliseconds when this live-overlay snapshot was observed. + ObservedAt int64 `json:"observedAt"` + // Monotonic durable run revision. + Revision int64 `json:"revision"` + // Factory run identifier. + RunID string `json:"runId"` + // Epoch milliseconds when execution first started, or null before start. + StartedAt *int64 `json:"startedAt"` + // Current factory run status. + Status FactoryRunStatus `json:"status"` + // Terminal run outcome, or null while nonterminal. + Terminal *FactoryRunTerminal `json:"terminal"` + // Total direct factory agents spawned across all attempts. + TotalSpawnedAgentCount int64 `json:"totalSpawnedAgentCount"` + // Epoch milliseconds when the durable run was last updated. + 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 { + // Human-readable terminal error. + Error *string `json:"error,omitempty"` + // Machine-readable terminal failure. + Failure FactoryRunFailure `json:"failure,omitempty"` + // Human-readable terminal reason. + Reason *string `json:"reason,omitempty"` + // Prompt-safe preview of the completed result. + ResultPreview *string `json:"resultPreview,omitempty"` +} + +// Internal parameters for resuming a factory run from a tool. +// Experimental: FactoryToolResumeRequest is part of an experimental API and may change or +// be removed. +// Internal: FactoryToolResumeRequest is an internal SDK API and is not part of the public +// surface. +type FactoryToolResumeRequest struct { + // Optional per-invocation resource ceiling overrides. + Limits *FactoryRunLimits `json:"limits,omitempty"` + // Factory run identifier. + RunID string `json:"runId"` + // Opaque identifier of the originating tool call. + ToolCallID *string `json:"toolCallId,omitempty"` +} + +// Options for an internal tool-originated factory invocation. +// Experimental: FactoryToolRunOptions is part of an experimental API and may change or be +// removed. +// Internal: FactoryToolRunOptions is an internal SDK API and is not part of the public +// surface. +type FactoryToolRunOptions 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"` +} + +// Internal parameters for invoking a registered factory from a tool. +// Experimental: FactoryToolRunRequest is part of an experimental API and may change or be +// removed. +// Internal: FactoryToolRunRequest is an internal SDK API and is not part of the public +// surface. +type FactoryToolRunRequest struct { + // Factory input value. + Args any `json:"args"` + // Registered factory name. + Name string `json:"name"` + // Tool-originated factory invocation options. + Options *FactoryToolRunOptions `json:"options,omitempty"` + // Opaque identifier of the originating tool call. + ToolCallID *string `json:"toolCallId,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. @@ -2517,6 +3795,10 @@ type GitHubTelemetryClientInfo struct { CLIVersion string `json:"cli_version"` // Copilot subscription plan, when known. CopilotPlan *string `json:"copilot_plan,omitempty"` + // Number of logical CPU cores on the host. + CpuCount *int64 `json:"cpu_count,omitempty"` + // Distinct CPU model names for the host, comma-separated. + CpuModel *string `json:"cpu_model,omitempty"` // Stable machine identifier for the device. DevDeviceID *string `json:"dev_device_id,omitempty"` // Whether the user is a GitHub/Microsoft staff member. @@ -2582,6 +3864,61 @@ type GitHubTelemetryNotification struct { SessionID *string `json:"sessionId,omitempty"` } +// Asks the SDK client to acquire a GitHub access token from an opaque callback registration. +// Experimental: GitHubTokenAcquireRequest is part of an experimental API and may change or +// be removed. +type GitHubTokenAcquireRequest struct { + // Effective GitHub host for which the callback must return a token. + Host string `json:"host"` + // Why the runtime is requesting a GitHub credential. + Reason GitHubTokenAcquireReason `json:"reason"` + // Opaque identifier generated by the SDK for this callback registration. + RegistrationID string `json:"registrationId"` + // Session receiving the token. Absent only before a cloud session has been assigned its id. + SessionID *string `json:"sessionId,omitempty"` +} + +// SDK host response to a GitHub credential request. +// Experimental: GitHubTokenAcquireResult is part of an experimental API and may change or +// be removed. +type GitHubTokenAcquireResult interface { + githubTokenAcquireResult() + Kind() GitHubTokenAcquireResultKind +} + +type RawGitHubTokenAcquireResultData struct { + Discriminator GitHubTokenAcquireResultKind + Raw json.RawMessage +} + +func (RawGitHubTokenAcquireResultData) githubTokenAcquireResult() {} +func (r RawGitHubTokenAcquireResultData) Kind() GitHubTokenAcquireResultKind { + return r.Discriminator +} + +type GitHubTokenAcquireResultCancelled struct { +} + +func (GitHubTokenAcquireResultCancelled) githubTokenAcquireResult() {} +func (GitHubTokenAcquireResultCancelled) Kind() GitHubTokenAcquireResultKind { + return GitHubTokenAcquireResultKindCancelled +} + +type GitHubTokenAcquireResultToken struct { + // GitHub access token acquired by the SDK host. + AccessToken string `json:"accessToken"` + // Remaining token lifetime in seconds when callback execution completes. It must exceed the + // one-hour preflight refresh threshold. + ExpiresIn int64 `json:"expiresIn"` + // OAuth token type. Defaults to bearer when omitted. + TokenType *string `json:"tokenType,omitempty"` +} + +func (GitHubTokenAcquireResultToken) githubTokenAcquireResult() {} +func (GitHubTokenAcquireResultToken) Kind() GitHubTokenAcquireResultKind { + return GitHubTokenAcquireResultKindToken +} + // 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 @@ -2621,6 +3958,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. @@ -2639,12 +3997,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 @@ -2665,6 +4032,141 @@ type HistoryCompactResult struct { TokensRemoved int64 `json:"tokensRemoved"` } +// 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. @@ -2686,6 +4188,12 @@ 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"` } @@ -2720,12 +4228,24 @@ type InstalledPlugin struct { Enabled bool `json:"enabled"` // Installation timestamp InstalledAt string `json:"installed_at"` + // Absolute path of the marketplace directory a live plugin was resolved from. Present only + // on live, never-persisted records β€” those synthesized at session start for a + // directory/local marketplace, whose cache_path points at the real plugin directory on disk + // rather than a copy under the installed-plugins cache. Its presence is what marks a record + // as live, and no record carrying it is ever written to the persisted installedPlugins key. + InstalledFrom *string `json:"installed_from,omitempty"` // Marketplace the plugin came from (empty string for direct repo installs) Marketplace string `json:"marketplace"` // Plugin name 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"` } @@ -2740,6 +4260,13 @@ type InstalledPluginInfo struct { DirectSourceID *string `json:"directSourceId,omitempty"` // Whether the plugin is currently enabled for new sessions Enabled bool `json:"enabled"` + // Absolute path of the marketplace directory a live plugin was resolved from. Present only + // on live, never-persisted records β€” a plugin belonging to a directory/local marketplace, + // which is loaded from its real directory on every pass instead of a copy under the + // installed-plugins cache. Its presence is what marks a listed plugin as live: such a + // plugin is always present on disk, so `enabled` is its only meaningful state and it is + // never "not installed". + InstalledFrom *string `json:"installedFrom,omitempty"` // Marketplace the plugin came from. Empty string ("") for direct repo / URL / local // installs. Marketplace string `json:"marketplace"` @@ -2759,14 +4286,19 @@ type InstalledPluginSource struct { String *string } -// Source descriptor for a direct GitHub plugin install, with `owner/repo`, optional ref, -// and optional subpath. +// 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 { + // Optional repository-relative path to the plugin. Path *string `json:"path,omitempty"` - Ref *string `json:"ref,omitempty"` - Repo string `json:"repo"` + // Optional Git ref to resolve. + Ref *string `json:"ref,omitempty"` + // GitHub repository in `owner/repo` form. + Repo string `json:"repo"` + // Optional full 40-character hexadecimal commit SHA. + Sha *string `json:"sha,omitempty"` // Constant value. Always "github". Source InstalledPluginSourceGitHubSource `json:"source"` } @@ -2775,21 +4307,27 @@ type InstalledPluginSourceGitHub struct { // Experimental: InstalledPluginSourceLocal is part of an experimental API and may change or // be removed. type InstalledPluginSourceLocal struct { + // Local filesystem path to the plugin. Path string `json:"path"` // Constant value. Always "local". Source InstalledPluginSourceLocalSource `json:"source"` } -// Source descriptor for a direct URL plugin install, with URL, optional ref, and optional -// subpath. +// 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 { + // Optional source-relative path to the plugin. Path *string `json:"path,omitempty"` - Ref *string `json:"ref,omitempty"` + // Optional Git ref to resolve. + 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"` + // URL of the plugin source. + URL string `json:"url"` } // Canonical file or directory where custom instructions can be discovered or created, with @@ -2873,9 +4411,8 @@ type InstructionSource struct { // Where this source lives β€” used for UI grouping Location InstructionSourceLocation `json:"location"` // The project path this source was discovered from. Only set by sessionless discovery for - // repository/working-directory sources, where it disambiguates same-named files (e.g. - // .github/copilot-instructions.md) across multiple workspace roots. The session-scoped - // getSources leaves it unset. + // 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"` @@ -2883,6 +4420,25 @@ type InstructionSource struct { 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 @@ -2940,8 +4496,9 @@ type LlmInferenceHTTPRequestStartRequest struct { // 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"` + AgentInvocationID *string `json:"agentInvocationId,omitempty"` + // HTTP request headers, preserving multiple values per name. + 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`, @@ -3026,6 +4583,7 @@ type LlmInferenceHTTPResponseChunkResult struct { // Experimental: LlmInferenceHTTPResponseStartRequest is part of an experimental API and may // change or be removed. type LlmInferenceHTTPResponseStartRequest struct { + // HTTP response headers, preserving multiple values per name. Headers map[string][]string `json:"headers"` // Matches the requestId from the originating httpRequestStart frame. RequestID string `json:"requestId"` @@ -3121,6 +4679,17 @@ 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. @@ -3405,7 +4974,7 @@ type MCPCancelSamplingExecutionResult struct { // removed. type MCPConfigAddRequest struct { // MCP server configuration (stdio process or remote HTTP/SSE) - Config MCPServerConfig `json:"config"` + Config MCPSerializableServerConfig `json:"config"` // Unique name for the MCP server Name string `json:"name"` } @@ -3448,7 +5017,7 @@ type MCPConfigEnableResult 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]MCPSerializableServerConfig `json:"servers"` } // Experimental: MCPConfigReloadResult is part of an experimental API and may change or be @@ -3474,7 +5043,7 @@ type MCPConfigRemoveResult struct { // removed. type MCPConfigUpdateRequest struct { // MCP server configuration (stdio process or remote HTTP/SSE) - Config MCPServerConfig `json:"config"` + Config MCPSerializableServerConfig `json:"config"` // Name of the MCP server to update Name string `json:"name"` } @@ -3484,7 +5053,7 @@ type MCPConfigUpdateRequest struct { type MCPConfigUpdateResult struct { } -// Opaque auth info used to configure GitHub MCP. +// Credential-free authentication identity used to configure GitHub MCP. // Experimental: MCPConfigureGitHubRequest is part of an experimental API and may change or // be removed. type MCPConfigureGitHubRequest struct { @@ -3571,12 +5140,21 @@ type MCPExecuteSamplingRequest struct { type MCPExecuteSamplingResult struct { } -// MCP server filtered by policy, with name, reason, optional redacted reason, and -// enterprise login. +// MCP server whose connection attempt failed. +// Experimental: MCPFailedServer is part of an experimental API and may change or be removed. +type MCPFailedServer struct { + // The captured connection failure detail. + Error *string `json:"error,omitempty"` + // The config key of the server that failed to connect. + Name string `json:"name"` +} + +// 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 { - // Enterprise login associated with an allowlist policy + // Deprecated. This field is no longer populated. + // Deprecated: EnterpriseName is deprecated. EnterpriseName *string `json:"enterpriseName,omitempty"` // Filtered server name Name string `json:"name"` @@ -3654,7 +5232,7 @@ type MCPHostState struct { DisabledServers []string `json:"disabledServers"` // Map of server name to recorded connection failure. FailedServers map[string]MCPServerFailureInfo `json:"failedServers"` - // Configured servers filtered out by enterprise allowlist policy. + // 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"` @@ -3664,6 +5242,44 @@ type MCPHostState struct { PendingConnections []string `json:"pendingConnections"` } +// A normalised, inert description of what installing an MCP server would involve. Carries +// no raw card, no install specification, and no secret value. +// Experimental: MCPInstallPlan is part of an experimental API and may change or be removed. +type MCPInstallPlan struct { + // The configuration changes installing would make, described rather than serialised, so the + // mutable configuration payload stays behind the runtime boundary. + ConfigurationChanges []MCPPlanConfigurationChange `json:"configurationChanges"` + // Normalised identity of the server the plan would install. + Identity MCPPlanResourceIdentity `json:"identity"` + // Opaque, runtime-instance scoped, TTL-bound, single-use handle for this plan. Rejected + // when stale, replayed, or presented to a different runtime instance. Never logged. + PlanHandle string `json:"planHandle"` + // ISO 8601 timestamp after which the plan handle is stale and will be rejected. Abandoning + // a plan needs no call: an unused handle simply expires, so cancellation before commit is + // side-effect free. + PlanHandleExpiresAt string `json:"planHandleExpiresAt"` + // Outcome of evaluating the server against registry and enterprise policy. + Policy MCPPlanPolicyResult `json:"policy"` + // Origin and semantic digest of the exact validated JSON MCP card content bound to this + // plan. + Provenance MCPPlanProvenance `json:"provenance"` + // Identifier of the choice the runtime would pick by default. Omitted when there is no + // eligible transport, or when the runtime expresses no preference. + RecommendedTransportChoiceID *string `json:"recommendedTransportChoiceId,omitempty"` + // Whether applying this plan would require an MCP reload to take effect. Planning itself + // never reloads. + ReloadRequired bool `json:"reloadRequired"` + // Whether the plan cannot be applied without further input, because a required value has no + // default or a secret must be supplied. + RequiresInteractiveConfiguration bool `json:"requiresInteractiveConfiguration"` + // Configuration scope and key the plan would write to. + Target MCPPlanTarget `json:"target"` + // Every eligible transport, so a host can present an explicit choice. A completed plan + // always has at least one; when none is eligible, planning returns + // `CatalogUnavailableTransportError` instead. + TransportChoices []MCPPlanTransportChoice `json:"transportChoices"` +} + // Server name to check running status for. // Experimental: MCPIsServerRunningRequest is part of an experimental API and may change or // be removed. @@ -3696,6 +5312,18 @@ type MCPListToolsResult struct { 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. @@ -3796,7 +5424,7 @@ type MCPOauthPendingRequestResponseToken struct { AccessToken string `json:"accessToken"` // Token lifetime in seconds, if known. ExpiresIn *int64 `json:"expiresIn,omitempty"` - // OAuth token type. Defaults to Bearer when omitted. + // OAuth token type. Defaults to bearer when omitted. TokenType *string `json:"tokenType,omitempty"` } @@ -3805,73 +5433,619 @@ func (MCPOauthPendingRequestResponseToken) Kind() MCPOauthPendingRequestResponse return MCPOauthPendingRequestResponseKindToken } -// 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 +// Remote MCP server name for a passive OAuth status probe. +// Experimental: MCPOauthProbeRequest is part of an experimental API and may change or be +// removed. +type MCPOauthProbeRequest struct { + // Name of the configured remote MCP server to probe. 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"` +// Passive MCP OAuth probe result. `authenticated` means the server accepted the probe +// request while an OAuth-origin access token was attached; it does not prove the server +// required or independently validated that token. The probe does not make a second +// unauthenticated request. Failed is an expected probe-domain outcome; JSON-RPC errors are +// reserved for API-call failures. +// Experimental: MCPOauthProbeResult is part of an experimental API and may change or be +// removed. +type MCPOauthProbeResult interface { + mcpOauthProbeResult() + Status() MCPOauthProbeResultStatus } -// 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"` +type RawMCPOauthProbeResultData struct { + Discriminator MCPOauthProbeResultStatus + Raw json.RawMessage } -// 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 +func (RawMCPOauthProbeResultData) mcpOauthProbeResult() {} +func (r RawMCPOauthProbeResultData) Status() MCPOauthProbeResultStatus { + return r.Discriminator +} + +type MCPOauthProbeResultAuthenticated struct { + // HTTP response returned by the server. + HTTPResponse MCPOauthHTTPResponse `json:"httpResponse"` +} + +func (MCPOauthProbeResultAuthenticated) mcpOauthProbeResult() {} +func (MCPOauthProbeResultAuthenticated) Status() MCPOauthProbeResultStatus { + return MCPOauthProbeResultStatusAuthenticated +} + +type MCPOauthProbeResultFailed struct { + // Human-readable probe failure detail. + Error string `json:"error"` + // HTTP response returned by the server, when the probe reached the server and captured the + // complete response. + HTTPResponse *MCPOauthHTTPResponse `json:"httpResponse,omitempty"` +} + +func (MCPOauthProbeResultFailed) mcpOauthProbeResult() {} +func (MCPOauthProbeResultFailed) Status() MCPOauthProbeResultStatus { + return MCPOauthProbeResultStatusFailed +} + +type MCPOauthProbeResultNeedsAuth struct { + // HTTP 401 or 403 response returned by the server. + HTTPResponse MCPOauthHTTPResponse `json:"httpResponse"` + // Why authentication is needed. + Reason MCPOauthProbeNeedsAuthReason `json:"reason"` + // Parsed WWW-Authenticate challenge parameters, when present and parseable. + WwwAuthenticateParams *MCPOauthWwwAuthenticateParams `json:"wwwAuthenticateParams,omitempty"` +} + +func (MCPOauthProbeResultNeedsAuth) mcpOauthProbeResult() {} +func (MCPOauthProbeResultNeedsAuth) Status() MCPOauthProbeResultStatus { + return MCPOauthProbeResultStatusNeedsAuth +} + +type MCPOauthProbeResultNoAuthRequired struct { + // HTTP response returned by the server. + HTTPResponse MCPOauthHTTPResponse `json:"httpResponse"` +} + +func (MCPOauthProbeResultNoAuthRequired) mcpOauthProbeResult() {} +func (MCPOauthProbeResultNoAuthRequired) Status() MCPOauthProbeResultStatus { + return MCPOauthProbeResultStatusNoAuthRequired +} + +// 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"` +} + +// One change applying the plan would make, described rather than serialised so the +// configuration payload stays behind the runtime boundary. +// Experimental: MCPPlanConfigurationChange is part of an experimental API and may change or +// be removed. +type MCPPlanConfigurationChange struct { + // Names of the configuration fields the change would set, without their values. + ChangedFields []string `json:"changedFields"` + // Configuration key the change applies to. + ConfigKey string `json:"configKey"` + // Whether the change would create a new entry or modify an existing one. + Operation MCPPlanConfigurationOperation `json:"operation"` + // Scope the change would be written to. + Scope MCPPlanScope `json:"scope"` + // Secret placeholders the written configuration would reference. The constrained + // placeholder type cannot carry a literal secret value. + SecretReferences []string `json:"secretReferences"` +} + +// A side-effect-free request for an MCP install plan. Computing a plan never writes +// configuration, stores a secret, or reloads MCP servers. +// Experimental: MCPPlanInstallRequest is part of an experimental API and may change or be +// removed. +type MCPPlanInstallRequest struct { + // Protocol version and capabilities the caller requires. + Contract CatalogClientContract `json:"contract"` + // Configuration scope the plan targets. Defaults to user scope when omitted. + Scope *MCPPlanScope `json:"scope,omitempty"` + // What to plan: either a candidate handle from a previous search, or a card supplied + // directly. + Source MCPPlanInstallSource `json:"source"` +} + +// Outcome of an mcp.planInstall call: either a normalised plan, or one typed refusal. +// Nothing is written in either case. +// Experimental: MCPPlanInstallResult is part of an experimental API and may change or be +// removed. +type MCPPlanInstallResult interface { + mcpPlanInstallResult() + mcpPlanInstallResultKind() MCPPlanInstallResultKind +} + +type RawMCPPlanInstallResultData struct { + Discriminator MCPPlanInstallResultKind + Raw json.RawMessage +} + +func (RawMCPPlanInstallResultData) mcpPlanInstallResult() {} +func (r RawMCPPlanInstallResultData) mcpPlanInstallResultKind() MCPPlanInstallResultKind { + return r.Discriminator +} +func (CatalogAuthenticationRequiredError) mcpPlanInstallResult() {} +func (CatalogAuthenticationRequiredError) mcpPlanInstallResultKind() MCPPlanInstallResultKind { + return MCPPlanInstallResultKindAuthenticationRequired +} +func (CatalogContractViolationError) mcpPlanInstallResult() {} +func (CatalogContractViolationError) mcpPlanInstallResultKind() MCPPlanInstallResultKind { + return MCPPlanInstallResultKindContractViolation +} + +// A presented handle was not accepted. Handles are runtime-instance scoped, TTL-bound, and +// single-use, so each way of failing is reported distinctly. +// Experimental: CatalogHandleRejectedError is part of an experimental API and may change or +// be removed. +type CatalogHandleRejectedError struct { + // Which kind of handle was presented. + HandleType CatalogHandleType `json:"handleType"` + // Human-readable explanation, safe to surface. Never contains the handle itself, nor a + // query, URL, or secret. + Message string `json:"message"` + // Why the handle was rejected. + Reason CatalogHandleRejectionReason `json:"reason"` +} + +func (CatalogHandleRejectedError) mcpPlanInstallResult() {} +func (CatalogHandleRejectedError) mcpPlanInstallResultKind() MCPPlanInstallResultKind { + return MCPPlanInstallResultKindHandleRejected +} +func (CatalogInvalidRequestError) mcpPlanInstallResult() {} +func (CatalogInvalidRequestError) mcpPlanInstallResultKind() MCPPlanInstallResultKind { + return MCPPlanInstallResultKindInvalidRequest +} +func (CatalogMalformedCardError) mcpPlanInstallResult() {} +func (CatalogMalformedCardError) mcpPlanInstallResultKind() MCPPlanInstallResultKind { + return MCPPlanInstallResultKindMalformedCard +} +func (CatalogNegotiationRefusedError) mcpPlanInstallResult() {} +func (CatalogNegotiationRefusedError) mcpPlanInstallResultKind() MCPPlanInstallResultKind { + return MCPPlanInstallResultKindNegotiationRefused +} +func (CatalogNetworkFailureError) mcpPlanInstallResult() {} +func (CatalogNetworkFailureError) mcpPlanInstallResultKind() MCPPlanInstallResultKind { + return MCPPlanInstallResultKindNetworkFailure +} + +// The candidate is discoverable but cannot be installed. `application/ai-skill` resolves +// here, because it stays searchable while remaining typed non-installable. +// Experimental: CatalogNotInstallableError is part of an experimental API and may change or +// be removed. +type CatalogNotInstallableError struct { + // Human-readable explanation, safe to surface. Never contains a query, URL, handle, or + // secret. + Message string `json:"message"` + // Why the candidate cannot be installed. + Reason CatalogNotInstallableReason `json:"reason"` +} + +func (CatalogNotInstallableError) mcpPlanInstallResult() {} +func (CatalogNotInstallableError) mcpPlanInstallResultKind() MCPPlanInstallResultKind { + return MCPPlanInstallResultKindNotInstallable +} +func (CatalogPolicyRejectedError) mcpPlanInstallResult() {} +func (CatalogPolicyRejectedError) mcpPlanInstallResultKind() MCPPlanInstallResultKind { + return MCPPlanInstallResultKindPolicyRejected +} +func (CatalogUnavailableError) mcpPlanInstallResult() {} +func (CatalogUnavailableError) mcpPlanInstallResultKind() MCPPlanInstallResultKind { + return MCPPlanInstallResultKindUnavailable +} + +// No transport this runtime can use is available for the requested server. +// Experimental: CatalogUnavailableTransportError is part of an experimental API and may +// change or be removed. +type CatalogUnavailableTransportError struct { + // Human-readable explanation, safe to surface. Never contains a query, URL, handle, or + // secret. + Message string `json:"message"` + // Why no transport could be offered. + Reason CatalogUnavailableTransportReason `json:"reason"` +} + +func (CatalogUnavailableTransportError) mcpPlanInstallResult() {} +func (CatalogUnavailableTransportError) mcpPlanInstallResultKind() MCPPlanInstallResultKind { + return MCPPlanInstallResultKindUnavailableTransport +} +func (CatalogUnsafeRetrievalError) mcpPlanInstallResult() {} +func (CatalogUnsafeRetrievalError) mcpPlanInstallResultKind() MCPPlanInstallResultKind { + return MCPPlanInstallResultKindUnsafeRetrieval +} + +// A computed MCP install plan. Nothing has been applied: the plan describes what installing +// would change, and the plan handle is what a later apply operation would consume. +// Experimental: MCPPlanInstallPlanned is part of an experimental API and may change or be +// removed. +type MCPPlanInstallPlanned struct { + // Protocol version and capabilities the runtime honoured. + Negotiated CatalogNegotiatedContract `json:"negotiated"` + // The normalised plan. + Plan MCPInstallPlan `json:"plan"` +} + +func (MCPPlanInstallPlanned) mcpPlanInstallResult() {} +func (MCPPlanInstallPlanned) mcpPlanInstallResultKind() MCPPlanInstallResultKind { + return MCPPlanInstallResultKindPlanned +} + +// What an install plan is computed from: a candidate handle from a previous search, or a +// card supplied directly. +// Experimental: MCPPlanInstallSource is part of an experimental API and may change or be +// removed. +type MCPPlanInstallSource interface { + mcpPlanInstallSource() + Kind() MCPPlanInstallSourceKind +} + +type RawMCPPlanInstallSourceData struct { + Discriminator MCPPlanInstallSourceKind + Raw json.RawMessage +} + +func (RawMCPPlanInstallSourceData) mcpPlanInstallSource() {} +func (r RawMCPPlanInstallSourceData) Kind() MCPPlanInstallSourceKind { + return r.Discriminator +} + +// Plan from a candidate returned by a previous catalog search. +// Experimental: MCPPlanInstallSourceCandidate is part of an experimental API and may change +// or be removed. +type MCPPlanInstallSourceCandidate struct { + // Single-use candidate handle. Consumed by this call, so a replay of the same handle is + // rejected. + CandidateHandle string `json:"candidateHandle"` + // The runtime- or authority-minted `searchId` returned with the search that produced this + // candidate. A search implementation binds it to private candidate-handle context; a + // planning implementation must verify that context before returning a plan. The unavailable + // planning implementation in this contract layer validates presence but does not claim the + // verification has occurred. It identifies a search rather than a person and must never be + // joined with user identity to re-identify anyone. + SearchID string `json:"searchId"` +} + +func (MCPPlanInstallSourceCandidate) mcpPlanInstallSource() {} +func (MCPPlanInstallSourceCandidate) Kind() MCPPlanInstallSourceKind { + return MCPPlanInstallSourceKindCandidate +} + +// Plan from a card supplied directly by the caller, without a preceding search. +// Experimental: MCPPlanInstallSourceCard is part of an experimental API and may change or +// be removed. +type MCPPlanInstallSourceCard struct { + // The card to plan from: exactly one of a URL or embedded data. + Card MCPServerCardReference `json:"card"` +} + +func (MCPPlanInstallSourceCard) mcpPlanInstallSource() {} +func (MCPPlanInstallSourceCard) Kind() MCPPlanInstallSourceKind { + return MCPPlanInstallSourceKindCard +} + +// Outcome of evaluating the planned server against registry and enterprise policy. +// Evaluation is read-only. +// Experimental: MCPPlanPolicyResult is part of an experimental API and may change or be +// removed. +type MCPPlanPolicyResult struct { + // What policy decided for this server. + Decision MCPPlanPolicyDecision `json:"decision"` + // Human-readable explanation, safe to surface. Never contains a query, URL, handle, or + // secret. + Reason *string `json:"reason,omitempty"` + // Which authority produced the decision. + Source MCPPlanPolicySource `json:"source"` +} + +// Provenance of the exact validated JSON MCP card content bound privately to a completed +// plan and its opaque handle. +// Experimental: MCPPlanProvenance is part of an experimental API and may change or be +// removed. +type MCPPlanProvenance struct { + // Authority associated with the validated card, without path, query, or credentials. Inert + // untrusted data. + Authority string `json:"authority"` + // Semantic digest of the exact validated JSON content bound to the plan handle. + CardDigest CardDigest `json:"cardDigest"` + // JSON MCP media type the validated card was interpreted as. + MediaType MCPServerCardMediaType `json:"mediaType"` + // ISO 8601 timestamp at which the runtime completed strict parsing and schema validation of + // the card content. + ValidatedAt string `json:"validatedAt"` +} + +// One non-secret value a transport choice needs, represented as a scalar or enumerated +// variant so enum values cannot be missing or attached to another type. +// Experimental: MCPPlanRequiredValue is part of an experimental API and may change or be +// removed. +type MCPPlanRequiredValue interface { + mcpPlanRequiredValue() + Kind() MCPPlanRequiredValueKind +} + +type RawMCPPlanRequiredValueData struct { + Discriminator MCPPlanRequiredValueKind + Raw json.RawMessage +} + +func (RawMCPPlanRequiredValueData) mcpPlanRequiredValue() {} +func (r RawMCPPlanRequiredValueData) Kind() MCPPlanRequiredValueKind { + return r.Discriminator +} + +// One enumerated non-secret value a transport choice needs before it can be applied. The +// permitted values are structurally required. +// Experimental: MCPPlanRequiredValueEnum is part of an experimental API and may change or +// be removed. +type MCPPlanRequiredValueEnum struct { + // Where the value is applied when the server is launched. + Category MCPPlanValueCategory `json:"category"` + // Default supplied by the card, when the value can be resolved without input. Presence is + // the authoritative indication that a default exists. Inert untrusted data. + DefaultValue *string `json:"defaultValue,omitempty"` + // Human-readable explanation from the card. Inert untrusted text. + Description *string `json:"description,omitempty"` + // Non-empty permitted value set. Inert untrusted data. + EnumValues []string `json:"enumValues"` + // Whether the value may be supplied more than once. + IsRepeated bool `json:"isRepeated"` + // Key the value is supplied under. Inert untrusted data. + Key string `json:"key"` + // Whether the value must be present for the plan to be applicable. + Required bool `json:"required"` + // Human-readable label from the card. Inert untrusted text. + Title *string `json:"title,omitempty"` + // Discriminator: the value must be one of `enumValues`. + ValueType MCPPlanEnumValueType `json:"valueType"` +} + +func (MCPPlanRequiredValueEnum) mcpPlanRequiredValue() {} +func (MCPPlanRequiredValueEnum) Kind() MCPPlanRequiredValueKind { + return MCPPlanRequiredValueKindEnum +} + +// One non-secret scalar value a transport choice needs before it can be applied. +// Experimental: MCPPlanRequiredValueScalar is part of an experimental API and may change or +// be removed. +type MCPPlanRequiredValueScalar struct { + // Where the value is applied when the server is launched. + Category MCPPlanValueCategory `json:"category"` + // Default supplied by the card, when the value can be resolved without input. Presence is + // the authoritative indication that a default exists. Inert untrusted data. + DefaultValue *string `json:"defaultValue,omitempty"` + // Human-readable explanation from the card. Inert untrusted text. + Description *string `json:"description,omitempty"` + // Whether the value may be supplied more than once. + IsRepeated bool `json:"isRepeated"` + // Key the value is supplied under. Inert untrusted data. + Key string `json:"key"` + // Whether the value must be present for the plan to be applicable. + Required bool `json:"required"` + // Human-readable label from the card. Inert untrusted text. + Title *string `json:"title,omitempty"` + // Scalar type the value must conform to. + ValueType MCPPlanScalarValueType `json:"valueType"` +} + +func (MCPPlanRequiredValueScalar) mcpPlanRequiredValue() {} +func (MCPPlanRequiredValueScalar) Kind() MCPPlanRequiredValueKind { + return MCPPlanRequiredValueKindScalar +} + +// Normalised identity of the MCP server a plan targets, independent of how the card spelled +// it. +// Experimental: MCPPlanResourceIdentity is part of an experimental API and may change or be +// removed. +type MCPPlanResourceIdentity struct { + // Canonical, normalised name of the server, for example `io.github.owner/server`. + CanonicalName string `json:"canonicalName"` + // Registry identifier of the server, when it came from a registry. + RegistryID *string `json:"registryId,omitempty"` + // Local configuration key the server would be recorded under. + ServerName string `json:"serverName"` + // Version advertised by the card, when it declares one. + Version *string `json:"version,omitempty"` +} + +// A secret a transport choice needs, referenced by placeholder. No secret value ever +// appears in a plan, and the placeholder resolves against the keychain only when a plan is +// applied. +// Experimental: MCPPlanSecretPlaceholder is part of an experimental API and may change or +// be removed. +type MCPPlanSecretPlaceholder struct { + // Key the secret is supplied under. Inert untrusted data. + Key string `json:"key"` + // The runtime-assigned `${secret:}` placeholder written into configuration in place of + // the value. + Placeholder string `json:"placeholder"` + // Human-readable label from the card. Inert untrusted text. + Title *string `json:"title,omitempty"` +} + +// A runtime-assigned secret placeholder. The identifier is carried once, inside the +// placeholder, so it cannot contradict a separate secret-id field. +// Experimental: MCPPlanSecretReference is part of an experimental API and may change or be +// removed. +type MCPPlanSecretReference string + +// Where a plan would be written. +// Experimental: MCPPlanTarget is part of an experimental API and may change or be removed. +type MCPPlanTarget struct { + // Configuration key the server would be recorded under within that scope. + ConfigKey string `json:"configKey"` + // Configuration scope the plan targets. + Scope MCPPlanScope `json:"scope"` +} + +// One eligible way to run the server, represented as a tagged package or remote variant so +// package identity and endpoint states cannot contradict the install method. +// Experimental: MCPPlanTransportChoice is part of an experimental API and may change or be +// removed. +type MCPPlanTransportChoice interface { + mcpPlanTransportChoice() + Transport() MCPPlanTransportChoiceTransport +} + +type RawMCPPlanTransportChoiceData struct { + Discriminator MCPPlanTransportChoiceTransport + Raw json.RawMessage +} + +func (RawMCPPlanTransportChoiceData) mcpPlanTransportChoice() {} +func (r RawMCPPlanTransportChoiceData) Transport() MCPPlanTransportChoiceTransport { + return r.Discriminator +} + +// An eligible local-package transport choice. Package identity is required and a remote +// endpoint cannot be represented. +// Experimental: MCPPlanTransportChoicePackage is part of an experimental API and may change +// or be removed. +type MCPPlanTransportChoicePackage struct { + // Stable identifier for this choice within the plan, used to select it when the plan is + // applied. + ChoiceID string `json:"choiceId"` + // Discriminator: this choice runs a local package + InstallMethod MCPPlanPackageInstallMethod `json:"installMethod"` + // Package identifier. Inert untrusted data. + PackageIdentifier string `json:"packageIdentifier"` + // Packaging ecosystem, for example `oci` or `npm`. + PackageType string `json:"packageType"` + // Typed values this choice requires, excluding secrets. + RequiredValues []MCPPlanRequiredValue `json:"requiredValues"` + // Secrets this choice requires, referenced by placeholder only. + SecretPlaceholders []MCPPlanSecretPlaceholder `json:"secretPlaceholders"` +} + +func (MCPPlanTransportChoicePackage) mcpPlanTransportChoice() {} +func (MCPPlanTransportChoicePackage) Transport() MCPPlanTransportChoiceTransport { + return MCPPlanTransportChoiceTransportStdio +} + +// An eligible remote-endpoint transport choice. The endpoint is required and package +// identity cannot be represented. +// Experimental: MCPPlanTransportChoiceRemote is part of an experimental API and may change +// or be removed. +type MCPPlanTransportChoiceRemote struct { + // Stable identifier for this choice within the plan, used to select it when the plan is + // applied. + ChoiceID string `json:"choiceId"` + // Endpoint URL. Inert untrusted data. + Endpoint string `json:"endpoint"` + // Discriminator: this choice connects to a remote endpoint + InstallMethod MCPPlanRemoteInstallMethod `json:"installMethod"` + // Typed values this choice requires, excluding secrets. + RequiredValues []MCPPlanRequiredValue `json:"requiredValues"` + // Secrets this choice requires, referenced by placeholder only. + SecretPlaceholders []MCPPlanSecretPlaceholder `json:"secretPlaceholders"` + Discriminator MCPPlanRemoteTransport `json:"transport,omitempty"` +} + +func (MCPPlanTransportChoiceRemote) mcpPlanTransportChoice() {} +func (r MCPPlanTransportChoiceRemote) Transport() MCPPlanTransportChoiceTransport { + if r.Discriminator == "" { + return MCPPlanTransportChoiceTransportHTTP + } + return MCPPlanTransportChoiceTransport(r.Discriminator) +} + +// 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"` +} + +// In-process MCP reload configuration. +// Experimental: MCPReloadConfig is part of an experimental API and may change or be removed. +type MCPReloadConfig struct { + ActiveGitHubToken *string `json:"activeGitHubToken,omitempty"` + // Server names the CLI enabled for this session via `--enable-mcp-server`. + CLIEnabledServers []string `json:"cliEnabledServers,omitzero"` + ConfigFilter any `json:"configFilter,omitempty"` + DisabledServers []string `json:"disabledServers,omitzero"` + EnabledServers []string `json:"enabledServers,omitzero"` + ForceRestart *bool `json:"forceRestart,omitempty"` + GitHubMCPToolOptions any `json:"githubMcpToolOptions,omitempty"` + GitHubMCPUserOverride *bool `json:"githubMcpUserOverride,omitempty"` + IncludeWorkspaceSources *bool `json:"includeWorkspaceSources,omitempty"` + Mcp3pEnabled *bool `json:"mcp3pEnabled,omitempty"` + MCPServers map[string]MCPServerConfig `json:"mcpServers"` + SecretStore any `json:"secretStore,omitempty"` + UseCachedToolSnapshots *bool `json:"useCachedToolSnapshots,omitempty"` +} + +// 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"` @@ -4015,11 +6189,34 @@ type MCPResourceTemplate struct { 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"` + Config MCPSerializableServerConfig `json:"config,omitempty"` // Name of the MCP server to restart ServerName string `json:"serverName"` } +// Telemetry-obfuscation policy for an MCP server's tools. +// Experimental: MCPSafeForTelemetry is part of an experimental API and may change or be +// removed. +type MCPSafeForTelemetry interface { + mcpSafeForTelemetry() +} + +type MCPSafeForTelemetryBoolean bool + +func (MCPSafeForTelemetryBoolean) mcpSafeForTelemetry() {} + +func (MCPSafeForTelemetryFields) mcpSafeForTelemetry() {} + +// Per-field MCP telemetry-obfuscation policy. +// Experimental: MCPSafeForTelemetryFields is part of an experimental API and may change or +// be removed. +type MCPSafeForTelemetryFields struct { + // Whether MCP tool input names may be included in telemetry without obfuscation. + InputsNames bool `json:"inputsNames"` + // Whether the MCP tool name may be included in telemetry without obfuscation. + Name bool `json:"name"` +} + // 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. @@ -4036,55 +6233,18 @@ type MCPSamplingExecutionResult struct { Result *MCPExecuteSamplingResult `json:"result,omitempty"` } -// 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"` - // 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, or not_configured - Status MCPServerStatus `json:"status"` +// Serializable MCP server configuration (stdio process or remote HTTP/SSE) +// Experimental: MCPSerializableServerConfig is part of an experimental API and may change +// or be removed. +type MCPSerializableServerConfig interface { + mcpSerializableServerConfig() } -// Set to `true` to use defaults, or provide an object with additional auth or OIDC settings. -// Experimental: MCPServerAuthConfig is part of an experimental API and may change or be -// removed. -type MCPServerAuthConfig interface { - mcpServerAuthConfig() +type RawMCPSerializableServerConfigData struct { + Raw json.RawMessage } -type MCPServerAuthConfigBoolean bool - -func (MCPServerAuthConfigBoolean) mcpServerAuthConfig() {} - -func (MCPServerAuthConfigRedirectPort) mcpServerAuthConfig() {} - -// Authentication settings with optional redirect port configuration. -// 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) -// Experimental: MCPServerConfig is part of an experimental API and may change or be removed. -type MCPServerConfig interface { - mcpServerConfig() -} - -type RawMCPServerConfigData struct { - Raw json.RawMessage -} - -func (RawMCPServerConfigData) mcpServerConfig() {} +func (RawMCPSerializableServerConfigData) mcpSerializableServerConfig() {} // Remote MCP server configuration accessed over HTTP or SSE. // Experimental: MCPServerConfigHTTP is part of an experimental API and may change or be @@ -4092,17 +6252,34 @@ func (RawMCPServerConfigData) mcpServerConfig() {} type MCPServerConfigHTTP struct { // Set to `true` to use defaults, or provide an object with additional auth or OIDC settings. Auth MCPServerAuthConfig `json:"auth,omitempty"` + // Configuration warnings recorded while loading the server. + ConfigWarnings []string `json:"configWarnings,omitzero"` // 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"` + // Whether secret masking is disabled for calls to this server. + DisableSecretMasking *bool `json:"disableSecretMasking,omitempty"` + // Set to true to disable persisted MCP tool snapshots for this server. Live tool discovery + // is unaffected. + DisableToolCache *bool `json:"disableToolCache,omitempty"` + // Optional human-readable server name. + DisplayName *string `json:"displayName,omitempty"` + // Event types this server receives as Copilot notifications. + Events []string `json:"events,omitzero"` + // Tool names excluded after the include filter is applied. + ExcludeTools []string `json:"excludeTools,omitzero"` // 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,omitzero"` + // Dynamic-header refresh cache lifetime in milliseconds. + HeadersRefreshTtlMs *int64 `json:"headersRefreshTtlMs,omitempty"` // Whether this server is a built-in fallback used when the user has not configured their // own server. IsDefaultServer *bool `json:"isDefaultServer,omitempty"` + // Copilot notification types this server may send to the host. + Notifications []string `json:"notifications,omitzero"` // 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. @@ -4111,7 +6288,19 @@ type MCPServerConfigHTTP struct { 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"` - // Timeout in milliseconds for tool calls to this server. + // Telemetry-obfuscation policy for this server's tools. + SafeForTelemetry MCPSafeForTelemetry `json:"safeForTelemetry,omitempty"` + // The origin of this server configuration. + Source *MCPServerSource `json:"source,omitempty"` + // Source file path recorded while loading the config. + SourcePath *string `json:"sourcePath,omitempty"` + // Plugin that provided this server. + SourcePlugin *string `json:"sourcePlugin,omitempty"` + // Whether the providing plugin uses the Open Plugin Spec. + SourcePluginSpec *bool `json:"sourcePluginSpec,omitempty"` + // Version of the plugin that provided this server. + SourcePluginVersion *string `json:"sourcePluginVersion,omitempty"` + // Timeout in milliseconds for tool discovery and tool calls. Timeout *int64 `json:"timeout,omitempty"` // Tools to include. Defaults to all tools if not specified. Tools []string `json:"tools,omitzero"` @@ -4121,7 +6310,7 @@ type MCPServerConfigHTTP struct { URL string `json:"url"` } -func (MCPServerConfigHTTP) mcpServerConfig() {} +func (MCPServerConfigHTTP) mcpSerializableServerConfig() {} // Stdio MCP server configuration launched as a child process. // Experimental: MCPServerConfigStdio is part of an experimental API and may change or be @@ -4133,27 +6322,216 @@ type MCPServerConfigStdio struct { Auth MCPServerAuthConfig `json:"auth,omitempty"` // Executable command used to start the Stdio MCP server process. Command string `json:"command"` + // Configuration warnings recorded while loading the server. + ConfigWarnings []string `json:"configWarnings,omitzero"` // 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"` + // Whether secret masking is disabled for calls to this server. + DisableSecretMasking *bool `json:"disableSecretMasking,omitempty"` + // Set to true to disable persisted MCP tool snapshots for this server. Live tool discovery + // is unaffected. + DisableToolCache *bool `json:"disableToolCache,omitempty"` + // Optional human-readable server name. + DisplayName *string `json:"displayName,omitempty"` // Environment variables to pass to the Stdio MCP server process. Env map[string]string `json:"env,omitzero"` + // Event types this server receives as Copilot notifications. + Events []string `json:"events,omitzero"` + // Tool names excluded after the include filter is applied. + ExcludeTools []string `json:"excludeTools,omitzero"` // Content filtering mode to apply to all tools, or a map of tool name to content filtering // mode. FilterMapping FilterMapping `json:"filterMapping,omitempty"` // Whether this server is a built-in fallback used when the user has not configured their // own server. IsDefaultServer *bool `json:"isDefaultServer,omitempty"` + // Copilot notification types this server may send to the host. + Notifications []string `json:"notifications,omitzero"` // Set to `true` to use defaults, or provide an object with additional auth or OIDC settings. Oidc MCPServerAuthConfig `json:"oidc,omitempty"` - // Timeout in milliseconds for tool calls to this server. + // Telemetry-obfuscation policy for this server's tools. + SafeForTelemetry MCPSafeForTelemetry `json:"safeForTelemetry,omitempty"` + // The origin of this server configuration. + Source *MCPServerSource `json:"source,omitempty"` + // Source file path recorded while loading the config. + SourcePath *string `json:"sourcePath,omitempty"` + // Plugin that provided this server. + SourcePlugin *string `json:"sourcePlugin,omitempty"` + // Whether the providing plugin uses the Open Plugin Spec. + SourcePluginSpec *bool `json:"sourcePluginSpec,omitempty"` + // Version of the plugin that provided this server. + SourcePluginVersion *string `json:"sourcePluginVersion,omitempty"` + // Timeout in milliseconds for tool discovery and tool calls. + Timeout *int64 `json:"timeout,omitempty"` + // Tools to include. Defaults to all tools if not specified. + Tools []string `json:"tools,omitzero"` + // Local transport type. Defaults to stdio when omitted. + Type *MCPServerConfigStdioType `json:"type,omitempty"` +} + +func (MCPServerConfigStdio) mcpSerializableServerConfig() {} + +// 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"` + // 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. +// Experimental: MCPServerAuthConfig is part of an experimental API and may change or be +// removed. +type MCPServerAuthConfig interface { + mcpServerAuthConfig() +} + +type MCPServerAuthConfigBoolean bool + +func (MCPServerAuthConfigBoolean) mcpServerAuthConfig() {} + +func (MCPServerAuthConfigRedirectPort) mcpServerAuthConfig() {} + +// Authentication settings with optional redirect port configuration. +// 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"` +} + +// A card supplied directly by the caller. Exactly one of a URL or embedded data, encoded +// structurally so neither both nor neither can be expressed. +// Experimental: MCPServerCardReference is part of an experimental API and may change or be +// removed. +type MCPServerCardReference interface { + mcpServerCardReference() + Kind() MCPServerCardReferenceKind +} + +type RawMCPServerCardReferenceData struct { + Discriminator MCPServerCardReferenceKind + Raw json.RawMessage +} + +func (RawMCPServerCardReferenceData) mcpServerCardReference() {} +func (r RawMCPServerCardReferenceData) Kind() MCPServerCardReferenceKind { + return r.Discriminator +} + +// An MCP server card supplied inline as an inert document. +// Experimental: MCPServerCardEmbedded is part of an experimental API and may change or be +// removed. +type MCPServerCardEmbedded struct { + // The card document verbatim, treated as inert untrusted bytes. The runtime parses and + // validates it; the host is not expected to interpret it. Never logged. + Data string `json:"data"` + // Media type the card is expected to conform to. + MediaType MCPServerCardMediaType `json:"mediaType"` +} + +func (MCPServerCardEmbedded) mcpServerCardReference() {} +func (MCPServerCardEmbedded) Kind() MCPServerCardReferenceKind { + return MCPServerCardReferenceKindEmbedded +} + +// An MCP server card to be retrieved from a URL through the runtime's hardened fetch +// boundary. +// Experimental: MCPServerCardURL is part of an experimental API and may change or be +// removed. +type MCPServerCardURL struct { + // Media type the card is expected to conform to. + MediaType MCPServerCardMediaType `json:"mediaType"` + // Card URL. Retrieved only through the runtime's hardened boundary, with scheme, + // credential, address-range, redirect, timeout, and response-size controls applied. Never + // logged. + URL string `json:"url"` +} + +func (MCPServerCardURL) mcpServerCardReference() {} +func (MCPServerCardURL) Kind() MCPServerCardReferenceKind { + return MCPServerCardReferenceKindURL +} + +// MCP server configuration (stdio, remote HTTP/SSE, or in-process) +// Experimental: MCPServerConfig is part of an experimental API and may change or be removed. +type MCPServerConfig interface { + mcpServerConfig() +} + +type RawMCPServerConfigData struct { + Raw json.RawMessage +} + +func (RawMCPServerConfigData) mcpServerConfig() {} +func (MCPServerConfigHTTP) mcpServerConfig() {} + +// In-process MCP server configuration used by embedded SDK clients. +// Experimental: MCPServerConfigMemory is part of an experimental API and may change or be +// removed. +type MCPServerConfigMemory struct { + // Configuration warnings recorded while loading the server. + ConfigWarnings []string `json:"configWarnings,omitzero"` + // Controls whether tools can be loaded on demand. + DeferTools *MCPServerConfigDeferTools `json:"deferTools,omitempty"` + // Whether secret masking is disabled for calls to this server. + DisableSecretMasking *bool `json:"disableSecretMasking,omitempty"` + // Whether persisted tool snapshots are disabled. + DisableToolCache *bool `json:"disableToolCache,omitempty"` + // Optional human-readable server name. + DisplayName *string `json:"displayName,omitempty"` + // Event types this server receives as Copilot notifications. + Events []string `json:"events,omitzero"` + // Tool names excluded after the include filter is applied. + ExcludeTools []string `json:"excludeTools,omitzero"` + // Content filtering mode to apply to this server's tools. + FilterMapping FilterMapping `json:"filterMapping,omitempty"` + // Whether this server is a built-in fallback. + IsDefaultServer *bool `json:"isDefaultServer,omitempty"` + // Copilot notification types this server may send to the host. + Notifications []string `json:"notifications,omitzero"` + // Set to `true` to use default OIDC settings. + Oidc MCPServerAuthConfig `json:"oidc,omitempty"` + // Telemetry-obfuscation policy for this server's tools. + SafeForTelemetry MCPSafeForTelemetry `json:"safeForTelemetry,omitempty"` + // In-process MCP server instance. This value cannot cross a JSON-RPC boundary. + // Internal: ServerInstance is part of the SDK's internal API surface and is not intended + // for external use. + ServerInstance any `json:"serverInstance"` + // The origin of this server configuration. + Source *MCPServerSource `json:"source,omitempty"` + // Source file path recorded while loading the config. + SourcePath *string `json:"sourcePath,omitempty"` + // Plugin that provided this server. + SourcePlugin *string `json:"sourcePlugin,omitempty"` + // Whether the providing plugin uses the Open Plugin Spec. + SourcePluginSpec *bool `json:"sourcePluginSpec,omitempty"` + // Version of the plugin that provided this server. + SourcePluginVersion *string `json:"sourcePluginVersion,omitempty"` + // Timeout in milliseconds for tool discovery and tool calls. Timeout *int64 `json:"timeout,omitempty"` // Tools to include. Defaults to all tools if not specified. Tools []string `json:"tools,omitzero"` + // Internal: Type is part of the SDK's internal API surface and is not intended for external + // use. + Type MCPServerConfigMemoryType `json:"type"` } +func (MCPServerConfigMemory) mcpServerConfig() {} + func (MCPServerConfigStdio) mcpServerConfig() {} // Recorded MCP server connection failure. @@ -4203,12 +6581,14 @@ type MCPSetEnvValueModeResult struct { Mode MCPSetEnvValueModeDetails `json:"mode"` } -// Server name and configuration for an individual MCP server start. +// 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) - Config MCPServerConfig `json:"config"` + // 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 MCPSerializableServerConfig `json:"config,omitempty"` // Name of the MCP server to start ServerName string `json:"serverName"` } @@ -4219,6 +6599,8 @@ type MCPStartServerRequest struct { type MCPStartServersResult struct { // Non-default servers allowed by policy AllowedServers []MCPAllowedServer `json:"allowedServers,omitzero"` + // Servers whose connection attempt failed. + FailedServers []MCPFailedServer `json:"failedServers,omitzero"` // Servers filtered out before startup FilteredServers []MCPFilteredServer `json:"filteredServers"` } @@ -4231,6 +6613,13 @@ type MCPStopServerRequest struct { ServerName string `json:"serverName"` } +// Metadata controlling an MCP task's lifetime. +// Experimental: MCPTaskMetadata is part of an experimental API and may change or be removed. +type MCPTaskMetadata struct { + // Task time-to-live. + Ttl *int64 `json:"ttl,omitempty"` +} + // 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. @@ -4447,6 +6836,10 @@ type Model struct { DefaultReasoningEffort *string `json:"defaultReasoningEffort,omitempty"` // Model identifier (e.g., "claude-sonnet-4.5") ID string `json:"id"` + // Informational notices the service published for this model, such as an upcoming change or + // a recommended alternative. Present only when the service published at least one notice. + // Hosts should surface these without implying anything is wrong with the model. + InfoMessages []ModelMessage `json:"infoMessages,omitzero"` // Model capability category for grouping in the model picker ModelPickerCategory *ModelPickerCategory `json:"modelPickerCategory,omitempty"` // Relative cost tier for token-based billing users @@ -4455,8 +6848,40 @@ type Model struct { Name string `json:"name"` // Policy state (if applicable) Policy *ModelPolicy `json:"policy,omitempty"` + // Context-window tiers this model offers, when the provider advertises them independently + // of tiered token pricing. Copilot models carry their tiers in `billing.tokenPrices`; a + // provider that has no pricing to publish (an agent host reached over AHP, for example) + // declares them here instead, so the model picker can still offer the tier toggle. + SupportedContextTiers []string `json:"supportedContextTiers,omitzero"` // Supported reasoning effort levels (only present if model supports reasoning effort) SupportedReasoningEfforts []string `json:"supportedReasoningEfforts,omitzero"` + // Warnings the service published for this model, such as a deprecated client version. + // Present only when the service published at least one warning. The model remains usable; + // hosts should surface these as advisory rather than blocking. + WarningMessages []ModelMessage `json:"warningMessages,omitzero"` + // Warning text the service requires hosts to surface for this model. Present only when the + // service published at least one warning. + WarningText *ModelWarningText `json:"warningText,omitempty"` +} + +// Managed, repository, and CLI model overrides to overlay onto the session at startup. +// Experimental: ModelApplyStartupOverlayRequest is part of an experimental API and may +// change or be removed. +type ModelApplyStartupOverlayRequest struct { + // Model explicitly selected by the CLI, when provided. + CLIModel *string `json:"cliModel,omitempty"` + // Whether the overlay is being applied while resuming a deferred session. + DeferredResume *bool `json:"deferredResume,omitempty"` + // Model required by device-managed policy, when configured. + DeviceManagedModel *string `json:"deviceManagedModel,omitempty"` + // Context tier selected by repository settings, when configured. + RepoContextTier *string `json:"repoContextTier,omitempty"` + // Model selected by repository settings, when configured. + RepoModel *string `json:"repoModel,omitempty"` + // Reasoning effort selected by repository settings, when configured. + RepoReasoningEffort *string `json:"repoReasoningEffort,omitempty"` + // Model required by server-managed policy, when configured. + ServerManagedModel *string `json:"serverManagedModel,omitempty"` } // Billing information @@ -4469,26 +6894,26 @@ type ModelBilling struct { // 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 time-boxed discount. + // 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 expiry. +// 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. Always present: the API only - // surfaces a promo whose expiry parses and is in the future. Consumers should treat a past - // value as expired. - EndsAt string `json:"endsAt"` + // 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. + // format endsAt and append it when present. Message *string `json:"message,omitempty"` } @@ -4503,6 +6928,8 @@ type ModelBillingTokenPrices struct { CachePrice *float64 `json:"cachePrice,omitempty"` // AI Credits cost per billing batch of cached (read) tokens CacheReadPrice *float64 `json:"cacheReadPrice,omitempty"` + // AI Credits cost per billing batch of 1-hour cache-write (cache creation) tokens. + CacheWrite1hPrice *float64 `json:"cacheWrite1hPrice,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 @@ -4529,6 +6956,8 @@ type ModelBillingTokenPricesLongContext struct { CachePrice *float64 `json:"cachePrice,omitempty"` // AI Credits cost per billing batch of cached (read) tokens CacheReadPrice *float64 `json:"cacheReadPrice,omitempty"` + // AI Credits cost per billing batch of 1-hour cache-write (cache creation) tokens. + CacheWrite1hPrice *float64 `json:"cacheWrite1hPrice,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 @@ -4650,14 +7079,46 @@ type ModelList struct { 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"` } +// A service-published message about a model, carrying a stable machine-readable code +// alongside human-readable text. +// Experimental: ModelMessage is part of an experimental API and may change or be removed. +type ModelMessage struct { + // Stable machine-readable identifier for the message, such as `client_version_deprecated`. + // Hosts can key custom presentation off this; unrecognized codes should fall back to + // displaying `message`. + Code string `json:"code"` + // Human-readable message text intended for display to the user. + Message string `json:"message"` +} + +// Experimental: ModelPickerPersistenceRequest is part of an experimental API and may change +// or be removed. +type ModelPickerPersistenceRequest struct { + // Whether context tier was explicitly selected and should be persisted. + ContextTierExplicit *bool `json:"contextTierExplicit,omitempty"` + // Whether reasoning effort was explicitly selected and should be persisted. + ReasoningEffortExplicit *bool `json:"reasoningEffortExplicit,omitempty"` + // Filesystem and environment context used to resolve settings persistence. + SettingsContext ModelPickerSettingsContext `json:"settingsContext"` +} + +// Filesystem and environment context used to resolve model-picker settings. +// Experimental: ModelPickerSettingsContext is part of an experimental API and may change or +// be removed. +type ModelPickerSettingsContext struct { + // Optional Copilot configuration directory containing persisted settings. + ConfigDir *string `json:"configDir,omitempty"` + // Environment variables consulted while resolving model-picker settings. + Environment any `json:"environment"` + // User home directory used when resolving persisted settings. + HomeDirectory string `json:"homeDirectory"` +} + // Policy state (if applicable) // Experimental: ModelPolicy is part of an experimental API and may change or be removed. type ModelPolicy struct { @@ -4689,9 +7150,23 @@ type ModelSetReasoningEffortResult struct { // 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. + // GitHub token accepted for compatibility with existing SDK clients. When provided, + // resolves this token instead of using the current account. GitHubToken *string `json:"gitHubToken,omitempty"` + // Opaque account identifier returned by `account.getAllUsers`. When omitted, the current + // account is used. + SelectionID *string `json:"selectionId,omitempty"` +} + +// Experimental: ModelSwitchConfirmation is part of an experimental API and may change or be +// removed. +type ModelSwitchConfirmation struct { + // Current conversation token count before switching models. + CurrentTokens float64 `json:"currentTokens"` + // Target model token limit used by the compaction preflight. + TargetLimit float64 `json:"targetLimit"` + // Display name of the model that requires compaction confirmation. + TargetModelDisplayName string `json:"targetModelDisplayName"` } // Target model identifier and optional reasoning effort, summary, capability overrides, and @@ -4699,19 +7174,43 @@ type ModelsListRequest struct { // Experimental: ModelSwitchToRequest is part of an experimental API and may change or be // removed. type ModelSwitchToRequest struct { + // Explicit response to a model-switch compaction preflight. Omit to request a confirmation + // projection when compaction is necessary. + CompactionDecision *string `json:"compactionDecision,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"` + // Settings scope used when persisting the selected model. + ModelChangeScope *string `json:"modelChangeScope,omitempty"` // 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. + // Optional settings context and explicit-override flags used to persist a picker selection. + PickerPersistence *ModelPickerPersistenceRequest `json:"pickerPersistence,omitempty"` + // 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"` + // Optional repository settings scope to persist after the switch commits. + RepoScope *string `json:"repoScope,omitempty"` + // Require the target to be currently available and enabled before applying the switch. + RequireAvailable *bool `json:"requireAvailable,omitempty"` + // When true, evaluate context-window compaction policy before applying the switch. + RunCompactionPreflight *bool `json:"runCompactionPreflight,omitempty"` + // Origin to record on the effective `session.model_change` event. Defaults to `sdk` when + // omitted. + Source *ModelChangeSource `json:"source,omitempty"` // Output verbosity level to request for supported models Verbosity *Verbosity `json:"verbosity,omitempty"` } @@ -4720,50 +7219,119 @@ type ModelSwitchToRequest struct { // Experimental: ModelSwitchToResult is part of an experimental API and may change or be // removed. type ModelSwitchToResult struct { + // Compaction confirmation projection when status is confirmation_required + Confirmation *ModelSwitchConfirmation `json:"confirmation,omitempty"` + // 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"` + // Deprecation warnings associated with the selected model or options. + DeprecationWarnings []string `json:"deprecationWarnings,omitzero"` + // User-facing outcome message for the model switch. + Message *string `json:"message,omitempty"` // Currently active model identifier after the switch ModelID *string `json:"modelId,omitempty"` + // Persistence failure encountered after applying the model switch. + PersistenceError *string `json:"persistenceError,omitempty"` + // Lifecycle result for the requested switch + Status *string `json:"status,omitempty"` + // User-facing warning produced while applying the model switch. + Warning *string `json:"warning,omitempty"` +} + +// Service-published warning text that hosts should display when presenting a model. +// Experimental: ModelWarningText is part of an experimental API and may change or be +// removed. +type ModelWarningText struct { + // Data-retention warning for the model. The text may contain Markdown links and should be + // rendered as Markdown when supported. + DataRetention *string `json:"dataRetention,omitempty"` } // Agent interaction mode to apply to the session. // Experimental: ModeSetRequest is part of an experimental API and may change or be removed. type ModeSetRequest struct { + // Explicit response to a model-switch compaction preflight. + CompactionDecision *string `json:"compactionDecision,omitempty"` + // Session whose plan-mode base state should be inherited. + InheritPlanBaseFromSessionID *string `json:"inheritPlanBaseFromSessionId,omitempty"` // The session mode the agent is operating in Mode SessionMode `json:"mode"` + // Whether the selected plan model should be persisted. + PersistPlanSelection *bool `json:"persistPlanSelection,omitempty"` + // Settings context used when persisting the selected plan model. + PickerSettingsContext *ModelPickerSettingsContext `json:"pickerSettingsContext,omitempty"` + // Context tier to use with the dedicated plan model. + PlanContextTier *string `json:"planContextTier,omitempty"` + // Action to perform when leaving plan mode. + PlanExitAction *string `json:"planExitAction,omitempty"` + // Dedicated model to use in plan mode, when configured. + PlanModel *string `json:"planModel,omitempty"` + // Whether a dedicated plan model is configured. + PlanModelConfigured *bool `json:"planModelConfigured,omitempty"` + // Reasoning effort to use with the dedicated plan model. + PlanReasoningEffort *string `json:"planReasoningEffort,omitempty"` + // Whether leaving plan mode should restore the session's previous model. + RestorePlanModel *bool `json:"restorePlanModel,omitempty"` +} + +// Outcome of a session mode change, including any model switch it triggered and follow-up +// the host must perform. +// Experimental: ModeSetResult is part of an experimental API and may change or be removed. +type ModeSetResult struct { + // Whether the host should arm an interactive continuation after the mode change. + ArmInteractiveContinuation *bool `json:"armInteractiveContinuation,omitempty"` + // Compaction confirmation required before the mode change can complete. + Confirmation *ModelSwitchConfirmation `json:"confirmation,omitempty"` + // Whether the host must defer implementing the requested mode change. + DeferImplementation *bool `json:"deferImplementation,omitempty"` + // Deprecation warnings associated with the model selected by the mode change. + DeprecationWarnings []string `json:"deprecationWarnings,omitzero"` + // User-facing outcome message for the model switch triggered by the mode change. + Message *string `json:"message,omitempty"` + // Whether applying the mode changed the active model. + ModelChanged bool `json:"modelChanged"` + // Lifecycle status of the requested mode change. + Status string `json:"status"` + // User-facing warning produced while applying the mode change. + Warning *string `json:"warning,omitempty"` } -// A named BYOK provider connection (transport + credentials). +// Result of moving in-flight MCP loading to the background. +// Experimental: MoveMCPLoadingToBackgroundResult is part of an experimental API and may +// change or be removed. +type MoveMCPLoadingToBackgroundResult struct { + // Whether an in-flight MCP load was moved to the background, releasing turns that were + // waiting on it. False when no MCP load was in flight or the waiting turns had already been + // released. + MovedToBackground bool `json:"movedToBackground"` +} + +// External SDK input for a named custom model provider. Ingested by the native protocol +// boundary before host dispatch. // 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. + // Static API key used to authenticate provider requests. APIKey *string `json:"apiKey,omitempty"` - // Azure-specific provider options. + // Azure authentication configuration for the provider. Azure *ProviderConfigAzure `json:"azure,omitempty"` - // API endpoint URL. + // Base URL for provider API requests. BaseURL string `json:"baseUrl"` - // Bearer token for authentication. Sets the Authorization header directly. Takes precedence - // over apiKey when both are set. + // Static bearer token used to authenticate provider requests. 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. + // Whether the host supplies bearer tokens dynamically. HasBearerTokenProvider *bool `json:"hasBearerTokenProvider,omitempty"` - // Custom HTTP headers to include in all outbound requests to the provider. + // Additional HTTP headers included with provider requests. Headers map[string]string `json:"headers,omitzero"` - // Stable identifier referenced by BYOK model definitions. Must not contain '/'. + // Unique provider name used to qualify model selection IDs. Name string `json:"name"` - // Provider transport. Defaults to "http". + // Transport used to communicate with the provider. Transport *ProviderConfigTransport `json:"transport,omitempty"` - // Provider type. Defaults to "openai" for generic OpenAI-compatible APIs. + // Provider protocol family. Type *ProviderConfigType `json:"type,omitempty"` - // Wire API format (openai/azure only). Defaults to "completions". + // Wire API used to communicate with the provider. WireAPI *ProviderConfigWireAPI `json:"wireApi,omitempty"` } @@ -4829,8 +7397,10 @@ type OpenCanvasInstance struct { // 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"` + // Opaque policy update timestamp supplied by the host. + LastUpdatedAt any `json:"last_updated_at"` + // Content-exclusion rules to apply. + Rules []OptionsUpdateAdditionalContentExclusionPolicyRule `json:"rules"` // Allowed values for the `OptionsUpdateAdditionalContentExclusionPolicyScope` enumeration. Scope OptionsUpdateAdditionalContentExclusionPolicyScope `json:"scope"` } @@ -4840,9 +7410,12 @@ type OptionsUpdateAdditionalContentExclusionPolicy struct { // Experimental: OptionsUpdateAdditionalContentExclusionPolicyRule is part of an // experimental API and may change or be removed. type OptionsUpdateAdditionalContentExclusionPolicyRule struct { - IfAnyMatch []string `json:"ifAnyMatch,omitzero"` + // Conditions of which at least one must match. + IfAnyMatch []string `json:"ifAnyMatch,omitzero"` + // Conditions none of which may match. IfNoneMatch []string `json:"ifNoneMatch,omitzero"` - Paths []string `json:"paths"` + // Path patterns covered by this rule. + Paths []string `json:"paths"` // Source descriptor for a `session.options.update` content-exclusion rule, with source name // and type. Source OptionsUpdateAdditionalContentExclusionPolicyRuleSource `json:"source"` @@ -4853,7 +7426,9 @@ type OptionsUpdateAdditionalContentExclusionPolicyRule struct { // Experimental: OptionsUpdateAdditionalContentExclusionPolicyRuleSource is part of an // experimental API and may change or be removed. type OptionsUpdateAdditionalContentExclusionPolicyRuleSource struct { + // Name of the policy source. Name string `json:"name"` + // Type of the policy source. Type string `json:"type"` } @@ -4975,6 +7550,8 @@ func (PermissionDecisionApproveForSession) Kind() PermissionDecisionKind { // 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() {} @@ -5155,6 +7732,24 @@ func (PermissionDecisionApproveForLocationApprovalCustomTool) Kind() PermissionD return PermissionDecisionApproveForLocationApprovalKindCustomTool } +// Location-scoped approval details for an extension's access to sensitive environment +// variables, keyed by extension name and the exact set of variable names. +// Experimental: PermissionDecisionApproveForLocationApprovalExtensionEnvAccess is part of +// an experimental API and may change or be removed. +type PermissionDecisionApproveForLocationApprovalExtensionEnvAccess struct { + // Names of the sensitive environment variables this approval covers. Values are never + // persisted. + EnvironmentVariables []string `json:"environmentVariables"` + // Extension name. + ExtensionName string `json:"extensionName"` +} + +func (PermissionDecisionApproveForLocationApprovalExtensionEnvAccess) permissionDecisionApproveForLocationApproval() { +} +func (PermissionDecisionApproveForLocationApprovalExtensionEnvAccess) Kind() PermissionDecisionApproveForLocationApprovalKind { + return PermissionDecisionApproveForLocationApprovalKindExtensionEnvAccess +} + // Location-scoped approval details for extension-management operations, optionally narrowed // by operation. // Experimental: PermissionDecisionApproveForLocationApprovalExtensionManagement is part of @@ -5186,6 +7781,21 @@ func (PermissionDecisionApproveForLocationApprovalExtensionPermissionAccess) Kin return PermissionDecisionApproveForLocationApprovalKindExtensionPermissionAccess } +// 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 @@ -5300,6 +7910,24 @@ func (PermissionDecisionApproveForSessionApprovalCustomTool) Kind() PermissionDe return PermissionDecisionApproveForSessionApprovalKindCustomTool } +// Session-scoped approval details for an extension's access to sensitive environment +// variables, keyed by extension name and the exact set of variable names. +// Experimental: PermissionDecisionApproveForSessionApprovalExtensionEnvAccess is part of an +// experimental API and may change or be removed. +type PermissionDecisionApproveForSessionApprovalExtensionEnvAccess struct { + // Names of the sensitive environment variables this approval covers. Values are never + // persisted. + EnvironmentVariables []string `json:"environmentVariables"` + // Extension name. + ExtensionName string `json:"extensionName"` +} + +func (PermissionDecisionApproveForSessionApprovalExtensionEnvAccess) permissionDecisionApproveForSessionApproval() { +} +func (PermissionDecisionApproveForSessionApprovalExtensionEnvAccess) Kind() PermissionDecisionApproveForSessionApprovalKind { + return PermissionDecisionApproveForSessionApprovalKindExtensionEnvAccess +} + // Session-scoped approval details for extension-management operations, optionally narrowed // by operation. // Experimental: PermissionDecisionApproveForSessionApprovalExtensionManagement is part of @@ -5331,6 +7959,21 @@ func (PermissionDecisionApproveForSessionApprovalExtensionPermissionAccess) Kind return PermissionDecisionApproveForSessionApprovalKindExtensionPermissionAccess } +// 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 @@ -5397,10 +8040,29 @@ 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"` + // Whether the responding client could ask a user interactively, was running headlessly, or + // had no response path. Omit when the client cannot determine this authoritatively. + ResponseCapability *PermissionResponseCapability `json:"responseCapability,omitempty"` + // 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 @@ -5466,7 +8128,9 @@ type PermissionLocationResolveResult struct { // be removed. type PermissionPathsAddParams struct { // Directory to add to the allow-list. The runtime resolves and validates the path before - // adding. + // adding, then loads conventional `.github/skills/` and `.github/agents/` definitions under + // it when their subsystem gates are enabled. Adding the directory is therefore also a trust + // decision for configuration stored there. Path string `json:"path"` } @@ -5493,9 +8157,11 @@ type PermissionPathsAllowedCheckResult struct { // removed. type PermissionPathsConfig struct { // 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). + // directory). Conventional `.github/skills/` and `.github/agents/` definitions under them + // also join the session catalogs when their subsystem gates are enabled, so supplying a + // directory is a trust decision for configuration stored there. 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,omitzero"` // Whether to include the system temp directory in the allowed list (defaults to true). // Ignored when `unrestricted` is true. @@ -5588,8 +8254,10 @@ type PermissionRulesSet struct { // Experimental: PermissionsConfigureAdditionalContentExclusionPolicy is part of an // experimental API and may change or be removed. type PermissionsConfigureAdditionalContentExclusionPolicy struct { - LastUpdatedAt any `json:"last_updated_at"` - Rules []PermissionsConfigureAdditionalContentExclusionPolicyRule `json:"rules"` + // Opaque policy update timestamp supplied by the host. + LastUpdatedAt any `json:"last_updated_at"` + // Content-exclusion rules to apply. + Rules []PermissionsConfigureAdditionalContentExclusionPolicyRule `json:"rules"` // Allowed values for the `PermissionsConfigureAdditionalContentExclusionPolicyScope` // enumeration. Scope PermissionsConfigureAdditionalContentExclusionPolicyScope `json:"scope"` @@ -5600,9 +8268,12 @@ type PermissionsConfigureAdditionalContentExclusionPolicy struct { // Experimental: PermissionsConfigureAdditionalContentExclusionPolicyRule is part of an // experimental API and may change or be removed. type PermissionsConfigureAdditionalContentExclusionPolicyRule struct { - IfAnyMatch []string `json:"ifAnyMatch,omitzero"` + // Conditions of which at least one must match. + IfAnyMatch []string `json:"ifAnyMatch,omitzero"` + // Conditions none of which may match. IfNoneMatch []string `json:"ifNoneMatch,omitzero"` - Paths []string `json:"paths"` + // Path patterns covered by this rule. + Paths []string `json:"paths"` // Source descriptor for a `session.permissions.configure` content-exclusion rule, with // source name and type. Source PermissionsConfigureAdditionalContentExclusionPolicyRuleSource `json:"source"` @@ -5613,7 +8284,9 @@ type PermissionsConfigureAdditionalContentExclusionPolicyRule struct { // Experimental: PermissionsConfigureAdditionalContentExclusionPolicyRuleSource is part of // an experimental API and may change or be removed. type PermissionsConfigureAdditionalContentExclusionPolicyRuleSource struct { + // Name of the policy source. Name string `json:"name"` + // Type of the policy source. Type string `json:"type"` } @@ -5661,9 +8334,17 @@ type PermissionsFolderTrustAddTrustedResult struct { } // No parameters. -// Experimental: PermissionsGetAllowAllRequest is part of an experimental API and may change -// or be removed. -type PermissionsGetAllowAllRequest struct { +// Experimental: PermissionsGetModeRequest is part of an experimental API and may change or +// be removed. +type PermissionsGetModeRequest struct { +} + +// Current permission mode. +// Experimental: PermissionsGetModeResult is part of an experimental API and may change or +// be removed. +type PermissionsGetModeResult struct { + // Current permission mode + Mode PermissionMode `json:"mode"` } // Tool approval to persist and apply @@ -5713,6 +8394,24 @@ func (PermissionsLocationsAddToolApprovalDetailsCustomTool) Kind() PermissionsLo return PermissionsLocationsAddToolApprovalDetailsKindCustomTool } +// Location-persisted tool approval details for an extension's access to sensitive +// environment variables, keyed by extension name and the exact set of variable names. +// Experimental: PermissionsLocationsAddToolApprovalDetailsExtensionEnvAccess is part of an +// experimental API and may change or be removed. +type PermissionsLocationsAddToolApprovalDetailsExtensionEnvAccess struct { + // Names of the sensitive environment variables this approval covers. Values are never + // persisted. + EnvironmentVariables []string `json:"environmentVariables"` + // Extension name. + ExtensionName string `json:"extensionName"` +} + +func (PermissionsLocationsAddToolApprovalDetailsExtensionEnvAccess) permissionsLocationsAddToolApprovalDetails() { +} +func (PermissionsLocationsAddToolApprovalDetailsExtensionEnvAccess) Kind() PermissionsLocationsAddToolApprovalDetailsKind { + return PermissionsLocationsAddToolApprovalDetailsKindExtensionEnvAccess +} + // Location-persisted tool approval details for extension-management operations, optionally // narrowed by operation. // Experimental: PermissionsLocationsAddToolApprovalDetailsExtensionManagement is part of an @@ -5744,6 +8443,21 @@ func (PermissionsLocationsAddToolApprovalDetailsExtensionPermissionAccess) Kind( return PermissionsLocationsAddToolApprovalDetailsKindExtensionPermissionAccess } +// 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 @@ -5877,10 +8591,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. @@ -5891,23 +8607,6 @@ type PermissionsResetSessionApprovalsResult struct { Success bool `json:"success"` } -// 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 { - // 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's active model is used. - Model *string `json:"model,omitempty"` - // Optional source for allow-all telemetry. Defaults to `rpc` when omitted for SDK callers. - Source *PermissionsSetAllowAllSource `json:"source,omitempty"` -} - // Allow-all toggle for tool permission requests, with an optional telemetry source. // Experimental: PermissionsSetApproveAllRequest is part of an experimental API and may // change or be removed. @@ -5926,6 +8625,32 @@ type PermissionsSetApproveAllResult struct { Success bool `json:"success"` } +// Permission mode to apply for the session. +// Experimental: PermissionsSetModeRequest is part of an experimental API and may change or +// be removed. +type PermissionsSetModeRequest struct { + // Optional judge model id for assisted mode. When omitted, the session resolves the + // provider default: `gpt-5.5` for CAPI sessions and the active session model for BYOK + // sessions. + AssistedApprovalModel *string `json:"assistedApprovalModel,omitempty"` + // Permission mode to apply + Mode PermissionMode `json:"mode"` + // Optional source for permission-mode telemetry. Defaults to `rpc` when omitted for SDK + // callers. + Source *PermissionModeSource `json:"source,omitempty"` +} + +// Indicates whether the requested permission mode was applied and reports the authoritative +// post-mutation mode. +// Experimental: PermissionsSetModeResult is part of an experimental API and may change or +// be removed. +type PermissionsSetModeResult struct { + // Authoritative permission mode after the mutation + Mode PermissionMode `json:"mode"` + // Whether the operation succeeded + Success bool `json:"success"` +} + // Toggles whether permission prompts should be bridged into session events for this client. // Experimental: PermissionsSetRequiredRequest is part of an experimental API and may change // or be removed. @@ -6009,7 +8734,8 @@ type PlanReadResult struct { // 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 from the session SQL todos table, ordered by creation time with insertion order used + // to break ties when available and id used for WITHOUT ROWID tables. Rows []PlanSQLTodosRow `json:"rows"` } @@ -6021,7 +8747,8 @@ type PlanReadSQLTodosWithDependenciesResult struct { // 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 + // Rows from the session SQL todos table, ordered by creation time with insertion order used + // to break ties when available and id used for WITHOUT ROWID tables. Empty when no // database, no todos table, or the SELECT failed. Rows []PlanSQLTodosRow `json:"rows"` } @@ -6041,6 +8768,11 @@ type PlanSQLTodoDependency struct { // 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 creation time, as stored by the session SQL schema's `datetime('now')` default: + // `YYYY-MM-DD HH:MM:SS` in UTC. Lets clients attribute todos to the work item that created + // them (e.g. scoping a goal's progress to the todos it produced) rather than to the whole + // session. + CreatedAt *string `json:"createdAt,omitempty"` // Todo description. Description *string `json:"description,omitempty"` // Todo identifier. @@ -6102,6 +8834,20 @@ type PluginListResult struct { Plugins []InstalledPluginInfo `json:"plugins"` } +// Trusted built-in plugin directories to use for this runtime process. +// Experimental: PluginsBuiltinSetRequest is part of an experimental API and may change or +// be removed. +type PluginsBuiltinSetRequest struct { + // Complete replacement set of trusted built-in plugin directories. Every entry must be an + // absolute local filesystem path no longer than 4096 characters. + Paths []string `json:"paths"` +} + +// Experimental: PluginsBuiltinSetResult is part of an experimental API and may change or be +// removed. +type PluginsBuiltinSetResult struct { +} + // Plugin names (or specs) to disable. // Experimental: PluginsDisableRequest is part of an experimental API and may change or be // removed. @@ -6187,9 +8933,6 @@ type PluginsMarketplacesRemoveRequest struct { Name string `json:"name"` } -// Optional flags controlling which side effects the reload performs. -// Experimental: PluginsReloadRequest is part of an experimental API and may change or be -// removed. 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`. @@ -6273,6 +9016,31 @@ type PluginUpdateResult struct { SkillsInstalled int64 `json:"skillsInstalled"` } +// Serializable definition of a caller-implemented tool whose execution is handled over the +// SDK connection. +// Experimental: ProtocolExternalToolDefinition is part of an experimental API and may +// change or be removed. +type ProtocolExternalToolDefinition struct { + // Tool-loading deferral policy. + Defer *ProtocolExternalToolDefer `json:"defer,omitempty"` + // Model-visible explanation of what the tool does. + Description string `json:"description"` + // Whether the tool executes commands in a terminal. + IsTerminal *bool `json:"isTerminal,omitempty"` + // Optional caller-defined metadata associated with the tool. + Metadata map[string]any `json:"metadata,omitzero"` + // Unique model-visible tool name. + Name string `json:"name"` + // Whether this definition replaces a built-in tool with the same name. + OverridesBuiltInTool *bool `json:"overridesBuiltInTool,omitempty"` + // JSON Schema describing the tool's input arguments. + Parameters map[string]any `json:"parameters,omitzero"` + // Whether execution bypasses the normal tool permission prompt. + SkipPermission *bool `json:"skipPermission,omitempty"` + // Optional human-readable display title. + Title *string `json:"title,omitempty"` +} + // 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 @@ -6327,9 +9095,13 @@ type ProviderConfig struct { MaxOutputTokens *float64 `json:"maxOutputTokens,omitempty"` // Maximum prompt/input tokens for the model. MaxPromptTokens *float64 `json:"maxPromptTokens,omitempty"` + // Overrides for model capabilities when they cannot be inferred from modelId. + ModelCapabilities *ModelCapabilitiesOverride `json:"modelCapabilities,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 name used for model and telemetry attribution. + ProviderName *string `json:"providerName,omitempty"` // Provider transport. Defaults to "http". Transport *ProviderConfigTransport `json:"transport,omitempty"` // Provider type. Defaults to "openai" for generic OpenAI-compatible APIs. @@ -6372,9 +9144,6 @@ type ProviderEndpoint struct { WireAPI *ProviderEndpointWireAPI `json:"wireApi,omitempty"` } -// Optional model identifier to scope the endpoint snapshot to. -// Experimental: ProviderGetEndpointRequest is part of an experimental API and may change or -// be removed. 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. @@ -6401,7 +9170,7 @@ type ProviderModelConfig struct { // 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. + // Name of the configured provider 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"` @@ -6430,8 +9199,8 @@ type ProviderSessionToken struct { // 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`. + // 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 the configured provider name. ProviderName string `json:"providerName"` // Target session identifier SessionID string `json:"sessionId"` @@ -6812,6 +9581,30 @@ type PushGitHubRepoRef struct { Owner string `json:"owner"` } +// 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"` +} + +// 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"` +} + +// 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"` +} + // Result of the queued command execution. // Experimental: QueuedCommandResult is part of an experimental API and may change or be // removed. @@ -6847,13 +9640,153 @@ func (QueuedCommandNotHandled) Handled() bool { return false } -// User-facing pending queue entry, with kind and display text for a queued message, slash -// command, or model change. +// 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"` +} + +// Parameters for duplicating a queued item. +// Experimental: QueueDuplicateAtRequest is part of an experimental API and may change or be +// removed. +type QueueDuplicateAtRequest struct { + // Stable opaque ID of the queued item to duplicate. + ID string `json:"id"` +} + +// 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"` +} + +// Result of enqueueing the resume-pending wake item. +// Experimental: QueueEnqueueResumePendingResult is part of an experimental API and may +// change or be removed. +type QueueEnqueueResumePendingResult struct { + // True when a wake item was newly queued. + Queued bool `json:"queued"` +} + +// 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"` +} + +// 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"` +} + +// 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"` +} + +// 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 { + // Queued message contents and delivery metadata. + Message QueueInsertMessage `json:"message"` + // Zero-based position in the public visible queue. Values outside the queue clamp to an end. + Position int64 `json:"position"` +} + +// Result of inserting a queued message. +// Experimental: QueueInsertAtResult is part of an experimental API and may change or be +// removed. +type QueueInsertAtResult struct { + // Fresh stable opaque id assigned to the inserted item. + ID string `json:"id"` +} + +// Serializable message fields accepted by queue.insertAt. +// Experimental: QueueInsertMessage is part of an experimental API and may change or be +// removed. +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"` +} + +// Parameters for moving a queued item by stable id. +// Experimental: QueueMoveItemRequest is part of an experimental API and may change or be +// removed. +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"` +} + +// Result of moving a queued item. +// Experimental: QueueMoveItemResult is part of an experimental API and may change or be +// removed. +type QueueMoveItemResult struct { + // True when the item changed position; false when it was already at the requested position. + Changed bool `json:"changed"` +} + +// 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 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"` } @@ -6862,6 +9795,10 @@ type QueuePendingItems struct { // Experimental: QueuePendingItemsResult is part of an experimental API and may change or be // removed. type QueuePendingItemsResult struct { + // How many leading entries of `steeringMessages` have already been folded into the running + // turn (and so have an emitted `user.message`), as opposed to still waiting for one. Absent + // for hosts that do not distinguish the two. + InFlightSteeringCount *int64 `json:"inFlightSteeringCount,omitempty"` // Pending queued items in submission order. Includes user messages, queued slash commands, // and queued model changes; omits internal system items. Items []QueuePendingItems `json:"items"` @@ -6870,6 +9807,22 @@ type QueuePendingItemsResult struct { SteeringMessages []string `json:"steeringMessages"` } +// 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 { + // Stable opaque ID of the queued item to remove. + ID string `json:"id"` +} + +// 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"` +} + // Indicates whether a user-facing pending item was removed. // Experimental: QueueRemoveMostRecentResult is part of an experimental API and may change // or be removed. @@ -6879,6 +9832,69 @@ type QueueRemoveMostRecentResult struct { Removed bool `json:"removed"` } +// 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 QueueSendNowRequest struct { + // Stable opaque ID of the queued item to steer into the live turn. + ID string `json:"id"` +} + +// 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 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 { + // Whether queued-lane draining should be paused. + Paused bool `json:"paused"` +} + +// 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 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"` +} + +// Parameters for editing a single queued message. +// Experimental: QueueUpdateTextRequest is part of an experimental API and may change or be +// removed. +type QueueUpdateTextRequest struct { + // Optional replacement prompt displayed to the user. + DisplayPrompt *string `json:"displayPrompt,omitempty"` + // Stable opaque ID of the queued item to edit. + ID string `json:"id"` + // Replacement prompt sent to the model. + Prompt string `json:"prompt"` +} + +// 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"` +} + // 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. @@ -6911,6 +9927,11 @@ type RegisterEventInterestResult struct { Handle string `json:"handle"` } +// Experimental: RegisterExtensionLaunchProviderResult is part of an experimental API and +// may change or be removed. +type RegisterExtensionLaunchProviderResult struct { +} + // 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. @@ -7018,9 +10039,8 @@ type RemoteControlStatusActive struct { // 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. + // excluded from the public SDK surface. Retained as an optional compatibility field; native + // remote control does not populate or consume it. // Internal: PromptManager is part of the SDK's internal API surface and is not intended for // external use. PromptManager any `json:"promptManager,omitempty"` @@ -7175,6 +10195,10 @@ type RemoteSessionRepository struct { type RunOptions struct { // Per-invocation resource ceiling overrides. Limits *FactoryRunLimits `json:"limits,omitempty"` + // Whether to emit factory phase names to the session transcript. + LogPhaseNames *bool `json:"logPhaseNames,omitempty"` + // Whether to notify the originating session when the factory completes. + NotifyOnComplete *bool `json:"notifyOnComplete,omitempty"` // Run identifier whose journal and progress should seed this resumed run. ResumeFromRunID *string `json:"resumeFromRunId,omitempty"` } @@ -7189,19 +10213,43 @@ type RuntimeShutdownResult struct { 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 tool directories discovered on PATH and in toolchain + // environment variables (GOROOT, JAVA_HOME, VIRTUAL_ENV, and similar), and to common + // developer-tool caches, config, and toolchains. Writable grants cover scratch caches, the + // Unix GitHub CLI cache, and Cargo's registry, git store, and lock/tracker files. A + // relocated CARGO_HOME gets the same narrow split: registry and git are read-write; bin is + // read-only; the home root, config.toml, and credentials.toml stay ungranted. Set to false + // to disable every grant listed above; user-installed toolchains and caches then need + // explicit userPolicy.filesystem readonlyPaths and readwritePaths entries. The working + // directory (see addCurrentWorkingDirectory), temporary storage, session log paths, and + // system locations follow their own rules and stay granted. 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"` - // Whether to export `GH_TOKEN` so the `gh` CLI authenticates inside the sandbox without the - // OS keyring the sandbox blocks. Default: false (opt-in). - GhAuth *bool `json:"ghAuth,omitempty"` - // Whether to inject the Copilot GitHub token as an `http..extraheader` so - // authenticated HTTPS git works inside the sandbox without the shell-based credential - // helper the sandbox blocks. Default: false (opt-in). - GitAuth *bool `json:"gitAuth,omitempty"` // User-managed sandbox policy fragment merged into the auto-discovered base policy. UserPolicy *SandboxConfigUserPolicy `json:"userPolicy,omitempty"` } +// Credential-injection capability flags applied while the sandbox is enabled. For the same +// capability independent of sandboxing, and matched to the credential's GitHub host, see +// `shell.credentials`; the two are additive. +// 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. @@ -7255,6 +10303,36 @@ type SandboxConfigUserPolicyNetwork struct { 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"` } // macOS seatbelt-specific options. @@ -7265,6 +10343,70 @@ type SandboxConfigUserPolicySeatbelt struct { KeychainAccess *bool `json:"keychainAccess,omitempty"` } +// Register an absolute-time scheduled prompt. +// Experimental: ScheduleAddAtRequest is part of an experimental API and may change or be +// removed. +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"` +} + +// Register a cron scheduled prompt. +// Experimental: ScheduleAddCronRequest is part of an experimental API and may change or be +// removed. +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"` +} + +// Register a relative-interval scheduled prompt. +// Experimental: ScheduleAddRequest is part of an experimental API and may change or be +// removed. +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"` +} + +// Result of registering or re-arming a scheduled prompt. +// Experimental: ScheduleAddResult is part of an experimental API and may change or be +// removed. +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"` +} + +// 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"` +} + // 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. @@ -7294,6 +10436,14 @@ type ScheduleEntry struct { Tz *string `json:"tz,omitempty"` } +// 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 ScheduleHasSelfPacedResult struct { + // True when at least one active schedule is self-paced. + HasSelfPaced bool `json:"hasSelfPaced"` +} + // 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 { @@ -7301,6 +10451,16 @@ type ScheduleList struct { Entries []ScheduleEntry `json:"entries"` } +// 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"` +} + // Identifier of the scheduled prompt to remove. // Experimental: ScheduleStopRequest is part of an experimental API and may change or be // removed. @@ -7365,10 +10525,9 @@ type SendMessageItem struct { // 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 match one of - // three forms: the literal `system`, `command-` for messages originating from a - // command (e.g. slash command, Mission Control command), or `schedule-` for - // messages originating from a scheduled job. + // 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"` @@ -7402,6 +10561,12 @@ type SendMessagesRequest struct { // 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"` } @@ -7442,10 +10607,9 @@ type SendRequest struct { // 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 match one of - // three forms: the literal `system`, `command-` for messages originating from a - // command (e.g. slash command, Mission Control command), or `schedule-` for - // messages originating from a scheduled job. + // 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"` @@ -7456,6 +10620,12 @@ type SendRequest struct { // 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"` } @@ -7466,6 +10636,18 @@ type SendResult struct { MessageID string `json:"messageId"` } +// 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"` +} + // 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 { @@ -7488,6 +10670,8 @@ 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) @@ -7528,6 +10712,66 @@ type SessionActivity struct { type SessionAgentDeselectResult 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: SessionAgentSetPromptResult is part of an experimental API and may change +// or be removed. +type SessionAgentSetPromptResult struct { +} + +// Credential-free authentication identity safe to expose to hosts and user interfaces. +// Experimental: SessionAuthInfoResult is part of an experimental API and may change or be +// removed. +type SessionAuthInfoResult struct { + // Snapshot of the authenticated user's Copilot subscription info, if known + CopilotUser *CopilotUserResponse `json:"copilotUser,omitempty"` + // Name of the environment variable that supplied the credential, when applicable + EnvVar *string `json:"envVar,omitempty"` + // Authentication host + Host string `json:"host"` + // Authenticated login, when available + Login *string `json:"login,omitempty"` + // Opaque SDK GitHub credential registration backing this identity. Routing metadata only; + // never a credential. + RegistrationID *string `json:"registrationId,omitempty"` + // Authentication type + Type AuthInfoType `json:"type"` +} + +// Internal GitHub login parameters. +// Experimental: SessionAuthLoginRequest is part of an experimental API and may change or be +// removed. +type SessionAuthLoginRequest struct { + // GitHub host URL + Host string `json:"host"` + // GitHub login + Login string `json:"login"` + // Whether to persist the token after login + Persist *bool `json:"persist,omitempty"` + // GitHub authentication token + Token string `json:"token"` +} + +// Parameters identifying a GitHub authentication to log out. +// Experimental: SessionAuthLogoutUserRequest is part of an experimental API and may change +// or be removed. +type SessionAuthLogoutUserRequest struct { + // Authentication information to log out + AuthInfo AuthInfo `json:"authInfo"` +} + // Authentication status and account metadata for the session. // Experimental: SessionAuthStatus is part of an experimental API and may change or be // removed. @@ -7546,6 +10790,16 @@ type SessionAuthStatus struct { StatusMessage *string `json:"statusMessage,omitempty"` } +// Parameters for switching the session's active authentication. +// Experimental: SessionAuthSwitchRequest is part of an experimental API and may change or +// be removed. +type SessionAuthSwitchRequest struct { + // Authentication information to activate + AuthInfo AuthInfo `json:"authInfo"` + // Optional token paired with the authentication information + Token *string `json:"token,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 // removed. @@ -7556,11 +10810,37 @@ type SessionBulkDeleteResult struct { FreedBytes map[string]int64 `json:"freedBytes"` } +// 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 SessionCanvasCloseResult struct { } +// Experimental: SessionCanvasProviderRegisterResult is part of an experimental API and may +// change or be removed. +type SessionCanvasProviderRegisterResult struct { +} + +// Experimental: SessionCanvasProviderUnregisterResult is part of an experimental API and +// may change or be removed. +type SessionCanvasProviderUnregisterResult struct { +} + +// Experimental: SessionCommandsListRequest is part of an experimental API and may change or +// be removed. +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"` +} + // 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. @@ -7600,17 +10880,65 @@ type SessionContext struct { // 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"` } +// 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. @@ -7905,7 +11233,7 @@ type SessionFSSqliteExistsResult struct { } // SQL query, query type, and optional bind parameters for executing a SQLite query against -// the per-session database. +// 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 { @@ -7937,6 +11265,49 @@ type SessionFSSqliteQueryResult struct { RowsAffected int64 `json:"rowsAffected"` } +// 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 { + // Machine-readable classification of the transaction failure. + ErrorClass SessionFSSqliteTransactionErrorClass `json:"errorClass"` + // Human-readable transaction failure message. + Message string `json:"message"` +} + +// 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"` + // Ordered SQL statements to execute in one transaction. + Statements []SessionFSSqliteTransactionStatement `json:"statements"` +} + +// 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 { + // Classified transaction failure, when execution did not succeed. + Error *SessionFSSqliteTransactionError `json:"error,omitempty"` + // Per-statement query results in input order. + Results []SessionFSSqliteQueryResult `json:"results"` +} + +// One statement in an atomic SQLite transaction. +// Experimental: SessionFSSqliteTransactionStatement is part of an experimental API and may +// change or be removed. +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"` +} + // 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. @@ -7979,6 +11350,45 @@ type SessionFSWriteFileRequest struct { SessionID string `json:"sessionId"` } +// Authentication accounts available to the internal session host. +// Experimental: SessionGitHubAuthGetAllAuthAvailableResult is part of an experimental API +// and may change or be removed. +type SessionGitHubAuthGetAllAuthAvailableResult []SessionAuthStatus + +// Whether the current authentication was logged out. +// Experimental: SessionGitHubAuthLogoutResult is part of an experimental API and may change +// or be removed. +type SessionGitHubAuthLogoutResult bool + +// Whether the requested authentication was logged out. +// Experimental: SessionGitHubAuthLogoutUserResult is part of an experimental API and may +// change or be removed. +type SessionGitHubAuthLogoutUserResult bool + +// Experimental: SessionGitHubAuthSwitchToAuthResult is part of an experimental API and may +// change or be removed. +type SessionGitHubAuthSwitchToAuthResult struct { +} + +// 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 @@ -7990,12 +11400,24 @@ type SessionInstalledPlugin struct { Enabled bool `json:"enabled"` // Installation timestamp (ISO-8601) InstalledAt string `json:"installed_at"` + // Absolute path of the marketplace directory a live plugin was resolved from. Present only + // on live, never-persisted records β€” those synthesized at session start for a + // directory/local marketplace, whose cache_path points at the real plugin directory on disk + // rather than a copy under the installed-plugins cache. Its presence is what marks a record + // as live, and no record carrying it is ever written to the persisted installedPlugins key. + InstalledFrom *string `json:"installed_from,omitempty"` // 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"` } @@ -8010,14 +11432,19 @@ type SessionInstalledPluginSource struct { String *string } -// Source descriptor for a direct GitHub plugin install, with `owner/repo`, optional ref, -// and optional subpath. +// 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 { + // Optional repository-relative path to the plugin. Path *string `json:"path,omitempty"` - Ref *string `json:"ref,omitempty"` - Repo string `json:"repo"` + // Optional Git ref to resolve. + Ref *string `json:"ref,omitempty"` + // GitHub repository in `owner/repo` form. + Repo string `json:"repo"` + // Optional full 40-character hexadecimal commit SHA. + Sha *string `json:"sha,omitempty"` // Constant value. Always "github". Source SessionInstalledPluginSourceGitHubSource `json:"source"` } @@ -8026,45 +11453,150 @@ type SessionInstalledPluginSourceGitHub struct { // Experimental: SessionInstalledPluginSourceLocal is part of an experimental API and may // change or be removed. type SessionInstalledPluginSourceLocal struct { + // Local filesystem path to the plugin. Path string `json:"path"` // Constant value. Always "local". Source SessionInstalledPluginSourceLocalSource `json:"source"` } -// Source descriptor for a direct URL plugin install, with URL, optional ref, and optional -// subpath. +// 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 { + // Optional source-relative path to the plugin. Path *string `json:"path,omitempty"` - Ref *string `json:"ref,omitempty"` + // Optional Git ref to resolve. + 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"` + // URL of the plugin source. + URL string `json:"url"` } -// Optional session limits. -// Experimental: SessionLimitsConfig is part of an experimental API and may change or be -// removed. -type SessionLimitsConfig struct { - // Maximum AI Credits allowed across the session's current accounting window. - MaxAiCredits *float64 `json:"maxAiCredits,omitempty"` +// 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"` } -// 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"` +// 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"` } -// 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 SessionListEntry interface { - sessionListEntry() - sessionListEntryIsRemote() bool +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"` +} + +// 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 RawSessionLimitPredictionResultData struct { + Discriminator SessionLimitPredictionResultKind + Raw json.RawMessage +} + +func (RawSessionLimitPredictionResultData) sessionLimitPredictionResult() {} +func (r RawSessionLimitPredictionResultData) Kind() SessionLimitPredictionResultKind { + return r.Discriminator +} + +type SessionLimitPredictionResultAvailable struct { + // Predicted session limit details. + Prediction SessionLimitPredictionDetails `json:"prediction"` +} + +func (SessionLimitPredictionResultAvailable) sessionLimitPredictionResult() {} +func (SessionLimitPredictionResultAvailable) Kind() SessionLimitPredictionResultKind { + return SessionLimitPredictionResultKindAvailable +} + +type SessionLimitPredictionResultUnavailable struct { + // Reason no prediction is available. + Reason SessionLimitPredictionUnavailableReason `json:"reason"` +} + +func (SessionLimitPredictionResultUnavailable) sessionLimitPredictionResult() {} +func (SessionLimitPredictionResultUnavailable) Kind() SessionLimitPredictionResultKind { + return SessionLimitPredictionResultKindUnavailable +} + +// 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"` + // Semantic usage tier. + Tier SessionLimitPredictionTier `json:"tier"` +} + +// Optional session limits. +// Experimental: SessionLimitsConfig is part of an experimental API and may change or be +// removed. +type SessionLimitsConfig struct { + // Maximum AI Credits allowed across the session's current accounting window. + MaxAiCredits *float64 `json:"maxAiCredits,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"` +} + +// 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 SessionListEntry interface { + sessionListEntry() + sessionListEntryIsRemote() bool } func (LocalSessionMetadataValue) sessionListEntry() {} @@ -8079,6 +11611,14 @@ func (LocalSessionMetadataValue) sessionListEntryIsRemote() bool { type RemoteSessionMetadataValue struct { // Most recent working directory context. Context *SessionContext `json:"context,omitempty"` + // Host-supplied human description of what the session is doing right now ("running tests", + // "waiting for approval"). Optional in the protocol and absent on hosts that do not publish + // it, so never rely on it -- it enriches `hostStatus`, it does not replace it. + HostActivity *string `json:"hostActivity,omitempty"` + // Live status as the owning host reports it in its session listing, so a row for a session + // running elsewhere can show that it is running. Absent for hosts that publish no such + // status (the cloud task managers), which read as idle. + HostStatus *RemoteSessionHostStatus `json:"hostStatus,omitempty"` // Last-modified time as an ISO 8601 timestamp. ModifiedTime string `json:"modifiedTime"` // Optional human-friendly name set via /rename. @@ -8142,6 +11682,34 @@ type SessionLoadDeferredRepoHooksResult struct { type SessionLspInitializeResult struct { } +// 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. `allow-auto-only` + // blocks full allow-all but permits advisory auto-approval. Any other value is accepted + // rather than failing the session, but is enforced as `disable`: the key is only present to + // restrict something, so a mode this runtime cannot interpret fails closed to the most + // restrictive one it knows. Omit the key entirely to impose no restriction. + DisableBypassPermissionsMode *string `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 SessionManagedSettings struct { + // Managed permission policy injected by the SDK host. + Permissions *SessionManagedPermissions `json:"permissions,omitempty"` +} + // Standard MCP CallToolResult // Experimental: SessionMCPAppsCallToolResult is part of an experimental API and may change // or be removed. @@ -8162,6 +11730,11 @@ type SessionMCPDisableResult struct { type SessionMCPEnableResult struct { } +// Experimental: SessionMCPOauthAuthenticationStateChangedResult is part of an experimental +// API and may change or be removed. +type SessionMCPOauthAuthenticationStateChangedResult struct { +} + // Experimental: SessionMCPRegisterExternalClientResult is part of an experimental API and // may change or be removed. type SessionMCPRegisterExternalClientResult struct { @@ -8254,19 +11827,23 @@ type SessionModelList struct { QuotaSnapshots map[string]any `json:"quotaSnapshots,omitzero"` } +// 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"` +} + // 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"` + // CAPI model identifier. + ID string `json:"id"` + // Cost category assigned to the model. PriceCategory ModelPickerPriceCategory `json:"priceCategory"` } -// Experimental: SessionModeSetResult is part of an experimental API and may change or be -// removed. -type SessionModeSetResult struct { -} - // Experimental: SessionNameSetResult is part of an experimental API and may change or be // removed. type SessionNameSetResult struct { @@ -8280,6 +11857,18 @@ type SessionOpenOptions struct { // 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). Conventional `.github/skills/` and `.github/agents/` + // definitions under each directory also join the session's project catalogs when their + // existing subsystem gates are enabled: added-root skills require both + // `enableConfigDiscovery` and effective `enableSkills`; added-root agents require + // `enableConfigDiscovery`. Supplying a directory therefore activates configuration from it + // and should be treated as a trust decision. 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 during session creation and cold + // resume and is not persisted, so a cold resume must re-supply the directories. + 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 @@ -8313,13 +11902,37 @@ type SessionOpenOptions struct { 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: enable native model citations for supported Anthropic and OpenAI models, + // 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. @@ -8332,6 +11945,8 @@ type SessionOpenOptions struct { 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. @@ -8351,6 +11966,10 @@ type SessionOpenOptions struct { // are available, subject to runtime availability and exclusions. Custom agents with the // same name remain available. IncludedBuiltinAgents []string `json:"includedBuiltinAgents,omitzero"` + // Built-in skill names to include in this session. When specified, only these + // runtime-bundled skills are available. Skills from other sources with the same name remain + // available. + IncludedBuiltinSkills []string `json:"includedBuiltinSkills,omitzero"` // Installed plugins visible to the session. InstalledPlugins []InstalledPlugin `json:"installedPlugins,omitzero"` // Stable integration identifier for analytics. @@ -8361,6 +11980,9 @@ type SessionOpenOptions struct { 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"` @@ -8382,7 +12004,9 @@ type SessionOpenOptions struct { // rejected. // Experimental: Providers is part of an experimental API and may change or be removed. Providers []NamedProviderConfig `json:"providers,omitzero"` - // Initial reasoning effort level. + // 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"` @@ -8396,15 +12020,23 @@ type SessionOpenOptions struct { RunningInInteractiveMode *bool `json:"runningInInteractiveMode,omitempty"` // Resolved sandbox configuration. SandboxConfig *SandboxConfig `json:"sandboxConfig,omitempty"` + // Origin of the sandbox choice. The runtime uses this only for internal telemetry + // provenance; managed policy is derived independently. + // Internal: SandboxConfigSource is part of the SDK's internal API surface and is not + // intended for external use. + SandboxConfigSource *SandboxConfigSource `json:"sandboxConfigSource,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"` - // Shell init profile. + // 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"` - // Per-shell process flags. + // 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"` @@ -8425,8 +12057,10 @@ type SessionOpenOptions struct { // 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"` + // Opaque policy update timestamp supplied by the host. + LastUpdatedAt any `json:"last_updated_at"` + // Content-exclusion rules to apply. + Rules []SessionOpenOptionsAdditionalContentExclusionPolicyRule `json:"rules"` // Allowed values for the `SessionOpenOptionsAdditionalContentExclusionPolicyScope` // enumeration. Scope SessionOpenOptionsAdditionalContentExclusionPolicyScope `json:"scope"` @@ -8437,9 +12071,12 @@ type SessionOpenOptionsAdditionalContentExclusionPolicy struct { // Experimental: SessionOpenOptionsAdditionalContentExclusionPolicyRule is part of an // experimental API and may change or be removed. type SessionOpenOptionsAdditionalContentExclusionPolicyRule struct { - IfAnyMatch []string `json:"ifAnyMatch,omitzero"` + // Conditions of which at least one must match. + IfAnyMatch []string `json:"ifAnyMatch,omitzero"` + // Conditions none of which may match. IfNoneMatch []string `json:"ifNoneMatch,omitzero"` - Paths []string `json:"paths"` + // Path patterns covered by this rule. + Paths []string `json:"paths"` // Source descriptor for a `sessions.open` content-exclusion rule, with source name and type. Source SessionOpenOptionsAdditionalContentExclusionPolicyRuleSource `json:"source"` } @@ -8448,7 +12085,9 @@ type SessionOpenOptionsAdditionalContentExclusionPolicyRule struct { // Experimental: SessionOpenOptionsAdditionalContentExclusionPolicyRuleSource is part of an // experimental API and may change or be removed. type SessionOpenOptionsAdditionalContentExclusionPolicyRuleSource struct { + // Name of the policy source. Name string `json:"name"` + // Type of the policy source. Type string `json:"type"` } @@ -8649,11 +12288,38 @@ type SessionPlanDeleteResult struct { type SessionPlanUpdateResult struct { } +// 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 { } +// Experimental: SessionProviderGetEndpointRequest is part of an experimental API and may +// change or be removed. +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"` +} + // 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 @@ -8676,6 +12342,21 @@ type SessionPruneResult struct { type SessionQueueClearResult struct { } +// Experimental: SessionQueueDeferSessionIdleResult is part of an experimental API and may +// change or be removed. +type SessionQueueDeferSessionIdleResult struct { +} + +// 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 SessionQueueSetDrainPausedResult struct { +} + // Experimental: SessionRemoteDisableResult is part of an experimental API and may change or // be removed. type SessionRemoteDisableResult struct { @@ -8706,6 +12387,11 @@ type SessionsCheckInUseResult struct { 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. @@ -8727,6 +12413,26 @@ type SessionsCloseResult struct { type SessionsConfigureSessionExtensionsResult struct { } +// Session ID to delete from disk. +// Experimental: SessionsDeleteRequest is part of an experimental API and may change or be +// removed. +type SessionsDeleteRequest struct { + // Session ID to delete + SessionID string `json:"sessionId"` + // Internal resolved session directory path to delete + SessionPath *string `json:"sessionPath,omitempty"` +} + +// Experimental: SessionsDeleteResult is part of an experimental API and may change or be +// removed. +type SessionsDeleteResult struct { +} + +// Experimental: SessionSendSystemNotificationResult is part of an experimental API and may +// change or be removed. +type SessionSendSystemNotificationResult 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. @@ -8749,7 +12455,7 @@ type SessionSetCredentialsParams struct { // 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"` + Credentials SettableAuthInfo `json:"credentials,omitempty"` } // Indicates whether the credential update succeeded. @@ -8773,8 +12479,10 @@ type SessionSetCredentialsResult struct { // Experimental: SessionSettingsBuiltInToolAvailabilitySnapshot is part of an experimental // API and may change or be removed. type SessionSettingsBuiltInToolAvailabilitySnapshot struct { + // Whether the create-pull-request tool is available. CreatePullRequest *bool `json:"createPullRequest,omitempty"` - ReportProgress *bool `json:"reportProgress,omitempty"` + // Whether the report-progress tool is available. + ReportProgress *bool `json:"reportProgress,omitempty"` } // Named Rust-owned settings predicate to evaluate for this session. @@ -8791,6 +12499,7 @@ type SessionSettingsEvaluatePredicateRequest struct { // Experimental: SessionSettingsEvaluatePredicateResult is part of an experimental API and // may change or be removed. type SessionSettingsEvaluatePredicateResult struct { + // Whether the named settings predicate evaluated to enabled. Enabled bool `json:"enabled"` } @@ -8798,26 +12507,35 @@ type SessionSettingsEvaluatePredicateResult struct { // Experimental: SessionSettingsJobSnapshot is part of an experimental API and may change or // be removed. type SessionSettingsJobSnapshot struct { + // Availability of job-specific built-in tools. BuiltInToolAvailability *SessionSettingsBuiltInToolAvailabilitySnapshot `json:"builtInToolAvailability,omitempty"` - EventType *string `json:"eventType,omitempty"` - IsTriggerJob *bool `json:"isTriggerJob,omitempty"` + // GitHub Actions event type for the job. + EventType *string `json:"eventType,omitempty"` + // Whether this is the workflow's trigger job. + IsTriggerJob *bool `json:"isTriggerJob,omitempty"` } // 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"` + // Agent service callback URL for job and progress updates. + CallbackURL *string `json:"callbackUrl,omitempty"` + // Default reasoning effort for the selected model. DefaultReasoningEffort *string `json:"defaultReasoningEffort,omitempty"` - InstanceID *string `json:"instanceId,omitempty"` - Model *string `json:"model,omitempty"` + // Agent job identifier for the session. + InstanceID *string `json:"instanceId,omitempty"` + // Selected model identifier. + Model *string `json:"model,omitempty"` } // 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"` + // Whether online evaluation is disabled. + DisableOnlineEvaluation *bool `json:"disableOnlineEvaluation,omitempty"` + // Whether online-evaluation output-file generation is enabled. EnableOnlineEvaluationOutputFile *bool `json:"enableOnlineEvaluationOutputFile,omitempty"` } @@ -8825,18 +12543,30 @@ type SessionSettingsOnlineEvaluationSnapshot struct { // 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"` + // Checked-out repository branch. + Branch *string `json:"branch,omitempty"` + // Checked-out commit SHA. + Commit *string `json:"commit,omitempty"` + // GitHub server host name. + Host *string `json:"host,omitempty"` + // Protocol used to access the GitHub host. + HostProtocol *string `json:"hostProtocol,omitempty"` + // GitHub repository database ID. + ID *float64 `json:"id,omitempty"` + // Repository name. + Name *string `json:"name,omitempty"` + // GitHub repository owner database ID. + OwnerID *float64 `json:"ownerId,omitempty"` + // Repository owner login. + OwnerName *string `json:"ownerName,omitempty"` + // Number of commits in the pull request. + PrCommitCount *float64 `json:"prCommitCount,omitempty"` + // Whether the repository is writable. + ReadWrite *bool `json:"readWrite,omitempty"` + // GitHub secret-scanning service URL. + SecretScanningURL *string `json:"secretScanningUrl,omitempty"` + // GitHub server base URL. + ServerURL *string `json:"serverUrl,omitempty"` } // Redacted, serializable view of session runtime settings for SDK boundary consumers. @@ -8844,30 +12574,49 @@ type SessionSettingsRepoSnapshot struct { // 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"` + // Name of the SDK client that created the session. + ClientName *string `json:"clientName,omitempty"` + // Redacted job settings. + Job SessionSettingsJobSnapshot `json:"job"` + // Redacted model routing settings. + Model SessionSettingsModelSnapshot `json:"model"` + // Online-evaluation settings safe for SDK consumers. 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 repository and host settings. + Repo SessionSettingsRepoSnapshot `json:"repo"` + // Session start time as Unix epoch milliseconds. + StartTimeMs *float64 `json:"startTimeMs,omitempty"` + // Session timeout in milliseconds. + TimeoutMs *float64 `json:"timeoutMs,omitempty"` + // Redacted validation and memory-tool settings. + Validation SessionSettingsValidationSnapshot `json:"validation"` + // Agent runtime version selector copied from the session settings, such as `latest` or a + // runtime release identifier. + 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 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"` + // Whether advisory validation is enabled. + AdvisoryEnabled *bool `json:"advisoryEnabled,omitempty"` + // Whether CodeQL validation is enabled. + CodeqlEnabled *bool `json:"codeqlEnabled,omitempty"` + // Whether code-review validation is enabled. + CodeReviewEnabled *bool `json:"codeReviewEnabled,omitempty"` + // Model used for code-review validation. + CodeReviewModel *string `json:"codeReviewModel,omitempty"` + // Dependabot validation timeout budget in seconds. + DependabotTimeout *float64 `json:"dependabotTimeout,omitempty"` + // Whether the memory-store tool is enabled. + MemoryStoreEnabled *bool `json:"memoryStoreEnabled,omitempty"` + // Whether the memory-vote tool is enabled. + MemoryVoteEnabled *bool `json:"memoryVoteEnabled,omitempty"` + // Whether secret-scanning validation is enabled. + SecretScanningEnabled *bool `json:"secretScanningEnabled,omitempty"` + // General validation timeout budget in seconds. + Timeout *float64 `json:"timeout,omitempty"` } // UUID prefix to resolve to a unique session ID. @@ -8976,6 +12725,22 @@ type SessionsGetLastForContextResult struct { SessionID *string `json:"sessionId,omitempty"` } +// 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"` +} + +// 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"` +} + // 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. @@ -9021,6 +12786,22 @@ type SessionSkillsEnableResult struct { type SessionSkillsEnsureLoadedResult struct { } +// 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"` +} + +// Recent local session IDs that contain user-visible history. +// Experimental: SessionsListNonEmptySessionIDsResult is part of an experimental API and may +// change or be removed. +type SessionsListNonEmptySessionIDsResult struct { + // Session IDs ordered newest-first. + SessionIDs []string `json:"sessionIds"` +} + // 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 @@ -9259,7 +13040,7 @@ type SessionUpdateOptionsParams struct { 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. + // `skipCustomInstructions`. EnableOnDemandInstructionDiscovery *bool `json:"enableOnDemandInstructionDiscovery,omitempty"` // Whether to surface reasoning-summary events from the model. EnableReasoningSummaries *bool `json:"enableReasoningSummaries,omitempty"` @@ -9278,6 +13059,8 @@ type SessionUpdateOptionsParams struct { // 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. @@ -9290,6 +13073,10 @@ type SessionUpdateOptionsParams struct { // 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"` + // Built-in skill names to include in this session. When specified, only these + // runtime-bundled skills are available. Skills from other sources with the same name remain + // available. Set to null to remove the allowlist restriction. + IncludedBuiltinSkills []string `json:"includedBuiltinSkills,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"` @@ -9318,7 +13105,9 @@ type SessionUpdateOptionsParams struct { OrganizationCustomInstructions *string `json:"organizationCustomInstructions,omitempty"` // Custom model-provider configuration (BYOK). Provider *ProviderConfig `json:"provider,omitempty"` - // 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 `json:"reasoningEffort,omitempty"` // Reasoning summary mode for supported model clients. ReasoningSummary *OptionsUpdateReasoningSummary `json:"reasoningSummary,omitempty"` @@ -9326,15 +13115,23 @@ type SessionUpdateOptionsParams struct { RunningInInteractiveMode *bool `json:"runningInInteractiveMode,omitempty"` // Resolved sandbox configuration. SandboxConfig *SandboxConfig `json:"sandboxConfig,omitempty"` + // Origin of the sandbox choice. The runtime uses this only for internal telemetry + // provenance; managed policy is derived independently. + // Internal: SandboxConfigSource is part of the SDK's internal API surface and is not + // intended for external use. + SandboxConfigSource *SandboxConfigSource `json:"sandboxConfigSource,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"` - // Shell init profile (`None` or `NonInteractive`). + // 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"` - // Per-shell process flags (e.g., `pwsh` arguments). + // 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"` @@ -9396,6 +13193,68 @@ type SessionWorkingDirectoryContext struct { type SessionWorkspacesCreateFileResult struct { } +// Authentication credentials accepted by session.gitHubAuth.setCredentials. Session-owned +// token-provider identities cannot be installed through this method. +// Experimental: SettableAuthInfo is part of an experimental API and may change or be +// removed. +type SettableAuthInfo interface { + settableAuthInfo() + settableAuthInfoType() SettableAuthInfoType +} + +type RawSettableAuthInfoData struct { + Discriminator SettableAuthInfoType + Raw json.RawMessage +} + +func (RawSettableAuthInfoData) settableAuthInfo() {} +func (r RawSettableAuthInfoData) settableAuthInfoType() SettableAuthInfoType { + return r.Discriminator +} +func (APIKeyAuthInfo) settableAuthInfo() {} +func (APIKeyAuthInfo) settableAuthInfoType() SettableAuthInfoType { + return SettableAuthInfoTypeAPIKey +} +func (CopilotAPITokenAuthInfo) settableAuthInfo() {} +func (CopilotAPITokenAuthInfo) settableAuthInfoType() SettableAuthInfoType { + return SettableAuthInfoTypeCopilotAPIToken +} +func (EnvAuthInfo) settableAuthInfo() {} +func (EnvAuthInfo) settableAuthInfoType() SettableAuthInfoType { + return SettableAuthInfoTypeEnv +} +func (GhCLIAuthInfo) settableAuthInfo() {} +func (GhCLIAuthInfo) settableAuthInfoType() SettableAuthInfoType { + return SettableAuthInfoTypeGhCLI +} +func (HMACAuthInfo) settableAuthInfo() {} +func (HMACAuthInfo) settableAuthInfoType() SettableAuthInfoType { + return SettableAuthInfoTypeHMAC +} + +// Token authentication accepted by session.gitHubAuth.setCredentials. +// Experimental: SettableTokenAuthInfo is part of an experimental API and may change or be +// removed. +type SettableTokenAuthInfo 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. + CopilotUser *CopilotUserResponse `json:"copilotUser,omitempty"` + // Authentication host. + Host string `json:"host"` + // The token value itself. Treat as a secret. + Token string `json:"token"` +} + +func (SettableTokenAuthInfo) settableAuthInfo() {} +func (SettableTokenAuthInfo) settableAuthInfoType() SettableAuthInfoType { + return SettableAuthInfoTypeToken +} +func (UserAuthInfo) settableAuthInfo() {} +func (UserAuthInfo) settableAuthInfoType() SettableAuthInfoType { + return SettableAuthInfoTypeUser +} + // User-requested shell execution cancellation handle. // Experimental: ShellCancelUserRequestedRequest is part of an experimental API and may // change or be removed. @@ -9404,6 +13263,55 @@ type ShellCancelUserRequestedRequest struct { RequestID string `json:"requestId"` } +// Command-scoped GitHub credential injection for the shell commands an agent runs. +// +// Each channel is opt-in and independent, and injection is scoped to the individual command +// spawn: the credential is resolved from the session's *current* authentication at every +// spawn +// and reaches only spawns whose script actually invokes `git` or `gh`. Because nothing is +// retained between spawns, replacing the session credential +// (`session.gitHubAuth.setCredentials`) +// changes what the next spawned command presents β€” which seeding a credential into the +// runtime +// process's own environment cannot do, since a child's environment is fixed at `exec`. +// +// The credential is matched to the host it authenticates to, so a github.com credential is +// never +// presented to a GitHub Enterprise host and vice versa. Where a channel cannot express that +// boundary it injects nothing rather than crossing it -- see `gh` below. +// +// This is independent of `sandboxConfig`: it is a decision about which identity the agent +// presents, not about what the agent may touch, and it works on every platform whether or +// not +// an OS sandboxing backend is available. `sandboxConfig.auth` remains the sandbox-scoped +// spelling and is additive with this one. +// Experimental: ShellCredentials is part of an experimental API and may change or be +// removed. +type ShellCredentials struct { + // Whether to authenticate the agent's `gh` commands as the session's GitHub credential, by + // exporting `GH_TOKEN` to a spawn that runs `gh`. Any inherited `gh` credential is removed + // from + // spawns that do not, so the credential stays command-scoped. + // + // Applies to a github.com credential only. `gh` picks its credential variable from the host + // a + // command targets rather than the one the credential belongs to, and the command can choose + // that + // target, so `GH_ENTERPRISE_TOKEN` would offer a single-tenant enterprise credential to + // every + // other enterprise host. A session whose credential is enterprise-scoped therefore runs `gh` + // unauthenticated; its `git` commands are unaffected, because `http..extraheader` is + // scoped + // to one host by construction. Default: false (opt-in). + Gh *bool `json:"gh,omitempty"` + // Whether to authenticate the agent's `git` commands as the session's GitHub credential, by + // injecting an `http..extraheader` (plus `insteadOf` rewrites so SSH-spelled remotes + // for + // that host use the authenticated HTTPS transport). Applied only to a spawn that runs a + // remote-contacting `git` subcommand. Default: false (opt-in). + Git *bool `json:"git,omitempty"` +} + // 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. @@ -9434,6 +13342,16 @@ type ShellExecuteUserRequestedRequest struct { RequestID string `json:"requestId"` } +// 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"` +} + // 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. @@ -9452,6 +13370,36 @@ type ShellKillResult struct { Killed bool `json:"killed"` } +// 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 { + // Command-scoped GitHub credential injection for shell commands. + Credentials *ShellCredentials `json:"credentials,omitempty"` + // 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"` +} + // Parameters for shutting down the session // Experimental: ShutdownRequest is part of an experimental API and may change or be removed. type ShutdownRequest struct { @@ -9469,6 +13417,8 @@ 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 @@ -9530,6 +13480,22 @@ type SkillsConfigSetDisabledSkillsRequest struct { type SkillsConfigSetDisabledSkillsResult struct { } +// Adds or removes a single skill from the global disabled list, leaving every other entry +// untouched. +// Experimental: SkillsConfigSetSkillDisabledRequest is part of an experimental API and may +// change or be removed. +type SkillsConfigSetSkillDisabledRequest struct { + // True to disable the skill, false to enable it + Disabled bool `json:"disabled"` + // Name of the skill to add to or remove from the disabled list + Name string `json:"name"` +} + +// Experimental: SkillsConfigSetSkillDisabledResult is part of an experimental API and may +// change or be removed. +type SkillsConfigSetSkillDisabledResult struct { +} + // Name of the skill to disable for the session. // Experimental: SkillsDisableRequest is part of an experimental API and may change or be // removed. @@ -9679,6 +13645,22 @@ func (r RawSlashCommandInvocationResultData) Kind() SlashCommandInvocationResult return r.Discriminator } +// Experimental: SlashCommandAddTimelineEntryResult is part of an experimental API and may +// change or be removed. +type SlashCommandAddTimelineEntryResult struct { + // Timeline entry the host should append. + Entry SlashCommandTimelineEntry `json:"entry"` + // Optional text the host should prefill into the input editor. + PrefillInput *string `json:"prefillInput,omitempty"` + // Whether command execution changed persisted runtime settings. + RuntimeSettingsChanged *bool `json:"runtimeSettingsChanged,omitempty"` +} + +func (SlashCommandAddTimelineEntryResult) slashCommandInvocationResult() {} +func (SlashCommandAddTimelineEntryResult) Kind() SlashCommandInvocationResultKind { + return SlashCommandInvocationResultKindAddTimelineEntry +} + // 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 @@ -9740,6 +13722,60 @@ func (SlashCommandSelectSubcommandResult) Kind() SlashCommandInvocationResultKin return SlashCommandInvocationResultKindSelectSubcommand } +// Experimental: SlashCommandSetModelResult is part of an experimental API and may change or +// be removed. +type SlashCommandSetModelResult struct { + // Model selected by the command. + Model string `json:"model"` + // Reasoning effort selected for the model. + ReasoningEffort *string `json:"reasoningEffort,omitempty"` + // Repository settings scope modified by the command. + RepoScope *string `json:"repoScope,omitempty"` + // User-settings snapshot to restore if the host cancels the model switch. + RevertOnCancel any `json:"revertOnCancel,omitempty"` + // Whether command execution changed persisted runtime settings. + RuntimeSettingsChanged *bool `json:"runtimeSettingsChanged,omitempty"` + // Settings scope modified by the command. + Scope *string `json:"scope,omitempty"` + // User-facing warning produced while selecting the model. + Warning *string `json:"warning,omitempty"` +} + +func (SlashCommandSetModelResult) slashCommandInvocationResult() {} +func (SlashCommandSetModelResult) Kind() SlashCommandInvocationResultKind { + return SlashCommandInvocationResultKindSetModel +} + +// Experimental: SlashCommandSetPlanModelResult is part of an experimental API and may +// change or be removed. +type SlashCommandSetPlanModelResult struct { + // User-facing confirmation message for the plan-model selection. + Message string `json:"message"` + // Dedicated model selected for plan mode. + PlanModel *string `json:"planModel,omitempty"` + // Whether command execution changed persisted runtime settings. + RuntimeSettingsChanged *bool `json:"runtimeSettingsChanged,omitempty"` +} + +func (SlashCommandSetPlanModelResult) slashCommandInvocationResult() {} +func (SlashCommandSetPlanModelResult) Kind() SlashCommandInvocationResultKind { + return SlashCommandInvocationResultKindSetPlanModel +} + +// Experimental: SlashCommandShowDialogResult is part of an experimental API and may change +// or be removed. +type SlashCommandShowDialogResult struct { + // Dialog the host should display. + Dialog SlashCommandModelPickerDialog `json:"dialog"` + // Whether command execution changed persisted runtime settings. + RuntimeSettingsChanged *bool `json:"runtimeSettingsChanged,omitempty"` +} + +func (SlashCommandShowDialogResult) slashCommandInvocationResult() {} +func (SlashCommandShowDialogResult) Kind() SlashCommandInvocationResultKind { + return SlashCommandInvocationResultKindShowDialog +} + // 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. @@ -9760,6 +13796,19 @@ func (SlashCommandTextResult) Kind() SlashCommandInvocationResultKind { return SlashCommandInvocationResultKindText } +// Experimental: SlashCommandModelPickerDialog is part of an experimental API and may change +// or be removed. +type SlashCommandModelPickerDialog struct { + // Discriminator for a model-picker dialog. + Kind SlashCommandModelPickerDialogKind `json:"kind"` + // Model that should be enabled before it can be selected. + ModelToEnable *string `json:"modelToEnable,omitempty"` + // Settings scope the picker should modify. + Scope *string `json:"scope,omitempty"` + // Model-selection target represented by the picker. + Target *string `json:"target,omitempty"` +} + // Selectable slash-command subcommand option with name, description, and optional group // label. // Experimental: SlashCommandSelectSubcommandOption is part of an experimental API and may @@ -9773,6 +13822,17 @@ type SlashCommandSelectSubcommandOption struct { Name string `json:"name"` } +// Experimental: SlashCommandTimelineEntry is part of an experimental API and may change or +// be removed. +type SlashCommandTimelineEntry struct { + // Text displayed for the timeline entry. + Text string `json:"text"` + // Timeline entry presentation type. + Type string `json:"type"` + // Optional URL associated with the timeline entry. + URL *string `json:"url,omitempty"` +} + // Configured per-agent subagent overrides // Experimental: SubagentSettings is part of an experimental API and may change or be // removed. @@ -9800,6 +13860,45 @@ type SubagentSettingsEntry struct { Model *string `json:"model,omitempty"` } +// Task completion notification with summary from the agent +// Experimental: TaskCompleteData is part of an experimental API and may change or be +// removed. +type TaskCompleteData struct { + // 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"` +} + +// Experimental: TaskCompletionDecision is part of an experimental API and may change or be +// removed. +type TaskCompletionDecision struct { + // Objective eligibility token captured when the decision was evaluated. + CompletionEligibilityToken *int64 `json:"completionEligibilityToken,omitempty"` + // Whether completion was accepted after the reviewer-rejection budget was exhausted. + CompletionRejectionBudgetExhausted *bool `json:"completionRejectionBudgetExhausted,omitempty"` + // Active autopilot objective evaluated by the completion reviewer. + ObjectiveID *int64 `json:"objectiveId,omitempty"` + // Semantic result of evaluating the task completion request. + Outcome TaskCompletionOutcome `json:"outcome"` + // Rationale for the completion decision, when one is available. + Reason *string `json:"reason,omitempty"` + // Whether the rationale was derived from completion-reviewer output. + ReviewerDerived *bool `json:"reviewerDerived,omitempty"` + // Information-flow metadata captured from the completion reviewer. + ReviewerResultMeta any `json:"reviewerResultMeta,omitempty"` +} + // 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 { @@ -9835,6 +13934,8 @@ type TaskAgentInfo struct { CompletedAt *time.Time `json:"completedAt,omitempty"` // Short description of the task Description string `json:"description"` + // Friendly, non-unique name intended for display + DisplayName *string `json:"displayName,omitempty"` // Error message when the task failed Error *string `json:"error,omitempty"` // Whether task execution is synchronously awaited or managed in the background @@ -10093,7 +14194,7 @@ type TasksStartAgentRequest struct { 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 + // Friendly, non-unique name used when displaying the agent Name string `json:"name"` // Task prompt for the agent Prompt string `json:"prompt"` @@ -10150,6 +14251,108 @@ type ToolList struct { Tools []Tool `json:"tools"` } +// Canonical result returned by a session tool. +// Experimental: ToolResult is part of an experimental API and may change or be removed. +type ToolResult interface { + toolResult() +} + +func (ToolResultExpanded) toolResult() {} + +type ToolStringResult string + +func (ToolStringResult) toolResult() {} + +// Expanded canonical result returned by a session tool. +// Experimental: ToolResultExpanded is part of an experimental API and may change or be +// removed. +type ToolResultExpanded struct { + // Base64-encoded binary results returned to the model. + BinaryResultsForLlm []ExternalToolTextResultForLlmBinaryResultsForLlm `json:"binaryResultsForLlm,omitzero"` + // Sources returned by the tool that the model may cite. + CitableSources []any `json:"citableSources,omitzero"` + // Structured content blocks returned to the model. + Contents []ExternalToolTextResultForLlmContent `json:"contents,omitzero"` + // Error message for an unsuccessful execution. + Error *string `json:"error,omitempty"` + // Metadata propagated with the tool result, including information-flow labels. + MCPMeta map[string]any `json:"mcpMeta,omitzero"` + // Messages to inject after the tool result. + NewMessages []ToolResultNewMessage `json:"newMessages,omitzero"` + // Whether post-tool-use failure hooks have already processed this result. + PostToolUseFailureHooksProcessed *bool `json:"postToolUseFailureHooksProcessed,omitempty"` + // Execution outcome classification. + ResultType ToolResultType `json:"resultType"` + // Detailed log content available for session display. + SessionLog *string `json:"sessionLog,omitempty"` + // Skill invocation metadata produced by the tool. + SkillInvocation any `json:"skillInvocation,omitempty"` + // Whether large-output post-processing should be skipped. + SkipLargeOutputProcessing *bool `json:"skipLargeOutputProcessing,omitempty"` + // Structured result content in addition to the model-facing text. + StructuredContent any `json:"structuredContent,omitempty"` + // Completion-review decision produced by the task-completion tool. + TaskCompletionDecision *TaskCompletionDecision `json:"taskCompletionDecision,omitempty"` + // Text result returned to the model. + TextResultForLlm string `json:"textResultForLlm"` + // Deferred tool names made available by this result. + ToolReferences []string `json:"toolReferences,omitzero"` + // Tool-specific telemetry payload. + ToolTelemetry any `json:"toolTelemetry,omitempty"` + // Optional UI resource produced by the tool. + UIResource any `json:"uiResource,omitempty"` +} + +// A message injected by a tool result. +// Experimental: ToolResultNewMessage is part of an experimental API and may change or be +// removed. +type ToolResultNewMessage struct { + // Message content to inject after the tool result. + Content string `json:"content"` + // Source attributed to the injected message. + Source string `json:"source"` +} + +// A tool name and arguments to execute through the session's native invocation pipeline. +// Experimental: ToolsExecuteRequest is part of an experimental API and may change or be +// removed. +type ToolsExecuteRequest struct { + // Arguments supplied to the tool. + Arguments any `json:"arguments"` + // Name of the currently offered tool to execute. + Name string `json:"name"` + // Optional identifier used to correlate this invocation with its tool call. + ToolCallID *string `json:"toolCallId,omitempty"` +} + +// Options controlling how Rust-owned built-in tool descriptors are materialized. +// Experimental: ToolsGetBuiltinDescriptorsRequest is part of an experimental API and may +// change or be removed. +type ToolsGetBuiltinDescriptorsRequest struct { + // Whether background task completion notifications are enabled. + BackgroundTaskNotificationsEnabled *bool `json:"backgroundTaskNotificationsEnabled,omitempty"` + // Whether tool descriptors should include authoring metadata. + IncludeAuthor *bool `json:"includeAuthor,omitempty"` + // Whether descriptors should favor fewer user-intervention prompts. + ReduceUserIntervention *bool `json:"reduceUserIntervention,omitempty"` + // Shell-specific names and description lines for shell tools. + ShellConfig *ToolsShellDescriptorConfig `json:"shellConfig,omitempty"` + // Whether the configured shell supports PowerShell 7 syntax. + ShellSupportsPowerShell7Syntax *bool `json:"shellSupportsPowerShell7Syntax,omitempty"` + // Default shell timeout in milliseconds. + ShellTimeoutMs *float64 `json:"shellTimeoutMs,omitempty"` + // Whether semantic skill lookup is available. + SkillEmbeddingEnabled *bool `json:"skillEmbeddingEnabled,omitempty"` +} + +// Rust-owned built-in tool descriptors for the session. +// Experimental: ToolsGetBuiltinDescriptorsResult is part of an experimental API and may +// change or be removed. +type ToolsGetBuiltinDescriptorsResult struct { + // Built-in tool descriptors materialized for the session. + Tools []BuiltinToolDescriptor `json:"tools"` +} + // Current lightweight tool metadata snapshot for the session. // Experimental: ToolsGetCurrentMetadataResult is part of an experimental API and may change // or be removed. @@ -10175,6 +14378,51 @@ type ToolsListRequest struct { Model *string `json:"model,omitempty"` } +// Complete externally implemented tool list for the calling connection. An empty list +// removes every tool previously supplied by that connection. +// Experimental: ToolsSetRequest is part of an experimental API and may change or be removed. +type ToolsSetRequest struct { + // Complete replacement list for the calling connection. + Tools []ProtocolExternalToolDefinition `json:"tools"` +} + +// Empty result after replacing the calling connection's externally implemented tools. +// Experimental: ToolsSetResult is part of an experimental API and may change or be removed. +type ToolsSetResult struct { +} + +// Shell-specific names and description lines used to materialize built-in shell tool +// descriptors. +// Experimental: ToolsShellDescriptorConfig is part of an experimental API and may change or +// be removed. +type ToolsShellDescriptorConfig struct { + // Additional model-facing shell description lines. + DescriptionLines []string `json:"descriptionLines"` + // Human-readable shell name. + DisplayName string `json:"displayName"` + // Tool name used to list active shells. + ListShellsToolName string `json:"listShellsToolName"` + // Tool name used to read shell output. + ReadShellToolName string `json:"readShellToolName"` + // Tool name used to start shell commands. + ShellToolName string `json:"shellToolName"` + // Stable shell type identifier. + ShellType string `json:"shellType"` + // Tool name used to stop shell commands. + StopShellToolName string `json:"stopShellToolName"` +} + +// Task-completion tool arguments and final result used to build a label-safe session event +// payload. +// Experimental: ToolsTaskCompleteEventDataRequest is part of an experimental API and may +// change or be removed. +type ToolsTaskCompleteEventDataRequest struct { + // Final expanded result returned by the task_complete tool. + FinalResult ToolResultExpanded `json:"finalResult"` + // Arguments supplied to the completed task_complete tool call. + ToolArgs any `json:"toolArgs"` +} + // Empty result after applying subagent settings // Experimental: ToolsUpdateSubagentSettingsResult is part of an experimental API and may // change or be removed. @@ -10239,8 +14487,14 @@ func (UIElicitationStringValue) uiElicitationFieldValue() {} type UIElicitationRequest struct { // Message describing what information is needed from the user Message string `json:"message"` + // MCP request metadata. + Meta map[string]any `json:"_meta,omitzero"` + // Elicitation mode. Omitted and form are equivalent for structured elicitation. + Mode *MCPElicitationFormMode `json:"mode,omitempty"` // JSON Schema describing the form fields to present to the user RequestedSchema UIElicitationSchema `json:"requestedSchema"` + // MCP task metadata. + Task *MCPTaskMetadata `json:"task,omitempty"` } // The elicitation response (accept with form values, decline, or cancel) @@ -10251,6 +14505,8 @@ type UIElicitationResponse struct { Action UIElicitationResponseAction `json:"action"` // The form values submitted by the user (present when action is 'accept') Content map[string]UIElicitationFieldValue `json:"content,omitzero"` + // MCP response metadata. + Meta map[string]any `json:"_meta,omitzero"` } // The form values submitted by the user (present when action is 'accept') @@ -10480,11 +14736,12 @@ type UIEphemeralQueryRequest struct { Question string `json:"question"` } -// Transient answer generated from current conversation context. +// Completed transient query. Ordered chunks and the terminal outcome are also delivered +// through `ui.ephemeral_query` session events while it runs. // Experimental: UIEphemeralQueryResult is part of an experimental API and may change or be // removed. type UIEphemeralQueryResult struct { - // Full assistant response text. + // Answer returned by the model Answer string `json:"answer"` } @@ -10497,6 +14754,11 @@ type UIExitPlanModeResponse struct { 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, @@ -10656,6 +14918,9 @@ type UpdateSubagentSettingsRequest struct { // Experimental: UsageGetMetricsResult is part of an experimental API and may change or be // removed. type UsageGetMetricsResult struct { + // Per-agent usage metrics, keyed by agent instance identifier. The main conversation uses + // the stable key `main`. + AgentMetrics map[string]UsageMetricsAgentMetric `json:"agentMetrics,omitzero"` // Aggregated code change metrics CodeChanges UsageMetricsCodeChanges `json:"codeChanges"` // Currently active model identifier @@ -10681,6 +14946,26 @@ type UsageGetMetricsResult struct { TotalUserRequests int64 `json:"totalUserRequests"` } +// Usage attributed to one agent instance, including its identity, API duration, AI units, +// and per-model breakdown. +// Experimental: UsageMetricsAgentMetric is part of an experimental API and may change or be +// removed. +type UsageMetricsAgentMetric struct { + // Human-readable label for this subagent invocation, copied from the originating + // `subagent.started` event. For task-tool subagents this is the invocation's task + // description rather than the agent's configured display name, so group by `agentName` for + // stable per-agent labels. + AgentDisplayName *string `json:"agentDisplayName,omitempty"` + // Configured agent name, when this is a subagent + AgentName *string `json:"agentName,omitempty"` + // Per-model usage for this agent, keyed by model identifier + ModelMetrics map[string]UsageMetricsModelMetric `json:"modelMetrics"` + // Time spent in model API calls by this agent, in milliseconds + TotalAPIDurationMs int64 `json:"totalApiDurationMs"` + // Accumulated nano-AI units cost for this agent + TotalNanoAiu float64 `json:"totalNanoAiu"` +} + // Aggregated code change metrics // Experimental: UsageMetricsCodeChanges is part of an experimental API and may change or be // removed. @@ -10866,6 +15151,23 @@ func (UserToolSessionApprovalCustomTool) Kind() UserToolSessionApprovalKind { return UserToolSessionApprovalKindCustomTool } +// Session-scoped tool-approval rule for an extension's access to sensitive environment +// variables, keyed by extension name and the exact set of variable names. +// Experimental: UserToolSessionApprovalExtensionEnvAccess is part of an experimental API +// and may change or be removed. +type UserToolSessionApprovalExtensionEnvAccess struct { + // Names of the sensitive environment variables this approval covers. Values are never + // persisted. + EnvironmentVariables []string `json:"environmentVariables"` + // Extension name + ExtensionName string `json:"extensionName"` +} + +func (UserToolSessionApprovalExtensionEnvAccess) userToolSessionApproval() {} +func (UserToolSessionApprovalExtensionEnvAccess) Kind() UserToolSessionApprovalKind { + return UserToolSessionApprovalKindExtensionEnvAccess +} + // Session-scoped tool-approval rule for extension-management operations, optionally // narrowed by operation. // Experimental: UserToolSessionApprovalExtensionManagement is part of an experimental API @@ -10894,6 +15196,19 @@ func (UserToolSessionApprovalExtensionPermissionAccess) Kind() UserToolSessionAp 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 @@ -10995,7 +15310,9 @@ type WorkspaceDiffFileChange struct { 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 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"` } @@ -11007,12 +15324,49 @@ type WorkspaceDiffResult struct { 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. + // 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 { + // Metadata for the persisted summary. + Summary any `json:"summary,omitempty"` + // Refreshed metadata for the containing workspace. + 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 @@ -11038,6 +15392,14 @@ type WorkspacesCreateFileRequest struct { 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. @@ -11048,6 +15410,14 @@ type WorkspacesDiffRequest struct { 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 @@ -11061,24 +15431,40 @@ type WorkspacesGetWorkspaceResult 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"` + // Current Git branch. + Branch *string `json:"branch,omitempty"` + // Whether the per-session Chronicle upgrade prompt was dismissed for the workspace. + ChronicleSyncDismissed *bool `json:"chronicle_sync_dismissed,omitempty"` + // Name of the client that created the workspace. + ClientName *string `json:"client_name,omitempty"` + // Timestamp when the workspace was created. + CreatedAt *time.Time `json:"created_at,omitempty"` + // Current working directory associated with the workspace. + Cwd *string `json:"cwd,omitempty"` + // Git repository root associated with the workspace. + 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"` + HostType *WorkspacesWorkspaceDetailsHostType `json:"host_type,omitempty"` + // Stable workspace identifier. + ID string `json:"id"` + // Most recent Mission Control event identifier observed for the workspace. + McLastEventID *string `json:"mc_last_event_id,omitempty"` + // Mission Control session identifier associated with the workspace. + McSessionID *string `json:"mc_session_id,omitempty"` + // Mission Control task identifier associated with the workspace. + McTaskID *string `json:"mc_task_id,omitempty"` + // Workspace display name. + Name *string `json:"name,omitempty"` + // Whether the workspace session can be steered remotely. + RemoteSteerable *bool `json:"remote_steerable,omitempty"` + // Repository identifier associated with the workspace. + Repository *string `json:"repository,omitempty"` + // Number of persisted summaries in the workspace. + SummaryCount *int64 `json:"summary_count,omitempty"` + // Timestamp when the workspace was last updated. + UpdatedAt *time.Time `json:"updated_at,omitempty"` + // Whether the workspace name was explicitly chosen by the user. + UserNamed *bool `json:"user_named,omitempty"` } // Workspace checkpoints in chronological order; empty when the workspace is not enabled. @@ -11097,6 +15483,14 @@ type WorkspacesListFilesResult struct { 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. @@ -11155,6 +15549,14 @@ type WorkspacesSaveLargePasteResultSaved struct { 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. @@ -11181,11 +15583,40 @@ type WorkspaceSummary struct { 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. @@ -11423,9 +15854,367 @@ const ( AuthInfoTypeGhCLI AuthInfoType = "gh-cli" AuthInfoTypeHMAC AuthInfoType = "hmac" AuthInfoTypeToken AuthInfoType = "token" + AuthInfoTypeTokenProvider AuthInfoType = "token-provider" AuthInfoTypeUser AuthInfoType = "user" ) +// Custom input-format kind. +// Experimental: BuiltinToolFormatType is part of an experimental API and may change or be +// removed. +type BuiltinToolFormatType string + +const ( + // The tool input is parsed with the supplied grammar. + BuiltinToolFormatTypeGrammar BuiltinToolFormatType = "grammar" +) + +// Root JSON Schema type for a built-in tool input. +// Experimental: BuiltinToolInputSchemaType is part of an experimental API and may change or +// be removed. +type BuiltinToolInputSchemaType string + +const ( + // The tool accepts a JSON object. + BuiltinToolInputSchemaTypeObject BuiltinToolInputSchemaType = "object" +) + +// Canonical digest algorithm for a validated MCP card +// Experimental: CardDigestAlgorithm is part of an experimental API and may change or be +// removed. +type CardDigestAlgorithm string + +const ( + // SHA-256 over RFC 8785 canonical JSON encoded as UTF-8. + CardDigestAlgorithmSha256Rfc8785 CardDigestAlgorithm = "sha256-rfc8785" +) + +// AI skills are discovery-only and cannot be installed through this surface +type CatalogAiSkillCandidateInstallability string + +const ( + CatalogAiSkillCandidateInstallabilityNotInstallableKind CatalogAiSkillCandidateInstallability = "not-installable-kind" +) + +// Media type of the underlying AI skill card +type CatalogAiSkillCandidateMediaType string + +const ( + CatalogAiSkillCandidateMediaTypeApplicationAiSkill CatalogAiSkillCandidateMediaType = "application/ai-skill" +) + +// Media type advertised for the referenced AI skill card +type CatalogAiSkillCandidateProvenanceMediaType string + +const ( + CatalogAiSkillCandidateProvenanceMediaTypeApplicationAiSkill CatalogAiSkillCandidateProvenanceMediaType = "application/ai-skill" +) + +// Why the catalog authority did not accept the caller's identity +// Experimental: CatalogAuthenticationRequiredReason is part of an experimental API and may +// change or be removed. +type CatalogAuthenticationRequiredReason string + +const ( + // A credential was presented and its lifetime has elapsed. A silent refresh is worth + // attempting before prompting anyone. + CatalogAuthenticationRequiredReasonCredentialExpired CatalogAuthenticationRequiredReason = "credential-expired" + // A credential was presented and the authority refused it, for example because it was + // revoked, malformed, or issued for another audience. Refreshing the same rejected + // credential is not useful; the caller must sign in again. + CatalogAuthenticationRequiredReasonCredentialRejected CatalogAuthenticationRequiredReason = "credential-rejected" + // No credential was presented, so there is nothing to refresh and the caller must sign in. + CatalogAuthenticationRequiredReasonNoCredential CatalogAuthenticationRequiredReason = "no-credential" +) + +// Kind discriminator for CatalogCandidate. +// Experimental: CatalogCandidateKind is part of an experimental API and may change or be +// removed. +type CatalogCandidateKind string + +const ( + CatalogCandidateKindAiSkill CatalogCandidateKind = "ai-skill" + CatalogCandidateKindMCPServer CatalogCandidateKind = "mcp-server" +) + +// Kind discriminator for CatalogCandidateSource. +type CatalogCandidateSourceKind string + +const ( + CatalogCandidateSourceKindEmbedded CatalogCandidateSourceKind = "embedded" + CatalogCandidateSourceKindURL CatalogCandidateSourceKind = "url" +) + +// A wire feature a caller can require of the catalog surface, negotiated per request. A +// grant means the runtime understands the feature's contract, not that the deployment has +// enabled the operation; typed unavailable results report availability separately. +// Experimental: CatalogCapability is part of an experimental API and may change or be +// removed. +type CatalogCapability string + +const ( + // Understands `application/ai-skill` candidates as discovery-only and typed non-installable. + CatalogCapabilityAiSkillDiscovery CatalogCapability = "ai-skill-discovery" + // Understands the legacy `application/mcp-server+json` media type. + CatalogCapabilityLegacyMCPServerCard CatalogCapability = "legacy-mcp-server-card" + // Understands side-effect-free MCP install-plan requests, results, and plan handles; + // `planning-unavailable` separately reports that planning is not enabled. + CatalogCapabilityMCPInstallPlanning CatalogCapability = "mcp-install-planning" + // Understands the current `application/mcp-server-card+json` media type. + CatalogCapabilityMCPServerCard CatalogCapability = "mcp-server-card" + // Understands plans that enumerate every eligible transport rather than a single preferred + // one. + CatalogCapabilityMultipleTransportChoice CatalogCapability = "multiple-transport-choice" +) + +// Which wire-contract rule an upstream response broke +// Experimental: CatalogContractViolationReason is part of an experimental API and may +// change or be removed. +type CatalogContractViolationReason string + +const ( + // A result carried both a URL and embedded data, when exactly one is permitted. + CatalogContractViolationReasonBothURLAndData CatalogContractViolationReason = "both-url-and-data" + // Two results claimed the same normalised identity. + CatalogContractViolationReasonDuplicateIdentity CatalogContractViolationReason = "duplicate-identity" + // A result carried neither a URL nor embedded data, when exactly one is required. + CatalogContractViolationReasonNeitherURLNorData CatalogContractViolationReason = "neither-url-nor-data" + // A result declared no media type, or one this contract does not model. + CatalogContractViolationReasonUnknownMediaType CatalogContractViolationReason = "unknown-media-type" +) + +// Why a presented handle was rejected +// Experimental: CatalogHandleRejectionReason is part of an experimental API and may change +// or be removed. +type CatalogHandleRejectionReason string + +const ( + // The handle was issued by a different runtime instance. + CatalogHandleRejectionReasonForeign CatalogHandleRejectionReason = "foreign" + // The handle is unparseable, unknown, or was issued for a different operation. + CatalogHandleRejectionReasonInvalid CatalogHandleRejectionReason = "invalid" + // The handle has already been used, and handles are single-use. + CatalogHandleRejectionReasonReplayed CatalogHandleRejectionReason = "replayed" + // The handle's time to live has elapsed. + CatalogHandleRejectionReasonStale CatalogHandleRejectionReason = "stale" +) + +// Which kind of opaque handle was presented +// Experimental: CatalogHandleType is part of an experimental API and may change or be +// removed. +type CatalogHandleType string + +const ( + // A search candidate handle. + CatalogHandleTypeCandidate CatalogHandleType = "candidate" + // An install plan handle. + CatalogHandleTypePlan CatalogHandleType = "plan" +) + +// Which request field was rejected before any work was done +// Experimental: CatalogInvalidRequestField is part of an experimental API and may change or +// be removed. +type CatalogInvalidRequestField string + +const ( + // The supplied card was missing its media type, URL, or data. + CatalogInvalidRequestFieldCard CatalogInvalidRequestField = "card" + // The negotiation block was missing or malformed. + CatalogInvalidRequestFieldContract CatalogInvalidRequestField = "contract" + // The requested candidate kinds were empty or contained a duplicate. + CatalogInvalidRequestFieldKinds CatalogInvalidRequestField = "kinds" + // The requested result count fell outside its permitted range. + CatalogInvalidRequestFieldLimit CatalogInvalidRequestField = "limit" + // The search query was empty or longer than permitted. + CatalogInvalidRequestFieldQuery CatalogInvalidRequestField = "query" + // The requested configuration scope is not one this runtime writes. + CatalogInvalidRequestFieldScope CatalogInvalidRequestField = "scope" + // The plan source was missing or malformed. + CatalogInvalidRequestFieldSource CatalogInvalidRequestField = "source" +) + +// How a card failed validation +// Experimental: CatalogMalformedCardReason is part of an experimental API and may change or +// be removed. +type CatalogMalformedCardReason string + +const ( + // The document is not well-formed JSON. + CatalogMalformedCardReasonInvalidJSON CatalogMalformedCardReason = "invalid-json" + // A field the media type requires is absent. + CatalogMalformedCardReasonMissingRequiredField CatalogMalformedCardReason = "missing-required-field" + // The document does not satisfy its media type's schema. + CatalogMalformedCardReasonSchemaViolation CatalogMalformedCardReason = "schema-violation" + // The document exceeded the permitted size. + CatalogMalformedCardReasonSizeLimitExceeded CatalogMalformedCardReason = "size-limit-exceeded" + // The declared media type is not one this runtime understands. + CatalogMalformedCardReasonUnsupportedMediaType CatalogMalformedCardReason = "unsupported-media-type" +) + +// Whether an MCP server candidate can be planned for installation +// Experimental: CatalogMCPServerInstallability is part of an experimental API and may +// change or be removed. +type CatalogMCPServerInstallability string + +const ( + // An install plan can be computed for this MCP server candidate. + CatalogMCPServerInstallabilityInstallable CatalogMCPServerInstallability = "installable" + // Policy forbids installing this MCP server candidate. + CatalogMCPServerInstallabilityNotInstallablePolicy CatalogMCPServerInstallability = "not-installable-policy" +) + +// Media type a catalog card is interpreted as +// Experimental: CatalogMediaType is part of an experimental API and may change or be +// removed. +type CatalogMediaType string + +const ( + // An AI skill card. Representable and searchable, but typed non-installable. + CatalogMediaTypeApplicationAiSkill CatalogMediaType = "application/ai-skill" + // The current MCP server card media type. + CatalogMediaTypeApplicationMCPServerCardJSON CatalogMediaType = "application/mcp-server-card+json" + // The legacy MCP server card media type, accepted for compatibility. + CatalogMediaTypeApplicationMCPServerJSON CatalogMediaType = "application/mcp-server+json" +) + +// Why capability and protocol-version negotiation refused a caller +// Experimental: CatalogNegotiationRefusedReason is part of an experimental API and may +// change or be removed. +type CatalogNegotiationRefusedReason string + +const ( + // The caller requires at least one capability this runtime cannot honour. + CatalogNegotiationRefusedReasonUnsupportedCapability CatalogNegotiationRefusedReason = "unsupported-capability" + // The caller's protocol version is below the lowest this runtime serves. + CatalogNegotiationRefusedReasonUnsupportedProtocolVersion CatalogNegotiationRefusedReason = "unsupported-protocol-version" +) + +// Categorised network failure, low cardinality so it can be aggregated without carrying a +// URL +// Experimental: CatalogNetworkFailureReason is part of an experimental API and may change +// or be removed. +type CatalogNetworkFailureReason string + +const ( + // The connection was refused or reset. + CatalogNetworkFailureReasonConnectionRefused CatalogNetworkFailureReason = "connection-refused" + // The authority's name could not be resolved. + CatalogNetworkFailureReasonDns CatalogNetworkFailureReason = "dns" + // The authority returned a status the runtime treats as a failure. + CatalogNetworkFailureReasonHTTPStatus CatalogNetworkFailureReason = "http-status" + // No network is available, so nothing was attempted. + CatalogNetworkFailureReasonOffline CatalogNetworkFailureReason = "offline" + // A redirect was refused by the runtime's redirect policy. + CatalogNetworkFailureReasonRedirectRejected CatalogNetworkFailureReason = "redirect-rejected" + // The response exceeded the permitted size. + CatalogNetworkFailureReasonResponseTooLarge CatalogNetworkFailureReason = "response-too-large" + // The request exceeded its time budget. + CatalogNetworkFailureReasonTimeout CatalogNetworkFailureReason = "timeout" + // The TLS handshake or certificate validation failed. + CatalogNetworkFailureReasonTls CatalogNetworkFailureReason = "tls" +) + +// Why a discoverable candidate cannot be installed +// Experimental: CatalogNotInstallableReason is part of an experimental API and may change +// or be removed. +type CatalogNotInstallableReason string + +const ( + // AI skills are discoverable but have no typed importer in this phase. + CatalogNotInstallableReasonAiSkillNotInstallable CatalogNotInstallableReason = "ai-skill-not-installable" + // This kind of resource is not installable through this surface. + CatalogNotInstallableReasonKindNotInstallable CatalogNotInstallableReason = "kind-not-installable" + // Policy forbids installing this candidate. + CatalogNotInstallableReasonPolicyForbids CatalogNotInstallableReason = "policy-forbids" +) + +// Kind discriminator for CatalogSearchResult. +type CatalogSearchResultKind string + +const ( + CatalogSearchResultKindAuthenticationRequired CatalogSearchResultKind = "authentication-required" + CatalogSearchResultKindContractViolation CatalogSearchResultKind = "contract-violation" + CatalogSearchResultKindInvalidRequest CatalogSearchResultKind = "invalid-request" + CatalogSearchResultKindMalformedCard CatalogSearchResultKind = "malformed-card" + CatalogSearchResultKindNegotiationRefused CatalogSearchResultKind = "negotiation-refused" + CatalogSearchResultKindNetworkFailure CatalogSearchResultKind = "network-failure" + CatalogSearchResultKindPolicyRejected CatalogSearchResultKind = "policy-rejected" + CatalogSearchResultKindSucceeded CatalogSearchResultKind = "succeeded" + CatalogSearchResultKindUnavailable CatalogSearchResultKind = "unavailable" + CatalogSearchResultKindUnsafeRetrieval CatalogSearchResultKind = "unsafe-retrieval" + CatalogSearchResultKindUnsupportedKind CatalogSearchResultKind = "unsupported-kind" +) + +// Why a catalog operation is not available on this runtime +// Experimental: CatalogUnavailableReason is part of an experimental API and may change or +// be removed. +type CatalogUnavailableReason string + +const ( + // No catalog authority is configured for this runtime. + CatalogUnavailableReasonAuthorityNotConfigured CatalogUnavailableReason = "authority-not-configured" + // The surface is disabled by policy on this runtime. + CatalogUnavailableReasonDisabledByPolicy CatalogUnavailableReason = "disabled-by-policy" + // Install planning is not wired up on this runtime build. + CatalogUnavailableReasonPlanningUnavailable CatalogUnavailableReason = "planning-unavailable" + // Bounded search is not wired up on this runtime build. + CatalogUnavailableReasonSearchUnavailable CatalogUnavailableReason = "search-unavailable" +) + +// Why no usable transport could be offered +// Experimental: CatalogUnavailableTransportReason is part of an experimental API and may +// change or be removed. +type CatalogUnavailableTransportReason string + +const ( + // The card advertises no transport this runtime can use. + CatalogUnavailableTransportReasonNoEligibleTransport CatalogUnavailableTransportReason = "no-eligible-transport" + // Eligible remotes could not be enumerated, so no explicit choice can be offered. + CatalogUnavailableTransportReasonRemoteEnumerationUnavailable CatalogUnavailableTransportReason = "remote-enumeration-unavailable" + // Every advertised transport is of a kind this runtime does not implement. + CatalogUnavailableTransportReasonTransportNotSupported CatalogUnavailableTransportReason = "transport-not-supported" +) + +// Which hardened-fetch control refused a retrieval +// Experimental: CatalogUnsafeRetrievalReason is part of an experimental API and may change +// or be removed. +type CatalogUnsafeRetrievalReason string + +const ( + // The URL resolved to a loopback, private, link-local, or cloud metadata address. + CatalogUnsafeRetrievalReasonBlockedAddress CatalogUnsafeRetrievalReason = "blocked-address" + // The URL used a scheme the runtime refuses to fetch. + CatalogUnsafeRetrievalReasonBlockedScheme CatalogUnsafeRetrievalReason = "blocked-scheme" + // The URL embedded credentials. + CatalogUnsafeRetrievalReasonCredentialsInURL CatalogUnsafeRetrievalReason = "credentials-in-url" + // The authority is not permitted for card retrieval. + CatalogUnsafeRetrievalReasonHostNotPermitted CatalogUnsafeRetrievalReason = "host-not-permitted" + // The configured proxy policy refused the request. + CatalogUnsafeRetrievalReasonProxyRejected CatalogUnsafeRetrievalReason = "proxy-rejected" + // A redirect target resolved to a blocked address. + CatalogUnsafeRetrievalReasonRedirectToBlockedAddress CatalogUnsafeRetrievalReason = "redirect-to-blocked-address" +) + +// Whether a pending slash-command invocation effect was applied or cancelled by the host. +// Experimental: CommandsInvocationEffectOutcome is part of an experimental API and may +// change or be removed. +type CommandsInvocationEffectOutcome string + +const ( + // The host applied the pending invocation effect. + CommandsInvocationEffectOutcomeApplied CommandsInvocationEffectOutcome = "applied" + // The host cancelled the pending invocation effect, so any provisional state must be + // reverted. + CommandsInvocationEffectOutcomeCancelled CommandsInvocationEffectOutcome = "cancelled" +) + +// Experimental: CommandsInvocationOrigin is part of an experimental API and may change or +// be removed. +type CommandsInvocationOrigin string + +const ( + CommandsInvocationOriginSettings CommandsInvocationOrigin = "settings" +) + // Neutral SDK discriminator for the connected remote session kind. // Experimental: ConnectedRemoteSessionMetadataKind is part of an experimental API and may // change or be removed. @@ -11533,6 +16322,32 @@ const ( DebugCollectLogsSourceShellLog DebugCollectLogsSource = "shell-log" ) +// 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. @@ -11572,7 +16387,11 @@ const ( // 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. // Experimental: EventsCursorStatus is part of an experimental API and may change or be // removed. type EventsCursorStatus string @@ -11584,6 +16403,21 @@ const ( 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. @@ -11654,6 +16488,36 @@ const ( 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" + // Renewing the durable owner lease that proves this process still owns the run. + FactoryDurableOperationRefreshLease FactoryDurableOperation = "refreshLease" + // 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. @@ -11666,24 +16530,46 @@ const ( 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 timeout deadline. - FactoryRunFailureKindTimeout FactoryRunFailureKind = "timeout" + // The run reached the approved accumulated active-execution time in seconds. + FactoryRunFailureKindTimeoutSeconds FactoryRunFailureKind = "timeoutSeconds" ) // Type discriminator for FactoryRunFailure. type FactoryRunFailureType string const ( - FactoryRunFailureTypeFactoryLimitReached FactoryRunFailureType = "factory_limit_reached" - FactoryRunFailureTypeFactoryResumeDeclined FactoryRunFailureType = "factory_resume_declined" + 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. @@ -11706,6 +16592,129 @@ const ( FactoryRunStatusRunning FactoryRunStatus = "running" ) +// Why the runtime is requesting a GitHub credential. +// Experimental: GitHubTokenAcquireReason is part of an experimental API and may change or +// be removed. +type GitHubTokenAcquireReason string + +const ( + // The runtime is acquiring the registration's first credential. + GitHubTokenAcquireReasonInitial GitHubTokenAcquireReason = "initial" + // The runtime is replacing a credential that is approaching expiry. + GitHubTokenAcquireReasonRefresh GitHubTokenAcquireReason = "refresh" +) + +// Kind discriminator for GitHubTokenAcquireResult. +// Experimental: GitHubTokenAcquireResultKind is part of an experimental API and may change +// or be removed. +type GitHubTokenAcquireResultKind string + +const ( + GitHubTokenAcquireResultKindCancelled GitHubTokenAcquireResultKind = "cancelled" + GitHubTokenAcquireResultKindToken GitHubTokenAcquireResultKind = "token" +) + +// 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 @@ -11970,8 +16979,17 @@ const ( MCPAppsSetHostContextDetailsThemeLight MCPAppsSetHostContextDetailsTheme = "light" ) -// Kind discriminator for MCPHeadersHandlePendingHeadersRefreshRequest. -type MCPHeadersHandlePendingHeadersRefreshRequestKind string +// Structured MCP elicitation mode. +// Experimental: MCPElicitationFormMode is part of an experimental API and may change or be +// removed. +type MCPElicitationFormMode string + +const ( + MCPElicitationFormModeForm MCPElicitationFormMode = "form" +) + +// Kind discriminator for MCPHeadersHandlePendingHeadersRefreshRequest. +type MCPHeadersHandlePendingHeadersRefreshRequestKind string const ( MCPHeadersHandlePendingHeadersRefreshRequestKindHeaders MCPHeadersHandlePendingHeadersRefreshRequestKind = "headers" @@ -11992,6 +17010,8 @@ const ( ) // Kind discriminator for MCPOauthPendingRequestResponse. +// Experimental: MCPOauthPendingRequestResponseKind is part of an experimental API and may +// change or be removed. type MCPOauthPendingRequestResponseKind string const ( @@ -11999,6 +17019,255 @@ const ( MCPOauthPendingRequestResponseKindToken MCPOauthPendingRequestResponseKind = "token" ) +// Why a passive MCP OAuth probe determined authentication is needed. +// Experimental: MCPOauthProbeNeedsAuthReason is part of an experimental API and may change +// or be removed. +type MCPOauthProbeNeedsAuthReason string + +const ( + // No token was sent and the server requires authentication. + MCPOauthProbeNeedsAuthReasonInitial MCPOauthProbeNeedsAuthReason = "initial" + // A cached token was sent and rejected. + MCPOauthProbeNeedsAuthReasonRefresh MCPOauthProbeNeedsAuthReason = "refresh" + // The server returned a 403 insufficient_scope challenge, indicating additional scopes or + // audience are needed. + MCPOauthProbeNeedsAuthReasonUpscope MCPOauthProbeNeedsAuthReason = "upscope" +) + +// Status discriminator for MCPOauthProbeResult. +type MCPOauthProbeResultStatus string + +const ( + MCPOauthProbeResultStatusAuthenticated MCPOauthProbeResultStatus = "authenticated" + MCPOauthProbeResultStatusFailed MCPOauthProbeResultStatus = "failed" + MCPOauthProbeResultStatusNeedsAuth MCPOauthProbeResultStatus = "needs-auth" + MCPOauthProbeResultStatusNoAuthRequired MCPOauthProbeResultStatus = "no-auth-required" +) + +// Whether a planned configuration change would create or modify an entry +// Experimental: MCPPlanConfigurationOperation is part of an experimental API and may change +// or be removed. +type MCPPlanConfigurationOperation string + +const ( + // Creates a configuration entry that does not exist yet. + MCPPlanConfigurationOperationAdd MCPPlanConfigurationOperation = "add" + // Modifies a configuration entry that already exists. + MCPPlanConfigurationOperationUpdate MCPPlanConfigurationOperation = "update" +) + +// Discriminator for an enumerated required value +// Experimental: MCPPlanEnumValueType is part of an experimental API and may change or be +// removed. +type MCPPlanEnumValueType string + +const ( + // One of a fixed, non-empty set of permitted values. + MCPPlanEnumValueTypeEnum MCPPlanEnumValueType = "enum" +) + +// Kind discriminator for MCPPlanInstallResult. +type MCPPlanInstallResultKind string + +const ( + MCPPlanInstallResultKindAuthenticationRequired MCPPlanInstallResultKind = "authentication-required" + MCPPlanInstallResultKindContractViolation MCPPlanInstallResultKind = "contract-violation" + MCPPlanInstallResultKindHandleRejected MCPPlanInstallResultKind = "handle-rejected" + MCPPlanInstallResultKindInvalidRequest MCPPlanInstallResultKind = "invalid-request" + MCPPlanInstallResultKindMalformedCard MCPPlanInstallResultKind = "malformed-card" + MCPPlanInstallResultKindNegotiationRefused MCPPlanInstallResultKind = "negotiation-refused" + MCPPlanInstallResultKindNetworkFailure MCPPlanInstallResultKind = "network-failure" + MCPPlanInstallResultKindNotInstallable MCPPlanInstallResultKind = "not-installable" + MCPPlanInstallResultKindPlanned MCPPlanInstallResultKind = "planned" + MCPPlanInstallResultKindPolicyRejected MCPPlanInstallResultKind = "policy-rejected" + MCPPlanInstallResultKindUnavailable MCPPlanInstallResultKind = "unavailable" + MCPPlanInstallResultKindUnavailableTransport MCPPlanInstallResultKind = "unavailable-transport" + MCPPlanInstallResultKindUnsafeRetrieval MCPPlanInstallResultKind = "unsafe-retrieval" +) + +// Discriminator for a candidate-backed install-plan source +// Experimental: MCPPlanInstallSourceCandidateKind is part of an experimental API and may +// change or be removed. +type MCPPlanInstallSourceCandidateKind string + +const ( + // Plan from a candidate returned by catalog search. + MCPPlanInstallSourceCandidateKindCandidate MCPPlanInstallSourceCandidateKind = "candidate" +) + +// Discriminator for a caller-supplied-card install-plan source +// Experimental: MCPPlanInstallSourceCardKind is part of an experimental API and may change +// or be removed. +type MCPPlanInstallSourceCardKind string + +const ( + // Plan directly from a caller-supplied card. + MCPPlanInstallSourceCardKindCard MCPPlanInstallSourceCardKind = "card" +) + +// Kind discriminator for MCPPlanInstallSource. +type MCPPlanInstallSourceKind string + +const ( + MCPPlanInstallSourceKindCandidate MCPPlanInstallSourceKind = "candidate" + MCPPlanInstallSourceKindCard MCPPlanInstallSourceKind = "card" +) + +// Discriminator for a package-backed transport choice +// Experimental: MCPPlanPackageInstallMethod is part of an experimental API and may change +// or be removed. +type MCPPlanPackageInstallMethod string + +const ( + // Install and run a local package. + MCPPlanPackageInstallMethodPackage MCPPlanPackageInstallMethod = "package" +) + +// Transport exposed by a locally launched package +// Experimental: MCPPlanPackageTransport is part of an experimental API and may change or be +// removed. +type MCPPlanPackageTransport string + +const ( + // A locally launched process spoken to over standard input and output. + MCPPlanPackageTransportStdio MCPPlanPackageTransport = "stdio" +) + +// What policy decided for a planned server +// Experimental: MCPPlanPolicyDecision is part of an experimental API and may change or be +// removed. +type MCPPlanPolicyDecision string + +const ( + // Policy permits the server. + MCPPlanPolicyDecisionAllowed MCPPlanPolicyDecision = "allowed" + // Policy forbids the server, so the plan cannot be applied. + MCPPlanPolicyDecisionBlocked MCPPlanPolicyDecision = "blocked" + // Policy permits the server only after an explicit approval. + MCPPlanPolicyDecisionRequiresApproval MCPPlanPolicyDecision = "requires-approval" +) + +// Which authority produced a policy decision +// Experimental: MCPPlanPolicySource is part of an experimental API and may change or be +// removed. +type MCPPlanPolicySource string + +const ( + // An enterprise allowlist evaluated the server. + MCPPlanPolicySourceEnterpriseAllowlist MCPPlanPolicySource = "enterprise-allowlist" + // Local trust settings evaluated the server. + MCPPlanPolicySourceLocalTrust MCPPlanPolicySource = "local-trust" + // No policy applied, so the server is permitted by default. + MCPPlanPolicySourceNone MCPPlanPolicySource = "none" + // The registry the card came from evaluated the server. + MCPPlanPolicySourceRegistryPolicy MCPPlanPolicySource = "registry-policy" +) + +// Discriminator for a remote-endpoint transport choice +// Experimental: MCPPlanRemoteInstallMethod is part of an experimental API and may change or +// be removed. +type MCPPlanRemoteInstallMethod string + +const ( + // Connect to a remote endpoint. + MCPPlanRemoteInstallMethodRemote MCPPlanRemoteInstallMethod = "remote" +) + +// Transport exposed by a remote endpoint +// Experimental: MCPPlanRemoteTransport is part of an experimental API and may change or be +// removed. +type MCPPlanRemoteTransport string + +const ( + // An HTTP endpoint. + MCPPlanRemoteTransportHTTP MCPPlanRemoteTransport = "http" + // A server-sent events endpoint. + MCPPlanRemoteTransportSSE MCPPlanRemoteTransport = "sse" + // A streamable HTTP endpoint. + MCPPlanRemoteTransportStreamableHTTP MCPPlanRemoteTransport = "streamable-http" +) + +// Discriminator for an enumerated required value +// Experimental: MCPPlanRequiredValueEnumKind is part of an experimental API and may change +// or be removed. +type MCPPlanRequiredValueEnumKind string + +const ( + // The value uses a fixed non-empty enumeration. + MCPPlanRequiredValueEnumKindEnum MCPPlanRequiredValueEnumKind = "enum" +) + +// Kind discriminator for MCPPlanRequiredValue. +type MCPPlanRequiredValueKind string + +const ( + MCPPlanRequiredValueKindEnum MCPPlanRequiredValueKind = "enum" + MCPPlanRequiredValueKindScalar MCPPlanRequiredValueKind = "scalar" +) + +// Discriminator for a scalar required value +// Experimental: MCPPlanRequiredValueScalarKind is part of an experimental API and may +// change or be removed. +type MCPPlanRequiredValueScalarKind string + +const ( + // The value uses one scalar type. + MCPPlanRequiredValueScalarKindScalar MCPPlanRequiredValueScalarKind = "scalar" +) + +// Scalar type a required value must conform to +// Experimental: MCPPlanScalarValueType is part of an experimental API and may change or be +// removed. +type MCPPlanScalarValueType string + +const ( + // A boolean. + MCPPlanScalarValueTypeBoolean MCPPlanScalarValueType = "boolean" + // A number. + MCPPlanScalarValueTypeNumber MCPPlanScalarValueType = "number" + // A filesystem path. + MCPPlanScalarValueTypePath MCPPlanScalarValueType = "path" + // Free text. + MCPPlanScalarValueTypeString MCPPlanScalarValueType = "string" +) + +// Configuration scope an MCP install plan targets +// Experimental: MCPPlanScope is part of an experimental API and may change or be removed. +type MCPPlanScope string + +const ( + // The user's own MCP configuration. + MCPPlanScopeUser MCPPlanScope = "user" +) + +// Transport discriminator for MCPPlanTransportChoice. +type MCPPlanTransportChoiceTransport string + +const ( + MCPPlanTransportChoiceTransportHTTP MCPPlanTransportChoiceTransport = "http" + MCPPlanTransportChoiceTransportSSE MCPPlanTransportChoiceTransport = "sse" + MCPPlanTransportChoiceTransportStdio MCPPlanTransportChoiceTransport = "stdio" + MCPPlanTransportChoiceTransportStreamableHTTP MCPPlanTransportChoiceTransport = "streamable-http" +) + +// Where a required value is applied when the planned server is launched +// Experimental: MCPPlanValueCategory is part of an experimental API and may change or be +// removed. +type MCPPlanValueCategory string + +const ( + // Set as an environment variable on the launched process. + MCPPlanValueCategoryEnvironmentVariable MCPPlanValueCategory = "environment-variable" + // Sent as a request header to a remote endpoint. + MCPPlanValueCategoryHeader MCPPlanValueCategory = "header" + // Passed to the packaged server itself. + MCPPlanValueCategoryPackageArgument MCPPlanValueCategory = "package-argument" + // Passed to the runtime that launches the package. + MCPPlanValueCategoryRuntimeArgument MCPPlanValueCategory = "runtime-argument" + // Substituted into the remote endpoint URL. + MCPPlanValueCategoryURLVariable MCPPlanValueCategory = "url-variable" +) + // 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. @@ -12015,6 +17284,46 @@ const ( MCPSamplingExecutionActionSuccess MCPSamplingExecutionAction = "success" ) +// Discriminator for an embedded MCP server card +// Experimental: MCPServerCardEmbeddedKind is part of an experimental API and may change or +// be removed. +type MCPServerCardEmbeddedKind string + +const ( + // Use the embedded card document. + MCPServerCardEmbeddedKindEmbedded MCPServerCardEmbeddedKind = "embedded" +) + +// JSON MCP card media type accepted for install planning +// Experimental: MCPServerCardMediaType is part of an experimental API and may change or be +// removed. +type MCPServerCardMediaType string + +const ( + // The current MCP server card media type. + MCPServerCardMediaTypeApplicationMCPServerCardJSON MCPServerCardMediaType = "application/mcp-server-card+json" + // The legacy MCP server card media type, accepted for compatibility. + MCPServerCardMediaTypeApplicationMCPServerJSON MCPServerCardMediaType = "application/mcp-server+json" +) + +// Kind discriminator for MCPServerCardReference. +type MCPServerCardReferenceKind string + +const ( + MCPServerCardReferenceKindEmbedded MCPServerCardReferenceKind = "embedded" + MCPServerCardReferenceKindURL MCPServerCardReferenceKind = "url" +) + +// Discriminator for a URL-backed MCP server card +// Experimental: MCPServerCardURLKind is part of an experimental API and may change or be +// removed. +type MCPServerCardURLKind string + +const ( + // Retrieve the card from its URL. + MCPServerCardURLKindURL MCPServerCardURLKind = "url" +) + // 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 @@ -12052,6 +17361,27 @@ const ( MCPServerConfigHTTPTypeSSE MCPServerConfigHTTPType = "sse" ) +// In-process MCP transport type. +// Experimental: MCPServerConfigMemoryType is part of an experimental API and may change or +// be removed. +type MCPServerConfigMemoryType string + +const ( + MCPServerConfigMemoryTypeMemory MCPServerConfigMemoryType = "memory" +) + +// Local MCP transport type. +// Experimental: MCPServerConfigStdioType is part of an experimental API and may change or +// be removed. +type MCPServerConfigStdioType string + +const ( + // Legacy alias for the local stdio transport. + MCPServerConfigStdioTypeLocal MCPServerConfigStdioType = "local" + // Server communicates over stdio with a local child process. + MCPServerConfigStdioTypeStdio MCPServerConfigStdioType = "stdio" +) + // Configuration source: user, workspace, plugin, or builtin // Experimental: MCPServerSource is part of an experimental API and may change or be removed. type MCPServerSource string @@ -12067,7 +17397,8 @@ const ( MCPServerSourceWorkspace MCPServerSource = "workspace" ) -// Connection status: connected, failed, needs-auth, pending, disabled, or not_configured +// 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 @@ -12084,6 +17415,10 @@ const ( 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 @@ -12141,6 +17476,38 @@ const ( MetadataSnapshotRemoteMetadataTaskTypeCLI MetadataSnapshotRemoteMetadataTaskType = "cli" ) +// Origin of an effective session model change. +// Experimental: ModelChangeSource is part of an experimental API and may change or be +// removed. +type ModelChangeSource string + +const ( + // Selecting an agent selected its configured model. + ModelChangeSourceAgent ModelChangeSource = "agent" + // The runtime selected the model automatically, such as rate-limit recovery or refusal + // fallback. + ModelChangeSourceAutomatic ModelChangeSource = "automatic" + // The user selected the model with the `/config` alias. + ModelChangeSourceConfigCommand ModelChangeSource = "config_command" + // Organization-managed settings selected the model. + ModelChangeSourceManagedSettings ModelChangeSource = "managed_settings" + // The user selected a model directly with `/model `. + ModelChangeSourceModelCommand ModelChangeSource = "model_command" + // The user selected the model in the model picker, including the picker opened by bare + // `/model`. + ModelChangeSourceModelPicker ModelChangeSource = "model_picker" + // Entering, leaving, or reconfiguring plan mode selected the model. + ModelChangeSourcePlanMode ModelChangeSource = "plan_mode" + // Repository settings selected the model. + ModelChangeSourceRepoSettings ModelChangeSource = "repo_settings" + // An SDK or RPC caller selected the model. + ModelChangeSourceSDK ModelChangeSource = "sdk" + // The user selected the model with `/settings`. + ModelChangeSourceSettingsCommand ModelChangeSource = "settings_command" + // Startup model resolution selected the model. + ModelChangeSourceStartup ModelChangeSource = "startup" +) + // Model capability category for grouping in the model picker // Experimental: ModelPickerCategory is part of an experimental API and may change or be // removed. @@ -12274,8 +17641,10 @@ type PermissionDecisionApproveForLocationApprovalKind string const ( PermissionDecisionApproveForLocationApprovalKindCommands PermissionDecisionApproveForLocationApprovalKind = "commands" PermissionDecisionApproveForLocationApprovalKindCustomTool PermissionDecisionApproveForLocationApprovalKind = "custom-tool" + PermissionDecisionApproveForLocationApprovalKindExtensionEnvAccess PermissionDecisionApproveForLocationApprovalKind = "extension-env-access" PermissionDecisionApproveForLocationApprovalKindExtensionManagement PermissionDecisionApproveForLocationApprovalKind = "extension-management" PermissionDecisionApproveForLocationApprovalKindExtensionPermissionAccess PermissionDecisionApproveForLocationApprovalKind = "extension-permission-access" + PermissionDecisionApproveForLocationApprovalKindFactory PermissionDecisionApproveForLocationApprovalKind = "factory" PermissionDecisionApproveForLocationApprovalKindMCP PermissionDecisionApproveForLocationApprovalKind = "mcp" PermissionDecisionApproveForLocationApprovalKindMCPSampling PermissionDecisionApproveForLocationApprovalKind = "mcp-sampling" PermissionDecisionApproveForLocationApprovalKindMemory PermissionDecisionApproveForLocationApprovalKind = "memory" @@ -12289,8 +17658,10 @@ type PermissionDecisionApproveForSessionApprovalKind string const ( PermissionDecisionApproveForSessionApprovalKindCommands PermissionDecisionApproveForSessionApprovalKind = "commands" PermissionDecisionApproveForSessionApprovalKindCustomTool PermissionDecisionApproveForSessionApprovalKind = "custom-tool" + PermissionDecisionApproveForSessionApprovalKindExtensionEnvAccess PermissionDecisionApproveForSessionApprovalKind = "extension-env-access" PermissionDecisionApproveForSessionApprovalKindExtensionManagement PermissionDecisionApproveForSessionApprovalKind = "extension-management" PermissionDecisionApproveForSessionApprovalKindExtensionPermissionAccess PermissionDecisionApproveForSessionApprovalKind = "extension-permission-access" + PermissionDecisionApproveForSessionApprovalKindFactory PermissionDecisionApproveForSessionApprovalKind = "factory" PermissionDecisionApproveForSessionApprovalKindMCP PermissionDecisionApproveForSessionApprovalKind = "mcp" PermissionDecisionApproveForSessionApprovalKindMCPSampling PermissionDecisionApproveForSessionApprovalKind = "mcp-sampling" PermissionDecisionApproveForSessionApprovalKindMemory PermissionDecisionApproveForSessionApprovalKind = "memory" @@ -12319,6 +17690,55 @@ const ( 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 response followed the assisted-approval judge recommendation. + PermissionDecisionSourceAssistedApproval PermissionDecisionSource = "assisted_approval" + // 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 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 ( + // An Agent Client Protocol host. + PermissionDecisionSurfaceAcp PermissionDecisionSurface = "acp" + // 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. @@ -12331,19 +17751,51 @@ const ( 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 +// Current or requested permission mode. +// Experimental: PermissionMode is part of an experimental API and may change or be removed. +type PermissionMode 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" + PermissionModeAllowAll PermissionMode = "allow-all" + // Permission requests include an LLM safety recommendation; clients may automatically + // approve requests judged acceptable. + PermissionModeAssisted PermissionMode = "assisted" + // Permission requests follow the normal approval flow. + PermissionModeManual PermissionMode = "manual" +) + +// Optional source for permission-mode telemetry. Defaults to `rpc` when omitted for SDK +// callers. +// Experimental: PermissionModeSource is part of an experimental API and may change or be +// removed. +type PermissionModeSource string + +const ( + // The mode was set by confirming autopilot behavior. + PermissionModeSourceAutopilotConfirmation PermissionModeSource = "autopilot_confirmation" + // The mode was set from a CLI command-line flag. + PermissionModeSourceCLIFlag PermissionModeSource = "cli_flag" + // The mode was set through an RPC caller. + PermissionModeSourceRPC PermissionModeSource = "rpc" + // The mode was set by a slash command. + PermissionModeSourceSlashCommand PermissionModeSource = "slash_command" + // The mode was set at startup by the `defaultPermissionMode` user setting. + PermissionModeSourceUserSetting PermissionModeSource = "user_setting" +) + +// Response capability available to the client when it settled a permission request. +// Experimental: PermissionResponseCapability is part of an experimental API and may change +// or be removed. +type PermissionResponseCapability string + +const ( + // The client could return an automated response but could not ask a user. + PermissionResponseCapabilityHeadless PermissionResponseCapability = "headless" + // The client could ask a user for this decision. + PermissionResponseCapabilityInteractive PermissionResponseCapability = "interactive" + // The client had no response path available. + PermissionResponseCapabilityNone PermissionResponseCapability = "none" ) // Allowed values for the `PermissionsConfigureAdditionalContentExclusionPolicyScope` @@ -12365,8 +17817,10 @@ type PermissionsLocationsAddToolApprovalDetailsKind string const ( PermissionsLocationsAddToolApprovalDetailsKindCommands PermissionsLocationsAddToolApprovalDetailsKind = "commands" PermissionsLocationsAddToolApprovalDetailsKindCustomTool PermissionsLocationsAddToolApprovalDetailsKind = "custom-tool" + PermissionsLocationsAddToolApprovalDetailsKindExtensionEnvAccess PermissionsLocationsAddToolApprovalDetailsKind = "extension-env-access" PermissionsLocationsAddToolApprovalDetailsKindExtensionManagement PermissionsLocationsAddToolApprovalDetailsKind = "extension-management" PermissionsLocationsAddToolApprovalDetailsKindExtensionPermissionAccess PermissionsLocationsAddToolApprovalDetailsKind = "extension-permission-access" + PermissionsLocationsAddToolApprovalDetailsKindFactory PermissionsLocationsAddToolApprovalDetailsKind = "factory" PermissionsLocationsAddToolApprovalDetailsKindMCP PermissionsLocationsAddToolApprovalDetailsKind = "mcp" PermissionsLocationsAddToolApprovalDetailsKindMCPSampling PermissionsLocationsAddToolApprovalDetailsKind = "mcp-sampling" PermissionsLocationsAddToolApprovalDetailsKindMemory PermissionsLocationsAddToolApprovalDetailsKind = "memory" @@ -12387,22 +17841,6 @@ const ( 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. @@ -12417,6 +17855,20 @@ const ( PermissionsSetApproveAllSourceRPC PermissionsSetApproveAllSource = "rpc" // Allow-all was enabled by a slash command. PermissionsSetApproveAllSourceSlashCommand PermissionsSetApproveAllSource = "slash_command" + // Allow-all was enabled at startup by the `defaultPermissionMode` user setting. + PermissionsSetApproveAllSourceUserSetting PermissionsSetApproveAllSource = "user_setting" +) + +// Controls whether the runtime may defer loading an external tool definition. +// Experimental: ProtocolExternalToolDefer is part of an experimental API and may change or +// be removed. +type ProtocolExternalToolDefer string + +const ( + // The runtime may defer the tool according to its tool-loading policy. + ProtocolExternalToolDeferAuto ProtocolExternalToolDefer = "auto" + // The runtime must include the tool without deferring it. + ProtocolExternalToolDeferNever ProtocolExternalToolDefer = "never" ) // Provider transport. Defaults to "http". @@ -12566,6 +18018,26 @@ const ( RemoteControlStatusStateOff RemoteControlStatusState = "off" ) +// What a remote host says one of its sessions is doing right now. Deliberately coarse: this +// is what a host can report for EVERY session in a catalogue listing, without a client +// subscribing to each one. AHP's `SessionSummary.status` is the source today; +// `input-needed` covers both a permission prompt and an `ask_user` question, since the +// summary does not say which. +// Experimental: RemoteSessionHostStatus is part of an experimental API and may change or be +// removed. +type RemoteSessionHostStatus string + +const ( + // The session ended its last turn in an error. + RemoteSessionHostStatusError RemoteSessionHostStatus = "error" + // No turn is running. + RemoteSessionHostStatusIdle RemoteSessionHostStatus = "idle" + // The session is blocked on the user: a permission prompt or an `ask_user` question. + RemoteSessionHostStatusInputNeeded RemoteSessionHostStatus = "input-needed" + // A turn is running. + RemoteSessionHostStatusWorking RemoteSessionHostStatus = "working" +) + // Whether the remote task originated from CCA or CLI `--remote`. // Experimental: RemoteSessionMetadataTaskType is part of an experimental API and may change // or be removed. @@ -12593,6 +18065,28 @@ const ( RemoteSessionModeOn RemoteSessionMode = "on" ) +// Origin of the sandbox choice supplied by an internal client. +// Experimental: SandboxConfigSource is part of an experimental API and may change or be +// removed. +type SandboxConfigSource string + +const ( + // The client applied the default because no sandbox preference was configured. + SandboxConfigSourceNeverConfigured SandboxConfigSource = "never_configured" + // A repository policy selected the sandbox state. + SandboxConfigSourceRepositoryPolicy SandboxConfigSource = "repository_policy" + // The user disabled the sandbox for the current session. + SandboxConfigSourceSessionDisabled SandboxConfigSource = "session_disabled" + // A command-line flag selected the sandbox state for this session. + SandboxConfigSourceSessionFlag SandboxConfigSource = "session_flag" + // The client disabled the sandbox because the host cannot enforce it. + SandboxConfigSourceUnsupportedHost SandboxConfigSource = "unsupported_host" + // The user's persisted settings disabled the sandbox. + SandboxConfigSourceUserDisabled SandboxConfigSource = "user_disabled" + // The user's persisted settings enabled the sandbox. + SandboxConfigSourceUserEnabled SandboxConfigSource = "user_enabled" +) + // 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. @@ -12714,6 +18208,35 @@ const ( 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 @@ -12735,6 +18258,69 @@ 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. @@ -12962,6 +18548,45 @@ const ( SessionWorkingDirectoryContextHostTypeGitHub SessionWorkingDirectoryContextHostType = "github" ) +// Type discriminator for SettableAuthInfo. +type SettableAuthInfoType string + +const ( + SettableAuthInfoTypeAPIKey SettableAuthInfoType = "api-key" + SettableAuthInfoTypeCopilotAPIToken SettableAuthInfoType = "copilot-api-token" + SettableAuthInfoTypeEnv SettableAuthInfoType = "env" + SettableAuthInfoTypeGhCLI SettableAuthInfoType = "gh-cli" + SettableAuthInfoTypeHMAC SettableAuthInfoType = "hmac" + SettableAuthInfoTypeToken SettableAuthInfoType = "token" + SettableAuthInfoTypeUser SettableAuthInfoType = "user" +) + +// 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 @@ -13037,9 +18662,13 @@ const ( type SlashCommandInvocationResultKind string const ( + SlashCommandInvocationResultKindAddTimelineEntry SlashCommandInvocationResultKind = "add-timeline-entry" SlashCommandInvocationResultKindAgentPrompt SlashCommandInvocationResultKind = "agent-prompt" SlashCommandInvocationResultKindCompleted SlashCommandInvocationResultKind = "completed" SlashCommandInvocationResultKindSelectSubcommand SlashCommandInvocationResultKind = "select-subcommand" + SlashCommandInvocationResultKindSetModel SlashCommandInvocationResultKind = "set-model" + SlashCommandInvocationResultKindSetPlanModel SlashCommandInvocationResultKind = "set-plan-model" + SlashCommandInvocationResultKindShowDialog SlashCommandInvocationResultKind = "show-dialog" SlashCommandInvocationResultKindText SlashCommandInvocationResultKind = "text" ) @@ -13058,6 +18687,13 @@ const ( SlashCommandKindSkill SlashCommandKind = "skill" ) +// Discriminator for a model-picker dialog. +type SlashCommandModelPickerDialogKind string + +const ( + SlashCommandModelPickerDialogKindModelPicker SlashCommandModelPickerDialogKind = "model-picker" +) + // Context tier override for matching subagents // Experimental: SubagentSettingsEntryContextTier is part of an experimental API and may // change or be removed. @@ -13072,6 +18708,21 @@ const ( SubagentSettingsEntryContextTierLongContext SubagentSettingsEntryContextTier = "long_context" ) +// Semantic result of evaluating a task completion request +// Experimental: TaskCompletionOutcome is part of an experimental API and may change or be +// removed. +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" +) + // 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. @@ -13130,6 +18781,23 @@ const ( TaskStatusRunning TaskStatus = "running" ) +// Execution outcome classification. +// Experimental: ToolResultType is part of an experimental API and may change or be removed. +type ToolResultType string + +const ( + // Permission policy denied the tool request. + ToolResultTypeDenied ToolResultType = "denied" + // The tool failed. + ToolResultTypeFailure ToolResultType = "failure" + // The tool request was rejected before execution. + ToolResultTypeRejected ToolResultType = "rejected" + // The tool completed successfully. + ToolResultTypeSuccess ToolResultType = "success" + // The tool exceeded its execution timeout. + ToolResultTypeTimeout ToolResultType = "timeout" +) + // 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 @@ -13251,8 +18919,10 @@ type UserToolSessionApprovalKind string const ( UserToolSessionApprovalKindCommands UserToolSessionApprovalKind = "commands" UserToolSessionApprovalKindCustomTool UserToolSessionApprovalKind = "custom-tool" + UserToolSessionApprovalKindExtensionEnvAccess UserToolSessionApprovalKind = "extension-env-access" UserToolSessionApprovalKindExtensionManagement UserToolSessionApprovalKind = "extension-management" UserToolSessionApprovalKindExtensionPermissionAccess UserToolSessionApprovalKind = "extension-permission-access" + UserToolSessionApprovalKindFactory UserToolSessionApprovalKind = "factory" UserToolSessionApprovalKindMCP UserToolSessionApprovalKind = "mcp" UserToolSessionApprovalKindMemory UserToolSessionApprovalKind = "memory" UserToolSessionApprovalKindRead UserToolSessionApprovalKind = "read" @@ -13369,12 +19039,12 @@ func (a *ServerAccountAPI) GetCurrentAuth(ctx context.Context) (*AccountGetCurre return &result, nil } -// GetQuota gets Copilot quota usage for the authenticated user or supplied GitHub token. +// GetQuota gets Copilot quota usage for the current or opaquely selected authenticated user. // // RPC method: account.getQuota. // -// Parameters: Optional GitHub token used to look up quota for a specific user instead of -// the global auth context. +// Parameters: Optional opaque account selection or compatibility GitHub token used to look +// up quota. // // Returns: Quota usage snapshots for the resolved user, keyed by quota type. func (a *ServerAccountAPI) GetQuota(ctx context.Context, params *AccountGetQuotaRequest) (*AccountGetQuotaResult, error) { @@ -13389,11 +19059,13 @@ func (a *ServerAccountAPI) GetQuota(ctx context.Context, params *AccountGetQuota return &result, nil } -// Login stores authentication credentials after successful login (e.g., device code flow). +// Login validates and stores authentication credentials. When login is omitted, resolves +// the authenticated user from the token before persistence. // // RPC method: account.login. // -// Parameters: Credentials to store after successful authentication +// Parameters: Credentials to validate and store. Omit login to resolve the authenticated +// user from the token. // // Returns: Result of a successful login; throws on failure func (a *ServerAccountAPI) Login(ctx context.Context, params *AccountLoginRequest) (*AccountLoginResult, error) { @@ -13498,7 +19170,39 @@ func (a *ServerAgentsAPI) GetDiscoveryPaths(ctx context.Context, params *AgentsG return &result, nil } -// Experimental: ServerCommandsAPI contains experimental APIs that may change or be removed. +// Experimental: ServerCatalogAPI contains experimental APIs that may change or be removed. +type ServerCatalogAPI serverAPI + +// Search requests a bounded catalog search. This host-implemented server method is +// available through SDK/TUI hosts; standalone and C-ABI runtimes whose host does not +// implement server-method dispatch return JSON-RPC MethodNotFound. A runtime with search +// available returns inert candidate summaries, each with an opaque single-use handle scoped +// to this runtime instance; a runtime without it returns the typed search-unavailable +// result. Public authorities may be searched anonymously, while an authority that requires +// credentials yields the typed authentication-required result. All returned text, URLs, and +// package metadata are untrusted external data and can never trigger instructions, tools, +// or installation. Read-only: nothing is installed, configured, or persisted. +// +// RPC method: catalog.search. +// +// Parameters: A bounded catalog search. Both the query length and the result count are +// capped by the schema so a caller cannot request an unbounded scan. +// +// Returns: Outcome of a catalog.search call: either bounded inert candidates, or one typed +// refusal. Never a partial success. +func (a *ServerCatalogAPI) Search(ctx context.Context, params *CatalogSearchRequest) (CatalogSearchResult, error) { + raw, err := a.client.Request(ctx, "catalog.search", params) + if err != nil { + return nil, err + } + result, err := unmarshalCatalogSearchResult(raw) + if 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 @@ -13521,6 +19225,67 @@ func (a *ServerCommandsAPI) List(ctx context.Context) (*CommandList, error) { 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 @@ -13632,6 +19397,29 @@ func (a *ServerLlmInferenceAPI) SetProvider(ctx context.Context) (*LlmInferenceS 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 @@ -13654,6 +19442,36 @@ func (a *ServerMCPAPI) Discover(ctx context.Context, params *MCPDiscoverRequest) return &result, nil } +// PlanInstall requests a side-effect-free MCP install plan from a catalog candidate handle +// or a caller-supplied card. This host-implemented server method is available through +// SDK/TUI hosts; standalone and C-ABI runtimes whose host does not implement server-method +// dispatch return JSON-RPC MethodNotFound. A runtime with planning available returns a +// normalised plan and opaque single-use plan handle; a runtime without it returns the typed +// planning-unavailable result. A completed plan reports resource identity, provenance, +// eligible transport choices, the user-scope target, required typed values and secret +// placeholders, the policy result, the configuration changes installing would make, and +// whether a reload would be needed. Planning never writes configuration, stores a secret, +// or reloads MCP servers, so abandoning a plan needs no call and leaves nothing behind. +// +// RPC method: mcp.planInstall. +// +// Parameters: A side-effect-free request for an MCP install plan. Computing a plan never +// writes configuration, stores a secret, or reloads MCP servers. +// +// Returns: Outcome of an mcp.planInstall call: either a normalised plan, or one typed +// refusal. Nothing is written in either case. +func (a *ServerMCPAPI) PlanInstall(ctx context.Context, params *MCPPlanInstallRequest) (MCPPlanInstallResult, error) { + raw, err := a.client.Request(ctx, "mcp.planInstall", params) + if err != nil { + return nil, err + } + result, err := unmarshalMCPPlanInstallResult(raw) + if err != nil { + return nil, err + } + return result, nil +} + // Experimental: ServerMCPConfigAPI contains experimental APIs that may change or be removed. type ServerMCPConfigAPI serverAPI @@ -13783,12 +19601,31 @@ func (s *ServerMCPAPI) Config() *ServerMCPConfigAPI { // 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. +// Parameters: Optional opaque account selection or compatibility GitHub token used to list +// models. // // Returns: List of Copilot models available to the resolved user, including capabilities // and billing metadata. @@ -13930,6 +19767,33 @@ func (a *ServerPluginsAPI) UpdateAll(ctx context.Context) (*PluginUpdateAllResul return &result, nil } +// Experimental: ServerPluginsBuiltinAPI contains experimental APIs that may change or be +// removed. +type ServerPluginsBuiltinAPI serverAPI + +// Set replaces this server's trusted built-in plugin directories while no sessions are +// active. +// +// RPC method: plugins.builtin.set. +// +// Parameters: Trusted built-in plugin directories to use for this runtime process. +func (a *ServerPluginsBuiltinAPI) Set(ctx context.Context, params *PluginsBuiltinSetRequest) (*PluginsBuiltinSetResult, error) { + raw, err := a.client.Request(ctx, "plugins.builtin.set", params) + if err != nil { + return nil, err + } + var result PluginsBuiltinSetResult + if err := json.Unmarshal(raw, &result); err != nil { + return nil, err + } + return &result, nil +} + +// Experimental: Builtin returns experimental APIs that may change or be removed. +func (s *ServerPluginsAPI) Builtin() *ServerPluginsBuiltinAPI { + return (*ServerPluginsBuiltinAPI)(s) +} + // Experimental: ServerPluginsMarketplacesAPI contains experimental APIs that may change or // be removed. type ServerPluginsMarketplacesAPI serverAPI @@ -14647,6 +20511,24 @@ func (a *ServerSkillsConfigAPI) SetDisabledSkills(ctx context.Context, params *S return &result, nil } +// SetSkillDisabled atomically adds or removes one skill from the disabled list. +// +// RPC method: skills.config.setSkillDisabled. +// +// Parameters: Adds or removes a single skill from the global disabled list, leaving every +// other entry untouched. +func (a *ServerSkillsConfigAPI) SetSkillDisabled(ctx context.Context, params *SkillsConfigSetSkillDisabledRequest) (*SkillsConfigSetSkillDisabledResult, error) { + raw, err := a.client.Request(ctx, "skills.config.setSkillDisabled", params) + if err != nil { + return nil, err + } + var result SkillsConfigSetSkillDisabledResult + 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) @@ -14755,22 +20637,25 @@ 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 - Instructions *ServerInstructionsAPI - LlmInference *ServerLlmInferenceAPI - MCP *ServerMCPAPI - Models *ServerModelsAPI - Plugins *ServerPluginsAPI - Runtime *ServerRuntimeAPI - Secrets *ServerSecretsAPI - SessionFS *ServerSessionFSAPI - Sessions *ServerSessionsAPI - Skills *ServerSkillsAPI - Tools *ServerToolsAPI - User *ServerUserAPI + Account *ServerAccountAPI + AgentRegistry *ServerAgentRegistryAPI + Agents *ServerAgentsAPI + Catalog *ServerCatalogAPI + 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. @@ -14794,15 +20679,37 @@ func (a *ServerRPC) Ping(ctx context.Context, params *PingRequest) (*PingResult, 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.Catalog = (*ServerCatalogAPI)(&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) @@ -14849,6 +20756,26 @@ func (a *InternalServerSessionsAPI) ConfigureSessionExtensions(ctx context.Conte 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 @@ -14900,6 +20827,27 @@ func (a *InternalServerSessionsAPI) GetEventFilePath(ctx context.Context, params 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 @@ -14926,6 +20874,28 @@ func (a *InternalServerSessionsAPI) GetPersistedRemoteSteerable(ctx context.Cont 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 @@ -14971,8 +20941,8 @@ type InternalServerRPC struct { // // 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). +// Parameters: Connection-level opt-ins for the `server.connect` handshake. Transport +// authentication is consumed by the native protocol boundary before dispatch. // // Returns: Handshake result reporting the server's protocol version and package version on // success. @@ -15041,13 +21011,28 @@ func (a *AgentAPI) GetCurrent(ctx context.Context) (*AgentGetCurrentResult, erro return &result, nil } -// 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. // // RPC method: session.agent.list. // -// Returns: Custom agents available to the session. -func (a *AgentAPI) List(ctx context.Context) (*AgentList, error) { +// 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 @@ -15100,6 +21085,32 @@ func (a *AgentAPI) Select(ctx context.Context, params *AgentSelectRequest) (*Age 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 @@ -15316,6 +21327,9 @@ func (a *CommandsAPI) Invoke(ctx context.Context, params *CommandsInvokeRequest) req["input"] = *params.Input } req["name"] = params.Name + if params.Origin != nil { + req["origin"] = *params.Origin + } } raw, err := a.client.Request(ctx, "session.commands.invoke", req) if err != nil { @@ -15336,8 +21350,8 @@ func (a *CommandsAPI) Invoke(ctx context.Context, params *CommandsInvokeRequest) // // 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 +func (a *CommandsAPI) List(ctx context.Context, params ...*SessionCommandsListRequest) (*CommandList, error) { + var requestParams *SessionCommandsListRequest if len(params) > 0 { requestParams = params[0] } @@ -15441,6 +21455,38 @@ func (a *CompletionsAPI) Request(ctx context.Context, params *CompletionsRequest 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 @@ -15480,6 +21526,7 @@ func (a *DebugAPI) CollectLogs(ctx context.Context, params *DebugCollectLogsRequ 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. // @@ -15491,12 +21538,21 @@ type EventLogAPI sessionAPI 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 } @@ -15703,6 +21759,7 @@ type FactoryAPI sessionAPI 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 @@ -15764,94 +21821,218 @@ func (a *FactoryAPI) GetRun(ctx context.Context, params *FactoryGetRunRequest) ( return &result, nil } -// Log records a batch of ordered factory progress lines. +// GetRunDetail gets durable and live observability detail for one factory run. // -// RPC method: session.factory.log. +// RPC method: session.factory.getRunDetail. // -// Parameters: Parameters for recording factory progress. +// Parameters: Parameters for retrieving a factory run. // -// Returns: Acknowledgement that a factory request was accepted. -func (a *FactoryAPI) Log(ctx context.Context, params *FactoryLogRequest) (*FactoryAckResult, error) { +// 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["lines"] = params.Lines req["runId"] = params.RunID } - raw, err := a.client.Request(ctx, "session.factory.log", req) + raw, err := a.client.Request(ctx, "session.factory.getRunDetail", req) if err != nil { return nil, err } - var result FactoryAckResult + var result FactoryRunDetail if err := json.Unmarshal(raw, &result); err != nil { return nil, err } return &result, nil } -// Runs a registered factory by name at the top level. +// GetRunProgress pages durable progress for one factory run. // -// RPC method: session.factory.run. +// RPC method: session.factory.getRunProgress. // -// Parameters: Parameters for invoking a registered factory. +// Parameters: Parameters for paging factory progress. // -// Returns: Complete current or terminal factory run envelope. -func (a *FactoryAPI) Run(ctx context.Context, params *FactoryRunRequest) (*FactoryRunResult, error) { +// 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 { - req["args"] = params.Args - req["name"] = params.Name - if params.Options != nil { - req["options"] = *params.Options + 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.run", req) + raw, err := a.client.Request(ctx, "session.factory.getRunProgress", req) if err != nil { return nil, err } - var result FactoryRunResult + var result FactoryProgressPage if err := json.Unmarshal(raw, &result); err != nil { return nil, err } return &result, nil } -// Experimental: FactoryJournalAPI contains experimental APIs that may change or be removed. -type FactoryJournalAPI sessionAPI - -// Get reads a memoized factory journal entry. +// ListRuns lists durable factory runs for this session in creation order. // -// RPC method: session.factory.journal.get. +// RPC method: session.factory.listRuns. // -// Parameters: Parameters for reading a factory journal entry. +// Parameters: Parameters for paging factory runs. // -// Returns: Result of reading a factory journal entry. -func (a *FactoryJournalAPI) Get(ctx context.Context, params *FactoryJournalGetRequest) (*FactoryJournalGetResult, error) { +// 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 { - req["key"] = params.Key - req["runId"] = params.RunID + 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.journal.get", req) + raw, err := a.client.Request(ctx, "session.factory.listRuns", req) if err != nil { return nil, err } - var result FactoryJournalGetResult + var result FactoryListRunsResult if err := json.Unmarshal(raw, &result); err != nil { return nil, err } return &result, nil } -// Put stores a memoized factory journal entry. +// Log records a batch of ordered factory progress lines. // -// RPC method: session.factory.journal.put. +// RPC method: session.factory.log. // -// Parameters: Parameters for storing a factory journal entry. +// 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 + } + if params.LogPhaseNames != nil { + req["logPhaseNames"] = *params.LogPhaseNames + } + if params.NotifyOnComplete != nil { + req["notifyOnComplete"] = *params.NotifyOnComplete + } + 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 +} + +// 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 +} + +// Experimental: FactoryJournalAPI contains experimental APIs that may change or be removed. +type FactoryJournalAPI sessionAPI + +// 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 +} + +// 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 @@ -15988,6 +22169,34 @@ func (a *HistoryAPI) CancelBackgroundCompaction(ctx context.Context) (*HistoryCa return &result, nil } +// 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 +} + // Compacts the session history to reduce context usage. // // RPC method: session.history.compact. @@ -15996,8 +22205,8 @@ func (a *HistoryAPI) CancelBackgroundCompaction(ctx context.Context) (*HistoryCa // // 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 +func (a *HistoryAPI) Compact(ctx context.Context, params ...*SessionHistoryCompactRequest) (*HistoryCompactResult, error) { + var requestParams *SessionHistoryCompactRequest if len(params) > 0 { requestParams = params[0] } @@ -16006,6 +22215,12 @@ func (a *HistoryAPI) Compact(ctx context.Context, params ...*HistoryCompactReque 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 { @@ -16018,6 +22233,84 @@ func (a *HistoryAPI) Compact(ctx context.Context, params ...*HistoryCompactReque return &result, nil } +// 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 +} + +// 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 +} + +// 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 +} + // SummarizeForHandoff produces a markdown summary of the session's conversation context for // hand-off scenarios. // @@ -16082,6 +22375,44 @@ func (a *InstructionsAPI) GetSources(ctx context.Context) (*InstructionsGetSourc return &result, nil } +// Experimental: LimitPredictionAPI contains experimental APIs that may change or be removed. +type LimitPredictionAPI sessionAPI + +// 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: session.limitPrediction.predict. +// +// Parameters: 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. +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 := unmarshalSessionLimitPredictionResult(raw) + if err != nil { + return nil, err + } + return result, nil +} + // Experimental: LspAPI contains experimental APIs that may change or be removed. type LspAPI sessionAPI @@ -16283,6 +22614,26 @@ func (a *MCPAPI) ListTools(ctx context.Context, params *MCPListToolsRequest) (*M return &result, nil } +// MoveLoadingToBackground releases any turns waiting on an in-flight MCP load without +// cancelling the load, letting the agent proceed while MCP servers finish connecting in the +// background. No-op when no MCP load is in flight or waiting turns were already released. +// +// RPC method: session.mcp.moveLoadingToBackground. +// +// Returns: Result of moving in-flight MCP loading to the background. +func (a *MCPAPI) MoveLoadingToBackground(ctx context.Context) (*MoveMCPLoadingToBackgroundResult, error) { + req := map[string]any{"sessionId": a.sessionID} + raw, err := a.client.Request(ctx, "session.mcp.moveLoadingToBackground", req) + if err != nil { + return nil, err + } + var result MoveMCPLoadingToBackgroundResult + if err := json.Unmarshal(raw, &result); err != nil { + return nil, err + } + return &result, nil +} + // Reloads MCP server connections for the session. // // RPC method: session.mcp.reload. @@ -16372,20 +22723,25 @@ func (a *MCPAPI) SetEnvValueMode(ctx context.Context, params *MCPSetEnvValueMode return &result, nil } -// StartServer starts an individual MCP server on the live session from a caller-supplied -// config. 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` / +// 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: session.mcp.startServer. // -// Parameters: Server name and configuration for an individual MCP server start. +// 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 { - req["config"] = params.Config + if params.Config != nil { + req["config"] = params.Config + } req["serverName"] = params.ServerName } raw, err := a.client.Request(ctx, "session.mcp.startServer", req) @@ -16611,6 +22967,33 @@ func (s *MCPAPI) Headers() *MCPHeadersAPI { // 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. +// +// RPC method: session.mcp.oauth.authenticationStateChanged. +// +// 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 SessionMCPOauthAuthenticationStateChangedResult + if err := json.Unmarshal(raw, &result); err != nil { + return nil, err + } + return &result, nil +} + // 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. @@ -16683,6 +23066,58 @@ func (a *MCPOauthAPI) Login(ctx context.Context, params *MCPOauthLoginRequest) ( return &result, nil } +// Probe passively probes a configured remote MCP server to classify whether OAuth is +// required or a cached/override token is accepted. Does not start OAuth, emit pending OAuth +// requests, or mutate MCP connection state. +// +// RPC method: session.mcp.oauth.probe. +// +// Parameters: Remote MCP server name for a passive OAuth status probe. +// +// Returns: Passive MCP OAuth probe result. `authenticated` means the server accepted the +// probe request while an OAuth-origin access token was attached; it does not prove the +// server required or independently validated that token. The probe does not make a second +// unauthenticated request. Failed is an expected probe-domain outcome; JSON-RPC errors are +// reserved for API-call failures. +func (a *MCPOauthAPI) Probe(ctx context.Context, params *MCPOauthProbeRequest) (MCPOauthProbeResult, error) { + req := map[string]any{"sessionId": a.sessionID} + if params != nil { + req["serverName"] = params.ServerName + } + raw, err := a.client.Request(ctx, "session.mcp.oauth.probe", req) + if err != nil { + return nil, err + } + result, err := unmarshalMCPOauthProbeResult(raw) + if err != nil { + return nil, err + } + return result, nil +} + +// Responds to a pending MCP OAuth authorization request by its request id. +// +// RPC method: session.mcp.oauth.respond. +// +// Parameters: Pending MCP OAuth request id to respond to. +// +// 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 MCPOauthRespondResult + 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) @@ -17039,16 +23474,49 @@ func (a *ModeAPI) Get(ctx context.Context) (*SessionMode, error) { // RPC method: session.mode.set. // // Parameters: Agent interaction mode to apply to the session. -func (a *ModeAPI) Set(ctx context.Context, params *ModeSetRequest) (*SessionModeSetResult, error) { +// +// Returns: Outcome of a session mode change, including any model switch it triggered and +// follow-up the host must perform. +func (a *ModeAPI) Set(ctx context.Context, params *ModeSetRequest) (*ModeSetResult, error) { req := map[string]any{"sessionId": a.sessionID} if params != nil { + if params.CompactionDecision != nil { + req["compactionDecision"] = *params.CompactionDecision + } + if params.InheritPlanBaseFromSessionID != nil { + req["inheritPlanBaseFromSessionId"] = *params.InheritPlanBaseFromSessionID + } req["mode"] = params.Mode - } - raw, err := a.client.Request(ctx, "session.mode.set", req) - if err != nil { - return nil, err - } - var result SessionModeSetResult + if params.PersistPlanSelection != nil { + req["persistPlanSelection"] = *params.PersistPlanSelection + } + if params.PickerSettingsContext != nil { + req["pickerSettingsContext"] = *params.PickerSettingsContext + } + if params.PlanContextTier != nil { + req["planContextTier"] = *params.PlanContextTier + } + if params.PlanExitAction != nil { + req["planExitAction"] = *params.PlanExitAction + } + if params.PlanModel != nil { + req["planModel"] = *params.PlanModel + } + if params.PlanModelConfigured != nil { + req["planModelConfigured"] = *params.PlanModelConfigured + } + if params.PlanReasoningEffort != nil { + req["planReasoningEffort"] = *params.PlanReasoningEffort + } + if params.RestorePlanModel != nil { + req["restorePlanModel"] = *params.RestorePlanModel + } + } + raw, err := a.client.Request(ctx, "session.mode.set", req) + if err != nil { + return nil, err + } + var result ModeSetResult if err := json.Unmarshal(raw, &result); err != nil { return nil, err } @@ -17087,8 +23555,8 @@ func (a *ModelAPI) GetCurrent(ctx context.Context) (*CurrentModel, error) { // Parameters: Optional listing options. // // Returns: The list of models available to this session. -func (a *ModelAPI) List(ctx context.Context, params ...*ModelListRequest) (*SessionModelList, error) { - var requestParams *ModelListRequest +func (a *ModelAPI) List(ctx context.Context, params ...*SessionModelListRequest) (*SessionModelList, error) { + var requestParams *SessionModelListRequest if len(params) > 0 { requestParams = params[0] } @@ -17146,19 +23614,43 @@ func (a *ModelAPI) SetReasoningEffort(ctx context.Context, params *ModelSetReaso func (a *ModelAPI) SwitchTo(ctx context.Context, params *ModelSwitchToRequest) (*ModelSwitchToResult, error) { req := map[string]any{"sessionId": a.sessionID} if params != nil { + if params.CompactionDecision != nil { + req["compactionDecision"] = *params.CompactionDecision + } if params.ContextTier != nil { req["contextTier"] = *params.ContextTier } + if params.DeferIfModelChangeQueued != nil { + req["deferIfModelChangeQueued"] = *params.DeferIfModelChangeQueued + } if params.ModelCapabilities != nil { req["modelCapabilities"] = *params.ModelCapabilities } + if params.ModelChangeScope != nil { + req["modelChangeScope"] = *params.ModelChangeScope + } req["modelId"] = params.ModelID + if params.PickerPersistence != nil { + req["pickerPersistence"] = *params.PickerPersistence + } if params.ReasoningEffort != nil { req["reasoningEffort"] = *params.ReasoningEffort } if params.ReasoningSummary != nil { req["reasoningSummary"] = *params.ReasoningSummary } + if params.RepoScope != nil { + req["repoScope"] = *params.RepoScope + } + if params.RequireAvailable != nil { + req["requireAvailable"] = *params.RequireAvailable + } + if params.RunCompactionPreflight != nil { + req["runCompactionPreflight"] = *params.RunCompactionPreflight + } + if params.Source != nil { + req["source"] = *params.Source + } if params.Verbosity != nil { req["verbosity"] = *params.Verbosity } @@ -17326,6 +23818,9 @@ func (a *OptionsAPI) Update(ctx context.Context, params *SessionUpdateOptionsPar if params.EventsLogDirectory != nil { req["eventsLogDirectory"] = *params.EventsLogDirectory } + if params.EventsLogIncludesSubagents != nil { + req["eventsLogIncludesSubagents"] = *params.EventsLogIncludesSubagents + } if params.ExcludedBuiltinAgents != nil { req["excludedBuiltinAgents"] = params.ExcludedBuiltinAgents } @@ -17338,6 +23833,9 @@ func (a *OptionsAPI) Update(ctx context.Context, params *SessionUpdateOptionsPar if params.IncludedBuiltinAgents != nil { req["includedBuiltinAgents"] = params.IncludedBuiltinAgents } + if params.IncludedBuiltinSkills != nil { + req["includedBuiltinSkills"] = params.IncludedBuiltinSkills + } if params.InstalledPlugins != nil { req["installedPlugins"] = params.InstalledPlugins } @@ -17383,12 +23881,18 @@ func (a *OptionsAPI) Update(ctx context.Context, params *SessionUpdateOptionsPar if params.SandboxConfig != nil { req["sandboxConfig"] = *params.SandboxConfig } + if params.SandboxConfigSource != nil { + req["sandboxConfigSource"] = *params.SandboxConfigSource + } 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 } @@ -17476,18 +23980,18 @@ func (a *PermissionsAPI) Configure(ctx context.Context, params *PermissionsConfi return &result, nil } -// GetAllowAll returns the current allow-all permission mode for the session. +// GetMode returns the current permission mode for the session. // -// RPC method: session.permissions.getAllowAll. +// RPC method: session.permissions.getMode. // -// Returns: Current allow-all permission mode. -func (a *PermissionsAPI) GetAllowAll(ctx context.Context) (*AllowAllPermissionState, error) { +// Returns: Current permission mode. +func (a *PermissionsAPI) GetMode(ctx context.Context) (*PermissionsGetModeResult, error) { req := map[string]any{"sessionId": a.sessionID} - raw, err := a.client.Request(ctx, "session.permissions.getAllowAll", req) + raw, err := a.client.Request(ctx, "session.permissions.getMode", req) if err != nil { return nil, err } - var result AllowAllPermissionState + var result PermissionsGetModeResult if err := json.Unmarshal(raw, &result); err != nil { return nil, err } @@ -17506,6 +24010,9 @@ func (a *PermissionsAPI) GetAllowAll(ctx context.Context) (*AllowAllPermissionSt func (a *PermissionsAPI) HandlePendingPermissionRequest(ctx context.Context, params *PermissionDecisionRequest) (*PermissionRequestResult, error) { req := map[string]any{"sessionId": a.sessionID} if params != nil { + if params.DecisionContext != nil { + req["decisionContext"] = *params.DecisionContext + } req["requestId"] = params.RequestID req["result"] = params.Result } @@ -17601,9 +24108,17 @@ func (a *PermissionsAPI) PendingRequests(ctx context.Context) (*PendingPermissio // // RPC method: session.permissions.resetSessionApprovals. // +// Parameters: Clears session-scoped tool permission approvals, and optionally the +// location-scoped ones. +// // Returns: Indicates whether the operation succeeded. -func (a *PermissionsAPI) ResetSessionApprovals(ctx context.Context) (*PermissionsResetSessionApprovalsResult, error) { +func (a *PermissionsAPI) ResetSessionApprovals(ctx context.Context, params *PermissionsResetSessionApprovalsRequest) (*PermissionsResetSessionApprovalsResult, error) { req := map[string]any{"sessionId": a.sessionID} + if params != nil { + if params.IncludeLocation != nil { + req["includeLocation"] = *params.IncludeLocation + } + } raw, err := a.client.Request(ctx, "session.permissions.resetSessionApprovals", req) if err != nil { return nil, err @@ -17615,68 +24130,62 @@ func (a *PermissionsAPI) ResetSessionApprovals(ctx context.Context) (*Permission return &result, nil } -// 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. +// SetApproveAll enables or disables automatic approval of tool permission requests for the +// session. // -// RPC method: session.permissions.setAllowAll. +// RPC method: session.permissions.setApproveAll. // -// Parameters: Allow-all mode to apply for the session. +// Parameters: Allow-all toggle for tool permission requests, with an optional telemetry +// source. // -// 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 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.Enabled != nil { - req["enabled"] = *params.Enabled - } - if params.Mode != nil { - req["mode"] = *params.Mode - } - if params.Model != nil { - req["model"] = *params.Model - } + req["enabled"] = params.Enabled if params.Source != nil { req["source"] = *params.Source } } - raw, err := a.client.Request(ctx, "session.permissions.setAllowAll", req) + raw, err := a.client.Request(ctx, "session.permissions.setApproveAll", req) if err != nil { return nil, err } - var result AllowAllPermissionSetResult + var result PermissionsSetApproveAllResult 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. +// SetMode sets the permission mode for the session. `manual` follows the normal approval +// flow, `assisted` attaches LLM safety recommendations, and `allow-all` automatically +// approves permission requests. The result returns the authoritative post-mutation mode so +// callers can update local state without racing the `session.permissions_changed` +// notification. // -// RPC method: session.permissions.setApproveAll. +// RPC method: session.permissions.setMode. // -// Parameters: Allow-all toggle for tool permission requests, with an optional telemetry -// source. +// Parameters: Permission mode to apply for the session. // -// Returns: Indicates whether the operation succeeded. -func (a *PermissionsAPI) SetApproveAll(ctx context.Context, params *PermissionsSetApproveAllRequest) (*PermissionsSetApproveAllResult, error) { +// Returns: Indicates whether the requested permission mode was applied and reports the +// authoritative post-mutation mode. +func (a *PermissionsAPI) SetMode(ctx context.Context, params *PermissionsSetModeRequest) (*PermissionsSetModeResult, error) { req := map[string]any{"sessionId": a.sessionID} if params != nil { - req["enabled"] = params.Enabled + if params.AssistedApprovalModel != nil { + req["assistedApprovalModel"] = *params.AssistedApprovalModel + } + req["mode"] = params.Mode if params.Source != nil { req["source"] = *params.Source } } - raw, err := a.client.Request(ctx, "session.permissions.setApproveAll", req) + raw, err := a.client.Request(ctx, "session.permissions.setMode", req) if err != nil { return nil, err } - var result PermissionsSetApproveAllResult + var result PermissionsSetModeResult if err := json.Unmarshal(raw, &result); err != nil { return nil, err } @@ -17847,7 +24356,8 @@ func (s *PermissionsAPI) Locations() *PermissionsLocationsAPI { // removed. type PermissionsPathsAPI sessionAPI -// Adds a directory to the session's allow-list. +// Adds a directory to the session's allow-list and activates conventional skill and agent +// definitions under it. // // RPC method: session.permissions.paths.add. // @@ -18123,8 +24633,8 @@ func (a *PluginsAPI) List(ctx context.Context) (*PluginList, error) { // RPC method: session.plugins.reload. // // Parameters: Optional flags controlling which side effects the reload performs. -func (a *PluginsAPI) Reload(ctx context.Context, params ...*PluginsReloadRequest) (*SessionPluginsReloadResult, error) { - var requestParams *PluginsReloadRequest +func (a *PluginsAPI) Reload(ctx context.Context, params ...*SessionPluginsReloadRequest) (*SessionPluginsReloadResult, error) { + var requestParams *SessionPluginsReloadRequest if len(params) > 0 { requestParams = params[0] } @@ -18206,8 +24716,8 @@ func (a *ProviderAPI) Add(ctx context.Context, params *ProviderAddRequest) (*Pro // // Returns: A snapshot of the provider endpoint the session is currently configured to talk // to. -func (a *ProviderAPI) GetEndpoint(ctx context.Context, params ...*ProviderGetEndpointRequest) (*ProviderEndpoint, error) { - var requestParams *ProviderGetEndpointRequest +func (a *ProviderAPI) GetEndpoint(ctx context.Context, params ...*SessionProviderGetEndpointRequest) (*ProviderEndpoint, error) { + var requestParams *SessionProviderGetEndpointRequest if len(params) > 0 { requestParams = params[0] } @@ -18247,6 +24757,77 @@ func (a *QueueAPI) Clear(ctx context.Context) (*SessionQueueClearResult, error) return &result, nil } +// DuplicateAt duplicates an addressable queued item immediately after its source. +// +// RPC method: session.queue.duplicateAt. +// +// Parameters: Parameters for duplicating a queued item. +// +// 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["id"] = params.ID + } + raw, err := a.client.Request(ctx, "session.queue.duplicateAt", req) + if err != nil { + return nil, err + } + var result QueueDuplicateAtResult + if err := json.Unmarshal(raw, &result); err != nil { + return nil, err + } + return &result, nil +} + +// InsertAt inserts a new queued message at a public visible position. +// +// RPC method: session.queue.insertAt. +// +// Parameters: Parameters for inserting a queued message at a public visible position. +// +// 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 { + req["message"] = params.Message + req["position"] = params.Position + } + raw, err := a.client.Request(ctx, "session.queue.insertAt", req) + if err != nil { + return nil, err + } + var result QueueInsertAtResult + if err := json.Unmarshal(raw, &result); err != nil { + return nil, err + } + return &result, nil +} + +// MoveItem moves an addressable queued item to a public visible position. +// +// RPC method: session.queue.moveItem. +// +// Parameters: Parameters for moving a queued item by stable id. +// +// 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["id"] = params.ID + req["toPosition"] = params.ToPosition + } + raw, err := a.client.Request(ctx, "session.queue.moveItem", req) + if err != nil { + return nil, err + } + var result QueueMoveItemResult + 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. // @@ -18266,6 +24847,29 @@ func (a *QueueAPI) PendingItems(ctx context.Context) (*QueuePendingItemsResult, return &result, nil } +// RemoveAt removes an addressable queued item by its stable id. +// +// RPC method: session.queue.removeAt. +// +// Parameters: Parameters for removing a queued item by stable id. +// +// 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["id"] = params.ID + } + raw, err := a.client.Request(ctx, "session.queue.removeAt", req) + if err != nil { + return nil, err + } + var result QueueRemoveAtResult + if err := json.Unmarshal(raw, &result); err != nil { + return nil, err + } + return &result, nil +} + // RemoveMostRecent removes the most recently queued user-facing item (LIFO). // // RPC method: session.queue.removeMostRecent. @@ -18284,6 +24888,82 @@ func (a *QueueAPI) RemoveMostRecent(ctx context.Context) (*QueueRemoveMostRecent return &result, nil } +// SendNow moves an addressable queued message into the live turn's steering lane. +// +// RPC method: session.queue.sendNow. +// +// 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["id"] = params.ID + } + raw, err := a.client.Request(ctx, "session.queue.sendNow", req) + if err != nil { + return nil, err + } + var result QueueSendNowResult + if err := json.Unmarshal(raw, &result); err != nil { + return nil, err + } + return &result, nil +} + +// SetDrainPaused acquires or releases the queued-lane drain pause. +// +// RPC method: session.queue.setDrainPaused. +// +// 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 { + req["paused"] = params.Paused + } + raw, err := a.client.Request(ctx, "session.queue.setDrainPaused", req) + if err != nil { + return nil, err + } + var result SessionQueueSetDrainPausedResult + if err := json.Unmarshal(raw, &result); err != nil { + return nil, err + } + return &result, nil +} + +// UpdateText updates the text of an addressable single-message queue item. +// +// RPC method: session.queue.updateText. +// +// Parameters: Parameters for editing a single queued message. +// +// 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 { + if params.DisplayPrompt != nil { + req["displayPrompt"] = *params.DisplayPrompt + } + req["id"] = params.ID + req["prompt"] = params.Prompt + } + raw, err := a.client.Request(ctx, "session.queue.updateText", req) + if err != nil { + return nil, err + } + var result QueueUpdateTextResult + 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 @@ -18428,7 +25108,14 @@ func (a *ShellAPI) CancelUserRequested(ctx context.Context, params *ShellCancelU return &result, nil } -// Exec starts a shell command and streams output through session notifications. +// 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.shell.exec. // @@ -18483,7 +25170,11 @@ func (a *ShellAPI) ExecuteUserRequested(ctx context.Context, params *ShellExecut return &result, nil } -// Kill sends a signal to a shell process previously started via "shell.exec". +// 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.shell.kill. // @@ -18931,6 +25622,79 @@ func (a *TelemetryAPI) SetFeatureOverrides(ctx context.Context, params *Telemetr // Experimental: ToolsAPI contains experimental APIs that may change or be removed. type ToolsAPI sessionAPI +// Executes one tool from the session's currently offered tool set through the native +// invocation pipeline. +// +// RPC method: session.tools.execute. +// +// Parameters: A tool name and arguments to execute through the session's native invocation +// pipeline. +// +// Returns: Canonical result returned by a session tool. +func (a *ToolsAPI) Execute(ctx context.Context, params *ToolsExecuteRequest) (ToolResult, error) { + req := map[string]any{"sessionId": a.sessionID} + if params != nil { + req["arguments"] = params.Arguments + req["name"] = params.Name + if params.ToolCallID != nil { + req["toolCallId"] = *params.ToolCallID + } + } + raw, err := a.client.Request(ctx, "session.tools.execute", req) + if err != nil { + return nil, err + } + result, err := unmarshalToolResult(raw) + if err != nil { + return nil, err + } + return result, nil +} + +// GetBuiltinDescriptors returns the Rust-owned built-in tool descriptors used to construct +// the session's offered tool set. +// +// RPC method: session.tools.getBuiltinDescriptors. +// +// Parameters: Options controlling how Rust-owned built-in tool descriptors are materialized. +// +// Returns: Rust-owned built-in tool descriptors for the session. +func (a *ToolsAPI) GetBuiltinDescriptors(ctx context.Context, params *ToolsGetBuiltinDescriptorsRequest) (*ToolsGetBuiltinDescriptorsResult, error) { + req := map[string]any{"sessionId": a.sessionID} + if params != nil { + if params.BackgroundTaskNotificationsEnabled != nil { + req["backgroundTaskNotificationsEnabled"] = *params.BackgroundTaskNotificationsEnabled + } + if params.IncludeAuthor != nil { + req["includeAuthor"] = *params.IncludeAuthor + } + if params.ReduceUserIntervention != nil { + req["reduceUserIntervention"] = *params.ReduceUserIntervention + } + if params.ShellConfig != nil { + req["shellConfig"] = *params.ShellConfig + } + if params.ShellSupportsPowerShell7Syntax != nil { + req["shellSupportsPowerShell7Syntax"] = *params.ShellSupportsPowerShell7Syntax + } + if params.ShellTimeoutMs != nil { + req["shellTimeoutMs"] = *params.ShellTimeoutMs + } + if params.SkillEmbeddingEnabled != nil { + req["skillEmbeddingEnabled"] = *params.SkillEmbeddingEnabled + } + } + raw, err := a.client.Request(ctx, "session.tools.getBuiltinDescriptors", req) + if err != nil { + return nil, err + } + var result ToolsGetBuiltinDescriptorsResult + if err := json.Unmarshal(raw, &result); err != nil { + return nil, err + } + return &result, nil +} + // GetCurrentMetadata returns lightweight metadata for the session's currently initialized // tools. // @@ -19002,6 +25766,59 @@ func (a *ToolsAPI) InitializeAndValidate(ctx context.Context) (*ToolsInitializeA return &result, nil } +// Set atomically replaces the complete externally implemented tool list supplied by the +// calling connection. Built-in, MCP/plugin, extension-discovered, subagent, and tools +// supplied by other connections remain unchanged. +// +// RPC method: session.tools.set. +// +// Parameters: Complete externally implemented tool list for the calling connection. An +// empty list removes every tool previously supplied by that connection. +// +// Returns: Empty result after replacing the calling connection's externally implemented +// tools. +func (a *ToolsAPI) Set(ctx context.Context, params *ToolsSetRequest) (*ToolsSetResult, error) { + req := map[string]any{"sessionId": a.sessionID} + if params != nil { + req["tools"] = params.Tools + } + raw, err := a.client.Request(ctx, "session.tools.set", req) + if err != nil { + return nil, err + } + var result ToolsSetResult + if err := json.Unmarshal(raw, &result); err != nil { + return nil, err + } + return &result, nil +} + +// TaskCompleteEventData projects a completed task_complete tool call into its label-safe +// session event payload. +// +// RPC method: session.tools.taskCompleteEventData. +// +// Parameters: Task-completion tool arguments and final result used to build a label-safe +// session event payload. +// +// Returns: Task completion notification with summary from the agent +func (a *ToolsAPI) TaskCompleteEventData(ctx context.Context, params *ToolsTaskCompleteEventDataRequest) (*TaskCompleteData, error) { + req := map[string]any{"sessionId": a.sessionID} + if params != nil { + req["finalResult"] = params.FinalResult + req["toolArgs"] = params.ToolArgs + } + raw, err := a.client.Request(ctx, "session.tools.taskCompleteEventData", req) + if err != nil { + return nil, err + } + var result TaskCompleteData + if err := json.Unmarshal(raw, &result); err != nil { + return nil, err + } + return &result, nil +} + // 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. @@ -19044,7 +25861,16 @@ func (a *UIAPI) Elicitation(ctx context.Context, params *UIElicitationRequest) ( req := map[string]any{"sessionId": a.sessionID} if params != nil { req["message"] = params.Message + if params.Meta != nil { + req["_meta"] = params.Meta + } + if params.Mode != nil { + req["mode"] = *params.Mode + } req["requestedSchema"] = params.RequestedSchema + if params.Task != nil { + req["task"] = *params.Task + } } raw, err := a.client.Request(ctx, "session.ui.elicitation", req) if err != nil { @@ -19064,7 +25890,8 @@ func (a *UIAPI) Elicitation(ctx context.Context, params *UIElicitationRequest) ( // // Parameters: Transient question to answer without adding it to conversation history. // -// Returns: Transient answer generated from current conversation context. +// Returns: Completed transient query. Ordered chunks and the terminal outcome are also +// delivered through `ui.ephemeral_query` session events while it runs. func (a *UIAPI) EphemeralQuery(ctx context.Context, params *UIEphemeralQueryRequest) (*UIEphemeralQueryResult, error) { req := map[string]any{"sessionId": a.sessionID} if params != nil { @@ -19366,16 +26193,59 @@ func (a *VisibilityAPI) Set(ctx context.Context, params *VisibilitySetRequest) ( // 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. +// AddSummary adds a compaction summary checkpoint to the local session workspace. // -// RPC method: session.workspaces.createFile. +// RPC method: session.workspaces.addSummary. // -// 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) { +// Parameters: Compaction summary checkpoint to persist. +// +// 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["content"] = params.Content - req["path"] = params.Path + req["title"] = params.Title + } + raw, err := a.client.Request(ctx, "session.workspaces.addSummary", req) + if err != nil { + return nil, err + } + var result WorkspacesAddSummaryResult + if err := json.Unmarshal(raw, &result); err != nil { + return nil, err + } + return &result, nil +} + +// AutopilotObjectiveExists checks whether the local session workspace has an autopilot +// objective state file. +// +// RPC method: session.workspaces.autopilotObjectiveExists. +// +// 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(ctx, "session.workspaces.autopilotObjectiveExists", req) + if err != nil { + return nil, err + } + var result WorkspacesAutopilotObjectiveExistsResult + if err := json.Unmarshal(raw, &result); err != nil { + return nil, err + } + return &result, nil +} + +// CreateFile creates or overwrites a file in the session workspace files directory. +// +// RPC method: session.workspaces.createFile. +// +// 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["content"] = params.Content + req["path"] = params.Path } raw, err := a.client.Request(ctx, "session.workspaces.createFile", req) if err != nil { @@ -19388,7 +26258,28 @@ func (a *WorkspacesAPI) CreateFile(ctx context.Context, params *WorkspacesCreate return &result, nil } -// Diff computes a diff for the session workspace. +// DeleteAutopilotObjective deletes the autopilot objective state file from the local +// session workspace. +// +// RPC method: session.workspaces.deleteAutopilotObjective. +// +// Returns: Result of deleting the autopilot objective file. +func (a *WorkspacesAPI) DeleteAutopilotObjective(ctx context.Context) (*WorkspacesDeleteAutopilotObjectiveResult, error) { + req := map[string]any{"sessionId": a.sessionID} + raw, err := a.client.Request(ctx, "session.workspaces.deleteAutopilotObjective", req) + if err != nil { + return nil, err + } + var result WorkspacesDeleteAutopilotObjectiveResult + if err := json.Unmarshal(raw, &result); err != nil { + return nil, err + } + return &result, nil +} + +// 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.workspaces.diff. // @@ -19414,6 +26305,32 @@ func (a *WorkspacesAPI) Diff(ctx context.Context, params *WorkspacesDiffRequest) return &result, nil } +// Ensures a local session workspace exists and returns it. +// +// RPC method: session.workspaces.ensure. +// +// Parameters: Optional session context used when creating a local workspace. +// +// 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 { + if params.Context != nil { + req["context"] = params.Context + } + } + raw, err := a.client.Request(ctx, "session.workspaces.ensure", req) + if err != nil { + return nil, err + } + var result WorkspacesGetWorkspaceResult + if err := json.Unmarshal(raw, &result); err != nil { + return nil, err + } + return &result, nil +} + // GetWorkspace gets current workspace metadata for the session. // // RPC method: session.workspaces.getWorkspace. @@ -19470,6 +26387,25 @@ func (a *WorkspacesAPI) ListFiles(ctx context.Context) (*WorkspacesListFilesResu return &result, nil } +// ReadAutopilotObjective reads the autopilot objective state file from the local session +// workspace. +// +// RPC method: session.workspaces.readAutopilotObjective. +// +// 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(ctx, "session.workspaces.readAutopilotObjective", req) + if err != nil { + return nil, err + } + var result WorkspacesReadAutopilotObjectiveResult + if err := json.Unmarshal(raw, &result); err != nil { + return nil, err + } + return &result, nil +} + // ReadCheckpoint reads the content of a workspace checkpoint by number. // // RPC method: session.workspaces.readCheckpoint. @@ -19540,46 +26476,126 @@ func (a *WorkspacesAPI) SaveLargePaste(ctx context.Context, params *WorkspacesSa return &result, nil } +// TruncateSummaries truncates local workspace compaction summaries after a rollback. +// +// RPC method: session.workspaces.truncateSummaries. +// +// 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} + 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 WorkspacesGetWorkspaceResult + if err := json.Unmarshal(raw, &result); err != nil { + return nil, err + } + return &result, nil +} + +// UpdateMetadata updates workspace metadata for a local session and returns the refreshed +// workspace. +// +// RPC method: session.workspaces.updateMetadata. +// +// Parameters: Workspace metadata fields to update. +// +// 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 { + if params.Context != nil { + req["context"] = params.Context + } + if params.Name != nil { + req["name"] = *params.Name + } + } + raw, err := a.client.Request(ctx, "session.workspaces.updateMetadata", req) + if err != nil { + return nil, err + } + var result WorkspacesGetWorkspaceResult + if err := json.Unmarshal(raw, &result); err != nil { + return nil, err + } + return &result, nil +} + +// WriteAutopilotObjective writes the autopilot objective state file in the local session +// workspace. +// +// RPC method: session.workspaces.writeAutopilotObjective. +// +// 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} + 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 WorkspacesWriteAutopilotObjectiveResult + 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 - Canvas *CanvasAPI - Commands *CommandsAPI - Completions *CompletionsAPI - Debug *DebugAPI - EventLog *EventLogAPI - Extensions *ExtensionsAPI - Factory *FactoryAPI - Fleet *FleetAPI - GitHubAuth *GitHubAuthAPI - History *HistoryAPI - Instructions *InstructionsAPI - 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 + 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. @@ -19609,6 +26625,58 @@ func (a *SessionRPC) Abort(ctx context.Context, params *AbortRequest) (*AbortRes return &result, nil } +// CancelAllBackgroundAgents cancels every running background agent (task-registry subagents +// plus sidekick agents) without interrupting the main agent loop. Promoted attached shells +// are left running. +// +// RPC method: session.cancelAllBackgroundAgents. +// +// 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 SessionCancelAllBackgroundAgentsResult + if err := json.Unmarshal(raw, &result); err != nil { + return nil, err + } + return &result, nil +} + +// 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.interruptMainTurn. +// +// Parameters: Parameters for interrupting the main agent turn. +// +// 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 { + if params.FlushQueued != nil { + req["flushQueued"] = *params.FlushQueued + } + } + raw, err := a.common.client.Request(ctx, "session.interruptMainTurn", req) + if err != nil { + return nil, err + } + var result InterruptMainTurnResult + 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. @@ -19750,219 +26818,996 @@ func (a *SessionRPC) SendMessages(ctx context.Context, params *SendMessagesReque req["wait"] = *params.Wait } } - raw, err := a.common.client.Request(ctx, "session.sendMessages", req) + raw, err := a.common.client.Request(ctx, "session.sendMessages", req) + if err != nil { + return nil, err + } + var result SendMessagesResult + 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. +// +// RPC method: session.shutdown. +// +// 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(ctx, "session.shutdown", req) + if err != nil { + return nil, err + } + var result SessionShutdownResult + if err := json.Unmarshal(raw, &result); err != nil { + return nil, err + } + return &result, nil +} + +// Suspends the session while preserving persisted state for later resume. +// +// 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 SessionSuspendResult + 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.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: InternalCanvasAPI contains experimental APIs that may change or be removed. +type InternalCanvasAPI internalSessionAPI + +// Experimental: InternalCanvasProviderAPI contains experimental APIs that may change or be +// removed. +type InternalCanvasProviderAPI internalSessionAPI + +// Registers an internal canvas provider connection and its contributions. +// +// RPC method: session.canvas.provider.register. +// +// Parameters: Internal canvas provider registration parameters. +// Internal: Register is part of the SDK's internal handshake/plumbing; external callers +// should not use it. +func (a *InternalCanvasProviderAPI) Register(ctx context.Context, params *CanvasProviderRegisterRequest) (*SessionCanvasProviderRegisterResult, error) { + req := map[string]any{"sessionId": a.sessionID} + if params != nil { + req["canvases"] = params.Canvases + req["connectionId"] = params.ConnectionID + req["info"] = params.Info + } + raw, err := a.client.Request(ctx, "session.canvas.provider.register", req) + if err != nil { + return nil, err + } + var result SessionCanvasProviderRegisterResult + if err := json.Unmarshal(raw, &result); err != nil { + return nil, err + } + return &result, nil +} + +// Unregisters an internal canvas provider connection. +// +// RPC method: session.canvas.provider.unregister. +// +// Parameters: Internal canvas provider unregistration parameters. +// Internal: Unregister is part of the SDK's internal handshake/plumbing; external callers +// should not use it. +func (a *InternalCanvasProviderAPI) Unregister(ctx context.Context, params *CanvasProviderUnregisterRequest) (*SessionCanvasProviderUnregisterResult, error) { + req := map[string]any{"sessionId": a.sessionID} + if params != nil { + req["connectionId"] = params.ConnectionID + } + raw, err := a.client.Request(ctx, "session.canvas.provider.unregister", req) + if err != nil { + return nil, err + } + var result SessionCanvasProviderUnregisterResult + if err := json.Unmarshal(raw, &result); err != nil { + return nil, err + } + return &result, nil +} + +// Experimental: Provider returns experimental APIs that may change or be removed. +func (s *InternalCanvasAPI) Provider() *InternalCanvasProviderAPI { + return (*InternalCanvasProviderAPI)(s) +} + +// Experimental: InternalCommandsAPI contains experimental APIs that may change or be +// removed. +type InternalCommandsAPI internalSessionAPI + +// FinalizeInvocationEffect finalizes persistence associated with a client-applied +// slash-command effect. +// +// RPC method: session.commands.finalizeInvocationEffect. +// +// Parameters: The pending slash-command invocation effect to finalize, plus whether the +// host applied or cancelled it. +// +// Returns: Whether finalizing the invocation effect succeeded, and the failure reason when +// it did not. +// Internal: FinalizeInvocationEffect is part of the SDK's internal handshake/plumbing; +// external callers should not use it. +func (a *InternalCommandsAPI) FinalizeInvocationEffect(ctx context.Context, params *CommandsFinalizeInvocationEffectRequest) (*CommandsFinalizeInvocationEffectResult, error) { + req := map[string]any{"sessionId": a.sessionID} + if params != nil { + req["effect"] = params.Effect + req["outcome"] = params.Outcome + } + raw, err := a.client.Request(ctx, "session.commands.finalizeInvocationEffect", req) + if err != nil { + return nil, err + } + var result CommandsFinalizeInvocationEffectResult + if err := json.Unmarshal(raw, &result); err != nil { + return nil, err + } + return &result, nil +} + +// Experimental: InternalFactoryAPI contains experimental APIs that may change or be removed. +type InternalFactoryAPI internalSessionAPI + +// ResumeFromTool internal tool-originated factory resume. +// +// RPC method: session.factory.resumeFromTool. +// +// Parameters: Internal parameters for resuming a factory run from a tool. +// +// Returns: Resolved persisted factory identity and resumed run envelope. +// Internal: ResumeFromTool is part of the SDK's internal handshake/plumbing; external +// callers should not use it. +func (a *InternalFactoryAPI) ResumeFromTool(ctx context.Context, params *FactoryToolResumeRequest) (*FactoryResumeResult, error) { + req := map[string]any{"sessionId": a.sessionID} + if params != nil { + if params.Limits != nil { + req["limits"] = *params.Limits + } + req["runId"] = params.RunID + if params.ToolCallID != nil { + req["toolCallId"] = *params.ToolCallID + } + } + raw, err := a.client.Request(ctx, "session.factory.resumeFromTool", req) + if err != nil { + return nil, err + } + var result FactoryResumeResult + if err := json.Unmarshal(raw, &result); err != nil { + return nil, err + } + return &result, nil +} + +// RunFromTool internal tool-originated factory invocation. +// +// RPC method: session.factory.runFromTool. +// +// Parameters: Internal parameters for invoking a registered factory from a tool. +// +// Returns: Complete current or terminal factory run envelope. +// Internal: RunFromTool is part of the SDK's internal handshake/plumbing; external callers +// should not use it. +func (a *InternalFactoryAPI) RunFromTool(ctx context.Context, params *FactoryToolRunRequest) (*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 + } + if params.ToolCallID != nil { + req["toolCallId"] = *params.ToolCallID + } + } + raw, err := a.client.Request(ctx, "session.factory.runFromTool", req) + if err != nil { + return nil, err + } + var result FactoryRunResult + if err := json.Unmarshal(raw, &result); err != nil { + return nil, err + } + return &result, nil +} + +// Experimental: InternalGitHubAuthAPI contains experimental APIs that may change or be +// removed. +type InternalGitHubAuthAPI internalSessionAPI + +// GetAllAuthAvailable gets all authentication accounts available to the internal session +// host. +// +// RPC method: session.gitHubAuth.getAllAuthAvailable. +// +// Returns: Authentication accounts available to the internal session host. +// Internal: GetAllAuthAvailable is part of the SDK's internal handshake/plumbing; external +// callers should not use it. +func (a *InternalGitHubAuthAPI) GetAllAuthAvailable(ctx context.Context) (*SessionGitHubAuthGetAllAuthAvailableResult, error) { + req := map[string]any{"sessionId": a.sessionID} + raw, err := a.client.Request(ctx, "session.gitHubAuth.getAllAuthAvailable", req) + if err != nil { + return nil, err + } + var result SessionGitHubAuthGetAllAuthAvailableResult + if err := json.Unmarshal(raw, &result); err != nil { + return nil, err + } + return &result, nil +} + +// GetCurrentAuthInfo gets the current authentication information for internal session hosts. +// +// RPC method: session.gitHubAuth.getCurrentAuthInfo. +// +// Returns: Current authentication information, or null when no authentication is active. +// Internal: GetCurrentAuthInfo is part of the SDK's internal handshake/plumbing; external +// callers should not use it. +func (a *InternalGitHubAuthAPI) GetCurrentAuthInfo(ctx context.Context) (*AuthIdentity, error) { + req := map[string]any{"sessionId": a.sessionID} + raw, err := a.client.Request(ctx, "session.gitHubAuth.getCurrentAuthInfo", req) + if err != nil { + return nil, err + } + var result AuthIdentity + if err := json.Unmarshal(raw, &result); err != nil { + return nil, err + } + return &result, nil +} + +// LastAuthErrors gets validation errors from the most recent authentication attempt. +// +// RPC method: session.gitHubAuth.lastAuthErrors. +// +// Returns: Validation errors from the most recent authentication attempt. +// Internal: LastAuthErrors is part of the SDK's internal handshake/plumbing; external +// callers should not use it. +func (a *InternalGitHubAuthAPI) LastAuthErrors(ctx context.Context) (*AuthValidationErrors, error) { + req := map[string]any{"sessionId": a.sessionID} + raw, err := a.client.Request(ctx, "session.gitHubAuth.lastAuthErrors", req) + if err != nil { + return nil, err + } + var result AuthValidationErrors + if err := json.Unmarshal(raw, &result); err != nil { + return nil, err + } + return &result, nil +} + +// Login logs in a GitHub user through the internal session host. +// +// RPC method: session.gitHubAuth.login. +// +// Parameters: Internal GitHub login parameters. +// +// Returns: Authentication credentials accepted only at native protocol ingress. Runtime +// outputs use credential-free `AuthIdentity` metadata. +// Internal: Login is part of the SDK's internal handshake/plumbing; external callers should +// not use it. +func (a *InternalGitHubAuthAPI) Login(ctx context.Context, params *SessionAuthLoginRequest) (AuthInfo, error) { + req := map[string]any{"sessionId": a.sessionID} + if params != nil { + req["host"] = params.Host + req["login"] = params.Login + if params.Persist != nil { + req["persist"] = *params.Persist + } + req["token"] = params.Token + } + raw, err := a.client.Request(ctx, "session.gitHubAuth.login", req) + if err != nil { + return nil, err + } + result, err := unmarshalAuthInfo(raw) + if err != nil { + return nil, err + } + return result, nil +} + +// Logout logs out the session's current GitHub authentication. +// +// RPC method: session.gitHubAuth.logout. +// +// Returns: Whether the current authentication was logged out. +// Internal: Logout is part of the SDK's internal handshake/plumbing; external callers +// should not use it. +func (a *InternalGitHubAuthAPI) Logout(ctx context.Context) (*SessionGitHubAuthLogoutResult, error) { + req := map[string]any{"sessionId": a.sessionID} + raw, err := a.client.Request(ctx, "session.gitHubAuth.logout", req) + if err != nil { + return nil, err + } + var result SessionGitHubAuthLogoutResult + if err := json.Unmarshal(raw, &result); err != nil { + return nil, err + } + return &result, nil +} + +// LogoutUser logs out a specific GitHub authentication. +// +// RPC method: session.gitHubAuth.logoutUser. +// +// Parameters: Parameters identifying a GitHub authentication to log out. +// +// Returns: Whether the requested authentication was logged out. +// Internal: LogoutUser is part of the SDK's internal handshake/plumbing; external callers +// should not use it. +func (a *InternalGitHubAuthAPI) LogoutUser(ctx context.Context, params *SessionAuthLogoutUserRequest) (*SessionGitHubAuthLogoutUserResult, error) { + req := map[string]any{"sessionId": a.sessionID} + if params != nil { + req["authInfo"] = params.AuthInfo + } + raw, err := a.client.Request(ctx, "session.gitHubAuth.logoutUser", req) + if err != nil { + return nil, err + } + var result SessionGitHubAuthLogoutUserResult + if err := json.Unmarshal(raw, &result); err != nil { + return nil, err + } + return &result, nil +} + +// RefreshCopilotUser refreshes Copilot account metadata for the current authentication. +// +// RPC method: session.gitHubAuth.refreshCopilotUser. +// +// Returns: Current authentication information, or null when no authentication is active. +// Internal: RefreshCopilotUser is part of the SDK's internal handshake/plumbing; external +// callers should not use it. +func (a *InternalGitHubAuthAPI) RefreshCopilotUser(ctx context.Context) (*AuthIdentity, error) { + req := map[string]any{"sessionId": a.sessionID} + raw, err := a.client.Request(ctx, "session.gitHubAuth.refreshCopilotUser", req) + if err != nil { + return nil, err + } + var result AuthIdentity + if err := json.Unmarshal(raw, &result); err != nil { + return nil, err + } + return &result, nil +} + +// SwitchToAuth switches the session to another available authentication. +// +// RPC method: session.gitHubAuth.switchToAuth. +// +// Parameters: Parameters for switching the session's active authentication. +// Internal: SwitchToAuth is part of the SDK's internal handshake/plumbing; external callers +// should not use it. +func (a *InternalGitHubAuthAPI) SwitchToAuth(ctx context.Context, params *SessionAuthSwitchRequest) (*SessionGitHubAuthSwitchToAuthResult, error) { + req := map[string]any{"sessionId": a.sessionID} + if params != nil { + req["authInfo"] = params.AuthInfo + if params.Token != nil { + req["token"] = *params.Token + } + } + raw, err := a.client.Request(ctx, "session.gitHubAuth.switchToAuth", req) + if err != nil { + return nil, err + } + var result SessionGitHubAuthSwitchToAuthResult + if err := json.Unmarshal(raw, &result); err != nil { + return nil, err + } + return &result, nil +} + +// Experimental: InternalMCPAPI contains experimental APIs that may change or be removed. +type InternalMCPAPI internalSessionAPI + +// ConfigureGitHub configures the built-in GitHub MCP server for the session's current auth +// context. +// +// RPC method: session.mcp.configureGitHub. +// +// Parameters: Credential-free authentication identity used to configure GitHub MCP. +// +// 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["authInfo"] = params.AuthInfo + } + raw, err := a.client.Request(ctx, "session.mcp.configureGitHub", req) + if err != nil { + return nil, err + } + var result MCPConfigureGitHubResult + if err := json.Unmarshal(raw, &result); err != nil { + return nil, err + } + return &result, nil +} + +// 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.mcp.registerExternalClient. +// +// 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["client"] = params.Client + req["config"] = params.Config + req["serverName"] = params.ServerName + req["transport"] = params.Transport + } + raw, err := a.client.Request(ctx, "session.mcp.registerExternalClient", req) + if err != nil { + return nil, err + } + var result SessionMCPRegisterExternalClientResult + if err := json.Unmarshal(raw, &result); err != nil { + return nil, err + } + return &result, nil +} + +// ReloadWithConfig reloads MCP server connections for the session with an explicit +// host-provided configuration. +// +// RPC method: session.mcp.reloadWithConfig. +// +// Parameters: Opaque MCP reload configuration. +// +// 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["config"] = params.Config + } + raw, err := a.client.Request(ctx, "session.mcp.reloadWithConfig", req) + if err != nil { + return nil, err + } + var result MCPStartServersResult + if err := json.Unmarshal(raw, &result); err != nil { + return nil, err + } + return &result, nil +} + +// 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.mcp.unregisterExternalClient. +// +// 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["serverName"] = params.ServerName + } + raw, err := a.client.Request(ctx, "session.mcp.unregisterExternalClient", req) + if err != nil { + return nil, err + } + var result SessionMCPUnregisterExternalClientResult + if err := json.Unmarshal(raw, &result); err != nil { + return nil, err + } + return &result, nil +} + +// Experimental: InternalModelAPI contains experimental APIs that may change or be removed. +type InternalModelAPI internalSessionAPI + +// ApplyStartupOverlay resolves and applies organization-managed and repository model +// overlays. +// +// RPC method: session.model.applyStartupOverlay. +// +// Parameters: Managed, repository, and CLI model overrides to overlay onto the session at +// startup. +// +// Returns: The model identifier active on the session after the switch. +// Internal: ApplyStartupOverlay is part of the SDK's internal handshake/plumbing; external +// callers should not use it. +func (a *InternalModelAPI) ApplyStartupOverlay(ctx context.Context, params *ModelApplyStartupOverlayRequest) (*ModelSwitchToResult, error) { + req := map[string]any{"sessionId": a.sessionID} + if params != nil { + if params.CLIModel != nil { + req["cliModel"] = *params.CLIModel + } + if params.DeferredResume != nil { + req["deferredResume"] = *params.DeferredResume + } + if params.DeviceManagedModel != nil { + req["deviceManagedModel"] = *params.DeviceManagedModel + } + if params.RepoContextTier != nil { + req["repoContextTier"] = *params.RepoContextTier + } + if params.RepoModel != nil { + req["repoModel"] = *params.RepoModel + } + if params.RepoReasoningEffort != nil { + req["repoReasoningEffort"] = *params.RepoReasoningEffort + } + if params.ServerManagedModel != nil { + req["serverManagedModel"] = *params.ServerManagedModel + } + } + raw, err := a.client.Request(ctx, "session.model.applyStartupOverlay", req) + if err != nil { + return nil, err + } + var result ModelSwitchToResult + if err := json.Unmarshal(raw, &result); err != nil { + return nil, err + } + return &result, nil +} + +// 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.queue.beginDeferredIdleDrain. +// +// Parameters: Inputs for starting a deferred-idle drain. +// +// 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["activeBackgroundWork"] = params.ActiveBackgroundWork + } + raw, err := a.client.Request(ctx, "session.queue.beginDeferredIdleDrain", req) + if err != nil { + return nil, err + } + var result QueueBeginDeferredIdleDrainResult + if err := json.Unmarshal(raw, &result); err != nil { + return nil, err + } + return &result, nil +} + +// ConsumeSystemNotifications consumes queued native system notifications matching an +// internal filter. +// +// RPC method: session.queue.consumeSystemNotifications. +// +// Parameters: Internal filter for consuming queued system notifications. +// +// 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["filter"] = params.Filter + } + raw, err := a.client.Request(ctx, "session.queue.consumeSystemNotifications", req) + if err != nil { + return nil, err + } + var result QueueRemoveMostRecentResult + if err := json.Unmarshal(raw, &result); err != nil { + return nil, err + } + return &result, nil +} + +// DeferSessionIdle marks session.idle as deferred by native background work state. +// +// RPC method: session.queue.deferSessionIdle. +// +// 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} + 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 SessionQueueDeferSessionIdleResult + if err := json.Unmarshal(raw, &result); err != nil { + return nil, err + } + return &result, nil +} + +// EnqueueResumePending enqueues the internal resume-pending wake item when orphan handling +// needs a follow-up turn. +// +// RPC method: session.queue.enqueueResumePending. +// +// 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} + raw, err := a.client.Request(ctx, "session.queue.enqueueResumePending", req) + if err != nil { + return nil, err + } + var result QueueEnqueueResumePendingResult + if err := json.Unmarshal(raw, &result); err != nil { + return nil, err + } + return &result, nil +} + +// FinishDeferredIdleDrain finishes a native deferred-idle drain and reports whether to +// drain queue work or emit idle. +// +// RPC method: session.queue.finishDeferredIdleDrain. +// +// 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} + 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 QueueFinishDeferredIdleDrainResult + if err := json.Unmarshal(raw, &result); err != nil { + return nil, err + } + return &result, nil +} + +// HasPending reports whether the local session has native queued work pending. +// +// RPC method: session.queue.hasPending. +// +// 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} + raw, err := a.client.Request(ctx, "session.queue.hasPending", req) + if err != nil { + return nil, err + } + var result QueueHasPendingResult + if err := json.Unmarshal(raw, &result); err != nil { + return nil, err + } + return &result, nil +} + +// Process drains the native local-session work queue for in-process session orchestration. +// +// 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} + raw, err := a.client.Request(ctx, "session.queue.process", req) + if err != nil { + return nil, err + } + var result SessionQueueProcessResult + if err := json.Unmarshal(raw, &result); err != nil { + return nil, err + } + return &result, nil +} + +// Snapshot returns the internal native queue snapshot for in-process session orchestration. +// +// RPC method: session.queue.snapshot. +// +// 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(ctx, "session.queue.snapshot", req) if err != nil { return nil, err } - var result SendMessagesResult + var result QueueSnapshotResult 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. +// Experimental: InternalScheduleAPI contains experimental APIs that may change or be +// removed. +type InternalScheduleAPI internalSessionAPI + +// Add registers a relative-interval scheduled prompt. // -// RPC method: session.shutdown. +// RPC method: session.schedule.add. // -// 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} +// 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} if params != nil { - if params.Reason != nil { - req["reason"] = *params.Reason + if params.DisplayPrompt != nil { + req["displayPrompt"] = *params.DisplayPrompt } - if params.Type != nil { - req["type"] = *params.Type + req["interval"] = params.Interval + req["prompt"] = params.Prompt + if params.Recurring != nil { + req["recurring"] = *params.Recurring } } - raw, err := a.common.client.Request(ctx, "session.shutdown", req) + raw, err := a.client.Request(ctx, "session.schedule.add", req) if err != nil { return nil, err } - var result SessionShutdownResult + var result ScheduleAddResult if err := json.Unmarshal(raw, &result); err != nil { return nil, err } return &result, nil } -// Suspends the session while preserving persisted state for later resume. +// AddAt registers an absolute-time scheduled prompt. // -// 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) +// RPC method: session.schedule.addAt. +// +// 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} + 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 SessionSuspendResult + var result ScheduleAddResult 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.Canvas = (*CanvasAPI)(&r.common) - r.Commands = (*CommandsAPI)(&r.common) - r.Completions = (*CompletionsAPI)(&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.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 - -// ConfigureGitHub configures the built-in GitHub MCP server for the session's current auth -// context. +// AddCron registers a recurring cron scheduled prompt. // -// RPC method: session.mcp.configureGitHub. +// RPC method: session.schedule.addCron. // -// Parameters: Opaque auth info used to configure GitHub MCP. +// Parameters: Register a cron scheduled prompt. // -// 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) { +// 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["authInfo"] = params.AuthInfo + 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(ctx, "session.mcp.configureGitHub", req) + raw, err := a.client.Request(ctx, "session.schedule.addCron", req) if err != nil { return nil, err } - var result MCPConfigureGitHubResult + var result ScheduleAddResult if err := json.Unmarshal(raw, &result); err != nil { return nil, err } return &result, nil } -// 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. +// AddSelfPaced registers a self-paced scheduled prompt. // -// RPC method: session.mcp.registerExternalClient. +// RPC method: session.schedule.addSelfPaced. // -// 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) { +// Parameters: Register a self-paced scheduled prompt. +// +// 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["client"] = params.Client - req["config"] = params.Config - req["serverName"] = params.ServerName - req["transport"] = params.Transport + if params.DisplayPrompt != nil { + req["displayPrompt"] = *params.DisplayPrompt + } + req["prompt"] = params.Prompt } - raw, err := a.client.Request(ctx, "session.mcp.registerExternalClient", req) + raw, err := a.client.Request(ctx, "session.schedule.addSelfPaced", req) if err != nil { return nil, err } - var result SessionMCPRegisterExternalClientResult + var result ScheduleAddResult if err := json.Unmarshal(raw, &result); err != nil { return nil, err } return &result, nil } -// ReloadWithConfig reloads MCP server connections for the session with an explicit -// host-provided configuration. -// -// RPC method: session.mcp.reloadWithConfig. +// HasSelfPaced reports whether the session has an active self-paced scheduled prompt. // -// Parameters: Opaque MCP reload configuration. +// RPC method: session.schedule.hasSelfPaced. // -// 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) { +// 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["config"] = params.Config + raw, err := a.client.Request(ctx, "session.schedule.hasSelfPaced", req) + if err != nil { + return nil, err } - raw, err := a.client.Request(ctx, "session.mcp.reloadWithConfig", req) + var result ScheduleHasSelfPacedResult + if err := json.Unmarshal(raw, &result); err != nil { + return nil, err + } + return &result, nil +} + +// Hydrates the native schedule registry from persisted session events. +// +// 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 MCPStartServersResult + var result SessionScheduleHydrateResult if err := json.Unmarshal(raw, &result); err != nil { return nil, err } return &result, nil } -// 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. +// RearmSelfPaced re-arms an active self-paced scheduled prompt. // -// RPC method: session.mcp.unregisterExternalClient. +// RPC method: session.schedule.rearmSelfPaced. // -// 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) { +// 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["serverName"] = params.ServerName + req["at"] = params.At + req["id"] = params.ID } - raw, err := a.client.Request(ctx, "session.mcp.unregisterExternalClient", req) + raw, err := a.client.Request(ctx, "session.schedule.rearmSelfPaced", req) if err != nil { return nil, err } - var result SessionMCPUnregisterExternalClientResult + var result ScheduleAddResult if err := json.Unmarshal(raw, &result); err != nil { return nil, err } @@ -20035,14 +27880,60 @@ type InternalSessionRPC struct { // Reuse a single struct instead of allocating one for each service on the heap. common internalSessionAPI - MCP *InternalMCPAPI - Settings *InternalSettingsAPI + Canvas *InternalCanvasAPI + Commands *InternalCommandsAPI + Factory *InternalFactoryAPI + GitHubAuth *InternalGitHubAuthAPI + MCP *InternalMCPAPI + Model *InternalModelAPI + 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.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} + 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 SessionSendSystemNotificationResult + if err := json.Unmarshal(raw, &result); err != nil { + return nil, err + } + return &result, nil } func NewInternalSessionRPC(client *jsonrpc2.Client, sessionID string) *InternalSessionRPC { r := &InternalSessionRPC{} r.common = internalSessionAPI{client: client, sessionID: sessionID} + r.Canvas = (*InternalCanvasAPI)(&r.common) + r.Commands = (*InternalCommandsAPI)(&r.common) + r.Factory = (*InternalFactoryAPI)(&r.common) + r.GitHubAuth = (*InternalGitHubAuthAPI)(&r.common) r.MCP = (*InternalMCPAPI)(&r.common) + r.Model = (*InternalModelAPI)(&r.common) + r.Queue = (*InternalQueueAPI)(&r.common) + r.Schedule = (*InternalScheduleAPI)(&r.common) r.Settings = (*InternalSettingsAPI)(&r.common) return r } @@ -20202,16 +28093,27 @@ type SessionFSHandler interface { // // 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. + // 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) + // 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. @@ -20559,6 +28461,25 @@ func RegisterClientSessionAPIHandlers(client *jsonrpc2.Client, getHandlers func( } 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 { + return nil, &jsonrpc2.Error{Code: -32603, Message: fmt.Sprintf("No sessionFs handler registered for session: %s", request.SessionID)} + } + result, err := handlers.SessionFS.SqliteTransaction(&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.stat", func(params json.RawMessage) (json.RawMessage, *jsonrpc2.Error) { var request SessionFSStatRequest if err := json.Unmarshal(params, &request); err != nil { @@ -20599,6 +28520,23 @@ func RegisterClientSessionAPIHandlers(client *jsonrpc2.Client, getHandlers func( }) } +// 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 { @@ -20615,6 +28553,21 @@ type GitHubTelemetryHandler interface { Event(request *GitHubTelemetryNotification) error } +// Experimental: GitHubTokenHandler contains experimental APIs that may change or be removed. +type GitHubTokenHandler interface { + // GetToken asks the SDK client to mint a GitHub access token for a session whose + // configuration supplied a GitHub token provider. The runtime acquires the initial token + // during bootstrap and refreshes it during expiry preflight when one hour or less remains. + // + // RPC method: gitHubToken.getToken. + // + // Parameters: Asks the SDK client to acquire a GitHub access token from an opaque callback + // registration. + // + // Returns: SDK host response to a GitHub credential request. + GetToken(request *GitHubTokenAcquireRequest) (GitHubTokenAcquireResult, 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 @@ -20665,9 +28618,11 @@ type LlmInferenceHandler interface { // Unlike client-session handlers these carry no implicit session id dispatch // key; a single set of handlers serves the entire connection. type ClientGlobalAPIHandlers struct { - GitHubTelemetry GitHubTelemetryHandler - Hooks HooksHandler - LlmInference LlmInferenceHandler + ExtensionLaunchProvider ExtensionLaunchProviderHandler + GitHubTelemetry GitHubTelemetryHandler + GitHubToken GitHubTokenHandler + Hooks HooksHandler + LlmInference LlmInferenceHandler } func clientGlobalHandlerError(err error) *jsonrpc2.Error { @@ -20684,6 +28639,24 @@ func clientGlobalHandlerError(err error) *jsonrpc2.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 { @@ -20697,6 +28670,24 @@ func RegisterClientGlobalAPIHandlers(client *jsonrpc2.Client, handlers *ClientGl } return nil, nil }) + client.SetRequestHandler("gitHubToken.getToken", func(params json.RawMessage) (json.RawMessage, *jsonrpc2.Error) { + var request GitHubTokenAcquireRequest + 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.GitHubToken == nil { + return nil, &jsonrpc2.Error{Code: -32603, Message: "No gitHubToken client-global handler registered"} + } + result, err := handlers.GitHubToken.GetToken(&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("hooks.invoke", func(params json.RawMessage) (json.RawMessage, *jsonrpc2.Error) { var request HookInvokeRequest if err := json.Unmarshal(params, &request); err != nil { diff --git a/go/rpc/zrpc_encoding.go b/go/rpc/zrpc_encoding.go index 82f6e10774..78788660f5 100644 --- a/go/rpc/zrpc_encoding.go +++ b/go/rpc/zrpc_encoding.go @@ -57,6 +57,12 @@ func unmarshalAuthInfo(data []byte) (AuthInfo, error) { return nil, err } return &d, nil + case AuthInfoTypeTokenProvider: + var d TokenProviderAuthInfo + if err := json.Unmarshal(data, &d); err != nil { + return nil, err + } + return &d, nil case AuthInfoTypeUser: var d UserAuthInfo if err := json.Unmarshal(data, &d); err != nil { @@ -145,6 +151,17 @@ func (r TokenAuthInfo) MarshalJSON() ([]byte, error) { }) } +func (r TokenProviderAuthInfo) MarshalJSON() ([]byte, error) { + type alias TokenProviderAuthInfo + return json.Marshal(struct { + Type AuthInfoType `json:"type"` + alias + }{ + Type: r.Type(), + alias: alias(r), + }) +} + func (r UserAuthInfo) MarshalJSON() ([]byte, error) { type alias UserAuthInfo return json.Marshal(struct { @@ -158,8 +175,9 @@ func (r UserAuthInfo) MarshalJSON() ([]byte, error) { func (r *AccountAllUsers) UnmarshalJSON(data []byte) error { type rawAccountAllUsers struct { - AuthInfo json.RawMessage `json:"authInfo"` - Token *string `json:"token,omitempty"` + AuthInfo json.RawMessage `json:"authInfo"` + SelectionID *string `json:"selectionId,omitempty"` + Token *string `json:"token,omitempty"` } var raw rawAccountAllUsers if err := json.Unmarshal(data, &raw); err != nil { @@ -172,6 +190,7 @@ func (r *AccountAllUsers) UnmarshalJSON(data []byte) error { } r.AuthInfo = value } + r.SelectionID = raw.SelectionID r.Token = raw.Token return nil } @@ -198,7 +217,8 @@ func (r *AccountGetCurrentAuthResult) UnmarshalJSON(data []byte) error { func (r *AccountLogoutRequest) UnmarshalJSON(data []byte) error { type rawAccountLogoutRequest struct { - AuthInfo json.RawMessage `json:"authInfo"` + AuthInfo json.RawMessage `json:"authInfo,omitempty"` + SelectionID *string `json:"selectionId,omitempty"` } var raw rawAccountLogoutRequest if err := json.Unmarshal(data, &raw); err != nil { @@ -211,6 +231,7 @@ func (r *AccountLogoutRequest) UnmarshalJSON(data []byte) error { } r.AuthInfo = value } + r.SelectionID = raw.SelectionID return nil } @@ -595,86 +616,108 @@ func (r AttachmentSelection) MarshalJSON() ([]byte, error) { }) } -func unmarshalQueuedCommandResult(data []byte) (QueuedCommandResult, error) { +func unmarshalBuiltinToolSafeForTelemetry(data []byte) (BuiltinToolSafeForTelemetry, error) { + if string(data) == "null" { + return nil, nil + } + { + var value bool + if err := json.Unmarshal(data, &value); err == nil { + return BuiltinToolSafeForTelemetryBoolean(value), nil + } + } + { + var value BuiltinToolSafeTelemetryFields + if err := json.Unmarshal(data, &value); err == nil { + return &value, nil + } + } + return nil, errors.New("data did not match any union variant for BuiltinToolSafeForTelemetry") +} + +func (r *BuiltinToolDescriptor) UnmarshalJSON(data []byte) error { + type rawBuiltinToolDescriptor struct { + Description string `json:"description"` + Format *BuiltinToolFormat `json:"format"` + HasSummariseIntention bool `json:"hasSummariseIntention"` + InputSchema *BuiltinToolInputSchema `json:"inputSchema"` + Instructions *string `json:"instructions"` + IsTerminal bool `json:"isTerminal"` + Name string `json:"name"` + SafeForTelemetry json.RawMessage `json:"safeForTelemetry"` + Title *string `json:"title"` + Type *string `json:"type"` + } + var raw rawBuiltinToolDescriptor + if err := json.Unmarshal(data, &raw); err != nil { + return err + } + r.Description = raw.Description + r.Format = raw.Format + r.HasSummariseIntention = raw.HasSummariseIntention + r.InputSchema = raw.InputSchema + r.Instructions = raw.Instructions + r.IsTerminal = raw.IsTerminal + r.Name = raw.Name + if raw.SafeForTelemetry != nil { + value, err := unmarshalBuiltinToolSafeForTelemetry(raw.SafeForTelemetry) + if err != nil { + return err + } + r.SafeForTelemetry = value + } + r.Title = raw.Title + r.Type = raw.Type + return nil +} + +func unmarshalCatalogCandidate(data []byte) (CatalogCandidate, error) { if string(data) == "null" { return nil, nil } type rawUnion struct { - Handled *bool `json:"handled"` + Kind CatalogCandidateKind `json:"kind"` } var raw rawUnion 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") - } - switch *raw.Handled { - case false: - var d QueuedCommandNotHandled + switch raw.Kind { + case CatalogCandidateKindAiSkill: + var d CatalogAiSkillCandidate if err := json.Unmarshal(data, &d); err != nil { return nil, err } return &d, nil - case true: - var d QueuedCommandHandled + case CatalogCandidateKindMCPServer: + var d CatalogMCPServerCandidate if err := json.Unmarshal(data, &d); err != nil { return nil, err } return &d, nil + default: + return &RawCatalogCandidateData{Discriminator: raw.Kind, Raw: data}, nil } - 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 +func (r RawCatalogCandidateData) MarshalJSON() ([]byte, error) { + if r.Raw != nil { + return r.Raw, nil + } return json.Marshal(struct { - Handled bool `json:"handled"` - alias + Kind CatalogCandidateKind `json:"kind"` }{ - Handled: r.Handled(), - alias: alias(r), + Kind: r.Discriminator, }) } -func (r *CommandsRespondToQueuedCommandRequest) UnmarshalJSON(data []byte) error { - type rawCommandsRespondToQueuedCommandRequest struct { - RequestID string `json:"requestId"` - Result json.RawMessage `json:"result"` - } - var raw rawCommandsRespondToQueuedCommandRequest - if err := json.Unmarshal(data, &raw); err != nil { - return err - } - r.RequestID = raw.RequestID - if raw.Result != nil { - value, err := unmarshalQueuedCommandResult(raw.Result) - if err != nil { - return err - } - r.Result = value - } - return nil -} - -func unmarshalDebugCollectLogsDestination(data []byte) (DebugCollectLogsDestination, error) { +func unmarshalCatalogCandidateSource(data []byte) (CatalogCandidateSource, error) { if string(data) == "null" { return nil, nil } type rawUnion struct { - Kind DebugCollectLogsDestinationKind `json:"kind"` + Kind CatalogCandidateSourceKind `json:"kind"` } var raw rawUnion if err := json.Unmarshal(data, &raw); err != nil { @@ -682,38 +725,38 @@ func unmarshalDebugCollectLogsDestination(data []byte) (DebugCollectLogsDestinat } switch raw.Kind { - case DebugCollectLogsDestinationKindArchive: - var d DebugCollectLogsDestinationArchive + case CatalogCandidateSourceKindEmbedded: + var d CatalogCandidateSourceEmbedded if err := json.Unmarshal(data, &d); err != nil { return nil, err } return &d, nil - case DebugCollectLogsDestinationKindDirectory: - var d DebugCollectLogsDestinationDirectory + case CatalogCandidateSourceKindURL: + var d CatalogCandidateSourceURL if err := json.Unmarshal(data, &d); err != nil { return nil, err } return &d, nil default: - return &RawDebugCollectLogsDestinationData{Discriminator: raw.Kind, Raw: data}, nil + return &RawCatalogCandidateSourceData{Discriminator: raw.Kind, Raw: data}, nil } } -func (r RawDebugCollectLogsDestinationData) MarshalJSON() ([]byte, error) { +func (r RawCatalogCandidateSourceData) MarshalJSON() ([]byte, error) { if r.Raw != nil { return r.Raw, nil } return json.Marshal(struct { - Kind DebugCollectLogsDestinationKind `json:"kind"` + Kind CatalogCandidateSourceKind `json:"kind"` }{ Kind: r.Discriminator, }) } -func (r DebugCollectLogsDestinationArchive) MarshalJSON() ([]byte, error) { - type alias DebugCollectLogsDestinationArchive +func (r CatalogCandidateSourceEmbedded) MarshalJSON() ([]byte, error) { + type alias CatalogCandidateSourceEmbedded return json.Marshal(struct { - Kind DebugCollectLogsDestinationKind `json:"kind"` + Kind CatalogCandidateSourceKind `json:"kind"` alias }{ Kind: r.Kind(), @@ -721,10 +764,10 @@ func (r DebugCollectLogsDestinationArchive) MarshalJSON() ([]byte, error) { }) } -func (r DebugCollectLogsDestinationDirectory) MarshalJSON() ([]byte, error) { - type alias DebugCollectLogsDestinationDirectory +func (r CatalogCandidateSourceURL) MarshalJSON() ([]byte, error) { + type alias CatalogCandidateSourceURL return json.Marshal(struct { - Kind DebugCollectLogsDestinationKind `json:"kind"` + Kind CatalogCandidateSourceKind `json:"kind"` alias }{ Kind: r.Kind(), @@ -732,768 +775,2116 @@ func (r DebugCollectLogsDestinationDirectory) MarshalJSON() ([]byte, error) { }) } -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"` +func (r *CatalogAiSkillCandidate) UnmarshalJSON(data []byte) error { + type rawCatalogAiSkillCandidate struct { + Description *string `json:"description,omitempty"` + DisplayName string `json:"displayName"` + Handle string `json:"handle"` + HandleExpiresAt string `json:"handleExpiresAt"` + Installability CatalogAiSkillCandidateInstallability `json:"installability"` + MediaType CatalogAiSkillCandidateMediaType `json:"mediaType"` + Provenance CatalogAiSkillCandidateProvenance `json:"provenance"` + Publisher *string `json:"publisher,omitempty"` + Source json.RawMessage `json:"source"` } - var raw rawDebugCollectLogsRequest + var raw rawCatalogAiSkillCandidate if err := json.Unmarshal(data, &raw); err != nil { return err } - r.AdditionalEntries = raw.AdditionalEntries - if raw.Destination != nil { - value, err := unmarshalDebugCollectLogsDestination(raw.Destination) + r.Description = raw.Description + r.DisplayName = raw.DisplayName + r.Handle = raw.Handle + r.HandleExpiresAt = raw.HandleExpiresAt + r.Installability = raw.Installability + r.MediaType = raw.MediaType + r.Provenance = raw.Provenance + r.Publisher = raw.Publisher + if raw.Source != nil { + value, err := unmarshalCatalogCandidateSource(raw.Source) if err != nil { return err } - r.Destination = value + r.Source = value } - r.Include = raw.Include 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 CatalogAiSkillCandidate) MarshalJSON() ([]byte, error) { + type alias CatalogAiSkillCandidate + return json.Marshal(struct { + Kind CatalogCandidateKind `json:"kind"` + alias + }{ + Kind: r.Kind(), + alias: alias(r), + }) } -func (r *EventLogTypes) UnmarshalJSON(data []byte) error { - if string(data) == "null" { - *r = EventLogTypes{} - return nil +func (r *CatalogMCPServerCandidate) UnmarshalJSON(data []byte) error { + type rawCatalogMCPServerCandidate struct { + Description *string `json:"description,omitempty"` + DisplayName string `json:"displayName"` + Handle string `json:"handle"` + HandleExpiresAt string `json:"handleExpiresAt"` + Installability CatalogMCPServerInstallability `json:"installability"` + MediaType MCPServerCardMediaType `json:"mediaType"` + Provenance CatalogMCPServerCandidateProvenance `json:"provenance"` + Publisher *string `json:"publisher,omitempty"` + Source json.RawMessage `json:"source"` } - { - var value EventLogTypesString - if err := json.Unmarshal(data, &value); err == nil { - *r = EventLogTypes{String: &value} - return nil - } + var raw rawCatalogMCPServerCandidate + 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 + r.Description = raw.Description + r.DisplayName = raw.DisplayName + r.Handle = raw.Handle + r.HandleExpiresAt = raw.HandleExpiresAt + r.Installability = raw.Installability + r.MediaType = raw.MediaType + r.Provenance = raw.Provenance + r.Publisher = raw.Publisher + if raw.Source != nil { + value, err := unmarshalCatalogCandidateSource(raw.Source) + if err != nil { + return err } + r.Source = value } - return errors.New("data did not match any union variant for EventLogTypes") + return nil } -func unmarshalExternalToolTextResultForLlmContent(data []byte) (ExternalToolTextResultForLlmContent, error) { +func (r CatalogMCPServerCandidate) MarshalJSON() ([]byte, error) { + type alias CatalogMCPServerCandidate + return json.Marshal(struct { + Kind CatalogCandidateKind `json:"kind"` + alias + }{ + Kind: r.Kind(), + alias: alias(r), + }) +} + +func unmarshalCatalogSearchResult(data []byte) (CatalogSearchResult, error) { if string(data) == "null" { return nil, nil } type rawUnion struct { - Type ExternalToolTextResultForLlmContentType `json:"type"` + Kind CatalogSearchResultKind `json:"kind"` } var raw rawUnion if err := json.Unmarshal(data, &raw); err != nil { return nil, err } - switch raw.Type { - case ExternalToolTextResultForLlmContentTypeAudio: - var d ExternalToolTextResultForLlmContentAudio + switch raw.Kind { + case CatalogSearchResultKindAuthenticationRequired: + var d CatalogAuthenticationRequiredError if err := json.Unmarshal(data, &d); err != nil { return nil, err } return &d, nil - case ExternalToolTextResultForLlmContentTypeImage: - var d ExternalToolTextResultForLlmContentImage + case CatalogSearchResultKindContractViolation: + var d CatalogContractViolationError if err := json.Unmarshal(data, &d); err != nil { return nil, err } return &d, nil - case ExternalToolTextResultForLlmContentTypeResource: - var d ExternalToolTextResultForLlmContentResource + case CatalogSearchResultKindInvalidRequest: + var d CatalogInvalidRequestError if err := json.Unmarshal(data, &d); err != nil { return nil, err } return &d, nil - case ExternalToolTextResultForLlmContentTypeResourceLink: - var d ExternalToolTextResultForLlmContentResourceLink + case CatalogSearchResultKindMalformedCard: + var d CatalogMalformedCardError if err := json.Unmarshal(data, &d); err != nil { return nil, err } return &d, nil - case ExternalToolTextResultForLlmContentTypeShellExit: - var d ExternalToolTextResultForLlmContentShellExit + case CatalogSearchResultKindNegotiationRefused: + var d CatalogNegotiationRefusedError if err := json.Unmarshal(data, &d); err != nil { return nil, err } return &d, nil - case ExternalToolTextResultForLlmContentTypeTerminal: - var d ExternalToolTextResultForLlmContentTerminal + case CatalogSearchResultKindNetworkFailure: + var d CatalogNetworkFailureError if err := json.Unmarshal(data, &d); err != nil { return nil, err } return &d, nil - case ExternalToolTextResultForLlmContentTypeText: - var d ExternalToolTextResultForLlmContentText + case CatalogSearchResultKindPolicyRejected: + var d CatalogPolicyRejectedError + if err := json.Unmarshal(data, &d); err != nil { + return nil, err + } + return &d, nil + case CatalogSearchResultKindSucceeded: + var d CatalogSearchSucceeded + if err := json.Unmarshal(data, &d); err != nil { + return nil, err + } + return &d, nil + case CatalogSearchResultKindUnavailable: + var d CatalogUnavailableError + if err := json.Unmarshal(data, &d); err != nil { + return nil, err + } + return &d, nil + case CatalogSearchResultKindUnsafeRetrieval: + var d CatalogUnsafeRetrievalError + if err := json.Unmarshal(data, &d); err != nil { + return nil, err + } + return &d, nil + case CatalogSearchResultKindUnsupportedKind: + var d CatalogUnsupportedKindError if err := json.Unmarshal(data, &d); err != nil { return nil, err } return &d, nil default: - return &RawExternalToolTextResultForLlmContentData{Discriminator: raw.Type, Raw: data}, nil + return &RawCatalogSearchResultData{Discriminator: raw.Kind, Raw: data}, nil } } -func (r RawExternalToolTextResultForLlmContentData) MarshalJSON() ([]byte, error) { +func (r RawCatalogSearchResultData) MarshalJSON() ([]byte, error) { if r.Raw != nil { return r.Raw, nil } return json.Marshal(struct { - Type ExternalToolTextResultForLlmContentType `json:"type"` + Kind CatalogSearchResultKind `json:"kind"` }{ - Type: r.Discriminator, + Kind: r.Discriminator, }) } -func (r ExternalToolTextResultForLlmContentAudio) MarshalJSON() ([]byte, error) { - type alias ExternalToolTextResultForLlmContentAudio +func (r CatalogAuthenticationRequiredError) MarshalJSON() ([]byte, error) { + type alias CatalogAuthenticationRequiredError return json.Marshal(struct { - Type ExternalToolTextResultForLlmContentType `json:"type"` + Kind CatalogSearchResultKind `json:"kind"` alias }{ - Type: r.Type(), + Kind: r.Kind(), alias: alias(r), }) } -func (r ExternalToolTextResultForLlmContentImage) MarshalJSON() ([]byte, error) { - type alias ExternalToolTextResultForLlmContentImage +func (r CatalogContractViolationError) MarshalJSON() ([]byte, error) { + type alias CatalogContractViolationError return json.Marshal(struct { - Type ExternalToolTextResultForLlmContentType `json:"type"` + Kind CatalogSearchResultKind `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 CatalogInvalidRequestError) MarshalJSON() ([]byte, error) { + type alias CatalogInvalidRequestError + return json.Marshal(struct { + Kind CatalogSearchResultKind `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 CatalogMalformedCardError) MarshalJSON() ([]byte, error) { + type alias CatalogMalformedCardError + return json.Marshal(struct { + Kind CatalogSearchResultKind `json:"kind"` + alias + }{ + Kind: r.Kind(), + alias: alias(r), + }) } -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 - } - return &d, 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 CatalogNegotiationRefusedError) MarshalJSON() ([]byte, error) { + type alias CatalogNegotiationRefusedError + return json.Marshal(struct { + Kind CatalogSearchResultKind `json:"kind"` + alias + }{ + Kind: r.Kind(), + alias: alias(r), + }) } -func (r RawExternalToolTextResultForLlmContentResourceDetailsData) MarshalJSON() ([]byte, error) { - if r.Raw != nil { - return r.Raw, nil - } - return []byte("null"), nil +func (r CatalogNetworkFailureError) MarshalJSON() ([]byte, error) { + type alias CatalogNetworkFailureError + return json.Marshal(struct { + Kind CatalogSearchResultKind `json:"kind"` + alias + }{ + Kind: r.Kind(), + alias: alias(r), + }) } -func (r *ExternalToolTextResultForLlmContentResource) UnmarshalJSON(data []byte) error { - type rawExternalToolTextResultForLlmContentResource struct { - Resource json.RawMessage `json:"resource"` +func (r CatalogPolicyRejectedError) MarshalJSON() ([]byte, error) { + type alias CatalogPolicyRejectedError + return json.Marshal(struct { + Kind CatalogSearchResultKind `json:"kind"` + alias + }{ + Kind: r.Kind(), + alias: alias(r), + }) +} + +func (r *CatalogSearchSucceeded) UnmarshalJSON(data []byte) error { + type rawCatalogSearchSucceeded struct { + Candidates []json.RawMessage `json:"candidates"` + Negotiated CatalogNegotiatedContract `json:"negotiated"` + SearchID string `json:"searchId"` + Truncated bool `json:"truncated"` } - var raw rawExternalToolTextResultForLlmContentResource + var raw rawCatalogSearchSucceeded if err := json.Unmarshal(data, &raw); err != nil { return err } - if raw.Resource != nil { - value, err := unmarshalExternalToolTextResultForLlmContentResourceDetails(raw.Resource) - if err != nil { - return err + if raw.Candidates != nil { + r.Candidates = make([]CatalogCandidate, 0, len(raw.Candidates)) + for _, rawItem := range raw.Candidates { + value, err := unmarshalCatalogCandidate(rawItem) + if err != nil { + return err + } + r.Candidates = append(r.Candidates, value) } - r.Resource = value } + r.Negotiated = raw.Negotiated + r.SearchID = raw.SearchID + r.Truncated = raw.Truncated return nil } -func (r ExternalToolTextResultForLlmContentResource) MarshalJSON() ([]byte, error) { - type alias ExternalToolTextResultForLlmContentResource +func (r CatalogSearchSucceeded) MarshalJSON() ([]byte, error) { + type alias CatalogSearchSucceeded return json.Marshal(struct { - Type ExternalToolTextResultForLlmContentType `json:"type"` + Kind CatalogSearchResultKind `json:"kind"` alias }{ - Type: r.Type(), + Kind: r.Kind(), alias: alias(r), }) } -func (r ExternalToolTextResultForLlmContentResourceLink) MarshalJSON() ([]byte, error) { - type alias ExternalToolTextResultForLlmContentResourceLink +func (r CatalogUnavailableError) MarshalJSON() ([]byte, error) { + type alias CatalogUnavailableError return json.Marshal(struct { - Type ExternalToolTextResultForLlmContentType `json:"type"` + Kind CatalogSearchResultKind `json:"kind"` alias }{ - Type: r.Type(), + Kind: r.Kind(), alias: alias(r), }) } -func (r ExternalToolTextResultForLlmContentShellExit) MarshalJSON() ([]byte, error) { - type alias ExternalToolTextResultForLlmContentShellExit +func (r CatalogUnsafeRetrievalError) MarshalJSON() ([]byte, error) { + type alias CatalogUnsafeRetrievalError return json.Marshal(struct { - Type ExternalToolTextResultForLlmContentType `json:"type"` + Kind CatalogSearchResultKind `json:"kind"` alias }{ - Type: r.Type(), + Kind: r.Kind(), alias: alias(r), }) } -func (r ExternalToolTextResultForLlmContentTerminal) MarshalJSON() ([]byte, error) { - type alias ExternalToolTextResultForLlmContentTerminal +func (r CatalogUnsupportedKindError) MarshalJSON() ([]byte, error) { + type alias CatalogUnsupportedKindError return json.Marshal(struct { - Type ExternalToolTextResultForLlmContentType `json:"type"` + Kind CatalogSearchResultKind `json:"kind"` alias }{ - Type: r.Type(), + Kind: r.Kind(), alias: alias(r), }) } -func (r ExternalToolTextResultForLlmContentText) MarshalJSON() ([]byte, error) { - type alias ExternalToolTextResultForLlmContentText +func unmarshalQueuedCommandResult(data []byte) (QueuedCommandResult, error) { + if string(data) == "null" { + return nil, nil + } + type rawUnion struct { + Handled *bool `json:"handled"` + } + var raw rawUnion + 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") + } + + 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 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 { - Type ExternalToolTextResultForLlmContentType `json:"type"` + Handled bool `json:"handled"` alias }{ - Type: r.Type(), - alias: alias(r), + Handled: r.Handled(), + 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"` +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"` } - var raw rawExternalToolTextResultForLlm + var raw rawCommandsRespondToQueuedCommandRequest 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.RequestID = raw.RequestID + if raw.Result != nil { + value, err := unmarshalQueuedCommandResult(raw.Result) + if err != nil { + return err } + r.Result = 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 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 unmarshalFactoryRunFailure(data []byte) (FactoryRunFailure, error) { +func unmarshalDebugCollectLogsDestination(data []byte) (DebugCollectLogsDestination, error) { if string(data) == "null" { return nil, nil } type rawUnion struct { - Type FactoryRunFailureType `json:"type"` + Kind DebugCollectLogsDestinationKind `json:"kind"` } var raw rawUnion if err := json.Unmarshal(data, &raw); err != nil { return nil, err } - switch raw.Type { - case FactoryRunFailureTypeFactoryLimitReached: - var d FactoryRunFailureFactoryLimitReached + switch raw.Kind { + case DebugCollectLogsDestinationKindArchive: + var d DebugCollectLogsDestinationArchive if err := json.Unmarshal(data, &d); err != nil { return nil, err } return &d, nil - case FactoryRunFailureTypeFactoryResumeDeclined: - var d FactoryRunFailureFactoryResumeDeclined + case DebugCollectLogsDestinationKindDirectory: + var d DebugCollectLogsDestinationDirectory if err := json.Unmarshal(data, &d); err != nil { return nil, err } return &d, nil default: - return &RawFactoryRunFailureData{Discriminator: raw.Type, Raw: data}, nil + return &RawDebugCollectLogsDestinationData{Discriminator: raw.Kind, Raw: data}, nil } } -func (r RawFactoryRunFailureData) MarshalJSON() ([]byte, error) { +func (r RawDebugCollectLogsDestinationData) MarshalJSON() ([]byte, error) { if r.Raw != nil { return r.Raw, nil } return json.Marshal(struct { - Type FactoryRunFailureType `json:"type"` + Kind DebugCollectLogsDestinationKind `json:"kind"` }{ - Type: r.Discriminator, + Kind: r.Discriminator, }) } -func (r FactoryRunFailureFactoryLimitReached) MarshalJSON() ([]byte, error) { - type alias FactoryRunFailureFactoryLimitReached +func (r DebugCollectLogsDestinationArchive) MarshalJSON() ([]byte, error) { + type alias DebugCollectLogsDestinationArchive return json.Marshal(struct { - Type FactoryRunFailureType `json:"type"` + Kind DebugCollectLogsDestinationKind `json:"kind"` alias }{ - Type: r.Type(), + Kind: r.Kind(), alias: alias(r), }) } -func (r FactoryRunFailureFactoryResumeDeclined) MarshalJSON() ([]byte, error) { - type alias FactoryRunFailureFactoryResumeDeclined +func (r DebugCollectLogsDestinationDirectory) MarshalJSON() ([]byte, error) { + type alias DebugCollectLogsDestinationDirectory return json.Marshal(struct { - Type FactoryRunFailureType `json:"type"` + Kind DebugCollectLogsDestinationKind `json:"kind"` alias }{ - Type: r.Type(), + Kind: r.Kind(), alias: alias(r), }) } -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"` +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 rawFactoryRunResult + var raw rawDebugCollectLogsRequest if err := json.Unmarshal(data, &raw); err != nil { return err } - r.Error = raw.Error - if raw.Failure != nil { - value, err := unmarshalFactoryRunFailure(raw.Failure) + r.AdditionalEntries = raw.AdditionalEntries + if raw.Destination != nil { + value, err := unmarshalDebugCollectLogsDestination(raw.Destination) if err != nil { return err } - r.Failure = value + r.Destination = value } - r.Reason = raw.Reason - r.Result = raw.Result - r.RunID = raw.RunID - r.Snapshot = raw.Snapshot - r.Status = raw.Status + r.Include = raw.Include return nil } -func unmarshalFilterMapping(data []byte) (FilterMapping, error) { - if string(data) == "null" { - return nil, nil +func (r EventLogTypes) MarshalJSON() ([]byte, error) { + if r.String != nil { + return json.Marshal(r.String) } - { - 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) + if r.StringArray != nil { + return json.Marshal(r.StringArray) } return []byte("null"), nil } -func (r *InstalledPluginSource) UnmarshalJSON(data []byte) error { +func (r *EventLogTypes) UnmarshalJSON(data []byte) error { if string(data) == "null" { - *r = InstalledPluginSource{} + *r = EventLogTypes{} return nil } { - var value InstalledPluginSourceGitHub + var value EventLogTypesString if err := json.Unmarshal(data, &value); err == nil { - *r = InstalledPluginSource{InstalledPluginSourceGitHub: &value} + *r = EventLogTypes{String: &value} return nil } } { - var value InstalledPluginSourceLocal + var value []string if err := json.Unmarshal(data, &value); err == nil { - *r = InstalledPluginSource{InstalledPluginSourceLocal: &value} + *r = EventLogTypes{StringArray: value} return nil } } - { - var value InstalledPluginSourceURL - if err := json.Unmarshal(data, &value); err == nil { - *r = InstalledPluginSource{InstalledPluginSourceURL: &value} - return nil - } + 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 } - { - var value string - if err := json.Unmarshal(data, &value); err == nil { - *r = InstalledPluginSource{String: &value} - return 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 + } + 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 } - return errors.New("data did not match any union variant for InstalledPluginSource") } -func matchesMCPServerConfigHTTP(data []byte) bool { +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 matchesExternalToolTextResultForLlmContentResourceDetailsEmbeddedBlobResourceContents(data []byte) bool { var rawGroup0 struct { - Command json.RawMessage `json:"command"` - URL json.RawMessage `json:"url"` + Blob json.RawMessage `json:"blob"` + Text json.RawMessage `json:"text"` } if err := json.Unmarshal(data, &rawGroup0); err != nil { return false } - if rawGroup0.URL == nil { + if rawGroup0.Blob == nil { return false } - return rawGroup0.Command == nil + return rawGroup0.Text == nil } -func matchesMCPServerConfigStdio(data []byte) bool { +func matchesExternalToolTextResultForLlmContentResourceDetailsEmbeddedTextResourceContents(data []byte) bool { var rawGroup0 struct { - Command json.RawMessage `json:"command"` - URL json.RawMessage `json:"url"` + Blob json.RawMessage `json:"blob"` + Text json.RawMessage `json:"text"` } if err := json.Unmarshal(data, &rawGroup0); err != nil { return false } - if rawGroup0.Command == nil { + if rawGroup0.Text == nil { return false } - return rawGroup0.URL == nil + return rawGroup0.Blob == nil } -func unmarshalMCPServerConfig(data []byte) (MCPServerConfig, error) { +func unmarshalExternalToolTextResultForLlmContentResourceDetails(data []byte) (ExternalToolTextResultForLlmContentResourceDetails, error) { if string(data) == "null" { return nil, nil } - if matchesMCPServerConfigHTTP(data) { - var d MCPServerConfigHTTP + if matchesExternalToolTextResultForLlmContentResourceDetailsEmbeddedBlobResourceContents(data) { + var d EmbeddedBlobResourceContents if err := json.Unmarshal(data, &d); err != nil { return nil, err } return &d, nil } - if matchesMCPServerConfigStdio(data) { - var d MCPServerConfigStdio + if matchesExternalToolTextResultForLlmContentResourceDetailsEmbeddedTextResourceContents(data) { + var d EmbeddedTextResourceContents if err := json.Unmarshal(data, &d); err != nil { return nil, err } return &d, nil } - return &RawMCPServerConfigData{Raw: data}, nil + return &RawExternalToolTextResultForLlmContentResourceDetailsData{Raw: data}, nil } -func (r RawMCPServerConfigData) MarshalJSON() ([]byte, error) { +func (r RawExternalToolTextResultForLlmContentResourceDetailsData) 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"` - 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"` +func (r *ExternalToolTextResultForLlmContentResource) UnmarshalJSON(data []byte) error { + type rawExternalToolTextResultForLlmContentResource struct { + Resource json.RawMessage `json:"resource"` } - var raw rawMCPServerConfigHTTP + var raw rawExternalToolTextResultForLlmContentResource 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 - 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 raw.Resource != nil { + value, err := unmarshalExternalToolTextResultForLlmContentResourceDetails(raw.Resource) if err != nil { return err } - r.Oidc = value + r.Resource = 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"` - 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"` +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 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.ToolReferences = raw.ToolReferences + r.ToolTelemetry = raw.ToolTelemetry + return nil +} + +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 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 unmarshalGitHubTokenAcquireResult(data []byte) (GitHubTokenAcquireResult, error) { + if string(data) == "null" { + return nil, nil + } + type rawUnion struct { + Kind GitHubTokenAcquireResultKind `json:"kind"` + } + var raw rawUnion + if err := json.Unmarshal(data, &raw); err != nil { + return nil, err + } + + switch raw.Kind { + case GitHubTokenAcquireResultKindCancelled: + var d GitHubTokenAcquireResultCancelled + if err := json.Unmarshal(data, &d); err != nil { + return nil, err + } + return &d, nil + case GitHubTokenAcquireResultKindToken: + var d GitHubTokenAcquireResultToken + if err := json.Unmarshal(data, &d); err != nil { + return nil, err + } + return &d, nil + default: + return &RawGitHubTokenAcquireResultData{Discriminator: raw.Kind, Raw: data}, nil + } +} + +func (r RawGitHubTokenAcquireResultData) MarshalJSON() ([]byte, error) { + if r.Raw != nil { + return r.Raw, nil + } + return json.Marshal(struct { + Kind GitHubTokenAcquireResultKind `json:"kind"` + }{ + Kind: r.Discriminator, + }) +} + +func (r GitHubTokenAcquireResultCancelled) MarshalJSON() ([]byte, error) { + type alias GitHubTokenAcquireResultCancelled + return json.Marshal(struct { + Kind GitHubTokenAcquireResultKind `json:"kind"` + alias + }{ + Kind: r.Kind(), + alias: alias(r), + }) +} + +func (r GitHubTokenAcquireResultToken) MarshalJSON() ([]byte, error) { + type alias GitHubTokenAcquireResultToken + return json.Marshal(struct { + Kind GitHubTokenAcquireResultKind `json:"kind"` + alias + }{ + Kind: r.Kind(), + 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 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 matchesMCPSerializableServerConfigMCPServerConfigHTTP(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 matchesMCPSerializableServerConfigMCPServerConfigStdio(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 unmarshalMCPSerializableServerConfig(data []byte) (MCPSerializableServerConfig, error) { + if string(data) == "null" { + return nil, nil + } + if matchesMCPSerializableServerConfigMCPServerConfigHTTP(data) { + var d MCPServerConfigHTTP + if err := json.Unmarshal(data, &d); err != nil { + return nil, err + } + return &d, nil + } + if matchesMCPSerializableServerConfigMCPServerConfigStdio(data) { + var d MCPServerConfigStdio + if err := json.Unmarshal(data, &d); err != nil { + return nil, err + } + return &d, nil + } + return &RawMCPSerializableServerConfigData{Raw: data}, nil +} + +func (r RawMCPSerializableServerConfigData) 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 unmarshalMCPSafeForTelemetry(data []byte) (MCPSafeForTelemetry, error) { + if string(data) == "null" { + return nil, nil + } + { + var value bool + if err := json.Unmarshal(data, &value); err == nil { + return MCPSafeForTelemetryBoolean(value), nil + } + } + { + var value MCPSafeForTelemetryFields + if err := json.Unmarshal(data, &value); err == nil { + return &value, nil + } + } + return nil, errors.New("data did not match any union variant for MCPSafeForTelemetry") +} + +func (r *MCPServerConfigHTTP) UnmarshalJSON(data []byte) error { + type rawMCPServerConfigHTTP struct { + Auth json.RawMessage `json:"auth,omitempty"` + ConfigWarnings []string `json:"configWarnings,omitzero"` + DeferTools *MCPServerConfigDeferTools `json:"deferTools,omitempty"` + DisableSecretMasking *bool `json:"disableSecretMasking,omitempty"` + DisableToolCache *bool `json:"disableToolCache,omitempty"` + DisplayName *string `json:"displayName,omitempty"` + Events []string `json:"events,omitzero"` + ExcludeTools []string `json:"excludeTools,omitzero"` + FilterMapping json.RawMessage `json:"filterMapping,omitempty"` + Headers map[string]string `json:"headers,omitzero"` + HeadersRefreshTtlMs *int64 `json:"headersRefreshTtlMs,omitempty"` + IsDefaultServer *bool `json:"isDefaultServer,omitempty"` + Notifications []string `json:"notifications,omitzero"` + OauthClientID *string `json:"oauthClientId,omitempty"` + OauthGrantType *MCPServerConfigHTTPOauthGrantType `json:"oauthGrantType,omitempty"` + OauthPublicClient *bool `json:"oauthPublicClient,omitempty"` + Oidc json.RawMessage `json:"oidc,omitempty"` + SafeForTelemetry json.RawMessage `json:"safeForTelemetry,omitempty"` + Source *MCPServerSource `json:"source,omitempty"` + SourcePath *string `json:"sourcePath,omitempty"` + SourcePlugin *string `json:"sourcePlugin,omitempty"` + SourcePluginSpec *bool `json:"sourcePluginSpec,omitempty"` + SourcePluginVersion *string `json:"sourcePluginVersion,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.ConfigWarnings = raw.ConfigWarnings + r.DeferTools = raw.DeferTools + r.DisableSecretMasking = raw.DisableSecretMasking + r.DisableToolCache = raw.DisableToolCache + r.DisplayName = raw.DisplayName + r.Events = raw.Events + r.ExcludeTools = raw.ExcludeTools + if raw.FilterMapping != nil { + value, err := unmarshalFilterMapping(raw.FilterMapping) + if err != nil { + return err + } + r.FilterMapping = value + } + r.Headers = raw.Headers + r.HeadersRefreshTtlMs = raw.HeadersRefreshTtlMs + r.IsDefaultServer = raw.IsDefaultServer + r.Notifications = raw.Notifications + 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 raw.SafeForTelemetry != nil { + value, err := unmarshalMCPSafeForTelemetry(raw.SafeForTelemetry) + if err != nil { + return err + } + r.SafeForTelemetry = value + } + r.Source = raw.Source + r.SourcePath = raw.SourcePath + r.SourcePlugin = raw.SourcePlugin + r.SourcePluginSpec = raw.SourcePluginSpec + r.SourcePluginVersion = raw.SourcePluginVersion + 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"` + ConfigWarnings []string `json:"configWarnings,omitzero"` + Cwd *string `json:"cwd,omitempty"` + DeferTools *MCPServerConfigDeferTools `json:"deferTools,omitempty"` + DisableSecretMasking *bool `json:"disableSecretMasking,omitempty"` + DisableToolCache *bool `json:"disableToolCache,omitempty"` + DisplayName *string `json:"displayName,omitempty"` + Env map[string]string `json:"env,omitzero"` + Events []string `json:"events,omitzero"` + ExcludeTools []string `json:"excludeTools,omitzero"` + FilterMapping json.RawMessage `json:"filterMapping,omitempty"` + IsDefaultServer *bool `json:"isDefaultServer,omitempty"` + Notifications []string `json:"notifications,omitzero"` + Oidc json.RawMessage `json:"oidc,omitempty"` + SafeForTelemetry json.RawMessage `json:"safeForTelemetry,omitempty"` + Source *MCPServerSource `json:"source,omitempty"` + SourcePath *string `json:"sourcePath,omitempty"` + SourcePlugin *string `json:"sourcePlugin,omitempty"` + SourcePluginSpec *bool `json:"sourcePluginSpec,omitempty"` + SourcePluginVersion *string `json:"sourcePluginVersion,omitempty"` + Timeout *int64 `json:"timeout,omitempty"` + Tools []string `json:"tools,omitzero"` + Type *MCPServerConfigStdioType `json:"type,omitempty"` + } + 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.ConfigWarnings = raw.ConfigWarnings + r.Cwd = raw.Cwd + r.DeferTools = raw.DeferTools + r.DisableSecretMasking = raw.DisableSecretMasking + r.DisableToolCache = raw.DisableToolCache + r.DisplayName = raw.DisplayName + r.Env = raw.Env + r.Events = raw.Events + r.ExcludeTools = raw.ExcludeTools + if raw.FilterMapping != nil { + value, err := unmarshalFilterMapping(raw.FilterMapping) + if err != nil { + return err + } + r.FilterMapping = value + } + r.IsDefaultServer = raw.IsDefaultServer + r.Notifications = raw.Notifications + if raw.Oidc != nil { + value, err := unmarshalMCPServerAuthConfig(raw.Oidc) + if err != nil { + return err + } + r.Oidc = value + } + if raw.SafeForTelemetry != nil { + value, err := unmarshalMCPSafeForTelemetry(raw.SafeForTelemetry) + if err != nil { + return err + } + r.SafeForTelemetry = value + } + r.Source = raw.Source + r.SourcePath = raw.SourcePath + r.SourcePlugin = raw.SourcePlugin + r.SourcePluginSpec = raw.SourcePluginSpec + r.SourcePluginVersion = raw.SourcePluginVersion + r.Timeout = raw.Timeout + r.Tools = raw.Tools + r.Type = raw.Type + 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 := unmarshalMCPSerializableServerConfig(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]MCPSerializableServerConfig, len(raw.Servers)) + for key, rawValue := range raw.Servers { + value, err := unmarshalMCPSerializableServerConfig(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 := unmarshalMCPSerializableServerConfig(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 unmarshalMCPPlanTransportChoice(data []byte) (MCPPlanTransportChoice, error) { + if string(data) == "null" { + return nil, nil + } + type rawUnion struct { + Transport MCPPlanTransportChoiceTransport `json:"transport"` + } + var raw rawUnion + if err := json.Unmarshal(data, &raw); err != nil { + return nil, err + } + + switch raw.Transport { + case MCPPlanTransportChoiceTransportHTTP: + var d MCPPlanTransportChoiceRemote + if err := json.Unmarshal(data, &d); err != nil { + return nil, err + } + return &d, nil + case MCPPlanTransportChoiceTransportSSE: + var d MCPPlanTransportChoiceRemote + if err := json.Unmarshal(data, &d); err != nil { + return nil, err + } + return &d, nil + case MCPPlanTransportChoiceTransportStdio: + var d MCPPlanTransportChoicePackage + if err := json.Unmarshal(data, &d); err != nil { + return nil, err + } + return &d, nil + case MCPPlanTransportChoiceTransportStreamableHTTP: + var d MCPPlanTransportChoiceRemote + if err := json.Unmarshal(data, &d); err != nil { + return nil, err + } + return &d, nil + default: + return &RawMCPPlanTransportChoiceData{Discriminator: raw.Transport, Raw: data}, nil + } +} + +func (r RawMCPPlanTransportChoiceData) MarshalJSON() ([]byte, error) { + if r.Raw != nil { + return r.Raw, nil + } + return json.Marshal(struct { + Transport MCPPlanTransportChoiceTransport `json:"transport"` + }{ + Transport: r.Discriminator, + }) +} + +func unmarshalMCPPlanRequiredValue(data []byte) (MCPPlanRequiredValue, error) { + if string(data) == "null" { + return nil, nil + } + type rawUnion struct { + Kind MCPPlanRequiredValueKind `json:"kind"` + } + var raw rawUnion + if err := json.Unmarshal(data, &raw); err != nil { + return nil, err + } + + switch raw.Kind { + case MCPPlanRequiredValueKindEnum: + var d MCPPlanRequiredValueEnum + if err := json.Unmarshal(data, &d); err != nil { + return nil, err + } + return &d, nil + case MCPPlanRequiredValueKindScalar: + var d MCPPlanRequiredValueScalar + if err := json.Unmarshal(data, &d); err != nil { + return nil, err + } + return &d, nil + default: + return &RawMCPPlanRequiredValueData{Discriminator: raw.Kind, Raw: data}, nil + } +} + +func (r RawMCPPlanRequiredValueData) MarshalJSON() ([]byte, error) { + if r.Raw != nil { + return r.Raw, nil + } + return json.Marshal(struct { + Kind MCPPlanRequiredValueKind `json:"kind"` + }{ + Kind: r.Discriminator, + }) +} + +func (r MCPPlanRequiredValueEnum) MarshalJSON() ([]byte, error) { + type alias MCPPlanRequiredValueEnum + return json.Marshal(struct { + Kind MCPPlanRequiredValueKind `json:"kind"` + alias + }{ + Kind: r.Kind(), + alias: alias(r), + }) +} + +func (r MCPPlanRequiredValueScalar) MarshalJSON() ([]byte, error) { + type alias MCPPlanRequiredValueScalar + return json.Marshal(struct { + Kind MCPPlanRequiredValueKind `json:"kind"` + alias + }{ + Kind: r.Kind(), + alias: alias(r), + }) +} + +func (r *MCPPlanTransportChoicePackage) UnmarshalJSON(data []byte) error { + type rawMCPPlanTransportChoicePackage struct { + ChoiceID string `json:"choiceId"` + InstallMethod MCPPlanPackageInstallMethod `json:"installMethod"` + PackageIdentifier string `json:"packageIdentifier"` + PackageType string `json:"packageType"` + RequiredValues []json.RawMessage `json:"requiredValues"` + SecretPlaceholders []MCPPlanSecretPlaceholder `json:"secretPlaceholders"` + } + var raw rawMCPPlanTransportChoicePackage + if err := json.Unmarshal(data, &raw); err != nil { + return err + } + r.ChoiceID = raw.ChoiceID + r.InstallMethod = raw.InstallMethod + r.PackageIdentifier = raw.PackageIdentifier + r.PackageType = raw.PackageType + if raw.RequiredValues != nil { + r.RequiredValues = make([]MCPPlanRequiredValue, 0, len(raw.RequiredValues)) + for _, rawItem := range raw.RequiredValues { + value, err := unmarshalMCPPlanRequiredValue(rawItem) + if err != nil { + return err + } + r.RequiredValues = append(r.RequiredValues, value) + } + } + r.SecretPlaceholders = raw.SecretPlaceholders + return nil +} + +func (r MCPPlanTransportChoicePackage) MarshalJSON() ([]byte, error) { + type alias MCPPlanTransportChoicePackage + return json.Marshal(struct { + Transport MCPPlanTransportChoiceTransport `json:"transport"` + alias + }{ + Transport: r.Transport(), + alias: alias(r), + }) +} + +func (r *MCPPlanTransportChoiceRemote) UnmarshalJSON(data []byte) error { + type rawMCPPlanTransportChoiceRemote struct { + ChoiceID string `json:"choiceId"` + Endpoint string `json:"endpoint"` + InstallMethod MCPPlanRemoteInstallMethod `json:"installMethod"` + RequiredValues []json.RawMessage `json:"requiredValues"` + SecretPlaceholders []MCPPlanSecretPlaceholder `json:"secretPlaceholders"` + Discriminator MCPPlanRemoteTransport `json:"transport,omitempty"` + } + var raw rawMCPPlanTransportChoiceRemote + if err := json.Unmarshal(data, &raw); err != nil { + return err + } + r.ChoiceID = raw.ChoiceID + r.Endpoint = raw.Endpoint + r.InstallMethod = raw.InstallMethod + if raw.RequiredValues != nil { + r.RequiredValues = make([]MCPPlanRequiredValue, 0, len(raw.RequiredValues)) + for _, rawItem := range raw.RequiredValues { + value, err := unmarshalMCPPlanRequiredValue(rawItem) + if err != nil { + return err + } + r.RequiredValues = append(r.RequiredValues, value) + } + } + r.SecretPlaceholders = raw.SecretPlaceholders + r.Discriminator = raw.Discriminator + return nil +} + +func (r MCPPlanTransportChoiceRemote) MarshalJSON() ([]byte, error) { + type alias MCPPlanTransportChoiceRemote + return json.Marshal(struct { + Transport MCPPlanTransportChoiceTransport `json:"transport"` + alias + }{ + Transport: r.Transport(), + alias: alias(r), + }) +} + +func (r *MCPInstallPlan) UnmarshalJSON(data []byte) error { + type rawMCPInstallPlan struct { + ConfigurationChanges []MCPPlanConfigurationChange `json:"configurationChanges"` + Identity MCPPlanResourceIdentity `json:"identity"` + PlanHandle string `json:"planHandle"` + PlanHandleExpiresAt string `json:"planHandleExpiresAt"` + Policy MCPPlanPolicyResult `json:"policy"` + Provenance MCPPlanProvenance `json:"provenance"` + RecommendedTransportChoiceID *string `json:"recommendedTransportChoiceId,omitempty"` + ReloadRequired bool `json:"reloadRequired"` + RequiresInteractiveConfiguration bool `json:"requiresInteractiveConfiguration"` + Target MCPPlanTarget `json:"target"` + TransportChoices []json.RawMessage `json:"transportChoices"` + } + var raw rawMCPInstallPlan + if err := json.Unmarshal(data, &raw); err != nil { + return err + } + r.ConfigurationChanges = raw.ConfigurationChanges + r.Identity = raw.Identity + r.PlanHandle = raw.PlanHandle + r.PlanHandleExpiresAt = raw.PlanHandleExpiresAt + r.Policy = raw.Policy + r.Provenance = raw.Provenance + r.RecommendedTransportChoiceID = raw.RecommendedTransportChoiceID + r.ReloadRequired = raw.ReloadRequired + r.RequiresInteractiveConfiguration = raw.RequiresInteractiveConfiguration + r.Target = raw.Target + if raw.TransportChoices != nil { + r.TransportChoices = make([]MCPPlanTransportChoice, 0, len(raw.TransportChoices)) + for _, rawItem := range raw.TransportChoices { + value, err := unmarshalMCPPlanTransportChoice(rawItem) + if err != nil { + return err + } + r.TransportChoices = append(r.TransportChoices, 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 unmarshalMCPOauthProbeResult(data []byte) (MCPOauthProbeResult, error) { + if string(data) == "null" { + return nil, nil + } + type rawUnion struct { + Status MCPOauthProbeResultStatus `json:"status"` + } + var raw rawUnion + if err := json.Unmarshal(data, &raw); err != nil { + return nil, err + } + + switch raw.Status { + case MCPOauthProbeResultStatusAuthenticated: + var d MCPOauthProbeResultAuthenticated + if err := json.Unmarshal(data, &d); err != nil { + return nil, err + } + return &d, nil + case MCPOauthProbeResultStatusFailed: + var d MCPOauthProbeResultFailed + if err := json.Unmarshal(data, &d); err != nil { + return nil, err + } + return &d, nil + case MCPOauthProbeResultStatusNeedsAuth: + var d MCPOauthProbeResultNeedsAuth + if err := json.Unmarshal(data, &d); err != nil { + return nil, err + } + return &d, nil + case MCPOauthProbeResultStatusNoAuthRequired: + var d MCPOauthProbeResultNoAuthRequired + if err := json.Unmarshal(data, &d); err != nil { + return nil, err + } + return &d, nil + default: + return &RawMCPOauthProbeResultData{Discriminator: raw.Status, Raw: data}, nil + } +} + +func (r RawMCPOauthProbeResultData) MarshalJSON() ([]byte, error) { + if r.Raw != nil { + return r.Raw, nil + } + return json.Marshal(struct { + Status MCPOauthProbeResultStatus `json:"status"` + }{ + Status: r.Discriminator, + }) +} + +func (r MCPOauthProbeResultAuthenticated) MarshalJSON() ([]byte, error) { + type alias MCPOauthProbeResultAuthenticated + return json.Marshal(struct { + Status MCPOauthProbeResultStatus `json:"status"` + alias + }{ + Status: r.Status(), + alias: alias(r), + }) +} + +func (r MCPOauthProbeResultFailed) MarshalJSON() ([]byte, error) { + type alias MCPOauthProbeResultFailed + return json.Marshal(struct { + Status MCPOauthProbeResultStatus `json:"status"` + alias + }{ + Status: r.Status(), + alias: alias(r), + }) +} + +func (r MCPOauthProbeResultNeedsAuth) MarshalJSON() ([]byte, error) { + type alias MCPOauthProbeResultNeedsAuth + return json.Marshal(struct { + Status MCPOauthProbeResultStatus `json:"status"` + alias + }{ + Status: r.Status(), + alias: alias(r), + }) +} + +func (r MCPOauthProbeResultNoAuthRequired) MarshalJSON() ([]byte, error) { + type alias MCPOauthProbeResultNoAuthRequired + return json.Marshal(struct { + Status MCPOauthProbeResultStatus `json:"status"` + alias + }{ + Status: r.Status(), + alias: alias(r), + }) +} + +func unmarshalMCPPlanInstallSource(data []byte) (MCPPlanInstallSource, error) { + if string(data) == "null" { + return nil, nil } - var raw rawMCPServerConfigStdio + type rawUnion struct { + Kind MCPPlanInstallSourceKind `json:"kind"` + } + var raw rawUnion if err := json.Unmarshal(data, &raw); err != nil { - return err + return nil, err } - r.Args = raw.Args - if raw.Auth != nil { - value, err := unmarshalMCPServerAuthConfig(raw.Auth) - if err != nil { - return err + + switch raw.Kind { + case MCPPlanInstallSourceKindCandidate: + var d MCPPlanInstallSourceCandidate + if err := json.Unmarshal(data, &d); err != nil { + return nil, err } - r.Auth = value - } - r.Command = raw.Command - r.Cwd = raw.Cwd - r.DeferTools = raw.DeferTools - r.Env = raw.Env - if raw.FilterMapping != nil { - value, err := unmarshalFilterMapping(raw.FilterMapping) - if err != nil { - return err + return &d, nil + case MCPPlanInstallSourceKindCard: + var d MCPPlanInstallSourceCard + if err := json.Unmarshal(data, &d); err != nil { + return nil, err } - r.FilterMapping = value + return &d, nil + default: + return &RawMCPPlanInstallSourceData{Discriminator: raw.Kind, Raw: data}, nil } - r.IsDefaultServer = raw.IsDefaultServer - if raw.Oidc != nil { - value, err := unmarshalMCPServerAuthConfig(raw.Oidc) - if err != nil { - return err - } - r.Oidc = value +} + +func (r RawMCPPlanInstallSourceData) MarshalJSON() ([]byte, error) { + if r.Raw != nil { + return r.Raw, nil } - r.Timeout = raw.Timeout - r.Tools = raw.Tools - return nil + return json.Marshal(struct { + Kind MCPPlanInstallSourceKind `json:"kind"` + }{ + Kind: r.Discriminator, + }) } -func (r *MCPConfigAddRequest) UnmarshalJSON(data []byte) error { - type rawMCPConfigAddRequest struct { - Config json.RawMessage `json:"config"` - Name string `json:"name"` +func (r MCPPlanInstallSourceCandidate) MarshalJSON() ([]byte, error) { + type alias MCPPlanInstallSourceCandidate + return json.Marshal(struct { + Kind MCPPlanInstallSourceKind `json:"kind"` + alias + }{ + Kind: r.Kind(), + alias: alias(r), + }) +} + +func unmarshalMCPServerCardReference(data []byte) (MCPServerCardReference, error) { + if string(data) == "null" { + return nil, nil } - var raw rawMCPConfigAddRequest + type rawUnion struct { + Kind MCPServerCardReferenceKind `json:"kind"` + } + var raw rawUnion if err := json.Unmarshal(data, &raw); err != nil { - return err + return nil, err } - if raw.Config != nil { - value, err := unmarshalMCPServerConfig(raw.Config) - if err != nil { - return err + + switch raw.Kind { + case MCPServerCardReferenceKindEmbedded: + var d MCPServerCardEmbedded + if err := json.Unmarshal(data, &d); err != nil { + return nil, err } - r.Config = value + return &d, nil + case MCPServerCardReferenceKindURL: + var d MCPServerCardURL + if err := json.Unmarshal(data, &d); err != nil { + return nil, err + } + return &d, nil + default: + return &RawMCPServerCardReferenceData{Discriminator: raw.Kind, Raw: data}, nil } - 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 RawMCPServerCardReferenceData) MarshalJSON() ([]byte, error) { + if r.Raw != nil { + return r.Raw, nil } - var raw rawMCPConfigList + return json.Marshal(struct { + Kind MCPServerCardReferenceKind `json:"kind"` + }{ + Kind: r.Discriminator, + }) +} + +func (r MCPServerCardEmbedded) MarshalJSON() ([]byte, error) { + type alias MCPServerCardEmbedded + return json.Marshal(struct { + Kind MCPServerCardReferenceKind `json:"kind"` + alias + }{ + Kind: r.Kind(), + alias: alias(r), + }) +} + +func (r MCPServerCardURL) MarshalJSON() ([]byte, error) { + type alias MCPServerCardURL + return json.Marshal(struct { + Kind MCPServerCardReferenceKind `json:"kind"` + alias + }{ + Kind: r.Kind(), + alias: alias(r), + }) +} + +func (r *MCPPlanInstallSourceCard) UnmarshalJSON(data []byte) error { + type rawMCPPlanInstallSourceCard struct { + Card json.RawMessage `json:"card"` + } + var raw rawMCPPlanInstallSourceCard 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 + if raw.Card != nil { + value, err := unmarshalMCPServerCardReference(raw.Card) + if err != nil { + return err } + r.Card = value } return nil } -func (r *MCPConfigUpdateRequest) UnmarshalJSON(data []byte) error { - type rawMCPConfigUpdateRequest struct { - Config json.RawMessage `json:"config"` - Name string `json:"name"` +func (r MCPPlanInstallSourceCard) MarshalJSON() ([]byte, error) { + type alias MCPPlanInstallSourceCard + return json.Marshal(struct { + Kind MCPPlanInstallSourceKind `json:"kind"` + alias + }{ + Kind: r.Kind(), + alias: alias(r), + }) +} + +func (r *MCPPlanInstallRequest) UnmarshalJSON(data []byte) error { + type rawMCPPlanInstallRequest struct { + Contract CatalogClientContract `json:"contract"` + Scope *MCPPlanScope `json:"scope,omitempty"` + Source json.RawMessage `json:"source"` } - var raw rawMCPConfigUpdateRequest + var raw rawMCPPlanInstallRequest if err := json.Unmarshal(data, &raw); err != nil { return err } - if raw.Config != nil { - value, err := unmarshalMCPServerConfig(raw.Config) + r.Contract = raw.Contract + r.Scope = raw.Scope + if raw.Source != nil { + value, err := unmarshalMCPPlanInstallSource(raw.Source) if err != nil { return err } - r.Config = value + r.Source = value } - r.Name = raw.Name return nil } -func unmarshalMCPHeadersHandlePendingHeadersRefreshRequest(data []byte) (MCPHeadersHandlePendingHeadersRefreshRequest, error) { +func unmarshalMCPPlanInstallResult(data []byte) (MCPPlanInstallResult, error) { if string(data) == "null" { return nil, nil } type rawUnion struct { - Kind MCPHeadersHandlePendingHeadersRefreshRequestKind `json:"kind"` + Kind MCPPlanInstallResultKind `json:"kind"` } var raw rawUnion if err := json.Unmarshal(data, &raw); err != nil { @@ -1501,156 +2892,366 @@ func unmarshalMCPHeadersHandlePendingHeadersRefreshRequest(data []byte) (MCPHead } switch raw.Kind { - case MCPHeadersHandlePendingHeadersRefreshRequestKindHeaders: - var d MCPHeadersHandlePendingHeadersRefreshRequestHeaders + case MCPPlanInstallResultKindAuthenticationRequired: + var d CatalogAuthenticationRequiredError if err := json.Unmarshal(data, &d); err != nil { return nil, err } return &d, nil - case MCPHeadersHandlePendingHeadersRefreshRequestKindNone: - var d MCPHeadersHandlePendingHeadersRefreshRequestNone + case MCPPlanInstallResultKindContractViolation: + var d CatalogContractViolationError + if err := json.Unmarshal(data, &d); err != nil { + return nil, err + } + return &d, nil + case MCPPlanInstallResultKindHandleRejected: + var d CatalogHandleRejectedError + if err := json.Unmarshal(data, &d); err != nil { + return nil, err + } + return &d, nil + case MCPPlanInstallResultKindInvalidRequest: + var d CatalogInvalidRequestError + if err := json.Unmarshal(data, &d); err != nil { + return nil, err + } + return &d, nil + case MCPPlanInstallResultKindMalformedCard: + var d CatalogMalformedCardError + if err := json.Unmarshal(data, &d); err != nil { + return nil, err + } + return &d, nil + case MCPPlanInstallResultKindNegotiationRefused: + var d CatalogNegotiationRefusedError + if err := json.Unmarshal(data, &d); err != nil { + return nil, err + } + return &d, nil + case MCPPlanInstallResultKindNetworkFailure: + var d CatalogNetworkFailureError + if err := json.Unmarshal(data, &d); err != nil { + return nil, err + } + return &d, nil + case MCPPlanInstallResultKindNotInstallable: + var d CatalogNotInstallableError + if err := json.Unmarshal(data, &d); err != nil { + return nil, err + } + return &d, nil + case MCPPlanInstallResultKindPlanned: + var d MCPPlanInstallPlanned + if err := json.Unmarshal(data, &d); err != nil { + return nil, err + } + return &d, nil + case MCPPlanInstallResultKindPolicyRejected: + var d CatalogPolicyRejectedError + if err := json.Unmarshal(data, &d); err != nil { + return nil, err + } + return &d, nil + case MCPPlanInstallResultKindUnavailable: + var d CatalogUnavailableError + if err := json.Unmarshal(data, &d); err != nil { + return nil, err + } + return &d, nil + case MCPPlanInstallResultKindUnavailableTransport: + var d CatalogUnavailableTransportError + if err := json.Unmarshal(data, &d); err != nil { + return nil, err + } + return &d, nil + case MCPPlanInstallResultKindUnsafeRetrieval: + var d CatalogUnsafeRetrievalError if err := json.Unmarshal(data, &d); err != nil { return nil, err } return &d, nil default: - return &RawMCPHeadersHandlePendingHeadersRefreshRequestData{Discriminator: raw.Kind, Raw: data}, nil + return &RawMCPPlanInstallResultData{Discriminator: raw.Kind, Raw: data}, nil } } -func (r RawMCPHeadersHandlePendingHeadersRefreshRequestData) MarshalJSON() ([]byte, error) { +func (r RawMCPPlanInstallResultData) MarshalJSON() ([]byte, error) { if r.Raw != nil { return r.Raw, nil } return json.Marshal(struct { - Kind MCPHeadersHandlePendingHeadersRefreshRequestKind `json:"kind"` + Kind MCPPlanInstallResultKind `json:"kind"` }{ Kind: r.Discriminator, }) } -func (r MCPHeadersHandlePendingHeadersRefreshRequestHeaders) MarshalJSON() ([]byte, error) { - type alias MCPHeadersHandlePendingHeadersRefreshRequestHeaders +func (r CatalogHandleRejectedError) MarshalJSON() ([]byte, error) { + type alias CatalogHandleRejectedError return json.Marshal(struct { - Kind MCPHeadersHandlePendingHeadersRefreshRequestKind `json:"kind"` + Kind MCPPlanInstallResultKind `json:"kind"` alias }{ - Kind: r.Kind(), + Kind: r.mcpPlanInstallResultKind(), alias: alias(r), }) } -func (r MCPHeadersHandlePendingHeadersRefreshRequestNone) MarshalJSON() ([]byte, error) { - type alias MCPHeadersHandlePendingHeadersRefreshRequestNone +func (r CatalogNotInstallableError) MarshalJSON() ([]byte, error) { + type alias CatalogNotInstallableError return json.Marshal(struct { - Kind MCPHeadersHandlePendingHeadersRefreshRequestKind `json:"kind"` + Kind MCPPlanInstallResultKind `json:"kind"` alias }{ - Kind: r.Kind(), + Kind: r.mcpPlanInstallResultKind(), + alias: alias(r), + }) +} + +func (r CatalogUnavailableTransportError) MarshalJSON() ([]byte, error) { + type alias CatalogUnavailableTransportError + return json.Marshal(struct { + Kind MCPPlanInstallResultKind `json:"kind"` + alias + }{ + Kind: r.mcpPlanInstallResultKind(), + alias: alias(r), + }) +} + +func (r MCPPlanInstallPlanned) MarshalJSON() ([]byte, error) { + type alias MCPPlanInstallPlanned + return json.Marshal(struct { + Kind MCPPlanInstallResultKind `json:"kind"` + alias + }{ + Kind: r.mcpPlanInstallResultKind(), alias: alias(r), }) } -func (r *MCPHeadersHandlePendingHeadersRefreshRequestRequest) UnmarshalJSON(data []byte) error { - type rawMCPHeadersHandlePendingHeadersRefreshRequestRequest struct { - RequestID string `json:"requestId"` - Result json.RawMessage `json:"result"` +func matchesMCPServerConfigHTTP(data []byte) bool { + var rawGroup0 struct { + Command json.RawMessage `json:"command"` + ServerInstance json.RawMessage `json:"serverInstance"` + Type json.RawMessage `json:"type"` + URL json.RawMessage `json:"url"` + } + if err := json.Unmarshal(data, &rawGroup0); err != nil { + return false + } + if rawGroup0.URL == nil { + return false + } + if rawGroup0.Command != nil { + return false + } + if rawGroup0.ServerInstance != nil { + return false + } + return rawGroup0.Type == nil +} + +func matchesMCPServerConfigMemory(data []byte) bool { + var rawGroup0 struct { + Command json.RawMessage `json:"command"` + ServerInstance json.RawMessage `json:"serverInstance"` + Type json.RawMessage `json:"type"` + URL json.RawMessage `json:"url"` + } + if err := json.Unmarshal(data, &rawGroup0); err != nil { + return false + } + if rawGroup0.ServerInstance == nil { + return false + } + if rawGroup0.Type == nil { + return false + } + var rawGroup0String string + if err := json.Unmarshal(rawGroup0.Type, &rawGroup0String); err != nil { + return false + } + switch rawGroup0String { + case "memory": + default: + return false + } + if rawGroup0.Command != nil { + return false + } + return rawGroup0.URL == nil +} + +func matchesMCPServerConfigStdio(data []byte) bool { + var rawGroup0 struct { + Command json.RawMessage `json:"command"` + ServerInstance json.RawMessage `json:"serverInstance"` + Type json.RawMessage `json:"type"` + URL json.RawMessage `json:"url"` } - var raw rawMCPHeadersHandlePendingHeadersRefreshRequestRequest - if err := json.Unmarshal(data, &raw); err != nil { - return err + if err := json.Unmarshal(data, &rawGroup0); err != nil { + return false } - r.RequestID = raw.RequestID - if raw.Result != nil { - value, err := unmarshalMCPHeadersHandlePendingHeadersRefreshRequest(raw.Result) - if err != nil { - return err - } - r.Result = value + if rawGroup0.Command == nil { + return false } - return nil + if rawGroup0.ServerInstance != nil { + return false + } + if rawGroup0.Type != nil { + return false + } + return rawGroup0.URL == nil } -func unmarshalMCPOauthPendingRequestResponse(data []byte) (MCPOauthPendingRequestResponse, error) { +func unmarshalMCPServerConfig(data []byte) (MCPServerConfig, 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 + if matchesMCPServerConfigHTTP(data) { + var d MCPServerConfigHTTP + if err := json.Unmarshal(data, &d); err != nil { + return nil, err + } + return &d, nil } - - switch raw.Kind { - case MCPOauthPendingRequestResponseKindCancelled: - var d MCPOauthPendingRequestResponseCancelled + if matchesMCPServerConfigMemory(data) { + var d MCPServerConfigMemory if err := json.Unmarshal(data, &d); err != nil { return nil, err } return &d, nil - case MCPOauthPendingRequestResponseKindToken: - var d MCPOauthPendingRequestResponseToken + } + if matchesMCPServerConfigStdio(data) { + var d MCPServerConfigStdio if err := json.Unmarshal(data, &d); err != nil { return nil, err } return &d, nil - default: - return &RawMCPOauthPendingRequestResponseData{Discriminator: raw.Kind, Raw: data}, nil } + return &RawMCPServerConfigData{Raw: data}, nil } -func (r RawMCPOauthPendingRequestResponseData) MarshalJSON() ([]byte, error) { +func (r RawMCPServerConfigData) 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), - }) + return []byte("null"), nil } -func (r *MCPOauthHandlePendingRequest) UnmarshalJSON(data []byte) error { - type rawMCPOauthHandlePendingRequest struct { - RequestID string `json:"requestId"` - Result json.RawMessage `json:"result"` - } - var raw rawMCPOauthHandlePendingRequest +func (r *MCPServerConfigMemory) UnmarshalJSON(data []byte) error { + type rawMCPServerConfigMemory struct { + ConfigWarnings []string `json:"configWarnings,omitzero"` + DeferTools *MCPServerConfigDeferTools `json:"deferTools,omitempty"` + DisableSecretMasking *bool `json:"disableSecretMasking,omitempty"` + DisableToolCache *bool `json:"disableToolCache,omitempty"` + DisplayName *string `json:"displayName,omitempty"` + Events []string `json:"events,omitzero"` + ExcludeTools []string `json:"excludeTools,omitzero"` + FilterMapping json.RawMessage `json:"filterMapping,omitempty"` + IsDefaultServer *bool `json:"isDefaultServer,omitempty"` + Notifications []string `json:"notifications,omitzero"` + Oidc json.RawMessage `json:"oidc,omitempty"` + SafeForTelemetry json.RawMessage `json:"safeForTelemetry,omitempty"` + ServerInstance any `json:"serverInstance"` + Source *MCPServerSource `json:"source,omitempty"` + SourcePath *string `json:"sourcePath,omitempty"` + SourcePlugin *string `json:"sourcePlugin,omitempty"` + SourcePluginSpec *bool `json:"sourcePluginSpec,omitempty"` + SourcePluginVersion *string `json:"sourcePluginVersion,omitempty"` + Timeout *int64 `json:"timeout,omitempty"` + Tools []string `json:"tools,omitzero"` + Type MCPServerConfigMemoryType `json:"type"` + } + var raw rawMCPServerConfigMemory if err := json.Unmarshal(data, &raw); err != nil { return err } - r.RequestID = raw.RequestID - if raw.Result != nil { - value, err := unmarshalMCPOauthPendingRequestResponse(raw.Result) + r.ConfigWarnings = raw.ConfigWarnings + r.DeferTools = raw.DeferTools + r.DisableSecretMasking = raw.DisableSecretMasking + r.DisableToolCache = raw.DisableToolCache + r.DisplayName = raw.DisplayName + r.Events = raw.Events + r.ExcludeTools = raw.ExcludeTools + if raw.FilterMapping != nil { + value, err := unmarshalFilterMapping(raw.FilterMapping) if err != nil { return err } - r.Result = value + r.FilterMapping = value + } + r.IsDefaultServer = raw.IsDefaultServer + r.Notifications = raw.Notifications + if raw.Oidc != nil { + value, err := unmarshalMCPServerAuthConfig(raw.Oidc) + if err != nil { + return err + } + r.Oidc = value + } + if raw.SafeForTelemetry != nil { + value, err := unmarshalMCPSafeForTelemetry(raw.SafeForTelemetry) + if err != nil { + return err + } + r.SafeForTelemetry = value + } + r.ServerInstance = raw.ServerInstance + r.Source = raw.Source + r.SourcePath = raw.SourcePath + r.SourcePlugin = raw.SourcePlugin + r.SourcePluginSpec = raw.SourcePluginSpec + r.SourcePluginVersion = raw.SourcePluginVersion + r.Timeout = raw.Timeout + r.Tools = raw.Tools + r.Type = raw.Type + return nil +} + +func (r *MCPReloadConfig) UnmarshalJSON(data []byte) error { + type rawMCPReloadConfig struct { + ActiveGitHubToken *string `json:"activeGitHubToken,omitempty"` + CLIEnabledServers []string `json:"cliEnabledServers,omitzero"` + ConfigFilter any `json:"configFilter,omitempty"` + DisabledServers []string `json:"disabledServers,omitzero"` + EnabledServers []string `json:"enabledServers,omitzero"` + ForceRestart *bool `json:"forceRestart,omitempty"` + GitHubMCPToolOptions any `json:"githubMcpToolOptions,omitempty"` + GitHubMCPUserOverride *bool `json:"githubMcpUserOverride,omitempty"` + IncludeWorkspaceSources *bool `json:"includeWorkspaceSources,omitempty"` + Mcp3pEnabled *bool `json:"mcp3pEnabled,omitempty"` + MCPServers map[string]json.RawMessage `json:"mcpServers"` + SecretStore any `json:"secretStore,omitempty"` + UseCachedToolSnapshots *bool `json:"useCachedToolSnapshots,omitempty"` + } + var raw rawMCPReloadConfig + if err := json.Unmarshal(data, &raw); err != nil { + return err + } + r.ActiveGitHubToken = raw.ActiveGitHubToken + r.CLIEnabledServers = raw.CLIEnabledServers + r.ConfigFilter = raw.ConfigFilter + r.DisabledServers = raw.DisabledServers + r.EnabledServers = raw.EnabledServers + r.ForceRestart = raw.ForceRestart + r.GitHubMCPToolOptions = raw.GitHubMCPToolOptions + r.GitHubMCPUserOverride = raw.GitHubMCPUserOverride + r.IncludeWorkspaceSources = raw.IncludeWorkspaceSources + r.Mcp3pEnabled = raw.Mcp3pEnabled + if raw.MCPServers != nil { + r.MCPServers = make(map[string]MCPServerConfig, len(raw.MCPServers)) + for key, rawValue := range raw.MCPServers { + value, err := unmarshalMCPServerConfig(rawValue) + if err != nil { + return err + } + r.MCPServers[key] = value + } } + r.SecretStore = raw.SecretStore + r.UseCachedToolSnapshots = raw.UseCachedToolSnapshots return nil } @@ -1664,7 +3265,7 @@ func (r *MCPRestartServerRequest) UnmarshalJSON(data []byte) error { return err } if raw.Config != nil { - value, err := unmarshalMCPServerConfig(raw.Config) + value, err := unmarshalMCPSerializableServerConfig(raw.Config) if err != nil { return err } @@ -1676,7 +3277,7 @@ func (r *MCPRestartServerRequest) UnmarshalJSON(data []byte) error { func (r *MCPStartServerRequest) UnmarshalJSON(data []byte) error { type rawMCPStartServerRequest struct { - Config json.RawMessage `json:"config"` + Config json.RawMessage `json:"config,omitempty"` ServerName string `json:"serverName"` } var raw rawMCPStartServerRequest @@ -1684,7 +3285,7 @@ func (r *MCPStartServerRequest) UnmarshalJSON(data []byte) error { return err } if raw.Config != nil { - value, err := unmarshalMCPServerConfig(raw.Config) + value, err := unmarshalMCPSerializableServerConfig(raw.Config) if err != nil { return err } @@ -1849,6 +3450,12 @@ func unmarshalUserToolSessionApproval(data []byte) (UserToolSessionApproval, err return nil, err } return &d, nil + case UserToolSessionApprovalKindExtensionEnvAccess: + var d UserToolSessionApprovalExtensionEnvAccess + 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 { @@ -1861,6 +3468,12 @@ func unmarshalUserToolSessionApproval(data []byte) (UserToolSessionApproval, err 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 { @@ -1923,6 +3536,17 @@ func (r UserToolSessionApprovalCustomTool) MarshalJSON() ([]byte, error) { }) } +func (r UserToolSessionApprovalExtensionEnvAccess) MarshalJSON() ([]byte, error) { + type alias UserToolSessionApprovalExtensionEnvAccess + 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 { @@ -1945,6 +3569,17 @@ func (r UserToolSessionApprovalExtensionPermissionAccess) MarshalJSON() ([]byte, }) } +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 { @@ -2074,6 +3709,12 @@ func unmarshalPermissionDecisionApproveForLocationApproval(data []byte) (Permiss return nil, err } return &d, nil + case PermissionDecisionApproveForLocationApprovalKindExtensionEnvAccess: + var d PermissionDecisionApproveForLocationApprovalExtensionEnvAccess + if err := json.Unmarshal(data, &d); err != nil { + return nil, err + } + return &d, nil case PermissionDecisionApproveForLocationApprovalKindExtensionManagement: var d PermissionDecisionApproveForLocationApprovalExtensionManagement if err := json.Unmarshal(data, &d); err != nil { @@ -2086,6 +3727,12 @@ func unmarshalPermissionDecisionApproveForLocationApproval(data []byte) (Permiss return nil, err } return &d, nil + case PermissionDecisionApproveForLocationApprovalKindFactory: + var d PermissionDecisionApproveForLocationApprovalFactory + if err := json.Unmarshal(data, &d); err != nil { + return nil, err + } + return &d, nil case PermissionDecisionApproveForLocationApprovalKindMCP: var d PermissionDecisionApproveForLocationApprovalMCP if err := json.Unmarshal(data, &d); err != nil { @@ -2154,6 +3801,17 @@ func (r PermissionDecisionApproveForLocationApprovalCustomTool) MarshalJSON() ([ }) } +func (r PermissionDecisionApproveForLocationApprovalExtensionEnvAccess) MarshalJSON() ([]byte, error) { + type alias PermissionDecisionApproveForLocationApprovalExtensionEnvAccess + 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 { @@ -2176,6 +3834,17 @@ func (r PermissionDecisionApproveForLocationApprovalExtensionPermissionAccess) M }) } +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 { @@ -2287,6 +3956,12 @@ func unmarshalPermissionDecisionApproveForSessionApproval(data []byte) (Permissi return nil, err } return &d, nil + case PermissionDecisionApproveForSessionApprovalKindExtensionEnvAccess: + var d PermissionDecisionApproveForSessionApprovalExtensionEnvAccess + if err := json.Unmarshal(data, &d); err != nil { + return nil, err + } + return &d, nil case PermissionDecisionApproveForSessionApprovalKindExtensionManagement: var d PermissionDecisionApproveForSessionApprovalExtensionManagement if err := json.Unmarshal(data, &d); err != nil { @@ -2299,6 +3974,12 @@ func unmarshalPermissionDecisionApproveForSessionApproval(data []byte) (Permissi return nil, err } return &d, nil + case PermissionDecisionApproveForSessionApprovalKindFactory: + var d PermissionDecisionApproveForSessionApprovalFactory + if err := json.Unmarshal(data, &d); err != nil { + return nil, err + } + return &d, nil case PermissionDecisionApproveForSessionApprovalKindMCP: var d PermissionDecisionApproveForSessionApprovalMCP if err := json.Unmarshal(data, &d); err != nil { @@ -2367,6 +4048,17 @@ func (r PermissionDecisionApproveForSessionApprovalCustomTool) MarshalJSON() ([] }) } +func (r PermissionDecisionApproveForSessionApprovalExtensionEnvAccess) MarshalJSON() ([]byte, error) { + type alias PermissionDecisionApproveForSessionApprovalExtensionEnvAccess + 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 { @@ -2389,6 +4081,17 @@ func (r PermissionDecisionApproveForSessionApprovalExtensionPermissionAccess) Ma }) } +func (r PermissionDecisionApproveForSessionApprovalFactory) MarshalJSON() ([]byte, error) { + type alias PermissionDecisionApproveForSessionApprovalFactory + 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 { @@ -2587,13 +4290,15 @@ func (r PermissionDecisionUserNotAvailable) MarshalJSON() ([]byte, error) { func (r *PermissionDecisionRequest) UnmarshalJSON(data []byte) error { type rawPermissionDecisionRequest struct { - RequestID string `json:"requestId"` - Result json.RawMessage `json:"result"` + 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) @@ -2630,6 +4335,12 @@ func unmarshalPermissionsLocationsAddToolApprovalDetails(data []byte) (Permissio return nil, err } return &d, nil + case PermissionsLocationsAddToolApprovalDetailsKindExtensionEnvAccess: + var d PermissionsLocationsAddToolApprovalDetailsExtensionEnvAccess + if err := json.Unmarshal(data, &d); err != nil { + return nil, err + } + return &d, nil case PermissionsLocationsAddToolApprovalDetailsKindExtensionManagement: var d PermissionsLocationsAddToolApprovalDetailsExtensionManagement if err := json.Unmarshal(data, &d); err != nil { @@ -2642,6 +4353,12 @@ func unmarshalPermissionsLocationsAddToolApprovalDetails(data []byte) (Permissio return nil, err } return &d, nil + case PermissionsLocationsAddToolApprovalDetailsKindFactory: + var d PermissionsLocationsAddToolApprovalDetailsFactory + 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 { @@ -2710,6 +4427,17 @@ func (r PermissionsLocationsAddToolApprovalDetailsCustomTool) MarshalJSON() ([]b }) } +func (r PermissionsLocationsAddToolApprovalDetailsExtensionEnvAccess) MarshalJSON() ([]byte, error) { + type alias PermissionsLocationsAddToolApprovalDetailsExtensionEnvAccess + return json.Marshal(struct { + Kind PermissionsLocationsAddToolApprovalDetailsKind `json:"kind"` + alias + }{ + Kind: r.Kind(), + alias: alias(r), + }) +} + func (r PermissionsLocationsAddToolApprovalDetailsExtensionManagement) MarshalJSON() ([]byte, error) { type alias PermissionsLocationsAddToolApprovalDetailsExtensionManagement return json.Marshal(struct { @@ -2732,6 +4460,17 @@ func (r PermissionsLocationsAddToolApprovalDetailsExtensionPermissionAccess) Mar }) } +func (r PermissionsLocationsAddToolApprovalDetailsFactory) MarshalJSON() ([]byte, error) { + type alias PermissionsLocationsAddToolApprovalDetailsFactory + return json.Marshal(struct { + Kind PermissionsLocationsAddToolApprovalDetailsKind `json:"kind"` + alias + }{ + Kind: r.Kind(), + alias: alias(r), + }) +} + func (r PermissionsLocationsAddToolApprovalDetailsMCP) MarshalJSON() ([]byte, error) { type alias PermissionsLocationsAddToolApprovalDetailsMCP return json.Marshal(struct { @@ -3091,6 +4830,49 @@ func (r PushAttachmentSelection) MarshalJSON() ([]byte, error) { }) } +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 rawQueueInsertMessage + 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.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 unmarshalRemoteControlStatus(data []byte) (RemoteControlStatus, error) { if string(data) == "null" { return nil, nil @@ -3345,6 +5127,44 @@ func (r *SendRequest) UnmarshalJSON(data []byte) error { return nil } +func (r *SessionAuthLogoutUserRequest) UnmarshalJSON(data []byte) error { + type rawSessionAuthLogoutUserRequest struct { + AuthInfo json.RawMessage `json:"authInfo"` + } + var raw rawSessionAuthLogoutUserRequest + if err := json.Unmarshal(data, &raw); err != nil { + return err + } + if raw.AuthInfo != nil { + value, err := unmarshalAuthInfo(raw.AuthInfo) + if err != nil { + return err + } + r.AuthInfo = value + } + return nil +} + +func (r *SessionAuthSwitchRequest) UnmarshalJSON(data []byte) error { + type rawSessionAuthSwitchRequest struct { + AuthInfo json.RawMessage `json:"authInfo"` + Token *string `json:"token,omitempty"` + } + var raw rawSessionAuthSwitchRequest + if err := json.Unmarshal(data, &raw); err != nil { + return err + } + if raw.AuthInfo != nil { + value, err := unmarshalAuthInfo(raw.AuthInfo) + if err != nil { + return err + } + r.AuthInfo = value + } + r.Token = raw.Token + return nil +} + func (r SessionInstalledPluginSource) MarshalJSON() ([]byte, error) { if r.SessionInstalledPluginSourceGitHub != nil { return json.Marshal(r.SessionInstalledPluginSourceGitHub) @@ -3397,6 +5217,69 @@ func (r *SessionInstalledPluginSource) UnmarshalJSON(data []byte) error { 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 SessionLimitPredictionResultKindUnavailable: + var d SessionLimitPredictionResultUnavailable + if err := json.Unmarshal(data, &d); err != nil { + return nil, err + } + return &d, nil + default: + return &RawSessionLimitPredictionResultData{Discriminator: raw.Kind, Raw: data}, nil + } +} + +func (r RawSessionLimitPredictionResultData) MarshalJSON() ([]byte, error) { + if r.Raw != nil { + return r.Raw, nil + } + return json.Marshal(struct { + Kind SessionLimitPredictionResultKind `json:"kind"` + }{ + Kind: r.Discriminator, + }) +} + +func (r SessionLimitPredictionResultAvailable) MarshalJSON() ([]byte, error) { + type alias SessionLimitPredictionResultAvailable + return json.Marshal(struct { + Kind SessionLimitPredictionResultKind `json:"kind"` + alias + }{ + Kind: r.Kind(), + alias: alias(r), + }) +} + +func (r SessionLimitPredictionResultUnavailable) MarshalJSON() ([]byte, error) { + type alias SessionLimitPredictionResultUnavailable + return json.Marshal(struct { + Kind SessionLimitPredictionResultKind `json:"kind"` + alias + }{ + Kind: r.Kind(), + alias: alias(r), + }) +} + func unmarshalSessionListEntry(data []byte) (SessionListEntry, error) { if string(data) == "null" { return nil, nil @@ -3475,6 +5358,7 @@ func (r *SessionList) UnmarshalJSON(data []byte) error { 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"` @@ -3491,24 +5375,29 @@ func (r *SessionOpenOptions) UnmarshalJSON(data []byte) error { 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"` + IncludedBuiltinSkills []string `json:"includedBuiltinSkills,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"` @@ -3524,9 +5413,11 @@ func (r *SessionOpenOptions) UnmarshalJSON(data []byte) error { RemoteSteerable *bool `json:"remoteSteerable,omitempty"` RunningInInteractiveMode *bool `json:"runningInInteractiveMode,omitempty"` SandboxConfig *SandboxConfig `json:"sandboxConfig,omitempty"` + SandboxConfigSource *SandboxConfigSource `json:"sandboxConfigSource,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"` @@ -3541,6 +5432,7 @@ func (r *SessionOpenOptions) UnmarshalJSON(data []byte) error { return err } r.AdditionalContentExclusionPolicies = raw.AdditionalContentExclusionPolicies + r.AdditionalDirectories = raw.AdditionalDirectories r.AgentContext = raw.AgentContext r.AllowAllMCPServerInstructions = raw.AllowAllMCPServerInstructions r.AskUserDisabled = raw.AskUserDisabled @@ -3563,24 +5455,29 @@ func (r *SessionOpenOptions) UnmarshalJSON(data []byte) error { 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.IncludedBuiltinSkills = raw.IncludedBuiltinSkills 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 @@ -3596,9 +5493,11 @@ func (r *SessionOpenOptions) UnmarshalJSON(data []byte) error { r.RemoteSteerable = raw.RemoteSteerable r.RunningInInteractiveMode = raw.RunningInInteractiveMode r.SandboxConfig = raw.SandboxConfig + r.SandboxConfigSource = raw.SandboxConfigSource 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 @@ -3758,6 +5657,88 @@ func (r SessionsOpenResumeLast) MarshalJSON() ([]byte, error) { }) } +func unmarshalSettableAuthInfo(data []byte) (SettableAuthInfo, error) { + if string(data) == "null" { + return nil, nil + } + type rawUnion struct { + Type SettableAuthInfoType `json:"type"` + } + var raw rawUnion + if err := json.Unmarshal(data, &raw); err != nil { + return nil, err + } + + switch raw.Type { + case SettableAuthInfoTypeAPIKey: + var d APIKeyAuthInfo + if err := json.Unmarshal(data, &d); err != nil { + return nil, err + } + return &d, nil + case SettableAuthInfoTypeCopilotAPIToken: + var d CopilotAPITokenAuthInfo + if err := json.Unmarshal(data, &d); err != nil { + return nil, err + } + return &d, nil + case SettableAuthInfoTypeEnv: + var d EnvAuthInfo + if err := json.Unmarshal(data, &d); err != nil { + return nil, err + } + return &d, nil + case SettableAuthInfoTypeGhCLI: + var d GhCLIAuthInfo + if err := json.Unmarshal(data, &d); err != nil { + return nil, err + } + return &d, nil + case SettableAuthInfoTypeHMAC: + var d HMACAuthInfo + if err := json.Unmarshal(data, &d); err != nil { + return nil, err + } + return &d, nil + case SettableAuthInfoTypeToken: + var d SettableTokenAuthInfo + if err := json.Unmarshal(data, &d); err != nil { + return nil, err + } + return &d, nil + case SettableAuthInfoTypeUser: + var d UserAuthInfo + if err := json.Unmarshal(data, &d); err != nil { + return nil, err + } + return &d, nil + default: + return &RawSettableAuthInfoData{Discriminator: raw.Type, Raw: data}, nil + } +} + +func (r RawSettableAuthInfoData) MarshalJSON() ([]byte, error) { + if r.Raw != nil { + return r.Raw, nil + } + return json.Marshal(struct { + Type SettableAuthInfoType `json:"type"` + }{ + Type: r.Discriminator, + }) +} + +func (r SettableTokenAuthInfo) MarshalJSON() ([]byte, error) { + type alias SettableTokenAuthInfo + return json.Marshal(struct { + Type SettableAuthInfoType `json:"type"` + alias + }{ + Type: r.settableAuthInfoType(), + alias: alias(r), + }) +} + func (r *SessionSetCredentialsParams) UnmarshalJSON(data []byte) error { type rawSessionSetCredentialsParams struct { Credentials json.RawMessage `json:"credentials,omitempty"` @@ -3767,7 +5748,7 @@ func (r *SessionSetCredentialsParams) UnmarshalJSON(data []byte) error { return err } if raw.Credentials != nil { - value, err := unmarshalAuthInfo(raw.Credentials) + value, err := unmarshalSettableAuthInfo(raw.Credentials) if err != nil { return err } @@ -3789,6 +5770,12 @@ func unmarshalSlashCommandInvocationResult(data []byte) (SlashCommandInvocationR } switch raw.Kind { + case SlashCommandInvocationResultKindAddTimelineEntry: + var d SlashCommandAddTimelineEntryResult + if err := json.Unmarshal(data, &d); err != nil { + return nil, err + } + return &d, nil case SlashCommandInvocationResultKindAgentPrompt: var d SlashCommandAgentPromptResult if err := json.Unmarshal(data, &d); err != nil { @@ -3807,6 +5794,24 @@ func unmarshalSlashCommandInvocationResult(data []byte) (SlashCommandInvocationR return nil, err } return &d, nil + case SlashCommandInvocationResultKindSetModel: + var d SlashCommandSetModelResult + if err := json.Unmarshal(data, &d); err != nil { + return nil, err + } + return &d, nil + case SlashCommandInvocationResultKindSetPlanModel: + var d SlashCommandSetPlanModelResult + if err := json.Unmarshal(data, &d); err != nil { + return nil, err + } + return &d, nil + case SlashCommandInvocationResultKindShowDialog: + var d SlashCommandShowDialogResult + if err := json.Unmarshal(data, &d); err != nil { + return nil, err + } + return &d, nil case SlashCommandInvocationResultKindText: var d SlashCommandTextResult if err := json.Unmarshal(data, &d); err != nil { @@ -3829,6 +5834,17 @@ func (r RawSlashCommandInvocationResultData) MarshalJSON() ([]byte, error) { }) } +func (r SlashCommandAddTimelineEntryResult) MarshalJSON() ([]byte, error) { + type alias SlashCommandAddTimelineEntryResult + return json.Marshal(struct { + Kind SlashCommandInvocationResultKind `json:"kind"` + alias + }{ + Kind: r.Kind(), + alias: alias(r), + }) +} + func (r SlashCommandAgentPromptResult) MarshalJSON() ([]byte, error) { type alias SlashCommandAgentPromptResult return json.Marshal(struct { @@ -3862,6 +5878,39 @@ func (r SlashCommandSelectSubcommandResult) MarshalJSON() ([]byte, error) { }) } +func (r SlashCommandSetModelResult) MarshalJSON() ([]byte, error) { + type alias SlashCommandSetModelResult + return json.Marshal(struct { + Kind SlashCommandInvocationResultKind `json:"kind"` + alias + }{ + Kind: r.Kind(), + alias: alias(r), + }) +} + +func (r SlashCommandSetPlanModelResult) MarshalJSON() ([]byte, error) { + type alias SlashCommandSetPlanModelResult + return json.Marshal(struct { + Kind SlashCommandInvocationResultKind `json:"kind"` + alias + }{ + Kind: r.Kind(), + alias: alias(r), + }) +} + +func (r SlashCommandShowDialogResult) MarshalJSON() ([]byte, error) { + type alias SlashCommandShowDialogResult + return json.Marshal(struct { + Kind SlashCommandInvocationResultKind `json:"kind"` + alias + }{ + Kind: r.Kind(), + alias: alias(r), + }) +} + func (r SlashCommandTextResult) MarshalJSON() ([]byte, error) { type alias SlashCommandTextResult return json.Marshal(struct { @@ -4074,6 +6123,78 @@ func (r *TasksPromoteCurrentToBackgroundResult) UnmarshalJSON(data []byte) error return nil } +func (r *ToolResultExpanded) UnmarshalJSON(data []byte) error { + type rawToolResultExpanded struct { + BinaryResultsForLlm []ExternalToolTextResultForLlmBinaryResultsForLlm `json:"binaryResultsForLlm,omitzero"` + CitableSources []any `json:"citableSources,omitzero"` + Contents []json.RawMessage `json:"contents,omitzero"` + Error *string `json:"error,omitempty"` + MCPMeta map[string]any `json:"mcpMeta,omitzero"` + NewMessages []ToolResultNewMessage `json:"newMessages,omitzero"` + PostToolUseFailureHooksProcessed *bool `json:"postToolUseFailureHooksProcessed,omitempty"` + ResultType ToolResultType `json:"resultType"` + SessionLog *string `json:"sessionLog,omitempty"` + SkillInvocation any `json:"skillInvocation,omitempty"` + SkipLargeOutputProcessing *bool `json:"skipLargeOutputProcessing,omitempty"` + StructuredContent any `json:"structuredContent,omitempty"` + TaskCompletionDecision *TaskCompletionDecision `json:"taskCompletionDecision,omitempty"` + TextResultForLlm string `json:"textResultForLlm"` + ToolReferences []string `json:"toolReferences,omitzero"` + ToolTelemetry any `json:"toolTelemetry,omitempty"` + UIResource any `json:"uiResource,omitempty"` + } + var raw rawToolResultExpanded + if err := json.Unmarshal(data, &raw); err != nil { + return err + } + r.BinaryResultsForLlm = raw.BinaryResultsForLlm + r.CitableSources = raw.CitableSources + 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.MCPMeta = raw.MCPMeta + r.NewMessages = raw.NewMessages + r.PostToolUseFailureHooksProcessed = raw.PostToolUseFailureHooksProcessed + r.ResultType = raw.ResultType + r.SessionLog = raw.SessionLog + r.SkillInvocation = raw.SkillInvocation + r.SkipLargeOutputProcessing = raw.SkipLargeOutputProcessing + r.StructuredContent = raw.StructuredContent + r.TaskCompletionDecision = raw.TaskCompletionDecision + r.TextResultForLlm = raw.TextResultForLlm + r.ToolReferences = raw.ToolReferences + r.ToolTelemetry = raw.ToolTelemetry + r.UIResource = raw.UIResource + return nil +} + +func unmarshalToolResult(data []byte) (ToolResult, error) { + if string(data) == "null" { + return nil, nil + } + { + var value string + if err := json.Unmarshal(data, &value); err == nil { + return ToolStringResult(value), nil + } + } + { + var value ToolResultExpanded + if err := json.Unmarshal(data, &value); err == nil { + return &value, nil + } + } + return nil, errors.New("data did not match any union variant for ToolResult") +} + func unmarshalUIElicitationFieldValue(data []byte) (UIElicitationFieldValue, error) { if string(data) == "null" { return nil, nil @@ -4105,7 +6226,7 @@ func unmarshalUIElicitationFieldValue(data []byte) (UIElicitationFieldValue, err return nil, errors.New("data did not match any union variant for UIElicitationFieldValue") } -func matchesUIElicitationArrayAnyOfField(data []byte) bool { +func matchesUIElicitationSchemaPropertyUIElicitationArrayAnyOfField(data []byte) bool { var rawGroup0 struct { Items json.RawMessage `json:"items"` } @@ -4132,7 +6253,7 @@ func matchesUIElicitationArrayAnyOfField(data []byte) bool { return rawGroup0Items.Type == nil } -func matchesUIElicitationArrayEnumField(data []byte) bool { +func matchesUIElicitationSchemaPropertyUIElicitationArrayEnumField(data []byte) bool { var rawGroup0 struct { Items json.RawMessage `json:"items"` } @@ -4182,7 +6303,7 @@ func matchesUIElicitationSchemaPropertyString(data []byte) bool { return rawGroup0.OneOf == nil } -func matchesUIElicitationStringEnumField(data []byte) bool { +func matchesUIElicitationSchemaPropertyUIElicitationStringEnumField(data []byte) bool { var rawGroup0 struct { Enum json.RawMessage `json:"enum"` OneOf json.RawMessage `json:"oneOf"` @@ -4196,7 +6317,7 @@ func matchesUIElicitationStringEnumField(data []byte) bool { return rawGroup0.OneOf == nil } -func matchesUIElicitationStringOneOfField(data []byte) bool { +func matchesUIElicitationSchemaPropertyUIElicitationStringOneOfField(data []byte) bool { var rawGroup0 struct { Enum json.RawMessage `json:"enum"` OneOf json.RawMessage `json:"oneOf"` @@ -4224,14 +6345,14 @@ func unmarshalUIElicitationSchemaProperty(data []byte) (UIElicitationSchemaPrope switch raw.Type { case UIElicitationSchemaPropertyTypeArray: - if matchesUIElicitationArrayAnyOfField(data) { + if matchesUIElicitationSchemaPropertyUIElicitationArrayAnyOfField(data) { var d UIElicitationArrayAnyOfField if err := json.Unmarshal(data, &d); err != nil { return nil, err } return &d, nil } - if matchesUIElicitationArrayEnumField(data) { + if matchesUIElicitationSchemaPropertyUIElicitationArrayEnumField(data) { var d UIElicitationArrayEnumField if err := json.Unmarshal(data, &d); err != nil { return nil, err @@ -4265,14 +6386,14 @@ func unmarshalUIElicitationSchemaProperty(data []byte) (UIElicitationSchemaPrope } return &d, nil } - if matchesUIElicitationStringEnumField(data) { + if matchesUIElicitationSchemaPropertyUIElicitationStringEnumField(data) { var d UIElicitationStringEnumField if err := json.Unmarshal(data, &d); err != nil { return nil, err } return &d, nil } - if matchesUIElicitationStringOneOfField(data) { + if matchesUIElicitationSchemaPropertyUIElicitationStringOneOfField(data) { var d UIElicitationStringOneOfField if err := json.Unmarshal(data, &d); err != nil { return nil, err @@ -4402,6 +6523,7 @@ func (r *UIElicitationResponse) UnmarshalJSON(data []byte) error { type rawUIElicitationResponse struct { Action UIElicitationResponseAction `json:"action"` Content map[string]json.RawMessage `json:"content,omitzero"` + Meta map[string]any `json:"_meta,omitzero"` } var raw rawUIElicitationResponse if err := json.Unmarshal(data, &raw); err != nil { @@ -4418,5 +6540,6 @@ func (r *UIElicitationResponse) UnmarshalJSON(data []byte) error { r.Content[key] = value } } + r.Meta = raw.Meta return nil } diff --git a/go/rpc/zsession_encoding.go b/go/rpc/zsession_encoding.go index fe99126cf7..4c03a42c00 100644 --- a/go/rpc/zsession_encoding.go +++ b/go/rpc/zsession_encoding.go @@ -41,6 +41,30 @@ func (e *SessionEvent) UnmarshalJSON(data []byte) error { return err } e.Data = &d + case SessionEventTypeAgentInterrupted: + var d AgentInterruptedData + if err := json.Unmarshal(raw.Data, &d); err != nil { + return err + } + e.Data = &d + case SessionEventTypeAssistantFusionPhaseCompleted: + var d AssistantFusionPhaseCompletedData + if err := json.Unmarshal(raw.Data, &d); err != nil { + return err + } + e.Data = &d + case SessionEventTypeAssistantFusionPhaseFailed: + var d AssistantFusionPhaseFailedData + if err := json.Unmarshal(raw.Data, &d); err != nil { + return err + } + e.Data = &d + case SessionEventTypeAssistantFusionPhaseStarted: + var d AssistantFusionPhaseStartedData + if err := json.Unmarshal(raw.Data, &d); err != nil { + return err + } + e.Data = &d case SessionEventTypeAssistantIdle: var d AssistantIdleData if err := json.Unmarshal(raw.Data, &d); err != nil { @@ -203,6 +227,24 @@ func (e *SessionEvent) UnmarshalJSON(data []byte) error { return err } e.Data = &d + case SessionEventTypeFactoryRunSettled: + var d FactoryRunSettledData + if err := json.Unmarshal(raw.Data, &d); err != nil { + return err + } + e.Data = &d + case SessionEventTypeFactoryRunStarted: + var d FactoryRunStartedData + if err := json.Unmarshal(raw.Data, &d); err != nil { + 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 { @@ -275,6 +317,12 @@ func (e *SessionEvent) UnmarshalJSON(data []byte) error { return err } e.Data = &d + case SessionEventTypeModelCallFinished: + var d ModelCallFinishedData + if err := json.Unmarshal(raw.Data, &d); err != nil { + return err + } + e.Data = &d case SessionEventTypeModelCallStart: var d ModelCallStartData if err := json.Unmarshal(raw.Data, &d); err != nil { @@ -299,6 +347,12 @@ func (e *SessionEvent) UnmarshalJSON(data []byte) error { return err } e.Data = &d + case SessionEventTypePromptCacheBreak: + var d PromptCacheBreakData + if err := json.Unmarshal(raw.Data, &d); err != nil { + return err + } + e.Data = &d case SessionEventTypeSamplingCompleted: var d SamplingCompletedData if err := json.Unmarshal(raw.Data, &d); err != nil { @@ -311,6 +365,12 @@ func (e *SessionEvent) UnmarshalJSON(data []byte) error { return err } e.Data = &d + case SessionEventTypeSandboxDecision: + var d SandboxDecisionData + if err := json.Unmarshal(raw.Data, &d); err != nil { + return err + } + e.Data = &d case SessionEventTypeSessionAutoModeResolved: var d SessionAutoModeResolvedData if err := json.Unmarshal(raw.Data, &d); err != nil { @@ -389,6 +449,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 { @@ -419,6 +485,30 @@ func (e *SessionEvent) UnmarshalJSON(data []byte) error { return err } e.Data = &d + case SessionEventTypeSessionFusionCompleted: + var d SessionFusionCompletedData + if err := json.Unmarshal(raw.Data, &d); err != nil { + return err + } + e.Data = &d + case SessionEventTypeSessionFusionResolved: + var d SessionFusionResolvedData + if err := json.Unmarshal(raw.Data, &d); err != nil { + return err + } + e.Data = &d + case SessionEventTypeSessionFusionRouteFailed: + var d SessionFusionRouteFailedData + if err := json.Unmarshal(raw.Data, &d); err != nil { + return err + } + e.Data = &d + case SessionEventTypeSessionFusionRouteStarted: + var d SessionFusionRouteStartedData + if err := json.Unmarshal(raw.Data, &d); err != nil { + return err + } + e.Data = &d case SessionEventTypeSessionHandoff: var d SessionHandoffData if err := json.Unmarshal(raw.Data, &d); err != nil { @@ -623,6 +713,12 @@ func (e *SessionEvent) UnmarshalJSON(data []byte) error { return err } e.Data = &d + case SessionEventTypeSubagentConfigured: + var d SubagentConfiguredData + if err := json.Unmarshal(raw.Data, &d); err != nil { + return err + } + e.Data = &d case SessionEventTypeSubagentDeselected: var d SubagentDeselectedData if err := json.Unmarshal(raw.Data, &d); err != nil { @@ -695,6 +791,12 @@ func (e *SessionEvent) UnmarshalJSON(data []byte) error { return err } e.Data = &d + case SessionEventTypeUIEphemeralQuery: + var d UIEphemeralQueryData + if err := json.Unmarshal(raw.Data, &d); err != nil { + return err + } + e.Data = &d case SessionEventTypeUserInputCompleted: var d UserInputCompletedData if err := json.Unmarshal(raw.Data, &d); err != nil { @@ -761,6 +863,7 @@ func (r *UserMessageData) UnmarshalJSON(data []byte) error { Source *string `json:"source,omitempty"` SupportedNativeDocumentMIMETypes []string `json:"supportedNativeDocumentMimeTypes,omitzero"` TransformedContent *string `json:"transformedContent,omitempty"` + TurnID *string `json:"turnId,omitempty"` } var raw rawUserMessageData if err := json.Unmarshal(data, &raw); err != nil { @@ -786,6 +889,7 @@ func (r *UserMessageData) UnmarshalJSON(data []byte) error { r.Source = raw.Source r.SupportedNativeDocumentMIMETypes = raw.SupportedNativeDocumentMIMETypes r.TransformedContent = raw.TransformedContent + r.TurnID = raw.TurnID return nil } @@ -893,7 +997,7 @@ func (r *CitationReference) UnmarshalJSON(data []byte) error { return nil } -func matchesBinaryAssetReference(data []byte) bool { +func matchesPersistedBinaryResultBinaryAssetReference(data []byte) bool { var rawGroup0 struct { AssetID json.RawMessage `json:"assetId"` ByteLength json.RawMessage `json:"byteLength"` @@ -915,7 +1019,7 @@ func matchesBinaryAssetReference(data []byte) bool { return rawGroup0.OmittedReason == nil } -func matchesOmittedBinaryResult(data []byte) bool { +func matchesPersistedBinaryResultOmittedBinaryResult(data []byte) bool { var rawGroup0 struct { AssetID json.RawMessage `json:"assetId"` ByteLength json.RawMessage `json:"byteLength"` @@ -937,7 +1041,7 @@ func matchesOmittedBinaryResult(data []byte) bool { return rawGroup0.Data == nil } -func matchesPersistedBinaryImage(data []byte) bool { +func matchesPersistedBinaryResultPersistedBinaryImage(data []byte) bool { var rawGroup0 struct { AssetID json.RawMessage `json:"assetId"` ByteLength json.RawMessage `json:"byteLength"` @@ -973,21 +1077,21 @@ func unmarshalPersistedBinaryResult(data []byte) (PersistedBinaryResult, error) switch raw.Type { case PersistedBinaryResultTypeImage: - if matchesBinaryAssetReference(data) { + if matchesPersistedBinaryResultBinaryAssetReference(data) { var d BinaryAssetReference if err := json.Unmarshal(data, &d); err != nil { return nil, err } return &d, nil } - if matchesOmittedBinaryResult(data) { + if matchesPersistedBinaryResultOmittedBinaryResult(data) { var d OmittedBinaryResult if err := json.Unmarshal(data, &d); err != nil { return nil, err } return &d, nil } - if matchesPersistedBinaryImage(data) { + if matchesPersistedBinaryResultPersistedBinaryImage(data) { var d PersistedBinaryImage if err := json.Unmarshal(data, &d); err != nil { return nil, err @@ -996,21 +1100,21 @@ func unmarshalPersistedBinaryResult(data []byte) (PersistedBinaryResult, error) } return &RawPersistedBinaryResult{Discriminator: raw.Type, Raw: data}, nil case PersistedBinaryResultTypeResource: - if matchesBinaryAssetReference(data) { + if matchesPersistedBinaryResultBinaryAssetReference(data) { var d BinaryAssetReference if err := json.Unmarshal(data, &d); err != nil { return nil, err } return &d, nil } - if matchesOmittedBinaryResult(data) { + if matchesPersistedBinaryResultOmittedBinaryResult(data) { var d OmittedBinaryResult if err := json.Unmarshal(data, &d); err != nil { return nil, err } return &d, nil } - if matchesPersistedBinaryImage(data) { + if matchesPersistedBinaryResultPersistedBinaryImage(data) { var d PersistedBinaryImage if err := json.Unmarshal(data, &d); err != nil { return nil, err @@ -1346,6 +1450,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 { @@ -1370,6 +1480,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 } @@ -1408,6 +1524,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 { @@ -1452,6 +1579,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"` @@ -1491,6 +1629,12 @@ func unmarshalPermissionRequest(data []byte) (PermissionRequest, error) { return nil, err } return &d, nil + case PermissionRequestKindExtensionEnvAccess: + var d PermissionRequestExtensionEnvAccess + if err := json.Unmarshal(data, &d); err != nil { + return nil, err + } + return &d, nil case PermissionRequestKindExtensionManagement: var d PermissionRequestExtensionManagement if err := json.Unmarshal(data, &d); err != nil { @@ -1503,6 +1647,12 @@ 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 { @@ -1572,6 +1722,17 @@ func (r PermissionRequestCustomTool) MarshalJSON() ([]byte, error) { }) } +func (r PermissionRequestExtensionEnvAccess) MarshalJSON() ([]byte, error) { + type alias PermissionRequestExtensionEnvAccess + return json.Marshal(struct { + Kind PermissionRequestKind `json:"kind"` + alias + }{ + Kind: r.Kind(), + alias: alias(r), + }) +} + func (r PermissionRequestExtensionManagement) MarshalJSON() ([]byte, error) { type alias PermissionRequestExtensionManagement return json.Marshal(struct { @@ -1594,6 +1755,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 { @@ -1696,6 +1868,12 @@ func unmarshalPermissionPromptRequest(data []byte) (PermissionPromptRequest, err return nil, err } return &d, nil + case PermissionPromptRequestKindExtensionEnvAccess: + var d PermissionPromptRequestExtensionEnvAccess + if err := json.Unmarshal(data, &d); err != nil { + return nil, err + } + return &d, nil case PermissionPromptRequestKindExtensionManagement: var d PermissionPromptRequestExtensionManagement if err := json.Unmarshal(data, &d); err != nil { @@ -1708,6 +1886,12 @@ 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 { @@ -1788,6 +1972,17 @@ func (r PermissionPromptRequestCustomTool) MarshalJSON() ([]byte, error) { }) } +func (r PermissionPromptRequestExtensionEnvAccess) MarshalJSON() ([]byte, error) { + type alias PermissionPromptRequestExtensionEnvAccess + return json.Marshal(struct { + Kind PermissionPromptRequestKind `json:"kind"` + alias + }{ + Kind: r.Kind(), + alias: alias(r), + }) +} + func (r PermissionPromptRequestExtensionManagement) MarshalJSON() ([]byte, error) { type alias PermissionPromptRequestExtensionManagement return json.Marshal(struct { @@ -1810,6 +2005,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 { @@ -1893,6 +2099,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 { @@ -1914,6 +2121,7 @@ func (r *PermissionRequestedData) UnmarshalJSON(data []byte) error { } r.RequestID = raw.RequestID r.ResolvedByHook = raw.ResolvedByHook + r.RiskAssessment = raw.RiskAssessment return nil } @@ -2013,8 +2221,9 @@ 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"` + Approval json.RawMessage `json:"approval"` + LocationKey string `json:"locationKey"` + ManagedApprovalHandled *bool `json:"managedApprovalHandled,omitempty"` } var raw rawPermissionApprovedForLocation if err := json.Unmarshal(data, &raw); err != nil { @@ -2028,6 +2237,7 @@ func (r *PermissionApprovedForLocation) UnmarshalJSON(data []byte) error { r.Approval = value } r.LocationKey = raw.LocationKey + r.ManagedApprovalHandled = raw.ManagedApprovalHandled return nil } @@ -2044,7 +2254,8 @@ func (r PermissionApprovedForLocation) MarshalJSON() ([]byte, error) { func (r *PermissionApprovedForSession) UnmarshalJSON(data []byte) error { type rawPermissionApprovedForSession struct { - Approval json.RawMessage `json:"approval"` + Approval json.RawMessage `json:"approval"` + ManagedApprovalHandled *bool `json:"managedApprovalHandled,omitempty"` } var raw rawPermissionApprovedForSession if err := json.Unmarshal(data, &raw); err != nil { @@ -2057,6 +2268,7 @@ func (r *PermissionApprovedForSession) UnmarshalJSON(data []byte) error { } r.Approval = value } + r.ManagedApprovalHandled = raw.ManagedApprovalHandled return nil } diff --git a/go/rpc/zsession_events.go b/go/rpc/zsession_events.go index 44f49948f4..7f24ab6283 100644 --- a/go/rpc/zsession_events.go +++ b/go/rpc/zsession_events.go @@ -53,7 +53,17 @@ func (r RawSessionEventData) Type() SessionEventType { type SessionEventType string const ( - SessionEventTypeAbort SessionEventType = "abort" + SessionEventTypeAbort SessionEventType = "abort" + SessionEventTypeAgentInterrupted SessionEventType = "agent.interrupted" + // Experimental: SessionEventTypeAssistantFusionPhaseCompleted identifies an experimental + // event that may change or be removed. + SessionEventTypeAssistantFusionPhaseCompleted SessionEventType = "assistant.fusion_phase_completed" + // Experimental: SessionEventTypeAssistantFusionPhaseFailed identifies an experimental event + // that may change or be removed. + SessionEventTypeAssistantFusionPhaseFailed SessionEventType = "assistant.fusion_phase_failed" + // Experimental: SessionEventTypeAssistantFusionPhaseStarted identifies an experimental + // event that may change or be removed. + SessionEventTypeAssistantFusionPhaseStarted SessionEventType = "assistant.fusion_phase_started" SessionEventTypeAssistantIdle SessionEventType = "assistant.idle" SessionEventTypeAssistantIntent SessionEventType = "assistant.intent" SessionEventTypeAssistantMessage SessionEventType = "assistant.message" @@ -81,24 +91,36 @@ const ( 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" - 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: SessionEventTypeFactoryRunSettled identifies an experimental event that may + // change or be removed. + SessionEventTypeFactoryRunSettled SessionEventType = "factory.run_settled" + // Experimental: SessionEventTypeFactoryRunStarted identifies an experimental event that may + // change or be removed. + SessionEventTypeFactoryRunStarted SessionEventType = "factory.run_started" + // 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" + SessionEventTypeModelCallFinished SessionEventType = "model.call_finished" + SessionEventTypeModelCallStart SessionEventType = "model.call_start" + SessionEventTypePendingMessagesModified SessionEventType = "pending_messages.modified" + SessionEventTypePermissionCompleted SessionEventType = "permission.completed" + SessionEventTypePermissionRequested SessionEventType = "permission.requested" + SessionEventTypePromptCacheBreak SessionEventType = "prompt_cache_break" + SessionEventTypeSamplingCompleted SessionEventType = "sampling.completed" + SessionEventTypeSamplingRequested SessionEventType = "sampling.requested" + SessionEventTypeSandboxDecision SessionEventType = "sandbox.decision" // Experimental: SessionEventTypeSessionAutoModeResolved identifies an experimental event // that may change or be removed. SessionEventTypeSessionAutoModeResolved SessionEventType = "session.auto_mode_resolved" @@ -128,16 +150,29 @@ const ( 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: SessionEventTypeSessionFusionCompleted identifies an experimental event + // that may change or be removed. + SessionEventTypeSessionFusionCompleted SessionEventType = "session.fusion_completed" + // Experimental: SessionEventTypeSessionFusionResolved identifies an experimental event that + // may change or be removed. + SessionEventTypeSessionFusionResolved SessionEventType = "session.fusion_resolved" + // Experimental: SessionEventTypeSessionFusionRouteFailed identifies an experimental event + // that may change or be removed. + SessionEventTypeSessionFusionRouteFailed SessionEventType = "session.fusion_route_failed" + // Experimental: SessionEventTypeSessionFusionRouteStarted identifies an experimental event + // that may change or be removed. + SessionEventTypeSessionFusionRouteStarted SessionEventType = "session.fusion_route_started" + 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" @@ -148,46 +183,122 @@ const ( 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" + // Experimental: SessionEventTypeSessionPermissionsChanged identifies an experimental event + // that may change or be removed. + 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" + SessionEventTypeSubagentConfigured SessionEventType = "subagent.configured" + 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" + // Experimental: SessionEventTypeUIEphemeralQuery identifies an experimental event that may + // change or be removed. + SessionEventTypeUIEphemeralQuery SessionEventType = "ui.ephemeral_query" + SessionEventTypeUserInputCompleted SessionEventType = "user_input.completed" + SessionEventTypeUserInputRequested SessionEventType = "user_input.requested" + SessionEventTypeUserMessage SessionEventType = "user.message" ) +// A detected loss of a previously cached prompt prefix +type PromptCacheBreakData struct { + // Request state whose cached prefix fell short + // Internal: AfterRequest is part of the SDK's internal API surface and is not intended for external use. + AfterRequest any `json:"afterRequest,omitempty"` + // Name of the sub-agent whose conversation broke, stamped by the parent bridge + // Internal: AgentName is part of the SDK's internal API surface and is not intended for external use. + AgentName *string `json:"agentName,omitempty"` + // Request state that established the prior cache frontier + // Internal: BeforeRequest is part of the SDK's internal API surface and is not intended for external use. + BeforeRequest any `json:"beforeRequest,omitempty"` + // Names of the cache-configuration fields that changed + // Internal: CacheConfigChangedFields is part of the SDK's internal API surface and is not intended for external use. + CacheConfigChangedFields []string `json:"cacheConfigChangedFields,omitzero"` + // All reasons that contributed to the cache break, ordered by precedence + ContributingReasons []string `json:"contributingReasons"` + // Prior cached prompt frontier in tokens + FrontierTokens int64 `json:"frontierTokens"` + // Model that held the prior cache frontier, when the call changed models + // Internal: ModelFrom is part of the SDK's internal API surface and is not intended for external use. + ModelFrom *string `json:"modelFrom,omitempty"` + // Model this call targeted, when the call changed models + // Internal: ModelTo is part of the SDK's internal API surface and is not intended for external use. + ModelTo *string `json:"modelTo,omitempty"` + // The highest-precedence reason for the cache break + PrimaryReason string `json:"primaryReason"` + // Fraction of the prior cache frontier that survived + RetentionRatio float64 `json:"retentionRatio"` + // Index of the first conversation message whose content changed + // Internal: RewriteMessageIndex is part of the SDK's internal API surface and is not intended for external use. + RewriteMessageIndex *int64 `json:"rewriteMessageIndex,omitempty"` + // Shape of the history rewrite, for example whether the history grew or shrank + // Internal: RewriteShape is part of the SDK's internal API surface and is not intended for external use. + RewriteShape *string `json:"rewriteShape,omitempty"` + // Subsystems that announced a history rewrite before this call, for example compaction or truncation + // Internal: RewriteSource is part of the SDK's internal API surface and is not intended for external use. + RewriteSource []string `json:"rewriteSource,omitzero"` + // Cached prefix tokens lost since the prior call + ShortfallTokens int64 `json:"shortfallTokens"` + // Number of cached prefix tokens that survived + SurvivedTokens int64 `json:"survivedTokens"` + // Names of the system-prompt segments whose content changed + // Internal: SystemSegmentsChanged is part of the SDK's internal API surface and is not intended for external use. + SystemSegmentsChanged []string `json:"systemSegmentsChanged,omitzero"` + // Telemetry-safe names of tools added since the prior call + // Internal: ToolsAdded is part of the SDK's internal API surface and is not intended for external use. + ToolsAdded []string `json:"toolsAdded,omitzero"` + // Raw names of tools added since the prior call, restricted because a tool name can be user-authored + // Internal: ToolsAddedRaw is part of the SDK's internal API surface and is not intended for external use. + ToolsAddedRaw []string `json:"toolsAddedRaw,omitzero"` + // Telemetry-safe names of tools whose definition changed since the prior call + // Internal: ToolsRedefined is part of the SDK's internal API surface and is not intended for external use. + ToolsRedefined []string `json:"toolsRedefined,omitzero"` + // Raw names of tools redefined since the prior call, restricted because a tool name can be user-authored + // Internal: ToolsRedefinedRaw is part of the SDK's internal API surface and is not intended for external use. + ToolsRedefinedRaw []string `json:"toolsRedefinedRaw,omitzero"` + // Telemetry-safe names of tools removed since the prior call + // Internal: ToolsRemoved is part of the SDK's internal API surface and is not intended for external use. + ToolsRemoved []string `json:"toolsRemoved,omitzero"` + // Raw names of tools removed since the prior call, restricted because a tool name can be user-authored + // Internal: ToolsRemovedRaw is part of the SDK's internal API surface and is not intended for external use. + ToolsRemovedRaw []string `json:"toolsRemovedRaw,omitzero"` + // Whether the tool list kept its members but changed their order + // Internal: ToolsReordered is part of the SDK's internal API surface and is not intended for external use. + ToolsReordered *bool `json:"toolsReordered,omitempty"` +} + +func (*PromptCacheBreakData) sessionEventData() {} +func (*PromptCacheBreakData) Type() SessionEventType { return SessionEventTypePromptCacheBreak } + // Agent intent description for current activity or plan type AssistantIntentData struct { // Short description of what the agent is currently doing or planning to do @@ -214,6 +325,8 @@ type AssistantReasoningData struct { Content string `json:"content"` // Unique identifier for this reasoning block ReasoningID string `json:"reasoningId"` + // Per-request treatment/eligibility signal returned by the Copilot API in the `X-GitHub-Copilot-Request-TE` response header for the associated model call; `false` when the header was absent or unparseable. + Rte *bool `json:"rte,omitempty"` } func (*AssistantReasoningData) sessionEventData() {} @@ -223,6 +336,10 @@ func (*AssistantReasoningData) Type() SessionEventType { return SessionEventType type AssistantMessageData struct { // 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"` @@ -232,6 +349,9 @@ type AssistantMessageData struct { Content string `json:"content"` // Encrypted reasoning content from OpenAI models. Session-bound and stripped on resume. EncryptedContent *string `json:"encryptedContent,omitempty"` + // Experimental HydraFusion source attribution for this ordinary authoritative assistant message. + // Experimental: Fusion is part of an experimental API and may change or be removed. + Fusion *FusionAttribution `json:"fusion,omitempty"` // CAPI interaction ID for correlating this message with upstream telemetry InteractionID *string `json:"interactionId,omitempty"` // Unique identifier for this assistant message @@ -245,6 +365,8 @@ type AssistantMessageData struct { ParentToolCallID *string `json:"parentToolCallId,omitempty"` // Generation phase for phased-output models (e.g., thinking vs. response phases) Phase *string `json:"phase,omitempty"` + // Neutral provider-tagged reasoning content blocks preserved verbatim for round-tripping. `reasoningText` and `reasoningOpaque` are a lossy derived view of these blocks, retained for display. + ReasoningBlocks *AssistantMessageReasoningBlocks `json:"reasoningBlocks,omitempty"` // Opaque/encrypted extended thinking data from Anthropic models. Session-bound and stripped on resume. ReasoningOpaque *string `json:"reasoningOpaque,omitempty"` // Readable reasoning text from the model's extended thinking @@ -253,6 +375,8 @@ type AssistantMessageData struct { 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"` + // Per-request treatment/eligibility signal returned by the Copilot API in the `X-GitHub-Copilot-Request-TE` response header for the associated model call; `false` when the header was absent or unparseable. + 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 @@ -269,18 +393,36 @@ func (*AssistantMessageData) Type() SessionEventType { return SessionEventTypeAs // 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() {} @@ -356,12 +498,18 @@ func (*SessionBinaryAssetData) Type() SessionEventType { return SessionEventType 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() {} @@ -369,8 +517,23 @@ 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 { + // Canonical model identifier used for model-specific behavior when replaying compaction + BehaviorModelID *string `json:"behaviorModelId,omitempty"` // Checkpoint snapshot number created for recovery CheckpointNumber *int64 `json:"checkpointNumber,omitempty"` // File path where the checkpoint was stored @@ -403,10 +566,14 @@ type SessionCompactionCompleteData struct { 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() {} @@ -510,6 +677,9 @@ 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"` + // Internal per-conversation prompt-cache-break detector baselines restored on resume + // Internal: PromptCacheBreakState is part of the SDK's internal API surface and is not intended for external use. + PromptCacheBreakState []any `json:"promptCacheBreakState,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 @@ -598,22 +768,28 @@ func (*PendingMessagesModifiedData) Type() SessionEventType { return SessionEventTypePendingMessagesModified } -// Enterprise managed-settings resolution: the effective managed settings the session applied and where they came from, so SDK clients can show users what is enterprise-managed and by which authority. 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; for a session-independent pull, use the SDK `getManagedSettings()` API, which returns the identical payload. Managed settings have a single authoritative source, so the highest-authority present layer (server > device) wins wholesale; `bypassPermissionsDisabled` is deny-wins across layers. Marked experimental while the managed-settings surface stabilizes. +// 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 the device (MDM/plist/registry/file) managed-settings layer was present + // 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 effective sandbox policy forces the sandbox on *only* because managed policy could not be determined, rather than because the policy requires it. Lets clients tell a user whose `--no-sandbox` was overridden that the sandbox stayed on as a fail-closed fallback, instead of attributing it to an administrator who set no such policy. + SandboxEnabledByUndeterminedPolicy *bool `json:"sandboxEnabledByUndeterminedPolicy,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"` - // Which channel supplied the effective managed settings (the winning layer), or `none` when no policy is in force + // 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"` } @@ -622,6 +798,18 @@ 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"` + // Factory run identifier. + 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 @@ -633,6 +821,40 @@ type HookProgressData struct { func (*HookProgressData) sessionEventData() {} func (*HookProgressData) Type() SessionEventType { return SessionEventTypeHookProgress } +// Ephemeral signal that a factory run attempt began executing. +// Experimental: FactoryRunStartedData is part of an experimental API and may change or be removed. +type FactoryRunStartedData struct { + // Attempt number this start committed; a resumed run increments it. + Attempt int64 `json:"attempt"` + // Name of the factory this run executes. Low cardinality by construction. + FactoryName string `json:"factoryName"` + // Identifier of the factory run that started. + RunID string `json:"runId"` +} + +func (*FactoryRunStartedData) sessionEventData() {} +func (*FactoryRunStartedData) Type() SessionEventType { return SessionEventTypeFactoryRunStarted } + +// Ephemeral signal that a factory run reached a terminal status. +// Experimental: FactoryRunSettledData is part of an experimental API and may change or be removed. +type FactoryRunSettledData struct { + // AI credits this run consumed, in nano-AIU. + ConsumedNanoAiu int64 `json:"consumedNanoAiu"` + // Subagents this run consumed against its limits. + ConsumedSubagents int64 `json:"consumedSubagents"` + // Active milliseconds accumulated across every attempt of this run. + ElapsedMs int64 `json:"elapsedMs"` + // Typed failure class recorded on the run, when it failed with one (e.g. `factory_limit_reached`). + FailureType *string `json:"failureType,omitempty"` + // Identifier of the factory run that settled. + RunID string `json:"runId"` + // Terminal status the run committed. + Status FactoryRunSettledStatus `json:"status"` +} + +func (*FactoryRunSettledData) sessionEventData() {} +func (*FactoryRunSettledData) Type() SessionEventType { return SessionEventTypeFactoryRunSettled } + // Error details for timeline display including message and optional diagnostic information type SessionErrorData struct { // Only set on `errorType: "rate_limit"`. When `true`, the runtime will follow this error with an `auto_mode_switch.requested` event (or silently switch if `continueOnAutoMode` is enabled). UI clients can use this flag to suppress duplicate rendering of the rate-limit error when they show their own auto-mode-switch prompt. @@ -658,6 +880,243 @@ type SessionErrorData struct { func (*SessionErrorData) sessionEventData() {} func (*SessionErrorData) Type() SessionEventType { return SessionEventTypeSessionError } +// Experimental durable HydraFusion phase output and lossless replay checkpoint. +// Experimental: AssistantFusionPhaseCompletedData is part of an experimental API and may change or be removed. +type AssistantFusionPhaseCompletedData struct { + // Provider-normalized textual output produced by the phase. + Content string `json:"content"` + // Conversation scope in which the phase executed. + ConversationScope FusionConversationScope `json:"conversationScope"` + // Elapsed execution time for the phase in milliseconds. + DurationMs float64 `json:"durationMs"` + // Identifier of the HydraFusion turn containing the phase. + FusionID string `json:"fusionId"` + // Concrete model that executed the phase. + Model string `json:"model"` + // Stable identifier for the completed phase. + PhaseID string `json:"phaseId"` + // Kind of phase that completed. + PhaseKind FusionPhaseKind `json:"phaseKind"` + // Exact provider-normalized message used to reconstruct canonical model history. + // Internal: ProjectionMessage is part of the SDK's internal API surface and is not intended for external use. + ProjectionMessage any `json:"projectionMessage,omitempty"` + // Projection action for the exact internal message. + // Internal: ProjectionMode is part of the SDK's internal API surface and is not intended for external use. + ProjectionMode *FusionProjectionMode `json:"projectionMode,omitempty"` + // Semantic role assigned to the completed phase. + Role string `json:"role"` + // Terminal request held outside canonical state until selected by the final commit. + // Internal: StagedTerminal is part of the SDK's internal API surface and is not intended for external use. + StagedTerminal *FusionStagedTerminal `json:"stagedTerminal,omitempty"` + // Durable outcome status of the phase. + Status FusionPhaseStatus `json:"status"` + // Aggregate concrete-model usage consumed by the phase. + Usage FusionPhaseUsage `json:"usage"` + // Structured judge or critic verdict, when the phase produces one. + Verdict *string `json:"verdict"` +} + +func (*AssistantFusionPhaseCompletedData) sessionEventData() {} +func (*AssistantFusionPhaseCompletedData) Type() SessionEventType { + return SessionEventTypeAssistantFusionPhaseCompleted +} + +// Experimental durable HydraFusion routing failure and the deterministic concrete fallback selected for the turn. +// Experimental: SessionFusionRouteFailedData is part of an experimental API and may change or be removed. +type SessionFusionRouteFailedData struct { + // Identifier of the routing attempt that failed. + AttemptID string `json:"attemptId"` + // Provider or validation error detail, when available. + ErrorMessage *string `json:"errorMessage,omitempty"` + // Concrete model selected as the deterministic fallback. + FallbackModel string `json:"fallbackModel"` + // HydraFusion routing policy requested for the turn. + Policy string `json:"policy"` + // Stable machine-readable reason for the routing failure. + Reason string `json:"reason"` + // Elapsed routing time in milliseconds before the failure. + RoutingLatencyMs *float64 `json:"routingLatencyMs,omitempty"` + // Synthetic HydraFusion model selected for the session. + SyntheticModel string `json:"syntheticModel"` +} + +func (*SessionFusionRouteFailedData) sessionEventData() {} +func (*SessionFusionRouteFailedData) Type() SessionEventType { + return SessionEventTypeSessionFusionRouteFailed +} + +// Experimental durable aggregate outcome of a HydraFusion turn. +// Experimental: SessionFusionCompletedData is part of an experimental API and may change or be removed. +type SessionFusionCompletedData struct { + // Total cached input tokens reported across all phases. + CachedTokens int64 `json:"cachedTokens"` + // Total tokens written to prompt cache across all phases. + CacheWriteTokens *int64 `json:"cacheWriteTokens,omitempty"` + // Idempotency identifier for the authoritative final commit. + CommitID string `json:"commitId"` + // Reason the turn used a degraded route, when applicable. + DegradedReason *string `json:"degradedReason"` + // Total elapsed execution time for the HydraFusion turn in milliseconds. + DurationMs float64 `json:"durationMs"` + // Concrete model that supplied the authoritative final content. + FinalSourceModel *string `json:"finalSourceModel"` + // Phase whose output supplied the authoritative final content. + FinalSourcePhaseID *string `json:"finalSourcePhaseId"` + // Concrete model recommended for eligible follow-up turns. + FollowUpModel string `json:"followUpModel"` + // Stable identifier for the completed HydraFusion turn. + FusionID string `json:"fusionId"` + // Total input tokens consumed across all phases. + InputTokens int64 `json:"inputTokens"` + // Stable aggregate outcome of the HydraFusion turn. + Outcome string `json:"outcome"` + // Total output tokens produced across all phases. + OutputTokens int64 `json:"outputTokens"` + // HydraFusion orchestration pattern executed for the turn. + Pattern FusionPattern `json:"pattern"` + // Number of concrete phases attempted by the turn. + PhaseCount int64 `json:"phaseCount"` + // Total concrete model requests made across all phases. + RequestCount int64 `json:"requestCount"` + // Synthetic HydraFusion model selected for the session. + SyntheticModel string `json:"syntheticModel"` + // Total normalized AI-unit cost reported across all phases, in nano-AIU. + TotalNanoAiu float64 `json:"totalNanoAiu"` + // Identifier of the session turn associated with the completion. + TurnID string `json:"turnId"` +} + +func (*SessionFusionCompletedData) sessionEventData() {} +func (*SessionFusionCompletedData) Type() SessionEventType { + return SessionEventTypeSessionFusionCompleted +} + +// Experimental durable typed HydraFusion phase failure and degradation transition. +// Experimental: AssistantFusionPhaseFailedData is part of an experimental API and may change or be removed. +type AssistantFusionPhaseFailedData struct { + // Conversation scope in which the phase executed. + ConversationScope FusionConversationScope `json:"conversationScope"` + // Identifier of the fallback phase used to continue the turn after degradation. + DegradedToPhaseID *string `json:"degradedToPhaseId,omitempty"` + // Elapsed execution time before the phase failed, in milliseconds. + DurationMs float64 `json:"durationMs"` + // Provider or execution error detail, when available. + ErrorMessage *string `json:"errorMessage,omitempty"` + // Identifier of the HydraFusion turn containing the phase. + FusionID string `json:"fusionId"` + // Concrete model that attempted the phase. + Model string `json:"model"` + // Stable identifier for the failed phase. + PhaseID string `json:"phaseId"` + // Kind of phase that failed. + PhaseKind FusionPhaseKind `json:"phaseKind"` + // Stable machine-readable reason for the phase failure. + Reason string `json:"reason"` + // Semantic role assigned to the failed phase. + Role string `json:"role"` + // Durable outcome status of the phase. + Status FusionPhaseStatus `json:"status"` + // Aggregate concrete-model usage consumed before the failure. + Usage FusionPhaseUsage `json:"usage"` +} + +func (*AssistantFusionPhaseFailedData) sessionEventData() {} +func (*AssistantFusionPhaseFailedData) Type() SessionEventType { + return SessionEventTypeAssistantFusionPhaseFailed +} + +// Experimental durable validated HydraFusion route and turn policy. +// Experimental: SessionFusionResolvedData is part of an experimental API and may change or be removed. +type SessionFusionResolvedData struct { + // Version of the validated HydraFusion event contract. + ContractVersion int64 `json:"contractVersion"` + // Concrete model used when the planned primary model cannot execute. + FallbackModel string `json:"fallbackModel"` + // Router recommendation controlling reuse or rerouting on later turns. + FollowUp *FusionFollowUpRecommendation `json:"followUp,omitempty"` + // Concrete model recommended for eligible follow-up turns. + FollowUpModel string `json:"followUpModel"` + // Stable identifier for the resolved HydraFusion turn. + FusionID string `json:"fusionId"` + // Version of the executable model universe used for selection. + ModelUniverseVersion *string `json:"modelUniverseVersion,omitempty"` + // Validated orchestration pattern selected for the turn. + Pattern FusionPattern `json:"pattern"` + // Version of the validated execution-plan format. + PlanVersion *string `json:"planVersion,omitempty"` + // HydraFusion routing policy used to resolve the plan. + Policy string `json:"policy"` + // Version of the local routing policy. + PolicyVersion *string `json:"policyVersion,omitempty"` + // Concrete model selected for the primary solver phase. + PrimaryModel string `json:"primaryModel"` + // Router implementation that supplied the plan. + RouteSource *string `json:"routeSource,omitempty"` + // Elapsed time in milliseconds required to resolve and validate the route. + RoutingLatencyMs *float64 `json:"routingLatencyMs,omitempty"` + // Identifier of the local policy rule that matched. + RuleID *string `json:"ruleId,omitempty"` + // Zero-based index of the local policy rule that matched. + RuleIndex *int64 `json:"ruleIndex,omitempty"` + // Human-readable name of the local policy rule that matched. + RuleName *string `json:"ruleName,omitempty"` + // Validated capability scores used to select the route. + Scores *FusionScores `json:"scores,omitempty"` + // Concrete model selected for the review or judge phase, when required. + SecondaryModel *string `json:"secondaryModel"` + // Synthetic HydraFusion model selected for the session. + SyntheticModel string `json:"syntheticModel"` + // Identifier of the session turn associated with the route. + TurnID string `json:"turnId"` +} + +func (*SessionFusionResolvedData) sessionEventData() {} +func (*SessionFusionResolvedData) Type() SessionEventType { + return SessionEventTypeSessionFusionResolved +} + +// Experimental transient HydraFusion phase/model/role signal. +// Experimental: AssistantFusionPhaseStartedData is part of an experimental API and may change or be removed. +type AssistantFusionPhaseStartedData struct { + // Conversation scope in which the phase executes. + ConversationScope FusionConversationScope `json:"conversationScope"` + // Identifier of the HydraFusion turn containing the phase. + FusionID string `json:"fusionId"` + // Concrete model executing the phase. + Model string `json:"model"` + // HydraFusion orchestration pattern containing the phase. + Pattern FusionPattern `json:"pattern"` + // Stable identifier for the concrete phase. + PhaseID string `json:"phaseId"` + // Kind of phase being executed. + PhaseKind FusionPhaseKind `json:"phaseKind"` + // Semantic role assigned to the phase. + Role string `json:"role"` +} + +func (*AssistantFusionPhaseStartedData) sessionEventData() {} +func (*AssistantFusionPhaseStartedData) Type() SessionEventType { + return SessionEventTypeAssistantFusionPhaseStarted +} + +// Experimental transient signal that HydraFusion routing has started for an eligible turn. +// Experimental: SessionFusionRouteStartedData is part of an experimental API and may change or be removed. +type SessionFusionRouteStartedData struct { + // Identifier for this routing attempt before a durable Fusion turn exists. + AttemptID string `json:"attemptId"` + // HydraFusion routing policy requested for the turn. + Policy *string `json:"policy,omitempty"` + // Synthetic HydraFusion model selected for the session. + SyntheticModel *string `json:"syntheticModel,omitempty"` + // Kind of turn being routed. + TurnKind FusionTurnKind `json:"turnKind"` +} + +func (*SessionFusionRouteStartedData) sessionEventData() {} +func (*SessionFusionRouteStartedData) Type() SessionEventType { + return SessionEventTypeSessionFusionRouteStarted +} + // External tool completion notification signaling UI dismissal type ExternalToolCompletedData struct { // Request ID of the resolved external tool request; clients should dismiss any UI for this request @@ -673,6 +1132,8 @@ func (*ExternalToolCompletedData) Type() SessionEventType { type ExternalToolRequestedData struct { // Arguments to pass to the external tool Arguments any `json:"arguments,omitempty"` + // Stable provider identity captured with an extension-owned tool definition; hosts use it to route the request to the same provider that was offered to the model + ProviderID *string `json:"providerId,omitempty"` // Unique identifier for this request; used to respond via session.respondToExternalTool() RequestID string `json:"requestId"` // Session ID that this external tool request belongs to @@ -712,8 +1173,13 @@ type ModelCallFailureData struct { ErrorType *string `json:"errorType,omitempty"` // Whether the failure originated from an API response or the request transport FailureKind *ModelCallFailureKind `json:"failureKind,omitempty"` + // Experimental HydraFusion attribution for this failed concrete model call. + // Experimental: Fusion is part of an experimental API and may change or be removed. + Fusion *FusionAttribution `json:"fusion,omitempty"` // What initiated this API call (e.g., "sub-agent", "mcp-sampling"); absent for user-initiated calls Initiator *string `json:"initiator,omitempty"` + // Authoritative interaction classification for the failed call, matching `assistant.usage.interactionType` (for example `conversation-agent`, `conversation-subagent`, or `conversation-sampling`). Absent when the producer cannot classify the interaction. + InteractionType *string `json:"interactionType,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 @@ -733,6 +1199,8 @@ type ModelCallFailureData struct { 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"` + // Per-request treatment/eligibility signal returned by the Copilot API in the `X-GitHub-Copilot-Request-TE` response header for the associated model call; `false` when the header was absent or unparseable. + 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 @@ -746,6 +1214,25 @@ type ModelCallFailureData struct { func (*ModelCallFailureData) sessionEventData() {} func (*ModelCallFailureData) Type() SessionEventType { return SessionEventTypeModelCallFailure } +// Final lifecycle outcome for one logical model dispatch. A logical dispatch may include internal reconnect or fallback work, so event count is not provider HTTP-request count. +type ModelCallFinishedData struct { + // Whether an accepted successful response requested the exact name and command semantics of a built-in file edit tool, including an external tool explicitly replacing that built-in name. Absent when the logical dispatch did not produce an accepted response. + ContainsBuiltInFileEditRequest *bool `json:"containsBuiltInFileEditRequest,omitempty"` + // Monotonic elapsed time spent in the logical model dispatch, including any internal transport reconnect or fallback and excluding orchestrator retry backoff, tool execution, confirmations, and post-response processing + DispatchDurationMs float64 `json:"dispatchDurationMs"` + // Version of the built-in file-edit semantic classifier used for this event + EditClassifierVersion int64 `json:"editClassifierVersion"` + // Identifier of the user interaction that owns the model dispatch, matching assistant.turn_start.interactionId when available + InteractionID *string `json:"interactionId,omitempty"` + // Final outcome after post-response acceptance processing + Outcome ModelCallFinishedOutcome `json:"outcome"` + // Agent-loop iteration within the interaction that initiated the model dispatch + TurnID string `json:"turnId"` +} + +func (*ModelCallFinishedData) sessionEventData() {} +func (*ModelCallFinishedData) Type() SessionEventType { return SessionEventTypeModelCallFinished } + // Hook invocation completion details including output, success status, and error information type HookEndData struct { // Error details when the hook failed @@ -756,6 +1243,8 @@ type HookEndData struct { HookType string `json:"hookType"` // Output data produced by the hook Output any `json:"output,omitempty"` + // Tool call ID of the parent tool invocation when this event originates from a sub-agent + ParentToolCallID *string `json:"parentToolCallId,omitempty"` // Whether the hook completed successfully Success bool `json:"success"` } @@ -771,6 +1260,8 @@ type HookStartData struct { HookType string `json:"hookType"` // Input data passed to the hook Input any `json:"input,omitempty"` + // Tool call ID of the parent tool invocation when this event originates from a sub-agent + ParentToolCallID *string `json:"parentToolCallId,omitempty"` } func (*HookStartData) sessionEventData() {} @@ -793,14 +1284,25 @@ func (*SessionInfoData) Type() SessionEventType { return SessionEventTypeSession // LLM API call usage metrics including tokens, costs, quotas, and billing information type AssistantUsageData struct { + // Number of accepted speculative prediction tokens + AcceptedPredictionTokens *int64 `json:"acceptedPredictionTokens,omitempty"` // 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"` + // 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"` + // Whether the provider reported prompt-cache usage details for this call + // Internal: CacheDetailsReported is part of the SDK's internal API surface and is not intended for external use. + CacheDetailsReported *bool `json:"cacheDetailsReported,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"` + // Effective prompt-cache lifetime in seconds for this call + // Internal: CacheTtlSeconds is part of the SDK's internal API surface and is not intended for external use. + CacheTtlSeconds *int64 `json:"cacheTtlSeconds,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. @@ -814,16 +1316,37 @@ type AssistantUsageData struct { 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"` + // How the prompt-cache frontier was determined for this call + // Internal: FrontierSource is part of the SDK's internal API surface and is not intended for external use. + FrontierSource *string `json:"frontierSource,omitempty"` + // Experimental HydraFusion attribution for this concrete model call's usage. + // Experimental: Fusion is part of an experimental API and may change or be removed. + Fusion *FusionAttribution `json:"fusion,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"` + // Whether Auto mode was selected for this model call + IsAuto *bool `json:"isAuto,omitempty"` + // Whether this model call used a bring-your-own-key provider + IsByok *bool `json:"isByok,omitempty"` + // Requested maximum output tokens used for this model call + MaxOutputTokens *int64 `json:"maxOutputTokens,omitempty"` + // Effective maximum prompt-token limit used for this model call + MaxPromptTokens *int64 `json:"maxPromptTokens,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"` + // Time to first observable model output in milliseconds. Includes text, reasoning, and tool-call output; only available for streaming requests that produce observable output. + OutputTtftMs *float64 `json:"outputTtftMs,omitempty"` // Parent tool call ID when this usage originates from a sub-agent // Deprecated: ParentToolCallID is deprecated. ParentToolCallID *string `json:"parentToolCallId,omitempty"` @@ -834,12 +1357,26 @@ type AssistantUsageData struct { 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"` + // Reasoning summary mode used for this model call, if applicable + ReasoningSummary *ReasoningSummary `json:"reasoningSummary,omitempty"` // Number of output tokens used for reasoning (e.g., chain-of-thought) ReasoningTokens *int64 `json:"reasoningTokens,omitempty"` + // Number of rejected speculative prediction tokens + RejectedPredictionTokens *int64 `json:"rejectedPredictionTokens,omitempty"` + // Per-request treatment/eligibility signal returned by the Copilot API in the `X-GitHub-Copilot-Request-TE` response header for the associated model call; `false` when the header was absent or unparseable. + 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 *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"` + // Transport used for this model call (http or websocket) + Transport *AssistantUsageTransport `json:"transport,omitempty"` } func (*AssistantUsageData) sessionEventData() {} @@ -922,10 +1459,49 @@ type AssistantTurnRetryData struct { func (*AssistantTurnRetryData) sessionEventData() {} func (*AssistantTurnRetryData) Type() SessionEventType { return SessionEventTypeAssistantTurnRetry } +// Metadata for work the user interrupted while the agent was running +type AgentInterruptedData struct { + // What the agent was doing when the user interrupted it + Activity AgentInterruptedActivity `json:"activity"` + // For an interrupted model call: the provider endpoint the request targeted + APIEndpoint *string `json:"apiEndpoint,omitempty"` + // For an interrupted model call: whether the user interrupted before any token arrived or while the response was streaming + CancelPhase *AgentInterruptedCancelPhase `json:"cancelPhase,omitempty"` + // How long the interrupted work had been running, in milliseconds + ElapsedMs float64 `json:"elapsedMs"` + // For an interrupted background-agent batch: how many background sub-agents the stop swept. Counts accepted cancellations, so an agent cancelled as a cascade of its interrupted parent is covered by that parent rather than counted again. + InterruptedAgentCount *int64 `json:"interruptedAgentCount,omitempty"` + // For an interrupted model call: the model the request targeted + Model *string `json:"model,omitempty"` + // For a mid-stream interrupt: the observed time to first observable output, in milliseconds. Deliberately distinct from the `ttftMs` reported on a successful model call, which measures time to first stream event. + OutputTtftMs *float64 `json:"outputTtftMs,omitempty"` + // For an interrupted model call: the reasoning effort the request asked for + ReasoningEffort *string `json:"reasoningEffort,omitempty"` + // Subset of `toolNames` whose tool metadata marks the tool name as safe to record unhashed in telemetry. + SafeToolNames []string `json:"safeToolNames,omitzero"` + // Tool call identifiers that were still running + ToolCallIDs []string `json:"toolCallIds,omitzero"` + // Names of the tools that were still running. More than one when the model requested a parallel fan-out. + ToolNames []string `json:"toolNames,omitzero"` + // For an interrupted model call: the transport the request used + Transport *ModelCallFailureTransport `json:"transport,omitempty"` + // Zero-based agentic-loop iteration the interrupt landed in + Turn int64 `json:"turn"` +} + +func (*AgentInterruptedData) sessionEventData() {} +func (*AgentInterruptedData) Type() SessionEventType { return SessionEventTypeAgentInterrupted } + // Model API dispatch metadata for internal telemetry type ModelCallStartData struct { + // Experimental HydraFusion attribution for this concrete model call. + // Experimental: Fusion is part of an experimental API and may change or be removed. + Fusion *FusionAttribution `json:"fusion,omitempty"` // 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"` } @@ -935,7 +1511,7 @@ func (*ModelCallStartData) Type() SessionEventType { return SessionEventTypeMode // 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 *ContextTier `json:"contextTier,omitempty"` @@ -953,6 +1529,8 @@ type SessionModelChangeData struct { ReasoningEffort *string `json:"reasoningEffort,omitempty"` // Reasoning summary mode after the model change, if applicable ReasoningSummary *ReasoningSummary `json:"reasoningSummary,omitempty"` + // Origin of the effective model change, when known. + Source *ModelChangeSource `json:"source,omitempty"` // Output verbosity level after the model change, if applicable Verbosity *Verbosity `json:"verbosity,omitempty"` } @@ -1013,6 +1591,24 @@ func (*SessionCustomNotificationData) Type() SessionEventType { return SessionEventTypeSessionCustomNotification } +// Ordered output and terminal state for a transient query that does not modify conversation history. +// Experimental: UIEphemeralQueryData is part of an experimental API and may change or be removed. +type UIEphemeralQueryData struct { + // Full response text, present for the `completed` phase. + Answer *string `json:"answer,omitempty"` + // Ordered text delta, present for the `chunk` phase. + Chunk *string `json:"chunk,omitempty"` + // Model or transport failure message, present for the `failed` phase. + Error *string `json:"error,omitempty"` + // Current query lifecycle phase. + Phase UIEphemeralQueryPhase `json:"phase"` + // Runtime-minted query identifier. + RequestID string `json:"requestId"` +} + +func (*UIEphemeralQueryData) sessionEventData() {} +func (*UIEphemeralQueryData) Type() SessionEventType { return SessionEventTypeUIEphemeralQuery } + // 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 @@ -1057,11 +1653,20 @@ func (*MCPToolsListChangedData) Type() SessionEventType { return SessionEventTyp type SessionIdleData struct { // True when the preceding agentic loop was cancelled via abort signal Aborted *bool `json:"aborted,omitempty"` + // The session mode the agent was operating in when it went idle, when the mode is known. Lets turn-scoped consumers distinguish an autopilot continuation boundary (where the agent keeps working after this idle) from a genuine turn completion. + Mode *SessionMode `json:"mode,omitempty"` } func (*SessionIdleData) sessionEventData() {} func (*SessionIdleData) Type() SessionEventType { return SessionEventTypeSessionIdle } +// Payload of `sandbox.decision`, a bounded governance record of what the process sandbox was configured to do and whether it took effect. Discriminated by `kind`. +type SandboxDecisionData struct { +} + +func (*SandboxDecisionData) sessionEventData() {} +func (*SandboxDecisionData) Type() SessionEventType { return SessionEventTypeSandboxDecision } + // 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 { @@ -1157,7 +1762,7 @@ type SessionMCPServerStatusChangedData struct { 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 + // Connection status: connected, failed, needs-auth, pending, disabled, stopped, or not_configured Status MCPServerStatus `json:"status"` } @@ -1213,12 +1818,14 @@ type UserMessageData struct { 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 (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 `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"` + // The agent-loop turn ID that consumed this message; absent when no agent-loop turn consumed it + TurnID *string `json:"turnId,omitempty"` } func (*UserMessageData) sessionEventData() {} @@ -1247,23 +1854,25 @@ 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 transition. +// Permission-mode transition details. +// Experimental: SessionPermissionsChangedData is part of an experimental API and may change or be removed. 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"` + // Explicit LLM judge model override used by assisted mode; omitted when the provider default applies + // Experimental: AssistedApprovalModel is part of an experimental API and may change or be removed. + AssistedApprovalModel *string `json:"assistedApprovalModel,omitempty"` + // Permission mode after the change + // Experimental: Mode is part of an experimental API and may change or be removed. + Mode PermissionMode `json:"mode"` + // Permission mode before the change + // Experimental: PreviousMode is part of an experimental API and may change or be removed. + PreviousMode PermissionMode `json:"previousMode"` } func (*SessionPermissionsChangedData) sessionEventData() {} @@ -1286,6 +1895,8 @@ func (*ToolSearchActivatedData) Type() SessionEventType { return SessionEventTyp type ExitPlanModeRequestedData struct { // Available actions the user can take Actions []ExitPlanModeAction `json:"actions"` + // Model the session had selected when the plan was authored, when one is known + Model *string `json:"model,omitempty"` // Full content of the plan file PlanContent string `json:"planContent"` // Recommended action to preselect for the user @@ -1364,6 +1975,21 @@ type CommandExecuteData struct { func (*CommandExecuteData) sessionEventData() {} func (*CommandExecuteData) Type() SessionEventType { return SessionEventTypeCommandExecute } +// Resolved runtime configuration for a configured sub-agent +type SubagentConfiguredData struct { + // Resolved context tier, when configured for the model + ContextTier *string `json:"contextTier,omitempty"` + // Resolved model the sub-agent will run with + Model string `json:"model"` + // Whether the sub-agent accepts follow-up turns + MultiTurn bool `json:"multiTurn"` + // Resolved reasoning effort, when configured for the model + ReasoningEffort *string `json:"reasoningEffort,omitempty"` +} + +func (*SubagentConfiguredData) sessionEventData() {} +func (*SubagentConfiguredData) Type() SessionEventType { return SessionEventTypeSubagentConfigured } + // 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 { @@ -1438,6 +2064,8 @@ type SessionScheduleCreatedData struct { ID int64 `json:"id"` // 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`) @@ -1508,6 +2136,8 @@ type SessionStartData struct { 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") @@ -1580,7 +2210,7 @@ type SessionResumeData struct { Context *WorkingDirectoryContext `json:"context,omitempty"` // Context tier currently selected at resume time; null when no tier is active 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 (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 *bool `json:"continuePendingWork,omitempty"` // Total number of persisted events in the session at the time of resume EventCount int64 `json:"eventCount"` @@ -1598,7 +2228,7 @@ type SessionResumeData struct { SelectedModel *string `json:"selectedModel,omitempty"` // Session limits currently configured at resume time; null when no limits are active SessionLimits *SessionLimitsConfig `json:"sessionLimits,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. + // 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"` @@ -1622,6 +2252,8 @@ func (*SessionSnapshotRewindData) Type() SessionEventType { // Session termination metrics including usage statistics, code changes, and shutdown reason type SessionShutdownData struct { + // Per-agent usage breakdown, keyed by agent instance identifier. The main conversation uses the stable key `main`. + AgentMetrics map[string]ShutdownAgentMetric `json:"agentMetrics,omitzero"` // Aggregate code change metrics for the session CodeChanges ShutdownCodeChanges `json:"codeChanges"` // Non-system message token count at shutdown @@ -1791,8 +2423,20 @@ type SubagentCompletedData struct { 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"` + // Whether the first model actually dispatched matched the user's configured preference + ConfiguredModelMatchesActual *bool `json:"configuredModelMatchesActual,omitempty"` + // Concrete model the user configured for this sub-agent via `/subagents`, when present + ConfiguredModelPreference *string `json:"configuredModelPreference,omitempty"` // Wall-clock duration of the sub-agent execution in milliseconds DurationMs *int64 `json:"durationMs,omitempty"` + // Whether the explicit task-call model matched the user's configured preference + ExplicitModelMatchesPreference *bool `json:"explicitModelMatchesPreference,omitempty"` + // Explicit model supplied by the parent agent on the task call, when present + ExplicitModelOverride *string `json:"explicitModelOverride,omitempty"` + // First model for which the sub-agent started an inference request, when one was dispatched + FirstDispatchedModel *string `json:"firstDispatchedModel,omitempty"` // Model used by the sub-agent Model *string `json:"model,omitempty"` // Tool call ID of the parent tool invocation that spawned this sub-agent @@ -1812,10 +2456,20 @@ type SubagentFailedData struct { AgentDisplayName string `json:"agentDisplayName"` // Internal name of the sub-agent AgentName string `json:"agentName"` + // Whether the first model actually dispatched matched the user's configured preference + ConfiguredModelMatchesActual *bool `json:"configuredModelMatchesActual,omitempty"` + // Concrete model the user configured for this sub-agent via `/subagents`, when present + ConfiguredModelPreference *string `json:"configuredModelPreference,omitempty"` // Wall-clock duration of the sub-agent execution in milliseconds DurationMs *int64 `json:"durationMs,omitempty"` // Error message describing why the sub-agent failed Error string `json:"error"` + // Whether the explicit task-call model matched the user's configured preference + ExplicitModelMatchesPreference *bool `json:"explicitModelMatchesPreference,omitempty"` + // Explicit model supplied by the parent agent on the task call, when present + ExplicitModelOverride *string `json:"explicitModelOverride,omitempty"` + // First model for which the sub-agent started an inference request, when one was dispatched + FirstDispatchedModel *string `json:"firstDispatchedModel,omitempty"` // 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 @@ -1837,8 +2491,18 @@ type SubagentStartedData struct { AgentDisplayName string `json:"agentDisplayName"` // Internal name of the sub-agent AgentName string `json:"agentName"` + // Type of the sub-agent selected at spawn time. + AgentType *string `json:"agentType,omitempty"` + // Whether the sub-agent runs synchronously or in the background. + ExecutionMode *string `json:"executionMode,omitempty"` + // Root id of the factory run that spawned this sub-agent, when it was spawned by one. + FactoryRunID *string `json:"factoryRunId,omitempty"` // Model the sub-agent will run with, when known at start. Model *string `json:"model,omitempty"` + // Task-registry ID of the spawning sub-agent. Absent when the root session spawned this child. + ParentID *string `json:"parentId,omitempty"` + // Whether this sub-agent can be resumed. Currently always false. + Resumable *bool `json:"resumable,omitempty"` // Tool call ID of the parent tool invocation that spawned this sub-agent ToolCallID string `json:"toolCallId"` } @@ -1861,6 +2525,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 @@ -1874,10 +2540,6 @@ 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) - Success *bool `json:"success,omitempty"` - // Summary of the completed task, provided by the agent - Summary *string `json:"summary,omitempty"` } func (*SessionTaskCompleteData) sessionEventData() {} @@ -1887,6 +2549,9 @@ func (*SessionTaskCompleteData) Type() SessionEventType { return SessionEventTyp type ToolExecutionCompleteData struct { // Error details when the tool execution failed Error *ToolExecutionCompleteError `json:"error,omitempty"` + // Experimental HydraFusion attribution for this tool completion. + // Experimental: Fusion is part of an experimental API and may change or be removed. + Fusion *FusionAttribution `json:"fusion,omitempty"` // CAPI interaction ID for correlating this tool execution with upstream telemetry InteractionID *string `json:"interactionId,omitempty"` // Whether this tool call was explicitly requested by the user rather than the assistant @@ -1901,6 +2566,8 @@ type ToolExecutionCompleteData struct { ParentToolCallID *string `json:"parentToolCallId,omitempty"` // Tool execution result on success Result *ToolExecutionCompleteResult `json:"result,omitempty"` + // Per-request treatment/eligibility signal returned by the Copilot API in the `X-GitHub-Copilot-Request-TE` response header for the associated model call; `false` when the header was absent or unparseable. + 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 @@ -1939,6 +2606,9 @@ type ToolExecutionStartData struct { Arguments any `json:"arguments,omitempty"` // When true, the tool output should be displayed expanded (verbatim) in the CLI timeline DisplayVerbatim *bool `json:"displayVerbatim,omitempty"` + // Experimental HydraFusion attribution for this tool execution. + // Experimental: Fusion is part of an experimental API and may change or be removed. + Fusion *FusionAttribution `json:"fusion,omitempty"` // Name of the MCP server hosting this tool, when the tool is an MCP tool MCPServerName *string `json:"mcpServerName,omitempty"` // Original tool name on the MCP server, when the tool is an MCP tool @@ -1948,6 +2618,8 @@ type ToolExecutionStartData struct { // 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"` + // Per-request treatment/eligibility signal returned by the Copilot API in the `X-GitHub-Copilot-Request-TE` response header for the associated model call; `false` when the header was absent or unparseable. + 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 @@ -2082,6 +2754,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") @@ -2106,14 +2780,28 @@ func (*SessionWorkspaceFileChangedData) Type() SessionEventType { return SessionEventTypeSessionWorkspaceFileChanged } +// Neutral provider-tagged reasoning content blocks preserved verbatim for round-tripping +// Experimental: AssistantMessageReasoningBlocks is part of an experimental API and may change or be removed. +type AssistantMessageReasoningBlocks struct { + // Provider-native reasoning content blocks (e.g. Anthropic `thinking` / `redacted_thinking`) preserved verbatim, in order. A single response can carry several, each signed over the content preceding it, so dropping or reordering any of them invalidates the rest. + Blocks []any `json:"blocks,omitzero"` + // Model provider that produced these reasoning blocks. + Provider string `json:"provider"` +} + // 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"` + // Advisor model identifier associated with the server-tool payload. + AdvisorModel *string `json:"advisorModel,omitempty"` + // Provider function-call namespaces keyed by function-call identifier. FunctionCallNamespaces map[string]string `json:"functionCallNamespaces,omitzero"` - Items []any `json:"items,omitzero"` - Provider string `json:"provider"` - RawContentBlocks []any `json:"rawContentBlocks,omitzero"` + // Provider-native server-tool call and output items preserved verbatim for replay. + Items []any `json:"items,omitzero"` + // Model provider that produced this server-tool payload. + Provider string `json:"provider"` + // Raw provider content blocks retained for verbatim round-tripping. + RawContentBlocks []any `json:"rawContentBlocks,omitzero"` } // A tool invocation request from the assistant @@ -2447,6 +3135,103 @@ 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"` +} + +// Experimental attribution linking an ordinary event to the HydraFusion turn, phase, and concrete source that produced it. +// Experimental: FusionAttribution is part of an experimental API and may change or be removed. +type FusionAttribution struct { + // Idempotency identifier for the authoritative commit, when the event belongs to the selected output. + CommitID *string `json:"commitId,omitempty"` + // Conversation scope in which the concrete phase executed. + ConversationScope *string `json:"conversationScope,omitempty"` + // Stable identifier for the HydraFusion turn that produced the event. + FusionID string `json:"fusionId"` + // HydraFusion orchestration pattern selected for the turn. + Pattern string `json:"pattern"` + // Identifier of the concrete phase that produced the event. + PhaseID *string `json:"phaseId,omitempty"` + // Kind of concrete phase that produced the event. + PhaseKind *string `json:"phaseKind,omitempty"` + // HydraFusion routing policy used for the turn. + Policy string `json:"policy"` + // Semantic role assigned to the concrete phase. + Role *string `json:"role,omitempty"` + // Concrete model that produced the attributed event. + SourceModel *string `json:"sourceModel,omitempty"` + // Phase whose output supplied the authoritative content, when different from the executing phase. + SourcePhaseID *string `json:"sourcePhaseId,omitempty"` + // Synthetic HydraFusion model selected for the session. + SyntheticModel string `json:"syntheticModel"` +} + +// Durable server recommendation for subsequent HydraFusion turns. +// Experimental: FusionFollowUpRecommendation is part of an experimental API and may change or be removed. +type FusionFollowUpRecommendation struct { + // Recommended routing action for the next compaction turn. + CompactionTurn FusionFollowUpAction `json:"compactionTurn"` + // Recommended routing action for the next user-message turn. + UserTurn FusionFollowUpAction `json:"userTurn"` +} + +// Aggregate concrete-model usage for one HydraFusion phase. +// Experimental: FusionPhaseUsage is part of an experimental API and may change or be removed. +type FusionPhaseUsage struct { + // Total cached input tokens reported for the phase. + CachedTokens int64 `json:"cachedTokens"` + // Total tokens written to prompt cache during the phase. + CacheWriteTokens *int64 `json:"cacheWriteTokens,omitempty"` + // Total input tokens consumed by the phase. + InputTokens int64 `json:"inputTokens"` + // Total output tokens produced by the phase. + OutputTokens int64 `json:"outputTokens"` + // Number of concrete model requests made by the phase. + RequestCount int64 `json:"requestCount"` + // Total normalized AI-unit cost reported for the phase, in nano-AIU. + TotalNanoAiu float64 `json:"totalNanoAiu"` +} + +// Validated HydraFusion routing capability scores. +// Experimental: FusionScores is part of an experimental API and may change or be removed. +type FusionScores struct { + // Code-generation capability score returned by the authenticated router. + CodeGen float64 `json:"codeGen"` + // Debugging capability score returned by the authenticated router. + Debugging float64 `json:"debugging"` + // Reasoning capability score returned by the authenticated router. + Reasoning float64 `json:"reasoning"` + // Tool-use capability score returned by the authenticated router. + ToolUse float64 `json:"toolUse"` +} + +// Internal durable terminal request staged by a HydraFusion phase until an idempotent final commit selects it. +// Experimental: FusionStagedTerminal is part of an experimental API and may change or be removed. +// Internal: FusionStagedTerminal is an internal SDK API and is not part of the public surface. +type FusionStagedTerminal struct { + Arguments string `json:"arguments"` + AssistantMessage any `json:"assistantMessage"` + PhaseID string `json:"phaseId"` + ToolCallID string `json:"toolCallId"` + ToolName string `json:"toolName"` +} + +// 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 @@ -2539,7 +3324,7 @@ type MCPServersLoadedServer struct { 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 + // 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"` @@ -2563,13 +3348,17 @@ type ModelCallFailureRequestFingerprint struct { 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 { +// Assisted-approval judge information attached to a permission request. Present only in assisted mode; its absence means the judge did not evaluate the request. The `recommendation` conveys the judge's disposition for this request. +// Experimental: PermissionAssistedApproval is part of an experimental API and may change or be removed. +type PermissionAssistedApproval struct { + // Classified cause of an `error` recommendation. Absent for every other recommendation. + FailureReason *AssistedApprovalJudgeFailureReason `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"` + // The assisted-approval safety judge's outcome for this request. + Recommendation AssistedApprovalRecommendation `json:"recommendation"` } // Derived user-facing permission prompt details for UI consumers @@ -2590,9 +3379,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"` + // Assisted-approval judge information for this request; present only in assisted mode. + // Experimental: AssistedApproval is part of an experimental API and may change or be removed. + AssistedApproval *PermissionAssistedApproval `json:"assistedApproval,omitempty"` // Whether the UI can offer session-wide approval for this command pattern CanOfferSessionApproval bool `json:"canOfferSessionApproval"` // Command identifiers covered by this approval prompt @@ -2601,6 +3390,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 @@ -2616,9 +3407,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"` + // Assisted-approval judge information for this request; present only in assisted mode. + // Experimental: AssistedApproval is part of an experimental API and may change or be removed. + AssistedApproval *PermissionAssistedApproval `json:"assistedApproval,omitempty"` // Tool call ID that triggered this permission request ToolCallID *string `json:"toolCallId,omitempty"` // Description of what the custom tool does @@ -2632,11 +3423,29 @@ func (PermissionPromptRequestCustomTool) Kind() PermissionPromptRequestKind { return PermissionPromptRequestKindCustomTool } +// Extension sensitive environment variable access prompt +type PermissionPromptRequestExtensionEnvAccess struct { + // Assisted-approval judge information for this request; present only in assisted mode. + // Experimental: AssistedApproval is part of an experimental API and may change or be removed. + AssistedApproval *PermissionAssistedApproval `json:"assistedApproval,omitempty"` + // Names of the sensitive environment variables the extension is requesting. Values never appear here. + EnvironmentVariables []string `json:"environmentVariables"` + // Name of the extension requesting environment variable access + ExtensionName string `json:"extensionName"` + // Tool call ID that triggered this permission request + ToolCallID *string `json:"toolCallId,omitempty"` +} + +func (PermissionPromptRequestExtensionEnvAccess) permissionPromptRequest() {} +func (PermissionPromptRequestExtensionEnvAccess) Kind() PermissionPromptRequestKind { + return PermissionPromptRequestKindExtensionEnvAccess +} + // 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"` + // Assisted-approval judge information for this request; present only in assisted mode. + // Experimental: AssistedApproval is part of an experimental API and may change or be removed. + AssistedApproval *PermissionAssistedApproval `json:"assistedApproval,omitempty"` // Name of the extension being managed ExtensionName *string `json:"extensionName,omitempty"` // The extension management operation (scaffold, reload) @@ -2652,9 +3461,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"` + // Assisted-approval judge information for this request; present only in assisted mode. + // Experimental: AssistedApproval is part of an experimental API and may change or be removed. + AssistedApproval *PermissionAssistedApproval `json:"assistedApproval,omitempty"` // Capabilities the extension is requesting Capabilities []string `json:"capabilities"` // Name of the extension requesting permission access @@ -2668,11 +3477,55 @@ 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"` + // Assisted-approval judge information for this request; present only in assisted mode. + // Experimental: AssistedApproval is part of an experimental API and may change or be removed. + AssistedApproval *PermissionAssistedApproval `json:"assistedApproval,omitempty"` + // Whether this factory is eligible for persistent approval + CanPersistApproval bool `json:"canPersistApproval"` + // Factory-declared AI-credit limit before any run/resume caller override is applied. + DeclaredMaxAiCredits *float64 `json:"declaredMaxAiCredits,omitempty"` + // Factory-declared concurrent-subagent limit before any run/resume caller override is applied. + DeclaredMaxConcurrentSubagents *int64 `json:"declaredMaxConcurrentSubagents,omitempty"` + // Factory-declared total-subagent limit before any run/resume caller override is applied. + DeclaredMaxTotalSubagents *int64 `json:"declaredMaxTotalSubagents,omitempty"` + // Factory-declared active-time limit in seconds before any run/resume caller override is applied. + 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"` + // Assisted-approval judge information for this request; present only in assisted mode. + // Experimental: AssistedApproval is part of an experimental API and may change or be removed. + AssistedApproval *PermissionAssistedApproval `json:"assistedApproval,omitempty"` // Optional message from the hook explaining why confirmation is needed HookMessage *string `json:"hookMessage,omitempty"` // Arguments of the tool call being gated @@ -2692,9 +3545,14 @@ func (PermissionPromptRequestHook) Kind() PermissionPromptRequestKind { type PermissionPromptRequestMCP struct { // Arguments to pass to the MCP 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"` + // Assisted-approval judge information for this request; present only in assisted mode. + // Experimental: AssistedApproval is part of an experimental API and may change or be removed. + AssistedApproval *PermissionAssistedApproval `json:"assistedApproval,omitempty"` + // Whether the host may offer a server-wide "approve all tools from this server" blanket. Absent is treated as true; the runtime sends false when managed policy disables bypass-permissions mode, which forbids the server-wide escalation while still allowing per-tool approval. + CanOfferServerWideApproval *bool `json:"canOfferServerWideApproval,omitempty"` + // Advisory runtime permission recommendation. The host remains responsible for deciding the request and may reject it. + // Experimental: PermissionRecommendation is part of an experimental API and may change or be removed. + PermissionRecommendation *PermissionRecommendation `json:"permissionRecommendation,omitempty"` // Name of the MCP server providing the tool ServerName string `json:"serverName"` // Tool call ID that triggered this permission request @@ -2714,9 +3572,9 @@ func (PermissionPromptRequestMCP) Kind() PermissionPromptRequestKind { 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"` + // Assisted-approval judge information for this request; present only in assisted mode. + // Experimental: AssistedApproval is part of an experimental API and may change or be removed. + AssistedApproval *PermissionAssistedApproval `json:"assistedApproval,omitempty"` // Source references for the stored fact (store only) Citations *string `json:"citations,omitempty"` // Vote direction (vote only) @@ -2740,9 +3598,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"` + // Assisted-approval judge information for this request; present only in assisted mode. + // Experimental: AssistedApproval is part of an experimental API and may change or be removed. + AssistedApproval *PermissionAssistedApproval `json:"assistedApproval,omitempty"` // File paths that require explicit approval Paths []string `json:"paths"` // Tool call ID that triggered this permission request @@ -2756,11 +3614,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"` + // Assisted-approval judge information for this request; present only in assisted mode. + // Experimental: AssistedApproval is part of an experimental API and may change or be removed. + AssistedApproval *PermissionAssistedApproval `json:"assistedApproval,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 @@ -2774,11 +3634,15 @@ 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"` + // Assisted-approval judge information for this request; present only in assisted mode. + // Experimental: AssistedApproval is part of an experimental API and may change or be removed. + AssistedApproval *PermissionAssistedApproval `json:"assistedApproval,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. @@ -2796,9 +3660,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"` + // Assisted-approval judge information for this request; present only in assisted mode. + // Experimental: AssistedApproval is part of an experimental API and may change or be removed. + AssistedApproval *PermissionAssistedApproval `json:"assistedApproval,omitempty"` // Whether the UI can offer session-wide approval for file write operations CanOfferSessionApproval bool `json:"canOfferSessionApproval"` // Unified diff showing the proposed changes @@ -2807,6 +3671,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 @@ -2822,6 +3688,7 @@ func (PermissionPromptRequestWrite) Kind() PermissionPromptRequestKind { type PermissionRequest interface { permissionRequest() Kind() PermissionRequestKind + RequiresManagedApproval() bool } type RawPermissionRequest struct { @@ -2838,6 +3705,10 @@ 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"` + // Whether the tool declared that permission may be skipped unless a deny rule matches + SkipPermission *bool `json:"skipPermission,omitempty"` // Tool call ID that triggered this permission request ToolCallID *string `json:"toolCallId,omitempty"` // Description of what the custom tool does @@ -2851,10 +3722,29 @@ func (PermissionRequestCustomTool) Kind() PermissionRequestKind { return PermissionRequestKindCustomTool } +// Extension sensitive environment variable access request +type PermissionRequestExtensionEnvAccess struct { + // Names of the sensitive environment variables the extension is requesting. Values never appear here. + EnvironmentVariables []string `json:"environmentVariables"` + // Name of the extension requesting environment variable 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"` +} + +func (PermissionRequestExtensionEnvAccess) permissionRequest() {} +func (PermissionRequestExtensionEnvAccess) Kind() PermissionRequestKind { + return PermissionRequestKindExtensionEnvAccess +} + // Extension management permission request 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 @@ -2872,6 +3762,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"` } @@ -2881,10 +3773,53 @@ 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"` + // Factory-declared AI-credit limit before any run/resume caller override is applied. + DeclaredMaxAiCredits *float64 `json:"declaredMaxAiCredits,omitempty"` + // Factory-declared concurrent-subagent limit before any run/resume caller override is applied. + DeclaredMaxConcurrentSubagents *int64 `json:"declaredMaxConcurrentSubagents,omitempty"` + // Factory-declared total-subagent limit before any run/resume caller override is applied. + DeclaredMaxTotalSubagents *int64 `json:"declaredMaxTotalSubagents,omitempty"` + // Factory-declared active-time limit in seconds before any run/resume caller override is applied. + 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 @@ -2902,6 +3837,11 @@ func (PermissionRequestHook) Kind() PermissionRequestKind { 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"` + // Advisory runtime permission recommendation. The SDK host remains responsible for deciding the request and may reject it. + // Experimental: PermissionRecommendation is part of an experimental API and may change or be removed. + PermissionRecommendation *PermissionRecommendation `json:"permissionRecommendation,omitempty"` // Whether this MCP tool is read-only (no side effects) ReadOnly bool `json:"readOnly"` // Name of the MCP server providing the tool @@ -2923,14 +3863,23 @@ func (PermissionRequestMCP) Kind() PermissionRequestKind { type PermissionRequestMemory struct { // Whether this is a store or vote memory operation Action *PermissionRequestMemoryAction `json:"action,omitempty"` + // Assisted-approval judge information for this request; present only in assisted mode. + // Experimental: AssistedApproval is part of an experimental API and may change or be removed. + AssistedApproval *PermissionAssistedApproval `json:"assistedApproval,omitempty"` // Source references for the stored fact (store only) Citations *string `json:"citations,omitempty"` // Vote direction (vote only) 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"` + // Repository name with owner associated with the stored memory (store only) + RepoNwo *string `json:"repoNwo,omitempty"` + // Scope of the stored memory (store only) + Scope *PermissionRequestMemoryScope `json:"scope,omitempty"` // Topic or subject of the memory (store only) Subject *string `json:"subject,omitempty"` // Tool call ID that triggered this permission request @@ -2946,6 +3895,8 @@ 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. @@ -2967,12 +3918,16 @@ 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 @@ -2996,6 +3951,10 @@ 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. @@ -3021,6 +3980,8 @@ 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. @@ -3044,6 +4005,14 @@ type PermissionRequestShellCommand struct { ReadOnly bool `json:"readOnly"` } +// 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 @@ -3068,6 +4037,8 @@ func (r RawPermissionResult) Kind() PermissionResultKind { // Permission response variant indicating the request was approved without persisting an approval rule. type PermissionApproved struct { + // Whether a managed approval policy already handled this request + ManagedApprovalHandled *bool `json:"managedApprovalHandled,omitempty"` } func (PermissionApproved) permissionResult() {} @@ -3081,6 +4052,8 @@ type PermissionApprovedForLocation struct { Approval UserToolSessionApproval `json:"approval"` // The location key (git root or cwd) to persist the approval to LocationKey string `json:"locationKey"` + // Whether a managed approval policy already handled this request + ManagedApprovalHandled *bool `json:"managedApprovalHandled,omitempty"` } func (PermissionApprovedForLocation) permissionResult() {} @@ -3092,6 +4065,8 @@ func (PermissionApprovedForLocation) Kind() PermissionResultKind { type PermissionApprovedForSession struct { // The approval to add as a session-scoped rule Approval UserToolSessionApproval `json:"approval"` + // Whether a managed approval policy already handled this request + ManagedApprovalHandled *bool `json:"managedApprovalHandled,omitempty"` } func (PermissionApprovedForSession) permissionResult() {} @@ -3263,6 +4238,20 @@ type SessionLimitsExhaustedResponse struct { MaxAiCredits *float64 `json:"maxAiCredits,omitempty"` } +// Usage attributed to one agent instance at session shutdown. +type ShutdownAgentMetric struct { + // Human-readable label for this subagent invocation, copied from the originating `subagent.started` event. For task-tool subagents this is the invocation's task description rather than the agent's configured display name, so group by `agentName` for stable per-agent labels. + AgentDisplayName *string `json:"agentDisplayName,omitempty"` + // Configured agent name, when this is a subagent + AgentName *string `json:"agentName,omitempty"` + // Per-model usage for this agent, keyed by model identifier + ModelMetrics map[string]ShutdownModelMetric `json:"modelMetrics"` + // Time spent in model API calls by this agent, in milliseconds + TotalAPIDurationMs int64 `json:"totalApiDurationMs"` + // Accumulated nano-AI units cost for this agent + TotalNanoAiu float64 `json:"totalNanoAiu"` +} + // Aggregate code change metrics for the session type ShutdownCodeChanges struct { // List of file paths that were modified during the session @@ -3326,6 +4315,8 @@ type ShutdownTokenDetail struct { 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 @@ -3366,12 +4357,14 @@ func (r RawSystemNotification) Type() SystemNotificationType { // 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 + // Unique task identifier AgentID string `json:"agentId"` // Type of the agent (e.g., explore, task, general-purpose) AgentType string `json:"agentType"` // Human-readable description of the agent task Description *string `json:"description,omitempty"` + // Friendly, non-unique name intended for display + DisplayName *string `json:"displayName,omitempty"` // The full prompt given to the background agent Prompt *string `json:"prompt,omitempty"` // Whether the agent completed successfully or failed @@ -3385,12 +4378,14 @@ func (SystemNotificationAgentCompleted) Type() SystemNotificationType { // 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 + // Unique task identifier AgentID string `json:"agentId"` // Type of the agent (e.g., explore, task, general-purpose) AgentType string `json:"agentType"` // Human-readable description of the agent task Description *string `json:"description,omitempty"` + // Friendly, non-unique name intended for display + DisplayName *string `json:"displayName,omitempty"` } func (SystemNotificationAgentIdle) systemNotification() {} @@ -3398,6 +4393,35 @@ func (SystemNotificationAgentIdle) Type() SystemNotificationType { return SystemNotificationTypeAgentIdle } +// 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/') @@ -3460,6 +4484,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() @@ -3542,6 +4577,8 @@ type ToolExecutionCompleteContentShellExit struct { Cwd *string `json:"cwd,omitempty"` // Exit code from the completed shell command ExitCode int64 `json:"exitCode"` + // Path reported in the shell session's filesystem namespace when shell output exceeded the configured large-output threshold. + OutputFilePath *string `json:"outputFilePath,omitempty"` // 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 @@ -3677,18 +4714,24 @@ type ToolExecutionCompleteUIResourceMeta struct { // MCP Apps UI resource metadata for a completed tool result, including CSP, permissions, domain, and border preference. type ToolExecutionCompleteUIResourceMetaUI struct { // 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"` + Csp *ToolExecutionCompleteUIResourceMetaUICsp `json:"csp,omitempty"` + // Optional dedicated origin for the rendered MCP Apps UI resource. + Domain *string `json:"domain,omitempty"` // 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"` + Permissions *ToolExecutionCompleteUIResourceMetaUIPermissions `json:"permissions,omitempty"` + // Whether the host should render a border around the MCP Apps UI resource. + PrefersBorder *bool `json:"prefersBorder,omitempty"` } // CSP domain allowlists for an MCP Apps UI resource, including connect, resource, frame, and base URI domains. type ToolExecutionCompleteUIResourceMetaUICsp struct { - BaseURIDomains []string `json:"baseUriDomains,omitzero"` - ConnectDomains []string `json:"connectDomains,omitzero"` - FrameDomains []string `json:"frameDomains,omitzero"` + // Domains the UI resource may use as document base URIs. + BaseURIDomains []string `json:"baseUriDomains,omitzero"` + // Domains the UI resource may connect to. + ConnectDomains []string `json:"connectDomains,omitzero"` + // Domains the UI resource may embed as nested frames. + FrameDomains []string `json:"frameDomains,omitzero"` + // Domains from which the UI resource may load scripts, styles, images, and other resources. ResourceDomains []string `json:"resourceDomains,omitzero"` } @@ -3722,6 +4765,9 @@ type ToolExecutionCompleteUIResourceMetaUIPermissionsMicrophone struct { // 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. @@ -3778,12 +4824,38 @@ 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") RepositoryHost *string `json:"repositoryHost,omitempty"` } +// What the agent was doing when the user interrupted it. +type AgentInterruptedActivity string + +const ( + // Background sub-agents were running while the main loop was idle. + AgentInterruptedActivityBackgroundAgent AgentInterruptedActivity = "background_agent" + // A request to the model was open. + AgentInterruptedActivityModelCall AgentInterruptedActivity = "model_call" + // The turn was sleeping between retry attempts. + AgentInterruptedActivityRetryBackoff AgentInterruptedActivity = "retry_backoff" + // One or more tools were executing. + AgentInterruptedActivityToolCall AgentInterruptedActivity = "tool_call" +) + +// Where the interruption landed relative to the first streamed token. +type AgentInterruptedCancelPhase string + +const ( + // The response was already streaming when the request was cancelled. + AgentInterruptedCancelPhaseMidStream AgentInterruptedCancelPhase = "mid_stream" + // No output had been produced when the request was cancelled. + AgentInterruptedCancelPhasePreFirstToken AgentInterruptedCancelPhase = "pre_first_token" +) + // Tool call type: "function" for standard tool calls, "custom" for grammar-based tool calls. Defaults to "function" when absent. type AssistantMessageToolRequestType string @@ -3808,19 +4880,46 @@ const ( AssistantUsageAPIEndpointWsResponses AssistantUsageAPIEndpoint = "ws:/responses" ) -// 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 +// Transport used for a successful model call +type AssistantUsageTransport string + +const ( + // HTTP transport, including SSE streams. + AssistantUsageTransportHTTP AssistantUsageTransport = "http" + // WebSocket transport. + AssistantUsageTransportWebsocket AssistantUsageTransport = "websocket" +) + +// Why the assisted-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: AssistedApprovalJudgeFailureReason is part of an experimental API and may change or be removed. +type AssistedApprovalJudgeFailureReason string + +const ( + // The judge model call was cancelled before it returned. + AssistedApprovalJudgeFailureReasonAbort AssistedApprovalJudgeFailureReason = "abort" + // The judge model call completed but returned no content. + AssistedApprovalJudgeFailureReasonEmptyResponse AssistedApprovalJudgeFailureReason = "empty_response" + // The judge model call failed (for example a transport, authentication, or rate-limit error). + AssistedApprovalJudgeFailureReasonModelError AssistedApprovalJudgeFailureReason = "model_error" + // The judge model replied, but the reply carried no ALLOW/DENY verdict. + AssistedApprovalJudgeFailureReasonParseError AssistedApprovalJudgeFailureReason = "parse_error" + // The judge model call exceeded its deadline. + AssistedApprovalJudgeFailureReasonTimeout AssistedApprovalJudgeFailureReason = "timeout" +) + +// Outcome of the assisted-approval safety judge for a permission request. Present only in assisted mode; its absence means the judge did not evaluate the request. +// Experimental: AssistedApprovalRecommendation is part of an experimental API and may change or be removed. +type AssistedApprovalRecommendation string const ( // The judge evaluated the request and recommends automatically approving it. - AutoApprovalRecommendationApprove AutoApprovalRecommendation = "approve" + AssistedApprovalRecommendationApprove AssistedApprovalRecommendation = "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" + AssistedApprovalRecommendationError AssistedApprovalRecommendation = "error" + // Assisted mode is enabled, but this request category is never automatically approvable (for example, sandbox-bypass requests), so the judge was not consulted. + AssistedApprovalRecommendationExcluded AssistedApprovalRecommendation = "excluded" + // The judge evaluated the request and does not recommend automatically approving it; explicit approval is required. Whether that means prompting, denying, or something else is the consumer's decision. + AssistedApprovalRecommendationRequireApproval AssistedApprovalRecommendation = "requireApproval" ) // Coarse request-difficulty bucket for UX explainability @@ -3916,6 +5015,22 @@ const ( CitationProviderOpenai CitationProvider = "openai" ) +// What initiated a conversation compaction +type CompactionTrigger string + +const ( + // 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) type ElicitationCompletedAction string @@ -3987,6 +5102,123 @@ 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" +) + +// Terminal status a factory run committed. A settled run is never `pending` or `running`, so those two members of the run-status domain are deliberately absent. +type FactoryRunSettledStatus string + +const ( + // The run was cancelled by its caller or by session disposal. + FactoryRunSettledStatusCancelled FactoryRunSettledStatus = "cancelled" + // The factory body resolved and its result was committed. + FactoryRunSettledStatusCompleted FactoryRunSettledStatus = "completed" + // The run failed, with `failureType` carrying the class when it has one. + FactoryRunSettledStatusError FactoryRunSettledStatus = "error" + // The run was stopped by a limit, an approval refusal or another policy decision. + FactoryRunSettledStatusHalted FactoryRunSettledStatus = "halted" +) + +// Conversation scope in which a HydraFusion phase executes. +// Experimental: FusionConversationScope is part of an experimental API and may change or be removed. +type FusionConversationScope string + +const ( + // Isolated read-only review history that does not enter the root conversation. + FusionConversationScopeReview FusionConversationScope = "review" + // Canonical root conversation history. + FusionConversationScopeRoot FusionConversationScope = "root" +) + +// Server-recommended routing behavior for a later HydraFusion turn. +// Experimental: FusionFollowUpAction is part of an experimental API and may change or be removed. +type FusionFollowUpAction string + +const ( + // Request a new routing decision. + FusionFollowUpActionReroute FusionFollowUpAction = "reroute" + // Reuse the durable primary model without routing. + FusionFollowUpActionReusePrimary FusionFollowUpAction = "reuse_primary" +) + +// Validated HydraFusion execution pattern. +// Experimental: FusionPattern is part of an experimental API and may change or be removed. +type FusionPattern string + +const ( + // Run a primary phase, a judge, and an optional repair. + FusionPatternCascade FusionPattern = "cascade" + // Run a primary draft, a read-only critique, and a revision. + FusionPatternCritique FusionPattern = "critique" + // Run one primary solver phase. + FusionPatternSingle FusionPattern = "single" +) + +// HydraFusion phase kind. +// Experimental: FusionPhaseKind is part of an experimental API and may change or be removed. +type FusionPhaseKind string + +const ( + // Read-only critique phase. + FusionPhaseKindCritic FusionPhaseKind = "critic" + // Initial critique-pattern draft phase. + FusionPhaseKindDraft FusionPhaseKind = "draft" + // Follow-up phase continuing from the resolved model. + FusionPhaseKindFollowUp FusionPhaseKind = "follow_up" + // Read-only cascade judge phase. + FusionPhaseKindJudge FusionPhaseKind = "judge" + // Primary solver phase. + FusionPhaseKindPrimary FusionPhaseKind = "primary" + // Cascade repair phase. + FusionPhaseKindRepair FusionPhaseKind = "repair" + // Critique-pattern revision phase. + FusionPhaseKindRevision FusionPhaseKind = "revision" +) + +// Durable outcome status of a HydraFusion phase. +// Experimental: FusionPhaseStatus is part of an experimental API and may change or be removed. +type FusionPhaseStatus string + +const ( + // The phase was cancelled. + FusionPhaseStatusCancelled FusionPhaseStatus = "cancelled" + // The phase failed. + FusionPhaseStatusFailed FusionPhaseStatus = "failed" + // The phase completed successfully. + FusionPhaseStatusSucceeded FusionPhaseStatus = "succeeded" +) + +// How a durable phase checkpoint contributes its exact message to canonical root history. +// Experimental: FusionProjectionMode is part of an experimental API and may change or be removed. +type FusionProjectionMode string + +const ( + // Append the exact root message immediately. + FusionProjectionModeAppend FusionProjectionMode = "append" + // Do not project the checkpoint into root history. + FusionProjectionModeNone FusionProjectionMode = "none" + // Hold a terminal message outside canonical history until the final commit selects it. + FusionProjectionModeStaged FusionProjectionMode = "staged" +) + +// Kind of turn for which HydraFusion routing is running. +// Experimental: FusionTurnKind is part of an experimental API and may change or be removed. +type FusionTurnKind string + +const ( + // A conversation-compaction turn. + FusionTurnKindCompaction FusionTurnKind = "compaction" + // A user-message turn. + FusionTurnKindUser FusionTurnKind = "user" +) + // Origin type of the session being handed off type HandoffSourceType string @@ -4009,27 +5241,33 @@ const ( type ManagedSettingsEnforcedEscalation string const ( - // Full allow-all ("/allow-all on") permissions β€” auto-approving tools, paths, and URLs. + // Full allow-all permissions β€” automatically approving tools, paths, and URLs. ManagedSettingsEnforcedEscalationAllowAll ManagedSettingsEnforcedEscalation = "allow_all" - // Auto-approval of all tool permission requests. + // Automatic 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" + // Assisted mode β€” keeps normal prompt paths and adds an LLM recommendation, distinct from allow-all. + ManagedSettingsEnforcedEscalationAssistedApproval ManagedSettingsEnforcedEscalation = "assisted_approval" + // A server-wide MCP "Always Allow" (or `--allow-tool `) blanket that would auto-approve every tool from an MCP server. Capped to per-tool approval; each tool still prompts. + ManagedSettingsEnforcedEscalationServerWideMCPApproval ManagedSettingsEnforcedEscalation = "server_wide_mcp_approval" // Unrestricted filesystem access outside the session's allowed directories. ManagedSettingsEnforcedEscalationUnrestrictedPaths ManagedSettingsEnforcedEscalation = "unrestricted_paths" // Unrestricted URL fetch access. ManagedSettingsEnforcedEscalationUnrestrictedURLs ManagedSettingsEnforcedEscalation = "unrestricted_urls" ) -// Which channel supplied the effective enterprise managed settings (highest-authority present layer wins wholesale) +// Summary of which managed-settings channels contributed to the effective session policy. Use the per-channel booleans for exact provenance. type ManagedSettingsResolvedSource string const ( - // Device-level MDM policy discovered from plist/registry/file (lower authority). + // Only session-local SDK-host injection contributed. + ManagedSettingsResolvedSourceClient ManagedSettingsResolvedSource = "client" + // Only the device MDM/plist/registry/file channel contributed. ManagedSettingsResolvedSourceDevice ManagedSettingsResolvedSource = "device" - // No managed policy is in force (no layer contributed). + // 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" - // Account/org policy self-fetched from the GitHub managed-settings endpoint (higher authority). + // Only the server/account channel contributed. ManagedSettingsResolvedSourceServer ManagedSettingsResolvedSource = "server" ) @@ -4144,6 +5382,20 @@ const ( ModelCallFailureTransportWebsocket ModelCallFailureTransport = "websocket" ) +// Final outcome of one logical model dispatch after response acceptance processing +type ModelCallFinishedOutcome string + +const ( + // The dispatch was cancelled before an accepted response was produced. + ModelCallFinishedOutcomeCancelled ModelCallFinishedOutcome = "cancelled" + // The dispatch ended with a provider or transport error. + ModelCallFinishedOutcomeError ModelCallFinishedOutcome = "error" + // The provider response was rejected during post-response acceptance processing. + ModelCallFinishedOutcomeRejected ModelCallFinishedOutcome = "rejected" + // The provider response was accepted for continued agent processing. + ModelCallFinishedOutcomeSuccess ModelCallFinishedOutcome = "success" +) + // Binary result type discriminator. Use "image" for images and "resource" for other binary data. type OmittedBinaryType string @@ -4154,27 +5406,16 @@ const ( 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 const ( PermissionPromptRequestKindCommands PermissionPromptRequestKind = "commands" PermissionPromptRequestKindCustomTool PermissionPromptRequestKind = "custom-tool" + PermissionPromptRequestKindExtensionEnvAccess PermissionPromptRequestKind = "extension-env-access" PermissionPromptRequestKindExtensionManagement PermissionPromptRequestKind = "extension-management" PermissionPromptRequestKindExtensionPermissionAccess PermissionPromptRequestKind = "extension-permission-access" + PermissionPromptRequestKindFactory PermissionPromptRequestKind = "factory" PermissionPromptRequestKindHook PermissionPromptRequestKind = "hook" PermissionPromptRequestKindMCP PermissionPromptRequestKind = "mcp" PermissionPromptRequestKindMemory PermissionPromptRequestKind = "memory" @@ -4196,13 +5437,24 @@ const ( PermissionPromptRequestPathAccessKindWrite PermissionPromptRequestPathAccessKind = "write" ) +// Advisory recommendation the runtime attaches to a permission request whose origin it can vouch for by construction. Unlike the auto-approval judge this does not depend on auto mode and does not evaluate what the tool call does; its absence simply means the runtime has no opinion and the request follows the host's normal approval flow. +// Experimental: PermissionRecommendation is part of an experimental API and may change or be removed. +type PermissionRecommendation string + +const ( + // The runtime vouches for the request's origin and recommends approving it without prompting. The host still owns the decision and may deny it; deny rules, managed policy, and the auto-approval safety judge all outrank this recommendation. + PermissionRecommendationApprove PermissionRecommendation = "approve" +) + // Kind discriminator for PermissionRequest. type PermissionRequestKind string const ( PermissionRequestKindCustomTool PermissionRequestKind = "custom-tool" + PermissionRequestKindExtensionEnvAccess PermissionRequestKind = "extension-env-access" PermissionRequestKindExtensionManagement PermissionRequestKind = "extension-management" PermissionRequestKindExtensionPermissionAccess PermissionRequestKind = "extension-permission-access" + PermissionRequestKindFactory PermissionRequestKind = "factory" PermissionRequestKindHook PermissionRequestKind = "hook" PermissionRequestKindMCP PermissionRequestKind = "mcp" PermissionRequestKindMemory PermissionRequestKind = "memory" @@ -4232,6 +5484,16 @@ const ( PermissionRequestMemoryDirectionUpvote PermissionRequestMemoryDirection = "upvote" ) +// Scope of a stored memory. +type PermissionRequestMemoryScope string + +const ( + // Store the memory for the current repository. + PermissionRequestMemoryScopeRepository PermissionRequestMemoryScope = "repository" + // Store the memory for the current user. + PermissionRequestMemoryScopeUser PermissionRequestMemoryScope = "user" +) + // Kind discriminator for PermissionResult. type PermissionResultKind string @@ -4278,6 +5540,16 @@ const ( PlanChangedOperationUpdate PlanChangedOperation = "update" ) +// 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 ( + // 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" +) + // User action selected for an exhausted session limit. type SessionLimitsExhaustedResponseAction string @@ -4324,16 +5596,32 @@ 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" ) // Theme variant this icon is intended for @@ -4379,6 +5667,23 @@ const ( ToolExecutionStartToolDescriptionMetaUIVisibilityModel ToolExecutionStartToolDescriptionMetaUIVisibility = "model" ) +// Lifecycle phase for a Rust-owned ephemeral query stream. +// Experimental: UIEphemeralQueryPhase is part of an experimental API and may change or be removed. +type UIEphemeralQueryPhase string + +const ( + // The ephemeral query stream was cancelled before completing. + UIEphemeralQueryPhaseAborted UIEphemeralQueryPhase = "aborted" + // A partial result chunk was produced by the stream. + UIEphemeralQueryPhaseChunk UIEphemeralQueryPhase = "chunk" + // The ephemeral query stream finished successfully. + UIEphemeralQueryPhaseCompleted UIEphemeralQueryPhase = "completed" + // The ephemeral query stream ended with an error. + UIEphemeralQueryPhaseFailed UIEphemeralQueryPhase = "failed" + // The ephemeral query stream has begun. + UIEphemeralQueryPhaseStarted UIEphemeralQueryPhase = "started" +) + // The agent mode that was active when this message was sent type UserMessageAgentMode string diff --git a/go/session.go b/go/session.go index 3059e3b3ae..5d45d19ef2 100644 --- a/go/session.go +++ b/go/session.go @@ -56,41 +56,45 @@ type sessionHandler struct { // }) type Session struct { // SessionID is the unique identifier for this session. - SessionID string - workspacePath string - client *jsonrpc2.Client - clientSessionAPIs *rpc.ClientSessionAPIHandlers - handlers []sessionHandler - nextHandlerID uint64 - handlerMutex sync.RWMutex - toolHandlers map[string]ToolHandler - toolHandlersM sync.RWMutex - permissionHandler PermissionHandlerFunc - permissionMux sync.RWMutex - mcpAuthHandler MCPAuthHandler - mcpAuthMu sync.RWMutex - userInputHandler UserInputHandler - userInputMux sync.RWMutex - exitPlanModeHandler ExitPlanModeRequestHandler - exitPlanModeMu sync.RWMutex - autoModeSwitchHandler AutoModeSwitchRequestHandler - autoModeSwitchMu sync.RWMutex - hooks *SessionHooks - hooksMux sync.RWMutex - transformCallbacks map[string]SectionTransformFn - transformMu sync.Mutex - commandHandlers map[string]CommandHandler - commandHandlersMu sync.RWMutex - elicitationHandler ElicitationHandler - elicitationMu sync.RWMutex - canvasHandler CanvasHandler - canvasMu sync.RWMutex - bearerTokenProviders map[string]BearerTokenProvider - bearerTokenMu sync.RWMutex - openCanvases []rpc.OpenCanvasInstance - openCanvasesMu sync.RWMutex - capabilities SessionCapabilities - capabilitiesMu sync.RWMutex + SessionID string + workspacePath string + client *jsonrpc2.Client + clientSessionAPIs *rpc.ClientSessionAPIHandlers + handlers []sessionHandler + nextHandlerID uint64 + handlerMutex sync.RWMutex + toolHandlers map[string]ToolHandler + toolHandlersM sync.RWMutex + permissionHandler PermissionHandlerFunc + permissionMux sync.RWMutex + managedSettings bool + mcpAuthHandler MCPAuthHandler + mcpAuthMu sync.RWMutex + userInputHandler UserInputHandler + userInputMux sync.RWMutex + exitPlanModeHandler ExitPlanModeRequestHandler + exitPlanModeMu sync.RWMutex + autoModeSwitchHandler AutoModeSwitchRequestHandler + autoModeSwitchMu sync.RWMutex + hooks *SessionHooks + hooksMux sync.RWMutex + transformCallbacks map[string]SectionTransformFn + transformMu sync.Mutex + commandHandlers map[string]CommandHandler + commandHandlersMu sync.RWMutex + elicitationHandler ElicitationHandler + elicitationMu sync.RWMutex + canvasHandler CanvasHandler + canvasMu sync.RWMutex + bearerTokenProviders map[string]BearerTokenProvider + bearerTokenMu sync.RWMutex + releaseGitHubTokenProvider func() + gitHubTokenProviderMu sync.Mutex + gitHubTokenProviderReleased bool + openCanvases []rpc.OpenCanvasInstance + openCanvasesMu sync.RWMutex + capabilities SessionCapabilities + capabilitiesMu sync.RWMutex // eventCh serializes user event handler dispatch. dispatchEvent enqueues; // a single goroutine (processEvents) dequeues and invokes handlers in FIFO order. @@ -365,10 +369,16 @@ 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{}, handlers: make([]sessionHandler, 0), @@ -488,6 +498,9 @@ func (s *Session) SendAndWait(ctx context.Context, options MessageOptions) (*Ses lastAssistantMessage = &eventCopy mu.Unlock() case *SessionIdleData: + if d.Mode != nil && *d.Mode == SessionModeAutopilot { + break + } select { case idleCh <- struct{}{}: default: @@ -779,6 +792,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 @@ -1575,6 +1598,20 @@ func (s *Session) executeToolAndRespond(requestID, toolName, toolCallID string, 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, @@ -1593,11 +1630,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{}, @@ -1613,6 +1652,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 } @@ -1621,8 +1664,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, }) } @@ -1684,11 +1728,9 @@ func (s *Session) GetEvents(ctx context.Context) ([]SessionEvent, error) { // } func (s *Session) Disconnect() error { _, err := s.client.Request(context.Background(), "session.destroy", sessionDestroyRequest{SessionID: s.SessionID}) - if err != nil { - return fmt.Errorf("failed to disconnect session: %w", err) - } s.closeOnce.Do(func() { close(s.eventCh) }) + s.releaseGitHubTokenProviderRegistration() // Clear handlers s.handlerMutex.Lock() @@ -1711,9 +1753,38 @@ func (s *Session) Disconnect() error { s.elicitationHandler = nil s.elicitationMu.Unlock() + if err != nil { + return fmt.Errorf("failed to disconnect session: %w", err) + } return nil } +func (s *Session) releaseGitHubTokenProviderRegistration() { + s.gitHubTokenProviderMu.Lock() + if s.gitHubTokenProviderReleased { + s.gitHubTokenProviderMu.Unlock() + return + } + s.gitHubTokenProviderReleased = true + release := s.releaseGitHubTokenProvider + s.releaseGitHubTokenProvider = nil + s.gitHubTokenProviderMu.Unlock() + if release != nil { + release() + } +} + +func (s *Session) setGitHubTokenProviderRegistrationRelease(release func()) { + s.gitHubTokenProviderMu.Lock() + if !s.gitHubTokenProviderReleased { + s.releaseGitHubTokenProvider = release + s.gitHubTokenProviderMu.Unlock() + return + } + s.gitHubTokenProviderMu.Unlock() + release() +} + // Abort aborts the currently processing message in this session. // // Use this to cancel a long-running request. The session remains valid @@ -1746,7 +1817,7 @@ 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. diff --git a/go/session_event_serialization_test.go b/go/session_event_serialization_test.go index bd47fdfbe2..ee9258b225 100644 --- a/go/session_event_serialization_test.go +++ b/go/session_event_serialization_test.go @@ -189,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 d2227d629e..0f653f1a0f 100644 --- a/go/session_fs_provider.go +++ b/go/session_fs_provider.go @@ -62,6 +62,36 @@ type SessionFSSqliteProvider interface { SqliteExists() (bool, error) } +// 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. @@ -217,17 +247,50 @@ func (a *sessionFSAdapter) SqliteQuery(request *rpc.SessionFSSqliteQueryRequest) 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) { @@ -250,3 +313,17 @@ func toSessionFSError(err error) *rpc.SessionFSError { msg := err.Error() 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 9c5f4df8c9..74e212c418 100644 --- a/go/session_test.go +++ b/go/session_test.go @@ -366,6 +366,138 @@ func readTestJSONRPCFrame(r io.Reader) ([]byte, error) { return data, err } +func TestSession_SendAndWaitSkipsAutopilotContinuationIdle(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() + + requestReceived := make(chan struct{}) + 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"` + } + if err := json.Unmarshal(frame, &request); err != nil { + errCh <- err + return + } + if request.Method != "session.send" { + errCh <- fmt.Errorf("expected session.send, got %s", request.Method) + return + } + + response := map[string]any{ + "jsonrpc": "2.0", + "id": json.RawMessage(request.ID), + "result": map[string]any{"messageId": "message-1"}, + } + 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 + } + close(requestReceived) + }() + + session := &Session{ + SessionID: "session-1", + client: client, + RPC: rpc.NewSessionRPC(client, "session-1"), + handlers: make([]sessionHandler, 0), + eventCh: make(chan SessionEvent, 8), + } + go session.processEvents() + defer close(session.eventCh) + + resultCh := make(chan *SessionEvent, 1) + go func() { + result, err := session.SendAndWait(t.Context(), MessageOptions{Prompt: "keep going"}) + if err != nil { + errCh <- err + return + } + resultCh <- result + }() + + select { + case <-requestReceived: + case err := <-errCh: + t.Fatal(err) + case <-time.After(2 * time.Second): + t.Fatal("timed out waiting for session.send request") + } + + continuationIdleProcessed := make(chan struct{}) + unsubscribe := session.On(func(event SessionEvent) { + if idle, ok := event.Data.(*SessionIdleData); ok && + idle.Mode != nil && *idle.Mode == SessionModeAutopilot { + close(continuationIdleProcessed) + } + }) + defer unsubscribe() + + autopilot := SessionModeAutopilot + session.dispatchEvent(SessionEvent{Data: &AssistantMessageData{ + Content: "intermediate", + MessageID: "assistant-1", + }}) + session.dispatchEvent(SessionEvent{Data: &SessionIdleData{Mode: &autopilot}}) + + select { + case <-continuationIdleProcessed: + case err := <-errCh: + t.Fatal(err) + case <-time.After(2 * time.Second): + t.Fatal("timed out waiting for autopilot continuation idle") + } + + select { + case <-resultCh: + t.Fatal("SendAndWait returned at an autopilot continuation idle") + default: + } + + interactive := SessionModeInteractive + session.dispatchEvent(SessionEvent{Data: &AssistantMessageData{ + Content: "final", + MessageID: "assistant-2", + }}) + session.dispatchEvent(SessionEvent{Data: &SessionIdleData{Mode: &interactive}}) + + select { + case result := <-resultCh: + message, ok := result.Data.(*AssistantMessageData) + if !ok { + t.Fatalf("expected assistant message, got %T", result.Data) + } + if message.Content != "final" { + t.Fatalf("expected final assistant message, got %q", message.Content) + } + case err := <-errCh: + t.Fatal(err) + case <-time.After(2 * time.Second): + t.Fatal("timed out waiting for terminal idle") + } +} + func TestSession_On(t *testing.T) { t.Run("multiple handlers all receive events", func(t *testing.T) { session, cleanup := newTestSession() diff --git a/go/toolset_test.go b/go/toolset_test.go index f8c38ef202..270d5b757f 100644 --- a/go/toolset_test.go +++ b/go/toolset_test.go @@ -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 @@ -276,6 +294,9 @@ func TestApplyConfigDefaultsForMode_emptyDefaultsGranularFlags(t *testing.T) { 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) { @@ -291,6 +312,7 @@ func TestApplyConfigDefaultsForMode_emptyHonorsCallerGranularFlags(t *testing.T) EnableSessionStore: &trueVal, EnableSkills: &trueVal, Memory: &MemoryConfiguration{Enabled: true}, + CustomAgentsLocalOnly: &falseVal, } c.applyConfigDefaultsForMode(cfg) if *cfg.SkipEmbeddingRetrieval != false { @@ -317,6 +339,9 @@ func TestApplyConfigDefaultsForMode_emptyHonorsCallerGranularFlags(t *testing.T) 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) { @@ -344,6 +369,25 @@ func TestApplyConfigDefaultsForMode_copilotCliLeavesGranularFlagsNil(t *testing. 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) { @@ -372,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 b0fd9c06ef..1d98e06158 100644 --- a/go/types.go +++ b/go/types.go @@ -129,6 +129,11 @@ type ClientOptions struct { // location. // 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". @@ -375,9 +380,62 @@ type PermissionHandlerFunc func(request PermissionRequest, invocation Permission // PermissionInvocation provides context about a permission request type PermissionInvocation struct { - SessionID string + 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 + +// PermissionResponseCapability describes whether the responding client could +// ask a user for a permission decision. +type PermissionResponseCapability = rpc.PermissionResponseCapability + +const ( + PermissionResponseCapabilityHeadless = rpc.PermissionResponseCapabilityHeadless + PermissionResponseCapabilityInteractive = rpc.PermissionResponseCapabilityInteractive + PermissionResponseCapabilityNone = rpc.PermissionResponseCapabilityNone +) + +// 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 ( + PermissionDecisionSourceAssistedApproval = rpc.PermissionDecisionSourceAssistedApproval + PermissionDecisionSourceHostPolicy = rpc.PermissionDecisionSourceHostPolicy + PermissionDecisionSourceHumanResponse = rpc.PermissionDecisionSourceHumanResponse + PermissionDecisionSourceUnattendedFallback = rpc.PermissionDecisionSourceUnattendedFallback +) + +// PermissionDecisionSurface identifies the client surface that submitted a +// permission response. +type PermissionDecisionSurface = rpc.PermissionDecisionSurface + +const ( + PermissionDecisionSurfaceAcp = rpc.PermissionDecisionSurfaceAcp + 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"` @@ -678,6 +736,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"` @@ -898,15 +996,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 - OnAgentStop AgentStopHandler - 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. @@ -1140,6 +1239,18 @@ func (e ExpConfigEntry) MarshalJSON() ([]byte, error) { 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 type SessionConfig struct { // SessionID is an optional custom session ID @@ -1150,7 +1261,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. @@ -1162,13 +1273,9 @@ 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 non-nil, controls automatic discovery of 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. + // 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. - // Custom instruction files (.github/copilot-instructions.md, AGENTS.md, etc.) are - // always loaded from the working directory regardless of this setting. EnableConfigDiscovery *bool // SkipEmbeddingRetrieval, when non-nil, controls embedding-based retrieval // for this session. Use in multitenant deployments to prevent cross-session @@ -1202,6 +1309,10 @@ type SessionConfig struct { // and discovered skill directories). When false, no skills are loaded regardless // of SkillDirectories or EnableConfigDiscovery settings. EnableSkills *bool + // IncludedBuiltinSkills is the allowlist of runtime-bundled skill names. + // In ModeEmpty, nil excludes all built-in skills; a non-nil list opts the + // named built-ins back in. Skills from other sources remain eligible. + IncludedBuiltinSkills []string // Tools exposes caller-implemented tools to the CLI. A Tool with a nil Handler // is declaration-only; the consumer must resolve its calls via pending tool RPCs. Tools []Tool @@ -1226,6 +1337,9 @@ type SessionConfig struct { // When provided, the SDK can satisfy MCP server OAuth requests with host-provided // token data or cancellation. OnMCPAuthRequest MCPAuthHandler + // GitHubTokenProvider acquires session-scoped GitHub tokens on demand. It + // cannot be combined with GitHubToken. + GitHubTokenProvider GitHubTokenProvider // 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 @@ -1233,6 +1347,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. @@ -1273,11 +1390,18 @@ type SessionConfig struct { // 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 @@ -1319,6 +1443,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 @@ -1379,6 +1507,10 @@ type SessionConfig struct { // cause MCP servers to register UI-enabled tool variants the consumer cannot // display. 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. @@ -1433,6 +1565,56 @@ type SessionConfig struct { // 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. +// +// The runtime may introduce additional fail-closed modes. Values are serialized +// as strings so callers can use newer modes without waiting for an SDK release. +type DisableBypassPermissionsMode string + +const ( + // DisableBypassPermissionsModeDisable turns off bypass-permissions mode. + DisableBypassPermissionsModeDisable DisableBypassPermissionsMode = "disable" + // DisableBypassPermissionsModeAllowAutoOnly permits only automatic bypass. + DisableBypassPermissionsModeAllowAutoOnly DisableBypassPermissionsMode = "allow-auto-only" +) + +// 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 restricts bypass-permissions mode for the + // session. See the DisableBypassPermissionsMode constants for known values. + // Newer values are forwarded unchanged so runtime policies remain fail-closed. + 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 @@ -1452,6 +1634,11 @@ type Tool struct { 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"` @@ -1629,6 +1816,9 @@ type ResumeSessionConfig struct { // ClientName identifies the application using the SDK. // Included in the User-Agent header for API requests. ClientName string + // GitHubTokenProvider acquires session-scoped GitHub tokens on demand. It + // cannot be combined with GitHubToken. + GitHubTokenProvider GitHubTokenProvider // Model to use for this session. Can change the model when resuming. Model string // Tools exposes caller-implemented tools to the CLI. A Tool with a nil Handler @@ -1647,6 +1837,10 @@ type ResumeSessionConfig struct { // be selected or invoked unless a custom agent with the same name is // configured. ExcludedBuiltInAgents []string + // IncludedBuiltinSkills is the allowlist of runtime-bundled skill names. + // In ModeEmpty, nil excludes all built-in skills; a non-nil list opts the + // named built-ins back in. Skills from other sources remain eligible. + IncludedBuiltinSkills []string // Provider configures a custom model provider Provider *ProviderConfig // Capi configures provider-scoped CAPI (Copilot API) session options. @@ -1675,11 +1869,19 @@ type ResumeSessionConfig struct { // 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 @@ -1697,7 +1899,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. @@ -1719,15 +1921,14 @@ 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 non-nil, controls automatic discovery of 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. + // 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. - // Custom instruction files (.github/copilot-instructions.md, AGENTS.md, etc.) are - // always loaded from the working directory regardless of this setting. EnableConfigDiscovery *bool // SkipEmbeddingRetrieval, when non-nil, controls embedding-based retrieval // for this session. Use in multitenant deployments to prevent cross-session @@ -1791,6 +1992,10 @@ 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 @@ -1847,6 +2052,10 @@ type ResumeSessionConfig struct { // Experimental: EnableMCPApps is part of an experimental wire-protocol // surface (SEP-1865) and may change or be removed in a future release. 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 @@ -1880,6 +2089,11 @@ type ResumeSessionConfig struct { // 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 @@ -2285,7 +2499,9 @@ type createSessionRequest struct { 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"` @@ -2297,6 +2513,7 @@ 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"` @@ -2320,6 +2537,7 @@ 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"` @@ -2327,7 +2545,9 @@ type createSessionRequest struct { Commands []wireCommand `json:"commands,omitempty"` RequestElicitation *bool `json:"requestElicitation,omitempty"` RequestMCPApps *bool `json:"requestMcpApps,omitempty"` + GitHubMCPToolConfig *GitHubMCPToolConfig `json:"githubMcpToolConfig,omitempty"` GitHubToken string `json:"gitHubToken,omitempty"` + GitHubTokenProviderRegistrationID string `json:"gitHubTokenProviderRegistrationId,omitempty"` RemoteSession rpc.RemoteSessionMode `json:"remoteSession,omitempty"` Cloud *CloudSessionOptions `json:"cloud,omitempty"` Canvases []CanvasDeclaration `json:"canvases,omitempty"` @@ -2338,6 +2558,7 @@ type createSessionRequest struct { 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"` } @@ -2345,7 +2566,7 @@ type createSessionRequest struct { // wireCommand is the wire representation of a command (name + description only, no handler). type wireCommand struct { Name string `json:"name"` - Description string `json:"description,omitempty"` + Description string `json:"description"` } // createSessionResponse is the response from session.create @@ -2375,7 +2596,9 @@ type resumeSessionRequest struct { 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"` @@ -2387,6 +2610,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"` @@ -2412,6 +2636,7 @@ 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"` @@ -2419,7 +2644,9 @@ type resumeSessionRequest struct { Commands []wireCommand `json:"commands,omitempty"` RequestElicitation *bool `json:"requestElicitation,omitempty"` RequestMCPApps *bool `json:"requestMcpApps,omitempty"` + GitHubMCPToolConfig *GitHubMCPToolConfig `json:"githubMcpToolConfig,omitempty"` GitHubToken string `json:"gitHubToken,omitempty"` + GitHubTokenProviderRegistrationID string `json:"gitHubTokenProviderRegistrationId,omitempty"` RemoteSession rpc.RemoteSessionMode `json:"remoteSession,omitempty"` Canvases []CanvasDeclaration `json:"canvases,omitempty"` OpenCanvases []rpc.OpenCanvasInstance `json:"openCanvases,omitempty"` @@ -2430,6 +2657,7 @@ type resumeSessionRequest struct { 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 a76ebaad40..4195464b33 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", diff --git a/go/zsession_events.go b/go/zsession_events.go index 1d35a0a518..38ea78087b 100644 --- a/go/zsession_events.go +++ b/go/zsession_events.go @@ -9,10 +9,17 @@ import "github.com/github/copilot-sdk/go/rpc" type ( AbortData = rpc.AbortData AbortReason = rpc.AbortReason + AgentInterruptedActivity = rpc.AgentInterruptedActivity + AgentInterruptedCancelPhase = rpc.AgentInterruptedCancelPhase + AgentInterruptedData = rpc.AgentInterruptedData + AssistantFusionPhaseCompletedData = rpc.AssistantFusionPhaseCompletedData + AssistantFusionPhaseFailedData = rpc.AssistantFusionPhaseFailedData + AssistantFusionPhaseStartedData = rpc.AssistantFusionPhaseStartedData AssistantIdleData = rpc.AssistantIdleData AssistantIntentData = rpc.AssistantIntentData AssistantMessageData = rpc.AssistantMessageData AssistantMessageDeltaData = rpc.AssistantMessageDeltaData + AssistantMessageReasoningBlocks = rpc.AssistantMessageReasoningBlocks AssistantMessageServerTools = rpc.AssistantMessageServerTools AssistantMessageStartData = rpc.AssistantMessageStartData AssistantMessageToolRequest = rpc.AssistantMessageToolRequest @@ -29,6 +36,9 @@ type ( AssistantUsageCopilotUsage = rpc.AssistantUsageCopilotUsage AssistantUsageCopilotUsageTokenDetail = rpc.AssistantUsageCopilotUsageTokenDetail AssistantUsageData = rpc.AssistantUsageData + AssistantUsageTransport = rpc.AssistantUsageTransport + AssistedApprovalJudgeFailureReason = rpc.AssistedApprovalJudgeFailureReason + AssistedApprovalRecommendation = rpc.AssistedApprovalRecommendation Attachment = rpc.Attachment AttachmentBlob = rpc.AttachmentBlob AttachmentDirectory = rpc.AttachmentDirectory @@ -53,7 +63,6 @@ type ( AttachmentSelectionDetailsEnd = rpc.AttachmentSelectionDetailsEnd AttachmentSelectionDetailsStart = rpc.AttachmentSelectionDetailsStart AttachmentType = rpc.AttachmentType - AutoApprovalRecommendation = rpc.AutoApprovalRecommendation AutoModeResolvedReasoningBucket = rpc.AutoModeResolvedReasoningBucket AutoModeSwitchCompletedData = rpc.AutoModeSwitchCompletedData AutoModeSwitchRequestedData = rpc.AutoModeSwitchRequestedData @@ -85,6 +94,7 @@ type ( CommandsChangedData = rpc.CommandsChangedData CompactionCompleteCompactionTokensUsed = rpc.CompactionCompleteCompactionTokensUsed CompactionCompleteCompactionTokensUsedCopilotUsageTokenDetail = rpc.CompactionCompleteCompactionTokensUsedCopilotUsageTokenDetail + CompactionTrigger = rpc.CompactionTrigger ContextTier = rpc.ContextTier CustomAgentsUpdatedAgent = rpc.CustomAgentsUpdatedAgent ElicitationCompletedAction = rpc.ElicitationCompletedAction @@ -103,6 +113,22 @@ type ( ExtensionsLoadedExtensionStatus = rpc.ExtensionsLoadedExtensionStatus ExternalToolCompletedData = rpc.ExternalToolCompletedData ExternalToolRequestedData = rpc.ExternalToolRequestedData + FactoryPermissionOperation = rpc.FactoryPermissionOperation + FactoryPermissionPhase = rpc.FactoryPermissionPhase + FactoryRunSettledData = rpc.FactoryRunSettledData + FactoryRunSettledStatus = rpc.FactoryRunSettledStatus + FactoryRunStartedData = rpc.FactoryRunStartedData + FactoryRunUpdatedData = rpc.FactoryRunUpdatedData + FusionAttribution = rpc.FusionAttribution + FusionConversationScope = rpc.FusionConversationScope + FusionFollowUpAction = rpc.FusionFollowUpAction + FusionFollowUpRecommendation = rpc.FusionFollowUpRecommendation + FusionPattern = rpc.FusionPattern + FusionPhaseKind = rpc.FusionPhaseKind + FusionPhaseStatus = rpc.FusionPhaseStatus + FusionPhaseUsage = rpc.FusionPhaseUsage + FusionScores = rpc.FusionScores + FusionTurnKind = rpc.FusionTurnKind GitHubRepoRef = rpc.GitHubRepoRef HandoffRepository = rpc.HandoffRepository HandoffSourceType = rpc.HandoffSourceType @@ -143,16 +169,18 @@ type ( ModelCallFailureRequestFingerprint = rpc.ModelCallFailureRequestFingerprint ModelCallFailureSource = rpc.ModelCallFailureSource ModelCallFailureTransport = rpc.ModelCallFailureTransport + ModelCallFinishedData = rpc.ModelCallFinishedData + ModelCallFinishedOutcome = rpc.ModelCallFinishedOutcome ModelCallStartData = rpc.ModelCallStartData + ModelChangeSource = rpc.ModelChangeSource 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 + PermissionAssistedApproval = rpc.PermissionAssistedApproval PermissionCancelled = rpc.PermissionCancelled PermissionCompletedData = rpc.PermissionCompletedData PermissionDeniedByContentExclusionPolicy = rpc.PermissionDeniedByContentExclusionPolicy @@ -160,11 +188,14 @@ type ( PermissionDeniedByRules = rpc.PermissionDeniedByRules PermissionDeniedInteractivelyByUser = rpc.PermissionDeniedInteractivelyByUser PermissionDeniedNoApprovalRuleAndCouldNotRequestFromUser = rpc.PermissionDeniedNoApprovalRuleAndCouldNotRequestFromUser + PermissionMode = rpc.PermissionMode PermissionPromptRequest = rpc.PermissionPromptRequest PermissionPromptRequestCommands = rpc.PermissionPromptRequestCommands PermissionPromptRequestCustomTool = rpc.PermissionPromptRequestCustomTool + PermissionPromptRequestExtensionEnvAccess = rpc.PermissionPromptRequestExtensionEnvAccess PermissionPromptRequestExtensionManagement = rpc.PermissionPromptRequestExtensionManagement PermissionPromptRequestExtensionPermissionAccess = rpc.PermissionPromptRequestExtensionPermissionAccess + PermissionPromptRequestFactory = rpc.PermissionPromptRequestFactory PermissionPromptRequestHook = rpc.PermissionPromptRequestHook PermissionPromptRequestKind = rpc.PermissionPromptRequestKind PermissionPromptRequestMCP = rpc.PermissionPromptRequestMCP @@ -174,21 +205,26 @@ type ( PermissionPromptRequestRead = rpc.PermissionPromptRequestRead PermissionPromptRequestURL = rpc.PermissionPromptRequestURL PermissionPromptRequestWrite = rpc.PermissionPromptRequestWrite + PermissionRecommendation = rpc.PermissionRecommendation PermissionRequest = rpc.PermissionRequest PermissionRequestCommand = rpc.PermissionRequestCommand PermissionRequestCustomTool = rpc.PermissionRequestCustomTool PermissionRequestedData = rpc.PermissionRequestedData + PermissionRequestExtensionEnvAccess = rpc.PermissionRequestExtensionEnvAccess PermissionRequestExtensionManagement = rpc.PermissionRequestExtensionManagement PermissionRequestExtensionPermissionAccess = rpc.PermissionRequestExtensionPermissionAccess + PermissionRequestFactory = rpc.PermissionRequestFactory PermissionRequestHook = rpc.PermissionRequestHook PermissionRequestKind = rpc.PermissionRequestKind PermissionRequestMCP = rpc.PermissionRequestMCP PermissionRequestMemory = rpc.PermissionRequestMemory PermissionRequestMemoryAction = rpc.PermissionRequestMemoryAction PermissionRequestMemoryDirection = rpc.PermissionRequestMemoryDirection + PermissionRequestMemoryScope = rpc.PermissionRequestMemoryScope PermissionRequestRead = rpc.PermissionRequestRead PermissionRequestShell = rpc.PermissionRequestShell PermissionRequestShellCommand = rpc.PermissionRequestShellCommand + PermissionRequestShellCommandSegment = rpc.PermissionRequestShellCommandSegment PermissionRequestShellPossibleURL = rpc.PermissionRequestShellPossibleURL PermissionRequestURL = rpc.PermissionRequestURL PermissionRequestWrite = rpc.PermissionRequestWrite @@ -201,6 +237,7 @@ type ( PersistedBinaryResultType = rpc.PersistedBinaryResultType PlanChangedOperation = rpc.PlanChangedOperation PossibleURL = rpc.PossibleURL + PromptCacheBreakData = rpc.PromptCacheBreakData RawCitationLocation = rpc.RawCitationLocation RawPermissionPromptRequest = rpc.RawPermissionPromptRequest RawPermissionRequest = rpc.RawPermissionRequest @@ -212,6 +249,8 @@ type ( ReasoningSummary = rpc.ReasoningSummary SamplingCompletedData = rpc.SamplingCompletedData SamplingRequestedData = rpc.SamplingRequestedData + SandboxDecisionData = rpc.SandboxDecisionData + ScheduleOrigin = rpc.ScheduleOrigin SessionAutoModeResolvedData = rpc.SessionAutoModeResolvedData SessionAutopilotObjectiveChangedData = rpc.SessionAutopilotObjectiveChangedData SessionBackgroundTasksChangedData = rpc.SessionBackgroundTasksChangedData @@ -225,6 +264,7 @@ type ( SessionCompactionCompleteData = rpc.SessionCompactionCompleteData SessionCompactionStartData = rpc.SessionCompactionStartData SessionContextChangedData = rpc.SessionContextChangedData + SessionContextClearedData = rpc.SessionContextClearedData SessionCustomAgentsUpdatedData = rpc.SessionCustomAgentsUpdatedData SessionCustomNotificationData = rpc.SessionCustomNotificationData SessionErrorData = rpc.SessionErrorData @@ -233,6 +273,10 @@ type ( SessionEventType = rpc.SessionEventType SessionExtensionsAttachmentsPushedData = rpc.SessionExtensionsAttachmentsPushedData SessionExtensionsLoadedData = rpc.SessionExtensionsLoadedData + SessionFusionCompletedData = rpc.SessionFusionCompletedData + SessionFusionResolvedData = rpc.SessionFusionResolvedData + SessionFusionRouteFailedData = rpc.SessionFusionRouteFailedData + SessionFusionRouteStartedData = rpc.SessionFusionRouteStartedData SessionHandoffData = rpc.SessionHandoffData SessionIdleData = rpc.SessionIdleData SessionInfoData = rpc.SessionInfoData @@ -269,6 +313,7 @@ type ( SessionUsageInfoData = rpc.SessionUsageInfoData SessionWarningData = rpc.SessionWarningData SessionWorkspaceFileChangedData = rpc.SessionWorkspaceFileChangedData + ShutdownAgentMetric = rpc.ShutdownAgentMetric ShutdownCodeChanges = rpc.ShutdownCodeChanges ShutdownModelMetric = rpc.ShutdownModelMetric ShutdownModelMetricRequests = rpc.ShutdownModelMetricRequests @@ -281,6 +326,7 @@ type ( SkillsLoadedSkill = rpc.SkillsLoadedSkill SkillSource = rpc.SkillSource SubagentCompletedData = rpc.SubagentCompletedData + SubagentConfiguredData = rpc.SubagentConfiguredData SubagentDeselectedData = rpc.SubagentDeselectedData SubagentFailedData = rpc.SubagentFailedData SubagentSelectedData = rpc.SubagentSelectedData @@ -293,11 +339,16 @@ 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 + TaskCompleteData = rpc.TaskCompleteData + TaskCompletionOutcome = rpc.TaskCompletionOutcome ToolExecutionCompleteContent = rpc.ToolExecutionCompleteContent ToolExecutionCompleteContentAudio = rpc.ToolExecutionCompleteContentAudio ToolExecutionCompleteContentImage = rpc.ToolExecutionCompleteContentImage @@ -336,6 +387,8 @@ type ( ToolExecutionStartToolDescriptionMetaUIVisibility = rpc.ToolExecutionStartToolDescriptionMetaUIVisibility ToolSearchActivatedData = rpc.ToolSearchActivatedData ToolUserRequestedData = rpc.ToolUserRequestedData + UIEphemeralQueryData = rpc.UIEphemeralQueryData + UIEphemeralQueryPhase = rpc.UIEphemeralQueryPhase UserInputCompletedData = rpc.UserInputCompletedData UserInputRequestedData = rpc.UserInputRequestedData UserMessageAgentMode = rpc.UserMessageAgentMode @@ -344,8 +397,10 @@ type ( UserToolSessionApproval = rpc.UserToolSessionApproval UserToolSessionApprovalCommands = rpc.UserToolSessionApprovalCommands UserToolSessionApprovalCustomTool = rpc.UserToolSessionApprovalCustomTool + UserToolSessionApprovalExtensionEnvAccess = rpc.UserToolSessionApprovalExtensionEnvAccess UserToolSessionApprovalExtensionManagement = rpc.UserToolSessionApprovalExtensionManagement UserToolSessionApprovalExtensionPermissionAccess = rpc.UserToolSessionApprovalExtensionPermissionAccess + UserToolSessionApprovalFactory = rpc.UserToolSessionApprovalFactory UserToolSessionApprovalKind = rpc.UserToolSessionApprovalKind UserToolSessionApprovalMCP = rpc.UserToolSessionApprovalMCP UserToolSessionApprovalMemory = rpc.UserToolSessionApprovalMemory @@ -359,15 +414,33 @@ 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 + AgentInterruptedActivityBackgroundAgent = rpc.AgentInterruptedActivityBackgroundAgent + AgentInterruptedActivityModelCall = rpc.AgentInterruptedActivityModelCall + AgentInterruptedActivityRetryBackoff = rpc.AgentInterruptedActivityRetryBackoff + AgentInterruptedActivityToolCall = rpc.AgentInterruptedActivityToolCall + AgentInterruptedCancelPhaseMidStream = rpc.AgentInterruptedCancelPhaseMidStream + AgentInterruptedCancelPhasePreFirstToken = rpc.AgentInterruptedCancelPhasePreFirstToken AssistantMessageToolRequestTypeCustom = rpc.AssistantMessageToolRequestTypeCustom AssistantMessageToolRequestTypeFunction = rpc.AssistantMessageToolRequestTypeFunction AssistantUsageAPIEndpointChatCompletions = rpc.AssistantUsageAPIEndpointChatCompletions AssistantUsageAPIEndpointResponses = rpc.AssistantUsageAPIEndpointResponses AssistantUsageAPIEndpointV1Messages = rpc.AssistantUsageAPIEndpointV1Messages AssistantUsageAPIEndpointWsResponses = rpc.AssistantUsageAPIEndpointWsResponses + AssistantUsageTransportHTTP = rpc.AssistantUsageTransportHTTP + AssistantUsageTransportWebsocket = rpc.AssistantUsageTransportWebsocket + AssistedApprovalJudgeFailureReasonAbort = rpc.AssistedApprovalJudgeFailureReasonAbort + AssistedApprovalJudgeFailureReasonEmptyResponse = rpc.AssistedApprovalJudgeFailureReasonEmptyResponse + AssistedApprovalJudgeFailureReasonModelError = rpc.AssistedApprovalJudgeFailureReasonModelError + AssistedApprovalJudgeFailureReasonParseError = rpc.AssistedApprovalJudgeFailureReasonParseError + AssistedApprovalJudgeFailureReasonTimeout = rpc.AssistedApprovalJudgeFailureReasonTimeout + AssistedApprovalRecommendationApprove = rpc.AssistedApprovalRecommendationApprove + AssistedApprovalRecommendationError = rpc.AssistedApprovalRecommendationError + AssistedApprovalRecommendationExcluded = rpc.AssistedApprovalRecommendationExcluded + AssistedApprovalRecommendationRequireApproval = rpc.AssistedApprovalRecommendationRequireApproval AttachmentGitHubReferenceTypeDiscussion = rpc.AttachmentGitHubReferenceTypeDiscussion AttachmentGitHubReferenceTypeIssue = rpc.AttachmentGitHubReferenceTypeIssue AttachmentGitHubReferenceTypePr = rpc.AttachmentGitHubReferenceTypePr @@ -386,10 +459,6 @@ const ( AttachmentTypeGitHubTreeComparison = rpc.AttachmentTypeGitHubTreeComparison AttachmentTypeGitHubURL = rpc.AttachmentTypeGitHubURL AttachmentTypeSelection = rpc.AttachmentTypeSelection - AutoApprovalRecommendationApprove = rpc.AutoApprovalRecommendationApprove - AutoApprovalRecommendationError = rpc.AutoApprovalRecommendationError - AutoApprovalRecommendationExcluded = rpc.AutoApprovalRecommendationExcluded - AutoApprovalRecommendationRequireApproval = rpc.AutoApprovalRecommendationRequireApproval AutoModeResolvedReasoningBucketHigh = rpc.AutoModeResolvedReasoningBucketHigh AutoModeResolvedReasoningBucketLow = rpc.AutoModeResolvedReasoningBucketLow AutoModeResolvedReasoningBucketMedium = rpc.AutoModeResolvedReasoningBucketMedium @@ -413,6 +482,11 @@ const ( 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 @@ -433,15 +507,46 @@ const ( ExtensionsLoadedExtensionStatusFailed = rpc.ExtensionsLoadedExtensionStatusFailed ExtensionsLoadedExtensionStatusRunning = rpc.ExtensionsLoadedExtensionStatusRunning ExtensionsLoadedExtensionStatusStarting = rpc.ExtensionsLoadedExtensionStatusStarting + FactoryPermissionOperationAuthor = rpc.FactoryPermissionOperationAuthor + FactoryPermissionOperationRun = rpc.FactoryPermissionOperationRun + FactoryRunSettledStatusCancelled = rpc.FactoryRunSettledStatusCancelled + FactoryRunSettledStatusCompleted = rpc.FactoryRunSettledStatusCompleted + FactoryRunSettledStatusError = rpc.FactoryRunSettledStatusError + FactoryRunSettledStatusHalted = rpc.FactoryRunSettledStatusHalted + FusionConversationScopeReview = rpc.FusionConversationScopeReview + FusionConversationScopeRoot = rpc.FusionConversationScopeRoot + FusionFollowUpActionReroute = rpc.FusionFollowUpActionReroute + FusionFollowUpActionReusePrimary = rpc.FusionFollowUpActionReusePrimary + FusionPatternCascade = rpc.FusionPatternCascade + FusionPatternCritique = rpc.FusionPatternCritique + FusionPatternSingle = rpc.FusionPatternSingle + FusionPhaseKindCritic = rpc.FusionPhaseKindCritic + FusionPhaseKindDraft = rpc.FusionPhaseKindDraft + FusionPhaseKindFollowUp = rpc.FusionPhaseKindFollowUp + FusionPhaseKindJudge = rpc.FusionPhaseKindJudge + FusionPhaseKindPrimary = rpc.FusionPhaseKindPrimary + FusionPhaseKindRepair = rpc.FusionPhaseKindRepair + FusionPhaseKindRevision = rpc.FusionPhaseKindRevision + FusionPhaseStatusCancelled = rpc.FusionPhaseStatusCancelled + FusionPhaseStatusFailed = rpc.FusionPhaseStatusFailed + FusionPhaseStatusSucceeded = rpc.FusionPhaseStatusSucceeded + FusionProjectionModeAppend = rpc.FusionProjectionModeAppend + FusionProjectionModeNone = rpc.FusionProjectionModeNone + FusionProjectionModeStaged = rpc.FusionProjectionModeStaged + FusionTurnKindCompaction = rpc.FusionTurnKindCompaction + FusionTurnKindUser = rpc.FusionTurnKindUser HandoffSourceTypeLocal = rpc.HandoffSourceTypeLocal HandoffSourceTypeRemote = rpc.HandoffSourceTypeRemote ManagedSettingsEnforcedActionBypassPermissionsBlocked = rpc.ManagedSettingsEnforcedActionBypassPermissionsBlocked ManagedSettingsEnforcedEscalationAllowAll = rpc.ManagedSettingsEnforcedEscalationAllowAll ManagedSettingsEnforcedEscalationApproveAll = rpc.ManagedSettingsEnforcedEscalationApproveAll - ManagedSettingsEnforcedEscalationAutoApproval = rpc.ManagedSettingsEnforcedEscalationAutoApproval + ManagedSettingsEnforcedEscalationAssistedApproval = rpc.ManagedSettingsEnforcedEscalationAssistedApproval + ManagedSettingsEnforcedEscalationServerWideMCPApproval = rpc.ManagedSettingsEnforcedEscalationServerWideMCPApproval ManagedSettingsEnforcedEscalationUnrestrictedPaths = rpc.ManagedSettingsEnforcedEscalationUnrestrictedPaths ManagedSettingsEnforcedEscalationUnrestrictedURLs = rpc.ManagedSettingsEnforcedEscalationUnrestrictedURLs + ManagedSettingsResolvedSourceClient = rpc.ManagedSettingsResolvedSourceClient ManagedSettingsResolvedSourceDevice = rpc.ManagedSettingsResolvedSourceDevice + ManagedSettingsResolvedSourceMixed = rpc.ManagedSettingsResolvedSourceMixed ManagedSettingsResolvedSourceNone = rpc.ManagedSettingsResolvedSourceNone ManagedSettingsResolvedSourceServer = rpc.ManagedSettingsResolvedSourceServer MCPHeadersRefreshCompletedOutcomeHeaders = rpc.MCPHeadersRefreshCompletedOutcomeHeaders @@ -467,6 +572,7 @@ const ( MCPServerStatusNeedsAuth = rpc.MCPServerStatusNeedsAuth MCPServerStatusNotConfigured = rpc.MCPServerStatusNotConfigured MCPServerStatusPending = rpc.MCPServerStatusPending + MCPServerStatusStopped = rpc.MCPServerStatusStopped MCPServerTransportHTTP = rpc.MCPServerTransportHTTP MCPServerTransportMemory = rpc.MCPServerTransportMemory MCPServerTransportSSE = rpc.MCPServerTransportSSE @@ -480,17 +586,34 @@ const ( ModelCallFailureSourceTopLevel = rpc.ModelCallFailureSourceTopLevel ModelCallFailureTransportHTTP = rpc.ModelCallFailureTransportHTTP ModelCallFailureTransportWebsocket = rpc.ModelCallFailureTransportWebsocket + ModelCallFinishedOutcomeCancelled = rpc.ModelCallFinishedOutcomeCancelled + ModelCallFinishedOutcomeError = rpc.ModelCallFinishedOutcomeError + ModelCallFinishedOutcomeRejected = rpc.ModelCallFinishedOutcomeRejected + ModelCallFinishedOutcomeSuccess = rpc.ModelCallFinishedOutcomeSuccess + ModelChangeSourceAgent = rpc.ModelChangeSourceAgent + ModelChangeSourceAutomatic = rpc.ModelChangeSourceAutomatic + ModelChangeSourceConfigCommand = rpc.ModelChangeSourceConfigCommand + ModelChangeSourceManagedSettings = rpc.ModelChangeSourceManagedSettings + ModelChangeSourceModelCommand = rpc.ModelChangeSourceModelCommand + ModelChangeSourceModelPicker = rpc.ModelChangeSourceModelPicker + ModelChangeSourcePlanMode = rpc.ModelChangeSourcePlanMode + ModelChangeSourceRepoSettings = rpc.ModelChangeSourceRepoSettings + ModelChangeSourceSDK = rpc.ModelChangeSourceSDK + ModelChangeSourceSettingsCommand = rpc.ModelChangeSourceSettingsCommand + ModelChangeSourceStartup = rpc.ModelChangeSourceStartup OmittedBinaryOmittedReasonAssetUnavailable = rpc.OmittedBinaryOmittedReasonAssetUnavailable OmittedBinaryOmittedReasonTooLarge = rpc.OmittedBinaryOmittedReasonTooLarge OmittedBinaryTypeImage = rpc.OmittedBinaryTypeImage OmittedBinaryTypeResource = rpc.OmittedBinaryTypeResource - PermissionAllowAllModeAuto = rpc.PermissionAllowAllModeAuto - PermissionAllowAllModeOff = rpc.PermissionAllowAllModeOff - PermissionAllowAllModeOn = rpc.PermissionAllowAllModeOn + PermissionModeAllowAll = rpc.PermissionModeAllowAll + PermissionModeAssisted = rpc.PermissionModeAssisted + PermissionModeManual = rpc.PermissionModeManual PermissionPromptRequestKindCommands = rpc.PermissionPromptRequestKindCommands PermissionPromptRequestKindCustomTool = rpc.PermissionPromptRequestKindCustomTool + PermissionPromptRequestKindExtensionEnvAccess = rpc.PermissionPromptRequestKindExtensionEnvAccess PermissionPromptRequestKindExtensionManagement = rpc.PermissionPromptRequestKindExtensionManagement PermissionPromptRequestKindExtensionPermissionAccess = rpc.PermissionPromptRequestKindExtensionPermissionAccess + PermissionPromptRequestKindFactory = rpc.PermissionPromptRequestKindFactory PermissionPromptRequestKindHook = rpc.PermissionPromptRequestKindHook PermissionPromptRequestKindMCP = rpc.PermissionPromptRequestKindMCP PermissionPromptRequestKindMemory = rpc.PermissionPromptRequestKindMemory @@ -501,9 +624,12 @@ const ( PermissionPromptRequestPathAccessKindRead = rpc.PermissionPromptRequestPathAccessKindRead PermissionPromptRequestPathAccessKindShell = rpc.PermissionPromptRequestPathAccessKindShell PermissionPromptRequestPathAccessKindWrite = rpc.PermissionPromptRequestPathAccessKindWrite + PermissionRecommendationApprove = rpc.PermissionRecommendationApprove PermissionRequestKindCustomTool = rpc.PermissionRequestKindCustomTool + PermissionRequestKindExtensionEnvAccess = rpc.PermissionRequestKindExtensionEnvAccess PermissionRequestKindExtensionManagement = rpc.PermissionRequestKindExtensionManagement PermissionRequestKindExtensionPermissionAccess = rpc.PermissionRequestKindExtensionPermissionAccess + PermissionRequestKindFactory = rpc.PermissionRequestKindFactory PermissionRequestKindHook = rpc.PermissionRequestKindHook PermissionRequestKindMCP = rpc.PermissionRequestKindMCP PermissionRequestKindMemory = rpc.PermissionRequestKindMemory @@ -515,6 +641,8 @@ const ( PermissionRequestMemoryActionVote = rpc.PermissionRequestMemoryActionVote PermissionRequestMemoryDirectionDownvote = rpc.PermissionRequestMemoryDirectionDownvote PermissionRequestMemoryDirectionUpvote = rpc.PermissionRequestMemoryDirectionUpvote + PermissionRequestMemoryScopeRepository = rpc.PermissionRequestMemoryScopeRepository + PermissionRequestMemoryScopeUser = rpc.PermissionRequestMemoryScopeUser PermissionResultKindApproved = rpc.PermissionResultKindApproved PermissionResultKindApprovedForLocation = rpc.PermissionResultKindApprovedForLocation PermissionResultKindApprovedForSession = rpc.PermissionResultKindApprovedForSession @@ -534,7 +662,13 @@ const ( ReasoningSummaryConcise = rpc.ReasoningSummaryConcise ReasoningSummaryDetailed = rpc.ReasoningSummaryDetailed ReasoningSummaryNone = rpc.ReasoningSummaryNone + ScheduleOriginModel = rpc.ScheduleOriginModel + ScheduleOriginUser = rpc.ScheduleOriginUser SessionEventTypeAbort = rpc.SessionEventTypeAbort + SessionEventTypeAgentInterrupted = rpc.SessionEventTypeAgentInterrupted + SessionEventTypeAssistantFusionPhaseCompleted = rpc.SessionEventTypeAssistantFusionPhaseCompleted + SessionEventTypeAssistantFusionPhaseFailed = rpc.SessionEventTypeAssistantFusionPhaseFailed + SessionEventTypeAssistantFusionPhaseStarted = rpc.SessionEventTypeAssistantFusionPhaseStarted SessionEventTypeAssistantIdle = rpc.SessionEventTypeAssistantIdle SessionEventTypeAssistantIntent = rpc.SessionEventTypeAssistantIntent SessionEventTypeAssistantMessage = rpc.SessionEventTypeAssistantMessage @@ -562,6 +696,9 @@ const ( SessionEventTypeExitPlanModeRequested = rpc.SessionEventTypeExitPlanModeRequested SessionEventTypeExternalToolCompleted = rpc.SessionEventTypeExternalToolCompleted SessionEventTypeExternalToolRequested = rpc.SessionEventTypeExternalToolRequested + SessionEventTypeFactoryRunSettled = rpc.SessionEventTypeFactoryRunSettled + SessionEventTypeFactoryRunStarted = rpc.SessionEventTypeFactoryRunStarted + SessionEventTypeFactoryRunUpdated = rpc.SessionEventTypeFactoryRunUpdated SessionEventTypeHookEnd = rpc.SessionEventTypeHookEnd SessionEventTypeHookProgress = rpc.SessionEventTypeHookProgress SessionEventTypeHookStart = rpc.SessionEventTypeHookStart @@ -574,12 +711,15 @@ const ( SessionEventTypeMCPResourcesListChanged = rpc.SessionEventTypeMCPResourcesListChanged SessionEventTypeMCPToolsListChanged = rpc.SessionEventTypeMCPToolsListChanged SessionEventTypeModelCallFailure = rpc.SessionEventTypeModelCallFailure + SessionEventTypeModelCallFinished = rpc.SessionEventTypeModelCallFinished SessionEventTypeModelCallStart = rpc.SessionEventTypeModelCallStart SessionEventTypePendingMessagesModified = rpc.SessionEventTypePendingMessagesModified SessionEventTypePermissionCompleted = rpc.SessionEventTypePermissionCompleted SessionEventTypePermissionRequested = rpc.SessionEventTypePermissionRequested + SessionEventTypePromptCacheBreak = rpc.SessionEventTypePromptCacheBreak SessionEventTypeSamplingCompleted = rpc.SessionEventTypeSamplingCompleted SessionEventTypeSamplingRequested = rpc.SessionEventTypeSamplingRequested + SessionEventTypeSandboxDecision = rpc.SessionEventTypeSandboxDecision SessionEventTypeSessionAutoModeResolved = rpc.SessionEventTypeSessionAutoModeResolved SessionEventTypeSessionAutopilotObjectiveChanged = rpc.SessionEventTypeSessionAutopilotObjectiveChanged SessionEventTypeSessionBackgroundTasksChanged = rpc.SessionEventTypeSessionBackgroundTasksChanged @@ -593,11 +733,16 @@ const ( 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 + SessionEventTypeSessionFusionCompleted = rpc.SessionEventTypeSessionFusionCompleted + SessionEventTypeSessionFusionResolved = rpc.SessionEventTypeSessionFusionResolved + SessionEventTypeSessionFusionRouteFailed = rpc.SessionEventTypeSessionFusionRouteFailed + SessionEventTypeSessionFusionRouteStarted = rpc.SessionEventTypeSessionFusionRouteStarted SessionEventTypeSessionHandoff = rpc.SessionEventTypeSessionHandoff SessionEventTypeSessionIdle = rpc.SessionEventTypeSessionIdle SessionEventTypeSessionInfo = rpc.SessionEventTypeSessionInfo @@ -632,6 +777,7 @@ const ( SessionEventTypeSessionWorkspaceFileChanged = rpc.SessionEventTypeSessionWorkspaceFileChanged SessionEventTypeSkillInvoked = rpc.SessionEventTypeSkillInvoked SessionEventTypeSubagentCompleted = rpc.SessionEventTypeSubagentCompleted + SessionEventTypeSubagentConfigured = rpc.SessionEventTypeSubagentConfigured SessionEventTypeSubagentDeselected = rpc.SessionEventTypeSubagentDeselected SessionEventTypeSubagentFailed = rpc.SessionEventTypeSubagentFailed SessionEventTypeSubagentSelected = rpc.SessionEventTypeSubagentSelected @@ -644,6 +790,7 @@ const ( SessionEventTypeToolExecutionStart = rpc.SessionEventTypeToolExecutionStart SessionEventTypeToolSearchActivated = rpc.SessionEventTypeToolSearchActivated SessionEventTypeToolUserRequested = rpc.SessionEventTypeToolUserRequested + SessionEventTypeUIEphemeralQuery = rpc.SessionEventTypeUIEphemeralQuery SessionEventTypeUserInputCompleted = rpc.SessionEventTypeUserInputCompleted SessionEventTypeUserInputRequested = rpc.SessionEventTypeUserInputRequested SessionEventTypeUserMessage = rpc.SessionEventTypeUserMessage @@ -670,12 +817,21 @@ 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 @@ -689,6 +845,11 @@ const ( ToolExecutionCompleteToolDescriptionMetaUIVisibilityModel = rpc.ToolExecutionCompleteToolDescriptionMetaUIVisibilityModel ToolExecutionStartToolDescriptionMetaUIVisibilityApp = rpc.ToolExecutionStartToolDescriptionMetaUIVisibilityApp ToolExecutionStartToolDescriptionMetaUIVisibilityModel = rpc.ToolExecutionStartToolDescriptionMetaUIVisibilityModel + UIEphemeralQueryPhaseAborted = rpc.UIEphemeralQueryPhaseAborted + UIEphemeralQueryPhaseChunk = rpc.UIEphemeralQueryPhaseChunk + UIEphemeralQueryPhaseCompleted = rpc.UIEphemeralQueryPhaseCompleted + UIEphemeralQueryPhaseFailed = rpc.UIEphemeralQueryPhaseFailed + UIEphemeralQueryPhaseStarted = rpc.UIEphemeralQueryPhaseStarted UserMessageAgentModeAutopilot = rpc.UserMessageAgentModeAutopilot UserMessageAgentModeInteractive = rpc.UserMessageAgentModeInteractive UserMessageAgentModePlan = rpc.UserMessageAgentModePlan @@ -698,8 +859,10 @@ const ( UserMessageDeliverySteering = rpc.UserMessageDeliverySteering UserToolSessionApprovalKindCommands = rpc.UserToolSessionApprovalKindCommands UserToolSessionApprovalKindCustomTool = rpc.UserToolSessionApprovalKindCustomTool + UserToolSessionApprovalKindExtensionEnvAccess = rpc.UserToolSessionApprovalKindExtensionEnvAccess UserToolSessionApprovalKindExtensionManagement = rpc.UserToolSessionApprovalKindExtensionManagement UserToolSessionApprovalKindExtensionPermissionAccess = rpc.UserToolSessionApprovalKindExtensionPermissionAccess + UserToolSessionApprovalKindFactory = rpc.UserToolSessionApprovalKindFactory UserToolSessionApprovalKindMCP = rpc.UserToolSessionApprovalKindMCP UserToolSessionApprovalKindMemory = rpc.UserToolSessionApprovalKindMemory UserToolSessionApprovalKindRead = rpc.UserToolSessionApprovalKindRead diff --git a/java/.mvn/wrapper/maven-wrapper.properties b/java/.mvn/wrapper/maven-wrapper.properties index 8dea6c227c..216df05897 100644 --- a/java/.mvn/wrapper/maven-wrapper.properties +++ b/java/.mvn/wrapper/maven-wrapper.properties @@ -1,3 +1,3 @@ wrapperVersion=3.3.4 distributionType=only-script -distributionUrl=https://repo.maven.apache.org/maven2/org/apache/maven/apache-maven/3.9.12/apache-maven-3.9.12-bin.zip +distributionUrl=https://repo.maven.apache.org/maven2/org/apache/maven/apache-maven/3.9.16/apache-maven-3.9.16-bin.zip diff --git a/java/README.md b/java/README.md index 2a31788232..2e1ba51812 100644 --- a/java/README.md +++ b/java/README.md @@ -32,14 +32,14 @@ Replace `${copilot.sdk.version}` with the latest release from Maven Central. com.github copilot-sdk-java - 1.0.5-01 + 1.0.13-preview.2 ``` ### Gradle ```groovy -implementation 'com.github:copilot-sdk-java:1.0.8-01' +implementation 'com.github:copilot-sdk-java:1.0.13-preview.2' ``` #### Snapshot Builds @@ -58,7 +58,7 @@ Snapshot builds of the next development version are published to Maven Central S com.github copilot-sdk-java - 1.0.9-SNAPSHOT + 1.0.14-preview.2-SNAPSHOT ``` @@ -67,7 +67,54 @@ Snapshot builds of the next development version are published to Maven Central S Replace `${copilot.sdk.version}` with the latest release from Maven Central. ```groovy -implementation 'com.github:copilot-sdk-java:1.0.8-01-SNAPSHOT' +implementation 'com.github:copilot-sdk-java:1.0.14-preview.2-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 supported on **linux-x64** (glibc), **linux-arm64** (glibc), **win32-x64**, **win32-arm64**, and **darwin-arm64**. + +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 @@ -120,16 +167,67 @@ 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. + +For rotating per-session GitHub credentials, use +`SessionConfig.setGitHubTokenProvider(...)` (or the equivalent +`ResumeSessionConfig` setter) instead of `setGitHubToken(...)`: + +```java +var config = new SessionConfig().setGitHubTokenProvider(args -> + acquireForHost(args.host()).thenApply(token -> + GitHubTokenProviderResult.token(token, 8 * 60 * 60))); +``` + +The remaining lifetime is required and must be positive when the callback +completes; production GitHub tokens typically last eight hours. A static token +and a provider are mutually exclusive. + +Initial acquisition runs during session creation or resume. Cancellation, +provider errors, and invalid token responses reject that operation instead of +falling back to ambient authentication. Idle sessions refresh only before their +next credential-consuming operation; there is no background refresh timer. + +## 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 ``` ## Annotation-based tools and `ToolInvocation` context @@ -232,6 +330,10 @@ Chain fluent modifiers to set tool options: 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`. @@ -386,7 +488,7 @@ The gate also applies to individual methods annotated with `@CopilotExperimental ### Development Setup -Requires JDK 25 or later for development. The following steps validate the artifact built with JDK 25 runs on both 25 and 17, preserving the MR-JAR behavior. +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 @@ -405,6 +507,65 @@ mvn verify -Dskip.test.harness=true 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 ``` +#### Development Setup for native embedding + +Run native-runtime Maven commands from the `java` directory. Native packaging requires Node.js and npm in addition to JDK 25 and Maven because `copilot-native/scripts/fetch-native.mjs` retrieves the pinned npm runtime package. + +On a native Linux glibc host, Maven activates `native-linux-x64` or `native-linux-arm64` for the matching architecture when `copilot.native.libc=glibc` is set. On Windows x64, Windows ARM64, and Apple Silicon macOS, Maven activates `native-win32-x64`, `native-win32-arm64`, or `native-darwin-arm64` automatically. The matching profile validates the host, runs the native script tests, fetches the pinned `@github/copilot-` package during `generate-resources`, packages the classifier JAR during `package`, and verifies its native contents. Ensure npm can authenticate to the package registry before running the build. + +Before opting in, validate that Node.js reports glibc for the build host: + +```bash +node copilot-native/scripts/validate-native-host.mjs linux-x64 +mvn -pl copilot-native clean verify -Dcopilot.native.libc=glibc +``` + +The `inprocess` test profile performs the same validation and native packaging automatically, so the full in-process test command remains: + +```bash +mvn -Pinprocess clean verify +``` + +On Windows x64 or ARM64 PowerShell, initialize Java and run the same profile: + +```powershell +mvn -Pinprocess clean verify +``` + +The same command validates in-process mode on Apple Silicon macOS: + +```bash +node copilot-native/scripts/validate-native-host.mjs darwin-arm64 +mvn -Pinprocess clean verify +``` + +The same command validates in-process mode on Linux ARM64: + +```bash +node copilot-native/scripts/validate-native-host.mjs linux-arm64 +mvn -Pinprocess clean verify -Dcopilot.native.libc=glibc +``` + +On Intel macOS, Linux musl, and other unsupported hosts, do not set `copilot.native.libc=glibc`. A normal build produces only the OS-neutral primary, sources, and Javadoc JARs; it does not run native script tests, download or stage native files, or produce a platform classifier JAR. + +To build only the OS-neutral artifacts on any host, or override the glibc opt-in, disable native download and packaging: + +```bash +mvn -pl copilot-native clean package -DskipTests -Dcopilot.native.libc=glibc -Dcopilot.native.skip.download=true +``` + +The verified Linux x64 checks are: + +```bash +node --test copilot-native/scripts/fetch-native.test.mjs copilot-native/scripts/validate-native-host.test.mjs +mvn -pl copilot-native help:active-profiles -Dcopilot.native.libc=glibc -Dcopilot.native.skip.download=false +mvn -pl copilot-native test -Dcopilot.native.libc=glibc +mvn clean verify -Dcopilot.native.libc=glibc +mvn clean package -pl copilot-native -DskipTests -Dcopilot.native.libc=glibc -Dcopilot.native.skip.download=true +``` + +On Linux, the classifier JAR contains `runtime.node`, `platform.properties`, and `copilot` under `native/linux-x64` or `native/linux-arm64`. On Windows, it contains those resources under `native/win32-x64` or `native/win32-arm64`, with the CLI named `copilot.exe`. On Apple Silicon macOS, it contains them under `native/darwin-arm64`. The placeholder JAR remains OS-neutral and contains no native binaries. Unsupported hosts retain the placeholder-only behavior. + ## 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 0000000000..d138a0e56b --- /dev/null +++ b/java/copilot-native/pom.xml @@ -0,0 +1,970 @@ + + + + 4.0.0 + + + com.github + copilot-sdk-java-parent + 1.0.14-preview.2-SNAPSHOT + ../pom.xml + + + com.github + copilot-sdk-java-runtime + jar + + GitHub Copilot SDK :: Java :: Native Runtime + Native runtime artifacts for the GitHub Copilot Java SDK, with host-matched 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}/../.. + ${project.build.directory}/native-staging + + false + + + + + + + src/main/resources + true + + + + + + org.codehaus.mojo + exec-maven-plugin + + + validate-native-host + none + + exec + + + node + + ${project.basedir}/scripts/validate-native-host.mjs + ${copilot.native.classifier} + + + + + fetch-native + none + + exec + + + node + + ${project.basedir}/scripts/fetch-native.mjs + ${copilot.sdk.root} + ${copilot.native.staging} + ${copilot.native.classifier} + + + + + test-fetch-native + none + + exec + + + ${skipTests} + node + + --test + ${project.basedir}/scripts/fetch-native.test.mjs + ${project.basedir}/scripts/validate-native-host.test.mjs + ${project.basedir}/scripts/validate-native-artifact.test.mjs + + + + + + + org.apache.maven.plugins + maven-jar-plugin + + + + jar-native + none + + 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 + none + + run + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + org.sonatype.central + central-publishing-maven-plugin + true + + central + true + + + + + + + + + inprocess + + linux-x64 + copilot + + + + + org.codehaus.mojo + exec-maven-plugin + + + validate-native-host + validate + + + fetch-native + generate-resources + + + test-fetch-native + test + + + + + org.apache.maven.plugins + maven-jar-plugin + + + jar-native + package + + + + + org.apache.maven.plugins + maven-antrun-plugin + + + verify-native-jars + package + + + + + + + + + native-linux-x64 + + + Linux + amd64 + + + copilot.native.libc + glibc + + + + linux-x64 + copilot + + + + + org.codehaus.mojo + exec-maven-plugin + + + validate-native-host + validate + + + fetch-native + generate-resources + + + test-fetch-native + test + + + + + org.apache.maven.plugins + maven-jar-plugin + + + jar-native + package + + + + + org.apache.maven.plugins + maven-antrun-plugin + + + verify-native-jars + package + + + + + + + + native-linux-arm64 + + + Linux + aarch64 + + + copilot.native.libc + glibc + + + + linux-arm64 + copilot + + + + + org.codehaus.mojo + exec-maven-plugin + + + validate-native-host + validate + + + fetch-native + generate-resources + + + test-fetch-native + test + + + + + org.apache.maven.plugins + maven-jar-plugin + + + jar-native + package + + + + + org.apache.maven.plugins + maven-antrun-plugin + + + verify-native-jars + package + + + + + + + + native-win32-x64 + + + Windows + amd64 + + + + win32-x64 + copilot.exe + + + + + org.codehaus.mojo + exec-maven-plugin + + + validate-native-host + validate + + + fetch-native + generate-resources + + + test-fetch-native + test + + + + + org.apache.maven.plugins + maven-jar-plugin + + + jar-native + package + + + + + org.apache.maven.plugins + maven-antrun-plugin + + + verify-native-jars + package + + + + + + + + native-win32-arm64 + + + Windows + aarch64 + + + + win32-arm64 + copilot.exe + + + + + org.codehaus.mojo + exec-maven-plugin + + + validate-native-host + validate + + + fetch-native + generate-resources + + + test-fetch-native + test + + + + + org.apache.maven.plugins + maven-jar-plugin + + + jar-native + package + + + + + org.apache.maven.plugins + maven-antrun-plugin + + + verify-native-jars + package + + + + + + + + native-darwin-arm64 + + + mac + aarch64 + + + + darwin-arm64 + copilot + + + + + org.codehaus.mojo + exec-maven-plugin + + + validate-native-host + validate + + + fetch-native + generate-resources + + + test-fetch-native + test + + + + + org.apache.maven.plugins + maven-jar-plugin + + + jar-native + package + + + + + org.apache.maven.plugins + maven-antrun-plugin + + + verify-native-jars + package + + + + + + + + + attach-external-linux-arm64-classifier + + + copilot.native.external.linux.arm64.classifier.path + + + + + + org.codehaus.mojo + exec-maven-plugin + + + validate-external-linux-arm64-classifier + validate + + exec + + + node + + ${project.basedir}/scripts/validate-native-artifact.mjs + classifier + linux-arm64 + ${copilot.native.external.linux.arm64.classifier.path} + ${project.build.finalName}-linux-arm64.jar + ${copilot.sdk.root} + + + + + + + org.codehaus.mojo + build-helper-maven-plugin + + + attach-external-linux-arm64-classifier + package + + attach-artifact + + + + + ${copilot.native.external.linux.arm64.classifier.path} + jar + linux-arm64 + + + + + + + + + + + + attach-external-win32-classifier + + + copilot.native.external.win32.classifier.path + + + + + + org.codehaus.mojo + exec-maven-plugin + + + validate-external-win32-classifier + validate + + exec + + + node + + ${project.basedir}/scripts/validate-native-artifact.mjs + classifier + win32-x64 + ${copilot.native.external.win32.classifier.path} + ${project.build.finalName}-win32-x64.jar + ${copilot.sdk.root} + + + + + + + org.codehaus.mojo + build-helper-maven-plugin + + + attach-external-win32-classifier + package + + attach-artifact + + + + + ${copilot.native.external.win32.classifier.path} + jar + win32-x64 + + + + + + + + + + + + attach-external-win32-arm64-classifier + + + copilot.native.external.win32.arm64.classifier.path + + + + + + org.codehaus.mojo + exec-maven-plugin + + + validate-external-win32-arm64-classifier + validate + + exec + + + node + + ${project.basedir}/scripts/validate-native-artifact.mjs + classifier + win32-arm64 + ${copilot.native.external.win32.arm64.classifier.path} + ${project.build.finalName}-win32-arm64.jar + ${copilot.sdk.root} + + + + + + + org.codehaus.mojo + build-helper-maven-plugin + + + attach-external-win32-arm64-classifier + package + + attach-artifact + + + + + ${copilot.native.external.win32.arm64.classifier.path} + jar + win32-arm64 + + + + + + + + + + + + attach-external-darwin-classifier + + + copilot.native.external.darwin.classifier.path + + + + + + org.codehaus.mojo + exec-maven-plugin + + + validate-external-darwin-classifier + validate + + exec + + + node + + ${project.basedir}/scripts/validate-native-artifact.mjs + classifier + darwin-arm64 + ${copilot.native.external.darwin.classifier.path} + ${project.build.finalName}-darwin-arm64.jar + ${copilot.sdk.root} + + + + + + + org.codehaus.mojo + build-helper-maven-plugin + + + attach-external-darwin-classifier + package + + attach-artifact + + + + + ${copilot.native.external.darwin.classifier.path} + jar + darwin-arm64 + + + + + + + + + + + + attach-test-linux-classifier + + + copilot.native.test.linux.classifier.path + + + + + + org.codehaus.mojo + exec-maven-plugin + + + validate-test-linux-classifier + validate + + exec + + + node + + ${project.basedir}/scripts/validate-native-artifact.mjs + classifier + linux-x64 + ${copilot.native.test.linux.classifier.path} + ${project.build.finalName}-linux-x64.jar + ${copilot.sdk.root} + + + + + + + org.codehaus.mojo + build-helper-maven-plugin + + + attach-test-linux-classifier + package + + attach-artifact + + + + + ${copilot.native.test.linux.classifier.path} + jar + linux-x64 + + + + + + + + + + + + local-publication-validation + + + copilot.native.test.local.publication + true + + + + + + org.sonatype.central + central-publishing-maven-plugin + + true + + + + + + + + skip-native-download + + + copilot.native.skip.download + true + + + + + + org.codehaus.mojo + exec-maven-plugin + + + validate-native-host + none + + + fetch-native + none + + + test-fetch-native + none + + + + + org.apache.maven.plugins + maven-jar-plugin + + + jar-native + none + + + + + org.apache.maven.plugins + maven-antrun-plugin + + + verify-native-jars + none + + + + + + + + diff --git a/java/copilot-native/scripts/create-native-classifier-test-fixture.mjs b/java/copilot-native/scripts/create-native-classifier-test-fixture.mjs new file mode 100644 index 0000000000..095d8c1e9e --- /dev/null +++ b/java/copilot-native/scripts/create-native-classifier-test-fixture.mjs @@ -0,0 +1,119 @@ +/*--------------------------------------------------------------------------------------------- + * Copyright (c) Microsoft Corporation. All rights reserved. + *--------------------------------------------------------------------------------------------*/ + +import fs from "node:fs"; +import path from "node:path"; +import { pathToFileURL } from "node:url"; + +import { readPinnedNativeVersion } from "./validate-native-artifact.mjs"; + +export function createNativeClassifierTestFixture({ + classifier, + outputPath, + repoRoot, +}) { + const cliFilename = classifier.startsWith("win32") + ? "copilot.exe" + : "copilot"; + const nativeVersion = readPinnedNativeVersion(repoRoot, classifier); + const prefix = `native/${classifier}`; + writeStoredZip(outputPath, [ + [`${prefix}/runtime.node`, "test runtime"], + [`${prefix}/${cliFilename}`, "test cli"], + [ + `${prefix}/platform.properties`, + `classifier=${classifier}\nversion=${nativeVersion}\n`, + ], + ]); +} + +export function writeStoredZip(outputPath, entries) { + const localRecords = []; + const centralRecords = []; + let offset = 0; + + for (const [filename, contents] of entries) { + const filenameBuffer = Buffer.from(filename); + const contentsBuffer = Buffer.isBuffer(contents) + ? contents + : Buffer.from(contents); + const crc = crc32(contentsBuffer); + const localHeader = Buffer.alloc(30); + localHeader.writeUInt32LE(0x04034b50, 0); + localHeader.writeUInt16LE(20, 4); + localHeader.writeUInt32LE(crc, 14); + localHeader.writeUInt32LE(contentsBuffer.length, 18); + localHeader.writeUInt32LE(contentsBuffer.length, 22); + localHeader.writeUInt16LE(filenameBuffer.length, 26); + const localRecord = Buffer.concat([ + localHeader, + filenameBuffer, + contentsBuffer, + ]); + localRecords.push(localRecord); + + const centralHeader = Buffer.alloc(46); + centralHeader.writeUInt32LE(0x02014b50, 0); + centralHeader.writeUInt16LE(20, 4); + centralHeader.writeUInt16LE(20, 6); + centralHeader.writeUInt32LE(crc, 16); + centralHeader.writeUInt32LE(contentsBuffer.length, 20); + centralHeader.writeUInt32LE(contentsBuffer.length, 24); + centralHeader.writeUInt16LE(filenameBuffer.length, 28); + centralHeader.writeUInt32LE(offset, 42); + centralRecords.push(Buffer.concat([centralHeader, filenameBuffer])); + offset += localRecord.length; + } + + const centralDirectory = Buffer.concat(centralRecords); + const endOfCentralDirectory = Buffer.alloc(22); + endOfCentralDirectory.writeUInt32LE(0x06054b50, 0); + endOfCentralDirectory.writeUInt16LE(entries.length, 8); + endOfCentralDirectory.writeUInt16LE(entries.length, 10); + endOfCentralDirectory.writeUInt32LE(centralDirectory.length, 12); + endOfCentralDirectory.writeUInt32LE(offset, 16); + + fs.mkdirSync(path.dirname(outputPath), { recursive: true }); + fs.writeFileSync( + outputPath, + Buffer.concat([...localRecords, centralDirectory, endOfCentralDirectory]), + ); +} + +function crc32(buffer) { + let crc = 0xffffffff; + for (const byte of buffer) { + crc ^= byte; + for (let bit = 0; bit < 8; bit += 1) { + crc = (crc >>> 1) ^ (crc & 1 ? 0xedb88320 : 0); + } + } + return (crc ^ 0xffffffff) >>> 0; +} + +function main() { + const [classifier, outputPath, repoRoot] = process.argv.slice(2); + if (!classifier || !outputPath || !repoRoot) { + console.error( + "Usage: node create-native-classifier-test-fixture.mjs ", + ); + process.exitCode = 1; + return; + } + + try { + createNativeClassifierTestFixture({ classifier, outputPath, repoRoot }); + console.log(`Created ${classifier} test fixture: ${outputPath}`); + } catch (error) { + console.error(error.message); + process.exitCode = 1; + } +} + +if ( + process.argv[1] && + import.meta.url === pathToFileURL(process.argv[1]).href +) { + main(); +} diff --git a/java/copilot-native/scripts/fetch-native.mjs b/java/copilot-native/scripts/fetch-native.mjs new file mode 100644 index 0000000000..7b68f04065 --- /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 0000000000..3ca1e2fde6 --- /dev/null +++ b/java/copilot-native/scripts/fetch-native.test.mjs @@ -0,0 +1,130 @@ +/*--------------------------------------------------------------------------------------------- + * 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 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)); + +for (const classifier of ['linux-x64', 'linux-arm64', 'win32-x64', 'win32-arm64', 'darwin-arm64']) { + test(`${classifier}: missing CLI does not use incremental fast path`, (t) => { + const fixture = createFixture(t, classifier); + fs.rmSync(fixture.cliPath); + + const result = runScript(fixture); + + assertRestagingAttempted(fixture, result); + }); + + test(`${classifier}: stale CLI does not use incremental fast path`, (t) => { + const fixture = createFixture(t, classifier); + fs.writeFileSync(fixture.cliPath, 'stale CLI content'); + + const result = runScript(fixture); + + assertRestagingAttempted(fixture, result); + }); + + test(`${classifier}: missing platform metadata does not use incremental fast path`, (t) => { + const fixture = createFixture(t, classifier); + fs.rmSync(fixture.platformPropertiesPath); + + const result = runScript(fixture); + + assertRestagingAttempted(fixture, result); + }); + + test(`${classifier}: complete matching artifacts use incremental fast path`, (t) => { + const fixture = createFixture(t, classifier); + + 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, classifier) { + 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, classifier.startsWith('win32') ? 'copilot.exe' : '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, process.platform === 'win32' ? 'npm.cmd' : 'npm'); + if (process.platform === 'win32') { + fs.writeFileSync(fakeNpmPath, '@echo off\r\n> "%FETCH_NATIVE_NPM_MARKER%" echo invoked\r\nexit /b 42\r\n'); + } else { + fs.writeFileSync(fakeNpmPath, '#!/bin/sh\nprintf invoked > "$FETCH_NATIVE_NPM_MARKER"\nexit 42\n'); + fs.chmodSync(fakeNpmPath, 0o755); + } + + return { + classifier, + repoRoot, + stagingDir, + fakeBinDir, + npmMarkerPath, + runtimePath, + cliPath, + platformPropertiesPath, + }; +} + +function runScript(fixture) { + return spawnSync(process.execPath, [scriptPath, fixture.repoRoot, fixture.stagingDir, fixture.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').trim(), 'invoked'); +} + +function digest(content) { + return `sha512-${createHash('sha512').update(content).digest('base64')}`; +} diff --git a/java/copilot-native/scripts/validate-local-publication.mjs b/java/copilot-native/scripts/validate-local-publication.mjs new file mode 100644 index 0000000000..c83f9682dd --- /dev/null +++ b/java/copilot-native/scripts/validate-local-publication.mjs @@ -0,0 +1,117 @@ +/*--------------------------------------------------------------------------------------------- + * Copyright (c) Microsoft Corporation. All rights reserved. + *--------------------------------------------------------------------------------------------*/ + +import fs from "node:fs"; +import path from "node:path"; +import { pathToFileURL } from "node:url"; + +import { + validateNativeClassifierJar, + validatePlaceholderJar, +} from "./validate-native-artifact.mjs"; + +export function validateLocalPublication({ + artifactId, + repositoryPath, + repoRoot, + requireSignatures, + version, +}) { + const artifactDirectory = path.join( + repositoryPath, + "com", + "github", + artifactId, + version, + ); + const requiredArtifacts = [ + `${artifactId}-${version}.jar`, + `${artifactId}-${version}.pom`, + `${artifactId}-${version}-sources.jar`, + `${artifactId}-${version}-javadoc.jar`, + `${artifactId}-${version}-linux-x64.jar`, + `${artifactId}-${version}-linux-arm64.jar`, + `${artifactId}-${version}-win32-x64.jar`, + `${artifactId}-${version}-win32-arm64.jar`, + `${artifactId}-${version}-darwin-arm64.jar`, + ]; + const files = new Set(fs.readdirSync(artifactDirectory)); + + for (const artifact of requiredArtifacts) { + if (!files.has(artifact)) { + throw new Error(`Local publication is missing ${artifact}`); + } + if (requireSignatures && !files.has(`${artifact}.asc`)) { + throw new Error( + `Local release publication is missing signature ${artifact}.asc`, + ); + } + } + + const publishedJars = [...files] + .filter((file) => file.endsWith(".jar")) + .sort(); + const expectedJars = requiredArtifacts + .filter((file) => file.endsWith(".jar")) + .sort(); + if (publishedJars.join("\n") !== expectedJars.join("\n")) { + throw new Error( + `Local publication contains unexpected JARs:\n${publishedJars.join("\n")}`, + ); + } + + validatePlaceholderJar( + path.join(artifactDirectory, `${artifactId}-${version}.jar`), + ); + for (const classifier of [ + "linux-x64", + "linux-arm64", + "win32-x64", + "win32-arm64", + "darwin-arm64", + ]) { + const filename = `${artifactId}-${version}-${classifier}.jar`; + validateNativeClassifierJar({ + classifier, + jarPath: path.join(artifactDirectory, filename), + expectedFilename: filename, + repoRoot, + }); + } + + return artifactDirectory; +} + +function main() { + const [repositoryPath, artifactId, version, repoRoot, signatures] = + process.argv.slice(2); + if (!repositoryPath || !artifactId || !version || !repoRoot) { + console.error( + "Usage: node validate-local-publication.mjs [--signatures]", + ); + process.exitCode = 1; + return; + } + + try { + const artifactDirectory = validateLocalPublication({ + artifactId, + repositoryPath, + repoRoot, + requireSignatures: signatures === "--signatures", + version, + }); + console.log(`Validated local Maven publication: ${artifactDirectory}`); + } catch (error) { + console.error(error.message); + process.exitCode = 1; + } +} + +if ( + process.argv[1] && + import.meta.url === pathToFileURL(process.argv[1]).href +) { + main(); +} diff --git a/java/copilot-native/scripts/validate-native-artifact.mjs b/java/copilot-native/scripts/validate-native-artifact.mjs new file mode 100644 index 0000000000..dda86a917a --- /dev/null +++ b/java/copilot-native/scripts/validate-native-artifact.mjs @@ -0,0 +1,341 @@ +/*--------------------------------------------------------------------------------------------- + * Copyright (c) Microsoft Corporation. All rights reserved. + *--------------------------------------------------------------------------------------------*/ + +import { createHash } from "node:crypto"; +import fs from "node:fs"; +import path from "node:path"; +import { pathToFileURL } from "node:url"; +import zlib from "node:zlib"; + +const END_OF_CENTRAL_DIRECTORY = 0x06054b50; +const CENTRAL_DIRECTORY_FILE_HEADER = 0x02014b50; +const LOCAL_FILE_HEADER = 0x04034b50; +const PLATFORM_CLASSIFIER = + /^(?:linux(?:musl)?-(?:x64|arm64)|darwin-(?:x64|arm64)|win32-(?:x64|arm64))$/; + +export function validateNativeClassifierJar({ + classifier, + jarPath, + expectedFilename, + repoRoot, +}) { + if (path.basename(jarPath) !== expectedFilename) { + throw new Error( + `External ${classifier} classifier must be named ${expectedFilename}; received ${path.basename(jarPath)}`, + ); + } + + const archive = readJar(jarPath); + const cliFilename = classifier.startsWith("win32") + ? "copilot.exe" + : "copilot"; + const resourcePrefix = `native/${classifier}/`; + const requiredEntries = [ + `${resourcePrefix}runtime.node`, + `${resourcePrefix}${cliFilename}`, + `${resourcePrefix}platform.properties`, + ]; + + for (const entryName of requiredEntries) { + const entry = archive.entries.get(entryName); + if (!entry || entry.uncompressedSize === 0) { + throw new Error( + `External ${classifier} classifier is missing nonempty ${entryName}`, + ); + } + } + + for (const entryName of archive.entries.keys()) { + const nativeClassifier = /^native\/([^/]+)\//.exec(entryName)?.[1]; + if (nativeClassifier && nativeClassifier !== classifier) { + throw new Error( + `External ${classifier} classifier must not contain ${entryName}`, + ); + } + } + + const properties = parseProperties( + readEntry(archive, `${resourcePrefix}platform.properties`), + ); + const expectedVersion = readPinnedNativeVersion(repoRoot, classifier); + if (properties.classifier !== classifier) { + throw new Error( + `External classifier metadata must contain classifier=${classifier}; received ${properties.classifier ?? "none"}`, + ); + } + if (properties.version !== expectedVersion) { + throw new Error( + `External ${classifier} classifier metadata must contain version=${expectedVersion}; received ${properties.version ?? "none"}`, + ); + } + + return { + classifier, + nativeVersion: expectedVersion, + sha256: undefined, + }; +} + +export function validatePlaceholderJar(jarPath) { + const archive = readJar(jarPath); + for (const entryName of archive.entries.keys()) { + const nativeClassifier = /^native\/([^/]+)\//.exec(entryName)?.[1]; + if (nativeClassifier && PLATFORM_CLASSIFIER.test(nativeClassifier)) { + throw new Error( + `Placeholder primary JAR must not contain platform-native resources; found ${entryName}`, + ); + } + } +} + +export function validateSha256Manifest({ + expectedFilename, + jarPath, + manifestPath, +}) { + let manifest; + try { + manifest = fs.readFileSync(manifestPath, "utf8").trim(); + } catch (error) { + throw new Error( + `Could not read SHA-256 manifest ${manifestPath}: ${error.message}`, + ); + } + const match = /^([a-fA-F0-9]{64}) {2}(.+)$/.exec(manifest); + if (!match || match[2] !== expectedFilename) { + throw new Error( + `SHA-256 manifest must contain one checksum for ${expectedFilename}: ${manifestPath}`, + ); + } + const actual = createHash("sha256") + .update(fs.readFileSync(jarPath)) + .digest("hex"); + if (actual !== match[1].toLowerCase()) { + throw new Error( + `SHA-256 mismatch for ${expectedFilename}; expected ${match[1].toLowerCase()}, received ${actual}`, + ); + } +} + +export function readPinnedNativeVersion(repoRoot, classifier) { + const packageName = `@github/copilot-${classifier}`; + const lockPath = path.join(repoRoot, "nodejs", "package-lock.json"); + let lock; + try { + lock = JSON.parse(fs.readFileSync(lockPath, "utf8")); + } catch (error) { + throw new Error( + `Could not read pinned ${packageName} version from ${lockPath}: ${error.message}`, + ); + } + + const version = lock.packages?.[`node_modules/${packageName}`]?.version; + if (!version) { + throw new Error( + `Could not find pinned ${packageName} version in ${lockPath}`, + ); + } + return version; +} + +function readJar(jarPath) { + let stat; + try { + stat = fs.statSync(jarPath); + } catch (error) { + throw new Error(`External classifier JAR does not exist: ${jarPath}`); + } + if (!stat.isFile() || path.extname(jarPath).toLowerCase() !== ".jar") { + throw new Error( + `External classifier must be a regular .jar file: ${jarPath}`, + ); + } + + const data = fs.readFileSync(jarPath); + const eocdOffset = findEndOfCentralDirectory(data); + const entryCount = data.readUInt16LE(eocdOffset + 10); + const centralDirectorySize = data.readUInt32LE(eocdOffset + 12); + const centralDirectoryOffset = data.readUInt32LE(eocdOffset + 16); + if (entryCount === 0xffff || centralDirectoryOffset === 0xffffffff) { + throw new Error(`ZIP64 classifier JARs are not supported: ${jarPath}`); + } + if (centralDirectoryOffset + centralDirectorySize > data.length) { + throw new Error( + `Classifier JAR has an invalid central directory: ${jarPath}`, + ); + } + + const entries = new Map(); + let offset = centralDirectoryOffset; + for (let index = 0; index < entryCount; index += 1) { + if (readUInt32(data, offset, jarPath) !== CENTRAL_DIRECTORY_FILE_HEADER) { + throw new Error( + `Classifier JAR has an invalid central directory entry: ${jarPath}`, + ); + } + const compressionMethod = data.readUInt16LE(offset + 10); + const compressedSize = data.readUInt32LE(offset + 20); + const uncompressedSize = data.readUInt32LE(offset + 24); + const filenameLength = data.readUInt16LE(offset + 28); + const extraLength = data.readUInt16LE(offset + 30); + const commentLength = data.readUInt16LE(offset + 32); + const localHeaderOffset = data.readUInt32LE(offset + 42); + const filenameOffset = offset + 46; + const nextOffset = + filenameOffset + filenameLength + extraLength + commentLength; + if (nextOffset > data.length) { + throw new Error( + `Classifier JAR has a truncated central directory entry: ${jarPath}`, + ); + } + + const filename = data.toString( + "utf8", + filenameOffset, + filenameOffset + filenameLength, + ); + if (entries.has(filename)) { + throw new Error( + `Classifier JAR contains duplicate entry ${filename}: ${jarPath}`, + ); + } + entries.set(filename, { + compressionMethod, + compressedSize, + uncompressedSize, + localHeaderOffset, + }); + offset = nextOffset; + } + + return { data, entries, jarPath }; +} + +function findEndOfCentralDirectory(data) { + const minimumSize = 22; + const minimumOffset = Math.max(0, data.length - minimumSize - 0xffff); + for ( + let offset = data.length - minimumSize; + offset >= minimumOffset; + offset -= 1 + ) { + if ( + data.readUInt32LE(offset) === END_OF_CENTRAL_DIRECTORY && + offset + minimumSize + data.readUInt16LE(offset + 20) === data.length + ) { + return offset; + } + } + throw new Error("Classifier JAR is not a valid ZIP archive"); +} + +function readEntry(archive, entryName) { + const entry = archive.entries.get(entryName); + if (!entry) { + throw new Error(`Classifier JAR is missing ${entryName}`); + } + if (entry.uncompressedSize > 1024 * 1024) { + throw new Error( + `Classifier JAR metadata entry is unexpectedly large: ${entryName}`, + ); + } + + const { data, jarPath } = archive; + const localOffset = entry.localHeaderOffset; + if (readUInt32(data, localOffset, jarPath) !== LOCAL_FILE_HEADER) { + throw new Error( + `Classifier JAR has an invalid local entry for ${entryName}`, + ); + } + const filenameLength = data.readUInt16LE(localOffset + 26); + const extraLength = data.readUInt16LE(localOffset + 28); + const contentsOffset = localOffset + 30 + filenameLength + extraLength; + const contentsEnd = contentsOffset + entry.compressedSize; + if (contentsEnd > data.length) { + throw new Error( + `Classifier JAR has a truncated local entry for ${entryName}`, + ); + } + + const compressed = data.subarray(contentsOffset, contentsEnd); + let contents; + if (entry.compressionMethod === 0) { + contents = compressed; + } else if (entry.compressionMethod === 8) { + contents = zlib.inflateRawSync(compressed); + } else { + throw new Error( + `Classifier JAR uses unsupported compression for ${entryName}: ${entry.compressionMethod}`, + ); + } + if (contents.length !== entry.uncompressedSize) { + throw new Error(`Classifier JAR has an invalid size for ${entryName}`); + } + return contents.toString("utf8"); +} + +function parseProperties(contents) { + const properties = {}; + for (const line of contents.split(/\r?\n/)) { + const separator = line.indexOf("="); + if (separator > 0) { + properties[line.slice(0, separator).trim()] = line + .slice(separator + 1) + .trim(); + } + } + return properties; +} + +function readUInt32(data, offset, jarPath) { + if (offset + 4 > data.length) { + throw new Error(`Classifier JAR is truncated: ${jarPath}`); + } + return data.readUInt32LE(offset); +} + +function main() { + const [mode, ...arguments_] = process.argv.slice(2); + try { + if (mode === "classifier" && arguments_.length === 4) { + const [classifier, jarPath, expectedFilename, repoRoot] = arguments_; + const result = validateNativeClassifierJar({ + classifier, + jarPath, + expectedFilename, + repoRoot, + }); + console.log( + `Validated ${result.classifier} classifier JAR (${result.nativeVersion}): ${jarPath}`, + ); + return; + } + if (mode === "placeholder" && arguments_.length === 1) { + validatePlaceholderJar(arguments_[0]); + console.log(`Validated native-free placeholder JAR: ${arguments_[0]}`); + return; + } + if (mode === "checksum" && arguments_.length === 3) { + const [jarPath, manifestPath, expectedFilename] = arguments_; + validateSha256Manifest({ expectedFilename, jarPath, manifestPath }); + console.log( + `Validated SHA-256 manifest for ${expectedFilename}: ${manifestPath}`, + ); + return; + } + throw new Error( + "Usage: node validate-native-artifact.mjs classifier | placeholder | checksum ", + ); + } catch (error) { + console.error(error.message); + process.exitCode = 1; + } +} + +if ( + process.argv[1] && + import.meta.url === pathToFileURL(process.argv[1]).href +) { + main(); +} diff --git a/java/copilot-native/scripts/validate-native-artifact.test.mjs b/java/copilot-native/scripts/validate-native-artifact.test.mjs new file mode 100644 index 0000000000..eb99d432db --- /dev/null +++ b/java/copilot-native/scripts/validate-native-artifact.test.mjs @@ -0,0 +1,557 @@ +/*--------------------------------------------------------------------------------------------- + * Copyright (c) Microsoft Corporation. All rights reserved. + *--------------------------------------------------------------------------------------------*/ + +import assert from "node:assert/strict"; +import { createHash } from "node:crypto"; +import fs from "node:fs"; +import path from "node:path"; +import test from "node:test"; +import { fileURLToPath } from "node:url"; + +import { + createNativeClassifierTestFixture, + writeStoredZip, +} from "./create-native-classifier-test-fixture.mjs"; +import { + validateNativeClassifierJar, + validatePlaceholderJar, + validateSha256Manifest, +} from "./validate-native-artifact.mjs"; +import { validateLocalPublication } from "./validate-local-publication.mjs"; + +const classifier = "win32-x64"; +const artifactName = "copilot-sdk-java-runtime-1.2.3-win32-x64.jar"; +const moduleRoot = fileURLToPath(new URL("../", import.meta.url)); + +test("accepts a matching, complete Windows classifier", (t) => { + const fixture = createFixture(t); + createNativeClassifierTestFixture({ + classifier, + outputPath: fixture.jarPath, + repoRoot: fixture.repoRoot, + }); + + assert.deepEqual( + validateNativeClassifierJar({ + classifier, + jarPath: fixture.jarPath, + expectedFilename: artifactName, + repoRoot: fixture.repoRoot, + }), + { classifier, nativeVersion: "9.8.7", sha256: undefined }, + ); +}); + +test("accepts a matching, complete Windows ARM64 classifier", (t) => { + const fixture = createFixture(t); + const windowsArm64Classifier = "win32-arm64"; + const windowsArm64ArtifactName = + "copilot-sdk-java-runtime-1.2.3-win32-arm64.jar"; + const windowsArm64JarPath = path.join( + fixture.root, + windowsArm64ArtifactName, + ); + createNativeClassifierTestFixture({ + classifier: windowsArm64Classifier, + outputPath: windowsArm64JarPath, + repoRoot: fixture.repoRoot, + }); + + assert.deepEqual( + validateNativeClassifierJar({ + classifier: windowsArm64Classifier, + jarPath: windowsArm64JarPath, + expectedFilename: windowsArm64ArtifactName, + repoRoot: fixture.repoRoot, + }), + { + classifier: windowsArm64Classifier, + nativeVersion: "9.8.10", + sha256: undefined, + }, + ); +}); + +test("accepts a matching, complete Darwin classifier", (t) => { + const fixture = createFixture(t); + const darwinClassifier = "darwin-arm64"; + const darwinArtifactName = + "copilot-sdk-java-runtime-1.2.3-darwin-arm64.jar"; + const darwinJarPath = path.join(fixture.root, darwinArtifactName); + createNativeClassifierTestFixture({ + classifier: darwinClassifier, + outputPath: darwinJarPath, + repoRoot: fixture.repoRoot, + }); + + assert.deepEqual( + validateNativeClassifierJar({ + classifier: darwinClassifier, + jarPath: darwinJarPath, + expectedFilename: darwinArtifactName, + repoRoot: fixture.repoRoot, + }), + { + classifier: darwinClassifier, + nativeVersion: "9.8.8", + sha256: undefined, + }, + ); +}); + +test("accepts a matching, complete Linux ARM64 classifier", (t) => { + const fixture = createFixture(t); + const linuxArm64Classifier = "linux-arm64"; + const linuxArm64ArtifactName = + "copilot-sdk-java-runtime-1.2.3-linux-arm64.jar"; + const linuxArm64JarPath = path.join(fixture.root, linuxArm64ArtifactName); + createNativeClassifierTestFixture({ + classifier: linuxArm64Classifier, + outputPath: linuxArm64JarPath, + repoRoot: fixture.repoRoot, + }); + + assert.deepEqual( + validateNativeClassifierJar({ + classifier: linuxArm64Classifier, + jarPath: linuxArm64JarPath, + expectedFilename: linuxArm64ArtifactName, + repoRoot: fixture.repoRoot, + }), + { + classifier: linuxArm64Classifier, + nativeVersion: "9.8.9", + sha256: undefined, + }, + ); +}); + +test("rejects a wrong external filename before attachment", (t) => { + const fixture = createFixture(t); + const wrongName = path.join(fixture.root, "arbitrary.jar"); + createNativeClassifierTestFixture({ + classifier, + outputPath: wrongName, + repoRoot: fixture.repoRoot, + }); + + assert.throws( + () => + validateNativeClassifierJar({ + classifier, + jarPath: wrongName, + expectedFilename: artifactName, + repoRoot: fixture.repoRoot, + }), + /must be named/, + ); +}); + +test("rejects a missing classifier JAR with the expected filename", (t) => { + const fixture = createFixture(t); + + assert.throws( + () => + validateNativeClassifierJar({ + classifier, + jarPath: fixture.jarPath, + expectedFilename: artifactName, + repoRoot: fixture.repoRoot, + }), + /does not exist/, + ); +}); + +test("rejects missing native resources", (t) => { + const fixture = createFixture(t); + writeStoredZip(fixture.jarPath, [ + ["native/win32-x64/runtime.node", "runtime"], + [ + "native/win32-x64/platform.properties", + "classifier=win32-x64\nversion=9.8.7\n", + ], + ]); + + assert.throws( + () => + validateNativeClassifierJar({ + classifier, + jarPath: fixture.jarPath, + expectedFilename: artifactName, + repoRoot: fixture.repoRoot, + }), + /copilot\.exe/, + ); +}); + +test("rejects incorrect pinned package metadata", (t) => { + const fixture = createFixture(t); + writeStoredZip(fixture.jarPath, [ + ["native/win32-x64/runtime.node", "runtime"], + ["native/win32-x64/copilot.exe", "cli"], + [ + "native/win32-x64/platform.properties", + "classifier=win32-x64\nversion=0.0.1\n", + ], + ]); + + assert.throws( + () => + validateNativeClassifierJar({ + classifier, + jarPath: fixture.jarPath, + expectedFilename: artifactName, + repoRoot: fixture.repoRoot, + }), + /version=9\.8\.7/, + ); +}); + +test("rejects Linux resources in a Windows classifier", (t) => { + const fixture = createFixture(t); + createNativeClassifierTestFixture({ + classifier, + outputPath: fixture.jarPath, + repoRoot: fixture.repoRoot, + }); + writeStoredZip(fixture.jarPath, [ + ["native/win32-x64/runtime.node", "runtime"], + ["native/win32-x64/copilot.exe", "cli"], + [ + "native/win32-x64/platform.properties", + "classifier=win32-x64\nversion=9.8.7\n", + ], + ["native/linux-x64/runtime.node", "wrong platform"], + ]); + + assert.throws( + () => + validateNativeClassifierJar({ + classifier, + jarPath: fixture.jarPath, + expectedFilename: artifactName, + repoRoot: fixture.repoRoot, + }), + /must not contain/, + ); +}); + +test("rejects Windows resources in a Linux classifier", (t) => { + const fixture = createFixture(t); + const linuxClassifier = "linux-x64"; + const linuxArtifactName = + "copilot-sdk-java-runtime-1.2.3-linux-x64.jar"; + const linuxJarPath = path.join(fixture.root, linuxArtifactName); + writeStoredZip(linuxJarPath, [ + ["native/linux-x64/runtime.node", "runtime"], + ["native/linux-x64/copilot", "cli"], + [ + "native/linux-x64/platform.properties", + "classifier=linux-x64\nversion=9.8.6\n", + ], + ["native/win32-x64/runtime.node", "wrong platform"], + ]); + + assert.throws( + () => + validateNativeClassifierJar({ + classifier: linuxClassifier, + jarPath: linuxJarPath, + expectedFilename: linuxArtifactName, + repoRoot: fixture.repoRoot, + }), + /must not contain/, + ); +}); + +test("rejects native resources in the placeholder JAR", (t) => { + const fixture = createFixture(t); + writeStoredZip(fixture.jarPath, [ + ["native/win32-x64/runtime.node", "runtime"], + ]); + + assert.throws( + () => validatePlaceholderJar(fixture.jarPath), + /must not contain/, + ); +}); + +test("rejects Darwin native resources in the placeholder JAR", (t) => { + const fixture = createFixture(t); + writeStoredZip(fixture.jarPath, [ + ["native/darwin-arm64/runtime.node", "runtime"], + ]); + + assert.throws( + () => validatePlaceholderJar(fixture.jarPath), + /must not contain/, + ); +}); + +test("accepts a native-free placeholder JAR", (t) => { + const fixture = createFixture(t); + writeStoredZip(fixture.jarPath, [ + ["META-INF/MANIFEST.MF", "Manifest-Version: 1.0\n"], + ]); + + assert.doesNotThrow(() => validatePlaceholderJar(fixture.jarPath)); +}); + +test("rejects an invalid SHA-256 manifest", (t) => { + const fixture = createFixture(t); + createNativeClassifierTestFixture({ + classifier, + outputPath: fixture.jarPath, + repoRoot: fixture.repoRoot, + }); + const manifestPath = path.join(fixture.root, "classifier.sha256"); + fs.writeFileSync(manifestPath, `${"0".repeat(64)} ${artifactName}\n`); + + assert.throws( + () => + validateSha256Manifest({ + expectedFilename: artifactName, + jarPath: fixture.jarPath, + manifestPath, + }), + /SHA-256 mismatch/, + ); +}); + +test("accepts a matching SHA-256 manifest", (t) => { + const fixture = createFixture(t); + createNativeClassifierTestFixture({ + classifier, + outputPath: fixture.jarPath, + repoRoot: fixture.repoRoot, + }); + const manifestPath = path.join(fixture.root, "classifier.sha256"); + const digest = createHash("sha256") + .update(fs.readFileSync(fixture.jarPath)) + .digest("hex"); + fs.writeFileSync(manifestPath, `${digest} ${artifactName}\n`); + + assert.doesNotThrow(() => + validateSha256Manifest({ + expectedFilename: artifactName, + jarPath: fixture.jarPath, + manifestPath, + }), + ); +}); + +test("validates one complete signed local publication", (t) => { + const fixture = createFixture(t); + const artifactId = "copilot-sdk-java-runtime"; + const version = "1.2.3"; + const publicationDirectory = path.join( + fixture.root, + "repository", + "com", + "github", + artifactId, + version, + ); + fs.mkdirSync(publicationDirectory, { recursive: true }); + const primaryJar = `${artifactId}-${version}.jar`; + const linuxJar = `${artifactId}-${version}-linux-x64.jar`; + const linuxArm64Jar = `${artifactId}-${version}-linux-arm64.jar`; + const windowsJar = `${artifactId}-${version}-win32-x64.jar`; + const windowsArm64Jar = `${artifactId}-${version}-win32-arm64.jar`; + const darwinJar = `${artifactId}-${version}-darwin-arm64.jar`; + writeStoredZip(path.join(publicationDirectory, primaryJar), [ + ["META-INF/MANIFEST.MF", "Manifest-Version: 1.0\n"], + ]); + writeStoredZip( + path.join(publicationDirectory, `${artifactId}-${version}-sources.jar`), + [], + ); + writeStoredZip( + path.join(publicationDirectory, `${artifactId}-${version}-javadoc.jar`), + [], + ); + createNativeClassifierTestFixture({ + classifier: "linux-x64", + outputPath: path.join(publicationDirectory, linuxJar), + repoRoot: fixture.repoRoot, + }); + createNativeClassifierTestFixture({ + classifier: "linux-arm64", + outputPath: path.join(publicationDirectory, linuxArm64Jar), + repoRoot: fixture.repoRoot, + }); + createNativeClassifierTestFixture({ + classifier, + outputPath: path.join(publicationDirectory, windowsJar), + repoRoot: fixture.repoRoot, + }); + createNativeClassifierTestFixture({ + classifier: "win32-arm64", + outputPath: path.join(publicationDirectory, windowsArm64Jar), + repoRoot: fixture.repoRoot, + }); + createNativeClassifierTestFixture({ + classifier: "darwin-arm64", + outputPath: path.join(publicationDirectory, darwinJar), + repoRoot: fixture.repoRoot, + }); + fs.writeFileSync( + path.join(publicationDirectory, `${artifactId}-${version}.pom`), + "", + ); + for (const artifact of [ + primaryJar, + `${artifactId}-${version}.pom`, + `${artifactId}-${version}-sources.jar`, + `${artifactId}-${version}-javadoc.jar`, + linuxJar, + linuxArm64Jar, + windowsJar, + windowsArm64Jar, + darwinJar, + ]) { + fs.writeFileSync( + path.join(publicationDirectory, `${artifact}.asc`), + "signature", + ); + } + + assert.equal( + validateLocalPublication({ + artifactId, + repositoryPath: path.join(fixture.root, "repository"), + repoRoot: fixture.repoRoot, + requireSignatures: true, + version, + }), + publicationDirectory, + ); +}); + +test("local publication validation rejects cross-classifier contamination", (t) => { + const fixture = createFixture(t); + const artifactId = "copilot-sdk-java-runtime"; + const version = "1.2.3"; + const publicationDirectory = path.join( + fixture.root, + "repository", + "com", + "github", + artifactId, + version, + ); + fs.mkdirSync(publicationDirectory, { recursive: true }); + + writeStoredZip( + path.join(publicationDirectory, `${artifactId}-${version}.jar`), + [["META-INF/MANIFEST.MF", "Manifest-Version: 1.0\n"]], + ); + writeStoredZip( + path.join(publicationDirectory, `${artifactId}-${version}-sources.jar`), + [], + ); + writeStoredZip( + path.join(publicationDirectory, `${artifactId}-${version}-javadoc.jar`), + [], + ); + writeStoredZip( + path.join(publicationDirectory, `${artifactId}-${version}-linux-x64.jar`), + [ + ["native/linux-x64/runtime.node", "runtime"], + ["native/linux-x64/copilot", "cli"], + [ + "native/linux-x64/platform.properties", + "classifier=linux-x64\nversion=9.8.6\n", + ], + ["native/win32-x64/runtime.node", "wrong platform"], + ], + ); + createNativeClassifierTestFixture({ + classifier: "linux-arm64", + outputPath: path.join( + publicationDirectory, + `${artifactId}-${version}-linux-arm64.jar`, + ), + repoRoot: fixture.repoRoot, + }); + createNativeClassifierTestFixture({ + classifier: "win32-x64", + outputPath: path.join( + publicationDirectory, + `${artifactId}-${version}-win32-x64.jar`, + ), + repoRoot: fixture.repoRoot, + }); + createNativeClassifierTestFixture({ + classifier: "win32-arm64", + outputPath: path.join( + publicationDirectory, + `${artifactId}-${version}-win32-arm64.jar`, + ), + repoRoot: fixture.repoRoot, + }); + createNativeClassifierTestFixture({ + classifier: "darwin-arm64", + outputPath: path.join( + publicationDirectory, + `${artifactId}-${version}-darwin-arm64.jar`, + ), + repoRoot: fixture.repoRoot, + }); + fs.writeFileSync( + path.join(publicationDirectory, `${artifactId}-${version}.pom`), + "", + ); + + assert.throws( + () => + validateLocalPublication({ + artifactId, + repositoryPath: path.join(fixture.root, "repository"), + repoRoot: fixture.repoRoot, + requireSignatures: false, + version, + }), + /must not contain/, + ); +}); + +function createFixture(t) { + const fixtureParent = path.join( + moduleRoot, + "target", + "validate-native-artifact-test-", + ); + fs.mkdirSync(fixtureParent, { recursive: true }); + const root = fs.mkdtempSync(path.join(fixtureParent, `${process.pid}-`)); + t.after(() => + fs.rmSync(root, { + recursive: true, + force: true, + maxRetries: 3, + retryDelay: 100, + }), + ); + + const repoRoot = path.join(root, "repo"); + fs.mkdirSync(path.join(repoRoot, "nodejs"), { recursive: true }); + fs.writeFileSync( + path.join(repoRoot, "nodejs", "package-lock.json"), + JSON.stringify({ + packages: { + "node_modules/@github/copilot-win32-x64": { version: "9.8.7" }, + "node_modules/@github/copilot-win32-arm64": { version: "9.8.10" }, + "node_modules/@github/copilot-linux-x64": { version: "9.8.6" }, + "node_modules/@github/copilot-linux-arm64": { version: "9.8.9" }, + "node_modules/@github/copilot-darwin-arm64": { version: "9.8.8" }, + }, + }), + ); + + return { + root, + repoRoot, + jarPath: path.join(root, artifactName), + }; +} diff --git a/java/copilot-native/scripts/validate-native-host.mjs b/java/copilot-native/scripts/validate-native-host.mjs new file mode 100644 index 0000000000..a0b7a70047 --- /dev/null +++ b/java/copilot-native/scripts/validate-native-host.mjs @@ -0,0 +1,77 @@ +/*--------------------------------------------------------------------------------------------- + * Copyright (c) Microsoft Corporation. All rights reserved. + *--------------------------------------------------------------------------------------------*/ + +import { pathToFileURL } from "node:url"; + +export function validateNativeHost(classifier, host) { + if (classifier === "linux-x64" || classifier === "linux-arm64") { + const expectedArch = classifier === "linux-x64" ? "x64" : "arm64"; + const displayArch = expectedArch === "x64" ? "x64" : "ARM64"; + if (host.platform !== "linux" || host.arch !== expectedArch) { + throw new Error( + `Native ${classifier} packaging requires Linux ${displayArch}; detected ${host.platform}-${host.arch}`, + ); + } + if (!host.glibcVersionRuntime) { + throw new Error( + `Native ${classifier} packaging requires glibc; musl and unknown libc hosts are unsupported`, + ); + } + return `Validated native build host: ${classifier} (glibc ${host.glibcVersionRuntime})`; + } + + if (classifier === "win32-x64" || classifier === "win32-arm64") { + const expectedArch = classifier === "win32-x64" ? "x64" : "arm64"; + const displayArch = expectedArch === "x64" ? "x64" : "ARM64"; + if (host.platform !== "win32" || host.arch !== expectedArch) { + throw new Error( + `Native ${classifier} packaging requires Windows ${displayArch}; detected ${host.platform}-${host.arch}`, + ); + } + return `Validated native build host: ${classifier}`; + } + + if (classifier === "darwin-arm64") { + if (host.platform !== "darwin" || host.arch !== "arm64") { + throw new Error( + `Native ${classifier} packaging requires macOS ARM64; detected ${host.platform}-${host.arch}`, + ); + } + return `Validated native build host: ${classifier}`; + } + + throw new Error(`Unsupported native build classifier: ${classifier}`); +} + +export function detectNativeHost() { + const report = process.report?.getReport(); + return { + platform: process.platform, + arch: process.arch, + glibcVersionRuntime: report?.header?.glibcVersionRuntime, + }; +} + +function main() { + const [classifier] = process.argv.slice(2); + if (!classifier) { + console.error("Usage: node validate-native-host.mjs "); + process.exitCode = 1; + return; + } + + try { + console.log(validateNativeHost(classifier, detectNativeHost())); + } catch (error) { + console.error(error.message); + process.exitCode = 1; + } +} + +if ( + process.argv[1] && + import.meta.url === pathToFileURL(process.argv[1]).href +) { + main(); +} diff --git a/java/copilot-native/scripts/validate-native-host.test.mjs b/java/copilot-native/scripts/validate-native-host.test.mjs new file mode 100644 index 0000000000..cb3429489c --- /dev/null +++ b/java/copilot-native/scripts/validate-native-host.test.mjs @@ -0,0 +1,195 @@ +/*--------------------------------------------------------------------------------------------- + * Copyright (c) Microsoft Corporation. All rights reserved. + *--------------------------------------------------------------------------------------------*/ + +import assert from "node:assert/strict"; +import test from "node:test"; + +import { validateNativeHost } from "./validate-native-host.mjs"; + +test("accepts Linux x64 with glibc", () => { + assert.equal( + validateNativeHost("linux-x64", { + platform: "linux", + arch: "x64", + glibcVersionRuntime: "2.39", + }), + "Validated native build host: linux-x64 (glibc 2.39)", + ); +}); + +test("accepts Linux ARM64 with glibc", () => { + assert.equal( + validateNativeHost("linux-arm64", { + platform: "linux", + arch: "arm64", + glibcVersionRuntime: "2.39", + }), + "Validated native build host: linux-arm64 (glibc 2.39)", + ); +}); + +test("accepts Windows x64 without a libc requirement", () => { + assert.equal( + validateNativeHost("win32-x64", { + platform: "win32", + arch: "x64", + glibcVersionRuntime: undefined, + }), + "Validated native build host: win32-x64", + ); +}); + +test("accepts Windows ARM64 without a libc requirement", () => { + assert.equal( + validateNativeHost("win32-arm64", { + platform: "win32", + arch: "arm64", + glibcVersionRuntime: undefined, + }), + "Validated native build host: win32-arm64", + ); +}); + +test("accepts macOS ARM64 without a libc requirement", () => { + assert.equal( + validateNativeHost("darwin-arm64", { + platform: "darwin", + arch: "arm64", + glibcVersionRuntime: undefined, + }), + "Validated native build host: darwin-arm64", + ); +}); + +test("rejects Linux x64 with musl or unknown libc", () => { + assert.throws( + () => + validateNativeHost("linux-x64", { + platform: "linux", + arch: "x64", + glibcVersionRuntime: undefined, + }), + /requires glibc/, + ); +}); + +test("rejects Linux ARM64 with musl or unknown libc", () => { + assert.throws( + () => + validateNativeHost("linux-arm64", { + platform: "linux", + arch: "arm64", + glibcVersionRuntime: undefined, + }), + /requires glibc/, + ); +}); + +test("rejects a non-Linux host", () => { + assert.throws( + () => + validateNativeHost("linux-x64", { + platform: "darwin", + arch: "x64", + glibcVersionRuntime: undefined, + }), + /requires Linux x64/, + ); +}); + +test("rejects a non-x64 host", () => { + assert.throws( + () => + validateNativeHost("linux-x64", { + platform: "linux", + arch: "arm64", + glibcVersionRuntime: "2.39", + }), + /requires Linux x64/, + ); +}); + +test("rejects Linux x64 for the Linux ARM64 classifier", () => { + assert.throws( + () => + validateNativeHost("linux-arm64", { + platform: "linux", + arch: "x64", + glibcVersionRuntime: "2.39", + }), + /requires Linux ARM64/, + ); +}); + +test("rejects a non-Windows host for the Windows classifier", () => { + assert.throws( + () => + validateNativeHost("win32-x64", { + platform: "linux", + arch: "x64", + glibcVersionRuntime: "2.39", + }), + /requires Windows x64/, + ); +}); + +test("rejects Windows ARM64 for the Windows x64 classifier", () => { + assert.throws( + () => + validateNativeHost("win32-x64", { + platform: "win32", + arch: "arm64", + glibcVersionRuntime: undefined, + }), + /requires Windows x64/, + ); +}); + +test("rejects Windows x64 for the Windows ARM64 classifier", () => { + assert.throws( + () => + validateNativeHost("win32-arm64", { + platform: "win32", + arch: "x64", + glibcVersionRuntime: undefined, + }), + /requires Windows ARM64/, + ); +}); + +test("rejects a non-macOS host for the macOS classifier", () => { + assert.throws( + () => + validateNativeHost("darwin-arm64", { + platform: "linux", + arch: "arm64", + glibcVersionRuntime: "2.39", + }), + /requires macOS ARM64/, + ); +}); + +test("rejects macOS x64 for the macOS ARM64 classifier", () => { + assert.throws( + () => + validateNativeHost("darwin-arm64", { + platform: "darwin", + arch: "x64", + glibcVersionRuntime: undefined, + }), + /requires macOS ARM64/, + ); +}); + +test("rejects an unimplemented classifier", () => { + assert.throws( + () => + validateNativeHost("linuxmusl-x64", { + platform: "linux", + arch: "x64", + glibcVersionRuntime: undefined, + }), + /Unsupported native build classifier/, + ); +}); diff --git a/java/copilot-native/src/main/java/.gitkeep b/java/copilot-native/src/main/java/.gitkeep new file mode 100644 index 0000000000..e69de29bb2 diff --git a/java/copilot-native/src/main/javadoc/.gitkeep b/java/copilot-native/src/main/javadoc/.gitkeep new file mode 100644 index 0000000000..e69de29bb2 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 0000000000..0f32308984 --- /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-007-native-bundling-strategy.md b/java/docs/adr/adr-007-native-bundling-strategy.md index 1322e199ef..1540829366 100644 --- a/java/docs/adr/adr-007-native-bundling-strategy.md +++ b/java/docs/adr/adr-007-native-bundling-strategy.md @@ -1,85 +1,109 @@ -# ADR-007: Native runtime bundling strategy β€” per-platform classifier JARs +# ADR-007: Native runtime bundling strategy: per-platform classifier JARs -## Context and Problem Statement +## Context and problem statement -The Copilot SDK for Java currently has no embedded runtime. It depends on an externally provided runtime process (see epic [#1917](https://github.com/github/copilot-sdk/issues/1917)). The ongoing Rust port of the `copilot-agent-runtime` repository is reaching the point where the runtime can be consumed as a native shared library without requiring a Node.js process, making it practical to embed the runtime directly in the SDK JAR. +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 (current CLI path). -- **[C ABI](#references) front door** β€” a fixed set of approximately 12 `extern "C"` lifecycle and transport entry points (`copilot_runtime_server_create`, `copilot_runtime_connection_open`, etc.) that any language can call in-process via [FFI](#references) ([JNA](#references) for Java, Python/cffi, C#/`DllImport`, Go/purego) **without a Node.js process**. All API methods travel as JSON-RPC data through this fixed transport; the export list never changes as the method set grows. +* **[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-07, 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 in the runtime currently spawns a short-lived child process to service method bodies not yet ported to Rust. This internal Node.js dependency shrinks with each port PR and is expected to disappear entirely when the migration completes. The C ABI surface and loading mechanism described in this ADR are stable regardless of migration progress. +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`) | +| 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 is 100% deterministic +### Platform selection -The correct binary can be selected at runtime without any heuristics, using only standard Java and OS APIs: +The loader selects a classifier at runtime using standard Java and OS APIs: -1. **OS**: `System.getProperty("os.name")` β€” distinguishes Windows, macOS, and Linux unambiguously. -2. **Architecture**: `System.getProperty("os.arch")` β€” `"amd64"` and `"x86_64"` both map to `x64`; `"aarch64"` and `"arm64"` both map to `arm64`. -3. **Linux libc variant**: Read the first 2 KB of `/proc/self/exe` and parse the [ELF](#references) PT_INTERP segment (the dynamic linker path). If the interpreter path contains `/ld-musl-` β†’ musl; if it contains `/ld-linux-` β†’ glibc. This requires no subprocess, no PATH lookup, and works inside containers. This is the same approach used by the `detect-libc` npm package (its primary, most reliable detection method). +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 | +| 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. -The published Java SDK JAR (`copilot-sdk-java-1.0.6-preview.1.jar`) is currently **1.53 MB**. A 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 +## Considered options -### Option 1: Monolithic JAR β€” all platform binaries in one artifact +### Option 1: Monolithic JAR with all platform binaries -All 6 (or 8) `runtime.node` binaries are bundled inside the single `copilot-sdk-java` artifact. At runtime the SDK extracts and loads the one matching the current platform; the remaining 5–7 are carried silently. +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 ([DJL](#references) style) +### 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: @@ -94,7 +118,7 @@ com.github:copilot-sdk-java-runtime:VERSION:win32-x64 com.github:copilot-sdk-java-runtime:VERSION:win32-arm64 ``` -Each classifier JAR contains only the `runtime.node` binary for that platform (~19–26 MB compressed) plus a small `.properties` metadata file. The coordination artifact selects and loads the matching native at startup. +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. @@ -105,39 +129,43 @@ Build tools can be configured to resolve the correct classifier automatically: - **Uber-jar builds**: include all classifiers; the coordination artifact picks the right one at runtime. **Advantages:** -- Default download is the tiny coordination artifact (~1.5 MB) plus one platform JAR (~20–26 MB compressed) β€” approximately **22–28 MB total** vs. 132–180 MB for a monolithic JAR. + +* 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 (DJL thin placeholder style) +### 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 +## Decision outcome -**Chosen: Option 2 β€” per-platform classifier JARs and Option 1 - monolithic jar. Use `maven-assembly-plugin` to allow the creation of the monolithic jar.** +**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 makes their download approximately 22–28 MB (coordination JAR + one platform JAR), versus 132–180 MB for Option 1 and an unbounded deferred network cost for Option 3. +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. @@ -145,15 +173,48 @@ The SDK ships a minimal placeholder that detects the current platform at runtime 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. **Size per platform is acceptable.** At ~20–26 MB compressed per platform, each classifier JAR is well within the range of routinely used native JARs in the Java ecosystem (DJL PyTorch osx-aarch64: 37 MB; ONNX Runtime per platform: ~20–30 MB before bundling). +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 section [How can we do Option 2 and Option 1](#how-can-we-do-option-2-and-option-1) for more details. +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 Maven build binds native packaging only for a host matching an implemented classifier. Linux x64 and ARM64 glibc hosts can opt in with `copilot.native.libc=glibc`, while Windows x64, Windows ARM64, and Apple Silicon macOS hosts package `win32-x64`, `win32-arm64`, or `darwin-arm64` automatically. The `inprocess` test profile selects the matching implemented classifier automatically on all five hosts. Every path validates the host before downloading or packaging native files. Linux musl and other unsupported hosts build only the OS-neutral placeholder, sources, and Javadoc artifacts unless they explicitly request in-process tests, which fail during host validation. Additional classifier artifacts remain follow-up work. + +Maven Central release and snapshot workflows build each classifier on its matching native host from the same immutable source. The Linux ARM64, Windows x64, Windows ARM64, and macOS jobs each upload only their verified classifier and checksum manifest. The Ubuntu x64 job verifies and attaches all four, builds `linux-x64` with the glibc opt-in, and performs the only Maven deployment. Release signing therefore covers the neutral artifacts and all five classifiers in one deployment. ## 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)). +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: @@ -161,7 +222,7 @@ A secondary decision within the scope of this ADR is *how* the coordination arti 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 ~12 entry points carrying JSON-RPC strings; JSON serialization/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. +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. @@ -171,110 +232,74 @@ A secondary decision within the scope of this ADR is *how* the coordination arti ### 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 ~12-function stable C ABI makes a future migration inexpensive. To keep that path open at low cost: +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 can we do Option 2 and Option 1 +## How to support classifier and monolithic JARs -## How it works: classpath resource convention + platform detection +### Classpath resource convention and platform detection -### 1. Each classifier JAR uses a well-known resource path +#### Each classifier JAR uses a well-known resource path -Each per-platform JAR (`copilot-sdk-java-runtime:VERSION:darwin-arm64`, etc.) places its binary under a deterministic path inside the JAR: +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 ``` -When `maven-assembly-plugin` creates the uber-jar, it unpacks all dependencies and merges them. The resulting uber-jar contains: +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 ``` -### 2. The coordination artifact selects at runtime via `getResourceAsStream` +#### The coordination artifact selects at runtime through the classloader -```java -public class NativeRuntimeLoader { - - public Path loadRuntime() { - String classifier = detectPlatformClassifier(); - String resourcePath = "native/" + classifier + "/runtime.node"; - - try (InputStream in = getClass().getClassLoader() - .getResourceAsStream(resourcePath)) { - if (in == null) { - throw new UnsupportedOperationException( - "No native runtime for platform: " + classifier); - } - Path cached = getCachePath(classifier); - if (!Files.exists(cached)) { - Files.createDirectories(cached.getParent()); - Files.copy(in, cached); - // Make executable on Unix - cached.toFile().setExecutable(true); - } - return cached; - } - } - - private String detectPlatformClassifier() { - String os = normalizeOs(System.getProperty("os.name")); - String arch = normalizeArch(System.getProperty("os.arch")); - String libc = "linux".equals(os) ? detectLinuxLibc() : ""; - - // Produces: "linux-x64", "linuxmusl-arm64", "darwin-arm64", "win32-x64", etc. - return (libc.isEmpty() ? os : os + libc) + "-" + arch; - } - - private String detectLinuxLibc() { - // Read ELF PT_INTERP from /proc/self/exe - // If interpreter contains "/ld-musl-" β†’ "musl" - // Otherwise β†’ "" (glibc is the default/unmarked case for "linux-") - // ... - } - - private Path getCachePath(String classifier) { - String version = getClass().getPackage().getImplementationVersion(); - return Path.of(System.getProperty("user.home"), - ".copilot", "runtime-cache", version, classifier, "runtime.node"); - } -} -``` +`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. -### 3. JNA loads from the extracted path +#### JNA loads from the extracted path Once extracted to a known filesystem path, JNA loads it directly: ```java -NativeLibrary lib = NativeLibrary.getInstance(extractedPath.toString()); -// Or via a mapped interface: -CopilotRuntime runtime = Native.load(extractedPath.toString(), CopilotRuntime.class); +CopilotRuntimeLibrary runtime = + Native.load(extractedPath.toString(), CopilotRuntimeLibrary.class); ``` -### Key insight: the same code works in both modes +#### The same code works in both modes -The beauty is that `getResourceAsStream("native/darwin-arm64/runtime.node")` works identically whether: +Classloader resource lookup works identically whether: -- The native lives in a **separate classifier JAR** on the classpath (normal dev dependency), OR -- It's been **merged into an uber-jar** by `maven-assembly-plugin` +* 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 doesn't care which JAR file the resource came from β€” it searches the entire classpath. This means **zero code changes** between the two consumption models. +The classloader searches the entire classpath, so the Java loading code does not change between the two consumption models. ---- - -## Assembly plugin configuration (consumer-side) +### Consumer-side assembly plugin configuration A consumer building a portable uber-jar would configure: @@ -298,7 +323,7 @@ With all classifier JARs declared as dependencies: copilot-sdk-java ${copilot.version} - + com.github copilot-sdk-java-runtime @@ -311,66 +336,64 @@ With all classifier JARs declared as dependencies: ${copilot.version} darwin-arm64 - + ``` ---- - -## Why this works cleanly +### 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 | Same `getResourceAsStream` call β€” classloader finds it in the separate JAR | -| Subset selection | Consumer declares only the classifiers they need; missing platforms get a clear error at runtime | -| JNA loading | `NativeLibrary.getInstance(path)` loads from an absolute filesystem path after extraction β€” no JNA platform-detection magic needed | - -The pattern is identical to how DJL's `LibUtils.loadLibrary()` works β€” detect platform, construct resource path, extract if needed, load via absolute path. +| 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 -- A new Maven module (`copilot-sdk-java-runtime` or similar) is introduced to hold the per-platform native JARs. The existing `copilot-sdk-java` coordination artifact depends on it. -- The coordination artifact gains a platform detection and native loading component that: +* 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 the binary to a temporary or cached location (e.g., `~/.copilot/runtime-cache/`) if not already present. + 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 release pipeline for `github/copilot-agent-runtime` must produce the per-platform `runtime.node` binaries as inputs to the Java SDK publish workflow. The per-platform `pkg-tarballs-` artifacts from the `publish-cli.yml` workflow are the authoritative source. -- Each release of `copilot-sdk-java` publishes 6 (or 8) classifier JARs to Maven Central alongside the coordination JAR. -- The version of the bundled `runtime.node` is recorded in the coordination JAR's manifest and queryable at runtime, enabling diagnostics and mismatch detection. -- `cli-native.node` is not bundled. It provides only terminal UI features (ICU4X text segmentation, Win32 APIs, OS desktop notifications) that are irrelevant to the Java SDK's programmatic API surface. +* A validated supported-host profile fetches the pinned matching `@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`, `linux-arm64`, `win32-x64`, `win32-arm64`, and `darwin-arm64` classifiers. The planned classifier set expands to the other detected platforms. +* Adding an implemented platform requires validated host activation, a profile that supplies the classifier and platform CLI filename, and lifecycle bindings for the shared host validation, fetch, script test, package, and verification executions. +* `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: Embed Rust-based Copilot CLI Runtime and cease requiring Node.js -- https://devdiv.visualstudio.com/DevDiv/_workitems/edit/3028097 -- https://github.com/github/copilot-sdk/pull/1901 dotnet: in-process FFI runtime hosting (InProcess transport) -- https://github.com/github/copilot-sdk/pull/1915 Add in-process FFI transport for Rust and TypeScript SDKs +* 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/ | +| 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: @@ -381,4 +404,3 @@ Additional source references: - `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.cmd b/java/mvnw.cmd index 92450f9327..5761d94892 100644 --- a/java/mvnw.cmd +++ b/java/mvnw.cmd @@ -1,189 +1,189 @@ -<# : batch portion -@REM ---------------------------------------------------------------------------- -@REM Licensed to the Apache Software Foundation (ASF) under one -@REM or more contributor license agreements. See the NOTICE file -@REM distributed with this work for additional information -@REM regarding copyright ownership. The ASF licenses this file -@REM to you under the Apache License, Version 2.0 (the -@REM "License"); you may not use this file except in compliance -@REM with the License. You may obtain a copy of the License at -@REM -@REM http://www.apache.org/licenses/LICENSE-2.0 -@REM -@REM Unless required by applicable law or agreed to in writing, -@REM software distributed under the License is distributed on an -@REM "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY -@REM KIND, either express or implied. See the License for the -@REM specific language governing permissions and limitations -@REM under the License. -@REM ---------------------------------------------------------------------------- - -@REM ---------------------------------------------------------------------------- -@REM Apache Maven Wrapper startup batch script, version 3.3.4 -@REM -@REM Optional ENV vars -@REM MVNW_REPOURL - repo url base for downloading maven distribution -@REM MVNW_USERNAME/MVNW_PASSWORD - user and password for downloading maven -@REM MVNW_VERBOSE - true: enable verbose log; others: silence the output -@REM ---------------------------------------------------------------------------- - -@IF "%__MVNW_ARG0_NAME__%"=="" (SET __MVNW_ARG0_NAME__=%~nx0) -@SET __MVNW_CMD__= -@SET __MVNW_ERROR__= -@SET __MVNW_PSMODULEP_SAVE=%PSModulePath% -@SET PSModulePath= -@FOR /F "usebackq tokens=1* delims==" %%A IN (`powershell -noprofile "& {$scriptDir='%~dp0'; $script='%__MVNW_ARG0_NAME__%'; icm -ScriptBlock ([Scriptblock]::Create((Get-Content -Raw '%~f0'))) -NoNewScope}"`) DO @( - IF "%%A"=="MVN_CMD" (set __MVNW_CMD__=%%B) ELSE IF "%%B"=="" (echo %%A) ELSE (echo %%A=%%B) -) -@SET PSModulePath=%__MVNW_PSMODULEP_SAVE% -@SET __MVNW_PSMODULEP_SAVE= -@SET __MVNW_ARG0_NAME__= -@SET MVNW_USERNAME= -@SET MVNW_PASSWORD= -@IF NOT "%__MVNW_CMD__%"=="" ("%__MVNW_CMD__%" %*) -@echo Cannot start maven from wrapper >&2 && exit /b 1 -@GOTO :EOF -: end batch / begin powershell #> - -$ErrorActionPreference = "Stop" -if ($env:MVNW_VERBOSE -eq "true") { - $VerbosePreference = "Continue" -} - -# calculate distributionUrl, requires .mvn/wrapper/maven-wrapper.properties -$distributionUrl = (Get-Content -Raw "$scriptDir/.mvn/wrapper/maven-wrapper.properties" | ConvertFrom-StringData).distributionUrl -if (!$distributionUrl) { - Write-Error "cannot read distributionUrl property in $scriptDir/.mvn/wrapper/maven-wrapper.properties" -} - -switch -wildcard -casesensitive ( $($distributionUrl -replace '^.*/','') ) { - "maven-mvnd-*" { - $USE_MVND = $true - $distributionUrl = $distributionUrl -replace '-bin\.[^.]*$',"-windows-amd64.zip" - $MVN_CMD = "mvnd.cmd" - break - } - default { - $USE_MVND = $false - $MVN_CMD = $script -replace '^mvnw','mvn' - break - } -} - -# apply MVNW_REPOURL and calculate MAVEN_HOME -# maven home pattern: ~/.m2/wrapper/dists/{apache-maven-,maven-mvnd--}/ -if ($env:MVNW_REPOURL) { - $MVNW_REPO_PATTERN = if ($USE_MVND -eq $False) { "/org/apache/maven/" } else { "/maven/mvnd/" } - $distributionUrl = "$env:MVNW_REPOURL$MVNW_REPO_PATTERN$($distributionUrl -replace "^.*$MVNW_REPO_PATTERN",'')" -} -$distributionUrlName = $distributionUrl -replace '^.*/','' -$distributionUrlNameMain = $distributionUrlName -replace '\.[^.]*$','' -replace '-bin$','' - -$MAVEN_M2_PATH = "$HOME/.m2" -if ($env:MAVEN_USER_HOME) { - $MAVEN_M2_PATH = "$env:MAVEN_USER_HOME" -} - -if (-not (Test-Path -Path $MAVEN_M2_PATH)) { - New-Item -Path $MAVEN_M2_PATH -ItemType Directory | Out-Null -} - -$MAVEN_WRAPPER_DISTS = $null -if ((Get-Item $MAVEN_M2_PATH).Target[0] -eq $null) { - $MAVEN_WRAPPER_DISTS = "$MAVEN_M2_PATH/wrapper/dists" -} else { - $MAVEN_WRAPPER_DISTS = (Get-Item $MAVEN_M2_PATH).Target[0] + "/wrapper/dists" -} - -$MAVEN_HOME_PARENT = "$MAVEN_WRAPPER_DISTS/$distributionUrlNameMain" -$MAVEN_HOME_NAME = ([System.Security.Cryptography.SHA256]::Create().ComputeHash([byte[]][char[]]$distributionUrl) | ForEach-Object {$_.ToString("x2")}) -join '' -$MAVEN_HOME = "$MAVEN_HOME_PARENT/$MAVEN_HOME_NAME" - -if (Test-Path -Path "$MAVEN_HOME" -PathType Container) { - Write-Verbose "found existing MAVEN_HOME at $MAVEN_HOME" - Write-Output "MVN_CMD=$MAVEN_HOME/bin/$MVN_CMD" - exit $? -} - -if (! $distributionUrlNameMain -or ($distributionUrlName -eq $distributionUrlNameMain)) { - Write-Error "distributionUrl is not valid, must end with *-bin.zip, but found $distributionUrl" -} - -# prepare tmp dir -$TMP_DOWNLOAD_DIR_HOLDER = New-TemporaryFile -$TMP_DOWNLOAD_DIR = New-Item -Itemtype Directory -Path "$TMP_DOWNLOAD_DIR_HOLDER.dir" -$TMP_DOWNLOAD_DIR_HOLDER.Delete() | Out-Null -trap { - if ($TMP_DOWNLOAD_DIR.Exists) { - try { Remove-Item $TMP_DOWNLOAD_DIR -Recurse -Force | Out-Null } - catch { Write-Warning "Cannot remove $TMP_DOWNLOAD_DIR" } - } -} - -New-Item -Itemtype Directory -Path "$MAVEN_HOME_PARENT" -Force | Out-Null - -# Download and Install Apache Maven -Write-Verbose "Couldn't find MAVEN_HOME, downloading and installing it ..." -Write-Verbose "Downloading from: $distributionUrl" -Write-Verbose "Downloading to: $TMP_DOWNLOAD_DIR/$distributionUrlName" - -$webclient = New-Object System.Net.WebClient -if ($env:MVNW_USERNAME -and $env:MVNW_PASSWORD) { - $webclient.Credentials = New-Object System.Net.NetworkCredential($env:MVNW_USERNAME, $env:MVNW_PASSWORD) -} -[Net.ServicePointManager]::SecurityProtocol = [Net.SecurityProtocolType]::Tls12 -$webclient.DownloadFile($distributionUrl, "$TMP_DOWNLOAD_DIR/$distributionUrlName") | Out-Null - -# If specified, validate the SHA-256 sum of the Maven distribution zip file -$distributionSha256Sum = (Get-Content -Raw "$scriptDir/.mvn/wrapper/maven-wrapper.properties" | ConvertFrom-StringData).distributionSha256Sum -if ($distributionSha256Sum) { - if ($USE_MVND) { - Write-Error "Checksum validation is not supported for maven-mvnd. `nPlease disable validation by removing 'distributionSha256Sum' from your maven-wrapper.properties." - } - Import-Module $PSHOME\Modules\Microsoft.PowerShell.Utility -Function Get-FileHash - if ((Get-FileHash "$TMP_DOWNLOAD_DIR/$distributionUrlName" -Algorithm SHA256).Hash.ToLower() -ne $distributionSha256Sum) { - Write-Error "Error: Failed to validate Maven distribution SHA-256, your Maven distribution might be compromised. If you updated your Maven version, you need to update the specified distributionSha256Sum property." - } -} - -# unzip and move -Expand-Archive "$TMP_DOWNLOAD_DIR/$distributionUrlName" -DestinationPath "$TMP_DOWNLOAD_DIR" | Out-Null - -# Find the actual extracted directory name (handles snapshots where filename != directory name) -$actualDistributionDir = "" - -# First try the expected directory name (for regular distributions) -$expectedPath = Join-Path "$TMP_DOWNLOAD_DIR" "$distributionUrlNameMain" -$expectedMvnPath = Join-Path "$expectedPath" "bin/$MVN_CMD" -if ((Test-Path -Path $expectedPath -PathType Container) -and (Test-Path -Path $expectedMvnPath -PathType Leaf)) { - $actualDistributionDir = $distributionUrlNameMain -} - -# If not found, search for any directory with the Maven executable (for snapshots) -if (!$actualDistributionDir) { - Get-ChildItem -Path "$TMP_DOWNLOAD_DIR" -Directory | ForEach-Object { - $testPath = Join-Path $_.FullName "bin/$MVN_CMD" - if (Test-Path -Path $testPath -PathType Leaf) { - $actualDistributionDir = $_.Name - } - } -} - -if (!$actualDistributionDir) { - Write-Error "Could not find Maven distribution directory in extracted archive" -} - -Write-Verbose "Found extracted Maven distribution directory: $actualDistributionDir" -Rename-Item -Path "$TMP_DOWNLOAD_DIR/$actualDistributionDir" -NewName $MAVEN_HOME_NAME | Out-Null -try { - Move-Item -Path "$TMP_DOWNLOAD_DIR/$MAVEN_HOME_NAME" -Destination $MAVEN_HOME_PARENT | Out-Null -} catch { - if (! (Test-Path -Path "$MAVEN_HOME" -PathType Container)) { - Write-Error "fail to move MAVEN_HOME" - } -} finally { - try { Remove-Item $TMP_DOWNLOAD_DIR -Recurse -Force | Out-Null } - catch { Write-Warning "Cannot remove $TMP_DOWNLOAD_DIR" } -} - -Write-Output "MVN_CMD=$MAVEN_HOME/bin/$MVN_CMD" +<# : batch portion +@REM ---------------------------------------------------------------------------- +@REM Licensed to the Apache Software Foundation (ASF) under one +@REM or more contributor license agreements. See the NOTICE file +@REM distributed with this work for additional information +@REM regarding copyright ownership. The ASF licenses this file +@REM to you under the Apache License, Version 2.0 (the +@REM "License"); you may not use this file except in compliance +@REM with the License. You may obtain a copy of the License at +@REM +@REM http://www.apache.org/licenses/LICENSE-2.0 +@REM +@REM Unless required by applicable law or agreed to in writing, +@REM software distributed under the License is distributed on an +@REM "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY +@REM KIND, either express or implied. See the License for the +@REM specific language governing permissions and limitations +@REM under the License. +@REM ---------------------------------------------------------------------------- + +@REM ---------------------------------------------------------------------------- +@REM Apache Maven Wrapper startup batch script, version 3.3.4 +@REM +@REM Optional ENV vars +@REM MVNW_REPOURL - repo url base for downloading maven distribution +@REM MVNW_USERNAME/MVNW_PASSWORD - user and password for downloading maven +@REM MVNW_VERBOSE - true: enable verbose log; others: silence the output +@REM ---------------------------------------------------------------------------- + +@IF "%__MVNW_ARG0_NAME__%"=="" (SET __MVNW_ARG0_NAME__=%~nx0) +@SET __MVNW_CMD__= +@SET __MVNW_ERROR__= +@SET __MVNW_PSMODULEP_SAVE=%PSModulePath% +@SET PSModulePath= +@FOR /F "usebackq tokens=1* delims==" %%A IN (`powershell -noprofile "& {$scriptDir='%~dp0'; $script='%__MVNW_ARG0_NAME__%'; icm -ScriptBlock ([Scriptblock]::Create((Get-Content -Raw '%~f0'))) -NoNewScope}"`) DO @( + IF "%%A"=="MVN_CMD" (set __MVNW_CMD__=%%B) ELSE IF "%%B"=="" (echo %%A) ELSE (echo %%A=%%B) +) +@SET PSModulePath=%__MVNW_PSMODULEP_SAVE% +@SET __MVNW_PSMODULEP_SAVE= +@SET __MVNW_ARG0_NAME__= +@SET MVNW_USERNAME= +@SET MVNW_PASSWORD= +@IF NOT "%__MVNW_CMD__%"=="" ("%__MVNW_CMD__%" %*) +@echo Cannot start maven from wrapper >&2 && exit /b 1 +@GOTO :EOF +: end batch / begin powershell #> + +$ErrorActionPreference = "Stop" +if ($env:MVNW_VERBOSE -eq "true") { + $VerbosePreference = "Continue" +} + +# calculate distributionUrl, requires .mvn/wrapper/maven-wrapper.properties +$distributionUrl = (Get-Content -Raw "$scriptDir/.mvn/wrapper/maven-wrapper.properties" | ConvertFrom-StringData).distributionUrl +if (!$distributionUrl) { + Write-Error "cannot read distributionUrl property in $scriptDir/.mvn/wrapper/maven-wrapper.properties" +} + +switch -wildcard -casesensitive ( $($distributionUrl -replace '^.*/','') ) { + "maven-mvnd-*" { + $USE_MVND = $true + $distributionUrl = $distributionUrl -replace '-bin\.[^.]*$',"-windows-amd64.zip" + $MVN_CMD = "mvnd.cmd" + break + } + default { + $USE_MVND = $false + $MVN_CMD = $script -replace '^mvnw','mvn' + break + } +} + +# apply MVNW_REPOURL and calculate MAVEN_HOME +# maven home pattern: ~/.m2/wrapper/dists/{apache-maven-,maven-mvnd--}/ +if ($env:MVNW_REPOURL) { + $MVNW_REPO_PATTERN = if ($USE_MVND -eq $False) { "/org/apache/maven/" } else { "/maven/mvnd/" } + $distributionUrl = "$env:MVNW_REPOURL$MVNW_REPO_PATTERN$($distributionUrl -replace "^.*$MVNW_REPO_PATTERN",'')" +} +$distributionUrlName = $distributionUrl -replace '^.*/','' +$distributionUrlNameMain = $distributionUrlName -replace '\.[^.]*$','' -replace '-bin$','' + +$MAVEN_M2_PATH = "$HOME/.m2" +if ($env:MAVEN_USER_HOME) { + $MAVEN_M2_PATH = "$env:MAVEN_USER_HOME" +} + +if (-not (Test-Path -Path $MAVEN_M2_PATH)) { + New-Item -Path $MAVEN_M2_PATH -ItemType Directory | Out-Null +} + +$MAVEN_WRAPPER_DISTS = $null +if ((Get-Item $MAVEN_M2_PATH).Target[0] -eq $null) { + $MAVEN_WRAPPER_DISTS = "$MAVEN_M2_PATH/wrapper/dists" +} else { + $MAVEN_WRAPPER_DISTS = (Get-Item $MAVEN_M2_PATH).Target[0] + "/wrapper/dists" +} + +$MAVEN_HOME_PARENT = "$MAVEN_WRAPPER_DISTS/$distributionUrlNameMain" +$MAVEN_HOME_NAME = ([System.Security.Cryptography.SHA256]::Create().ComputeHash([byte[]][char[]]$distributionUrl) | ForEach-Object {$_.ToString("x2")}) -join '' +$MAVEN_HOME = "$MAVEN_HOME_PARENT/$MAVEN_HOME_NAME" + +if (Test-Path -Path "$MAVEN_HOME" -PathType Container) { + Write-Verbose "found existing MAVEN_HOME at $MAVEN_HOME" + Write-Output "MVN_CMD=$MAVEN_HOME/bin/$MVN_CMD" + exit $? +} + +if (! $distributionUrlNameMain -or ($distributionUrlName -eq $distributionUrlNameMain)) { + Write-Error "distributionUrl is not valid, must end with *-bin.zip, but found $distributionUrl" +} + +# prepare tmp dir +$TMP_DOWNLOAD_DIR_HOLDER = New-TemporaryFile +$TMP_DOWNLOAD_DIR = New-Item -Itemtype Directory -Path "$TMP_DOWNLOAD_DIR_HOLDER.dir" +$TMP_DOWNLOAD_DIR_HOLDER.Delete() | Out-Null +trap { + if ($TMP_DOWNLOAD_DIR.Exists) { + try { Remove-Item $TMP_DOWNLOAD_DIR -Recurse -Force | Out-Null } + catch { Write-Warning "Cannot remove $TMP_DOWNLOAD_DIR" } + } +} + +New-Item -Itemtype Directory -Path "$MAVEN_HOME_PARENT" -Force | Out-Null + +# Download and Install Apache Maven +Write-Verbose "Couldn't find MAVEN_HOME, downloading and installing it ..." +Write-Verbose "Downloading from: $distributionUrl" +Write-Verbose "Downloading to: $TMP_DOWNLOAD_DIR/$distributionUrlName" + +$webclient = New-Object System.Net.WebClient +if ($env:MVNW_USERNAME -and $env:MVNW_PASSWORD) { + $webclient.Credentials = New-Object System.Net.NetworkCredential($env:MVNW_USERNAME, $env:MVNW_PASSWORD) +} +[Net.ServicePointManager]::SecurityProtocol = [Net.SecurityProtocolType]::Tls12 +$webclient.DownloadFile($distributionUrl, "$TMP_DOWNLOAD_DIR/$distributionUrlName") | Out-Null + +# If specified, validate the SHA-256 sum of the Maven distribution zip file +$distributionSha256Sum = (Get-Content -Raw "$scriptDir/.mvn/wrapper/maven-wrapper.properties" | ConvertFrom-StringData).distributionSha256Sum +if ($distributionSha256Sum) { + if ($USE_MVND) { + Write-Error "Checksum validation is not supported for maven-mvnd. `nPlease disable validation by removing 'distributionSha256Sum' from your maven-wrapper.properties." + } + Import-Module $PSHOME\Modules\Microsoft.PowerShell.Utility -Function Get-FileHash + if ((Get-FileHash "$TMP_DOWNLOAD_DIR/$distributionUrlName" -Algorithm SHA256).Hash.ToLower() -ne $distributionSha256Sum) { + Write-Error "Error: Failed to validate Maven distribution SHA-256, your Maven distribution might be compromised. If you updated your Maven version, you need to update the specified distributionSha256Sum property." + } +} + +# unzip and move +Expand-Archive "$TMP_DOWNLOAD_DIR/$distributionUrlName" -DestinationPath "$TMP_DOWNLOAD_DIR" | Out-Null + +# Find the actual extracted directory name (handles snapshots where filename != directory name) +$actualDistributionDir = "" + +# First try the expected directory name (for regular distributions) +$expectedPath = Join-Path "$TMP_DOWNLOAD_DIR" "$distributionUrlNameMain" +$expectedMvnPath = Join-Path "$expectedPath" "bin/$MVN_CMD" +if ((Test-Path -Path $expectedPath -PathType Container) -and (Test-Path -Path $expectedMvnPath -PathType Leaf)) { + $actualDistributionDir = $distributionUrlNameMain +} + +# If not found, search for any directory with the Maven executable (for snapshots) +if (!$actualDistributionDir) { + Get-ChildItem -Path "$TMP_DOWNLOAD_DIR" -Directory | ForEach-Object { + $testPath = Join-Path $_.FullName "bin/$MVN_CMD" + if (Test-Path -Path $testPath -PathType Leaf) { + $actualDistributionDir = $_.Name + } + } +} + +if (!$actualDistributionDir) { + Write-Error "Could not find Maven distribution directory in extracted archive" +} + +Write-Verbose "Found extracted Maven distribution directory: $actualDistributionDir" +Rename-Item -Path "$TMP_DOWNLOAD_DIR/$actualDistributionDir" -NewName $MAVEN_HOME_NAME | Out-Null +try { + Move-Item -Path "$TMP_DOWNLOAD_DIR/$MAVEN_HOME_NAME" -Destination $MAVEN_HOME_PARENT | Out-Null +} catch { + if (! (Test-Path -Path "$MAVEN_HOME" -PathType Container)) { + Write-Error "fail to move MAVEN_HOME" + } +} finally { + try { Remove-Item $TMP_DOWNLOAD_DIR -Recurse -Force | Out-Null } + catch { Write-Warning "Cannot remove $TMP_DOWNLOAD_DIR" } +} + +Write-Output "MVN_CMD=$MAVEN_HOME/bin/$MVN_CMD" diff --git a/java/pom.xml b/java/pom.xml index 5016a34b9d..3e5e1645a5 100644 --- a/java/pom.xml +++ b/java/pom.xml @@ -6,12 +6,12 @@ 4.0.0 com.github - copilot-sdk-java - 1.0.9-SNAPSHOT - jar + copilot-sdk-java-parent + 1.0.14-preview.2-SNAPSHOT + pom - GitHub Copilot SDK :: Java - Official 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 @@ -36,50 +36,25 @@ HEAD - - - central - https://central.sonatype.com/repository/maven-snapshots/ - - + + sdk + copilot-native + + + 17 UTF-8 ${project.basedir}/.. - ${copilot.sdk.root}/test - - ${copilot.sdk.root}/nodejs/node_modules/@github/copilot/npm-loader.js - - false - - ${skip.test.harness} - - notice - - - ^1.0.73 - + ^1.0.82-0 + + true - - - - com.fasterxml.jackson.core - jackson-databind - 2.22.0 - - - com.fasterxml.jackson.core - jackson-annotations - 2.22 - - - com.fasterxml.jackson.datatype - jackson-datatype-jsr310 - 2.22.0 - - - - - com.github.spotbugs - spotbugs-annotations - 4.10.2 - 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 @@ -146,521 +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.3.1 + + + org.apache.maven.plugins + maven-checkstyle-plugin + 3.6.0 + com.github.spotbugs spotbugs-maven-plugin - 4.10.2.0 + 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.8.0 - config/spotbugs/spotbugs-exclude.xml + ossrh + + + flatten + process-resources + + flatten + + + + flatten-clean + clean + + clean + + + - - org.apache.maven.plugins - maven-clean-plugin - 3.5.0 - - - org.apache.maven.plugins - maven-compiler-plugin - 3.15.0 - - - -Acopilot.experimental.allowed=true - - none - - - - org.apache.maven.plugins - maven-jar-plugin - 3.5.0 - - - org.apache.maven.plugins - maven-antrun-plugin - 3.2.0 - - - print-test-jdk-banner - process-test-classes - - run - - - - - - - - - - org.codehaus.mojo - exec-maven-plugin - 3.6.3 - - - install-harness-dependencies - generate-test-resources - - exec - - - ${skip.test.harness} - npm - ${copilot.sdk.root}/test/harness - - ci - --loglevel - ${npm.loglevel} - - - - - - install-nodejs-cli-dependencies - generate-test-resources - - exec - - - ${skip.cli.install} - npm - ${copilot.sdk.root}/nodejs - - ci - --ignore-scripts - --loglevel - ${npm.loglevel} - - - - - - - - org.apache.maven.plugins - maven-failsafe-plugin - 3.5.6 - - - - integration-test - verify - - - - - - ${project.build.directory} - ${project.build.finalName} - ${project.build.testOutputDirectory} - - - - ${copilot.cli.path} - - - - - org.apache.maven.plugins - maven-surefire-plugin - 3.5.6 - - alphabetical - - ${testExecutionAgentArgs} ${surefire.jvm.args} - - 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 - 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.15 - - - - 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.6.3 - - - 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 @@ -668,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 @@ -693,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 @@ -707,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 f0c083c6b9..785049afa1 100644 --- a/java/scripts/codegen/java.ts +++ b/java/scripts/codegen/java.ts @@ -4,7 +4,7 @@ /** * 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"; @@ -66,6 +66,24 @@ function normalizeBrandCasingNode(node: unknown): void { if (node === null || typeof node !== "object") return; const obj = node as Record; + if (obj.title === "ProviderModelConfig" && obj.properties && typeof obj.properties === "object") { + const tokenFields = new Set([ + "maxPromptTokens", + "maxContextWindowTokens", + "maxOutputTokens", + ]); + for (const [key, value] of Object.entries(obj.properties as Record)) { + if ( + tokenFields.has(key) && + value !== null && + typeof value === "object" && + (value as Record).type === "number" + ) { + (value as Record).type = "integer"; + } + } + } + for (const defsKey of ["definitions", "$defs"] as const) { const defs = obj[defsKey]; if (defs && typeof defs === "object" && !Array.isArray(defs)) { @@ -149,7 +167,9 @@ function toCamelCase(name: string): string { } function toEnumConstant(value: string): string { - return value.toUpperCase().replace(/[-. /:]/g, "_").replace(/^_+/, "").replace(/_+/g, "_"); + const constant = value.toUpperCase().replace(/[^A-Z0-9]/g, "_").replace(/^_+/, "").replace(/_+/g, "_"); + if (constant.length === 0) return "_"; + return /^[0-9]/.test(constant) ? `_${constant}` : constant; } // ── Schema path resolution ─────────────────────────────────────────────────── @@ -232,6 +252,7 @@ interface JavaTypeResult { // Set before each schema generation pass; used by schemaTypeToJava and helpers. let currentDefinitions: Record = {}; const pendingStandaloneTypes = new Map(); +const generatedSessionEventTypeNames = new Set(); // Cross-schema definitions: keyed by schema filename (e.g. "session-events.schema.json"), // value is the definitions map from that schema. Populated by generateRpcTypes so that @@ -256,6 +277,40 @@ 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; @@ -539,21 +594,15 @@ function schemaTypeToJava( if (crossSchemaMatch) { const [, schemaFile, typeName] = crossSchemaMatch; const externalDefs = crossSchemaDefinitions.get(schemaFile); - if (externalDefs) { - const resolved = externalDefs[typeName]; - if (resolved) { - // Save and swap currentDefinitions so recursive calls resolve against - // the external schema's definitions. - const savedDefs = currentDefinitions; - currentDefinitions = externalDefs; - const result = schemaTypeToJava(resolved, required, context, propName, nestedTypes); - currentDefinitions = savedDefs; - return result; - } + if ( + schemaFile === "session-events.schema.json" + && externalDefs?.[typeName] + && generatedSessionEventTypeNames.has(typeName) + ) { + imports.add(`com.github.copilot.generated.${typeName}`); + return { javaType: typeName, imports }; } - // Fallback: extract just the type name and warn - console.warn(`[codegen] Unresolved cross-schema $ref: ${schema.$ref}`); - return { javaType: typeName, imports }; + return { javaType: "Object", imports }; } const name = schema.$ref.replace(/^#\/definitions\//, ""); @@ -745,7 +794,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); @@ -758,6 +807,13 @@ async function generateSessionEvents(schemaPath: string): Promise { // Generate standalone types discovered via $ref resolution await generatePendingStandaloneTypes(packageName, packageDir, GENERATED_FROM_SESSION_EVENTS); + generatedSessionEventTypeNames.clear(); + for (const entry of await fs.readdir(path.join(REPO_ROOT, packageDir), { withFileTypes: true })) { + if (entry.isFile() && entry.name.endsWith(".java")) { + generatedSessionEventTypeNames.add(path.basename(entry.name, ".java")); + } + } + console.log(`βœ… Generated ${variants.length + 1} session event files`); } @@ -1350,7 +1406,7 @@ 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][] = []; @@ -1379,6 +1435,19 @@ async function generateRpcTypes(schemaPath: string): Promise { } 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)) { @@ -1669,9 +1738,11 @@ function addWrapperResultImports(resultType: string, allImports: Set, pa * callers supply it explicitly. */ function wrapperParamsClassName(method: RpcMethodNode, isSession: boolean): string | null { - let params = method.params; - if (params?.$ref) params = resolveRef(params) as JSONSchema7; - if (!params || typeof params !== "object") return 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) => !isSession || k !== "sessionId"); if (userProps.length === 0) return null; @@ -1680,11 +1751,16 @@ function wrapperParamsClassName(method: RpcMethodNode, isSession: boolean): stri /** 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. @@ -1699,6 +1775,7 @@ function generateApiMethod( const paramsClass = wrapperParamsClassName(method, isSession); const hasSessionId = methodHasSessionId(method); const hasExtraParams = paramsClass !== null; + const paramsOptional = hasExtraParams && methodParamsAreOptional(method); let needsMapper = false; const lines: string[] = []; @@ -1707,26 +1784,39 @@ 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.`); - } - lines.push(` * @since 1.0.0`); - lines.push(` */`); - if (method.deprecated) { - lines.push(` @Deprecated`); - } - if (method.stability === "experimental") { - lines.push(` @CopilotExperimental`); + 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(``); } + pushJavadoc(); + // Signature if (hasExtraParams) { lines.push(` public CompletableFuture<${resultClass}> ${key}(${paramsClass} params) {`); @@ -1739,7 +1829,10 @@ 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, ${wrapperResultTypeExpression(resultClass)});`); } else if (hasSessionId) { @@ -1750,7 +1843,8 @@ function generateApiMethod( } else { // Server-side: pass params directly (or empty map if no params) if (hasExtraParams) { - lines.push(` return caller.invoke("${method.rpcMethod}", params, ${wrapperResultTypeExpression(resultClass)});`); + 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(), ${wrapperResultTypeExpression(resultClass)});`); } @@ -2152,7 +2246,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); @@ -2275,7 +2369,7 @@ async function main(): Promise { console.log("============================"); // Clean the generated output directory to remove orphaned files from previous runs - const generatedOutputDir = path.join(REPO_ROOT, "src/generated/java/com/github/copilot/generated"); + 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 }); @@ -2290,8 +2384,8 @@ async function main(): Promise { await generateRpcWrappers(apiSchemaPath); // Generate package-info.java for each generated package - const generatedPkgDir = `src/generated/java/com/github/copilot/generated`; - const rpcPkgDir = `src/generated/java/com/github/copilot/generated/rpc`; + 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); diff --git a/java/scripts/codegen/package-lock.json b/java/scripts/codegen/package-lock.json index 107a777851..985ae5d5db 100644 --- a/java/scripts/codegen/package-lock.json +++ b/java/scripts/codegen/package-lock.json @@ -6,9 +6,9 @@ "": { "name": "copilot-sdk-java-codegen", "dependencies": { - "@github/copilot": "^1.0.73", + "@github/copilot": "^1.0.82-0", "json-schema": "^0.4.0", - "tsx": "^4.23.1" + "tsx": "^4.23.12" } }, "node_modules/@esbuild/aix-ppc64": { @@ -428,9 +428,9 @@ } }, "node_modules/@github/copilot": { - "version": "1.0.73", - "resolved": "https://registry.npmjs.org/@github/copilot/-/copilot-1.0.73.tgz", - "integrity": "sha512-8I2Ejg2CX/PQA3c2H8W1zuqhniCeR1q1/bD8CrV53/ZLw8GF7DAV0xQpwa8ELYvFgjXb6AADojafCKwdbVef+A==", + "version": "1.0.82-0", + "resolved": "https://registry.npmjs.org/@github/copilot/-/copilot-1.0.82-0.tgz", + "integrity": "sha512-fSZVNAzFFYaS6btYD0+cKF7SrrtOklhpkPs/cIMZY7Fgxoa6rfZrlTWXlQNgNIdwLp51XxwTfxnZO+D9+MQ5yg==", "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.73", - "@github/copilot-darwin-x64": "1.0.73", - "@github/copilot-linux-arm64": "1.0.73", - "@github/copilot-linux-x64": "1.0.73", - "@github/copilot-linuxmusl-arm64": "1.0.73", - "@github/copilot-linuxmusl-x64": "1.0.73", - "@github/copilot-win32-arm64": "1.0.73", - "@github/copilot-win32-x64": "1.0.73" + "@github/copilot-darwin-arm64": "1.0.82-0", + "@github/copilot-darwin-x64": "1.0.82-0", + "@github/copilot-linux-arm64": "1.0.82-0", + "@github/copilot-linux-x64": "1.0.82-0", + "@github/copilot-linuxmusl-arm64": "1.0.82-0", + "@github/copilot-linuxmusl-x64": "1.0.82-0", + "@github/copilot-win32-arm64": "1.0.82-0", + "@github/copilot-win32-x64": "1.0.82-0" } }, "node_modules/@github/copilot-darwin-arm64": { - "version": "1.0.73", - "resolved": "https://registry.npmjs.org/@github/copilot-darwin-arm64/-/copilot-darwin-arm64-1.0.73.tgz", - "integrity": "sha512-5jv7t2sw35/zI0cPze38hG6239NT5/q/Emjx6gLibYkolDqMDJjpm17Ps7tc8oafUEOiMQMb+ar7+qi6rSiGJA==", + "version": "1.0.82-0", + "resolved": "https://registry.npmjs.org/@github/copilot-darwin-arm64/-/copilot-darwin-arm64-1.0.82-0.tgz", + "integrity": "sha512-TzBYfyvxcw3z9Mu7U8TsFo/Nq7m5XS6ahT71aPL+gx/YId0kmenI27b9daXsK6LA1D0gsFGwNBDKINddqntt1g==", "cpu": [ "arm64" ], @@ -466,9 +466,9 @@ } }, "node_modules/@github/copilot-darwin-x64": { - "version": "1.0.73", - "resolved": "https://registry.npmjs.org/@github/copilot-darwin-x64/-/copilot-darwin-x64-1.0.73.tgz", - "integrity": "sha512-l794k6Ahb11AG2FQT/P4TEWxWblzM1h8aQQCzG8jBWp8dfwjhyYjJ+d+0CWQzM3Fc1ddNUZRjKXCUsfvFjiZhQ==", + "version": "1.0.82-0", + "resolved": "https://registry.npmjs.org/@github/copilot-darwin-x64/-/copilot-darwin-x64-1.0.82-0.tgz", + "integrity": "sha512-Lm/U5Q8kN8yEeBTWKTfIxXAgXaT6zqdBzAAO7lA4DWHZ92AEeZZiVTs6jEWsQ2aWB2uMs6zbn0vi6t+/jIqCGw==", "cpu": [ "x64" ], @@ -482,9 +482,9 @@ } }, "node_modules/@github/copilot-linux-arm64": { - "version": "1.0.73", - "resolved": "https://registry.npmjs.org/@github/copilot-linux-arm64/-/copilot-linux-arm64-1.0.73.tgz", - "integrity": "sha512-Zu0W5nupJjNeem0brqU/pG+VY0IWr6EWr/FsC90g5SEDiaM4VhVNVWcz8t0E3DQCSYetV6IBaNMtjs/3uIIiDQ==", + "version": "1.0.82-0", + "resolved": "https://registry.npmjs.org/@github/copilot-linux-arm64/-/copilot-linux-arm64-1.0.82-0.tgz", + "integrity": "sha512-YERVMC1Q4p6l6KQHL5rVOI52rWbvgp9IwyzUBaVSGrfFuqu5BEvZ9bgHPsxTYi3Npkt5KVOXEyPMU5rAY09qQQ==", "cpu": [ "arm64" ], @@ -498,9 +498,9 @@ } }, "node_modules/@github/copilot-linux-x64": { - "version": "1.0.73", - "resolved": "https://registry.npmjs.org/@github/copilot-linux-x64/-/copilot-linux-x64-1.0.73.tgz", - "integrity": "sha512-k33XIr6/PVp+K+5F/zv3No4PPaNImvHz73mcbIw63oxh5iiacXjgr0WqbBIS5s/rkhOWjNPIkbof/TTPZ7mQjA==", + "version": "1.0.82-0", + "resolved": "https://registry.npmjs.org/@github/copilot-linux-x64/-/copilot-linux-x64-1.0.82-0.tgz", + "integrity": "sha512-z2hxMVjqt4+xDRFTZv3/0K3X+aqcJhd6zPO2JxCpOVTh5CNZFaWk+XIa2iXAPWxFqdKJsQ4muXMl3zInaAOkRw==", "cpu": [ "x64" ], @@ -514,9 +514,9 @@ } }, "node_modules/@github/copilot-linuxmusl-arm64": { - "version": "1.0.73", - "resolved": "https://registry.npmjs.org/@github/copilot-linuxmusl-arm64/-/copilot-linuxmusl-arm64-1.0.73.tgz", - "integrity": "sha512-HJWzhfD3oaiIgfRAHkNWzp17fELtshqM9HVN5n+lFEmSO2EETCEh0P1lhJc4m+FYfXSJnL0raAqVuyaNMuPoPw==", + "version": "1.0.82-0", + "resolved": "https://registry.npmjs.org/@github/copilot-linuxmusl-arm64/-/copilot-linuxmusl-arm64-1.0.82-0.tgz", + "integrity": "sha512-EcUCv2PKhBzCCvpTaS511VYTDWyhudyIRPvBpc9gFNO3hjlgiNDusf4k9vP6+E3/lHenwGYzMsyRHcYIOy4vcQ==", "cpu": [ "arm64" ], @@ -530,9 +530,9 @@ } }, "node_modules/@github/copilot-linuxmusl-x64": { - "version": "1.0.73", - "resolved": "https://registry.npmjs.org/@github/copilot-linuxmusl-x64/-/copilot-linuxmusl-x64-1.0.73.tgz", - "integrity": "sha512-/BpOXSb16wHEu8I1SaKiLszQ4Kvu4+Z4uCn7W0bv4xI4fPZwTEG0u3zgaI2W9Ao3+aBl0XRpPmpWzE9ziYEq+w==", + "version": "1.0.82-0", + "resolved": "https://registry.npmjs.org/@github/copilot-linuxmusl-x64/-/copilot-linuxmusl-x64-1.0.82-0.tgz", + "integrity": "sha512-1fKVjUiZ1tdb0/d/re90EpFGXhlIPfjENp2Wo/2Kj592dWO3+IwM2qV/AOdMQ4pacW5iYHII7nibx1/EYq3LGQ==", "cpu": [ "x64" ], @@ -546,9 +546,9 @@ } }, "node_modules/@github/copilot-win32-arm64": { - "version": "1.0.73", - "resolved": "https://registry.npmjs.org/@github/copilot-win32-arm64/-/copilot-win32-arm64-1.0.73.tgz", - "integrity": "sha512-DbPeXiYzQjpOy9oboaBvuCzjRwfcL987c3bG09cK1crdCDrKfkTJ7NXpcp1KWRPIRFO1FQm1qToNE89J+L3uvg==", + "version": "1.0.82-0", + "resolved": "https://registry.npmjs.org/@github/copilot-win32-arm64/-/copilot-win32-arm64-1.0.82-0.tgz", + "integrity": "sha512-H341wuxQHhwe/yLmORHzwC3DGzFZgGzh+TpwfyK2zjeYVbwDZ3Bax8M+9CzIED9jIBdEfAmfGzxKUHFugpXTtQ==", "cpu": [ "arm64" ], @@ -562,9 +562,9 @@ } }, "node_modules/@github/copilot-win32-x64": { - "version": "1.0.73", - "resolved": "https://registry.npmjs.org/@github/copilot-win32-x64/-/copilot-win32-x64-1.0.73.tgz", - "integrity": "sha512-8D3E1l5i+N5Eq8HIOQpx+Zbcb3MXdFxszksM2gqq175Z1S7Zna67oY4GoR3psxlbIpSyHKiLEBWYiaps6ayHWw==", + "version": "1.0.82-0", + "resolved": "https://registry.npmjs.org/@github/copilot-win32-x64/-/copilot-win32-x64-1.0.82-0.tgz", + "integrity": "sha512-f1ba3gG8NaoYWFHtHaHcLN4It7mclkWdCOXvwFPqPEwqCEIx/+Zh6VHiOeIcNWRS0elRP6QYDCKaTDy1TW27uQ==", "cpu": [ "x64" ], @@ -648,9 +648,9 @@ "license": "(AFL-2.1 OR BSD-3-Clause)" }, "node_modules/tsx": { - "version": "4.23.1", - "resolved": "https://registry.npmjs.org/tsx/-/tsx-4.23.1.tgz", - "integrity": "sha512-GQHnkIfxyx1wYCOS/wonik5MVRZU9hi1TEZmzGZSCJB1y9YgoZ8H6itNE/u4suE+yLmOzuE4E5S4TZ/ZX2wcWQ==", + "version": "4.23.12", + "resolved": "https://registry.npmjs.org/tsx/-/tsx-4.23.12.tgz", + "integrity": "sha512-FDf4L4sYzKtzWYhU/Xm0AQFdTjdIxNo9ElTf2mxXM6k8YMHXzYUe4yODVaXP4V9uMFbVg8c0qyBccK2OOxb45Q==", "license": "MIT", "dependencies": { "esbuild": "~0.28.0" diff --git a/java/scripts/codegen/package.json b/java/scripts/codegen/package.json index dbe8b5e6ef..f5d6bf66da 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.73", + "@github/copilot": "^1.0.82-0", "json-schema": "^0.4.0", - "tsx": "^4.23.1" + "tsx": "^4.23.12" } } diff --git a/java/scripts/test-update-documentation-versions.sh b/java/scripts/test-update-documentation-versions.sh new file mode 100755 index 0000000000..606e2f7f80 --- /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 0000000000..5280f55d55 --- /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 7288de3067..6cb04215ac 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.8-01 +//DEPS com.github:copilot-sdk-java:1.0.13-preview.2 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 0000000000..811a05db67 --- /dev/null +++ b/java/sdk/pom.xml @@ -0,0 +1,881 @@ + + + + 4.0.0 + + + com.github + copilot-sdk-java-parent + 1.0.14-preview.2-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 + + 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 + --loglevel + ${npm.loglevel} + + + + + + install-nodejs-cli-dependencies + generate-test-resources + + exec + + + ${skip.cli.install} + npm + ${copilot.sdk.root}/nodejs + + ci + --ignore-scripts + --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 + linux-x64 + + + + + + + com.github + copilot-sdk-java-runtime + ${project.version} + ${copilot.native.classifier} + test + + + + + + org.apache.maven.plugins + maven-surefire-plugin + + false + 1 + none + + + **/AskUserTest.java + **/CompactionTest.java + **/CopilotSessionTest.java + **/ErrorHandlingTest.java + **/EventFidelityTest.java + **/ExecutorWiringTest.java + **/HooksTest.java + **/McpAndAgentsTest.java + **/McpOAuthResumeE2ETest.java + **/PermissionsTest.java + **/PreMcpToolCallHookTest.java + **/RpcServerE2ETest.java + **/RpcSessionStateExtrasE2ETest.java + **/SessionConfigE2ETest.java + **/SessionEventsE2ETest.java + **/SessionTodosChangedTest.java + **/SkillsTest.java + **/StreamingFidelityTest.java + **/SubagentHooksE2ETest.java + **/ToolResultsTest.java + **/ToolsTest.java + + + ${copilot.inprocess.cli.path} + inprocess + + + + + org.apache.maven.plugins + maven-failsafe-plugin + + 1 + none + + + **/ErgonomicToolDefinitionIT.java + **/GitHubTelemetryForwardingIT.java + **/LowLevelToolDefinitionIT.java + **/RewindIT.java + **/SystemMessageSectionsIT.java + + + ${copilot.inprocess.cli.path} + inprocess + + + + + + + + native-linux-arm64 + + + Linux + aarch64 + + + + linux-arm64 + + + + native-win32-x64 + + + Windows + amd64 + + + + win32-x64 + + + + native-win32-arm64 + + + Windows + aarch64 + + + + win32-arm64 + + + + native-darwin-arm64 + + + mac + aarch64 + + + + darwin-arm64 + + + + + 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 100% 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 diff --git a/java/src/generated/java/com/github/copilot/generated/AbortReason.java b/java/sdk/src/generated/java/com/github/copilot/generated/AbortReason.java similarity index 90% rename from java/src/generated/java/com/github/copilot/generated/AbortReason.java rename to java/sdk/src/generated/java/com/github/copilot/generated/AbortReason.java index 2ffbdb8d8c..c1ba2119a6 100644 --- a/java/src/generated/java/com/github/copilot/generated/AbortReason.java +++ b/java/sdk/src/generated/java/com/github/copilot/generated/AbortReason.java @@ -21,7 +21,9 @@ public enum AbortReason { /** The {@code remote_command} variant. */ REMOTE_COMMAND("remote_command"), /** The {@code user_abort} variant. */ - USER_ABORT("user_abort"); + 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; } diff --git a/java/sdk/src/generated/java/com/github/copilot/generated/AgentInterruptedActivity.java b/java/sdk/src/generated/java/com/github/copilot/generated/AgentInterruptedActivity.java new file mode 100644 index 0000000000..0cca731a6e --- /dev/null +++ b/java/sdk/src/generated/java/com/github/copilot/generated/AgentInterruptedActivity.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; + +/** + * What the agent was doing when the user interrupted it. + * + * @since 1.0.0 + */ +@javax.annotation.processing.Generated("copilot-sdk-codegen") +public enum AgentInterruptedActivity { + /** The {@code model_call} variant. */ + MODEL_CALL("model_call"), + /** The {@code retry_backoff} variant. */ + RETRY_BACKOFF("retry_backoff"), + /** The {@code tool_call} variant. */ + TOOL_CALL("tool_call"), + /** The {@code background_agent} variant. */ + BACKGROUND_AGENT("background_agent"); + + private final String value; + AgentInterruptedActivity(String value) { this.value = value; } + @com.fasterxml.jackson.annotation.JsonValue + public String getValue() { return value; } + @com.fasterxml.jackson.annotation.JsonCreator + public static AgentInterruptedActivity fromValue(String value) { + for (AgentInterruptedActivity v : values()) { + if (v.value.equals(value)) return v; + } + throw new IllegalArgumentException("Unknown AgentInterruptedActivity value: " + value); + } +} diff --git a/java/sdk/src/generated/java/com/github/copilot/generated/AgentInterruptedCancelPhase.java b/java/sdk/src/generated/java/com/github/copilot/generated/AgentInterruptedCancelPhase.java new file mode 100644 index 0000000000..41a8bd11b8 --- /dev/null +++ b/java/sdk/src/generated/java/com/github/copilot/generated/AgentInterruptedCancelPhase.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; + +/** + * Where the interruption landed relative to the first streamed token. + * + * @since 1.0.0 + */ +@javax.annotation.processing.Generated("copilot-sdk-codegen") +public enum AgentInterruptedCancelPhase { + /** The {@code pre_first_token} variant. */ + PRE_FIRST_TOKEN("pre_first_token"), + /** The {@code mid_stream} variant. */ + MID_STREAM("mid_stream"); + + private final String value; + AgentInterruptedCancelPhase(String value) { this.value = value; } + @com.fasterxml.jackson.annotation.JsonValue + public String getValue() { return value; } + @com.fasterxml.jackson.annotation.JsonCreator + public static AgentInterruptedCancelPhase fromValue(String value) { + for (AgentInterruptedCancelPhase v : values()) { + if (v.value.equals(value)) return v; + } + throw new IllegalArgumentException("Unknown AgentInterruptedCancelPhase value: " + value); + } +} diff --git a/java/sdk/src/generated/java/com/github/copilot/generated/AgentInterruptedEvent.java b/java/sdk/src/generated/java/com/github/copilot/generated/AgentInterruptedEvent.java new file mode 100644 index 0000000000..ef6772fca2 --- /dev/null +++ b/java/sdk/src/generated/java/com/github/copilot/generated/AgentInterruptedEvent.java @@ -0,0 +1,66 @@ +/*--------------------------------------------------------------------------------------------- + * 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 "agent.interrupted". Metadata for work the user interrupted while the agent was running + * @since 1.0.0 + */ +@JsonIgnoreProperties(ignoreUnknown = true) +@JsonInclude(JsonInclude.Include.NON_NULL) +@javax.annotation.processing.Generated("copilot-sdk-codegen") +public final class AgentInterruptedEvent extends SessionEvent { + + @Override + public String getType() { return "agent.interrupted"; } + + @JsonProperty("data") + private AgentInterruptedEventData data; + + public AgentInterruptedEventData getData() { return data; } + public void setData(AgentInterruptedEventData data) { this.data = data; } + + /** Data payload for {@link AgentInterruptedEvent}. */ + @JsonIgnoreProperties(ignoreUnknown = true) + @JsonInclude(JsonInclude.Include.NON_NULL) + public record AgentInterruptedEventData( + /** What the agent was doing when the user interrupted it */ + @JsonProperty("activity") AgentInterruptedActivity activity, + /** How long the interrupted work had been running, in milliseconds */ + @JsonProperty("elapsedMs") Double elapsedMs, + /** Zero-based agentic-loop iteration the interrupt landed in */ + @JsonProperty("turn") Long turn, + /** For an interrupted model call: the model the request targeted */ + @JsonProperty("model") String model, + /** For an interrupted model call: the provider endpoint the request targeted */ + @JsonProperty("apiEndpoint") String apiEndpoint, + /** For an interrupted model call: the transport the request used */ + @JsonProperty("transport") ModelCallFailureTransport transport, + /** For an interrupted model call: the reasoning effort the request asked for */ + @JsonProperty("reasoningEffort") String reasoningEffort, + /** For an interrupted model call: whether the user interrupted before any token arrived or while the response was streaming */ + @JsonProperty("cancelPhase") AgentInterruptedCancelPhase cancelPhase, + /** For a mid-stream interrupt: the observed time to first observable output, in milliseconds. Deliberately distinct from the `ttftMs` reported on a successful model call, which measures time to first stream event. */ + @JsonProperty("outputTtftMs") Double outputTtftMs, + /** Names of the tools that were still running. More than one when the model requested a parallel fan-out. */ + @JsonProperty("toolNames") List toolNames, + /** Tool call identifiers that were still running */ + @JsonProperty("toolCallIds") List toolCallIds, + /** Subset of `toolNames` whose tool metadata marks the tool name as safe to record unhashed in telemetry. */ + @JsonProperty("safeToolNames") List safeToolNames, + /** For an interrupted background-agent batch: how many background sub-agents the stop swept. Counts accepted cancellations, so an agent cancelled as a cascade of its interrupted parent is covered by that parent rather than counted again. */ + @JsonProperty("interruptedAgentCount") Long interruptedAgentCount + ) { + } +} diff --git a/java/sdk/src/generated/java/com/github/copilot/generated/AssistantFusionPhaseCompletedEvent.java b/java/sdk/src/generated/java/com/github/copilot/generated/AssistantFusionPhaseCompletedEvent.java new file mode 100644 index 0000000000..5ad9beee17 --- /dev/null +++ b/java/sdk/src/generated/java/com/github/copilot/generated/AssistantFusionPhaseCompletedEvent.java @@ -0,0 +1,67 @@ +/*--------------------------------------------------------------------------------------------- + * 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.fusion_phase_completed". Experimental durable HydraFusion phase output and lossless replay checkpoint. + * @since 1.0.0 + */ +@JsonIgnoreProperties(ignoreUnknown = true) +@JsonInclude(JsonInclude.Include.NON_NULL) +@javax.annotation.processing.Generated("copilot-sdk-codegen") +public final class AssistantFusionPhaseCompletedEvent extends SessionEvent { + + @Override + public String getType() { return "assistant.fusion_phase_completed"; } + + @JsonProperty("data") + private AssistantFusionPhaseCompletedEventData data; + + public AssistantFusionPhaseCompletedEventData getData() { return data; } + public void setData(AssistantFusionPhaseCompletedEventData data) { this.data = data; } + + /** Data payload for {@link AssistantFusionPhaseCompletedEvent}. */ + @JsonIgnoreProperties(ignoreUnknown = true) + @JsonInclude(JsonInclude.Include.NON_NULL) + public record AssistantFusionPhaseCompletedEventData( + /** Identifier of the HydraFusion turn containing the phase. */ + @JsonProperty("fusionId") String fusionId, + /** Stable identifier for the completed phase. */ + @JsonProperty("phaseId") String phaseId, + /** Kind of phase that completed. */ + @JsonProperty("phaseKind") FusionPhaseKind phaseKind, + /** Semantic role assigned to the completed phase. */ + @JsonProperty("role") String role, + /** Conversation scope in which the phase executed. */ + @JsonProperty("conversationScope") FusionConversationScope conversationScope, + /** Concrete model that executed the phase. */ + @JsonProperty("model") String model, + /** Durable outcome status of the phase. */ + @JsonProperty("status") FusionPhaseStatus status, + /** Provider-normalized textual output produced by the phase. */ + @JsonProperty("content") String content, + /** Structured judge or critic verdict, when the phase produces one. */ + @JsonProperty("verdict") String verdict, + /** Elapsed execution time for the phase in milliseconds. */ + @JsonProperty("durationMs") Double durationMs, + /** Aggregate concrete-model usage consumed by the phase. */ + @JsonProperty("usage") FusionPhaseUsage usage, + /** Exact provider-normalized message used to reconstruct canonical model history. */ + @JsonProperty("projectionMessage") Object projectionMessage, + /** Projection action for the exact internal message. */ + @JsonProperty("projectionMode") FusionProjectionMode projectionMode, + /** Terminal request held outside canonical state until selected by the final commit. */ + @JsonProperty("stagedTerminal") FusionStagedTerminal stagedTerminal + ) { + } +} diff --git a/java/sdk/src/generated/java/com/github/copilot/generated/AssistantFusionPhaseFailedEvent.java b/java/sdk/src/generated/java/com/github/copilot/generated/AssistantFusionPhaseFailedEvent.java new file mode 100644 index 0000000000..17de3c7190 --- /dev/null +++ b/java/sdk/src/generated/java/com/github/copilot/generated/AssistantFusionPhaseFailedEvent.java @@ -0,0 +1,63 @@ +/*--------------------------------------------------------------------------------------------- + * 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.fusion_phase_failed". Experimental durable typed HydraFusion phase failure and degradation transition. + * @since 1.0.0 + */ +@JsonIgnoreProperties(ignoreUnknown = true) +@JsonInclude(JsonInclude.Include.NON_NULL) +@javax.annotation.processing.Generated("copilot-sdk-codegen") +public final class AssistantFusionPhaseFailedEvent extends SessionEvent { + + @Override + public String getType() { return "assistant.fusion_phase_failed"; } + + @JsonProperty("data") + private AssistantFusionPhaseFailedEventData data; + + public AssistantFusionPhaseFailedEventData getData() { return data; } + public void setData(AssistantFusionPhaseFailedEventData data) { this.data = data; } + + /** Data payload for {@link AssistantFusionPhaseFailedEvent}. */ + @JsonIgnoreProperties(ignoreUnknown = true) + @JsonInclude(JsonInclude.Include.NON_NULL) + public record AssistantFusionPhaseFailedEventData( + /** Identifier of the HydraFusion turn containing the phase. */ + @JsonProperty("fusionId") String fusionId, + /** Stable identifier for the failed phase. */ + @JsonProperty("phaseId") String phaseId, + /** Kind of phase that failed. */ + @JsonProperty("phaseKind") FusionPhaseKind phaseKind, + /** Semantic role assigned to the failed phase. */ + @JsonProperty("role") String role, + /** Conversation scope in which the phase executed. */ + @JsonProperty("conversationScope") FusionConversationScope conversationScope, + /** Concrete model that attempted the phase. */ + @JsonProperty("model") String model, + /** Durable outcome status of the phase. */ + @JsonProperty("status") FusionPhaseStatus status, + /** Stable machine-readable reason for the phase failure. */ + @JsonProperty("reason") String reason, + /** Elapsed execution time before the phase failed, in milliseconds. */ + @JsonProperty("durationMs") Double durationMs, + /** Aggregate concrete-model usage consumed before the failure. */ + @JsonProperty("usage") FusionPhaseUsage usage, + /** Provider or execution error detail, when available. */ + @JsonProperty("errorMessage") String errorMessage, + /** Identifier of the fallback phase used to continue the turn after degradation. */ + @JsonProperty("degradedToPhaseId") String degradedToPhaseId + ) { + } +} diff --git a/java/sdk/src/generated/java/com/github/copilot/generated/AssistantFusionPhaseStartedEvent.java b/java/sdk/src/generated/java/com/github/copilot/generated/AssistantFusionPhaseStartedEvent.java new file mode 100644 index 0000000000..88c4064a73 --- /dev/null +++ b/java/sdk/src/generated/java/com/github/copilot/generated/AssistantFusionPhaseStartedEvent.java @@ -0,0 +1,53 @@ +/*--------------------------------------------------------------------------------------------- + * 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.fusion_phase_started". Experimental transient HydraFusion phase/model/role signal. + * @since 1.0.0 + */ +@JsonIgnoreProperties(ignoreUnknown = true) +@JsonInclude(JsonInclude.Include.NON_NULL) +@javax.annotation.processing.Generated("copilot-sdk-codegen") +public final class AssistantFusionPhaseStartedEvent extends SessionEvent { + + @Override + public String getType() { return "assistant.fusion_phase_started"; } + + @JsonProperty("data") + private AssistantFusionPhaseStartedEventData data; + + public AssistantFusionPhaseStartedEventData getData() { return data; } + public void setData(AssistantFusionPhaseStartedEventData data) { this.data = data; } + + /** Data payload for {@link AssistantFusionPhaseStartedEvent}. */ + @JsonIgnoreProperties(ignoreUnknown = true) + @JsonInclude(JsonInclude.Include.NON_NULL) + public record AssistantFusionPhaseStartedEventData( + /** Identifier of the HydraFusion turn containing the phase. */ + @JsonProperty("fusionId") String fusionId, + /** Stable identifier for the concrete phase. */ + @JsonProperty("phaseId") String phaseId, + /** Kind of phase being executed. */ + @JsonProperty("phaseKind") FusionPhaseKind phaseKind, + /** HydraFusion orchestration pattern containing the phase. */ + @JsonProperty("pattern") FusionPattern pattern, + /** Semantic role assigned to the phase. */ + @JsonProperty("role") String role, + /** Conversation scope in which the phase executes. */ + @JsonProperty("conversationScope") FusionConversationScope conversationScope, + /** Concrete model executing the phase. */ + @JsonProperty("model") String model + ) { + } +} diff --git a/java/src/generated/java/com/github/copilot/generated/AssistantIdleEvent.java b/java/sdk/src/generated/java/com/github/copilot/generated/AssistantIdleEvent.java similarity index 100% rename from java/src/generated/java/com/github/copilot/generated/AssistantIdleEvent.java rename to java/sdk/src/generated/java/com/github/copilot/generated/AssistantIdleEvent.java 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 100% 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 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 100% 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 diff --git a/java/src/generated/java/com/github/copilot/generated/AssistantMessageEvent.java b/java/sdk/src/generated/java/com/github/copilot/generated/AssistantMessageEvent.java similarity index 79% rename from java/src/generated/java/com/github/copilot/generated/AssistantMessageEvent.java rename to java/sdk/src/generated/java/com/github/copilot/generated/AssistantMessageEvent.java index fdbdc0afd7..9ba4f05618 100644 --- a/java/src/generated/java/com/github/copilot/generated/AssistantMessageEvent.java +++ b/java/sdk/src/generated/java/com/github/copilot/generated/AssistantMessageEvent.java @@ -53,6 +53,10 @@ public record AssistantMessageEventData( @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 */ @@ -63,16 +67,22 @@ public record AssistantMessageEventData( @JsonProperty("clientRequestId") String clientRequestId, /** Copilot service request ID (x-copilot-service-request-id header) for CAPI log correlation */ @JsonProperty("serviceRequestId") String serviceRequestId, + /** Per-request treatment/eligibility signal returned by the Copilot API in the `X-GitHub-Copilot-Request-TE` response header for the associated model call; `false` when the header was absent or unparseable. */ + @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, + /** Neutral provider-tagged reasoning content blocks preserved verbatim for round-tripping. `reasoningText` and `reasoningOpaque` are a lossy derived view of these blocks, retained for display. */ + @JsonProperty("reasoningBlocks") AssistantMessageReasoningBlocks reasoningBlocks, /** 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 + @JsonProperty("citations") Citations citations, + /** Experimental HydraFusion source attribution for this ordinary authoritative assistant message. */ + @JsonProperty("fusion") FusionAttribution fusion ) { } } diff --git a/java/sdk/src/generated/java/com/github/copilot/generated/AssistantMessageReasoningBlocks.java b/java/sdk/src/generated/java/com/github/copilot/generated/AssistantMessageReasoningBlocks.java new file mode 100644 index 0000000000..d2ad87f7c4 --- /dev/null +++ b/java/sdk/src/generated/java/com/github/copilot/generated/AssistantMessageReasoningBlocks.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; + +/** + * Neutral provider-tagged reasoning content blocks preserved verbatim for round-tripping + * + * @since 1.0.0 + */ +@javax.annotation.processing.Generated("copilot-sdk-codegen") +@JsonInclude(JsonInclude.Include.NON_NULL) +@JsonIgnoreProperties(ignoreUnknown = true) +public record AssistantMessageReasoningBlocks( + /** Model provider that produced these reasoning blocks. */ + @JsonProperty("provider") String provider, + /** Provider-native reasoning content blocks (e.g. Anthropic `thinking` / `redacted_thinking`) preserved verbatim, in order. A single response can carry several, each signed over the content preceding it, so dropping or reordering any of them invalidates the rest. */ + @JsonProperty("blocks") List blocks +) { +} diff --git a/java/src/generated/java/com/github/copilot/generated/AssistantMessageServerTools.java b/java/sdk/src/generated/java/com/github/copilot/generated/AssistantMessageServerTools.java similarity index 76% rename from java/src/generated/java/com/github/copilot/generated/AssistantMessageServerTools.java rename to java/sdk/src/generated/java/com/github/copilot/generated/AssistantMessageServerTools.java index 72d6850376..6d67f6ecbe 100644 --- a/java/src/generated/java/com/github/copilot/generated/AssistantMessageServerTools.java +++ b/java/sdk/src/generated/java/com/github/copilot/generated/AssistantMessageServerTools.java @@ -23,10 +23,15 @@ @JsonInclude(JsonInclude.Include.NON_NULL) @JsonIgnoreProperties(ignoreUnknown = true) public record AssistantMessageServerTools( + /** Model provider that produced this server-tool payload. */ @JsonProperty("provider") String provider, + /** Provider-native server-tool call and output items preserved verbatim for replay. */ @JsonProperty("items") List items, + /** Provider function-call namespaces keyed by function-call identifier. */ @JsonProperty("functionCallNamespaces") Map functionCallNamespaces, + /** Raw provider content blocks retained for verbatim round-tripping. */ @JsonProperty("rawContentBlocks") List rawContentBlocks, + /** Advisor model identifier associated with the server-tool payload. */ @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 100% 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 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 100% 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 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 84% 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 9b69fedac1..627dea8ef5 100644 --- a/java/src/generated/java/com/github/copilot/generated/AssistantReasoningEvent.java +++ b/java/sdk/src/generated/java/com/github/copilot/generated/AssistantReasoningEvent.java @@ -37,7 +37,9 @@ 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, + /** Per-request treatment/eligibility signal returned by the Copilot API in the `X-GitHub-Copilot-Request-TE` response header for the associated model call; `false` when the header was absent or unparseable. */ + @JsonProperty("rte") Boolean rte ) { } } diff --git a/java/src/generated/java/com/github/copilot/generated/AssistantServerToolProgressEvent.java b/java/sdk/src/generated/java/com/github/copilot/generated/AssistantServerToolProgressEvent.java similarity index 100% rename from java/src/generated/java/com/github/copilot/generated/AssistantServerToolProgressEvent.java rename to java/sdk/src/generated/java/com/github/copilot/generated/AssistantServerToolProgressEvent.java 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 100% 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 diff --git a/java/src/generated/java/com/github/copilot/generated/AssistantToolCallDeltaEvent.java b/java/sdk/src/generated/java/com/github/copilot/generated/AssistantToolCallDeltaEvent.java similarity index 100% rename from java/src/generated/java/com/github/copilot/generated/AssistantToolCallDeltaEvent.java rename to java/sdk/src/generated/java/com/github/copilot/generated/AssistantToolCallDeltaEvent.java 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 100% 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 diff --git a/java/src/generated/java/com/github/copilot/generated/AssistantTurnRetryEvent.java b/java/sdk/src/generated/java/com/github/copilot/generated/AssistantTurnRetryEvent.java similarity index 100% rename from java/src/generated/java/com/github/copilot/generated/AssistantTurnRetryEvent.java rename to java/sdk/src/generated/java/com/github/copilot/generated/AssistantTurnRetryEvent.java 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 100% 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 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/src/generated/java/com/github/copilot/generated/AssistantUsageEvent.java b/java/sdk/src/generated/java/com/github/copilot/generated/AssistantUsageEvent.java similarity index 60% rename from java/src/generated/java/com/github/copilot/generated/AssistantUsageEvent.java rename to java/sdk/src/generated/java/com/github/copilot/generated/AssistantUsageEvent.java index 47bfcbb4c7..d0956f5a77 100644 --- a/java/src/generated/java/com/github/copilot/generated/AssistantUsageEvent.java +++ b/java/sdk/src/generated/java/com/github/copilot/generated/AssistantUsageEvent.java @@ -56,16 +56,36 @@ public record AssistantUsageEventData( @JsonProperty("duration") Long duration, /** Time to first token in milliseconds. Only available for streaming requests */ @JsonProperty("timeToFirstTokenMs") Double timeToFirstTokenMs, + /** Time to first observable model output in milliseconds. Includes text, reasoning, and tool-call output; only available for streaming requests that produce observable output. */ + @JsonProperty("outputTtftMs") Double outputTtftMs, /** 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, + /** Whether this model call used a bring-your-own-key provider */ + @JsonProperty("isByok") Boolean isByok, + /** Whether Auto mode was selected for this model call */ + @JsonProperty("isAuto") Boolean isAuto, + /** Effective maximum prompt-token limit used for this model call */ + @JsonProperty("maxPromptTokens") Long maxPromptTokens, + /** Requested maximum output tokens used for this model call */ + @JsonProperty("maxOutputTokens") Long maxOutputTokens, + /** Number of accepted speculative prediction tokens */ + @JsonProperty("acceptedPredictionTokens") Long acceptedPredictionTokens, + /** Number of rejected speculative prediction tokens */ + @JsonProperty("rejectedPredictionTokens") Long rejectedPredictionTokens, + /** Transport used for this model call (http or websocket) */ + @JsonProperty("transport") AssistantUsageTransport transport, /** 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, + /** Per-request treatment/eligibility signal returned by the Copilot API in the `X-GitHub-Copilot-Request-TE` response header for the associated model call; `false` when the header was absent or unparseable. */ + @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 */ @@ -76,10 +96,28 @@ public record AssistantUsageEventData( @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, + /** Reasoning summary mode used for this model call, if applicable */ + @JsonProperty("reasoningSummary") ReasoningSummary reasoningSummary, + /** 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, + /** How the prompt-cache frontier was determined for this call */ + @JsonProperty("frontierSource") String frontierSource, + /** Effective prompt-cache lifetime in seconds for this call */ + @JsonProperty("cacheTtlSeconds") Long cacheTtlSeconds, + /** Whether the provider reported prompt-cache usage details for this call */ + @JsonProperty("cacheDetailsReported") Boolean cacheDetailsReported, + /** 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 + @JsonProperty("contentFilterTriggered") Boolean contentFilterTriggered, + /** Experimental HydraFusion attribution for this concrete model call's usage. */ + @JsonProperty("fusion") FusionAttribution fusion ) { } } diff --git a/java/src/generated/java/com/github/copilot/generated/AssistantUsageQuotaSnapshot.java b/java/sdk/src/generated/java/com/github/copilot/generated/AssistantUsageQuotaSnapshot.java similarity index 100% rename from java/src/generated/java/com/github/copilot/generated/AssistantUsageQuotaSnapshot.java rename to java/sdk/src/generated/java/com/github/copilot/generated/AssistantUsageQuotaSnapshot.java diff --git a/java/src/generated/java/com/github/copilot/generated/PermissionAllowAllMode.java b/java/sdk/src/generated/java/com/github/copilot/generated/AssistantUsageTransport.java similarity index 60% rename from java/src/generated/java/com/github/copilot/generated/PermissionAllowAllMode.java rename to java/sdk/src/generated/java/com/github/copilot/generated/AssistantUsageTransport.java index d05b936e6a..9d69b50f0d 100644 --- a/java/src/generated/java/com/github/copilot/generated/PermissionAllowAllMode.java +++ b/java/sdk/src/generated/java/com/github/copilot/generated/AssistantUsageTransport.java @@ -10,28 +10,26 @@ import javax.annotation.processing.Generated; /** - * Allow-all mode for the session. + * Transport used for a successful model call * * @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"); +public enum AssistantUsageTransport { + /** The {@code http} variant. */ + HTTP("http"), + /** The {@code websocket} variant. */ + WEBSOCKET("websocket"); private final String value; - PermissionAllowAllMode(String value) { this.value = value; } + AssistantUsageTransport(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()) { + public static AssistantUsageTransport fromValue(String value) { + for (AssistantUsageTransport v : values()) { if (v.value.equals(value)) return v; } - throw new IllegalArgumentException("Unknown PermissionAllowAllMode value: " + value); + throw new IllegalArgumentException("Unknown AssistantUsageTransport value: " + value); } } diff --git a/java/src/generated/java/com/github/copilot/generated/AutoModeResolvedReasoningBucket.java b/java/sdk/src/generated/java/com/github/copilot/generated/AutoModeResolvedReasoningBucket.java similarity index 100% rename from java/src/generated/java/com/github/copilot/generated/AutoModeResolvedReasoningBucket.java rename to java/sdk/src/generated/java/com/github/copilot/generated/AutoModeResolvedReasoningBucket.java 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 100% 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 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 100% 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 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/src/generated/java/com/github/copilot/generated/BinaryAssetType.java b/java/sdk/src/generated/java/com/github/copilot/generated/BinaryAssetType.java similarity index 100% rename from java/src/generated/java/com/github/copilot/generated/BinaryAssetType.java rename to java/sdk/src/generated/java/com/github/copilot/generated/BinaryAssetType.java 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 100% 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 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 100% 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 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 100% 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 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/src/generated/java/com/github/copilot/generated/CitableSource.java b/java/sdk/src/generated/java/com/github/copilot/generated/CitableSource.java similarity index 100% rename from java/src/generated/java/com/github/copilot/generated/CitableSource.java rename to java/sdk/src/generated/java/com/github/copilot/generated/CitableSource.java diff --git a/java/src/generated/java/com/github/copilot/generated/CitationProvider.java b/java/sdk/src/generated/java/com/github/copilot/generated/CitationProvider.java similarity index 100% rename from java/src/generated/java/com/github/copilot/generated/CitationProvider.java rename to java/sdk/src/generated/java/com/github/copilot/generated/CitationProvider.java diff --git a/java/src/generated/java/com/github/copilot/generated/CitationReference.java b/java/sdk/src/generated/java/com/github/copilot/generated/CitationReference.java similarity index 100% rename from java/src/generated/java/com/github/copilot/generated/CitationReference.java rename to java/sdk/src/generated/java/com/github/copilot/generated/CitationReference.java diff --git a/java/src/generated/java/com/github/copilot/generated/CitationSource.java b/java/sdk/src/generated/java/com/github/copilot/generated/CitationSource.java similarity index 100% rename from java/src/generated/java/com/github/copilot/generated/CitationSource.java rename to java/sdk/src/generated/java/com/github/copilot/generated/CitationSource.java diff --git a/java/src/generated/java/com/github/copilot/generated/CitationSpan.java b/java/sdk/src/generated/java/com/github/copilot/generated/CitationSpan.java similarity index 100% rename from java/src/generated/java/com/github/copilot/generated/CitationSpan.java rename to java/sdk/src/generated/java/com/github/copilot/generated/CitationSpan.java diff --git a/java/src/generated/java/com/github/copilot/generated/Citations.java b/java/sdk/src/generated/java/com/github/copilot/generated/Citations.java similarity index 100% rename from java/src/generated/java/com/github/copilot/generated/Citations.java rename to java/sdk/src/generated/java/com/github/copilot/generated/Citations.java 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 100% 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 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 100% 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 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 100% 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 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 100% 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 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 100% 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 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 0000000000..1c77861dcc --- /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/src/generated/java/com/github/copilot/generated/ContextTier.java b/java/sdk/src/generated/java/com/github/copilot/generated/ContextTier.java similarity index 100% rename from java/src/generated/java/com/github/copilot/generated/ContextTier.java rename to java/sdk/src/generated/java/com/github/copilot/generated/ContextTier.java 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 100% 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 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 100% 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 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 100% 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 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 100% 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 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 93% 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 4242b4b656..7f20d35bf2 100644 --- a/java/src/generated/java/com/github/copilot/generated/ExitPlanModeRequestedEvent.java +++ b/java/sdk/src/generated/java/com/github/copilot/generated/ExitPlanModeRequestedEvent.java @@ -44,7 +44,9 @@ public record ExitPlanModeRequestedEventData( /** Available actions the user can take */ @JsonProperty("actions") List actions, /** Recommended action to preselect for the user */ - @JsonProperty("recommendedAction") ExitPlanModeAction recommendedAction + @JsonProperty("recommendedAction") ExitPlanModeAction recommendedAction, + /** Model the session had selected when the plan was authored, when one is known */ + @JsonProperty("model") String model ) { } } 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 100% 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 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 100% 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 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 100% 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 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 91% 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 903f01f1e8..e2d5bda5a9 100644 --- a/java/src/generated/java/com/github/copilot/generated/ExternalToolRequestedEvent.java +++ b/java/sdk/src/generated/java/com/github/copilot/generated/ExternalToolRequestedEvent.java @@ -42,6 +42,8 @@ public record ExternalToolRequestedEventData( @JsonProperty("toolCallId") String toolCallId, /** Name of the external tool to invoke */ @JsonProperty("toolName") String toolName, + /** Stable provider identity captured with an extension-owned tool definition; hosts use it to route the request to the same provider that was offered to the model */ + @JsonProperty("providerId") String providerId, /** Arguments to pass to the external tool */ @JsonProperty("arguments") Object arguments, /** Active session working directory, when known. */ diff --git a/java/sdk/src/generated/java/com/github/copilot/generated/FactoryRunSettledEvent.java b/java/sdk/src/generated/java/com/github/copilot/generated/FactoryRunSettledEvent.java new file mode 100644 index 0000000000..58ffa9cb3c --- /dev/null +++ b/java/sdk/src/generated/java/com/github/copilot/generated/FactoryRunSettledEvent.java @@ -0,0 +1,51 @@ +/*--------------------------------------------------------------------------------------------- + * 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_settled". Ephemeral signal that a factory run reached a terminal status. + * @since 1.0.0 + */ +@JsonIgnoreProperties(ignoreUnknown = true) +@JsonInclude(JsonInclude.Include.NON_NULL) +@javax.annotation.processing.Generated("copilot-sdk-codegen") +public final class FactoryRunSettledEvent extends SessionEvent { + + @Override + public String getType() { return "factory.run_settled"; } + + @JsonProperty("data") + private FactoryRunSettledEventData data; + + public FactoryRunSettledEventData getData() { return data; } + public void setData(FactoryRunSettledEventData data) { this.data = data; } + + /** Data payload for {@link FactoryRunSettledEvent}. */ + @JsonIgnoreProperties(ignoreUnknown = true) + @JsonInclude(JsonInclude.Include.NON_NULL) + public record FactoryRunSettledEventData( + /** Identifier of the factory run that settled. */ + @JsonProperty("runId") String runId, + /** Terminal status the run committed. */ + @JsonProperty("status") FactoryRunSettledStatus status, + /** Subagents this run consumed against its limits. */ + @JsonProperty("consumedSubagents") Long consumedSubagents, + /** AI credits this run consumed, in nano-AIU. */ + @JsonProperty("consumedNanoAiu") Long consumedNanoAiu, + /** Active milliseconds accumulated across every attempt of this run. */ + @JsonProperty("elapsedMs") Long elapsedMs, + /** Typed failure class recorded on the run, when it failed with one (e.g. `factory_limit_reached`). */ + @JsonProperty("failureType") String failureType + ) { + } +} diff --git a/java/sdk/src/generated/java/com/github/copilot/generated/FactoryRunSettledStatus.java b/java/sdk/src/generated/java/com/github/copilot/generated/FactoryRunSettledStatus.java new file mode 100644 index 0000000000..bbeffbbf48 --- /dev/null +++ b/java/sdk/src/generated/java/com/github/copilot/generated/FactoryRunSettledStatus.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; + +/** + * Terminal status a factory run committed. A settled run is never `pending` or `running`, so those two members of the run-status domain are deliberately absent. + * + * @since 1.0.0 + */ +@javax.annotation.processing.Generated("copilot-sdk-codegen") +public enum FactoryRunSettledStatus { + /** 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; + FactoryRunSettledStatus(String value) { this.value = value; } + @com.fasterxml.jackson.annotation.JsonValue + public String getValue() { return value; } + @com.fasterxml.jackson.annotation.JsonCreator + public static FactoryRunSettledStatus fromValue(String value) { + for (FactoryRunSettledStatus v : values()) { + if (v.value.equals(value)) return v; + } + throw new IllegalArgumentException("Unknown FactoryRunSettledStatus value: " + value); + } +} diff --git a/java/sdk/src/generated/java/com/github/copilot/generated/FactoryRunStartedEvent.java b/java/sdk/src/generated/java/com/github/copilot/generated/FactoryRunStartedEvent.java new file mode 100644 index 0000000000..691c7185d4 --- /dev/null +++ b/java/sdk/src/generated/java/com/github/copilot/generated/FactoryRunStartedEvent.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 "factory.run_started". Ephemeral signal that a factory run attempt began executing. + * @since 1.0.0 + */ +@JsonIgnoreProperties(ignoreUnknown = true) +@JsonInclude(JsonInclude.Include.NON_NULL) +@javax.annotation.processing.Generated("copilot-sdk-codegen") +public final class FactoryRunStartedEvent extends SessionEvent { + + @Override + public String getType() { return "factory.run_started"; } + + @JsonProperty("data") + private FactoryRunStartedEventData data; + + public FactoryRunStartedEventData getData() { return data; } + public void setData(FactoryRunStartedEventData data) { this.data = data; } + + /** Data payload for {@link FactoryRunStartedEvent}. */ + @JsonIgnoreProperties(ignoreUnknown = true) + @JsonInclude(JsonInclude.Include.NON_NULL) + public record FactoryRunStartedEventData( + /** Identifier of the factory run that started. */ + @JsonProperty("runId") String runId, + /** Name of the factory this run executes. Low cardinality by construction. */ + @JsonProperty("factoryName") String factoryName, + /** Attempt number this start committed; a resumed run increments it. */ + @JsonProperty("attempt") Long attempt + ) { + } +} 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 0000000000..33b542058b --- /dev/null +++ b/java/sdk/src/generated/java/com/github/copilot/generated/FactoryRunUpdatedEvent.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 "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( + /** Factory run identifier. */ + @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/FusionAttribution.java b/java/sdk/src/generated/java/com/github/copilot/generated/FusionAttribution.java new file mode 100644 index 0000000000..8e4ae7e937 --- /dev/null +++ b/java/sdk/src/generated/java/com/github/copilot/generated/FusionAttribution.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; + +/** + * Experimental attribution linking an ordinary event to the HydraFusion turn, phase, and concrete source that produced it. + * + * @since 1.0.0 + */ +@javax.annotation.processing.Generated("copilot-sdk-codegen") +@JsonInclude(JsonInclude.Include.NON_NULL) +@JsonIgnoreProperties(ignoreUnknown = true) +public record FusionAttribution( + /** Stable identifier for the HydraFusion turn that produced the event. */ + @JsonProperty("fusionId") String fusionId, + /** Idempotency identifier for the authoritative commit, when the event belongs to the selected output. */ + @JsonProperty("commitId") String commitId, + /** Synthetic HydraFusion model selected for the session. */ + @JsonProperty("syntheticModel") String syntheticModel, + /** HydraFusion routing policy used for the turn. */ + @JsonProperty("policy") String policy, + /** HydraFusion orchestration pattern selected for the turn. */ + @JsonProperty("pattern") String pattern, + /** Identifier of the concrete phase that produced the event. */ + @JsonProperty("phaseId") String phaseId, + /** Kind of concrete phase that produced the event. */ + @JsonProperty("phaseKind") String phaseKind, + /** Semantic role assigned to the concrete phase. */ + @JsonProperty("role") String role, + /** Concrete model that produced the attributed event. */ + @JsonProperty("sourceModel") String sourceModel, + /** Conversation scope in which the concrete phase executed. */ + @JsonProperty("conversationScope") String conversationScope, + /** Phase whose output supplied the authoritative content, when different from the executing phase. */ + @JsonProperty("sourcePhaseId") String sourcePhaseId +) { +} diff --git a/java/sdk/src/generated/java/com/github/copilot/generated/FusionConversationScope.java b/java/sdk/src/generated/java/com/github/copilot/generated/FusionConversationScope.java new file mode 100644 index 0000000000..d38381ed48 --- /dev/null +++ b/java/sdk/src/generated/java/com/github/copilot/generated/FusionConversationScope.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; + +/** + * Conversation scope in which a HydraFusion phase executes. + * + * @since 1.0.0 + */ +@javax.annotation.processing.Generated("copilot-sdk-codegen") +public enum FusionConversationScope { + /** The {@code root} variant. */ + ROOT("root"), + /** The {@code review} variant. */ + REVIEW("review"); + + private final String value; + FusionConversationScope(String value) { this.value = value; } + @com.fasterxml.jackson.annotation.JsonValue + public String getValue() { return value; } + @com.fasterxml.jackson.annotation.JsonCreator + public static FusionConversationScope fromValue(String value) { + for (FusionConversationScope v : values()) { + if (v.value.equals(value)) return v; + } + throw new IllegalArgumentException("Unknown FusionConversationScope value: " + value); + } +} diff --git a/java/sdk/src/generated/java/com/github/copilot/generated/FusionFollowUpAction.java b/java/sdk/src/generated/java/com/github/copilot/generated/FusionFollowUpAction.java new file mode 100644 index 0000000000..e54bf4604f --- /dev/null +++ b/java/sdk/src/generated/java/com/github/copilot/generated/FusionFollowUpAction.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; + +/** + * Server-recommended routing behavior for a later HydraFusion turn. + * + * @since 1.0.0 + */ +@javax.annotation.processing.Generated("copilot-sdk-codegen") +public enum FusionFollowUpAction { + /** The {@code reuse_primary} variant. */ + REUSE_PRIMARY("reuse_primary"), + /** The {@code reroute} variant. */ + REROUTE("reroute"); + + private final String value; + FusionFollowUpAction(String value) { this.value = value; } + @com.fasterxml.jackson.annotation.JsonValue + public String getValue() { return value; } + @com.fasterxml.jackson.annotation.JsonCreator + public static FusionFollowUpAction fromValue(String value) { + for (FusionFollowUpAction v : values()) { + if (v.value.equals(value)) return v; + } + throw new IllegalArgumentException("Unknown FusionFollowUpAction value: " + value); + } +} diff --git a/java/sdk/src/generated/java/com/github/copilot/generated/FusionFollowUpRecommendation.java b/java/sdk/src/generated/java/com/github/copilot/generated/FusionFollowUpRecommendation.java new file mode 100644 index 0000000000..101d497fb2 --- /dev/null +++ b/java/sdk/src/generated/java/com/github/copilot/generated/FusionFollowUpRecommendation.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; + +/** + * Durable server recommendation for subsequent HydraFusion turns. + * + * @since 1.0.0 + */ +@javax.annotation.processing.Generated("copilot-sdk-codegen") +@JsonInclude(JsonInclude.Include.NON_NULL) +@JsonIgnoreProperties(ignoreUnknown = true) +public record FusionFollowUpRecommendation( + /** Recommended routing action for the next user-message turn. */ + @JsonProperty("userTurn") FusionFollowUpAction userTurn, + /** Recommended routing action for the next compaction turn. */ + @JsonProperty("compactionTurn") FusionFollowUpAction compactionTurn +) { +} diff --git a/java/sdk/src/generated/java/com/github/copilot/generated/FusionPattern.java b/java/sdk/src/generated/java/com/github/copilot/generated/FusionPattern.java new file mode 100644 index 0000000000..d37ef4ee83 --- /dev/null +++ b/java/sdk/src/generated/java/com/github/copilot/generated/FusionPattern.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; + +/** + * Validated HydraFusion execution pattern. + * + * @since 1.0.0 + */ +@javax.annotation.processing.Generated("copilot-sdk-codegen") +public enum FusionPattern { + /** The {@code single} variant. */ + SINGLE("single"), + /** The {@code cascade} variant. */ + CASCADE("cascade"), + /** The {@code critique} variant. */ + CRITIQUE("critique"); + + private final String value; + FusionPattern(String value) { this.value = value; } + @com.fasterxml.jackson.annotation.JsonValue + public String getValue() { return value; } + @com.fasterxml.jackson.annotation.JsonCreator + public static FusionPattern fromValue(String value) { + for (FusionPattern v : values()) { + if (v.value.equals(value)) return v; + } + throw new IllegalArgumentException("Unknown FusionPattern value: " + value); + } +} diff --git a/java/sdk/src/generated/java/com/github/copilot/generated/FusionPhaseKind.java b/java/sdk/src/generated/java/com/github/copilot/generated/FusionPhaseKind.java new file mode 100644 index 0000000000..ead79b75fc --- /dev/null +++ b/java/sdk/src/generated/java/com/github/copilot/generated/FusionPhaseKind.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; + +/** + * HydraFusion phase kind. + * + * @since 1.0.0 + */ +@javax.annotation.processing.Generated("copilot-sdk-codegen") +public enum FusionPhaseKind { + /** The {@code primary} variant. */ + PRIMARY("primary"), + /** The {@code judge} variant. */ + JUDGE("judge"), + /** The {@code repair} variant. */ + REPAIR("repair"), + /** The {@code draft} variant. */ + DRAFT("draft"), + /** The {@code critic} variant. */ + CRITIC("critic"), + /** The {@code revision} variant. */ + REVISION("revision"), + /** The {@code follow_up} variant. */ + FOLLOW_UP("follow_up"); + + private final String value; + FusionPhaseKind(String value) { this.value = value; } + @com.fasterxml.jackson.annotation.JsonValue + public String getValue() { return value; } + @com.fasterxml.jackson.annotation.JsonCreator + public static FusionPhaseKind fromValue(String value) { + for (FusionPhaseKind v : values()) { + if (v.value.equals(value)) return v; + } + throw new IllegalArgumentException("Unknown FusionPhaseKind value: " + value); + } +} diff --git a/java/sdk/src/generated/java/com/github/copilot/generated/FusionPhaseStatus.java b/java/sdk/src/generated/java/com/github/copilot/generated/FusionPhaseStatus.java new file mode 100644 index 0000000000..f670332b5c --- /dev/null +++ b/java/sdk/src/generated/java/com/github/copilot/generated/FusionPhaseStatus.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; + +/** + * Durable outcome status of a HydraFusion phase. + * + * @since 1.0.0 + */ +@javax.annotation.processing.Generated("copilot-sdk-codegen") +public enum FusionPhaseStatus { + /** The {@code succeeded} variant. */ + SUCCEEDED("succeeded"), + /** The {@code failed} variant. */ + FAILED("failed"), + /** The {@code cancelled} variant. */ + CANCELLED("cancelled"); + + private final String value; + FusionPhaseStatus(String value) { this.value = value; } + @com.fasterxml.jackson.annotation.JsonValue + public String getValue() { return value; } + @com.fasterxml.jackson.annotation.JsonCreator + public static FusionPhaseStatus fromValue(String value) { + for (FusionPhaseStatus v : values()) { + if (v.value.equals(value)) return v; + } + throw new IllegalArgumentException("Unknown FusionPhaseStatus value: " + value); + } +} diff --git a/java/sdk/src/generated/java/com/github/copilot/generated/FusionPhaseUsage.java b/java/sdk/src/generated/java/com/github/copilot/generated/FusionPhaseUsage.java new file mode 100644 index 0000000000..4a707bb69e --- /dev/null +++ b/java/sdk/src/generated/java/com/github/copilot/generated/FusionPhaseUsage.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 com.fasterxml.jackson.annotation.JsonIgnoreProperties; +import com.fasterxml.jackson.annotation.JsonInclude; +import com.fasterxml.jackson.annotation.JsonProperty; +import javax.annotation.processing.Generated; + +/** + * Aggregate concrete-model usage for one HydraFusion phase. + * + * @since 1.0.0 + */ +@javax.annotation.processing.Generated("copilot-sdk-codegen") +@JsonInclude(JsonInclude.Include.NON_NULL) +@JsonIgnoreProperties(ignoreUnknown = true) +public record FusionPhaseUsage( + /** Number of concrete model requests made by the phase. */ + @JsonProperty("requestCount") Long requestCount, + /** Total input tokens consumed by the phase. */ + @JsonProperty("inputTokens") Long inputTokens, + /** Total output tokens produced by the phase. */ + @JsonProperty("outputTokens") Long outputTokens, + /** Total cached input tokens reported for the phase. */ + @JsonProperty("cachedTokens") Long cachedTokens, + /** Total tokens written to prompt cache during the phase. */ + @JsonProperty("cacheWriteTokens") Long cacheWriteTokens, + /** Total normalized AI-unit cost reported for the phase, in nano-AIU. */ + @JsonProperty("totalNanoAiu") Double totalNanoAiu +) { +} diff --git a/java/sdk/src/generated/java/com/github/copilot/generated/FusionProjectionMode.java b/java/sdk/src/generated/java/com/github/copilot/generated/FusionProjectionMode.java new file mode 100644 index 0000000000..9681efc0ba --- /dev/null +++ b/java/sdk/src/generated/java/com/github/copilot/generated/FusionProjectionMode.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 a durable phase checkpoint contributes its exact message to canonical root history. + * + * @since 1.0.0 + */ +@javax.annotation.processing.Generated("copilot-sdk-codegen") +public enum FusionProjectionMode { + /** The {@code append} variant. */ + APPEND("append"), + /** The {@code staged} variant. */ + STAGED("staged"), + /** The {@code none} variant. */ + NONE("none"); + + private final String value; + FusionProjectionMode(String value) { this.value = value; } + @com.fasterxml.jackson.annotation.JsonValue + public String getValue() { return value; } + @com.fasterxml.jackson.annotation.JsonCreator + public static FusionProjectionMode fromValue(String value) { + for (FusionProjectionMode v : values()) { + if (v.value.equals(value)) return v; + } + throw new IllegalArgumentException("Unknown FusionProjectionMode value: " + value); + } +} diff --git a/java/sdk/src/generated/java/com/github/copilot/generated/FusionScores.java b/java/sdk/src/generated/java/com/github/copilot/generated/FusionScores.java new file mode 100644 index 0000000000..eefb8190a1 --- /dev/null +++ b/java/sdk/src/generated/java/com/github/copilot/generated/FusionScores.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; + +/** + * Validated HydraFusion routing capability scores. + * + * @since 1.0.0 + */ +@javax.annotation.processing.Generated("copilot-sdk-codegen") +@JsonInclude(JsonInclude.Include.NON_NULL) +@JsonIgnoreProperties(ignoreUnknown = true) +public record FusionScores( + /** Reasoning capability score returned by the authenticated router. */ + @JsonProperty("reasoning") Double reasoning, + /** Code-generation capability score returned by the authenticated router. */ + @JsonProperty("codeGen") Double codeGen, + /** Debugging capability score returned by the authenticated router. */ + @JsonProperty("debugging") Double debugging, + /** Tool-use capability score returned by the authenticated router. */ + @JsonProperty("toolUse") Double toolUse +) { +} diff --git a/java/sdk/src/generated/java/com/github/copilot/generated/FusionStagedTerminal.java b/java/sdk/src/generated/java/com/github/copilot/generated/FusionStagedTerminal.java new file mode 100644 index 0000000000..262c8c664b --- /dev/null +++ b/java/sdk/src/generated/java/com/github/copilot/generated/FusionStagedTerminal.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 javax.annotation.processing.Generated; + +/** + * Internal durable terminal request staged by a HydraFusion phase until an idempotent final commit selects it. + * + * @since 1.0.0 + */ +@javax.annotation.processing.Generated("copilot-sdk-codegen") +@JsonInclude(JsonInclude.Include.NON_NULL) +@JsonIgnoreProperties(ignoreUnknown = true) +public record FusionStagedTerminal( + @JsonProperty("assistantMessage") Object assistantMessage, + @JsonProperty("toolName") String toolName, + @JsonProperty("toolCallId") String toolCallId, + @JsonProperty("arguments") String arguments, + @JsonProperty("phaseId") String phaseId +) { +} diff --git a/java/sdk/src/generated/java/com/github/copilot/generated/FusionTurnKind.java b/java/sdk/src/generated/java/com/github/copilot/generated/FusionTurnKind.java new file mode 100644 index 0000000000..24e39b976c --- /dev/null +++ b/java/sdk/src/generated/java/com/github/copilot/generated/FusionTurnKind.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; + +/** + * Kind of turn for which HydraFusion routing is running. + * + * @since 1.0.0 + */ +@javax.annotation.processing.Generated("copilot-sdk-codegen") +public enum FusionTurnKind { + /** The {@code user} variant. */ + USER("user"), + /** The {@code compaction} variant. */ + COMPACTION("compaction"); + + private final String value; + FusionTurnKind(String value) { this.value = value; } + @com.fasterxml.jackson.annotation.JsonValue + public String getValue() { return value; } + @com.fasterxml.jackson.annotation.JsonCreator + public static FusionTurnKind fromValue(String value) { + for (FusionTurnKind v : values()) { + if (v.value.equals(value)) return v; + } + throw new IllegalArgumentException("Unknown FusionTurnKind value: " + value); + } +} 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 0000000000..afa69b9856 --- /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/src/generated/java/com/github/copilot/generated/HeaderEntry.java b/java/sdk/src/generated/java/com/github/copilot/generated/HeaderEntry.java similarity index 100% rename from java/src/generated/java/com/github/copilot/generated/HeaderEntry.java rename to java/sdk/src/generated/java/com/github/copilot/generated/HeaderEntry.java 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 100% 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 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 89% 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 cd081dc87f..8d4afe7a1d 100644 --- a/java/src/generated/java/com/github/copilot/generated/HookEndEvent.java +++ b/java/sdk/src/generated/java/com/github/copilot/generated/HookEndEvent.java @@ -43,7 +43,9 @@ public record HookEndEventData( /** Whether the hook completed successfully */ @JsonProperty("success") Boolean success, /** Error details when the hook failed */ - @JsonProperty("error") HookEndError error + @JsonProperty("error") HookEndError error, + /** 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/HookProgressEvent.java b/java/sdk/src/generated/java/com/github/copilot/generated/HookProgressEvent.java similarity index 100% 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 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 88% 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 4c5de1a1d6..3b8b41fafb 100644 --- a/java/src/generated/java/com/github/copilot/generated/HookStartEvent.java +++ b/java/sdk/src/generated/java/com/github/copilot/generated/HookStartEvent.java @@ -39,7 +39,9 @@ public record HookStartEventData( /** Type of hook being invoked (e.g., "preToolUse", "postToolUse", "sessionStart") */ @JsonProperty("hookType") String hookType, /** Input data passed to the hook */ - @JsonProperty("input") Object input + @JsonProperty("input") Object input, + /** 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/ManagedSettingsEnforcedAction.java b/java/sdk/src/generated/java/com/github/copilot/generated/ManagedSettingsEnforcedAction.java similarity index 100% rename from java/src/generated/java/com/github/copilot/generated/ManagedSettingsEnforcedAction.java rename to java/sdk/src/generated/java/com/github/copilot/generated/ManagedSettingsEnforcedAction.java diff --git a/java/src/generated/java/com/github/copilot/generated/ManagedSettingsEnforcedEscalation.java b/java/sdk/src/generated/java/com/github/copilot/generated/ManagedSettingsEnforcedEscalation.java similarity index 85% rename from java/src/generated/java/com/github/copilot/generated/ManagedSettingsEnforcedEscalation.java rename to java/sdk/src/generated/java/com/github/copilot/generated/ManagedSettingsEnforcedEscalation.java index cdeea72b4f..619fb326e1 100644 --- a/java/src/generated/java/com/github/copilot/generated/ManagedSettingsEnforcedEscalation.java +++ b/java/sdk/src/generated/java/com/github/copilot/generated/ManagedSettingsEnforcedEscalation.java @@ -20,12 +20,14 @@ public enum ManagedSettingsEnforcedEscalation { ALLOW_ALL("allow_all"), /** The {@code approve_all} variant. */ APPROVE_ALL("approve_all"), - /** The {@code auto_approval} variant. */ - AUTO_APPROVAL("auto_approval"), + /** The {@code assisted_approval} variant. */ + ASSISTED_APPROVAL("assisted_approval"), /** The {@code unrestricted_paths} variant. */ UNRESTRICTED_PATHS("unrestricted_paths"), /** The {@code unrestricted_urls} variant. */ - UNRESTRICTED_URLS("unrestricted_urls"); + UNRESTRICTED_URLS("unrestricted_urls"), + /** The {@code server_wide_mcp_approval} variant. */ + SERVER_WIDE_MCP_APPROVAL("server_wide_mcp_approval"); private final String value; ManagedSettingsEnforcedEscalation(String value) { this.value = value; } diff --git a/java/src/generated/java/com/github/copilot/generated/ManagedSettingsResolvedSource.java b/java/sdk/src/generated/java/com/github/copilot/generated/ManagedSettingsResolvedSource.java similarity index 83% rename from java/src/generated/java/com/github/copilot/generated/ManagedSettingsResolvedSource.java rename to java/sdk/src/generated/java/com/github/copilot/generated/ManagedSettingsResolvedSource.java index 1ffa100635..32386f898a 100644 --- a/java/src/generated/java/com/github/copilot/generated/ManagedSettingsResolvedSource.java +++ b/java/sdk/src/generated/java/com/github/copilot/generated/ManagedSettingsResolvedSource.java @@ -10,7 +10,7 @@ import javax.annotation.processing.Generated; /** - * Which channel supplied the effective enterprise managed settings (highest-authority present layer wins wholesale) + * Summary of which managed-settings channels contributed to the effective session policy. Use the per-channel booleans for exact provenance. * * @since 1.0.0 */ @@ -20,6 +20,10 @@ public enum ManagedSettingsResolvedSource { 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"); 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 100% 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 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 100% 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 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 100% 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 diff --git a/java/src/generated/java/com/github/copilot/generated/McpHeadersRefreshCompletedEvent.java b/java/sdk/src/generated/java/com/github/copilot/generated/McpHeadersRefreshCompletedEvent.java similarity index 100% rename from java/src/generated/java/com/github/copilot/generated/McpHeadersRefreshCompletedEvent.java rename to java/sdk/src/generated/java/com/github/copilot/generated/McpHeadersRefreshCompletedEvent.java diff --git a/java/src/generated/java/com/github/copilot/generated/McpHeadersRefreshCompletedOutcome.java b/java/sdk/src/generated/java/com/github/copilot/generated/McpHeadersRefreshCompletedOutcome.java similarity index 100% rename from java/src/generated/java/com/github/copilot/generated/McpHeadersRefreshCompletedOutcome.java rename to java/sdk/src/generated/java/com/github/copilot/generated/McpHeadersRefreshCompletedOutcome.java diff --git a/java/src/generated/java/com/github/copilot/generated/McpHeadersRefreshRequiredEvent.java b/java/sdk/src/generated/java/com/github/copilot/generated/McpHeadersRefreshRequiredEvent.java similarity index 100% rename from java/src/generated/java/com/github/copilot/generated/McpHeadersRefreshRequiredEvent.java rename to java/sdk/src/generated/java/com/github/copilot/generated/McpHeadersRefreshRequiredEvent.java diff --git a/java/src/generated/java/com/github/copilot/generated/McpHeadersRefreshRequiredReason.java b/java/sdk/src/generated/java/com/github/copilot/generated/McpHeadersRefreshRequiredReason.java similarity index 100% rename from java/src/generated/java/com/github/copilot/generated/McpHeadersRefreshRequiredReason.java rename to java/sdk/src/generated/java/com/github/copilot/generated/McpHeadersRefreshRequiredReason.java 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 100% 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 diff --git a/java/src/generated/java/com/github/copilot/generated/McpOauthCompletionOutcome.java b/java/sdk/src/generated/java/com/github/copilot/generated/McpOauthCompletionOutcome.java similarity index 100% rename from java/src/generated/java/com/github/copilot/generated/McpOauthCompletionOutcome.java rename to java/sdk/src/generated/java/com/github/copilot/generated/McpOauthCompletionOutcome.java diff --git a/java/src/generated/java/com/github/copilot/generated/McpOauthHttpResponse.java b/java/sdk/src/generated/java/com/github/copilot/generated/McpOauthHttpResponse.java similarity index 100% rename from java/src/generated/java/com/github/copilot/generated/McpOauthHttpResponse.java rename to java/sdk/src/generated/java/com/github/copilot/generated/McpOauthHttpResponse.java diff --git a/java/src/generated/java/com/github/copilot/generated/McpOauthRequestReason.java b/java/sdk/src/generated/java/com/github/copilot/generated/McpOauthRequestReason.java similarity index 100% rename from java/src/generated/java/com/github/copilot/generated/McpOauthRequestReason.java rename to java/sdk/src/generated/java/com/github/copilot/generated/McpOauthRequestReason.java diff --git a/java/src/generated/java/com/github/copilot/generated/McpOauthRequiredEvent.java b/java/sdk/src/generated/java/com/github/copilot/generated/McpOauthRequiredEvent.java similarity index 100% rename from java/src/generated/java/com/github/copilot/generated/McpOauthRequiredEvent.java rename to java/sdk/src/generated/java/com/github/copilot/generated/McpOauthRequiredEvent.java 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 100% 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 diff --git a/java/src/generated/java/com/github/copilot/generated/McpOauthWWWAuthenticateParams.java b/java/sdk/src/generated/java/com/github/copilot/generated/McpOauthWWWAuthenticateParams.java similarity index 100% rename from java/src/generated/java/com/github/copilot/generated/McpOauthWWWAuthenticateParams.java rename to java/sdk/src/generated/java/com/github/copilot/generated/McpOauthWWWAuthenticateParams.java diff --git a/java/src/generated/java/com/github/copilot/generated/McpPromptsListChangedEvent.java b/java/sdk/src/generated/java/com/github/copilot/generated/McpPromptsListChangedEvent.java similarity index 100% rename from java/src/generated/java/com/github/copilot/generated/McpPromptsListChangedEvent.java rename to java/sdk/src/generated/java/com/github/copilot/generated/McpPromptsListChangedEvent.java diff --git a/java/src/generated/java/com/github/copilot/generated/McpResourcesListChangedEvent.java b/java/sdk/src/generated/java/com/github/copilot/generated/McpResourcesListChangedEvent.java similarity index 100% rename from java/src/generated/java/com/github/copilot/generated/McpResourcesListChangedEvent.java rename to java/sdk/src/generated/java/com/github/copilot/generated/McpResourcesListChangedEvent.java 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/src/generated/java/com/github/copilot/generated/McpServerStatus.java b/java/sdk/src/generated/java/com/github/copilot/generated/McpServerStatus.java similarity index 93% rename from java/src/generated/java/com/github/copilot/generated/McpServerStatus.java rename to java/sdk/src/generated/java/com/github/copilot/generated/McpServerStatus.java index b5bb080935..f11cebdc96 100644 --- a/java/src/generated/java/com/github/copilot/generated/McpServerStatus.java +++ b/java/sdk/src/generated/java/com/github/copilot/generated/McpServerStatus.java @@ -10,7 +10,7 @@ import javax.annotation.processing.Generated; /** - * Connection status: connected, failed, needs-auth, pending, disabled, or not_configured + * Connection status: connected, failed, needs-auth, pending, disabled, stopped, or not_configured * * @since 1.0.0 */ @@ -26,6 +26,8 @@ public enum McpServerStatus { PENDING("pending"), /** The {@code disabled} variant. */ DISABLED("disabled"), + /** The {@code stopped} variant. */ + STOPPED("stopped"), /** The {@code not_configured} variant. */ NOT_CONFIGURED("not_configured"); 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 97% 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 1a2f05023e..c4567f30fa 100644 --- a/java/src/generated/java/com/github/copilot/generated/McpServersLoadedServer.java +++ b/java/sdk/src/generated/java/com/github/copilot/generated/McpServersLoadedServer.java @@ -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/src/generated/java/com/github/copilot/generated/McpToolsListChangedEvent.java b/java/sdk/src/generated/java/com/github/copilot/generated/McpToolsListChangedEvent.java similarity index 100% rename from java/src/generated/java/com/github/copilot/generated/McpToolsListChangedEvent.java rename to java/sdk/src/generated/java/com/github/copilot/generated/McpToolsListChangedEvent.java diff --git a/java/src/generated/java/com/github/copilot/generated/ModelCallFailureBadRequestKind.java b/java/sdk/src/generated/java/com/github/copilot/generated/ModelCallFailureBadRequestKind.java similarity index 100% rename from java/src/generated/java/com/github/copilot/generated/ModelCallFailureBadRequestKind.java rename to java/sdk/src/generated/java/com/github/copilot/generated/ModelCallFailureBadRequestKind.java diff --git a/java/src/generated/java/com/github/copilot/generated/ModelCallFailureEvent.java b/java/sdk/src/generated/java/com/github/copilot/generated/ModelCallFailureEvent.java similarity index 87% rename from java/src/generated/java/com/github/copilot/generated/ModelCallFailureEvent.java rename to java/sdk/src/generated/java/com/github/copilot/generated/ModelCallFailureEvent.java index 25c011fe33..d3049cd472 100644 --- a/java/src/generated/java/com/github/copilot/generated/ModelCallFailureEvent.java +++ b/java/sdk/src/generated/java/com/github/copilot/generated/ModelCallFailureEvent.java @@ -45,6 +45,8 @@ public record ModelCallFailureEventData( @JsonProperty("providerCallId") String providerCallId, /** Copilot service request ID (x-copilot-service-request-id header) for CAPI log correlation */ @JsonProperty("serviceRequestId") String serviceRequestId, + /** Per-request treatment/eligibility signal returned by the Copilot API in the `X-GitHub-Copilot-Request-TE` response header for the associated model call; `false` when the header was absent or unparseable. */ + @JsonProperty("rte") Boolean rte, /** HTTP status code from the failed request */ @JsonProperty("statusCode") Long statusCode, /** Duration of the failed API call in milliseconds */ @@ -65,6 +67,8 @@ public record ModelCallFailureEventData( @JsonProperty("isAuto") Boolean isAuto, /** Reasoning effort level used for the failed model call, if applicable */ @JsonProperty("reasoningEffort") String reasoningEffort, + /** Authoritative interaction classification for the failed call, matching `assistant.usage.interactionType` (for example `conversation-agent`, `conversation-subagent`, or `conversation-sampling`). Absent when the producer cannot classify the interaction. */ + @JsonProperty("interactionType") String interactionType, /** Where the failed model call originated */ @JsonProperty("source") ModelCallFailureSource source, /** Raw provider/runtime error message for restricted telemetry */ @@ -78,7 +82,9 @@ public record ModelCallFailureEventData( /** 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 + @JsonProperty("requestFingerprint") ModelCallFailureRequestFingerprint requestFingerprint, + /** Experimental HydraFusion attribution for this failed concrete model call. */ + @JsonProperty("fusion") FusionAttribution fusion ) { } } diff --git a/java/src/generated/java/com/github/copilot/generated/ModelCallFailureKind.java b/java/sdk/src/generated/java/com/github/copilot/generated/ModelCallFailureKind.java similarity index 100% rename from java/src/generated/java/com/github/copilot/generated/ModelCallFailureKind.java rename to java/sdk/src/generated/java/com/github/copilot/generated/ModelCallFailureKind.java diff --git a/java/src/generated/java/com/github/copilot/generated/ModelCallFailureRequestFingerprint.java b/java/sdk/src/generated/java/com/github/copilot/generated/ModelCallFailureRequestFingerprint.java similarity index 100% rename from java/src/generated/java/com/github/copilot/generated/ModelCallFailureRequestFingerprint.java rename to java/sdk/src/generated/java/com/github/copilot/generated/ModelCallFailureRequestFingerprint.java 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/src/generated/java/com/github/copilot/generated/ModelCallFailureTransport.java b/java/sdk/src/generated/java/com/github/copilot/generated/ModelCallFailureTransport.java similarity index 100% rename from java/src/generated/java/com/github/copilot/generated/ModelCallFailureTransport.java rename to java/sdk/src/generated/java/com/github/copilot/generated/ModelCallFailureTransport.java diff --git a/java/sdk/src/generated/java/com/github/copilot/generated/ModelCallFinishedEvent.java b/java/sdk/src/generated/java/com/github/copilot/generated/ModelCallFinishedEvent.java new file mode 100644 index 0000000000..a1b424e807 --- /dev/null +++ b/java/sdk/src/generated/java/com/github/copilot/generated/ModelCallFinishedEvent.java @@ -0,0 +1,51 @@ +/*--------------------------------------------------------------------------------------------- + * 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_finished". Final lifecycle outcome for one logical model dispatch. A logical dispatch may include internal reconnect or fallback work, so event count is not provider HTTP-request count. + * @since 1.0.0 + */ +@JsonIgnoreProperties(ignoreUnknown = true) +@JsonInclude(JsonInclude.Include.NON_NULL) +@javax.annotation.processing.Generated("copilot-sdk-codegen") +public final class ModelCallFinishedEvent extends SessionEvent { + + @Override + public String getType() { return "model.call_finished"; } + + @JsonProperty("data") + private ModelCallFinishedEventData data; + + public ModelCallFinishedEventData getData() { return data; } + public void setData(ModelCallFinishedEventData data) { this.data = data; } + + /** Data payload for {@link ModelCallFinishedEvent}. */ + @JsonIgnoreProperties(ignoreUnknown = true) + @JsonInclude(JsonInclude.Include.NON_NULL) + public record ModelCallFinishedEventData( + /** Agent-loop iteration within the interaction that initiated the model dispatch */ + @JsonProperty("turnId") String turnId, + /** Identifier of the user interaction that owns the model dispatch, matching assistant.turn_start.interactionId when available */ + @JsonProperty("interactionId") String interactionId, + /** Monotonic elapsed time spent in the logical model dispatch, including any internal transport reconnect or fallback and excluding orchestrator retry backoff, tool execution, confirmations, and post-response processing */ + @JsonProperty("dispatchDurationMs") Double dispatchDurationMs, + /** Final outcome after post-response acceptance processing */ + @JsonProperty("outcome") ModelCallFinishedOutcome outcome, + /** Whether an accepted successful response requested the exact name and command semantics of a built-in file edit tool, including an external tool explicitly replacing that built-in name. Absent when the logical dispatch did not produce an accepted response. */ + @JsonProperty("containsBuiltInFileEditRequest") Boolean containsBuiltInFileEditRequest, + /** Version of the built-in file-edit semantic classifier used for this event */ + @JsonProperty("editClassifierVersion") Long editClassifierVersion + ) { + } +} diff --git a/java/sdk/src/generated/java/com/github/copilot/generated/ModelCallFinishedOutcome.java b/java/sdk/src/generated/java/com/github/copilot/generated/ModelCallFinishedOutcome.java new file mode 100644 index 0000000000..8b86ed0281 --- /dev/null +++ b/java/sdk/src/generated/java/com/github/copilot/generated/ModelCallFinishedOutcome.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; + +/** + * Final outcome of one logical model dispatch after response acceptance processing + * + * @since 1.0.0 + */ +@javax.annotation.processing.Generated("copilot-sdk-codegen") +public enum ModelCallFinishedOutcome { + /** The {@code success} variant. */ + SUCCESS("success"), + /** The {@code error} variant. */ + ERROR("error"), + /** The {@code cancelled} variant. */ + CANCELLED("cancelled"), + /** The {@code rejected} variant. */ + REJECTED("rejected"); + + private final String value; + ModelCallFinishedOutcome(String value) { this.value = value; } + @com.fasterxml.jackson.annotation.JsonValue + public String getValue() { return value; } + @com.fasterxml.jackson.annotation.JsonCreator + public static ModelCallFinishedOutcome fromValue(String value) { + for (ModelCallFinishedOutcome v : values()) { + if (v.value.equals(value)) return v; + } + throw new IllegalArgumentException("Unknown ModelCallFinishedOutcome value: " + value); + } +} diff --git a/java/src/generated/java/com/github/copilot/generated/ModelCallStartEvent.java b/java/sdk/src/generated/java/com/github/copilot/generated/ModelCallStartEvent.java similarity index 81% rename from java/src/generated/java/com/github/copilot/generated/ModelCallStartEvent.java rename to java/sdk/src/generated/java/com/github/copilot/generated/ModelCallStartEvent.java index 6ab9fa5477..a68e455420 100644 --- a/java/src/generated/java/com/github/copilot/generated/ModelCallStartEvent.java +++ b/java/sdk/src/generated/java/com/github/copilot/generated/ModelCallStartEvent.java @@ -37,7 +37,11 @@ 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 + @JsonProperty("model") String model, + /** Previous response or interaction identifier included in the model request, when present */ + @JsonProperty("previousResponseId") String previousResponseId, + /** Experimental HydraFusion attribution for this concrete model call. */ + @JsonProperty("fusion") FusionAttribution fusion ) { } } diff --git a/java/sdk/src/generated/java/com/github/copilot/generated/ModelChangeSource.java b/java/sdk/src/generated/java/com/github/copilot/generated/ModelChangeSource.java new file mode 100644 index 0000000000..0d54709de8 --- /dev/null +++ b/java/sdk/src/generated/java/com/github/copilot/generated/ModelChangeSource.java @@ -0,0 +1,53 @@ +/*--------------------------------------------------------------------------------------------- + * 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; + +/** + * Origin of an effective session model change. + * + * @since 1.0.0 + */ +@javax.annotation.processing.Generated("copilot-sdk-codegen") +public enum ModelChangeSource { + /** The {@code model_command} variant. */ + MODEL_COMMAND("model_command"), + /** The {@code settings_command} variant. */ + SETTINGS_COMMAND("settings_command"), + /** The {@code config_command} variant. */ + CONFIG_COMMAND("config_command"), + /** The {@code model_picker} variant. */ + MODEL_PICKER("model_picker"), + /** The {@code managed_settings} variant. */ + MANAGED_SETTINGS("managed_settings"), + /** The {@code repo_settings} variant. */ + REPO_SETTINGS("repo_settings"), + /** The {@code startup} variant. */ + STARTUP("startup"), + /** The {@code agent} variant. */ + AGENT("agent"), + /** The {@code plan_mode} variant. */ + PLAN_MODE("plan_mode"), + /** The {@code automatic} variant. */ + AUTOMATIC("automatic"), + /** The {@code sdk} variant. */ + SDK("sdk"); + + private final String value; + ModelChangeSource(String value) { this.value = value; } + @com.fasterxml.jackson.annotation.JsonValue + public String getValue() { return value; } + @com.fasterxml.jackson.annotation.JsonCreator + public static ModelChangeSource fromValue(String value) { + for (ModelChangeSource v : values()) { + if (v.value.equals(value)) return v; + } + throw new IllegalArgumentException("Unknown ModelChangeSource value: " + value); + } +} 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 100% 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 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 100% 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 diff --git a/java/sdk/src/generated/java/com/github/copilot/generated/PermissionMode.java b/java/sdk/src/generated/java/com/github/copilot/generated/PermissionMode.java new file mode 100644 index 0000000000..421ad76139 --- /dev/null +++ b/java/sdk/src/generated/java/com/github/copilot/generated/PermissionMode.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; + +/** + * Permission mode for the session. + * + * @since 1.0.0 + */ +@javax.annotation.processing.Generated("copilot-sdk-codegen") +public enum PermissionMode { + /** The {@code manual} variant. */ + MANUAL("manual"), + /** The {@code assisted} variant. */ + ASSISTED("assisted"), + /** The {@code allow-all} variant. */ + ALLOW_ALL("allow-all"); + + private final String value; + PermissionMode(String value) { this.value = value; } + @com.fasterxml.jackson.annotation.JsonValue + public String getValue() { return value; } + @com.fasterxml.jackson.annotation.JsonCreator + public static PermissionMode fromValue(String value) { + for (PermissionMode v : values()) { + if (v.value.equals(value)) return v; + } + throw new IllegalArgumentException("Unknown PermissionMode value: " + value); + } +} 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 98eecceb58..b7aae9ec80 100644 --- a/java/src/generated/java/com/github/copilot/generated/PermissionRequestedEvent.java +++ b/java/sdk/src/generated/java/com/github/copilot/generated/PermissionRequestedEvent.java @@ -40,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/sdk/src/generated/java/com/github/copilot/generated/PromptCacheBreakEvent.java b/java/sdk/src/generated/java/com/github/copilot/generated/PromptCacheBreakEvent.java new file mode 100644 index 0000000000..7ad39dec97 --- /dev/null +++ b/java/sdk/src/generated/java/com/github/copilot/generated/PromptCacheBreakEvent.java @@ -0,0 +1,86 @@ +/*--------------------------------------------------------------------------------------------- + * 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 "prompt_cache_break". A detected loss of a previously cached prompt prefix + * @since 1.0.0 + */ +@JsonIgnoreProperties(ignoreUnknown = true) +@JsonInclude(JsonInclude.Include.NON_NULL) +@javax.annotation.processing.Generated("copilot-sdk-codegen") +public final class PromptCacheBreakEvent extends SessionEvent { + + @Override + public String getType() { return "prompt_cache_break"; } + + @JsonProperty("data") + private PromptCacheBreakEventData data; + + public PromptCacheBreakEventData getData() { return data; } + public void setData(PromptCacheBreakEventData data) { this.data = data; } + + /** Data payload for {@link PromptCacheBreakEvent}. */ + @JsonIgnoreProperties(ignoreUnknown = true) + @JsonInclude(JsonInclude.Include.NON_NULL) + public record PromptCacheBreakEventData( + /** The highest-precedence reason for the cache break */ + @JsonProperty("primaryReason") String primaryReason, + /** All reasons that contributed to the cache break, ordered by precedence */ + @JsonProperty("contributingReasons") List contributingReasons, + /** Request state that established the prior cache frontier */ + @JsonProperty("beforeRequest") Object beforeRequest, + /** Request state whose cached prefix fell short */ + @JsonProperty("afterRequest") Object afterRequest, + /** Number of cached prefix tokens that survived */ + @JsonProperty("survivedTokens") Long survivedTokens, + /** Prior cached prompt frontier in tokens */ + @JsonProperty("frontierTokens") Long frontierTokens, + /** Cached prefix tokens lost since the prior call */ + @JsonProperty("shortfallTokens") Long shortfallTokens, + /** Fraction of the prior cache frontier that survived */ + @JsonProperty("retentionRatio") Double retentionRatio, + /** Model that held the prior cache frontier, when the call changed models */ + @JsonProperty("modelFrom") String modelFrom, + /** Model this call targeted, when the call changed models */ + @JsonProperty("modelTo") String modelTo, + /** Telemetry-safe names of tools added since the prior call */ + @JsonProperty("toolsAdded") List toolsAdded, + /** Telemetry-safe names of tools removed since the prior call */ + @JsonProperty("toolsRemoved") List toolsRemoved, + /** Telemetry-safe names of tools whose definition changed since the prior call */ + @JsonProperty("toolsRedefined") List toolsRedefined, + /** Raw names of tools added since the prior call, restricted because a tool name can be user-authored */ + @JsonProperty("toolsAddedRaw") List toolsAddedRaw, + /** Raw names of tools removed since the prior call, restricted because a tool name can be user-authored */ + @JsonProperty("toolsRemovedRaw") List toolsRemovedRaw, + /** Raw names of tools redefined since the prior call, restricted because a tool name can be user-authored */ + @JsonProperty("toolsRedefinedRaw") List toolsRedefinedRaw, + /** Whether the tool list kept its members but changed their order */ + @JsonProperty("toolsReordered") Boolean toolsReordered, + /** Names of the system-prompt segments whose content changed */ + @JsonProperty("systemSegmentsChanged") List systemSegmentsChanged, + /** Names of the cache-configuration fields that changed */ + @JsonProperty("cacheConfigChangedFields") List cacheConfigChangedFields, + /** Index of the first conversation message whose content changed */ + @JsonProperty("rewriteMessageIndex") Long rewriteMessageIndex, + /** Shape of the history rewrite, for example whether the history grew or shrank */ + @JsonProperty("rewriteShape") String rewriteShape, + /** Subsystems that announced a history rewrite before this call, for example compaction or truncation */ + @JsonProperty("rewriteSource") List rewriteSource, + /** Name of the sub-agent whose conversation broke, stamped by the parent bridge */ + @JsonProperty("agentName") String agentName + ) { + } +} 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 100% 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 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 100% 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 diff --git a/java/sdk/src/generated/java/com/github/copilot/generated/SandboxDecisionEvent.java b/java/sdk/src/generated/java/com/github/copilot/generated/SandboxDecisionEvent.java new file mode 100644 index 0000000000..f87be0fe9d --- /dev/null +++ b/java/sdk/src/generated/java/com/github/copilot/generated/SandboxDecisionEvent.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 "sandbox.decision". Payload of `sandbox.decision`, a bounded governance record of what the process sandbox was configured to do and whether it took effect. Discriminated by `kind`. + * @since 1.0.0 + */ +@JsonIgnoreProperties(ignoreUnknown = true) +@JsonInclude(JsonInclude.Include.NON_NULL) +@javax.annotation.processing.Generated("copilot-sdk-codegen") +public final class SandboxDecisionEvent extends SessionEvent { + + @Override + public String getType() { return "sandbox.decision"; } + + @JsonProperty("data") + private SandboxDecisionEventData data; + + public SandboxDecisionEventData getData() { return data; } + public void setData(SandboxDecisionEventData data) { this.data = data; } + + /** Data payload for {@link SandboxDecisionEvent}. */ + @JsonIgnoreProperties(ignoreUnknown = true) + @JsonInclude(JsonInclude.Include.NON_NULL) + public record SandboxDecisionEventData() { + } +} 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 0000000000..cba65eadb5 --- /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/src/generated/java/com/github/copilot/generated/SessionAutoModeResolvedEvent.java b/java/sdk/src/generated/java/com/github/copilot/generated/SessionAutoModeResolvedEvent.java similarity index 71% rename from java/src/generated/java/com/github/copilot/generated/SessionAutoModeResolvedEvent.java rename to java/sdk/src/generated/java/com/github/copilot/generated/SessionAutoModeResolvedEvent.java index f79be388ec..88b06f4471 100644 --- a/java/src/generated/java/com/github/copilot/generated/SessionAutoModeResolvedEvent.java +++ b/java/sdk/src/generated/java/com/github/copilot/generated/SessionAutoModeResolvedEvent.java @@ -47,7 +47,25 @@ public record SessionAutoModeResolvedEventData( /** 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 + @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 100% 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 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 100% 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 diff --git a/java/src/generated/java/com/github/copilot/generated/SessionBinaryAssetEvent.java b/java/sdk/src/generated/java/com/github/copilot/generated/SessionBinaryAssetEvent.java similarity index 100% rename from java/src/generated/java/com/github/copilot/generated/SessionBinaryAssetEvent.java rename to java/sdk/src/generated/java/com/github/copilot/generated/SessionBinaryAssetEvent.java diff --git a/java/src/generated/java/com/github/copilot/generated/SessionCanvasClosedEvent.java b/java/sdk/src/generated/java/com/github/copilot/generated/SessionCanvasClosedEvent.java similarity index 100% rename from java/src/generated/java/com/github/copilot/generated/SessionCanvasClosedEvent.java rename to java/sdk/src/generated/java/com/github/copilot/generated/SessionCanvasClosedEvent.java 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 100% 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 diff --git a/java/src/generated/java/com/github/copilot/generated/SessionCanvasRecordedEvent.java b/java/sdk/src/generated/java/com/github/copilot/generated/SessionCanvasRecordedEvent.java similarity index 100% rename from java/src/generated/java/com/github/copilot/generated/SessionCanvasRecordedEvent.java rename to java/sdk/src/generated/java/com/github/copilot/generated/SessionCanvasRecordedEvent.java 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 100% 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 diff --git a/java/src/generated/java/com/github/copilot/generated/SessionCanvasRemovedEvent.java b/java/sdk/src/generated/java/com/github/copilot/generated/SessionCanvasRemovedEvent.java similarity index 100% rename from java/src/generated/java/com/github/copilot/generated/SessionCanvasRemovedEvent.java rename to java/sdk/src/generated/java/com/github/copilot/generated/SessionCanvasRemovedEvent.java diff --git a/java/src/generated/java/com/github/copilot/generated/SessionCanvasUnavailableEvent.java b/java/sdk/src/generated/java/com/github/copilot/generated/SessionCanvasUnavailableEvent.java similarity index 100% rename from java/src/generated/java/com/github/copilot/generated/SessionCanvasUnavailableEvent.java rename to java/sdk/src/generated/java/com/github/copilot/generated/SessionCanvasUnavailableEvent.java 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 89% 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 8771d3114a..1925f6d893 100644 --- a/java/src/generated/java/com/github/copilot/generated/SessionCompactionCompleteEvent.java +++ b/java/sdk/src/generated/java/com/github/copilot/generated/SessionCompactionCompleteEvent.java @@ -52,6 +52,8 @@ public record SessionCompactionCompleteEventData( @JsonProperty("customInstructions") String customInstructions, /** LLM-generated summary of the compacted conversation history */ @JsonProperty("summaryContent") String summaryContent, + /** Canonical model identifier used for model-specific behavior when replaying compaction */ + @JsonProperty("behaviorModelId") String behaviorModelId, /** Checkpoint snapshot number created for recovery */ @JsonProperty("checkpointNumber") Long checkpointNumber, /** File path where the checkpoint was stored */ @@ -69,7 +71,11 @@ public record SessionCompactionCompleteEventData( /** Token count from tool definitions after compaction */ @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 + @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 82% 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 e92a3ac50f..076a124262 100644 --- a/java/src/generated/java/com/github/copilot/generated/SessionCompactionStartEvent.java +++ b/java/sdk/src/generated/java/com/github/copilot/generated/SessionCompactionStartEvent.java @@ -41,7 +41,13 @@ public record SessionCompactionStartEventData( /** 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 6fb6a54db9..fc96eff674 100644 --- a/java/src/generated/java/com/github/copilot/generated/SessionContextChangedEvent.java +++ b/java/sdk/src/generated/java/com/github/copilot/generated/SessionContextChangedEvent.java @@ -49,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 0000000000..7a4e9cd00e --- /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 100% 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 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 100% 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 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 100% 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 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 88% 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 162572b037..e22561b914 100644 --- a/java/src/generated/java/com/github/copilot/generated/SessionEvent.java +++ b/java/sdk/src/generated/java/com/github/copilot/generated/SessionEvent.java @@ -51,14 +51,23 @@ @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 = SessionFusionRouteStartedEvent.class, name = "session.fusion_route_started"), + @JsonSubTypes.Type(value = SessionFusionRouteFailedEvent.class, name = "session.fusion_route_failed"), + @JsonSubTypes.Type(value = SessionFusionResolvedEvent.class, name = "session.fusion_resolved"), + @JsonSubTypes.Type(value = SessionFusionCompletedEvent.class, name = "session.fusion_completed"), @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 = AgentInterruptedEvent.class, name = "agent.interrupted"), @JsonSubTypes.Type(value = AssistantIntentEvent.class, name = "assistant.intent"), + @JsonSubTypes.Type(value = AssistantFusionPhaseStartedEvent.class, name = "assistant.fusion_phase_started"), + @JsonSubTypes.Type(value = AssistantFusionPhaseCompletedEvent.class, name = "assistant.fusion_phase_completed"), + @JsonSubTypes.Type(value = AssistantFusionPhaseFailedEvent.class, name = "assistant.fusion_phase_failed"), @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"), @@ -70,7 +79,9 @@ @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 = PromptCacheBreakEvent.class, name = "prompt_cache_break"), @JsonSubTypes.Type(value = ModelCallFailureEvent.class, name = "model.call_failure"), + @JsonSubTypes.Type(value = ModelCallFinishedEvent.class, name = "model.call_finished"), @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"), @@ -80,7 +91,9 @@ @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 = SandboxDecisionEvent.class, name = "sandbox.decision"), @JsonSubTypes.Type(value = SubagentStartedEvent.class, name = "subagent.started"), + @JsonSubTypes.Type(value = SubagentConfiguredEvent.class, name = "subagent.configured"), @JsonSubTypes.Type(value = SubagentCompletedEvent.class, name = "subagent.completed"), @JsonSubTypes.Type(value = SubagentFailedEvent.class, name = "subagent.failed"), @JsonSubTypes.Type(value = SubagentSelectedEvent.class, name = "subagent.selected"), @@ -104,6 +117,7 @@ @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 = UiEphemeralQueryEvent.class, name = "ui.ephemeral_query"), @JsonSubTypes.Type(value = ExternalToolRequestedEvent.class, name = "external_tool.requested"), @JsonSubTypes.Type(value = ExternalToolCompletedEvent.class, name = "external_tool.completed"), @JsonSubTypes.Type(value = CommandQueuedEvent.class, name = "command.queued"), @@ -122,6 +136,9 @@ @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 = FactoryRunStartedEvent.class, name = "factory.run_started"), + @JsonSubTypes.Type(value = FactoryRunSettledEvent.class, name = "factory.run_settled"), @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"), @@ -167,14 +184,23 @@ public abstract sealed class SessionEvent permits SessionUsageCheckpointEvent, SessionContextChangedEvent, SessionUsageInfoEvent, + SessionContextClearedEvent, SessionCompactionStartEvent, SessionCompactionCompleteEvent, SessionTaskCompleteEvent, + SessionFusionRouteStartedEvent, + SessionFusionRouteFailedEvent, + SessionFusionResolvedEvent, + SessionFusionCompletedEvent, UserMessageEvent, PendingMessagesModifiedEvent, AssistantTurnStartEvent, AssistantTurnRetryEvent, + AgentInterruptedEvent, AssistantIntentEvent, + AssistantFusionPhaseStartedEvent, + AssistantFusionPhaseCompletedEvent, + AssistantFusionPhaseFailedEvent, AssistantServerToolProgressEvent, AssistantReasoningEvent, AssistantReasoningDeltaEvent, @@ -186,7 +212,9 @@ public abstract sealed class SessionEvent permits AssistantTurnEndEvent, AssistantIdleEvent, AssistantUsageEvent, + PromptCacheBreakEvent, ModelCallFailureEvent, + ModelCallFinishedEvent, ModelCallStartEvent, AbortEvent, ToolUserRequestedEvent, @@ -196,7 +224,9 @@ public abstract sealed class SessionEvent permits ToolExecutionCompleteEvent, ToolSearchActivatedEvent, SkillInvokedEvent, + SandboxDecisionEvent, SubagentStartedEvent, + SubagentConfiguredEvent, SubagentCompletedEvent, SubagentFailedEvent, SubagentSelectedEvent, @@ -220,6 +250,7 @@ public abstract sealed class SessionEvent permits McpHeadersRefreshRequiredEvent, McpHeadersRefreshCompletedEvent, SessionCustomNotificationEvent, + UiEphemeralQueryEvent, ExternalToolRequestedEvent, ExternalToolCompletedEvent, CommandQueuedEvent, @@ -238,6 +269,9 @@ public abstract sealed class SessionEvent permits ExitPlanModeCompletedEvent, SessionToolsUpdatedEvent, SessionBackgroundTasksChangedEvent, + FactoryRunUpdatedEvent, + FactoryRunStartedEvent, + FactoryRunSettledEvent, SessionSkillsLoadedEvent, SessionCustomAgentsUpdatedEvent, SessionMcpServersLoadedEvent, diff --git a/java/src/generated/java/com/github/copilot/generated/SessionExtensionsAttachmentsPushedEvent.java b/java/sdk/src/generated/java/com/github/copilot/generated/SessionExtensionsAttachmentsPushedEvent.java similarity index 100% rename from java/src/generated/java/com/github/copilot/generated/SessionExtensionsAttachmentsPushedEvent.java rename to java/sdk/src/generated/java/com/github/copilot/generated/SessionExtensionsAttachmentsPushedEvent.java 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 100% 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 diff --git a/java/sdk/src/generated/java/com/github/copilot/generated/SessionFusionCompletedEvent.java b/java/sdk/src/generated/java/com/github/copilot/generated/SessionFusionCompletedEvent.java new file mode 100644 index 0000000000..6742cdc3e3 --- /dev/null +++ b/java/sdk/src/generated/java/com/github/copilot/generated/SessionFusionCompletedEvent.java @@ -0,0 +1,75 @@ +/*--------------------------------------------------------------------------------------------- + * 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.fusion_completed". Experimental durable aggregate outcome of a HydraFusion turn. + * @since 1.0.0 + */ +@JsonIgnoreProperties(ignoreUnknown = true) +@JsonInclude(JsonInclude.Include.NON_NULL) +@javax.annotation.processing.Generated("copilot-sdk-codegen") +public final class SessionFusionCompletedEvent extends SessionEvent { + + @Override + public String getType() { return "session.fusion_completed"; } + + @JsonProperty("data") + private SessionFusionCompletedEventData data; + + public SessionFusionCompletedEventData getData() { return data; } + public void setData(SessionFusionCompletedEventData data) { this.data = data; } + + /** Data payload for {@link SessionFusionCompletedEvent}. */ + @JsonIgnoreProperties(ignoreUnknown = true) + @JsonInclude(JsonInclude.Include.NON_NULL) + public record SessionFusionCompletedEventData( + /** Stable identifier for the completed HydraFusion turn. */ + @JsonProperty("fusionId") String fusionId, + /** Idempotency identifier for the authoritative final commit. */ + @JsonProperty("commitId") String commitId, + /** Identifier of the session turn associated with the completion. */ + @JsonProperty("turnId") String turnId, + /** Synthetic HydraFusion model selected for the session. */ + @JsonProperty("syntheticModel") String syntheticModel, + /** HydraFusion orchestration pattern executed for the turn. */ + @JsonProperty("pattern") FusionPattern pattern, + /** Stable aggregate outcome of the HydraFusion turn. */ + @JsonProperty("outcome") String outcome, + /** Phase whose output supplied the authoritative final content. */ + @JsonProperty("finalSourcePhaseId") String finalSourcePhaseId, + /** Concrete model that supplied the authoritative final content. */ + @JsonProperty("finalSourceModel") String finalSourceModel, + /** Concrete model recommended for eligible follow-up turns. */ + @JsonProperty("followUpModel") String followUpModel, + /** Reason the turn used a degraded route, when applicable. */ + @JsonProperty("degradedReason") String degradedReason, + /** Number of concrete phases attempted by the turn. */ + @JsonProperty("phaseCount") Long phaseCount, + /** Total concrete model requests made across all phases. */ + @JsonProperty("requestCount") Long requestCount, + /** Total input tokens consumed across all phases. */ + @JsonProperty("inputTokens") Long inputTokens, + /** Total output tokens produced across all phases. */ + @JsonProperty("outputTokens") Long outputTokens, + /** Total cached input tokens reported across all phases. */ + @JsonProperty("cachedTokens") Long cachedTokens, + /** Total tokens written to prompt cache across all phases. */ + @JsonProperty("cacheWriteTokens") Long cacheWriteTokens, + /** Total normalized AI-unit cost reported across all phases, in nano-AIU. */ + @JsonProperty("totalNanoAiu") Double totalNanoAiu, + /** Total elapsed execution time for the HydraFusion turn in milliseconds. */ + @JsonProperty("durationMs") Double durationMs + ) { + } +} diff --git a/java/sdk/src/generated/java/com/github/copilot/generated/SessionFusionResolvedEvent.java b/java/sdk/src/generated/java/com/github/copilot/generated/SessionFusionResolvedEvent.java new file mode 100644 index 0000000000..7553c6eb43 --- /dev/null +++ b/java/sdk/src/generated/java/com/github/copilot/generated/SessionFusionResolvedEvent.java @@ -0,0 +1,79 @@ +/*--------------------------------------------------------------------------------------------- + * 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.fusion_resolved". Experimental durable validated HydraFusion route and turn policy. + * @since 1.0.0 + */ +@JsonIgnoreProperties(ignoreUnknown = true) +@JsonInclude(JsonInclude.Include.NON_NULL) +@javax.annotation.processing.Generated("copilot-sdk-codegen") +public final class SessionFusionResolvedEvent extends SessionEvent { + + @Override + public String getType() { return "session.fusion_resolved"; } + + @JsonProperty("data") + private SessionFusionResolvedEventData data; + + public SessionFusionResolvedEventData getData() { return data; } + public void setData(SessionFusionResolvedEventData data) { this.data = data; } + + /** Data payload for {@link SessionFusionResolvedEvent}. */ + @JsonIgnoreProperties(ignoreUnknown = true) + @JsonInclude(JsonInclude.Include.NON_NULL) + public record SessionFusionResolvedEventData( + /** Stable identifier for the resolved HydraFusion turn. */ + @JsonProperty("fusionId") String fusionId, + /** Identifier of the session turn associated with the route. */ + @JsonProperty("turnId") String turnId, + /** Version of the validated HydraFusion event contract. */ + @JsonProperty("contractVersion") Long contractVersion, + /** Synthetic HydraFusion model selected for the session. */ + @JsonProperty("syntheticModel") String syntheticModel, + /** HydraFusion routing policy used to resolve the plan. */ + @JsonProperty("policy") String policy, + /** Router implementation that supplied the plan. */ + @JsonProperty("routeSource") String routeSource, + /** Version of the validated execution-plan format. */ + @JsonProperty("planVersion") String planVersion, + /** Version of the local routing policy. */ + @JsonProperty("policyVersion") String policyVersion, + /** Version of the executable model universe used for selection. */ + @JsonProperty("modelUniverseVersion") String modelUniverseVersion, + /** Identifier of the local policy rule that matched. */ + @JsonProperty("ruleId") String ruleId, + /** Zero-based index of the local policy rule that matched. */ + @JsonProperty("ruleIndex") Long ruleIndex, + /** Human-readable name of the local policy rule that matched. */ + @JsonProperty("ruleName") String ruleName, + /** Validated capability scores used to select the route. */ + @JsonProperty("scores") FusionScores scores, + /** Validated orchestration pattern selected for the turn. */ + @JsonProperty("pattern") FusionPattern pattern, + /** Concrete model selected for the primary solver phase. */ + @JsonProperty("primaryModel") String primaryModel, + /** Concrete model selected for the review or judge phase, when required. */ + @JsonProperty("secondaryModel") String secondaryModel, + /** Concrete model used when the planned primary model cannot execute. */ + @JsonProperty("fallbackModel") String fallbackModel, + /** Concrete model recommended for eligible follow-up turns. */ + @JsonProperty("followUpModel") String followUpModel, + /** Router recommendation controlling reuse or rerouting on later turns. */ + @JsonProperty("followUp") FusionFollowUpRecommendation followUp, + /** Elapsed time in milliseconds required to resolve and validate the route. */ + @JsonProperty("routingLatencyMs") Double routingLatencyMs + ) { + } +} diff --git a/java/sdk/src/generated/java/com/github/copilot/generated/SessionFusionRouteFailedEvent.java b/java/sdk/src/generated/java/com/github/copilot/generated/SessionFusionRouteFailedEvent.java new file mode 100644 index 0000000000..25698b336b --- /dev/null +++ b/java/sdk/src/generated/java/com/github/copilot/generated/SessionFusionRouteFailedEvent.java @@ -0,0 +1,53 @@ +/*--------------------------------------------------------------------------------------------- + * 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.fusion_route_failed". Experimental durable HydraFusion routing failure and the deterministic concrete fallback selected for the turn. + * @since 1.0.0 + */ +@JsonIgnoreProperties(ignoreUnknown = true) +@JsonInclude(JsonInclude.Include.NON_NULL) +@javax.annotation.processing.Generated("copilot-sdk-codegen") +public final class SessionFusionRouteFailedEvent extends SessionEvent { + + @Override + public String getType() { return "session.fusion_route_failed"; } + + @JsonProperty("data") + private SessionFusionRouteFailedEventData data; + + public SessionFusionRouteFailedEventData getData() { return data; } + public void setData(SessionFusionRouteFailedEventData data) { this.data = data; } + + /** Data payload for {@link SessionFusionRouteFailedEvent}. */ + @JsonIgnoreProperties(ignoreUnknown = true) + @JsonInclude(JsonInclude.Include.NON_NULL) + public record SessionFusionRouteFailedEventData( + /** Identifier of the routing attempt that failed. */ + @JsonProperty("attemptId") String attemptId, + /** Synthetic HydraFusion model selected for the session. */ + @JsonProperty("syntheticModel") String syntheticModel, + /** HydraFusion routing policy requested for the turn. */ + @JsonProperty("policy") String policy, + /** Stable machine-readable reason for the routing failure. */ + @JsonProperty("reason") String reason, + /** Provider or validation error detail, when available. */ + @JsonProperty("errorMessage") String errorMessage, + /** Concrete model selected as the deterministic fallback. */ + @JsonProperty("fallbackModel") String fallbackModel, + /** Elapsed routing time in milliseconds before the failure. */ + @JsonProperty("routingLatencyMs") Double routingLatencyMs + ) { + } +} diff --git a/java/sdk/src/generated/java/com/github/copilot/generated/SessionFusionRouteStartedEvent.java b/java/sdk/src/generated/java/com/github/copilot/generated/SessionFusionRouteStartedEvent.java new file mode 100644 index 0000000000..139cb4f011 --- /dev/null +++ b/java/sdk/src/generated/java/com/github/copilot/generated/SessionFusionRouteStartedEvent.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 "session.fusion_route_started". Experimental transient signal that HydraFusion routing has started for an eligible turn. + * @since 1.0.0 + */ +@JsonIgnoreProperties(ignoreUnknown = true) +@JsonInclude(JsonInclude.Include.NON_NULL) +@javax.annotation.processing.Generated("copilot-sdk-codegen") +public final class SessionFusionRouteStartedEvent extends SessionEvent { + + @Override + public String getType() { return "session.fusion_route_started"; } + + @JsonProperty("data") + private SessionFusionRouteStartedEventData data; + + public SessionFusionRouteStartedEventData getData() { return data; } + public void setData(SessionFusionRouteStartedEventData data) { this.data = data; } + + /** Data payload for {@link SessionFusionRouteStartedEvent}. */ + @JsonIgnoreProperties(ignoreUnknown = true) + @JsonInclude(JsonInclude.Include.NON_NULL) + public record SessionFusionRouteStartedEventData( + /** Identifier for this routing attempt before a durable Fusion turn exists. */ + @JsonProperty("attemptId") String attemptId, + /** Kind of turn being routed. */ + @JsonProperty("turnKind") FusionTurnKind turnKind, + /** Synthetic HydraFusion model selected for the session. */ + @JsonProperty("syntheticModel") String syntheticModel, + /** HydraFusion routing policy requested for the turn. */ + @JsonProperty("policy") String policy + ) { + } +} 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 100% 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 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 81% 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 e51a26e5ae..ae509c4b42 100644 --- a/java/src/generated/java/com/github/copilot/generated/SessionIdleEvent.java +++ b/java/sdk/src/generated/java/com/github/copilot/generated/SessionIdleEvent.java @@ -35,7 +35,9 @@ public final class SessionIdleEvent extends SessionEvent { @JsonInclude(JsonInclude.Include.NON_NULL) public record SessionIdleEventData( /** True when the preceding agentic loop was cancelled via abort signal */ - @JsonProperty("aborted") Boolean aborted + @JsonProperty("aborted") Boolean aborted, + /** The session mode the agent was operating in when it went idle, when the mode is known. Lets turn-scoped consumers distinguish an autopilot continuation boundary (where the agent keeps working after this idle) from a genuine turn completion. */ + @JsonProperty("mode") SessionMode mode ) { } } 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 100% 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 diff --git a/java/src/generated/java/com/github/copilot/generated/SessionLimitsConfig.java b/java/sdk/src/generated/java/com/github/copilot/generated/SessionLimitsConfig.java similarity index 100% rename from java/src/generated/java/com/github/copilot/generated/SessionLimitsConfig.java rename to java/sdk/src/generated/java/com/github/copilot/generated/SessionLimitsConfig.java diff --git a/java/src/generated/java/com/github/copilot/generated/SessionLimitsExhaustedCompletedEvent.java b/java/sdk/src/generated/java/com/github/copilot/generated/SessionLimitsExhaustedCompletedEvent.java similarity index 100% rename from java/src/generated/java/com/github/copilot/generated/SessionLimitsExhaustedCompletedEvent.java rename to java/sdk/src/generated/java/com/github/copilot/generated/SessionLimitsExhaustedCompletedEvent.java diff --git a/java/src/generated/java/com/github/copilot/generated/SessionLimitsExhaustedRequestedEvent.java b/java/sdk/src/generated/java/com/github/copilot/generated/SessionLimitsExhaustedRequestedEvent.java similarity index 100% rename from java/src/generated/java/com/github/copilot/generated/SessionLimitsExhaustedRequestedEvent.java rename to java/sdk/src/generated/java/com/github/copilot/generated/SessionLimitsExhaustedRequestedEvent.java diff --git a/java/src/generated/java/com/github/copilot/generated/SessionLimitsExhaustedResponse.java b/java/sdk/src/generated/java/com/github/copilot/generated/SessionLimitsExhaustedResponse.java similarity index 100% rename from java/src/generated/java/com/github/copilot/generated/SessionLimitsExhaustedResponse.java rename to java/sdk/src/generated/java/com/github/copilot/generated/SessionLimitsExhaustedResponse.java diff --git a/java/src/generated/java/com/github/copilot/generated/SessionLimitsExhaustedResponseAction.java b/java/sdk/src/generated/java/com/github/copilot/generated/SessionLimitsExhaustedResponseAction.java similarity index 100% rename from java/src/generated/java/com/github/copilot/generated/SessionLimitsExhaustedResponseAction.java rename to java/sdk/src/generated/java/com/github/copilot/generated/SessionLimitsExhaustedResponseAction.java diff --git a/java/src/generated/java/com/github/copilot/generated/SessionManagedSettingsEnforcedEvent.java b/java/sdk/src/generated/java/com/github/copilot/generated/SessionManagedSettingsEnforcedEvent.java similarity index 100% rename from java/src/generated/java/com/github/copilot/generated/SessionManagedSettingsEnforcedEvent.java rename to java/sdk/src/generated/java/com/github/copilot/generated/SessionManagedSettingsEnforcedEvent.java diff --git a/java/src/generated/java/com/github/copilot/generated/SessionManagedSettingsResolvedEvent.java b/java/sdk/src/generated/java/com/github/copilot/generated/SessionManagedSettingsResolvedEvent.java similarity index 60% rename from java/src/generated/java/com/github/copilot/generated/SessionManagedSettingsResolvedEvent.java rename to java/sdk/src/generated/java/com/github/copilot/generated/SessionManagedSettingsResolvedEvent.java index 7cc495269f..ac3763248a 100644 --- a/java/src/generated/java/com/github/copilot/generated/SessionManagedSettingsResolvedEvent.java +++ b/java/sdk/src/generated/java/com/github/copilot/generated/SessionManagedSettingsResolvedEvent.java @@ -14,7 +14,7 @@ import javax.annotation.processing.Generated; /** - * Session event "session.managed_settings_resolved". Enterprise managed-settings resolution: the effective managed settings the session applied and where they came from, so SDK clients can show users what is enterprise-managed and by which authority. 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; for a session-independent pull, use the SDK `getManagedSettings()` API, which returns the identical payload. Managed settings have a single authoritative source, so the highest-authority present layer (server > device) wins wholesale; `bypassPermissionsDisabled` is deny-wins across layers. Marked experimental while the managed-settings surface stabilizes. + * 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) @@ -35,16 +35,22 @@ public final class SessionManagedSettingsResolvedEvent extends SessionEvent { @JsonIgnoreProperties(ignoreUnknown = true) @JsonInclude(JsonInclude.Include.NON_NULL) public record SessionManagedSettingsResolvedEventData( - /** Which channel supplied the effective managed settings (the winning layer), or `none` when no policy is in force */ + /** 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 the device (MDM/plist/registry/file) managed-settings layer was present */ + /** 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 the effective sandbox policy forces the sandbox on *only* because managed policy could not be determined, rather than because the policy requires it. Lets clients tell a user whose `--no-sandbox` was overridden that the sandbox stayed on as a fail-closed fallback, instead of attributing it to an administrator who set no such policy. */ + @JsonProperty("sandboxEnabledByUndeterminedPolicy") Boolean sandboxEnabledByUndeterminedPolicy, /** 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. */ 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 97% 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 cb15f1d9e9..b084652db1 100644 --- a/java/src/generated/java/com/github/copilot/generated/SessionMcpServerStatusChangedEvent.java +++ b/java/sdk/src/generated/java/com/github/copilot/generated/SessionMcpServerStatusChangedEvent.java @@ -36,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 100% 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 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 100% 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 diff --git a/java/src/generated/java/com/github/copilot/generated/SessionModelChangeEvent.java b/java/sdk/src/generated/java/com/github/copilot/generated/SessionModelChangeEvent.java similarity index 85% rename from java/src/generated/java/com/github/copilot/generated/SessionModelChangeEvent.java rename to java/sdk/src/generated/java/com/github/copilot/generated/SessionModelChangeEvent.java index f12b86d088..868d78fe0d 100644 --- a/java/src/generated/java/com/github/copilot/generated/SessionModelChangeEvent.java +++ b/java/sdk/src/generated/java/com/github/copilot/generated/SessionModelChangeEvent.java @@ -52,8 +52,10 @@ public record SessionModelChangeEventData( @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. 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 + /** 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, + /** Origin of the effective model change, when known. */ + @JsonProperty("source") ModelChangeSource source ) { } } 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 66% 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 c1f82f5af7..ef332617ac 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,7 +13,7 @@ import javax.annotation.processing.Generated; /** - * Session event "session.permissions_changed". Permissions change details carrying the aggregate allow-all transition. + * Session event "session.permissions_changed". Permission-mode transition details. * @since 1.0.0 */ @JsonIgnoreProperties(ignoreUnknown = true) @@ -34,14 +34,12 @@ public final class SessionPermissionsChangedEvent extends SessionEvent { @JsonIgnoreProperties(ignoreUnknown = true) @JsonInclude(JsonInclude.Include.NON_NULL) 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, - /** Allow-all mode before the change */ - @JsonProperty("previousAllowAllPermissionMode") PermissionAllowAllMode previousAllowAllPermissionMode, - /** Allow-all mode after the change */ - @JsonProperty("allowAllPermissionMode") PermissionAllowAllMode allowAllPermissionMode + /** Permission mode before the change */ + @JsonProperty("previousMode") PermissionMode previousMode, + /** Permission mode after the change */ + @JsonProperty("mode") PermissionMode mode, + /** Explicit LLM judge model override used by assisted mode; omitted when the provider default applies */ + @JsonProperty("assistedApprovalModel") String assistedApprovalModel ) { } } 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 100% 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 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 100% 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 diff --git a/java/src/generated/java/com/github/copilot/generated/SessionResumeEvent.java b/java/sdk/src/generated/java/com/github/copilot/generated/SessionResumeEvent.java similarity index 84% rename from java/src/generated/java/com/github/copilot/generated/SessionResumeEvent.java rename to java/sdk/src/generated/java/com/github/copilot/generated/SessionResumeEvent.java index 6efac46f27..a3f39d7696 100644 --- a/java/src/generated/java/com/github/copilot/generated/SessionResumeEvent.java +++ b/java/sdk/src/generated/java/com/github/copilot/generated/SessionResumeEvent.java @@ -57,11 +57,11 @@ public record SessionResumeEventData( @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. */ + /** 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 (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. */ @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 100% 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 diff --git a/java/src/generated/java/com/github/copilot/generated/SessionScheduleCreatedEvent.java b/java/sdk/src/generated/java/com/github/copilot/generated/SessionScheduleCreatedEvent.java similarity index 85% rename from java/src/generated/java/com/github/copilot/generated/SessionScheduleCreatedEvent.java rename to java/sdk/src/generated/java/com/github/copilot/generated/SessionScheduleCreatedEvent.java index 435a8501e8..cc0b3b165d 100644 --- a/java/src/generated/java/com/github/copilot/generated/SessionScheduleCreatedEvent.java +++ b/java/sdk/src/generated/java/com/github/copilot/generated/SessionScheduleCreatedEvent.java @@ -51,7 +51,9 @@ public record SessionScheduleCreatedEventData( /** 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 + @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/src/generated/java/com/github/copilot/generated/SessionScheduleRearmedEvent.java b/java/sdk/src/generated/java/com/github/copilot/generated/SessionScheduleRearmedEvent.java similarity index 100% rename from java/src/generated/java/com/github/copilot/generated/SessionScheduleRearmedEvent.java rename to java/sdk/src/generated/java/com/github/copilot/generated/SessionScheduleRearmedEvent.java diff --git a/java/src/generated/java/com/github/copilot/generated/SessionSessionLimitsChangedEvent.java b/java/sdk/src/generated/java/com/github/copilot/generated/SessionSessionLimitsChangedEvent.java similarity index 100% rename from java/src/generated/java/com/github/copilot/generated/SessionSessionLimitsChangedEvent.java rename to java/sdk/src/generated/java/com/github/copilot/generated/SessionSessionLimitsChangedEvent.java 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 94% 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 84c3023066..cf8600e388 100644 --- a/java/src/generated/java/com/github/copilot/generated/SessionShutdownEvent.java +++ b/java/sdk/src/generated/java/com/github/copilot/generated/SessionShutdownEvent.java @@ -55,6 +55,8 @@ public record SessionShutdownEventData( @JsonProperty("codeChanges") ShutdownCodeChanges codeChanges, /** Per-model usage breakdown, keyed by model identifier */ @JsonProperty("modelMetrics") Map modelMetrics, + /** Per-agent usage breakdown, keyed by agent instance identifier. The main conversation uses the stable key `main`. */ + @JsonProperty("agentMetrics") Map agentMetrics, /** Model that was selected at the time of shutdown */ @JsonProperty("currentModel") String currentModel, /** Total tokens in context window at shutdown */ 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 100% 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 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 100% 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 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 96% 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 4beb487c31..bf8b4e91cf 100644 --- a/java/src/generated/java/com/github/copilot/generated/SessionStartEvent.java +++ b/java/sdk/src/generated/java/com/github/copilot/generated/SessionStartEvent.java @@ -59,6 +59,8 @@ public record SessionStartEventData( @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/src/generated/java/com/github/copilot/generated/SessionTaskCompleteEvent.java b/java/sdk/src/generated/java/com/github/copilot/generated/SessionTaskCompleteEvent.java similarity index 64% rename from java/src/generated/java/com/github/copilot/generated/SessionTaskCompleteEvent.java rename to java/sdk/src/generated/java/com/github/copilot/generated/SessionTaskCompleteEvent.java index 8933662bab..c44c682b1c 100644 --- a/java/src/generated/java/com/github/copilot/generated/SessionTaskCompleteEvent.java +++ b/java/sdk/src/generated/java/com/github/copilot/generated/SessionTaskCompleteEvent.java @@ -36,8 +36,14 @@ public final class SessionTaskCompleteEvent extends SessionEvent { 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 + /** 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 100% 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 diff --git a/java/src/generated/java/com/github/copilot/generated/SessionTodosChangedEvent.java b/java/sdk/src/generated/java/com/github/copilot/generated/SessionTodosChangedEvent.java similarity index 100% rename from java/src/generated/java/com/github/copilot/generated/SessionTodosChangedEvent.java rename to java/sdk/src/generated/java/com/github/copilot/generated/SessionTodosChangedEvent.java 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 100% 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 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 100% 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 diff --git a/java/src/generated/java/com/github/copilot/generated/SessionUsageCheckpointEvent.java b/java/sdk/src/generated/java/com/github/copilot/generated/SessionUsageCheckpointEvent.java similarity index 90% rename from java/src/generated/java/com/github/copilot/generated/SessionUsageCheckpointEvent.java rename to java/sdk/src/generated/java/com/github/copilot/generated/SessionUsageCheckpointEvent.java index 1a400c0130..bdbc1add95 100644 --- a/java/src/generated/java/com/github/copilot/generated/SessionUsageCheckpointEvent.java +++ b/java/sdk/src/generated/java/com/github/copilot/generated/SessionUsageCheckpointEvent.java @@ -40,7 +40,9 @@ public record SessionUsageCheckpointEventData( /** 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 + @JsonProperty("modelCacheState") List modelCacheState, + /** Internal per-conversation prompt-cache-break detector baselines restored on resume */ + @JsonProperty("promptCacheBreakState") List promptCacheBreakState ) { } } 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 100% 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 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 100% 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 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 100% 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 diff --git a/java/sdk/src/generated/java/com/github/copilot/generated/ShutdownAgentMetric.java b/java/sdk/src/generated/java/com/github/copilot/generated/ShutdownAgentMetric.java new file mode 100644 index 0000000000..a6ed890ba7 --- /dev/null +++ b/java/sdk/src/generated/java/com/github/copilot/generated/ShutdownAgentMetric.java @@ -0,0 +1,36 @@ +/*--------------------------------------------------------------------------------------------- + * 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; + +/** + * Usage attributed to one agent instance at session shutdown. + * + * @since 1.0.0 + */ +@javax.annotation.processing.Generated("copilot-sdk-codegen") +@JsonInclude(JsonInclude.Include.NON_NULL) +@JsonIgnoreProperties(ignoreUnknown = true) +public record ShutdownAgentMetric( + /** Configured agent name, when this is a subagent */ + @JsonProperty("agentName") String agentName, + /** Human-readable label for this subagent invocation, copied from the originating `subagent.started` event. For task-tool subagents this is the invocation's task description rather than the agent's configured display name, so group by `agentName` for stable per-agent labels. */ + @JsonProperty("agentDisplayName") String agentDisplayName, + /** Time spent in model API calls by this agent, in milliseconds */ + @JsonProperty("totalApiDurationMs") Long totalApiDurationMs, + /** Accumulated nano-AI units cost for this agent */ + @JsonProperty("totalNanoAiu") Double totalNanoAiu, + /** Per-model usage for this agent, keyed by model identifier */ + @JsonProperty("modelMetrics") Map modelMetrics +) { +} 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 100% 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 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 100% 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 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 100% 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 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 100% 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 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/src/generated/java/com/github/copilot/generated/SkillsLoadedSkill.java b/java/sdk/src/generated/java/com/github/copilot/generated/SkillsLoadedSkill.java similarity index 92% rename from java/src/generated/java/com/github/copilot/generated/SkillsLoadedSkill.java rename to java/sdk/src/generated/java/com/github/copilot/generated/SkillsLoadedSkill.java index d3196c6bbf..932d9affe5 100644 --- a/java/src/generated/java/com/github/copilot/generated/SkillsLoadedSkill.java +++ b/java/sdk/src/generated/java/com/github/copilot/generated/SkillsLoadedSkill.java @@ -23,6 +23,8 @@ 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) */ 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 63% 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 f32613579d..62f6803652 100644 --- a/java/src/generated/java/com/github/copilot/generated/SubagentCompletedEvent.java +++ b/java/sdk/src/generated/java/com/github/copilot/generated/SubagentCompletedEvent.java @@ -42,12 +42,24 @@ public record SubagentCompletedEventData( @JsonProperty("agentDisplayName") String agentDisplayName, /** Model used by the sub-agent */ @JsonProperty("model") String model, + /** First model for which the sub-agent started an inference request, when one was dispatched */ + @JsonProperty("firstDispatchedModel") String firstDispatchedModel, + /** Concrete model the user configured for this sub-agent via `/subagents`, when present */ + @JsonProperty("configuredModelPreference") String configuredModelPreference, + /** Explicit model supplied by the parent agent on the task call, when present */ + @JsonProperty("explicitModelOverride") String explicitModelOverride, + /** Whether the explicit task-call model matched the user's configured preference */ + @JsonProperty("explicitModelMatchesPreference") Boolean explicitModelMatchesPreference, + /** Whether the first model actually dispatched matched the user's configured preference */ + @JsonProperty("configuredModelMatchesActual") Boolean configuredModelMatchesActual, /** Total number of tool calls made by the sub-agent */ @JsonProperty("totalToolCalls") Long totalToolCalls, /** 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/sdk/src/generated/java/com/github/copilot/generated/SubagentConfiguredEvent.java b/java/sdk/src/generated/java/com/github/copilot/generated/SubagentConfiguredEvent.java new file mode 100644 index 0000000000..235066fade --- /dev/null +++ b/java/sdk/src/generated/java/com/github/copilot/generated/SubagentConfiguredEvent.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 "subagent.configured". Resolved runtime configuration for a configured sub-agent + * @since 1.0.0 + */ +@JsonIgnoreProperties(ignoreUnknown = true) +@JsonInclude(JsonInclude.Include.NON_NULL) +@javax.annotation.processing.Generated("copilot-sdk-codegen") +public final class SubagentConfiguredEvent extends SessionEvent { + + @Override + public String getType() { return "subagent.configured"; } + + @JsonProperty("data") + private SubagentConfiguredEventData data; + + public SubagentConfiguredEventData getData() { return data; } + public void setData(SubagentConfiguredEventData data) { this.data = data; } + + /** Data payload for {@link SubagentConfiguredEvent}. */ + @JsonIgnoreProperties(ignoreUnknown = true) + @JsonInclude(JsonInclude.Include.NON_NULL) + public record SubagentConfiguredEventData( + /** Resolved model the sub-agent will run with */ + @JsonProperty("model") String model, + /** Resolved reasoning effort, when configured for the model */ + @JsonProperty("reasoningEffort") String reasoningEffort, + /** Resolved context tier, when configured for the model */ + @JsonProperty("contextTier") String contextTier, + /** Whether the sub-agent accepts follow-up turns */ + @JsonProperty("multiTurn") Boolean multiTurn + ) { + } +} 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 100% 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 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 72% 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 6a48544ce9..1d1413c64d 100644 --- a/java/src/generated/java/com/github/copilot/generated/SubagentFailedEvent.java +++ b/java/sdk/src/generated/java/com/github/copilot/generated/SubagentFailedEvent.java @@ -44,6 +44,16 @@ public record SubagentFailedEventData( @JsonProperty("error") String error, /** Model selected for the sub-agent, when known */ @JsonProperty("model") String model, + /** First model for which the sub-agent started an inference request, when one was dispatched */ + @JsonProperty("firstDispatchedModel") String firstDispatchedModel, + /** Concrete model the user configured for this sub-agent via `/subagents`, when present */ + @JsonProperty("configuredModelPreference") String configuredModelPreference, + /** Explicit model supplied by the parent agent on the task call, when present */ + @JsonProperty("explicitModelOverride") String explicitModelOverride, + /** Whether the explicit task-call model matched the user's configured preference */ + @JsonProperty("explicitModelMatchesPreference") Boolean explicitModelMatchesPreference, + /** Whether the first model actually dispatched matched the user's configured preference */ + @JsonProperty("configuredModelMatchesActual") Boolean configuredModelMatchesActual, /** Total number of tool calls made before the sub-agent failed */ @JsonProperty("totalToolCalls") Long totalToolCalls, /** Total tokens (input + output) consumed before the sub-agent failed */ 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 100% 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 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 72% 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 fb94f97cfa..c246fac1ea 100644 --- a/java/src/generated/java/com/github/copilot/generated/SubagentStartedEvent.java +++ b/java/sdk/src/generated/java/com/github/copilot/generated/SubagentStartedEvent.java @@ -43,7 +43,17 @@ public record SubagentStartedEventData( /** Description of what the sub-agent does */ @JsonProperty("agentDescription") String agentDescription, /** Model the sub-agent will run with, when known at start. */ - @JsonProperty("model") String model + @JsonProperty("model") String model, + /** Root id of the factory run that spawned this sub-agent, when it was spawned by one. */ + @JsonProperty("factoryRunId") String factoryRunId, + /** Task-registry ID of the spawning sub-agent. Absent when the root session spawned this child. */ + @JsonProperty("parentId") String parentId, + /** Whether this sub-agent can be resumed. Currently always false. */ + @JsonProperty("resumable") Boolean resumable, + /** Type of the sub-agent selected at spawn time. */ + @JsonProperty("agentType") String agentType, + /** Whether the sub-agent runs synchronously or in the background. */ + @JsonProperty("executionMode") String executionMode ) { } } 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 a6248a7fee..315e9e8bb6 100644 --- a/java/src/generated/java/com/github/copilot/generated/SystemMessageEvent.java +++ b/java/sdk/src/generated/java/com/github/copilot/generated/SystemMessageEvent.java @@ -36,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 100% 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 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 0000000000..827cf2b77b --- /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 89% 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 99d138b1e6..4cb949c80b 100644 --- a/java/src/generated/java/com/github/copilot/generated/ToolExecutionCompleteEvent.java +++ b/java/sdk/src/generated/java/com/github/copilot/generated/ToolExecutionCompleteEvent.java @@ -45,6 +45,8 @@ public record ToolExecutionCompleteEventData( @JsonProperty("mcpMeta") Object mcpMeta, /** CAPI interaction ID for correlating this tool execution with upstream telemetry */ @JsonProperty("interactionId") String interactionId, + /** Per-request treatment/eligibility signal returned by the Copilot API in the `X-GitHub-Copilot-Request-TE` response header for the associated model call; `false` when the header was absent or unparseable. */ + @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 */ @@ -60,7 +62,9 @@ public record ToolExecutionCompleteEventData( /** Whether this tool execution ran inside a sandbox container */ @JsonProperty("sandboxed") Boolean sandboxed, /** Tool call ID of the parent tool invocation when this event originates from a sub-agent */ - @JsonProperty("parentToolCallId") String parentToolCallId + @JsonProperty("parentToolCallId") String parentToolCallId, + /** Experimental HydraFusion attribution for this tool completion. */ + @JsonProperty("fusion") FusionAttribution fusion ) { } } diff --git a/java/src/generated/java/com/github/copilot/generated/ToolExecutionCompleteResult.java b/java/sdk/src/generated/java/com/github/copilot/generated/ToolExecutionCompleteResult.java similarity index 100% rename from java/src/generated/java/com/github/copilot/generated/ToolExecutionCompleteResult.java rename to java/sdk/src/generated/java/com/github/copilot/generated/ToolExecutionCompleteResult.java 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 100% 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 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 100% 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 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 100% 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 diff --git a/java/src/generated/java/com/github/copilot/generated/ToolExecutionCompleteUIResourceMetaUI.java b/java/sdk/src/generated/java/com/github/copilot/generated/ToolExecutionCompleteUIResourceMetaUI.java similarity index 90% rename from java/src/generated/java/com/github/copilot/generated/ToolExecutionCompleteUIResourceMetaUI.java rename to java/sdk/src/generated/java/com/github/copilot/generated/ToolExecutionCompleteUIResourceMetaUI.java index 6679b85aec..500eb17554 100644 --- a/java/src/generated/java/com/github/copilot/generated/ToolExecutionCompleteUIResourceMetaUI.java +++ b/java/sdk/src/generated/java/com/github/copilot/generated/ToolExecutionCompleteUIResourceMetaUI.java @@ -25,7 +25,9 @@ public record ToolExecutionCompleteUIResourceMetaUI( @JsonProperty("csp") ToolExecutionCompleteUIResourceMetaUICsp csp, /** Browser permission metadata for an MCP Apps UI resource, including camera, microphone, geolocation, and clipboard-write. */ @JsonProperty("permissions") ToolExecutionCompleteUIResourceMetaUIPermissions permissions, + /** Optional dedicated origin for the rendered MCP Apps UI resource. */ @JsonProperty("domain") String domain, + /** Whether the host should render a border around the MCP Apps UI resource. */ @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 81% 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 41e799cf03..4b9cfb133b 100644 --- a/java/src/generated/java/com/github/copilot/generated/ToolExecutionCompleteUIResourceMetaUICsp.java +++ b/java/sdk/src/generated/java/com/github/copilot/generated/ToolExecutionCompleteUIResourceMetaUICsp.java @@ -22,9 +22,13 @@ @JsonInclude(JsonInclude.Include.NON_NULL) @JsonIgnoreProperties(ignoreUnknown = true) public record ToolExecutionCompleteUIResourceMetaUICsp( + /** Domains the UI resource may connect to. */ @JsonProperty("connectDomains") List connectDomains, + /** Domains from which the UI resource may load scripts, styles, images, and other resources. */ @JsonProperty("resourceDomains") List resourceDomains, + /** Domains the UI resource may embed as nested frames. */ @JsonProperty("frameDomains") List frameDomains, + /** Domains the UI resource may use as document base URIs. */ @JsonProperty("baseUriDomains") List baseUriDomains ) { } diff --git a/java/src/generated/java/com/github/copilot/generated/ToolExecutionCompleteUIResourceMetaUIPermissions.java b/java/sdk/src/generated/java/com/github/copilot/generated/ToolExecutionCompleteUIResourceMetaUIPermissions.java similarity index 100% rename from java/src/generated/java/com/github/copilot/generated/ToolExecutionCompleteUIResourceMetaUIPermissions.java rename to java/sdk/src/generated/java/com/github/copilot/generated/ToolExecutionCompleteUIResourceMetaUIPermissions.java 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 100% 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 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 100% 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 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 100% 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 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 100% 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 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 100% 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 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 100% 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 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 89% 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 b119a3eb0e..36691ca41e 100644 --- a/java/src/generated/java/com/github/copilot/generated/ToolExecutionStartEvent.java +++ b/java/sdk/src/generated/java/com/github/copilot/generated/ToolExecutionStartEvent.java @@ -44,6 +44,8 @@ public record ToolExecutionStartEventData( @JsonProperty("shellToolInfo") ToolExecutionStartShellToolInfo shellToolInfo, /** Model identifier that generated this tool call */ @JsonProperty("model") String model, + /** Per-request treatment/eligibility signal returned by the Copilot API in the `X-GitHub-Copilot-Request-TE` response header for the associated model call; `false` when the header was absent or unparseable. */ + @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 */ @@ -55,7 +57,9 @@ public record ToolExecutionStartEventData( /** 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 + @JsonProperty("parentToolCallId") String parentToolCallId, + /** Experimental HydraFusion attribution for this tool execution. */ + @JsonProperty("fusion") FusionAttribution fusion ) { } } diff --git a/java/src/generated/java/com/github/copilot/generated/ToolExecutionStartShellToolInfo.java b/java/sdk/src/generated/java/com/github/copilot/generated/ToolExecutionStartShellToolInfo.java similarity index 77% rename from java/src/generated/java/com/github/copilot/generated/ToolExecutionStartShellToolInfo.java rename to java/sdk/src/generated/java/com/github/copilot/generated/ToolExecutionStartShellToolInfo.java index 88ac787fca..967dab4c34 100644 --- a/java/src/generated/java/com/github/copilot/generated/ToolExecutionStartShellToolInfo.java +++ b/java/sdk/src/generated/java/com/github/copilot/generated/ToolExecutionStartShellToolInfo.java @@ -25,6 +25,8 @@ 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 + @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/src/generated/java/com/github/copilot/generated/ToolExecutionStartToolDescription.java b/java/sdk/src/generated/java/com/github/copilot/generated/ToolExecutionStartToolDescription.java similarity index 100% rename from java/src/generated/java/com/github/copilot/generated/ToolExecutionStartToolDescription.java rename to java/sdk/src/generated/java/com/github/copilot/generated/ToolExecutionStartToolDescription.java diff --git a/java/src/generated/java/com/github/copilot/generated/ToolExecutionStartToolDescriptionMeta.java b/java/sdk/src/generated/java/com/github/copilot/generated/ToolExecutionStartToolDescriptionMeta.java similarity index 100% rename from java/src/generated/java/com/github/copilot/generated/ToolExecutionStartToolDescriptionMeta.java rename to java/sdk/src/generated/java/com/github/copilot/generated/ToolExecutionStartToolDescriptionMeta.java diff --git a/java/src/generated/java/com/github/copilot/generated/ToolExecutionStartToolDescriptionMetaUI.java b/java/sdk/src/generated/java/com/github/copilot/generated/ToolExecutionStartToolDescriptionMetaUI.java similarity index 100% rename from java/src/generated/java/com/github/copilot/generated/ToolExecutionStartToolDescriptionMetaUI.java rename to java/sdk/src/generated/java/com/github/copilot/generated/ToolExecutionStartToolDescriptionMetaUI.java diff --git a/java/src/generated/java/com/github/copilot/generated/ToolExecutionStartToolDescriptionMetaUIVisibility.java b/java/sdk/src/generated/java/com/github/copilot/generated/ToolExecutionStartToolDescriptionMetaUIVisibility.java similarity index 100% rename from java/src/generated/java/com/github/copilot/generated/ToolExecutionStartToolDescriptionMetaUIVisibility.java rename to java/sdk/src/generated/java/com/github/copilot/generated/ToolExecutionStartToolDescriptionMetaUIVisibility.java diff --git a/java/src/generated/java/com/github/copilot/generated/ToolSearchActivatedEvent.java b/java/sdk/src/generated/java/com/github/copilot/generated/ToolSearchActivatedEvent.java similarity index 100% rename from java/src/generated/java/com/github/copilot/generated/ToolSearchActivatedEvent.java rename to java/sdk/src/generated/java/com/github/copilot/generated/ToolSearchActivatedEvent.java 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 100% 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 diff --git a/java/sdk/src/generated/java/com/github/copilot/generated/UIEphemeralQueryPhase.java b/java/sdk/src/generated/java/com/github/copilot/generated/UIEphemeralQueryPhase.java new file mode 100644 index 0000000000..7798c159eb --- /dev/null +++ b/java/sdk/src/generated/java/com/github/copilot/generated/UIEphemeralQueryPhase.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; + +/** + * Lifecycle phase for a Rust-owned ephemeral query stream. + * + * @since 1.0.0 + */ +@javax.annotation.processing.Generated("copilot-sdk-codegen") +public enum UIEphemeralQueryPhase { + /** The {@code started} variant. */ + STARTED("started"), + /** The {@code chunk} variant. */ + CHUNK("chunk"), + /** The {@code completed} variant. */ + COMPLETED("completed"), + /** The {@code failed} variant. */ + FAILED("failed"), + /** The {@code aborted} variant. */ + ABORTED("aborted"); + + private final String value; + UIEphemeralQueryPhase(String value) { this.value = value; } + @com.fasterxml.jackson.annotation.JsonValue + public String getValue() { return value; } + @com.fasterxml.jackson.annotation.JsonCreator + public static UIEphemeralQueryPhase fromValue(String value) { + for (UIEphemeralQueryPhase v : values()) { + if (v.value.equals(value)) return v; + } + throw new IllegalArgumentException("Unknown UIEphemeralQueryPhase value: " + value); + } +} diff --git a/java/sdk/src/generated/java/com/github/copilot/generated/UiEphemeralQueryEvent.java b/java/sdk/src/generated/java/com/github/copilot/generated/UiEphemeralQueryEvent.java new file mode 100644 index 0000000000..b2f390e823 --- /dev/null +++ b/java/sdk/src/generated/java/com/github/copilot/generated/UiEphemeralQueryEvent.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 "ui.ephemeral_query". Ordered output and terminal state for a transient query that does not modify conversation history. + * @since 1.0.0 + */ +@JsonIgnoreProperties(ignoreUnknown = true) +@JsonInclude(JsonInclude.Include.NON_NULL) +@javax.annotation.processing.Generated("copilot-sdk-codegen") +public final class UiEphemeralQueryEvent extends SessionEvent { + + @Override + public String getType() { return "ui.ephemeral_query"; } + + @JsonProperty("data") + private UiEphemeralQueryEventData data; + + public UiEphemeralQueryEventData getData() { return data; } + public void setData(UiEphemeralQueryEventData data) { this.data = data; } + + /** Data payload for {@link UiEphemeralQueryEvent}. */ + @JsonIgnoreProperties(ignoreUnknown = true) + @JsonInclude(JsonInclude.Include.NON_NULL) + public record UiEphemeralQueryEventData( + /** Runtime-minted query identifier. */ + @JsonProperty("requestId") String requestId, + /** Current query lifecycle phase. */ + @JsonProperty("phase") UIEphemeralQueryPhase phase, + /** Ordered text delta, present for the `chunk` phase. */ + @JsonProperty("chunk") String chunk, + /** Full response text, present for the `completed` phase. */ + @JsonProperty("answer") String answer, + /** Model or transport failure message, present for the `failed` phase. */ + @JsonProperty("error") String error + ) { + } +} 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/src/generated/java/com/github/copilot/generated/UsageCheckpointModelCacheState.java b/java/sdk/src/generated/java/com/github/copilot/generated/UsageCheckpointModelCacheState.java similarity index 100% rename from java/src/generated/java/com/github/copilot/generated/UsageCheckpointModelCacheState.java rename to java/sdk/src/generated/java/com/github/copilot/generated/UsageCheckpointModelCacheState.java 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 100% 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 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 100% 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 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/src/generated/java/com/github/copilot/generated/UserMessageDelivery.java b/java/sdk/src/generated/java/com/github/copilot/generated/UserMessageDelivery.java similarity index 100% rename from java/src/generated/java/com/github/copilot/generated/UserMessageDelivery.java rename to java/sdk/src/generated/java/com/github/copilot/generated/UserMessageDelivery.java 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 92% 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 5af4842430..7d839087da 100644 --- a/java/src/generated/java/com/github/copilot/generated/UserMessageEvent.java +++ b/java/sdk/src/generated/java/com/github/copilot/generated/UserMessageEvent.java @@ -45,7 +45,7 @@ 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, @@ -55,6 +55,8 @@ public record UserMessageEventData( @JsonProperty("isAutopilotContinuation") Boolean isAutopilotContinuation, /** CAPI interaction ID for correlating this user message with its turn */ @JsonProperty("interactionId") String interactionId, + /** The agent-loop turn ID that consumed this message; absent when no agent-loop turn consumed it */ + @JsonProperty("turnId") String turnId, /** Parent agent task ID for background telemetry correlated to this user turn */ @JsonProperty("parentAgentTaskId") String parentAgentTaskId ) { diff --git a/java/src/generated/java/com/github/copilot/generated/Verbosity.java b/java/sdk/src/generated/java/com/github/copilot/generated/Verbosity.java similarity index 100% rename from java/src/generated/java/com/github/copilot/generated/Verbosity.java rename to java/sdk/src/generated/java/com/github/copilot/generated/Verbosity.java 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 813cd5e02f..e22fc461d6 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/src/generated/java/com/github/copilot/generated/package-info.java b/java/sdk/src/generated/java/com/github/copilot/generated/package-info.java similarity index 100% rename from java/src/generated/java/com/github/copilot/generated/package-info.java rename to java/sdk/src/generated/java/com/github/copilot/generated/package-info.java diff --git a/java/src/generated/java/com/github/copilot/generated/rpc/AbortReason.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/AbortReason.java similarity index 90% rename from java/src/generated/java/com/github/copilot/generated/rpc/AbortReason.java rename to java/sdk/src/generated/java/com/github/copilot/generated/rpc/AbortReason.java index a486400778..8d26959e80 100644 --- a/java/src/generated/java/com/github/copilot/generated/rpc/AbortReason.java +++ b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/AbortReason.java @@ -21,7 +21,9 @@ public enum AbortReason { /** The {@code remote_command} variant. */ REMOTE_COMMAND("remote_command"), /** The {@code user_abort} variant. */ - USER_ABORT("user_abort"); + 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; } diff --git a/java/src/generated/java/com/github/copilot/generated/rpc/AccountAllUsers.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/AccountAllUsers.java similarity index 89% rename from java/src/generated/java/com/github/copilot/generated/rpc/AccountAllUsers.java rename to java/sdk/src/generated/java/com/github/copilot/generated/rpc/AccountAllUsers.java index eecdad01ee..3f93dd7c60 100644 --- a/java/src/generated/java/com/github/copilot/generated/rpc/AccountAllUsers.java +++ b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/AccountAllUsers.java @@ -13,7 +13,7 @@ import javax.annotation.processing.Generated; /** - * Authenticated account entry returned by `account.getAllUsers`, with auth info and an optional associated token. + * Authenticated account entry returned by `account.getAllUsers`. * * @since 1.0.0 */ @@ -23,6 +23,8 @@ public record AccountAllUsers( /** Authentication information for this user */ @JsonProperty("authInfo") Object authInfo, + /** Opaque identifier accepted by account and model selection APIs */ + @JsonProperty("selectionId") String selectionId, /** Associated token, if available */ @JsonProperty("token") String token ) { diff --git a/java/src/generated/java/com/github/copilot/generated/rpc/AccountGetCurrentAuthResult.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/AccountGetCurrentAuthResult.java similarity index 100% rename from java/src/generated/java/com/github/copilot/generated/rpc/AccountGetCurrentAuthResult.java rename to java/sdk/src/generated/java/com/github/copilot/generated/rpc/AccountGetCurrentAuthResult.java 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 0000000000..9863b5d9c9 --- /dev/null +++ b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/AccountGetQuotaParams.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 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( + /** Opaque account identifier returned by `account.getAllUsers`. When omitted, the current account is used. */ + @JsonProperty("selectionId") String selectionId, + /** GitHub token accepted for compatibility with existing SDK clients. When provided, resolves this token instead of using the current account. */ + @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 100% 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 diff --git a/java/src/generated/java/com/github/copilot/generated/rpc/AccountLoginParams.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/AccountLoginParams.java similarity index 84% rename from java/src/generated/java/com/github/copilot/generated/rpc/AccountLoginParams.java rename to java/sdk/src/generated/java/com/github/copilot/generated/rpc/AccountLoginParams.java index bd8e697341..ca724fc675 100644 --- a/java/src/generated/java/com/github/copilot/generated/rpc/AccountLoginParams.java +++ b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/AccountLoginParams.java @@ -14,7 +14,7 @@ import javax.annotation.processing.Generated; /** - * Credentials to store after successful authentication + * Credentials to validate and store. Omit login to resolve the authenticated user from the token. * * @apiNote This method is experimental and may change in a future version. * @since 1.0.0 @@ -26,7 +26,7 @@ public record AccountLoginParams( /** GitHub host URL */ @JsonProperty("host") String host, - /** User login/username */ + /** User login/username. When omitted, the runtime validates the token and resolves the login from GitHub. */ @JsonProperty("login") String login, /** GitHub authentication token */ @JsonProperty("token") String token diff --git a/java/src/generated/java/com/github/copilot/generated/rpc/AccountLoginResult.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/AccountLoginResult.java similarity index 100% rename from java/src/generated/java/com/github/copilot/generated/rpc/AccountLoginResult.java rename to java/sdk/src/generated/java/com/github/copilot/generated/rpc/AccountLoginResult.java diff --git a/java/src/generated/java/com/github/copilot/generated/rpc/AccountLogoutParams.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/AccountLogoutParams.java similarity index 89% rename from java/src/generated/java/com/github/copilot/generated/rpc/AccountLogoutParams.java rename to java/sdk/src/generated/java/com/github/copilot/generated/rpc/AccountLogoutParams.java index b5e93e1859..b57aef87c4 100644 --- a/java/src/generated/java/com/github/copilot/generated/rpc/AccountLogoutParams.java +++ b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/AccountLogoutParams.java @@ -24,6 +24,8 @@ @JsonInclude(JsonInclude.Include.NON_NULL) @JsonIgnoreProperties(ignoreUnknown = true) public record AccountLogoutParams( + /** Opaque account identifier returned by `account.getAllUsers` */ + @JsonProperty("selectionId") String selectionId, /** Authentication information for the user to log out */ @JsonProperty("authInfo") Object authInfo ) { diff --git a/java/src/generated/java/com/github/copilot/generated/rpc/AccountLogoutResult.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/AccountLogoutResult.java similarity index 100% rename from java/src/generated/java/com/github/copilot/generated/rpc/AccountLogoutResult.java rename to java/sdk/src/generated/java/com/github/copilot/generated/rpc/AccountLogoutResult.java 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 100% 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 diff --git a/java/src/generated/java/com/github/copilot/generated/rpc/AdaptiveThinkingSupport.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/AdaptiveThinkingSupport.java similarity index 100% rename from java/src/generated/java/com/github/copilot/generated/rpc/AdaptiveThinkingSupport.java rename to java/sdk/src/generated/java/com/github/copilot/generated/rpc/AdaptiveThinkingSupport.java diff --git a/java/src/generated/java/com/github/copilot/generated/rpc/AgentDiscoveryPath.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/AgentDiscoveryPath.java similarity index 100% rename from java/src/generated/java/com/github/copilot/generated/rpc/AgentDiscoveryPath.java rename to java/sdk/src/generated/java/com/github/copilot/generated/rpc/AgentDiscoveryPath.java diff --git a/java/src/generated/java/com/github/copilot/generated/rpc/AgentDiscoveryPathScope.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/AgentDiscoveryPathScope.java similarity index 100% rename from java/src/generated/java/com/github/copilot/generated/rpc/AgentDiscoveryPathScope.java rename to java/sdk/src/generated/java/com/github/copilot/generated/rpc/AgentDiscoveryPathScope.java diff --git a/java/src/generated/java/com/github/copilot/generated/rpc/AgentInfo.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/AgentInfo.java similarity index 78% rename from java/src/generated/java/com/github/copilot/generated/rpc/AgentInfo.java rename to java/sdk/src/generated/java/com/github/copilot/generated/rpc/AgentInfo.java index 29813e30a0..f239c82e61 100644 --- a/java/src/generated/java/com/github/copilot/generated/rpc/AgentInfo.java +++ b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/AgentInfo.java @@ -15,7 +15,7 @@ import javax.annotation.processing.Generated; /** - * Custom agent metadata, including identifiers, display details, source, tools, model, MCP servers, skills, and file path. + * Agent metadata, including identifiers, display details, source, tools, model, MCP servers, skills, and file path. * * @since 1.0.0 */ @@ -23,7 +23,7 @@ @JsonInclude(JsonInclude.Include.NON_NULL) @JsonIgnoreProperties(ignoreUnknown = true) public record AgentInfo( - /** Unique identifier of the custom agent */ + /** Name of the agent. Use `id` as the stable selection identifier. */ @JsonProperty("name") String name, /** Human-readable display name */ @JsonProperty("displayName") String displayName, @@ -39,11 +39,13 @@ public record AgentInfo( @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. */ + /** 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 + @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/src/generated/java/com/github/copilot/generated/rpc/AgentRegistryLiveTargetEntry.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/AgentRegistryLiveTargetEntry.java similarity index 97% rename from java/src/generated/java/com/github/copilot/generated/rpc/AgentRegistryLiveTargetEntry.java rename to java/sdk/src/generated/java/com/github/copilot/generated/rpc/AgentRegistryLiveTargetEntry.java index 3e44993b96..c9e2ed2320 100644 --- a/java/src/generated/java/com/github/copilot/generated/rpc/AgentRegistryLiveTargetEntry.java +++ b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/AgentRegistryLiveTargetEntry.java @@ -31,8 +31,6 @@ public record AgentRegistryLiveTargetEntry( @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) */ @@ -56,6 +54,8 @@ public record AgentRegistryLiveTargetEntry( /** 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 + @JsonProperty("lastSeenMs") Long lastSeenMs, + /** Connection token (null when the target is unauthenticated) */ + @JsonProperty("token") String token ) { } diff --git a/java/src/generated/java/com/github/copilot/generated/rpc/AgentRegistryLiveTargetEntryAttentionKind.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/AgentRegistryLiveTargetEntryAttentionKind.java similarity index 100% rename from java/src/generated/java/com/github/copilot/generated/rpc/AgentRegistryLiveTargetEntryAttentionKind.java rename to java/sdk/src/generated/java/com/github/copilot/generated/rpc/AgentRegistryLiveTargetEntryAttentionKind.java diff --git a/java/src/generated/java/com/github/copilot/generated/rpc/AgentRegistryLiveTargetEntryKind.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/AgentRegistryLiveTargetEntryKind.java similarity index 100% rename from java/src/generated/java/com/github/copilot/generated/rpc/AgentRegistryLiveTargetEntryKind.java rename to java/sdk/src/generated/java/com/github/copilot/generated/rpc/AgentRegistryLiveTargetEntryKind.java diff --git a/java/src/generated/java/com/github/copilot/generated/rpc/AgentRegistryLiveTargetEntryLastTerminalEvent.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/AgentRegistryLiveTargetEntryLastTerminalEvent.java similarity index 100% rename from java/src/generated/java/com/github/copilot/generated/rpc/AgentRegistryLiveTargetEntryLastTerminalEvent.java rename to java/sdk/src/generated/java/com/github/copilot/generated/rpc/AgentRegistryLiveTargetEntryLastTerminalEvent.java diff --git a/java/src/generated/java/com/github/copilot/generated/rpc/AgentRegistryLiveTargetEntryStatus.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/AgentRegistryLiveTargetEntryStatus.java similarity index 100% rename from java/src/generated/java/com/github/copilot/generated/rpc/AgentRegistryLiveTargetEntryStatus.java rename to java/sdk/src/generated/java/com/github/copilot/generated/rpc/AgentRegistryLiveTargetEntryStatus.java diff --git a/java/src/generated/java/com/github/copilot/generated/rpc/AgentRegistryLogCapture.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/AgentRegistryLogCapture.java similarity index 100% rename from java/src/generated/java/com/github/copilot/generated/rpc/AgentRegistryLogCapture.java rename to java/sdk/src/generated/java/com/github/copilot/generated/rpc/AgentRegistryLogCapture.java diff --git a/java/src/generated/java/com/github/copilot/generated/rpc/AgentRegistryLogCaptureOpenErrorReason.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/AgentRegistryLogCaptureOpenErrorReason.java similarity index 100% rename from java/src/generated/java/com/github/copilot/generated/rpc/AgentRegistryLogCaptureOpenErrorReason.java rename to java/sdk/src/generated/java/com/github/copilot/generated/rpc/AgentRegistryLogCaptureOpenErrorReason.java diff --git a/java/src/generated/java/com/github/copilot/generated/rpc/AgentRegistrySpawnError.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/AgentRegistrySpawnError.java similarity index 100% rename from java/src/generated/java/com/github/copilot/generated/rpc/AgentRegistrySpawnError.java rename to java/sdk/src/generated/java/com/github/copilot/generated/rpc/AgentRegistrySpawnError.java 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 100% 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 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/src/generated/java/com/github/copilot/generated/rpc/AgentRegistrySpawnRegistryTimeout.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/AgentRegistrySpawnRegistryTimeout.java similarity index 100% rename from java/src/generated/java/com/github/copilot/generated/rpc/AgentRegistrySpawnRegistryTimeout.java rename to java/sdk/src/generated/java/com/github/copilot/generated/rpc/AgentRegistrySpawnRegistryTimeout.java diff --git a/java/src/generated/java/com/github/copilot/generated/rpc/AgentRegistrySpawnResult.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/AgentRegistrySpawnResult.java similarity index 100% rename from java/src/generated/java/com/github/copilot/generated/rpc/AgentRegistrySpawnResult.java rename to java/sdk/src/generated/java/com/github/copilot/generated/rpc/AgentRegistrySpawnResult.java diff --git a/java/src/generated/java/com/github/copilot/generated/rpc/AgentRegistrySpawnSpawned.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/AgentRegistrySpawnSpawned.java similarity index 100% rename from java/src/generated/java/com/github/copilot/generated/rpc/AgentRegistrySpawnSpawned.java rename to java/sdk/src/generated/java/com/github/copilot/generated/rpc/AgentRegistrySpawnSpawned.java diff --git a/java/src/generated/java/com/github/copilot/generated/rpc/AgentRegistrySpawnValidationError.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/AgentRegistrySpawnValidationError.java similarity index 100% rename from java/src/generated/java/com/github/copilot/generated/rpc/AgentRegistrySpawnValidationError.java rename to java/sdk/src/generated/java/com/github/copilot/generated/rpc/AgentRegistrySpawnValidationError.java diff --git a/java/src/generated/java/com/github/copilot/generated/rpc/AgentRegistrySpawnValidationErrorField.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/AgentRegistrySpawnValidationErrorField.java similarity index 100% rename from java/src/generated/java/com/github/copilot/generated/rpc/AgentRegistrySpawnValidationErrorField.java rename to java/sdk/src/generated/java/com/github/copilot/generated/rpc/AgentRegistrySpawnValidationErrorField.java diff --git a/java/src/generated/java/com/github/copilot/generated/rpc/AgentRegistrySpawnValidationErrorReason.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/AgentRegistrySpawnValidationErrorReason.java similarity index 100% rename from java/src/generated/java/com/github/copilot/generated/rpc/AgentRegistrySpawnValidationErrorReason.java rename to java/sdk/src/generated/java/com/github/copilot/generated/rpc/AgentRegistrySpawnValidationErrorReason.java diff --git a/java/src/generated/java/com/github/copilot/generated/rpc/AgentsDiscoverParams.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/AgentsDiscoverParams.java similarity index 100% rename from java/src/generated/java/com/github/copilot/generated/rpc/AgentsDiscoverParams.java rename to java/sdk/src/generated/java/com/github/copilot/generated/rpc/AgentsDiscoverParams.java diff --git a/java/src/generated/java/com/github/copilot/generated/rpc/AgentsDiscoverResult.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/AgentsDiscoverResult.java similarity index 100% rename from java/src/generated/java/com/github/copilot/generated/rpc/AgentsDiscoverResult.java rename to java/sdk/src/generated/java/com/github/copilot/generated/rpc/AgentsDiscoverResult.java diff --git a/java/src/generated/java/com/github/copilot/generated/rpc/AgentsGetDiscoveryPathsParams.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/AgentsGetDiscoveryPathsParams.java similarity index 100% rename from java/src/generated/java/com/github/copilot/generated/rpc/AgentsGetDiscoveryPathsParams.java rename to java/sdk/src/generated/java/com/github/copilot/generated/rpc/AgentsGetDiscoveryPathsParams.java diff --git a/java/src/generated/java/com/github/copilot/generated/rpc/AgentsGetDiscoveryPathsResult.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/AgentsGetDiscoveryPathsResult.java similarity index 100% rename from java/src/generated/java/com/github/copilot/generated/rpc/AgentsGetDiscoveryPathsResult.java rename to java/sdk/src/generated/java/com/github/copilot/generated/rpc/AgentsGetDiscoveryPathsResult.java diff --git a/java/sdk/src/generated/java/com/github/copilot/generated/rpc/ApiKeyAuthInfo.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/ApiKeyAuthInfo.java new file mode 100644 index 0000000000..fecbfff415 --- /dev/null +++ b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/ApiKeyAuthInfo.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; + +/** + * Authentication-info input variant for API-key authentication to a non-GitHub LLM provider, carrying the secret `apiKey` and host. + * + * @since 1.0.0 + */ +@JsonIgnoreProperties(ignoreUnknown = true) +@JsonInclude(JsonInclude.Include.NON_NULL) +@javax.annotation.processing.Generated("copilot-sdk-codegen") +public final class ApiKeyAuthInfo extends AuthInfo { + + @JsonProperty("type") + private final String type = "api-key"; + + @Override + public String getType() { return type; } + + /** The API key. Treat as a secret. */ + @JsonProperty("apiKey") + private String apiKey; + + /** Authentication host. */ + @JsonProperty("host") + private String host; + + /** 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. */ + @JsonProperty("copilotUser") + private CopilotUserResponse copilotUser; + + public String getApiKey() { return apiKey; } + public void setApiKey(String apiKey) { this.apiKey = apiKey; } + + public String getHost() { return host; } + public void setHost(String host) { this.host = host; } + + public CopilotUserResponse getCopilotUser() { return copilotUser; } + public void setCopilotUser(CopilotUserResponse copilotUser) { this.copilotUser = copilotUser; } +} diff --git a/java/sdk/src/generated/java/com/github/copilot/generated/rpc/AuthInfo.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/AuthInfo.java new file mode 100644 index 0000000000..5d82a47f85 --- /dev/null +++ b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/AuthInfo.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.JsonSubTypes; +import com.fasterxml.jackson.annotation.JsonTypeInfo; +import javax.annotation.processing.Generated; + +/** + * Authentication credentials accepted only at native protocol ingress. Runtime outputs use credential-free `AuthIdentity` metadata. + * + * @since 1.0.0 + */ +@JsonTypeInfo(use = JsonTypeInfo.Id.NAME, property = "type", visible = true) +@JsonSubTypes({ + @JsonSubTypes.Type(value = HMACAuthInfo.class, name = "hmac"), + @JsonSubTypes.Type(value = EnvAuthInfo.class, name = "env"), + @JsonSubTypes.Type(value = TokenAuthInfo.class, name = "token"), + @JsonSubTypes.Type(value = TokenProviderAuthInfo.class, name = "token-provider"), + @JsonSubTypes.Type(value = CopilotApiTokenAuthInfo.class, name = "copilot-api-token"), + @JsonSubTypes.Type(value = UserAuthInfo.class, name = "user"), + @JsonSubTypes.Type(value = GhCliAuthInfo.class, name = "gh-cli"), + @JsonSubTypes.Type(value = ApiKeyAuthInfo.class, name = "api-key") +}) +@JsonIgnoreProperties(ignoreUnknown = true) +@javax.annotation.processing.Generated("copilot-sdk-codegen") +public abstract class AuthInfo { + + /** + * Returns the discriminator value for this variant. + * + * @return the type discriminator + */ + public abstract String getType(); +} 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 94% 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 index 1fb4b43ba4..5f81c8cf84 100644 --- 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 @@ -28,6 +28,8 @@ public enum AuthInfoType { API_KEY("api-key"), /** The {@code token} variant. */ TOKEN("token"), + /** The {@code token-provider} variant. */ + TOKEN_PROVIDER("token-provider"), /** The {@code copilot-api-token} variant. */ COPILOT_API_TOKEN("copilot-api-token"); diff --git a/java/sdk/src/generated/java/com/github/copilot/generated/rpc/AuthValidationError.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/AuthValidationError.java new file mode 100644 index 0000000000..99f78006fd --- /dev/null +++ b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/AuthValidationError.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; + +/** + * Validation error from an authentication attempt. + * + * @since 1.0.0 + */ +@javax.annotation.processing.Generated("copilot-sdk-codegen") +@JsonInclude(JsonInclude.Include.NON_NULL) +@JsonIgnoreProperties(ignoreUnknown = true) +public record AuthValidationError( + /** Authentication validation error message */ + @JsonProperty("message") String message, + /** Optional message returned by GitHub */ + @JsonProperty("githubMessage") String gitHubMessage +) { +} 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 0000000000..a3f751b418 --- /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 provider or provider-model metadata. 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/sdk/src/generated/java/com/github/copilot/generated/rpc/BuiltinToolDescriptor.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/BuiltinToolDescriptor.java new file mode 100644 index 0000000000..057498fb98 --- /dev/null +++ b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/BuiltinToolDescriptor.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; + +/** + * Rust-owned metadata and input schema for a built-in tool. + * + * @since 1.0.0 + */ +@javax.annotation.processing.Generated("copilot-sdk-codegen") +@JsonInclude(JsonInclude.Include.NON_NULL) +@JsonIgnoreProperties(ignoreUnknown = true) +public record BuiltinToolDescriptor( + /** Stable name used to invoke the built-in tool. */ + @JsonProperty("name") String name, + /** Optional human-readable title for the tool. */ + @JsonProperty("title") String title, + /** Model-facing description of the tool's behavior. */ + @JsonProperty("description") String description, + /** JSON Schema for the tool input, or null when the tool uses a custom format. */ + @JsonProperty("inputSchema") BuiltinToolInputSchema inputSchema, + /** Optional supplemental usage instructions for the tool. */ + @JsonProperty("instructions") String instructions, + /** Optional tool category discriminator. */ + @JsonProperty("type") String type, + /** Optional custom input format used instead of a JSON Schema. */ + @JsonProperty("format") BuiltinToolFormat format, + /** Policy describing which tool metadata may be recorded without obfuscation. */ + @JsonProperty("safeForTelemetry") Object safeForTelemetry, + /** Whether the tool executes commands in a terminal. */ + @JsonProperty("isTerminal") Boolean isTerminal, + /** Whether the tool provides a specialized intention summary. */ + @JsonProperty("hasSummariseIntention") Boolean hasSummariseIntention +) { +} diff --git a/java/sdk/src/generated/java/com/github/copilot/generated/rpc/BuiltinToolFormat.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/BuiltinToolFormat.java new file mode 100644 index 0000000000..7af5ef2d45 --- /dev/null +++ b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/BuiltinToolFormat.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; + +/** + * Custom grammar input format accepted by a built-in tool. + * + * @since 1.0.0 + */ +@javax.annotation.processing.Generated("copilot-sdk-codegen") +@JsonInclude(JsonInclude.Include.NON_NULL) +@JsonIgnoreProperties(ignoreUnknown = true) +public record BuiltinToolFormat( + /** Custom input-format discriminator. */ + @JsonProperty("type") BuiltinToolFormatType type, + /** Grammar syntax used by the format definition. */ + @JsonProperty("syntax") String syntax, + /** Grammar definition accepted by the tool. */ + @JsonProperty("definition") String definition +) { +} diff --git a/java/sdk/src/generated/java/com/github/copilot/generated/rpc/BuiltinToolFormatType.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/BuiltinToolFormatType.java new file mode 100644 index 0000000000..6239493671 --- /dev/null +++ b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/BuiltinToolFormatType.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 javax.annotation.processing.Generated; + +/** + * Custom input-format kind. + * + * @since 1.0.0 + */ +@javax.annotation.processing.Generated("copilot-sdk-codegen") +public enum BuiltinToolFormatType { + /** The {@code grammar} variant. */ + GRAMMAR("grammar"); + + private final String value; + BuiltinToolFormatType(String value) { this.value = value; } + @com.fasterxml.jackson.annotation.JsonValue + public String getValue() { return value; } + @com.fasterxml.jackson.annotation.JsonCreator + public static BuiltinToolFormatType fromValue(String value) { + for (BuiltinToolFormatType v : values()) { + if (v.value.equals(value)) return v; + } + throw new IllegalArgumentException("Unknown BuiltinToolFormatType value: " + value); + } +} diff --git a/java/sdk/src/generated/java/com/github/copilot/generated/rpc/BuiltinToolInputSchema.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/BuiltinToolInputSchema.java new file mode 100644 index 0000000000..764450b37e --- /dev/null +++ b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/BuiltinToolInputSchema.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; + +/** + * JSON Schema object accepted by a built-in tool. + * + * @since 1.0.0 + */ +@javax.annotation.processing.Generated("copilot-sdk-codegen") +@JsonInclude(JsonInclude.Include.NON_NULL) +@JsonIgnoreProperties(ignoreUnknown = true) +public record BuiltinToolInputSchema( + /** Root type of the tool input schema. */ + @JsonProperty("type") BuiltinToolInputSchemaType type +) { +} diff --git a/java/sdk/src/generated/java/com/github/copilot/generated/rpc/BuiltinToolInputSchemaType.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/BuiltinToolInputSchemaType.java new file mode 100644 index 0000000000..729f3329b5 --- /dev/null +++ b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/BuiltinToolInputSchemaType.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 javax.annotation.processing.Generated; + +/** + * Root JSON Schema type for a built-in tool input. + * + * @since 1.0.0 + */ +@javax.annotation.processing.Generated("copilot-sdk-codegen") +public enum BuiltinToolInputSchemaType { + /** The {@code object} variant. */ + OBJECT("object"); + + private final String value; + BuiltinToolInputSchemaType(String value) { this.value = value; } + @com.fasterxml.jackson.annotation.JsonValue + public String getValue() { return value; } + @com.fasterxml.jackson.annotation.JsonCreator + public static BuiltinToolInputSchemaType fromValue(String value) { + for (BuiltinToolInputSchemaType v : values()) { + if (v.value.equals(value)) return v; + } + throw new IllegalArgumentException("Unknown BuiltinToolInputSchemaType value: " + value); + } +} 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/src/generated/java/com/github/copilot/generated/rpc/CanvasActionInvokeParams.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/CanvasActionInvokeParams.java similarity index 100% rename from java/src/generated/java/com/github/copilot/generated/rpc/CanvasActionInvokeParams.java rename to java/sdk/src/generated/java/com/github/copilot/generated/rpc/CanvasActionInvokeParams.java 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 100% 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 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 100% 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 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 100% 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 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/src/generated/java/com/github/copilot/generated/rpc/CapiSessionOptions.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/CapiSessionOptions.java similarity index 100% rename from java/src/generated/java/com/github/copilot/generated/rpc/CapiSessionOptions.java rename to java/sdk/src/generated/java/com/github/copilot/generated/rpc/CapiSessionOptions.java diff --git a/java/sdk/src/generated/java/com/github/copilot/generated/rpc/CardDigest.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/CardDigest.java new file mode 100644 index 0000000000..f14f9abdfc --- /dev/null +++ b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/CardDigest.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; + +/** + * Semantic digest of a strictly parsed and schema-validated JSON MCP card. Both URL-backed and embedded cards are canonicalised with RFC 8785 JSON Canonicalization Scheme, encoded as UTF-8, and hashed with SHA-256. + * + * @since 1.0.0 + */ +@javax.annotation.processing.Generated("copilot-sdk-codegen") +@JsonInclude(JsonInclude.Include.NON_NULL) +@JsonIgnoreProperties(ignoreUnknown = true) +public record CardDigest( + /** Digest algorithm and canonical representation */ + @JsonProperty("algorithm") CardDigestAlgorithm algorithm, + /** SHA-256 digest of the RFC 8785 canonical UTF-8 bytes, encoded as exactly 64 lowercase hexadecimal characters. */ + @JsonProperty("value") String value +) { +} diff --git a/java/sdk/src/generated/java/com/github/copilot/generated/rpc/CardDigestAlgorithm.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/CardDigestAlgorithm.java new file mode 100644 index 0000000000..83a691705b --- /dev/null +++ b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/CardDigestAlgorithm.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 javax.annotation.processing.Generated; + +/** + * Canonical digest algorithm for a validated MCP card + * + * @since 1.0.0 + */ +@javax.annotation.processing.Generated("copilot-sdk-codegen") +public enum CardDigestAlgorithm { + /** The {@code sha256-rfc8785} variant. */ + SHA256_RFC8785("sha256-rfc8785"); + + private final String value; + CardDigestAlgorithm(String value) { this.value = value; } + @com.fasterxml.jackson.annotation.JsonValue + public String getValue() { return value; } + @com.fasterxml.jackson.annotation.JsonCreator + public static CardDigestAlgorithm fromValue(String value) { + for (CardDigestAlgorithm v : values()) { + if (v.value.equals(value)) return v; + } + throw new IllegalArgumentException("Unknown CardDigestAlgorithm value: " + value); + } +} diff --git a/java/sdk/src/generated/java/com/github/copilot/generated/rpc/CatalogAuthenticationRequiredError.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/CatalogAuthenticationRequiredError.java new file mode 100644 index 0000000000..3433f0e977 --- /dev/null +++ b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/CatalogAuthenticationRequiredError.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; + +/** + * An optional catalog authentication exchange did not establish the caller's identity. Anonymous search remains supported; this refusal is reserved for an operation that cannot continue after the attempted exchange. It is distinct from `policy-rejected` and from a network failure, and the reason identifies the recovery action. + * + * @since 1.0.0 + */ +@JsonIgnoreProperties(ignoreUnknown = true) +@JsonInclude(JsonInclude.Include.NON_NULL) +@javax.annotation.processing.Generated("copilot-sdk-codegen") +public final class CatalogAuthenticationRequiredError extends CatalogSearchResult { + + @JsonProperty("kind") + private final String kind = "authentication-required"; + + @Override + public String getKind() { return kind; } + + /** Why authentication failed. Only an expired credential justifies attempting a silent refresh; an absent or rejected credential requires sign-in. */ + @JsonProperty("reason") + private CatalogAuthenticationRequiredReason reason; + + /** Human-readable explanation, safe to surface. Never contains a credential or token, nor a query, URL, handle, or secret. */ + @JsonProperty("message") + private String message; + + public CatalogAuthenticationRequiredReason getReason() { return reason; } + public void setReason(CatalogAuthenticationRequiredReason reason) { this.reason = reason; } + + 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/CatalogAuthenticationRequiredReason.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/CatalogAuthenticationRequiredReason.java new file mode 100644 index 0000000000..1c87593273 --- /dev/null +++ b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/CatalogAuthenticationRequiredReason.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; + +/** + * Why the catalog authority did not accept the caller's identity + * + * @since 1.0.0 + */ +@javax.annotation.processing.Generated("copilot-sdk-codegen") +public enum CatalogAuthenticationRequiredReason { + /** The {@code no-credential} variant. */ + NO_CREDENTIAL("no-credential"), + /** The {@code credential-expired} variant. */ + CREDENTIAL_EXPIRED("credential-expired"), + /** The {@code credential-rejected} variant. */ + CREDENTIAL_REJECTED("credential-rejected"); + + private final String value; + CatalogAuthenticationRequiredReason(String value) { this.value = value; } + @com.fasterxml.jackson.annotation.JsonValue + public String getValue() { return value; } + @com.fasterxml.jackson.annotation.JsonCreator + public static CatalogAuthenticationRequiredReason fromValue(String value) { + for (CatalogAuthenticationRequiredReason v : values()) { + if (v.value.equals(value)) return v; + } + throw new IllegalArgumentException("Unknown CatalogAuthenticationRequiredReason value: " + value); + } +} diff --git a/java/sdk/src/generated/java/com/github/copilot/generated/rpc/CatalogCandidateKind.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/CatalogCandidateKind.java new file mode 100644 index 0000000000..e7316cf872 --- /dev/null +++ b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/CatalogCandidateKind.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; + +/** + * What kind of resource a catalog candidate describes + * + * @since 1.0.0 + */ +@javax.annotation.processing.Generated("copilot-sdk-codegen") +public enum CatalogCandidateKind { + /** The {@code mcp-server} variant. */ + MCP_SERVER("mcp-server"), + /** The {@code ai-skill} variant. */ + AI_SKILL("ai-skill"); + + private final String value; + CatalogCandidateKind(String value) { this.value = value; } + @com.fasterxml.jackson.annotation.JsonValue + public String getValue() { return value; } + @com.fasterxml.jackson.annotation.JsonCreator + public static CatalogCandidateKind fromValue(String value) { + for (CatalogCandidateKind v : values()) { + if (v.value.equals(value)) return v; + } + throw new IllegalArgumentException("Unknown CatalogCandidateKind value: " + value); + } +} diff --git a/java/sdk/src/generated/java/com/github/copilot/generated/rpc/CatalogCapability.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/CatalogCapability.java new file mode 100644 index 0000000000..bb1662ba27 --- /dev/null +++ b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/CatalogCapability.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; + +/** + * A wire feature a caller can require of the catalog surface, negotiated per request. A grant means the runtime understands the feature's contract, not that the deployment has enabled the operation; typed unavailable results report availability separately. + * + * @since 1.0.0 + */ +@javax.annotation.processing.Generated("copilot-sdk-codegen") +public enum CatalogCapability { + /** The {@code mcp-server-card} variant. */ + MCP_SERVER_CARD("mcp-server-card"), + /** The {@code legacy-mcp-server-card} variant. */ + LEGACY_MCP_SERVER_CARD("legacy-mcp-server-card"), + /** The {@code ai-skill-discovery} variant. */ + AI_SKILL_DISCOVERY("ai-skill-discovery"), + /** The {@code mcp-install-planning} variant. */ + MCP_INSTALL_PLANNING("mcp-install-planning"), + /** The {@code multiple-transport-choice} variant. */ + MULTIPLE_TRANSPORT_CHOICE("multiple-transport-choice"); + + private final String value; + CatalogCapability(String value) { this.value = value; } + @com.fasterxml.jackson.annotation.JsonValue + public String getValue() { return value; } + @com.fasterxml.jackson.annotation.JsonCreator + public static CatalogCapability fromValue(String value) { + for (CatalogCapability v : values()) { + if (v.value.equals(value)) return v; + } + throw new IllegalArgumentException("Unknown CatalogCapability value: " + value); + } +} diff --git a/java/sdk/src/generated/java/com/github/copilot/generated/rpc/CatalogClientContract.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/CatalogClientContract.java new file mode 100644 index 0000000000..62cf8db22c --- /dev/null +++ b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/CatalogClientContract.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; + +/** + * The protocol version and capability set a caller requires, supplied on every catalog request so negotiation cannot be skipped by omission. + * + * @since 1.0.0 + */ +@javax.annotation.processing.Generated("copilot-sdk-codegen") +@JsonInclude(JsonInclude.Include.NON_NULL) +@JsonIgnoreProperties(ignoreUnknown = true) +public record CatalogClientContract( + /** SDK protocol version the caller was generated against. A caller below the runtime's minimum supported version is refused rather than served a partial result. */ + @JsonProperty("protocolVersion") Long protocolVersion, + /** Wire features the caller requires the runtime to understand. Identifiers are bounded but extensible so a newer caller can negotiate with an older runtime. Requiring an unknown feature yields a typed refusal listing what is understood, never a partial grant. A grant does not promise that a deployment has enabled the operation; typed unavailable results report that separately. */ + @JsonProperty("requiredCapabilities") List requiredCapabilities +) { +} diff --git a/java/sdk/src/generated/java/com/github/copilot/generated/rpc/CatalogContractViolationError.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/CatalogContractViolationError.java new file mode 100644 index 0000000000..5951d75a5e --- /dev/null +++ b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/CatalogContractViolationError.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; + +/** + * An upstream catalog response broke the wire contract. Most importantly, every result must carry exactly one of a URL or embedded data: a result carrying both, or neither, is refused here rather than being guessed at. + * + * @since 1.0.0 + */ +@JsonIgnoreProperties(ignoreUnknown = true) +@JsonInclude(JsonInclude.Include.NON_NULL) +@javax.annotation.processing.Generated("copilot-sdk-codegen") +public final class CatalogContractViolationError extends CatalogSearchResult { + + @JsonProperty("kind") + private final String kind = "contract-violation"; + + @Override + public String getKind() { return kind; } + + /** Which rule the response broke. */ + @JsonProperty("reason") + private CatalogContractViolationReason reason; + + /** Human-readable explanation, safe to surface. Never echoes response content, nor a query, URL, handle, or secret. */ + @JsonProperty("message") + private String message; + + public CatalogContractViolationReason getReason() { return reason; } + public void setReason(CatalogContractViolationReason reason) { this.reason = reason; } + + 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/CatalogContractViolationReason.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/CatalogContractViolationReason.java new file mode 100644 index 0000000000..f289d67666 --- /dev/null +++ b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/CatalogContractViolationReason.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 wire-contract rule an upstream response broke + * + * @since 1.0.0 + */ +@javax.annotation.processing.Generated("copilot-sdk-codegen") +public enum CatalogContractViolationReason { + /** The {@code both-url-and-data} variant. */ + BOTH_URL_AND_DATA("both-url-and-data"), + /** The {@code neither-url-nor-data} variant. */ + NEITHER_URL_NOR_DATA("neither-url-nor-data"), + /** The {@code duplicate-identity} variant. */ + DUPLICATE_IDENTITY("duplicate-identity"), + /** The {@code unknown-media-type} variant. */ + UNKNOWN_MEDIA_TYPE("unknown-media-type"); + + private final String value; + CatalogContractViolationReason(String value) { this.value = value; } + @com.fasterxml.jackson.annotation.JsonValue + public String getValue() { return value; } + @com.fasterxml.jackson.annotation.JsonCreator + public static CatalogContractViolationReason fromValue(String value) { + for (CatalogContractViolationReason v : values()) { + if (v.value.equals(value)) return v; + } + throw new IllegalArgumentException("Unknown CatalogContractViolationReason value: " + value); + } +} diff --git a/java/sdk/src/generated/java/com/github/copilot/generated/rpc/CatalogHandleRejectedError.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/CatalogHandleRejectedError.java new file mode 100644 index 0000000000..7469d6194d --- /dev/null +++ b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/CatalogHandleRejectedError.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; + +/** + * A presented handle was not accepted. Handles are runtime-instance scoped, TTL-bound, and single-use, so each way of failing is reported distinctly. + * + * @since 1.0.0 + */ +@JsonIgnoreProperties(ignoreUnknown = true) +@JsonInclude(JsonInclude.Include.NON_NULL) +@javax.annotation.processing.Generated("copilot-sdk-codegen") +public final class CatalogHandleRejectedError extends McpPlanInstallResult { + + @JsonProperty("kind") + private final String kind = "handle-rejected"; + + @Override + public String getKind() { return kind; } + + /** Which kind of handle was presented. */ + @JsonProperty("handleType") + private CatalogHandleType handleType; + + /** Why the handle was rejected. */ + @JsonProperty("reason") + private CatalogHandleRejectionReason reason; + + /** Human-readable explanation, safe to surface. Never contains the handle itself, nor a query, URL, or secret. */ + @JsonProperty("message") + private String message; + + public CatalogHandleType getHandleType() { return handleType; } + public void setHandleType(CatalogHandleType handleType) { this.handleType = handleType; } + + public CatalogHandleRejectionReason getReason() { return reason; } + public void setReason(CatalogHandleRejectionReason reason) { this.reason = reason; } + + 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/CatalogHandleRejectionReason.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/CatalogHandleRejectionReason.java new file mode 100644 index 0000000000..6db6b69365 --- /dev/null +++ b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/CatalogHandleRejectionReason.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; + +/** + * Why a presented handle was rejected + * + * @since 1.0.0 + */ +@javax.annotation.processing.Generated("copilot-sdk-codegen") +public enum CatalogHandleRejectionReason { + /** The {@code invalid} variant. */ + INVALID("invalid"), + /** The {@code stale} variant. */ + STALE("stale"), + /** The {@code replayed} variant. */ + REPLAYED("replayed"), + /** The {@code foreign} variant. */ + FOREIGN("foreign"); + + private final String value; + CatalogHandleRejectionReason(String value) { this.value = value; } + @com.fasterxml.jackson.annotation.JsonValue + public String getValue() { return value; } + @com.fasterxml.jackson.annotation.JsonCreator + public static CatalogHandleRejectionReason fromValue(String value) { + for (CatalogHandleRejectionReason v : values()) { + if (v.value.equals(value)) return v; + } + throw new IllegalArgumentException("Unknown CatalogHandleRejectionReason value: " + value); + } +} diff --git a/java/sdk/src/generated/java/com/github/copilot/generated/rpc/CatalogHandleType.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/CatalogHandleType.java new file mode 100644 index 0000000000..a14ceef85b --- /dev/null +++ b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/CatalogHandleType.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 kind of opaque handle was presented + * + * @since 1.0.0 + */ +@javax.annotation.processing.Generated("copilot-sdk-codegen") +public enum CatalogHandleType { + /** The {@code candidate} variant. */ + CANDIDATE("candidate"), + /** The {@code plan} variant. */ + PLAN("plan"); + + private final String value; + CatalogHandleType(String value) { this.value = value; } + @com.fasterxml.jackson.annotation.JsonValue + public String getValue() { return value; } + @com.fasterxml.jackson.annotation.JsonCreator + public static CatalogHandleType fromValue(String value) { + for (CatalogHandleType v : values()) { + if (v.value.equals(value)) return v; + } + throw new IllegalArgumentException("Unknown CatalogHandleType value: " + value); + } +} diff --git a/java/sdk/src/generated/java/com/github/copilot/generated/rpc/CatalogInvalidRequestError.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/CatalogInvalidRequestError.java new file mode 100644 index 0000000000..0f9eb7e769 --- /dev/null +++ b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/CatalogInvalidRequestError.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; + +/** + * The request was rejected before any work was done, because a bounded field fell outside its permitted range or a required field was unusable. + * + * @since 1.0.0 + */ +@JsonIgnoreProperties(ignoreUnknown = true) +@JsonInclude(JsonInclude.Include.NON_NULL) +@javax.annotation.processing.Generated("copilot-sdk-codegen") +public final class CatalogInvalidRequestError extends CatalogSearchResult { + + @JsonProperty("kind") + private final String kind = "invalid-request"; + + @Override + public String getKind() { return kind; } + + /** Which request field was rejected. */ + @JsonProperty("field") + private CatalogInvalidRequestField field; + + /** Human-readable explanation, safe to surface. Never echoes the offending value, nor a query, URL, handle, or secret. */ + @JsonProperty("message") + private String message; + + public CatalogInvalidRequestField getField() { return field; } + public void setField(CatalogInvalidRequestField 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/CatalogInvalidRequestField.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/CatalogInvalidRequestField.java new file mode 100644 index 0000000000..b930640163 --- /dev/null +++ b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/CatalogInvalidRequestField.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; + +/** + * Which request field was rejected before any work was done + * + * @since 1.0.0 + */ +@javax.annotation.processing.Generated("copilot-sdk-codegen") +public enum CatalogInvalidRequestField { + /** The {@code query} variant. */ + QUERY("query"), + /** The {@code limit} variant. */ + LIMIT("limit"), + /** The {@code kinds} variant. */ + KINDS("kinds"), + /** The {@code contract} variant. */ + CONTRACT("contract"), + /** The {@code source} variant. */ + SOURCE("source"), + /** The {@code card} variant. */ + CARD("card"), + /** The {@code scope} variant. */ + SCOPE("scope"); + + private final String value; + CatalogInvalidRequestField(String value) { this.value = value; } + @com.fasterxml.jackson.annotation.JsonValue + public String getValue() { return value; } + @com.fasterxml.jackson.annotation.JsonCreator + public static CatalogInvalidRequestField fromValue(String value) { + for (CatalogInvalidRequestField v : values()) { + if (v.value.equals(value)) return v; + } + throw new IllegalArgumentException("Unknown CatalogInvalidRequestField value: " + value); + } +} diff --git a/java/sdk/src/generated/java/com/github/copilot/generated/rpc/CatalogMalformedCardError.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/CatalogMalformedCardError.java new file mode 100644 index 0000000000..24cb5cae13 --- /dev/null +++ b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/CatalogMalformedCardError.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; + +/** + * A card could not be parsed or did not satisfy its declared media type's schema. + * + * @since 1.0.0 + */ +@JsonIgnoreProperties(ignoreUnknown = true) +@JsonInclude(JsonInclude.Include.NON_NULL) +@javax.annotation.processing.Generated("copilot-sdk-codegen") +public final class CatalogMalformedCardError extends CatalogSearchResult { + + @JsonProperty("kind") + private final String kind = "malformed-card"; + + @Override + public String getKind() { return kind; } + + /** How the card failed validation. */ + @JsonProperty("reason") + private CatalogMalformedCardReason reason; + + /** Media type the card was interpreted as, when it declared one this runtime recognises. */ + @JsonProperty("mediaType") + private CatalogMediaType mediaType; + + /** Human-readable explanation, safe to surface. Never echoes card content, nor a query, URL, handle, or secret. */ + @JsonProperty("message") + private String message; + + public CatalogMalformedCardReason getReason() { return reason; } + public void setReason(CatalogMalformedCardReason reason) { this.reason = reason; } + + public CatalogMediaType getMediaType() { return mediaType; } + public void setMediaType(CatalogMediaType mediaType) { this.mediaType = mediaType; } + + 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/CatalogMalformedCardReason.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/CatalogMalformedCardReason.java new file mode 100644 index 0000000000..17c1a05407 --- /dev/null +++ b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/CatalogMalformedCardReason.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; + +/** + * How a card failed validation + * + * @since 1.0.0 + */ +@javax.annotation.processing.Generated("copilot-sdk-codegen") +public enum CatalogMalformedCardReason { + /** The {@code invalid-json} variant. */ + INVALID_JSON("invalid-json"), + /** The {@code schema-violation} variant. */ + SCHEMA_VIOLATION("schema-violation"), + /** The {@code unsupported-media-type} variant. */ + UNSUPPORTED_MEDIA_TYPE("unsupported-media-type"), + /** The {@code missing-required-field} variant. */ + MISSING_REQUIRED_FIELD("missing-required-field"), + /** The {@code size-limit-exceeded} variant. */ + SIZE_LIMIT_EXCEEDED("size-limit-exceeded"); + + private final String value; + CatalogMalformedCardReason(String value) { this.value = value; } + @com.fasterxml.jackson.annotation.JsonValue + public String getValue() { return value; } + @com.fasterxml.jackson.annotation.JsonCreator + public static CatalogMalformedCardReason fromValue(String value) { + for (CatalogMalformedCardReason v : values()) { + if (v.value.equals(value)) return v; + } + throw new IllegalArgumentException("Unknown CatalogMalformedCardReason value: " + value); + } +} diff --git a/java/sdk/src/generated/java/com/github/copilot/generated/rpc/CatalogMediaType.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/CatalogMediaType.java new file mode 100644 index 0000000000..1528b052ee --- /dev/null +++ b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/CatalogMediaType.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; + +/** + * Media type a catalog card is interpreted as + * + * @since 1.0.0 + */ +@javax.annotation.processing.Generated("copilot-sdk-codegen") +public enum CatalogMediaType { + /** The {@code application/mcp-server-card+json} variant. */ + APPLICATION_MCP_SERVER_CARD_JSON("application/mcp-server-card+json"), + /** The {@code application/mcp-server+json} variant. */ + APPLICATION_MCP_SERVER_JSON("application/mcp-server+json"), + /** The {@code application/ai-skill} variant. */ + APPLICATION_AI_SKILL("application/ai-skill"); + + private final String value; + CatalogMediaType(String value) { this.value = value; } + @com.fasterxml.jackson.annotation.JsonValue + public String getValue() { return value; } + @com.fasterxml.jackson.annotation.JsonCreator + public static CatalogMediaType fromValue(String value) { + for (CatalogMediaType v : values()) { + if (v.value.equals(value)) return v; + } + throw new IllegalArgumentException("Unknown CatalogMediaType value: " + value); + } +} diff --git a/java/sdk/src/generated/java/com/github/copilot/generated/rpc/CatalogNegotiatedContract.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/CatalogNegotiatedContract.java new file mode 100644 index 0000000000..379525fc28 --- /dev/null +++ b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/CatalogNegotiatedContract.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; + +/** + * The protocol version and capability set the runtime actually honoured for a successful catalog operation. + * + * @since 1.0.0 + */ +@javax.annotation.processing.Generated("copilot-sdk-codegen") +@JsonInclude(JsonInclude.Include.NON_NULL) +@JsonIgnoreProperties(ignoreUnknown = true) +public record CatalogNegotiatedContract( + /** Protocol version of the runtime that served the request. */ + @JsonProperty("runtimeProtocolVersion") Long runtimeProtocolVersion, + /** Wire features the runtime understood for this operation. Always a superset of the caller's required features, because any shortfall is a refusal instead. Operation availability remains a separate typed result. */ + @JsonProperty("grantedCapabilities") List grantedCapabilities +) { +} diff --git a/java/sdk/src/generated/java/com/github/copilot/generated/rpc/CatalogNegotiationRefusedError.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/CatalogNegotiationRefusedError.java new file mode 100644 index 0000000000..56e20d3b4e --- /dev/null +++ b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/CatalogNegotiationRefusedError.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.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; + +/** + * The caller's protocol version or required capabilities cannot be honoured. Returned instead of a partial or ambiguous success. + * + * @since 1.0.0 + */ +@JsonIgnoreProperties(ignoreUnknown = true) +@JsonInclude(JsonInclude.Include.NON_NULL) +@javax.annotation.processing.Generated("copilot-sdk-codegen") +public final class CatalogNegotiationRefusedError extends CatalogSearchResult { + + @JsonProperty("kind") + private final String kind = "negotiation-refused"; + + @Override + public String getKind() { return kind; } + + /** Whether the version or the capability set was the problem. */ + @JsonProperty("reason") + private CatalogNegotiationRefusedReason reason; + + /** Protocol version of the runtime that refused the request. */ + @JsonProperty("runtimeProtocolVersion") + private Long runtimeProtocolVersion; + + /** Lowest caller protocol version this runtime will serve. */ + @JsonProperty("minimumSupportedProtocolVersion") + private Long minimumSupportedProtocolVersion; + + /** Every wire feature this runtime understands, so the caller can retry within that contract. This list does not imply that every deployment has enabled every operation. */ + @JsonProperty("supportedCapabilities") + private List supportedCapabilities; + + /** The subset of the caller's bounded extensible capability identifiers this runtime cannot honour. */ + @JsonProperty("unsupportedCapabilities") + private List unsupportedCapabilities; + + /** Human-readable explanation, safe to surface. Never contains a query, URL, handle, or secret. */ + @JsonProperty("message") + private String message; + + public CatalogNegotiationRefusedReason getReason() { return reason; } + public void setReason(CatalogNegotiationRefusedReason reason) { this.reason = reason; } + + public Long getRuntimeProtocolVersion() { return runtimeProtocolVersion; } + public void setRuntimeProtocolVersion(Long runtimeProtocolVersion) { this.runtimeProtocolVersion = runtimeProtocolVersion; } + + public Long getMinimumSupportedProtocolVersion() { return minimumSupportedProtocolVersion; } + public void setMinimumSupportedProtocolVersion(Long minimumSupportedProtocolVersion) { this.minimumSupportedProtocolVersion = minimumSupportedProtocolVersion; } + + public List getSupportedCapabilities() { return supportedCapabilities; } + public void setSupportedCapabilities(List supportedCapabilities) { this.supportedCapabilities = supportedCapabilities; } + + public List getUnsupportedCapabilities() { return unsupportedCapabilities; } + public void setUnsupportedCapabilities(List unsupportedCapabilities) { this.unsupportedCapabilities = unsupportedCapabilities; } + + 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/CatalogNegotiationRefusedReason.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/CatalogNegotiationRefusedReason.java new file mode 100644 index 0000000000..ee86246b4a --- /dev/null +++ b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/CatalogNegotiationRefusedReason.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; + +/** + * Why capability and protocol-version negotiation refused a caller + * + * @since 1.0.0 + */ +@javax.annotation.processing.Generated("copilot-sdk-codegen") +public enum CatalogNegotiationRefusedReason { + /** The {@code unsupported-protocol-version} variant. */ + UNSUPPORTED_PROTOCOL_VERSION("unsupported-protocol-version"), + /** The {@code unsupported-capability} variant. */ + UNSUPPORTED_CAPABILITY("unsupported-capability"); + + private final String value; + CatalogNegotiationRefusedReason(String value) { this.value = value; } + @com.fasterxml.jackson.annotation.JsonValue + public String getValue() { return value; } + @com.fasterxml.jackson.annotation.JsonCreator + public static CatalogNegotiationRefusedReason fromValue(String value) { + for (CatalogNegotiationRefusedReason v : values()) { + if (v.value.equals(value)) return v; + } + throw new IllegalArgumentException("Unknown CatalogNegotiationRefusedReason value: " + value); + } +} diff --git a/java/sdk/src/generated/java/com/github/copilot/generated/rpc/CatalogNetworkFailureError.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/CatalogNetworkFailureError.java new file mode 100644 index 0000000000..d4afb32c3d --- /dev/null +++ b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/CatalogNetworkFailureError.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; + +/** + * The runtime could not reach the catalog authority or retrieve a card. Covers being offline as well as transport-level failure. + * + * @since 1.0.0 + */ +@JsonIgnoreProperties(ignoreUnknown = true) +@JsonInclude(JsonInclude.Include.NON_NULL) +@javax.annotation.processing.Generated("copilot-sdk-codegen") +public final class CatalogNetworkFailureError extends CatalogSearchResult { + + @JsonProperty("kind") + private final String kind = "network-failure"; + + @Override + public String getKind() { return kind; } + + /** Categorised failure, low cardinality so it can be aggregated without carrying a URL. */ + @JsonProperty("reason") + private CatalogNetworkFailureReason reason; + + /** HTTP status code, when the failure was a rejected response. */ + @JsonProperty("statusCode") + private Long statusCode; + + /** Human-readable explanation, safe to surface. Never contains a query, URL, handle, or secret. */ + @JsonProperty("message") + private String message; + + public CatalogNetworkFailureReason getReason() { return reason; } + public void setReason(CatalogNetworkFailureReason reason) { this.reason = reason; } + + public Long getStatusCode() { return statusCode; } + public void setStatusCode(Long statusCode) { this.statusCode = statusCode; } + + 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/CatalogNetworkFailureReason.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/CatalogNetworkFailureReason.java new file mode 100644 index 0000000000..c28d1cc4a7 --- /dev/null +++ b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/CatalogNetworkFailureReason.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 javax.annotation.processing.Generated; + +/** + * Categorised network failure, low cardinality so it can be aggregated without carrying a URL + * + * @since 1.0.0 + */ +@javax.annotation.processing.Generated("copilot-sdk-codegen") +public enum CatalogNetworkFailureReason { + /** The {@code offline} variant. */ + OFFLINE("offline"), + /** The {@code dns} variant. */ + DNS("dns"), + /** The {@code timeout} variant. */ + TIMEOUT("timeout"), + /** The {@code tls} variant. */ + TLS("tls"), + /** The {@code connection-refused} variant. */ + CONNECTION_REFUSED("connection-refused"), + /** The {@code http-status} variant. */ + HTTP_STATUS("http-status"), + /** The {@code response-too-large} variant. */ + RESPONSE_TOO_LARGE("response-too-large"), + /** The {@code redirect-rejected} variant. */ + REDIRECT_REJECTED("redirect-rejected"); + + private final String value; + CatalogNetworkFailureReason(String value) { this.value = value; } + @com.fasterxml.jackson.annotation.JsonValue + public String getValue() { return value; } + @com.fasterxml.jackson.annotation.JsonCreator + public static CatalogNetworkFailureReason fromValue(String value) { + for (CatalogNetworkFailureReason v : values()) { + if (v.value.equals(value)) return v; + } + throw new IllegalArgumentException("Unknown CatalogNetworkFailureReason value: " + value); + } +} diff --git a/java/sdk/src/generated/java/com/github/copilot/generated/rpc/CatalogNotInstallableError.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/CatalogNotInstallableError.java new file mode 100644 index 0000000000..2ba3c84ec4 --- /dev/null +++ b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/CatalogNotInstallableError.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; + +/** + * The candidate is discoverable but cannot be installed. `application/ai-skill` resolves here, because it stays searchable while remaining typed non-installable. + * + * @since 1.0.0 + */ +@JsonIgnoreProperties(ignoreUnknown = true) +@JsonInclude(JsonInclude.Include.NON_NULL) +@javax.annotation.processing.Generated("copilot-sdk-codegen") +public final class CatalogNotInstallableError extends McpPlanInstallResult { + + @JsonProperty("kind") + private final String kind = "not-installable"; + + @Override + public String getKind() { return kind; } + + /** Why the candidate cannot be installed. */ + @JsonProperty("reason") + private CatalogNotInstallableReason reason; + + /** Human-readable explanation, safe to surface. Never contains a query, URL, handle, or secret. */ + @JsonProperty("message") + private String message; + + public CatalogNotInstallableReason getReason() { return reason; } + public void setReason(CatalogNotInstallableReason reason) { this.reason = reason; } + + 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/CatalogNotInstallableReason.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/CatalogNotInstallableReason.java new file mode 100644 index 0000000000..75abb619e2 --- /dev/null +++ b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/CatalogNotInstallableReason.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; + +/** + * Why a discoverable candidate cannot be installed + * + * @since 1.0.0 + */ +@javax.annotation.processing.Generated("copilot-sdk-codegen") +public enum CatalogNotInstallableReason { + /** The {@code kind-not-installable} variant. */ + KIND_NOT_INSTALLABLE("kind-not-installable"), + /** The {@code ai-skill-not-installable} variant. */ + AI_SKILL_NOT_INSTALLABLE("ai-skill-not-installable"), + /** The {@code policy-forbids} variant. */ + POLICY_FORBIDS("policy-forbids"); + + private final String value; + CatalogNotInstallableReason(String value) { this.value = value; } + @com.fasterxml.jackson.annotation.JsonValue + public String getValue() { return value; } + @com.fasterxml.jackson.annotation.JsonCreator + public static CatalogNotInstallableReason fromValue(String value) { + for (CatalogNotInstallableReason v : values()) { + if (v.value.equals(value)) return v; + } + throw new IllegalArgumentException("Unknown CatalogNotInstallableReason value: " + value); + } +} diff --git a/java/sdk/src/generated/java/com/github/copilot/generated/rpc/CatalogPolicyRejectedError.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/CatalogPolicyRejectedError.java new file mode 100644 index 0000000000..56542ba46e --- /dev/null +++ b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/CatalogPolicyRejectedError.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; + +/** + * Registry or enterprise policy refused the operation. + * + * @since 1.0.0 + */ +@JsonIgnoreProperties(ignoreUnknown = true) +@JsonInclude(JsonInclude.Include.NON_NULL) +@javax.annotation.processing.Generated("copilot-sdk-codegen") +public final class CatalogPolicyRejectedError extends CatalogSearchResult { + + @JsonProperty("kind") + private final String kind = "policy-rejected"; + + @Override + public String getKind() { return kind; } + + /** Which authority produced the decision. */ + @JsonProperty("source") + private McpPlanPolicySource source; + + /** Human-readable explanation, safe to surface. Never contains a query, URL, handle, or secret. */ + @JsonProperty("message") + private String message; + + public McpPlanPolicySource getSource() { return source; } + public void setSource(McpPlanPolicySource source) { this.source = source; } + + 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/CatalogSearchParams.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/CatalogSearchParams.java new file mode 100644 index 0000000000..ee5e703621 --- /dev/null +++ b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/CatalogSearchParams.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; + +/** + * A bounded catalog search. Both the query length and the result count are capped by the schema so a caller cannot request an unbounded scan. + * + * @apiNote This method is experimental and may change in a future version. + * @since 1.0.0 + */ +@CopilotExperimental +@javax.annotation.processing.Generated("copilot-sdk-codegen") +@JsonInclude(JsonInclude.Include.NON_NULL) +@JsonIgnoreProperties(ignoreUnknown = true) +public record CatalogSearchParams( + /** Protocol version and capabilities the caller requires. */ + @JsonProperty("contract") CatalogClientContract contract, + /** Free-text search query. Never written to logs or telemetry. */ + @JsonProperty("query") String query, + /** Maximum number of candidates to return. Defaults to 10 when omitted. */ + @JsonProperty("limit") Long limit, + /** Restrict results to these candidate kinds. When omitted, every kind the runtime supports is searched. */ + @JsonProperty("kinds") List kinds +) { +} diff --git a/java/sdk/src/generated/java/com/github/copilot/generated/rpc/CatalogSearchResult.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/CatalogSearchResult.java new file mode 100644 index 0000000000..4bfbf32701 --- /dev/null +++ b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/CatalogSearchResult.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.JsonSubTypes; +import com.fasterxml.jackson.annotation.JsonTypeInfo; +import javax.annotation.processing.Generated; + +/** + * Outcome of a catalog.search call: either bounded inert candidates, or one typed refusal. Never a partial success. + * + * @since 1.0.0 + */ +@JsonTypeInfo(use = JsonTypeInfo.Id.NAME, property = "kind", visible = true) +@JsonSubTypes({ + @JsonSubTypes.Type(value = CatalogSearchSucceeded.class, name = "succeeded"), + @JsonSubTypes.Type(value = CatalogNegotiationRefusedError.class, name = "negotiation-refused"), + @JsonSubTypes.Type(value = CatalogUnsupportedKindError.class, name = "unsupported-kind"), + @JsonSubTypes.Type(value = CatalogInvalidRequestError.class, name = "invalid-request"), + @JsonSubTypes.Type(value = CatalogAuthenticationRequiredError.class, name = "authentication-required"), + @JsonSubTypes.Type(value = CatalogPolicyRejectedError.class, name = "policy-rejected"), + @JsonSubTypes.Type(value = CatalogNetworkFailureError.class, name = "network-failure"), + @JsonSubTypes.Type(value = CatalogUnsafeRetrievalError.class, name = "unsafe-retrieval"), + @JsonSubTypes.Type(value = CatalogMalformedCardError.class, name = "malformed-card"), + @JsonSubTypes.Type(value = CatalogContractViolationError.class, name = "contract-violation"), + @JsonSubTypes.Type(value = CatalogUnavailableError.class, name = "unavailable") +}) +@JsonIgnoreProperties(ignoreUnknown = true) +@javax.annotation.processing.Generated("copilot-sdk-codegen") +public abstract class CatalogSearchResult { + + /** + * 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/CatalogSearchSucceeded.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/CatalogSearchSucceeded.java new file mode 100644 index 0000000000..8ecd11788a --- /dev/null +++ b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/CatalogSearchSucceeded.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; + +/** + * A completed catalog search: inert candidate summaries, each carrying a single-use handle. + * + * @since 1.0.0 + */ +@JsonIgnoreProperties(ignoreUnknown = true) +@JsonInclude(JsonInclude.Include.NON_NULL) +@javax.annotation.processing.Generated("copilot-sdk-codegen") +public final class CatalogSearchSucceeded extends CatalogSearchResult { + + @JsonProperty("kind") + private final String kind = "succeeded"; + + @Override + public String getKind() { return kind; } + + /** Pseudonymous identifier for this search, issued by the runtime or by the catalog authority it queried and never by the caller, so it cannot be forged or replayed to attribute an install to a search that never happened. Always present on a success, so a result set can be tied to the installs it leads to. It identifies a search rather than a person: it is derived from no user, account, device, or query data, and must never be joined with user identity to re-identify anyone. */ + @JsonProperty("searchId") + private String searchId; + + /** Matching candidates, never more than the requested limit. All text is inert untrusted data. */ + @JsonProperty("candidates") + private List candidates; + + /** Whether further matches existed beyond the requested limit. */ + @JsonProperty("truncated") + private Boolean truncated; + + /** Protocol version and capabilities the runtime honoured. */ + @JsonProperty("negotiated") + private CatalogNegotiatedContract negotiated; + + public String getSearchId() { return searchId; } + public void setSearchId(String searchId) { this.searchId = searchId; } + + public List getCandidates() { return candidates; } + public void setCandidates(List candidates) { this.candidates = candidates; } + + public Boolean getTruncated() { return truncated; } + public void setTruncated(Boolean truncated) { this.truncated = truncated; } + + public CatalogNegotiatedContract getNegotiated() { return negotiated; } + public void setNegotiated(CatalogNegotiatedContract negotiated) { this.negotiated = negotiated; } +} diff --git a/java/sdk/src/generated/java/com/github/copilot/generated/rpc/CatalogUnavailableError.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/CatalogUnavailableError.java new file mode 100644 index 0000000000..7f21c57085 --- /dev/null +++ b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/CatalogUnavailableError.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; + +/** + * The operation is not available on this runtime. Distinct from a network failure: nothing was attempted. + * + * @since 1.0.0 + */ +@JsonIgnoreProperties(ignoreUnknown = true) +@JsonInclude(JsonInclude.Include.NON_NULL) +@javax.annotation.processing.Generated("copilot-sdk-codegen") +public final class CatalogUnavailableError extends CatalogSearchResult { + + @JsonProperty("kind") + private final String kind = "unavailable"; + + @Override + public String getKind() { return kind; } + + /** Why the operation is unavailable. */ + @JsonProperty("reason") + private CatalogUnavailableReason reason; + + /** Human-readable explanation, safe to surface. Never contains a query, URL, handle, or secret. */ + @JsonProperty("message") + private String message; + + public CatalogUnavailableReason getReason() { return reason; } + public void setReason(CatalogUnavailableReason reason) { this.reason = reason; } + + 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/CatalogUnavailableReason.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/CatalogUnavailableReason.java new file mode 100644 index 0000000000..c7bf4dcd76 --- /dev/null +++ b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/CatalogUnavailableReason.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; + +/** + * Why a catalog operation is not available on this runtime + * + * @since 1.0.0 + */ +@javax.annotation.processing.Generated("copilot-sdk-codegen") +public enum CatalogUnavailableReason { + /** The {@code search-unavailable} variant. */ + SEARCH_UNAVAILABLE("search-unavailable"), + /** The {@code planning-unavailable} variant. */ + PLANNING_UNAVAILABLE("planning-unavailable"), + /** The {@code authority-not-configured} variant. */ + AUTHORITY_NOT_CONFIGURED("authority-not-configured"), + /** The {@code disabled-by-policy} variant. */ + DISABLED_BY_POLICY("disabled-by-policy"); + + private final String value; + CatalogUnavailableReason(String value) { this.value = value; } + @com.fasterxml.jackson.annotation.JsonValue + public String getValue() { return value; } + @com.fasterxml.jackson.annotation.JsonCreator + public static CatalogUnavailableReason fromValue(String value) { + for (CatalogUnavailableReason v : values()) { + if (v.value.equals(value)) return v; + } + throw new IllegalArgumentException("Unknown CatalogUnavailableReason value: " + value); + } +} diff --git a/java/sdk/src/generated/java/com/github/copilot/generated/rpc/CatalogUnavailableTransportError.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/CatalogUnavailableTransportError.java new file mode 100644 index 0000000000..3c40687eac --- /dev/null +++ b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/CatalogUnavailableTransportError.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; + +/** + * No transport this runtime can use is available for the requested server. + * + * @since 1.0.0 + */ +@JsonIgnoreProperties(ignoreUnknown = true) +@JsonInclude(JsonInclude.Include.NON_NULL) +@javax.annotation.processing.Generated("copilot-sdk-codegen") +public final class CatalogUnavailableTransportError extends McpPlanInstallResult { + + @JsonProperty("kind") + private final String kind = "unavailable-transport"; + + @Override + public String getKind() { return kind; } + + /** Why no transport could be offered. */ + @JsonProperty("reason") + private CatalogUnavailableTransportReason reason; + + /** Human-readable explanation, safe to surface. Never contains a query, URL, handle, or secret. */ + @JsonProperty("message") + private String message; + + public CatalogUnavailableTransportReason getReason() { return reason; } + public void setReason(CatalogUnavailableTransportReason reason) { this.reason = reason; } + + 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/CatalogUnavailableTransportReason.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/CatalogUnavailableTransportReason.java new file mode 100644 index 0000000000..d532967313 --- /dev/null +++ b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/CatalogUnavailableTransportReason.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; + +/** + * Why no usable transport could be offered + * + * @since 1.0.0 + */ +@javax.annotation.processing.Generated("copilot-sdk-codegen") +public enum CatalogUnavailableTransportReason { + /** The {@code no-eligible-transport} variant. */ + NO_ELIGIBLE_TRANSPORT("no-eligible-transport"), + /** The {@code transport-not-supported} variant. */ + TRANSPORT_NOT_SUPPORTED("transport-not-supported"), + /** The {@code remote-enumeration-unavailable} variant. */ + REMOTE_ENUMERATION_UNAVAILABLE("remote-enumeration-unavailable"); + + private final String value; + CatalogUnavailableTransportReason(String value) { this.value = value; } + @com.fasterxml.jackson.annotation.JsonValue + public String getValue() { return value; } + @com.fasterxml.jackson.annotation.JsonCreator + public static CatalogUnavailableTransportReason fromValue(String value) { + for (CatalogUnavailableTransportReason v : values()) { + if (v.value.equals(value)) return v; + } + throw new IllegalArgumentException("Unknown CatalogUnavailableTransportReason value: " + value); + } +} diff --git a/java/sdk/src/generated/java/com/github/copilot/generated/rpc/CatalogUnsafeRetrievalError.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/CatalogUnsafeRetrievalError.java new file mode 100644 index 0000000000..513ce5b80f --- /dev/null +++ b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/CatalogUnsafeRetrievalError.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; + +/** + * Retrieval was refused by the runtime's hardened fetch boundary before any request left the process, or before a redirect was followed. + * + * @since 1.0.0 + */ +@JsonIgnoreProperties(ignoreUnknown = true) +@JsonInclude(JsonInclude.Include.NON_NULL) +@javax.annotation.processing.Generated("copilot-sdk-codegen") +public final class CatalogUnsafeRetrievalError extends CatalogSearchResult { + + @JsonProperty("kind") + private final String kind = "unsafe-retrieval"; + + @Override + public String getKind() { return kind; } + + /** Which control refused the retrieval, low cardinality so it can be aggregated without carrying a URL. */ + @JsonProperty("reason") + private CatalogUnsafeRetrievalReason reason; + + /** Human-readable explanation, safe to surface. Never contains the refused URL, nor a query, handle, or secret. */ + @JsonProperty("message") + private String message; + + public CatalogUnsafeRetrievalReason getReason() { return reason; } + public void setReason(CatalogUnsafeRetrievalReason reason) { this.reason = reason; } + + 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/CatalogUnsafeRetrievalReason.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/CatalogUnsafeRetrievalReason.java new file mode 100644 index 0000000000..e05931dac1 --- /dev/null +++ b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/CatalogUnsafeRetrievalReason.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; + +/** + * Which hardened-fetch control refused a retrieval + * + * @since 1.0.0 + */ +@javax.annotation.processing.Generated("copilot-sdk-codegen") +public enum CatalogUnsafeRetrievalReason { + /** The {@code blocked-scheme} variant. */ + BLOCKED_SCHEME("blocked-scheme"), + /** The {@code credentials-in-url} variant. */ + CREDENTIALS_IN_URL("credentials-in-url"), + /** The {@code blocked-address} variant. */ + BLOCKED_ADDRESS("blocked-address"), + /** The {@code redirect-to-blocked-address} variant. */ + REDIRECT_TO_BLOCKED_ADDRESS("redirect-to-blocked-address"), + /** The {@code proxy-rejected} variant. */ + PROXY_REJECTED("proxy-rejected"), + /** The {@code host-not-permitted} variant. */ + HOST_NOT_PERMITTED("host-not-permitted"); + + private final String value; + CatalogUnsafeRetrievalReason(String value) { this.value = value; } + @com.fasterxml.jackson.annotation.JsonValue + public String getValue() { return value; } + @com.fasterxml.jackson.annotation.JsonCreator + public static CatalogUnsafeRetrievalReason fromValue(String value) { + for (CatalogUnsafeRetrievalReason v : values()) { + if (v.value.equals(value)) return v; + } + throw new IllegalArgumentException("Unknown CatalogUnsafeRetrievalReason value: " + value); + } +} diff --git a/java/sdk/src/generated/java/com/github/copilot/generated/rpc/CatalogUnsupportedKindError.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/CatalogUnsupportedKindError.java new file mode 100644 index 0000000000..06cc7bc5a8 --- /dev/null +++ b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/CatalogUnsupportedKindError.java @@ -0,0 +1,52 @@ +/*--------------------------------------------------------------------------------------------- + * Copyright (c) Microsoft Corporation. All rights reserved. + *--------------------------------------------------------------------------------------------*/ + +// AUTO-GENERATED FILE - DO NOT EDIT +// Generated from: api.schema.json + +package 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; + +/** + * The request asked for a candidate kind this runtime does not serve. + * + * @since 1.0.0 + */ +@JsonIgnoreProperties(ignoreUnknown = true) +@JsonInclude(JsonInclude.Include.NON_NULL) +@javax.annotation.processing.Generated("copilot-sdk-codegen") +public final class CatalogUnsupportedKindError extends CatalogSearchResult { + + @JsonProperty("kind") + private final String kind = "unsupported-kind"; + + @Override + public String getKind() { return kind; } + + /** The kinds from the request that are not supported. */ + @JsonProperty("requestedKinds") + private List requestedKinds; + + /** Every candidate kind this runtime can serve. */ + @JsonProperty("supportedKinds") + private List supportedKinds; + + /** Human-readable explanation, safe to surface. Never contains a query, URL, handle, or secret. */ + @JsonProperty("message") + private String message; + + public List getRequestedKinds() { return requestedKinds; } + public void setRequestedKinds(List requestedKinds) { this.requestedKinds = requestedKinds; } + + public List getSupportedKinds() { return supportedKinds; } + public void setSupportedKinds(List supportedKinds) { this.supportedKinds = supportedKinds; } + + 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/CommandsInvocationEffectOutcome.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/CommandsInvocationEffectOutcome.java new file mode 100644 index 0000000000..79f3be8baf --- /dev/null +++ b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/CommandsInvocationEffectOutcome.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 a pending slash-command invocation effect was applied or cancelled by the host. + * + * @since 1.0.0 + */ +@javax.annotation.processing.Generated("copilot-sdk-codegen") +public enum CommandsInvocationEffectOutcome { + /** The {@code applied} variant. */ + APPLIED("applied"), + /** The {@code cancelled} variant. */ + CANCELLED("cancelled"); + + private final String value; + CommandsInvocationEffectOutcome(String value) { this.value = value; } + @com.fasterxml.jackson.annotation.JsonValue + public String getValue() { return value; } + @com.fasterxml.jackson.annotation.JsonCreator + public static CommandsInvocationEffectOutcome fromValue(String value) { + for (CommandsInvocationEffectOutcome v : values()) { + if (v.value.equals(value)) return v; + } + throw new IllegalArgumentException("Unknown CommandsInvocationEffectOutcome value: " + value); + } +} diff --git a/java/sdk/src/generated/java/com/github/copilot/generated/rpc/CommandsInvocationOrigin.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/CommandsInvocationOrigin.java new file mode 100644 index 0000000000..14d5906d34 --- /dev/null +++ b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/CommandsInvocationOrigin.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 CommandsInvocationOrigin { + /** The {@code settings} variant. */ + SETTINGS("settings"); + + private final String value; + CommandsInvocationOrigin(String value) { this.value = value; } + @com.fasterxml.jackson.annotation.JsonValue + public String getValue() { return value; } + @com.fasterxml.jackson.annotation.JsonCreator + public static CommandsInvocationOrigin fromValue(String value) { + for (CommandsInvocationOrigin v : values()) { + if (v.value.equals(value)) return v; + } + throw new IllegalArgumentException("Unknown CommandsInvocationOrigin value: " + value); + } +} diff --git a/java/src/generated/java/com/github/copilot/generated/rpc/CommandsListResult.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/CommandsListResult.java similarity index 100% rename from java/src/generated/java/com/github/copilot/generated/rpc/CommandsListResult.java rename to java/sdk/src/generated/java/com/github/copilot/generated/rpc/CommandsListResult.java diff --git a/java/sdk/src/generated/java/com/github/copilot/generated/rpc/ConnectClientInfo.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/ConnectClientInfo.java new file mode 100644 index 0000000000..e5b6b6f24d --- /dev/null +++ b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/ConnectClientInfo.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; + +/** + * Identity of the integrating host, declared once on the `server.connect` handshake so telemetry from this connection is attributed to a single, consistent surface. All fields are optional; omit them to keep the default attribution. + * + * @since 1.0.0 + */ +@javax.annotation.processing.Generated("copilot-sdk-codegen") +@JsonInclude(JsonInclude.Include.NON_NULL) +@JsonIgnoreProperties(ignoreUnknown = true) +public record ConnectClientInfo( + /** Name of the host editor, e.g. `"vscode"`. */ + @JsonProperty("editorName") String editorName, + /** Version of the host editor, e.g. `"1.124.2"`. Ignored unless it looks like a version string. */ + @JsonProperty("editorVersion") String editorVersion, + /** Name of the Copilot extension within the host, e.g. `"copilot-chat"`. */ + @JsonProperty("extensionName") String extensionName, + /** Version of the Copilot extension within the host, e.g. `"0.54.0"`. Ignored unless it looks like a version string. */ + @JsonProperty("extensionVersion") String extensionVersion +) { +} diff --git a/java/src/generated/java/com/github/copilot/generated/rpc/ConnectParams.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/ConnectParams.java similarity index 59% rename from java/src/generated/java/com/github/copilot/generated/rpc/ConnectParams.java rename to java/sdk/src/generated/java/com/github/copilot/generated/rpc/ConnectParams.java index 491dadad37..05f2534970 100644 --- a/java/src/generated/java/com/github/copilot/generated/rpc/ConnectParams.java +++ b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/ConnectParams.java @@ -14,7 +14,7 @@ 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). + * Connection-level opt-ins for the `server.connect` handshake. Transport authentication is consumed by the native protocol boundary before dispatch. * * @apiNote This method is experimental and may change in a future version. * @since 1.0.0 @@ -24,9 +24,11 @@ @JsonInclude(JsonInclude.Include.NON_NULL) @JsonIgnoreProperties(ignoreUnknown = true) public record ConnectParams( + /** 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, + /** Identity of the integrating host. Optional; omit it to keep the default attribution. */ + @JsonProperty("clientInfo") ConnectClientInfo clientInfo, /** 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, in addition to the runtime's normal GitHub/CTS emission (dual-write). 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. */ - @JsonProperty("enableGitHubTelemetryForwarding") Boolean enableGitHubTelemetryForwarding + @JsonProperty("token") String token ) { } 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 100% 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 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 0000000000..ba48326c2e --- /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/src/generated/java/com/github/copilot/generated/rpc/ContextHeaviestMessage.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/ContextHeaviestMessage.java similarity index 100% rename from java/src/generated/java/com/github/copilot/generated/rpc/ContextHeaviestMessage.java rename to java/sdk/src/generated/java/com/github/copilot/generated/rpc/ContextHeaviestMessage.java diff --git a/java/src/generated/java/com/github/copilot/generated/rpc/ContextTier.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/ContextTier.java similarity index 100% rename from java/src/generated/java/com/github/copilot/generated/rpc/ContextTier.java rename to java/sdk/src/generated/java/com/github/copilot/generated/rpc/ContextTier.java diff --git a/java/sdk/src/generated/java/com/github/copilot/generated/rpc/CopilotApiTokenAuthInfo.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/CopilotApiTokenAuthInfo.java new file mode 100644 index 0000000000..2e6952f538 --- /dev/null +++ b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/CopilotApiTokenAuthInfo.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; + +/** + * Authentication-info variant for direct Copilot API token auth sourced from environment variables, with public GitHub host. + * + * @since 1.0.0 + */ +@JsonIgnoreProperties(ignoreUnknown = true) +@JsonInclude(JsonInclude.Include.NON_NULL) +@javax.annotation.processing.Generated("copilot-sdk-codegen") +public final class CopilotApiTokenAuthInfo extends AuthInfo { + + @JsonProperty("type") + private final String type = "copilot-api-token"; + + @Override + public String getType() { return type; } + + /** Authentication host (always the public GitHub host). */ + @JsonProperty("host") + private String host; + + /** 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. */ + @JsonProperty("copilotUser") + private CopilotUserResponse copilotUser; + + public String getHost() { return host; } + public void setHost(String host) { this.host = host; } + + public CopilotUserResponse getCopilotUser() { return copilotUser; } + public void setCopilotUser(CopilotUserResponse copilotUser) { this.copilotUser = copilotUser; } +} diff --git a/java/sdk/src/generated/java/com/github/copilot/generated/rpc/CopilotUserResponse.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/CopilotUserResponse.java new file mode 100644 index 0000000000..cd6d5c83bd --- /dev/null +++ b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/CopilotUserResponse.java @@ -0,0 +1,79 @@ +/*--------------------------------------------------------------------------------------------- + * Copyright (c) Microsoft Corporation. All rights reserved. + *--------------------------------------------------------------------------------------------*/ + +// AUTO-GENERATED FILE - DO NOT EDIT +// Generated from: api.schema.json + +package 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; + +/** + * 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. + * + * @since 1.0.0 + */ +@javax.annotation.processing.Generated("copilot-sdk-codegen") +@JsonInclude(JsonInclude.Include.NON_NULL) +@JsonIgnoreProperties(ignoreUnknown = true) +public record CopilotUserResponse( + /** GitHub login of the authenticated user. */ + @JsonProperty("login") String login, + /** Copilot access SKU identifier (e.g. `free_limited_copilot`, `copilot_for_business_seat_quota`) used to gate model and feature access. */ + @JsonProperty("access_type_sku") String accessTypeSku, + /** Opaque analytics tracking identifier for the user, forwarded from the Copilot API. */ + @JsonProperty("analytics_tracking_id") String analyticsTrackingId, + /** Date the Copilot seat was assigned to the user, if applicable. */ + @JsonProperty("assigned_date") Object assignedDate, + /** Whether the user is eligible to sign up for the free/limited Copilot tier. */ + @JsonProperty("can_signup_for_limited") Boolean canSignupForLimited, + /** Whether Copilot chat is enabled for the user. */ + @JsonProperty("chat_enabled") Boolean chatEnabled, + /** Copilot plan name for the user (e.g. `individual`, `business`, `enterprise`). */ + @JsonProperty("copilot_plan") String copilotPlan, + /** Whether `.copilotignore` content-exclusion support is enabled for the user. */ + @JsonProperty("copilotignore_enabled") Boolean copilotignoreEnabled, + /** Endpoint URLs from the raw Copilot `/copilot_internal/v2/token` user-response passthrough. */ + @JsonProperty("endpoints") CopilotUserResponseEndpoints endpoints, + /** Logins of the organizations the user belongs to. */ + @JsonProperty("organization_login_list") List organizationLoginList, + /** Organizations the user belongs to, each with an optional login and display name. */ + @JsonProperty("organization_list") Object organizationList, + /** Whether the Codex agent is enabled for the user. */ + @JsonProperty("codex_agent_enabled") Boolean codexAgentEnabled, + /** Whether MCP (Model Context Protocol) support is enabled for the user. */ + @JsonProperty("is_mcp_enabled") Object isMcpEnabled, + /** 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. */ + @JsonProperty("quota_reset_date") String quotaResetDate, + /** Quota snapshot map from the raw Copilot user-response passthrough, with chat, completions, premium-interactions, and other entries. */ + @JsonProperty("quota_snapshots") CopilotUserResponseQuotaSnapshots quotaSnapshots, + /** Whether the user's telemetry is subject to restricted-data handling. */ + @JsonProperty("restricted_telemetry") Boolean restrictedTelemetry, + /** Whether the user is a GitHub/Microsoft staff member. */ + @JsonProperty("is_staff") Boolean isStaff, + /** 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. */ + @JsonProperty("te") Boolean te, + /** Whether the account is on usage-based (token/AI-credit) billing rather than a fixed premium-request quota. */ + @JsonProperty("token_based_billing") Boolean tokenBasedBilling, + /** Whether the user is able to upgrade their Copilot plan. */ + @JsonProperty("can_upgrade_plan") Boolean canUpgradePlan, + /** UTC-normalized form of `quota_reset_date` (the date the user's usage quota next resets). */ + @JsonProperty("quota_reset_date_utc") String quotaResetDateUtc, + /** Per-category quota allotments for free/limited-tier users, keyed by quota category. */ + @JsonProperty("limited_user_quotas") Map limitedUserQuotas, + /** Date the free/limited-tier user's quotas next reset, as a raw string from the Copilot API. */ + @JsonProperty("limited_user_reset_date") String limitedUserResetDate, + /** Per-category monthly quota allotments, keyed by quota category. */ + @JsonProperty("monthly_quotas") Map monthlyQuotas, + /** Whether cloud session storage is enabled for the user. */ + @JsonProperty("cloud_session_storage_enabled") Boolean cloudSessionStorageEnabled, + /** Whether CLI remote control is enabled for the user. */ + @JsonProperty("cli_remote_control_enabled") Boolean cliRemoteControlEnabled +) { +} diff --git a/java/sdk/src/generated/java/com/github/copilot/generated/rpc/CopilotUserResponseEndpoints.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/CopilotUserResponseEndpoints.java new file mode 100644 index 0000000000..3e4606559f --- /dev/null +++ b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/CopilotUserResponseEndpoints.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; + +/** + * Endpoint URLs from the raw Copilot `/copilot_internal/v2/token` user-response passthrough. + * + * @since 1.0.0 + */ +@javax.annotation.processing.Generated("copilot-sdk-codegen") +@JsonInclude(JsonInclude.Include.NON_NULL) +@JsonIgnoreProperties(ignoreUnknown = true) +public record CopilotUserResponseEndpoints( + /** Copilot API endpoint URL. */ + @JsonProperty("api") String api, + /** Origin-tracker endpoint URL. */ + @JsonProperty("origin-tracker") String originTracker, + /** Copilot proxy endpoint URL. */ + @JsonProperty("proxy") String proxy, + /** Copilot telemetry endpoint URL. */ + @JsonProperty("telemetry") String telemetry, + /** Experimental-service endpoint URL. */ + @JsonProperty("exp") String exp +) { +} diff --git a/java/sdk/src/generated/java/com/github/copilot/generated/rpc/CopilotUserResponseQuotaSnapshots.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/CopilotUserResponseQuotaSnapshots.java new file mode 100644 index 0000000000..10c983bb40 --- /dev/null +++ b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/CopilotUserResponseQuotaSnapshots.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; + +/** + * Quota snapshot map from the raw Copilot user-response passthrough, with chat, completions, premium-interactions, and other entries. + * + * @since 1.0.0 + */ +@javax.annotation.processing.Generated("copilot-sdk-codegen") +@JsonInclude(JsonInclude.Include.NON_NULL) +@JsonIgnoreProperties(ignoreUnknown = true) +public record CopilotUserResponseQuotaSnapshots( + /** Chat quota snapshot from the raw Copilot user-response passthrough, with entitlement, overage, remaining quota, reset, and billing fields. */ + @JsonProperty("chat") CopilotUserResponseQuotaSnapshotsChat chat, + /** Completions quota snapshot from the raw Copilot user-response passthrough, with entitlement, overage, remaining quota, reset, and billing fields. */ + @JsonProperty("completions") CopilotUserResponseQuotaSnapshotsCompletions completions, + /** Premium-interactions quota snapshot from the raw Copilot user-response passthrough, with entitlement, overage, remaining quota, reset, and billing fields. */ + @JsonProperty("premium_interactions") CopilotUserResponseQuotaSnapshotsPremiumInteractions premiumInteractions +) { +} diff --git a/java/sdk/src/generated/java/com/github/copilot/generated/rpc/CopilotUserResponseQuotaSnapshotsChat.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/CopilotUserResponseQuotaSnapshotsChat.java new file mode 100644 index 0000000000..94a516286b --- /dev/null +++ b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/CopilotUserResponseQuotaSnapshotsChat.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 javax.annotation.processing.Generated; + +/** + * Chat quota snapshot from the raw Copilot user-response passthrough, with entitlement, overage, remaining quota, reset, and billing fields. + * + * @since 1.0.0 + */ +@javax.annotation.processing.Generated("copilot-sdk-codegen") +@JsonInclude(JsonInclude.Include.NON_NULL) +@JsonIgnoreProperties(ignoreUnknown = true) +public record CopilotUserResponseQuotaSnapshotsChat( + /** Number of requests/units included in the entitlement for this period; `-1` denotes an unlimited entitlement. */ + @JsonProperty("entitlement") Double entitlement, + /** Count of additional pay-per-request usage consumed this period beyond the entitlement. */ + @JsonProperty("overage_count") Double overageCount, + /** Whether usage may continue at pay-per-request rates once the entitlement is exhausted. */ + @JsonProperty("overage_permitted") Boolean overagePermitted, + /** Percentage of the entitlement remaining at the snapshot timestamp. */ + @JsonProperty("percent_remaining") Double percentRemaining, + /** Identifier of the quota bucket this snapshot describes. */ + @JsonProperty("quota_id") String quotaId, + /** Amount of quota remaining at the snapshot timestamp. */ + @JsonProperty("quota_remaining") Double quotaRemaining, + /** Remaining entitlement/quota amount at the snapshot timestamp. */ + @JsonProperty("remaining") Double remaining, + /** Whether the entitlement for this category is unlimited. */ + @JsonProperty("unlimited") Boolean unlimited, + /** UTC timestamp when this snapshot was captured. */ + @JsonProperty("timestamp_utc") String timestampUtc, + /** Whether the user currently has quota available; when `false` and not unlimited, further requests are blocked until the quota resets. */ + @JsonProperty("has_quota") Boolean hasQuota, + /** Unix epoch time, in seconds, when this quota next resets. */ + @JsonProperty("quota_reset_at") Double quotaResetAt, + /** Whether this category uses usage-based (token/AI-credit) billing rather than a fixed premium-request count. */ + @JsonProperty("token_based_billing") Boolean tokenBasedBilling +) { +} diff --git a/java/sdk/src/generated/java/com/github/copilot/generated/rpc/CopilotUserResponseQuotaSnapshotsCompletions.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/CopilotUserResponseQuotaSnapshotsCompletions.java new file mode 100644 index 0000000000..826b034ba0 --- /dev/null +++ b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/CopilotUserResponseQuotaSnapshotsCompletions.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 javax.annotation.processing.Generated; + +/** + * Completions quota snapshot from the raw Copilot user-response passthrough, with entitlement, overage, remaining quota, reset, and billing fields. + * + * @since 1.0.0 + */ +@javax.annotation.processing.Generated("copilot-sdk-codegen") +@JsonInclude(JsonInclude.Include.NON_NULL) +@JsonIgnoreProperties(ignoreUnknown = true) +public record CopilotUserResponseQuotaSnapshotsCompletions( + /** Number of requests/units included in the entitlement for this period; `-1` denotes an unlimited entitlement. */ + @JsonProperty("entitlement") Double entitlement, + /** Count of additional pay-per-request usage consumed this period beyond the entitlement. */ + @JsonProperty("overage_count") Double overageCount, + /** Whether usage may continue at pay-per-request rates once the entitlement is exhausted. */ + @JsonProperty("overage_permitted") Boolean overagePermitted, + /** Percentage of the entitlement remaining at the snapshot timestamp. */ + @JsonProperty("percent_remaining") Double percentRemaining, + /** Identifier of the quota bucket this snapshot describes. */ + @JsonProperty("quota_id") String quotaId, + /** Amount of quota remaining at the snapshot timestamp. */ + @JsonProperty("quota_remaining") Double quotaRemaining, + /** Remaining entitlement/quota amount at the snapshot timestamp. */ + @JsonProperty("remaining") Double remaining, + /** Whether the entitlement for this category is unlimited. */ + @JsonProperty("unlimited") Boolean unlimited, + /** UTC timestamp when this snapshot was captured. */ + @JsonProperty("timestamp_utc") String timestampUtc, + /** Whether the user currently has quota available; when `false` and not unlimited, further requests are blocked until the quota resets. */ + @JsonProperty("has_quota") Boolean hasQuota, + /** Unix epoch time, in seconds, when this quota next resets. */ + @JsonProperty("quota_reset_at") Double quotaResetAt, + /** Whether this category uses usage-based (token/AI-credit) billing rather than a fixed premium-request count. */ + @JsonProperty("token_based_billing") Boolean tokenBasedBilling +) { +} diff --git a/java/sdk/src/generated/java/com/github/copilot/generated/rpc/CopilotUserResponseQuotaSnapshotsPremiumInteractions.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/CopilotUserResponseQuotaSnapshotsPremiumInteractions.java new file mode 100644 index 0000000000..ca4a08b4f0 --- /dev/null +++ b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/CopilotUserResponseQuotaSnapshotsPremiumInteractions.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 javax.annotation.processing.Generated; + +/** + * Premium-interactions quota snapshot from the raw Copilot user-response passthrough, with entitlement, overage, remaining quota, reset, and billing fields. + * + * @since 1.0.0 + */ +@javax.annotation.processing.Generated("copilot-sdk-codegen") +@JsonInclude(JsonInclude.Include.NON_NULL) +@JsonIgnoreProperties(ignoreUnknown = true) +public record CopilotUserResponseQuotaSnapshotsPremiumInteractions( + /** Number of requests/units included in the entitlement for this period; `-1` denotes an unlimited entitlement. */ + @JsonProperty("entitlement") Double entitlement, + /** Count of additional pay-per-request usage consumed this period beyond the entitlement. */ + @JsonProperty("overage_count") Double overageCount, + /** Whether usage may continue at pay-per-request rates once the entitlement is exhausted. */ + @JsonProperty("overage_permitted") Boolean overagePermitted, + /** Percentage of the entitlement remaining at the snapshot timestamp. */ + @JsonProperty("percent_remaining") Double percentRemaining, + /** Identifier of the quota bucket this snapshot describes. */ + @JsonProperty("quota_id") String quotaId, + /** Amount of quota remaining at the snapshot timestamp. */ + @JsonProperty("quota_remaining") Double quotaRemaining, + /** Remaining entitlement/quota amount at the snapshot timestamp. */ + @JsonProperty("remaining") Double remaining, + /** Whether the entitlement for this category is unlimited. */ + @JsonProperty("unlimited") Boolean unlimited, + /** UTC timestamp when this snapshot was captured. */ + @JsonProperty("timestamp_utc") String timestampUtc, + /** Whether the user currently has quota available; when `false` and not unlimited, further requests are blocked until the quota resets. */ + @JsonProperty("has_quota") Boolean hasQuota, + /** Unix epoch time, in seconds, when this quota next resets. */ + @JsonProperty("quota_reset_at") Double quotaResetAt, + /** Whether this category uses usage-based (token/AI-credit) billing rather than a fixed premium-request count. */ + @JsonProperty("token_based_billing") Boolean tokenBasedBilling +) { +} diff --git a/java/src/generated/java/com/github/copilot/generated/rpc/CurrentToolMetadata.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/CurrentToolMetadata.java similarity index 100% rename from java/src/generated/java/com/github/copilot/generated/rpc/CurrentToolMetadata.java rename to java/sdk/src/generated/java/com/github/copilot/generated/rpc/CurrentToolMetadata.java diff --git a/java/src/generated/java/com/github/copilot/generated/rpc/DebugCollectLogsCollectedEntry.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/DebugCollectLogsCollectedEntry.java similarity index 100% rename from java/src/generated/java/com/github/copilot/generated/rpc/DebugCollectLogsCollectedEntry.java rename to java/sdk/src/generated/java/com/github/copilot/generated/rpc/DebugCollectLogsCollectedEntry.java diff --git a/java/src/generated/java/com/github/copilot/generated/rpc/DebugCollectLogsEntry.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/DebugCollectLogsEntry.java similarity index 100% rename from java/src/generated/java/com/github/copilot/generated/rpc/DebugCollectLogsEntry.java rename to java/sdk/src/generated/java/com/github/copilot/generated/rpc/DebugCollectLogsEntry.java diff --git a/java/src/generated/java/com/github/copilot/generated/rpc/DebugCollectLogsEntryKind.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/DebugCollectLogsEntryKind.java similarity index 100% rename from java/src/generated/java/com/github/copilot/generated/rpc/DebugCollectLogsEntryKind.java rename to java/sdk/src/generated/java/com/github/copilot/generated/rpc/DebugCollectLogsEntryKind.java diff --git a/java/src/generated/java/com/github/copilot/generated/rpc/DebugCollectLogsInclude.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/DebugCollectLogsInclude.java similarity index 100% rename from java/src/generated/java/com/github/copilot/generated/rpc/DebugCollectLogsInclude.java rename to java/sdk/src/generated/java/com/github/copilot/generated/rpc/DebugCollectLogsInclude.java diff --git a/java/src/generated/java/com/github/copilot/generated/rpc/DebugCollectLogsRedaction.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/DebugCollectLogsRedaction.java similarity index 100% rename from java/src/generated/java/com/github/copilot/generated/rpc/DebugCollectLogsRedaction.java rename to java/sdk/src/generated/java/com/github/copilot/generated/rpc/DebugCollectLogsRedaction.java diff --git a/java/src/generated/java/com/github/copilot/generated/rpc/DebugCollectLogsResultKind.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/DebugCollectLogsResultKind.java similarity index 100% rename from java/src/generated/java/com/github/copilot/generated/rpc/DebugCollectLogsResultKind.java rename to java/sdk/src/generated/java/com/github/copilot/generated/rpc/DebugCollectLogsResultKind.java diff --git a/java/src/generated/java/com/github/copilot/generated/rpc/DebugCollectLogsSkippedEntry.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/DebugCollectLogsSkippedEntry.java similarity index 100% rename from java/src/generated/java/com/github/copilot/generated/rpc/DebugCollectLogsSkippedEntry.java rename to java/sdk/src/generated/java/com/github/copilot/generated/rpc/DebugCollectLogsSkippedEntry.java diff --git a/java/src/generated/java/com/github/copilot/generated/rpc/DebugCollectLogsSource.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/DebugCollectLogsSource.java similarity index 100% rename from java/src/generated/java/com/github/copilot/generated/rpc/DebugCollectLogsSource.java rename to java/sdk/src/generated/java/com/github/copilot/generated/rpc/DebugCollectLogsSource.java 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 100% 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 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 0000000000..7bb2531fe8 --- /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 0000000000..23bc327780 --- /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 0000000000..8df0018ef6 --- /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 0000000000..c38225167d --- /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 100% 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 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/sdk/src/generated/java/com/github/copilot/generated/rpc/EnvAuthInfo.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/EnvAuthInfo.java new file mode 100644 index 0000000000..ce96797903 --- /dev/null +++ b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/EnvAuthInfo.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; + +/** + * Authentication-info input variant for a token sourced from an environment variable, with host, optional login, token, and env var name. + * + * @since 1.0.0 + */ +@JsonIgnoreProperties(ignoreUnknown = true) +@JsonInclude(JsonInclude.Include.NON_NULL) +@javax.annotation.processing.Generated("copilot-sdk-codegen") +public final class EnvAuthInfo extends AuthInfo { + + @JsonProperty("type") + private final String type = "env"; + + @Override + public String getType() { return type; } + + /** Authentication host (e.g. https://github.com or a GHES host). */ + @JsonProperty("host") + private String host; + + /** User login associated with the token. Undefined for server-to-server tokens (those starting with `ghs_`). */ + @JsonProperty("login") + private String login; + + /** The token value itself. Treat as a secret. */ + @JsonProperty("token") + private String token; + + /** Name of the environment variable the token was sourced from. */ + @JsonProperty("envVar") + private String envVar; + + /** 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. */ + @JsonProperty("copilotUser") + private CopilotUserResponse copilotUser; + + public String getHost() { return host; } + public void setHost(String host) { this.host = host; } + + public String getLogin() { return login; } + public void setLogin(String login) { this.login = login; } + + public String getToken() { return token; } + public void setToken(String token) { this.token = token; } + + public String getEnvVar() { return envVar; } + public void setEnvVar(String envVar) { this.envVar = envVar; } + + public CopilotUserResponse getCopilotUser() { return copilotUser; } + public void setCopilotUser(CopilotUserResponse copilotUser) { this.copilotUser = copilotUser; } +} 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 31c1fcab01..20f37bdfa4 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 0000000000..1df0ac8f7d --- /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 100% 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 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 0000000000..e7590c7f9e --- /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 0000000000..7b520f9067 --- /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 0000000000..8a43ad4af3 --- /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 100% 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 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 0000000000..dc4ef9d6ca --- /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 0000000000..fa319d7fed --- /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 0000000000..2e4351d3d9 --- /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/ExternalToolTextResultForLlmBinaryResultsForLlm.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/ExternalToolTextResultForLlmBinaryResultsForLlm.java new file mode 100644 index 0000000000..9aec5d03a1 --- /dev/null +++ b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/ExternalToolTextResultForLlmBinaryResultsForLlm.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; + +/** + * Binary result returned by a tool for the model + * + * @since 1.0.0 + */ +@javax.annotation.processing.Generated("copilot-sdk-codegen") +@JsonInclude(JsonInclude.Include.NON_NULL) +@JsonIgnoreProperties(ignoreUnknown = true) +public record ExternalToolTextResultForLlmBinaryResultsForLlm( + /** Binary result type discriminator. Use "image" for images and "resource" for other binary data. */ + @JsonProperty("type") ExternalToolTextResultForLlmBinaryResultsForLlmType type, + /** Base64-encoded binary data */ + @JsonProperty("data") String data, + /** MIME type of the binary data */ + @JsonProperty("mimeType") String mimeType, + /** 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/rpc/ExternalToolTextResultForLlmBinaryResultsForLlmType.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/ExternalToolTextResultForLlmBinaryResultsForLlmType.java new file mode 100644 index 0000000000..d73e769b87 --- /dev/null +++ b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/ExternalToolTextResultForLlmBinaryResultsForLlmType.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; + +/** + * Binary result type discriminator. Use "image" for images and "resource" for other binary data. + * + * @since 1.0.0 + */ +@javax.annotation.processing.Generated("copilot-sdk-codegen") +public enum ExternalToolTextResultForLlmBinaryResultsForLlmType { + /** The {@code image} variant. */ + IMAGE("image"), + /** The {@code resource} variant. */ + RESOURCE("resource"); + + private final String value; + ExternalToolTextResultForLlmBinaryResultsForLlmType(String value) { this.value = value; } + @com.fasterxml.jackson.annotation.JsonValue + public String getValue() { return value; } + @com.fasterxml.jackson.annotation.JsonCreator + public static ExternalToolTextResultForLlmBinaryResultsForLlmType fromValue(String value) { + for (ExternalToolTextResultForLlmBinaryResultsForLlmType v : values()) { + if (v.value.equals(value)) return v; + } + throw new IllegalArgumentException("Unknown ExternalToolTextResultForLlmBinaryResultsForLlmType value: " + value); + } +} diff --git a/java/src/generated/java/com/github/copilot/generated/rpc/FactoryAbortParams.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/FactoryAbortParams.java similarity index 100% rename from java/src/generated/java/com/github/copilot/generated/rpc/FactoryAbortParams.java rename to java/sdk/src/generated/java/com/github/copilot/generated/rpc/FactoryAbortParams.java diff --git a/java/src/generated/java/com/github/copilot/generated/rpc/FactoryAgentOptions.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/FactoryAgentOptions.java similarity index 69% rename from java/src/generated/java/com/github/copilot/generated/rpc/FactoryAgentOptions.java rename to java/sdk/src/generated/java/com/github/copilot/generated/rpc/FactoryAgentOptions.java index 675e715e85..9910d4f7f5 100644 --- a/java/src/generated/java/com/github/copilot/generated/rpc/FactoryAgentOptions.java +++ b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/FactoryAgentOptions.java @@ -26,6 +26,12 @@ public record FactoryAgentOptions( /** Optional JSON Schema for structured agent output. */ @JsonProperty("schema") Object schema, /** Optional model identifier for the subagent. */ - @JsonProperty("model") String model + @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 0000000000..d1bd2329b2 --- /dev/null +++ b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/FactoryAgentSummary.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 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( + /** Stable direct-agent identifier. */ + @JsonProperty("agentId") String agentId, + /** Tool-call identifier that launched the agent. */ + @JsonProperty("toolCallId") String toolCallId, + /** Owning factory run identifier. */ + @JsonProperty("runId") String runId, + /** Phase identifier active when the agent was launched, or null. */ + @JsonProperty("phaseId") String phaseId, + /** Friendly, non-unique name intended for display */ + @JsonProperty("label") String label, + /** Friendly, non-unique name intended for display */ + @JsonProperty("displayName") String displayName, + /** Registered agent type. */ + @JsonProperty("agentType") String agentType, + /** Current durable or live agent status. */ + @JsonProperty("status") String status, + /** Model requested when the agent was launched. */ + @JsonProperty("requestedModel") String requestedModel, + /** Concrete model resolved for the agent. */ + @JsonProperty("resolvedModel") String resolvedModel, + /** Epoch milliseconds when the agent started. */ + @JsonProperty("startedAt") Long startedAt, + /** Epoch milliseconds when the agent completed. */ + @JsonProperty("completedAt") Long completedAt, + /** Accumulated active agent time in milliseconds. */ + @JsonProperty("activeMs") Long activeMs, + /** Prompt-safe live activity text. */ + @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 0000000000..e0a30f51a6 --- /dev/null +++ b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/FactoryCurrentPhase.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; + +/** + * 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( + /** Current phase identifier. */ + @JsonProperty("id") String id, + /** Zero-based declared phase ordinal, or null for an undeclared phase. */ + @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 0000000000..7fa99b005b --- /dev/null +++ b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/FactoryDeclaredLimits.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; + +/** + * 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( + /** Maximum concurrently active subagents. */ + @JsonProperty("maxConcurrentSubagents") Long maxConcurrentSubagents, + /** Maximum total subagents spawned by the run. */ + @JsonProperty("maxTotalSubagents") Long maxTotalSubagents, + /** Maximum accumulated active execution time in seconds. */ + @JsonProperty("timeoutSeconds") Double timeoutSeconds, + /** Maximum AI credits consumed by subagents and descendants. */ + @JsonProperty("maxAiCredits") Double maxAiCredits +) { +} diff --git a/java/src/generated/java/com/github/copilot/generated/rpc/FactoryExecuteParams.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/FactoryExecuteParams.java similarity index 91% rename from java/src/generated/java/com/github/copilot/generated/rpc/FactoryExecuteParams.java rename to java/sdk/src/generated/java/com/github/copilot/generated/rpc/FactoryExecuteParams.java index e6f4538146..6834dd4b12 100644 --- a/java/src/generated/java/com/github/copilot/generated/rpc/FactoryExecuteParams.java +++ b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/FactoryExecuteParams.java @@ -30,6 +30,8 @@ public record FactoryExecuteParams( @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/src/generated/java/com/github/copilot/generated/rpc/FactoryExecuteResult.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/FactoryExecuteResult.java similarity index 100% rename from java/src/generated/java/com/github/copilot/generated/rpc/FactoryExecuteResult.java rename to java/sdk/src/generated/java/com/github/copilot/generated/rpc/FactoryExecuteResult.java diff --git a/java/src/generated/java/com/github/copilot/generated/rpc/FactoryLogLine.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/FactoryLogLine.java similarity index 100% rename from java/src/generated/java/com/github/copilot/generated/rpc/FactoryLogLine.java rename to java/sdk/src/generated/java/com/github/copilot/generated/rpc/FactoryLogLine.java diff --git a/java/src/generated/java/com/github/copilot/generated/rpc/FactoryLogLineKind.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/FactoryLogLineKind.java similarity index 100% rename from java/src/generated/java/com/github/copilot/generated/rpc/FactoryLogLineKind.java rename to java/sdk/src/generated/java/com/github/copilot/generated/rpc/FactoryLogLineKind.java 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 0000000000..aa96e0cb90 --- /dev/null +++ b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/FactoryPhaseObservation.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; + +/** + * 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( + /** Phase identifier. */ + @JsonProperty("id") String id, + /** Zero-based declared phase ordinal, or null for an undeclared phase. */ + @JsonProperty("ordinal") Long ordinal, + /** Human-readable phase title. */ + @JsonProperty("title") String title, + /** Optional human-readable phase detail. */ + @JsonProperty("detail") String detail, + /** Derived lifecycle state of the phase. */ + @JsonProperty("status") FactoryPhaseStatus status, + /** Most recent run attempt that entered this phase, or `0` if the phase has never been entered. */ + @JsonProperty("lastEnteredRunAttempt") Long lastEnteredRunAttempt, + /** Number of times execution entered this phase. */ + @JsonProperty("entryCount") Long entryCount, + /** Epoch milliseconds when this phase first started; for a skipped phase, the synthetic skip timestamp (equal to `completedAt`). */ + @JsonProperty("startedAt") Long startedAt, + /** Epoch milliseconds when this phase completed; for a skipped phase, the synthetic skip timestamp (equal to `startedAt`). */ + @JsonProperty("completedAt") Long completedAt, + /** Completed active time accumulated by this phase in milliseconds. */ + @JsonProperty("accumulatedActiveMs") Long accumulatedActiveMs, + /** Current live active time for this phase in milliseconds. */ + @JsonProperty("currentActiveMs") Long currentActiveMs, + /** Total direct agents associated with this phase. */ + @JsonProperty("totalAgentCount") Long totalAgentCount, + /** Direct agents in this phase that are currently live. */ + @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 0000000000..d9fea0bc36 --- /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 0000000000..3a26b67d79 --- /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 0000000000..76278a1585 --- /dev/null +++ b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/FactoryProgressPage.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 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( + /** Progress records in sequence order. */ + @JsonProperty("records") List records, + /** Oldest sequence number in this page, or null when empty. */ + @JsonProperty("oldestSeq") Long oldestSeq, + /** Newest sequence number in this page, or null when empty. */ + @JsonProperty("newestSeq") Long newestSeq, + /** Whether progress records older than this page exist. */ + @JsonProperty("hasMoreOlder") Boolean hasMoreOlder, + /** Whether progress records newer than this page exist. */ + @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 0000000000..a492db26f6 --- /dev/null +++ b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/FactoryRunConsumed.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; + +/** + * 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( + /** Accumulated active execution time in milliseconds. */ + @JsonProperty("activeMs") Long activeMs, + /** Total subagents spawned by the run. */ + @JsonProperty("subagents") Long subagents, + /** AI usage consumed by the run in nano-AIU. */ + @JsonProperty("nanoAiu") Long nanoAiu +) { +} diff --git a/java/src/generated/java/com/github/copilot/generated/rpc/FactoryRunLimits.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/FactoryRunLimits.java similarity index 69% rename from java/src/generated/java/com/github/copilot/generated/rpc/FactoryRunLimits.java rename to java/sdk/src/generated/java/com/github/copilot/generated/rpc/FactoryRunLimits.java index ede598b806..79304772a0 100644 --- a/java/src/generated/java/com/github/copilot/generated/rpc/FactoryRunLimits.java +++ b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/FactoryRunLimits.java @@ -25,7 +25,9 @@ public record FactoryRunLimits( @JsonProperty("maxConcurrentSubagents") Long maxConcurrentSubagents, /** Maximum total number of factory subagents that may be admitted. */ @JsonProperty("maxTotalSubagents") Long maxTotalSubagents, - /** Factory active-run timeout in milliseconds. */ - @JsonProperty("timeout") Double timeout + /** 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 0000000000..bb28f40887 --- /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/src/generated/java/com/github/copilot/generated/rpc/FactoryRunStatus.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/FactoryRunStatus.java similarity index 100% rename from java/src/generated/java/com/github/copilot/generated/rpc/FactoryRunStatus.java rename to java/sdk/src/generated/java/com/github/copilot/generated/rpc/FactoryRunStatus.java 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 0000000000..f482acfa16 --- /dev/null +++ b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/FactoryRunSummary.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.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( + /** Factory run identifier. */ + @JsonProperty("runId") String runId, + /** Registered factory name. */ + @JsonProperty("factoryName") String factoryName, + /** Human-readable factory description. */ + @JsonProperty("description") String description, + /** Current factory run status. */ + @JsonProperty("status") FactoryRunStatus status, + /** Monotonic durable run revision. */ + @JsonProperty("revision") Long revision, + /** Epoch milliseconds when the run was created. */ + @JsonProperty("createdAt") Long createdAt, + /** Epoch milliseconds when execution first started, or null before start. */ + @JsonProperty("startedAt") Long startedAt, + /** Epoch milliseconds when the durable run was last updated. */ + @JsonProperty("updatedAt") Long updatedAt, + /** Epoch milliseconds when the run completed, or null while nonterminal. */ + @JsonProperty("completedAt") Long completedAt, + /** Current phase identity, or null before any phase is entered. */ + @JsonProperty("currentPhase") FactoryCurrentPhase currentPhase, + /** Number of phases declared by the factory. */ + @JsonProperty("declaredPhaseCount") Long declaredPhaseCount, + /** Number of direct factory agents currently live. */ + @JsonProperty("liveAgentCount") Long liveAgentCount, + /** Total direct factory agents spawned across all attempts. */ + @JsonProperty("totalSpawnedAgentCount") Long totalSpawnedAgentCount, + /** Durable resource consumption. */ + @JsonProperty("consumed") FactoryRunConsumed consumed, + /** Resource ceilings declared by the factory. */ + @JsonProperty("declaredLimits") FactoryDeclaredLimits declaredLimits, + /** Approved effective resource ceilings, or null until approved. */ + @JsonProperty("approved") FactoryDeclaredLimits approved, + /** Epoch milliseconds when this live-overlay snapshot was observed. */ + @JsonProperty("observedAt") Long observedAt, + /** Epoch milliseconds when the current active segment started, or null while inactive. */ + @JsonProperty("activeSegmentStartedAt") Long activeSegmentStartedAt, + /** Terminal run outcome, or null while nonterminal. */ + @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 0000000000..bf9bfa7db4 --- /dev/null +++ b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/FactoryRunTerminal.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; + +/** + * 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( + /** Human-readable terminal reason. */ + @JsonProperty("reason") String reason, + /** Machine-readable terminal failure. */ + @JsonProperty("failure") Object failure, + /** Human-readable terminal error. */ + @JsonProperty("error") String error, + /** Prompt-safe preview of the completed result. */ + @JsonProperty("resultPreview") String resultPreview +) { +} diff --git a/java/sdk/src/generated/java/com/github/copilot/generated/rpc/FactoryToolRunOptions.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/FactoryToolRunOptions.java new file mode 100644 index 0000000000..cc3e7c8da1 --- /dev/null +++ b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/FactoryToolRunOptions.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 for an internal tool-originated factory invocation. + * + * @since 1.0.0 + */ +@javax.annotation.processing.Generated("copilot-sdk-codegen") +@JsonInclude(JsonInclude.Include.NON_NULL) +@JsonIgnoreProperties(ignoreUnknown = true) +public record FactoryToolRunOptions( + /** 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/GhCliAuthInfo.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/GhCliAuthInfo.java new file mode 100644 index 0000000000..5bfc896f63 --- /dev/null +++ b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/GhCliAuthInfo.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; + +/** + * Authentication-info input variant for GitHub CLI credentials, carrying host, login, and the `gh auth token` value. + * + * @since 1.0.0 + */ +@JsonIgnoreProperties(ignoreUnknown = true) +@JsonInclude(JsonInclude.Include.NON_NULL) +@javax.annotation.processing.Generated("copilot-sdk-codegen") +public final class GhCliAuthInfo extends AuthInfo { + + @JsonProperty("type") + private final String type = "gh-cli"; + + @Override + public String getType() { return type; } + + /** Authentication host. */ + @JsonProperty("host") + private String host; + + /** User login as reported by `gh auth status`. */ + @JsonProperty("login") + private String login; + + /** The token returned by `gh auth token`. Treat as a secret. */ + @JsonProperty("token") + private String 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. */ + @JsonProperty("copilotUser") + private CopilotUserResponse copilotUser; + + public String getHost() { return host; } + public void setHost(String host) { this.host = host; } + + public String getLogin() { return login; } + public void setLogin(String login) { this.login = login; } + + public String getToken() { return token; } + public void setToken(String token) { this.token = token; } + + public CopilotUserResponse getCopilotUser() { return copilotUser; } + public void setCopilotUser(CopilotUserResponse copilotUser) { this.copilotUser = copilotUser; } +} diff --git a/java/src/generated/java/com/github/copilot/generated/rpc/GitHubTelemetryClientInfo.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/GitHubTelemetryClientInfo.java similarity index 87% rename from java/src/generated/java/com/github/copilot/generated/rpc/GitHubTelemetryClientInfo.java rename to java/sdk/src/generated/java/com/github/copilot/generated/rpc/GitHubTelemetryClientInfo.java index 7d7a1eaf72..b6bef1bffd 100644 --- a/java/src/generated/java/com/github/copilot/generated/rpc/GitHubTelemetryClientInfo.java +++ b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/GitHubTelemetryClientInfo.java @@ -40,6 +40,10 @@ public record GitHubTelemetryClientInfo( /** 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 + @JsonProperty("dev_device_id") String devDeviceId, + /** Distinct CPU model names for the host, comma-separated. */ + @JsonProperty("cpu_model") String cpuModel, + /** Number of logical CPU cores on the host. */ + @JsonProperty("cpu_count") Long cpuCount ) { } diff --git a/java/src/generated/java/com/github/copilot/generated/rpc/GitHubTelemetryEvent.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/GitHubTelemetryEvent.java similarity index 100% rename from java/src/generated/java/com/github/copilot/generated/rpc/GitHubTelemetryEvent.java rename to java/sdk/src/generated/java/com/github/copilot/generated/rpc/GitHubTelemetryEvent.java diff --git a/java/src/generated/java/com/github/copilot/generated/rpc/GitHubTelemetryNotification.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/GitHubTelemetryNotification.java similarity index 100% rename from java/src/generated/java/com/github/copilot/generated/rpc/GitHubTelemetryNotification.java rename to java/sdk/src/generated/java/com/github/copilot/generated/rpc/GitHubTelemetryNotification.java diff --git a/java/sdk/src/generated/java/com/github/copilot/generated/rpc/GitHubTokenAcquireReason.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/GitHubTokenAcquireReason.java new file mode 100644 index 0000000000..9f18889a03 --- /dev/null +++ b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/GitHubTokenAcquireReason.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; + +/** + * Why the runtime is requesting a GitHub credential. + * + * @since 1.0.0 + */ +@javax.annotation.processing.Generated("copilot-sdk-codegen") +public enum GitHubTokenAcquireReason { + /** The {@code initial} variant. */ + INITIAL("initial"), + /** The {@code refresh} variant. */ + REFRESH("refresh"); + + private final String value; + GitHubTokenAcquireReason(String value) { this.value = value; } + @com.fasterxml.jackson.annotation.JsonValue + public String getValue() { return value; } + @com.fasterxml.jackson.annotation.JsonCreator + public static GitHubTokenAcquireReason fromValue(String value) { + for (GitHubTokenAcquireReason v : values()) { + if (v.value.equals(value)) return v; + } + throw new IllegalArgumentException("Unknown GitHubTokenAcquireReason value: " + value); + } +} diff --git a/java/sdk/src/generated/java/com/github/copilot/generated/rpc/GitHubTokenAcquireRequest.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/GitHubTokenAcquireRequest.java new file mode 100644 index 0000000000..59ba9d8ed5 --- /dev/null +++ b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/GitHubTokenAcquireRequest.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; + +/** + * Asks the SDK client to acquire a GitHub access token from an opaque callback registration. + * + * @since 1.0.0 + */ +@javax.annotation.processing.Generated("copilot-sdk-codegen") +@JsonInclude(JsonInclude.Include.NON_NULL) +@JsonIgnoreProperties(ignoreUnknown = true) +public record GitHubTokenAcquireRequest( + /** Opaque identifier generated by the SDK for this callback registration. */ + @JsonProperty("registrationId") String registrationId, + /** Effective GitHub host for which the callback must return a token. */ + @JsonProperty("host") String host, + /** Session receiving the token. Absent only before a cloud session has been assigned its id. */ + @JsonProperty("sessionId") String sessionId, + /** Why the runtime is requesting a GitHub credential. */ + @JsonProperty("reason") GitHubTokenAcquireReason reason +) { +} diff --git a/java/sdk/src/generated/java/com/github/copilot/generated/rpc/GitHubTokenAcquireResult.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/GitHubTokenAcquireResult.java new file mode 100644 index 0000000000..a20724c337 --- /dev/null +++ b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/GitHubTokenAcquireResult.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; + +/** + * SDK host response to a GitHub credential request. + * + * @since 1.0.0 + */ +@JsonTypeInfo(use = JsonTypeInfo.Id.NAME, property = "kind", visible = true) +@JsonSubTypes({ + @JsonSubTypes.Type(value = GitHubTokenAcquireResultToken.class, name = "token"), + @JsonSubTypes.Type(value = GitHubTokenAcquireResultCancelled.class, name = "cancelled") +}) +@JsonIgnoreProperties(ignoreUnknown = true) +@javax.annotation.processing.Generated("copilot-sdk-codegen") +public abstract class GitHubTokenAcquireResult { + + /** + * 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/GitHubTokenAcquireResultCancelled.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/GitHubTokenAcquireResultCancelled.java new file mode 100644 index 0000000000..40ab8d5f74 --- /dev/null +++ b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/GitHubTokenAcquireResultCancelled.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 javax.annotation.processing.Generated; + +/** + * Variant {@code cancelled} of {@link GitHubTokenAcquireResult}. + * + * @since 1.0.0 + */ +@JsonIgnoreProperties(ignoreUnknown = true) +@JsonInclude(JsonInclude.Include.NON_NULL) +@javax.annotation.processing.Generated("copilot-sdk-codegen") +public final class GitHubTokenAcquireResultCancelled extends GitHubTokenAcquireResult { + + @JsonProperty("kind") + private final String kind = "cancelled"; + + @Override + public String getKind() { return kind; } +} diff --git a/java/sdk/src/generated/java/com/github/copilot/generated/rpc/GitHubTokenAcquireResultToken.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/GitHubTokenAcquireResultToken.java new file mode 100644 index 0000000000..cc250a54fd --- /dev/null +++ b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/GitHubTokenAcquireResultToken.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; + +/** + * Variant {@code token} of {@link GitHubTokenAcquireResult}. + * + * @since 1.0.0 + */ +@JsonIgnoreProperties(ignoreUnknown = true) +@JsonInclude(JsonInclude.Include.NON_NULL) +@javax.annotation.processing.Generated("copilot-sdk-codegen") +public final class GitHubTokenAcquireResultToken extends GitHubTokenAcquireResult { + + @JsonProperty("kind") + private final String kind = "token"; + + @Override + public String getKind() { return kind; } + + /** GitHub access token acquired by the SDK host. */ + @JsonProperty("accessToken") + private String accessToken; + + /** OAuth token type. Defaults to bearer when omitted. */ + @JsonProperty("tokenType") + private String tokenType; + + /** Remaining token lifetime in seconds when callback execution completes. It must exceed the one-hour preflight refresh threshold. */ + @JsonProperty("expiresIn") + private Long expiresIn; + + public String getAccessToken() { return accessToken; } + public void setAccessToken(String accessToken) { this.accessToken = accessToken; } + + public String getTokenType() { return tokenType; } + public void setTokenType(String tokenType) { this.tokenType = tokenType; } + + public Long getExpiresIn() { return expiresIn; } + public void setExpiresIn(Long expiresIn) { this.expiresIn = expiresIn; } +} diff --git a/java/sdk/src/generated/java/com/github/copilot/generated/rpc/HMACAuthInfo.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/HMACAuthInfo.java new file mode 100644 index 0000000000..06cebd66c5 --- /dev/null +++ b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/HMACAuthInfo.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; + +/** + * Authentication-info input variant for GitHub-internal HMAC auth, carrying the public GitHub host and HMAC secret. + * + * @since 1.0.0 + */ +@JsonIgnoreProperties(ignoreUnknown = true) +@JsonInclude(JsonInclude.Include.NON_NULL) +@javax.annotation.processing.Generated("copilot-sdk-codegen") +public final class HMACAuthInfo extends AuthInfo { + + @JsonProperty("type") + private final String type = "hmac"; + + @Override + public String getType() { return type; } + + /** Authentication host. HMAC auth always targets the public GitHub host. */ + @JsonProperty("host") + private String host; + + /** HMAC secret used to sign requests. */ + @JsonProperty("hmac") + private String 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. */ + @JsonProperty("copilotUser") + private CopilotUserResponse copilotUser; + + public String getHost() { return host; } + public void setHost(String host) { this.host = host; } + + public String getHmac() { return hmac; } + public void setHmac(String hmac) { this.hmac = hmac; } + + public CopilotUserResponse getCopilotUser() { return copilotUser; } + public void setCopilotUser(CopilotUserResponse copilotUser) { this.copilotUser = copilotUser; } +} 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 0000000000..46e943e016 --- /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 0000000000..85b12b873f --- /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 0000000000..7733246dd0 --- /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 0000000000..f72ded947a --- /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 0000000000..624795ee4e --- /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 0000000000..84926c74e0 --- /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 0000000000..ae6b029ac4 --- /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 0000000000..60c8c2d40c --- /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/src/generated/java/com/github/copilot/generated/rpc/HookInvokeRequest.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/HookInvokeRequest.java similarity index 100% rename from java/src/generated/java/com/github/copilot/generated/rpc/HookInvokeRequest.java rename to java/sdk/src/generated/java/com/github/copilot/generated/rpc/HookInvokeRequest.java diff --git a/java/src/generated/java/com/github/copilot/generated/rpc/HookType.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/HookType.java similarity index 100% rename from java/src/generated/java/com/github/copilot/generated/rpc/HookType.java rename to java/sdk/src/generated/java/com/github/copilot/generated/rpc/HookType.java diff --git a/java/src/generated/java/com/github/copilot/generated/rpc/HooksInvokeResult.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/HooksInvokeResult.java similarity index 100% rename from java/src/generated/java/com/github/copilot/generated/rpc/HooksInvokeResult.java rename to java/sdk/src/generated/java/com/github/copilot/generated/rpc/HooksInvokeResult.java diff --git a/java/src/generated/java/com/github/copilot/generated/rpc/InstalledPlugin.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/InstalledPlugin.java similarity index 61% rename from java/src/generated/java/com/github/copilot/generated/rpc/InstalledPlugin.java rename to java/sdk/src/generated/java/com/github/copilot/generated/rpc/InstalledPlugin.java index b3487e7e31..e372049403 100644 --- a/java/src/generated/java/com/github/copilot/generated/rpc/InstalledPlugin.java +++ b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/InstalledPlugin.java @@ -34,6 +34,10 @@ public record InstalledPlugin( /** 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 + @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, + /** Absolute path of the marketplace directory a live plugin was resolved from. Present only on live, never-persisted records β€” those synthesized at session start for a directory/local marketplace, whose cache_path points at the real plugin directory on disk rather than a copy under the installed-plugins cache. Its presence is what marks a record as live, and no record carrying it is ever written to the persisted installedPlugins key. */ + @JsonProperty("installed_from") String installedFrom ) { } diff --git a/java/src/generated/java/com/github/copilot/generated/rpc/InstalledPluginInfo.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/InstalledPluginInfo.java similarity index 73% rename from java/src/generated/java/com/github/copilot/generated/rpc/InstalledPluginInfo.java rename to java/sdk/src/generated/java/com/github/copilot/generated/rpc/InstalledPluginInfo.java index 2f4895690f..2c81e95f2b 100644 --- a/java/src/generated/java/com/github/copilot/generated/rpc/InstalledPluginInfo.java +++ b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/InstalledPluginInfo.java @@ -30,6 +30,8 @@ public record InstalledPluginInfo( /** 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 + @JsonProperty("enabled") Boolean enabled, + /** Absolute path of the marketplace directory a live plugin was resolved from. Present only on live, never-persisted records β€” a plugin belonging to a directory/local marketplace, which is loaded from its real directory on every pass instead of a copy under the installed-plugins cache. Its presence is what marks a listed plugin as live: such a plugin is always present on disk, so `enabled` is its only meaningful state and it is never "not installed". */ + @JsonProperty("installedFrom") String installedFrom ) { } diff --git a/java/src/generated/java/com/github/copilot/generated/rpc/InstructionDiscoveryPath.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/InstructionDiscoveryPath.java similarity index 100% rename from java/src/generated/java/com/github/copilot/generated/rpc/InstructionDiscoveryPath.java rename to java/sdk/src/generated/java/com/github/copilot/generated/rpc/InstructionDiscoveryPath.java diff --git a/java/src/generated/java/com/github/copilot/generated/rpc/InstructionDiscoveryPathKind.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/InstructionDiscoveryPathKind.java similarity index 100% rename from java/src/generated/java/com/github/copilot/generated/rpc/InstructionDiscoveryPathKind.java rename to java/sdk/src/generated/java/com/github/copilot/generated/rpc/InstructionDiscoveryPathKind.java diff --git a/java/src/generated/java/com/github/copilot/generated/rpc/InstructionDiscoveryPathLocation.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/InstructionDiscoveryPathLocation.java similarity index 100% rename from java/src/generated/java/com/github/copilot/generated/rpc/InstructionDiscoveryPathLocation.java rename to java/sdk/src/generated/java/com/github/copilot/generated/rpc/InstructionDiscoveryPathLocation.java diff --git a/java/src/generated/java/com/github/copilot/generated/rpc/InstructionSource.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/InstructionSource.java similarity index 90% rename from java/src/generated/java/com/github/copilot/generated/rpc/InstructionSource.java rename to java/sdk/src/generated/java/com/github/copilot/generated/rpc/InstructionSource.java index 2581375b33..496e1eadc1 100644 --- a/java/src/generated/java/com/github/copilot/generated/rpc/InstructionSource.java +++ b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/InstructionSource.java @@ -40,7 +40,7 @@ public record InstructionSource( @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 sources, where it disambiguates same-named files (e.g. .github/copilot-instructions.md) across multiple workspace roots. The session-scoped getSources leaves it unset. */ + /** 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/src/generated/java/com/github/copilot/generated/rpc/InstructionSourceLocation.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/InstructionSourceLocation.java similarity index 100% rename from java/src/generated/java/com/github/copilot/generated/rpc/InstructionSourceLocation.java rename to java/sdk/src/generated/java/com/github/copilot/generated/rpc/InstructionSourceLocation.java diff --git a/java/src/generated/java/com/github/copilot/generated/rpc/InstructionSourceType.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/InstructionSourceType.java similarity index 100% rename from java/src/generated/java/com/github/copilot/generated/rpc/InstructionSourceType.java rename to java/sdk/src/generated/java/com/github/copilot/generated/rpc/InstructionSourceType.java diff --git a/java/src/generated/java/com/github/copilot/generated/rpc/InstructionsDiscoverParams.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/InstructionsDiscoverParams.java similarity index 100% rename from java/src/generated/java/com/github/copilot/generated/rpc/InstructionsDiscoverParams.java rename to java/sdk/src/generated/java/com/github/copilot/generated/rpc/InstructionsDiscoverParams.java diff --git a/java/src/generated/java/com/github/copilot/generated/rpc/InstructionsDiscoverResult.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/InstructionsDiscoverResult.java similarity index 100% rename from java/src/generated/java/com/github/copilot/generated/rpc/InstructionsDiscoverResult.java rename to java/sdk/src/generated/java/com/github/copilot/generated/rpc/InstructionsDiscoverResult.java diff --git a/java/src/generated/java/com/github/copilot/generated/rpc/InstructionsGetDiscoveryPathsParams.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/InstructionsGetDiscoveryPathsParams.java similarity index 100% rename from java/src/generated/java/com/github/copilot/generated/rpc/InstructionsGetDiscoveryPathsParams.java rename to java/sdk/src/generated/java/com/github/copilot/generated/rpc/InstructionsGetDiscoveryPathsParams.java diff --git a/java/src/generated/java/com/github/copilot/generated/rpc/InstructionsGetDiscoveryPathsResult.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/InstructionsGetDiscoveryPathsResult.java similarity index 100% rename from java/src/generated/java/com/github/copilot/generated/rpc/InstructionsGetDiscoveryPathsResult.java rename to java/sdk/src/generated/java/com/github/copilot/generated/rpc/InstructionsGetDiscoveryPathsResult.java diff --git a/java/src/generated/java/com/github/copilot/generated/rpc/LlmInferenceHttpRequestChunkRequest.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/LlmInferenceHttpRequestChunkRequest.java similarity index 100% rename from java/src/generated/java/com/github/copilot/generated/rpc/LlmInferenceHttpRequestChunkRequest.java rename to java/sdk/src/generated/java/com/github/copilot/generated/rpc/LlmInferenceHttpRequestChunkRequest.java diff --git a/java/src/generated/java/com/github/copilot/generated/rpc/LlmInferenceHttpRequestChunkResult.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/LlmInferenceHttpRequestChunkResult.java similarity index 100% rename from java/src/generated/java/com/github/copilot/generated/rpc/LlmInferenceHttpRequestChunkResult.java rename to java/sdk/src/generated/java/com/github/copilot/generated/rpc/LlmInferenceHttpRequestChunkResult.java diff --git a/java/src/generated/java/com/github/copilot/generated/rpc/LlmInferenceHttpRequestStartRequest.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/LlmInferenceHttpRequestStartRequest.java similarity index 98% rename from java/src/generated/java/com/github/copilot/generated/rpc/LlmInferenceHttpRequestStartRequest.java rename to java/sdk/src/generated/java/com/github/copilot/generated/rpc/LlmInferenceHttpRequestStartRequest.java index b846fcf37c..a75733cb3a 100644 --- a/java/src/generated/java/com/github/copilot/generated/rpc/LlmInferenceHttpRequestStartRequest.java +++ b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/LlmInferenceHttpRequestStartRequest.java @@ -31,6 +31,7 @@ public record LlmInferenceHttpRequestStartRequest( @JsonProperty("method") String method, /** Absolute request URL. */ @JsonProperty("url") String url, + /** HTTP request headers, preserving multiple values per name. */ @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, diff --git a/java/src/generated/java/com/github/copilot/generated/rpc/LlmInferenceHttpRequestStartResult.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/LlmInferenceHttpRequestStartResult.java similarity index 100% rename from java/src/generated/java/com/github/copilot/generated/rpc/LlmInferenceHttpRequestStartResult.java rename to java/sdk/src/generated/java/com/github/copilot/generated/rpc/LlmInferenceHttpRequestStartResult.java diff --git a/java/src/generated/java/com/github/copilot/generated/rpc/LlmInferenceHttpRequestStartTransport.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/LlmInferenceHttpRequestStartTransport.java similarity index 100% rename from java/src/generated/java/com/github/copilot/generated/rpc/LlmInferenceHttpRequestStartTransport.java rename to java/sdk/src/generated/java/com/github/copilot/generated/rpc/LlmInferenceHttpRequestStartTransport.java diff --git a/java/src/generated/java/com/github/copilot/generated/rpc/LlmInferenceHttpResponseChunkError.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/LlmInferenceHttpResponseChunkError.java similarity index 100% rename from java/src/generated/java/com/github/copilot/generated/rpc/LlmInferenceHttpResponseChunkError.java rename to java/sdk/src/generated/java/com/github/copilot/generated/rpc/LlmInferenceHttpResponseChunkError.java diff --git a/java/src/generated/java/com/github/copilot/generated/rpc/LlmInferenceHttpResponseChunkParams.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/LlmInferenceHttpResponseChunkParams.java similarity index 100% rename from java/src/generated/java/com/github/copilot/generated/rpc/LlmInferenceHttpResponseChunkParams.java rename to java/sdk/src/generated/java/com/github/copilot/generated/rpc/LlmInferenceHttpResponseChunkParams.java diff --git a/java/src/generated/java/com/github/copilot/generated/rpc/LlmInferenceHttpResponseChunkResult.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/LlmInferenceHttpResponseChunkResult.java similarity index 100% rename from java/src/generated/java/com/github/copilot/generated/rpc/LlmInferenceHttpResponseChunkResult.java rename to java/sdk/src/generated/java/com/github/copilot/generated/rpc/LlmInferenceHttpResponseChunkResult.java diff --git a/java/src/generated/java/com/github/copilot/generated/rpc/LlmInferenceHttpResponseStartParams.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/LlmInferenceHttpResponseStartParams.java similarity index 95% rename from java/src/generated/java/com/github/copilot/generated/rpc/LlmInferenceHttpResponseStartParams.java rename to java/sdk/src/generated/java/com/github/copilot/generated/rpc/LlmInferenceHttpResponseStartParams.java index 69c26221b8..dddc6a315a 100644 --- a/java/src/generated/java/com/github/copilot/generated/rpc/LlmInferenceHttpResponseStartParams.java +++ b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/LlmInferenceHttpResponseStartParams.java @@ -32,6 +32,7 @@ public record LlmInferenceHttpResponseStartParams( @JsonProperty("status") Long status, /** Optional HTTP status reason phrase. */ @JsonProperty("statusText") String statusText, + /** HTTP response headers, preserving multiple values per name. */ @JsonProperty("headers") Map> headers ) { } diff --git a/java/src/generated/java/com/github/copilot/generated/rpc/LlmInferenceHttpResponseStartResult.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/LlmInferenceHttpResponseStartResult.java similarity index 100% rename from java/src/generated/java/com/github/copilot/generated/rpc/LlmInferenceHttpResponseStartResult.java rename to java/sdk/src/generated/java/com/github/copilot/generated/rpc/LlmInferenceHttpResponseStartResult.java diff --git a/java/src/generated/java/com/github/copilot/generated/rpc/LlmInferenceSetProviderResult.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/LlmInferenceSetProviderResult.java similarity index 100% rename from java/src/generated/java/com/github/copilot/generated/rpc/LlmInferenceSetProviderResult.java rename to java/sdk/src/generated/java/com/github/copilot/generated/rpc/LlmInferenceSetProviderResult.java diff --git a/java/src/generated/java/com/github/copilot/generated/rpc/LocalSessionMetadataValue.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/LocalSessionMetadataValue.java similarity index 100% rename from java/src/generated/java/com/github/copilot/generated/rpc/LocalSessionMetadataValue.java rename to java/sdk/src/generated/java/com/github/copilot/generated/rpc/LocalSessionMetadataValue.java 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 0000000000..2018f62ce0 --- /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/src/generated/java/com/github/copilot/generated/rpc/MarketplaceInfo.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/MarketplaceInfo.java similarity index 100% rename from java/src/generated/java/com/github/copilot/generated/rpc/MarketplaceInfo.java rename to java/sdk/src/generated/java/com/github/copilot/generated/rpc/MarketplaceInfo.java diff --git a/java/src/generated/java/com/github/copilot/generated/rpc/MarketplacePluginInfo.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/MarketplacePluginInfo.java similarity index 100% rename from java/src/generated/java/com/github/copilot/generated/rpc/MarketplacePluginInfo.java rename to java/sdk/src/generated/java/com/github/copilot/generated/rpc/MarketplacePluginInfo.java diff --git a/java/src/generated/java/com/github/copilot/generated/rpc/MarketplaceRefreshEntry.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/MarketplaceRefreshEntry.java similarity index 100% rename from java/src/generated/java/com/github/copilot/generated/rpc/MarketplaceRefreshEntry.java rename to java/sdk/src/generated/java/com/github/copilot/generated/rpc/MarketplaceRefreshEntry.java diff --git a/java/src/generated/java/com/github/copilot/generated/rpc/McpAllowedServer.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/McpAllowedServer.java similarity index 100% rename from java/src/generated/java/com/github/copilot/generated/rpc/McpAllowedServer.java rename to java/sdk/src/generated/java/com/github/copilot/generated/rpc/McpAllowedServer.java 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 100% 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 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 100% 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 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 100% 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 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 100% 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 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 100% 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 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 100% 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 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 100% 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 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 100% 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 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 100% 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 diff --git a/java/sdk/src/generated/java/com/github/copilot/generated/rpc/McpElicitationFormMode.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/McpElicitationFormMode.java new file mode 100644 index 0000000000..8bb655e3e8 --- /dev/null +++ b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/McpElicitationFormMode.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 javax.annotation.processing.Generated; + +/** + * Structured MCP elicitation mode. + * + * @since 1.0.0 + */ +@javax.annotation.processing.Generated("copilot-sdk-codegen") +public enum McpElicitationFormMode { + /** The {@code form} variant. */ + FORM("form"); + + private final String value; + McpElicitationFormMode(String value) { this.value = value; } + @com.fasterxml.jackson.annotation.JsonValue + public String getValue() { return value; } + @com.fasterxml.jackson.annotation.JsonCreator + public static McpElicitationFormMode fromValue(String value) { + for (McpElicitationFormMode v : values()) { + if (v.value.equals(value)) return v; + } + throw new IllegalArgumentException("Unknown McpElicitationFormMode value: " + value); + } +} 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/McpFailedServer.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/McpFailedServer.java new file mode 100644 index 0000000000..36009e4915 --- /dev/null +++ b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/McpFailedServer.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 whose connection attempt failed. + * + * @since 1.0.0 + */ +@javax.annotation.processing.Generated("copilot-sdk-codegen") +@JsonInclude(JsonInclude.Include.NON_NULL) +@JsonIgnoreProperties(ignoreUnknown = true) +public record McpFailedServer( + /** The config key of the server that failed to connect. */ + @JsonProperty("name") String name, + /** The captured connection failure detail. */ + @JsonProperty("error") String error +) { +} diff --git a/java/src/generated/java/com/github/copilot/generated/rpc/McpFilteredServer.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/McpFilteredServer.java similarity index 87% rename from java/src/generated/java/com/github/copilot/generated/rpc/McpFilteredServer.java rename to java/sdk/src/generated/java/com/github/copilot/generated/rpc/McpFilteredServer.java index 51dbd2bd14..e0ecefae76 100644 --- a/java/src/generated/java/com/github/copilot/generated/rpc/McpFilteredServer.java +++ b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/McpFilteredServer.java @@ -13,7 +13,7 @@ import javax.annotation.processing.Generated; /** - * MCP server filtered by policy, with name, reason, optional redacted reason, and enterprise login. + * MCP server filtered by policy, with name, reason, and optional redacted reason. * * @since 1.0.0 */ @@ -27,7 +27,7 @@ public record McpFilteredServer( @JsonProperty("reason") String reason, /** PII-free filter reason */ @JsonProperty("redactedReason") String redactedReason, - /** Enterprise login associated with an allowlist policy */ + /** Deprecated. This field is no longer populated. */ @JsonProperty("enterpriseName") String enterpriseName ) { } diff --git a/java/src/generated/java/com/github/copilot/generated/rpc/McpHostState.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/McpHostState.java similarity index 95% rename from java/src/generated/java/com/github/copilot/generated/rpc/McpHostState.java rename to java/sdk/src/generated/java/com/github/copilot/generated/rpc/McpHostState.java index 0326a120e1..152bd8556e 100644 --- a/java/src/generated/java/com/github/copilot/generated/rpc/McpHostState.java +++ b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/McpHostState.java @@ -27,7 +27,7 @@ public record McpHostState( @JsonProperty("mcp3pEnabled") Boolean mcp3pEnabled, /** Configured servers that are explicitly disabled. */ @JsonProperty("disabledServers") List disabledServers, - /** Configured servers filtered out by enterprise allowlist policy. */ + /** Configured servers filtered out by MCP server policy. */ @JsonProperty("filteredServers") List filteredServers, /** Names of currently-connected MCP clients. */ @JsonProperty("clients") List clients, diff --git a/java/sdk/src/generated/java/com/github/copilot/generated/rpc/McpInstallPlan.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/McpInstallPlan.java new file mode 100644 index 0000000000..7274ce2b7f --- /dev/null +++ b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/McpInstallPlan.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 java.util.List; +import javax.annotation.processing.Generated; + +/** + * A normalised, inert description of what installing an MCP server would involve. Carries no raw card, no install specification, and no secret value. + * + * @since 1.0.0 + */ +@javax.annotation.processing.Generated("copilot-sdk-codegen") +@JsonInclude(JsonInclude.Include.NON_NULL) +@JsonIgnoreProperties(ignoreUnknown = true) +public record McpInstallPlan( + /** Opaque, runtime-instance scoped, TTL-bound, single-use handle for this plan. Rejected when stale, replayed, or presented to a different runtime instance. Never logged. */ + @JsonProperty("planHandle") String planHandle, + /** ISO 8601 timestamp after which the plan handle is stale and will be rejected. Abandoning a plan needs no call: an unused handle simply expires, so cancellation before commit is side-effect free. */ + @JsonProperty("planHandleExpiresAt") String planHandleExpiresAt, + /** Normalised identity of the server the plan would install. */ + @JsonProperty("identity") McpPlanResourceIdentity identity, + /** Origin and semantic digest of the exact validated JSON MCP card content bound to this plan. */ + @JsonProperty("provenance") McpPlanProvenance provenance, + /** Every eligible transport, so a host can present an explicit choice. A completed plan always has at least one; when none is eligible, planning returns `CatalogUnavailableTransportError` instead. */ + @JsonProperty("transportChoices") List transportChoices, + /** Identifier of the choice the runtime would pick by default. Omitted when there is no eligible transport, or when the runtime expresses no preference. */ + @JsonProperty("recommendedTransportChoiceId") String recommendedTransportChoiceId, + /** Configuration scope and key the plan would write to. */ + @JsonProperty("target") McpPlanTarget target, + /** Outcome of evaluating the server against registry and enterprise policy. */ + @JsonProperty("policy") McpPlanPolicyResult policy, + /** The configuration changes installing would make, described rather than serialised, so the mutable configuration payload stays behind the runtime boundary. */ + @JsonProperty("configurationChanges") List configurationChanges, + /** Whether applying this plan would require an MCP reload to take effect. Planning itself never reloads. */ + @JsonProperty("reloadRequired") Boolean reloadRequired, + /** Whether the plan cannot be applied without further input, because a required value has no default or a secret must be supplied. */ + @JsonProperty("requiresInteractiveConfiguration") Boolean requiresInteractiveConfiguration +) { +} diff --git a/java/src/generated/java/com/github/copilot/generated/rpc/McpOauthLoginGrantType.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/McpOauthLoginGrantType.java similarity index 100% rename from java/src/generated/java/com/github/copilot/generated/rpc/McpOauthLoginGrantType.java rename to java/sdk/src/generated/java/com/github/copilot/generated/rpc/McpOauthLoginGrantType.java diff --git a/java/sdk/src/generated/java/com/github/copilot/generated/rpc/McpOauthProbeNeedsAuthReason.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/McpOauthProbeNeedsAuthReason.java new file mode 100644 index 0000000000..967a01aabc --- /dev/null +++ b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/McpOauthProbeNeedsAuthReason.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; + +/** + * Why a passive MCP OAuth probe determined authentication is needed. + * + * @since 1.0.0 + */ +@javax.annotation.processing.Generated("copilot-sdk-codegen") +public enum McpOauthProbeNeedsAuthReason { + /** The {@code initial} variant. */ + INITIAL("initial"), + /** The {@code refresh} variant. */ + REFRESH("refresh"), + /** The {@code upscope} variant. */ + UPSCOPE("upscope"); + + private final String value; + McpOauthProbeNeedsAuthReason(String value) { this.value = value; } + @com.fasterxml.jackson.annotation.JsonValue + public String getValue() { return value; } + @com.fasterxml.jackson.annotation.JsonCreator + public static McpOauthProbeNeedsAuthReason fromValue(String value) { + for (McpOauthProbeNeedsAuthReason v : values()) { + if (v.value.equals(value)) return v; + } + throw new IllegalArgumentException("Unknown McpOauthProbeNeedsAuthReason value: " + value); + } +} diff --git a/java/sdk/src/generated/java/com/github/copilot/generated/rpc/McpOauthProbeResult.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/McpOauthProbeResult.java new file mode 100644 index 0000000000..1a94e17142 --- /dev/null +++ b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/McpOauthProbeResult.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; + +/** + * Passive MCP OAuth probe result. `authenticated` means the server accepted the probe request while an OAuth-origin access token was attached; it does not prove the server required or independently validated that token. The probe does not make a second unauthenticated request. Failed is an expected probe-domain outcome; JSON-RPC errors are reserved for API-call failures. + * + * @since 1.0.0 + */ +@JsonTypeInfo(use = JsonTypeInfo.Id.NAME, property = "status", visible = true) +@JsonSubTypes({ + @JsonSubTypes.Type(value = McpOauthProbeResultNoAuthRequired.class, name = "no-auth-required"), + @JsonSubTypes.Type(value = McpOauthProbeResultAuthenticated.class, name = "authenticated"), + @JsonSubTypes.Type(value = McpOauthProbeResultNeedsAuth.class, name = "needs-auth"), + @JsonSubTypes.Type(value = McpOauthProbeResultFailed.class, name = "failed") +}) +@JsonIgnoreProperties(ignoreUnknown = true) +@javax.annotation.processing.Generated("copilot-sdk-codegen") +public abstract class McpOauthProbeResult { + + /** + * Returns the discriminator value for this variant. + * + * @return the status discriminator + */ + public abstract String getStatus(); +} diff --git a/java/sdk/src/generated/java/com/github/copilot/generated/rpc/McpOauthProbeResultAuthenticated.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/McpOauthProbeResultAuthenticated.java new file mode 100644 index 0000000000..8af0d6ca4e --- /dev/null +++ b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/McpOauthProbeResultAuthenticated.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.generated.McpOauthHttpResponse; +import javax.annotation.processing.Generated; + +/** + * Variant {@code authenticated} of {@link McpOauthProbeResult}. + * + * @since 1.0.0 + */ +@JsonIgnoreProperties(ignoreUnknown = true) +@JsonInclude(JsonInclude.Include.NON_NULL) +@javax.annotation.processing.Generated("copilot-sdk-codegen") +public final class McpOauthProbeResultAuthenticated extends McpOauthProbeResult { + + @JsonProperty("status") + private final String status = "authenticated"; + + @Override + public String getStatus() { return status; } + + /** HTTP response returned by the server. */ + @JsonProperty("httpResponse") + private McpOauthHttpResponse httpResponse; + + public McpOauthHttpResponse getHttpResponse() { return httpResponse; } + public void setHttpResponse(McpOauthHttpResponse httpResponse) { this.httpResponse = httpResponse; } +} diff --git a/java/sdk/src/generated/java/com/github/copilot/generated/rpc/McpOauthProbeResultFailed.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/McpOauthProbeResultFailed.java new file mode 100644 index 0000000000..a613265878 --- /dev/null +++ b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/McpOauthProbeResultFailed.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 com.github.copilot.generated.McpOauthHttpResponse; +import javax.annotation.processing.Generated; + +/** + * Variant {@code failed} of {@link McpOauthProbeResult}. + * + * @since 1.0.0 + */ +@JsonIgnoreProperties(ignoreUnknown = true) +@JsonInclude(JsonInclude.Include.NON_NULL) +@javax.annotation.processing.Generated("copilot-sdk-codegen") +public final class McpOauthProbeResultFailed extends McpOauthProbeResult { + + @JsonProperty("status") + private final String status = "failed"; + + @Override + public String getStatus() { return status; } + + /** Human-readable probe failure detail. */ + @JsonProperty("error") + private String error; + + /** HTTP response returned by the server, when the probe reached the server and captured the complete response. */ + @JsonProperty("httpResponse") + private McpOauthHttpResponse httpResponse; + + public String getError() { return error; } + public void setError(String error) { this.error = error; } + + public McpOauthHttpResponse getHttpResponse() { return httpResponse; } + public void setHttpResponse(McpOauthHttpResponse httpResponse) { this.httpResponse = httpResponse; } +} diff --git a/java/sdk/src/generated/java/com/github/copilot/generated/rpc/McpOauthProbeResultNeedsAuth.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/McpOauthProbeResultNeedsAuth.java new file mode 100644 index 0000000000..4cc54dfbe2 --- /dev/null +++ b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/McpOauthProbeResultNeedsAuth.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 com.fasterxml.jackson.annotation.JsonIgnoreProperties; +import com.fasterxml.jackson.annotation.JsonInclude; +import com.fasterxml.jackson.annotation.JsonProperty; +import com.github.copilot.generated.McpOauthHttpResponse; +import com.github.copilot.generated.McpOauthWWWAuthenticateParams; +import javax.annotation.processing.Generated; + +/** + * Variant {@code needs-auth} of {@link McpOauthProbeResult}. + * + * @since 1.0.0 + */ +@JsonIgnoreProperties(ignoreUnknown = true) +@JsonInclude(JsonInclude.Include.NON_NULL) +@javax.annotation.processing.Generated("copilot-sdk-codegen") +public final class McpOauthProbeResultNeedsAuth extends McpOauthProbeResult { + + @JsonProperty("status") + private final String status = "needs-auth"; + + @Override + public String getStatus() { return status; } + + /** HTTP 401 or 403 response returned by the server. */ + @JsonProperty("httpResponse") + private McpOauthHttpResponse httpResponse; + + /** Why authentication is needed. */ + @JsonProperty("reason") + private McpOauthProbeNeedsAuthReason reason; + + /** Parsed WWW-Authenticate challenge parameters, when present and parseable. */ + @JsonProperty("wwwAuthenticateParams") + private McpOauthWWWAuthenticateParams wwwAuthenticateParams; + + public McpOauthHttpResponse getHttpResponse() { return httpResponse; } + public void setHttpResponse(McpOauthHttpResponse httpResponse) { this.httpResponse = httpResponse; } + + public McpOauthProbeNeedsAuthReason getReason() { return reason; } + public void setReason(McpOauthProbeNeedsAuthReason reason) { this.reason = reason; } + + public McpOauthWWWAuthenticateParams getWwwAuthenticateParams() { return wwwAuthenticateParams; } + public void setWwwAuthenticateParams(McpOauthWWWAuthenticateParams wwwAuthenticateParams) { this.wwwAuthenticateParams = wwwAuthenticateParams; } +} diff --git a/java/sdk/src/generated/java/com/github/copilot/generated/rpc/McpOauthProbeResultNoAuthRequired.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/McpOauthProbeResultNoAuthRequired.java new file mode 100644 index 0000000000..71ddbfc2ac --- /dev/null +++ b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/McpOauthProbeResultNoAuthRequired.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.generated.McpOauthHttpResponse; +import javax.annotation.processing.Generated; + +/** + * Variant {@code no-auth-required} of {@link McpOauthProbeResult}. + * + * @since 1.0.0 + */ +@JsonIgnoreProperties(ignoreUnknown = true) +@JsonInclude(JsonInclude.Include.NON_NULL) +@javax.annotation.processing.Generated("copilot-sdk-codegen") +public final class McpOauthProbeResultNoAuthRequired extends McpOauthProbeResult { + + @JsonProperty("status") + private final String status = "no-auth-required"; + + @Override + public String getStatus() { return status; } + + /** HTTP response returned by the server. */ + @JsonProperty("httpResponse") + private McpOauthHttpResponse httpResponse; + + public McpOauthHttpResponse getHttpResponse() { return httpResponse; } + public void setHttpResponse(McpOauthHttpResponse httpResponse) { this.httpResponse = httpResponse; } +} diff --git a/java/sdk/src/generated/java/com/github/copilot/generated/rpc/McpPlanConfigurationChange.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/McpPlanConfigurationChange.java new file mode 100644 index 0000000000..d419772111 --- /dev/null +++ b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/McpPlanConfigurationChange.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.List; +import javax.annotation.processing.Generated; + +/** + * One change applying the plan would make, described rather than serialised so the configuration payload stays behind the runtime boundary. + * + * @since 1.0.0 + */ +@javax.annotation.processing.Generated("copilot-sdk-codegen") +@JsonInclude(JsonInclude.Include.NON_NULL) +@JsonIgnoreProperties(ignoreUnknown = true) +public record McpPlanConfigurationChange( + /** Whether the change would create a new entry or modify an existing one. */ + @JsonProperty("operation") McpPlanConfigurationOperation operation, + /** Scope the change would be written to. */ + @JsonProperty("scope") McpPlanScope scope, + /** Configuration key the change applies to. */ + @JsonProperty("configKey") String configKey, + /** Names of the configuration fields the change would set, without their values. */ + @JsonProperty("changedFields") List changedFields, + /** Secret placeholders the written configuration would reference. The constrained placeholder type cannot carry a literal secret value. */ + @JsonProperty("secretReferences") List secretReferences +) { +} diff --git a/java/sdk/src/generated/java/com/github/copilot/generated/rpc/McpPlanConfigurationOperation.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/McpPlanConfigurationOperation.java new file mode 100644 index 0000000000..a661db48ab --- /dev/null +++ b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/McpPlanConfigurationOperation.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 a planned configuration change would create or modify an entry + * + * @since 1.0.0 + */ +@javax.annotation.processing.Generated("copilot-sdk-codegen") +public enum McpPlanConfigurationOperation { + /** The {@code add} variant. */ + ADD("add"), + /** The {@code update} variant. */ + UPDATE("update"); + + private final String value; + McpPlanConfigurationOperation(String value) { this.value = value; } + @com.fasterxml.jackson.annotation.JsonValue + public String getValue() { return value; } + @com.fasterxml.jackson.annotation.JsonCreator + public static McpPlanConfigurationOperation fromValue(String value) { + for (McpPlanConfigurationOperation v : values()) { + if (v.value.equals(value)) return v; + } + throw new IllegalArgumentException("Unknown McpPlanConfigurationOperation value: " + value); + } +} diff --git a/java/sdk/src/generated/java/com/github/copilot/generated/rpc/McpPlanInstallParams.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/McpPlanInstallParams.java new file mode 100644 index 0000000000..7b182fe2d6 --- /dev/null +++ b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/McpPlanInstallParams.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; + +/** + * A side-effect-free request for an MCP install plan. Computing a plan never writes configuration, stores a secret, or reloads MCP servers. + * + * @apiNote This method is experimental and may change in a future version. + * @since 1.0.0 + */ +@CopilotExperimental +@javax.annotation.processing.Generated("copilot-sdk-codegen") +@JsonInclude(JsonInclude.Include.NON_NULL) +@JsonIgnoreProperties(ignoreUnknown = true) +public record McpPlanInstallParams( + /** Protocol version and capabilities the caller requires. */ + @JsonProperty("contract") CatalogClientContract contract, + /** What to plan: either a candidate handle from a previous search, or a card supplied directly. */ + @JsonProperty("source") Object source, + /** Configuration scope the plan targets. Defaults to user scope when omitted. */ + @JsonProperty("scope") McpPlanScope scope +) { +} diff --git a/java/sdk/src/generated/java/com/github/copilot/generated/rpc/McpPlanInstallPlanned.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/McpPlanInstallPlanned.java new file mode 100644 index 0000000000..571353a384 --- /dev/null +++ b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/McpPlanInstallPlanned.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; + +/** + * A computed MCP install plan. Nothing has been applied: the plan describes what installing would change, and the plan handle is what a later apply operation would consume. + * + * @since 1.0.0 + */ +@JsonIgnoreProperties(ignoreUnknown = true) +@JsonInclude(JsonInclude.Include.NON_NULL) +@javax.annotation.processing.Generated("copilot-sdk-codegen") +public final class McpPlanInstallPlanned extends McpPlanInstallResult { + + @JsonProperty("kind") + private final String kind = "planned"; + + @Override + public String getKind() { return kind; } + + /** The normalised plan. */ + @JsonProperty("plan") + private McpInstallPlan plan; + + /** Protocol version and capabilities the runtime honoured. */ + @JsonProperty("negotiated") + private CatalogNegotiatedContract negotiated; + + public McpInstallPlan getPlan() { return plan; } + public void setPlan(McpInstallPlan plan) { this.plan = plan; } + + public CatalogNegotiatedContract getNegotiated() { return negotiated; } + public void setNegotiated(CatalogNegotiatedContract negotiated) { this.negotiated = negotiated; } +} diff --git a/java/sdk/src/generated/java/com/github/copilot/generated/rpc/McpPlanInstallResult.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/McpPlanInstallResult.java new file mode 100644 index 0000000000..d257703477 --- /dev/null +++ b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/McpPlanInstallResult.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.JsonSubTypes; +import com.fasterxml.jackson.annotation.JsonTypeInfo; +import javax.annotation.processing.Generated; + +/** + * Outcome of an mcp.planInstall call: either a normalised plan, or one typed refusal. Nothing is written in either case. + * + * @since 1.0.0 + */ +@JsonTypeInfo(use = JsonTypeInfo.Id.NAME, property = "kind", visible = true) +@JsonSubTypes({ + @JsonSubTypes.Type(value = McpPlanInstallPlanned.class, name = "planned"), + @JsonSubTypes.Type(value = CatalogNegotiationRefusedError.class, name = "negotiation-refused"), + @JsonSubTypes.Type(value = CatalogHandleRejectedError.class, name = "handle-rejected"), + @JsonSubTypes.Type(value = CatalogInvalidRequestError.class, name = "invalid-request"), + @JsonSubTypes.Type(value = CatalogAuthenticationRequiredError.class, name = "authentication-required"), + @JsonSubTypes.Type(value = CatalogPolicyRejectedError.class, name = "policy-rejected"), + @JsonSubTypes.Type(value = CatalogNetworkFailureError.class, name = "network-failure"), + @JsonSubTypes.Type(value = CatalogUnsafeRetrievalError.class, name = "unsafe-retrieval"), + @JsonSubTypes.Type(value = CatalogMalformedCardError.class, name = "malformed-card"), + @JsonSubTypes.Type(value = CatalogContractViolationError.class, name = "contract-violation"), + @JsonSubTypes.Type(value = CatalogUnavailableTransportError.class, name = "unavailable-transport"), + @JsonSubTypes.Type(value = CatalogNotInstallableError.class, name = "not-installable"), + @JsonSubTypes.Type(value = CatalogUnavailableError.class, name = "unavailable") +}) +@JsonIgnoreProperties(ignoreUnknown = true) +@javax.annotation.processing.Generated("copilot-sdk-codegen") +public abstract class McpPlanInstallResult { + + /** + * 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/McpPlanPolicyDecision.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/McpPlanPolicyDecision.java new file mode 100644 index 0000000000..be32c283a0 --- /dev/null +++ b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/McpPlanPolicyDecision.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; + +/** + * What policy decided for a planned server + * + * @since 1.0.0 + */ +@javax.annotation.processing.Generated("copilot-sdk-codegen") +public enum McpPlanPolicyDecision { + /** The {@code allowed} variant. */ + ALLOWED("allowed"), + /** The {@code blocked} variant. */ + BLOCKED("blocked"), + /** The {@code requires-approval} variant. */ + REQUIRES_APPROVAL("requires-approval"); + + private final String value; + McpPlanPolicyDecision(String value) { this.value = value; } + @com.fasterxml.jackson.annotation.JsonValue + public String getValue() { return value; } + @com.fasterxml.jackson.annotation.JsonCreator + public static McpPlanPolicyDecision fromValue(String value) { + for (McpPlanPolicyDecision v : values()) { + if (v.value.equals(value)) return v; + } + throw new IllegalArgumentException("Unknown McpPlanPolicyDecision value: " + value); + } +} diff --git a/java/sdk/src/generated/java/com/github/copilot/generated/rpc/McpPlanPolicyResult.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/McpPlanPolicyResult.java new file mode 100644 index 0000000000..ee8d2ff0c1 --- /dev/null +++ b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/McpPlanPolicyResult.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; + +/** + * Outcome of evaluating the planned server against registry and enterprise policy. Evaluation is read-only. + * + * @since 1.0.0 + */ +@javax.annotation.processing.Generated("copilot-sdk-codegen") +@JsonInclude(JsonInclude.Include.NON_NULL) +@JsonIgnoreProperties(ignoreUnknown = true) +public record McpPlanPolicyResult( + /** What policy decided for this server. */ + @JsonProperty("decision") McpPlanPolicyDecision decision, + /** Which authority produced the decision. */ + @JsonProperty("source") McpPlanPolicySource source, + /** Human-readable explanation, safe to surface. Never contains a query, URL, handle, or secret. */ + @JsonProperty("reason") String reason +) { +} diff --git a/java/sdk/src/generated/java/com/github/copilot/generated/rpc/McpPlanPolicySource.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/McpPlanPolicySource.java new file mode 100644 index 0000000000..f6c0498f3b --- /dev/null +++ b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/McpPlanPolicySource.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 authority produced a policy decision + * + * @since 1.0.0 + */ +@javax.annotation.processing.Generated("copilot-sdk-codegen") +public enum McpPlanPolicySource { + /** The {@code none} variant. */ + NONE("none"), + /** The {@code enterprise-allowlist} variant. */ + ENTERPRISE_ALLOWLIST("enterprise-allowlist"), + /** The {@code registry-policy} variant. */ + REGISTRY_POLICY("registry-policy"), + /** The {@code local-trust} variant. */ + LOCAL_TRUST("local-trust"); + + private final String value; + McpPlanPolicySource(String value) { this.value = value; } + @com.fasterxml.jackson.annotation.JsonValue + public String getValue() { return value; } + @com.fasterxml.jackson.annotation.JsonCreator + public static McpPlanPolicySource fromValue(String value) { + for (McpPlanPolicySource v : values()) { + if (v.value.equals(value)) return v; + } + throw new IllegalArgumentException("Unknown McpPlanPolicySource value: " + value); + } +} diff --git a/java/sdk/src/generated/java/com/github/copilot/generated/rpc/McpPlanProvenance.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/McpPlanProvenance.java new file mode 100644 index 0000000000..5b7d6531d3 --- /dev/null +++ b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/McpPlanProvenance.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; + +/** + * Provenance of the exact validated JSON MCP card content bound privately to a completed plan and its opaque handle. + * + * @since 1.0.0 + */ +@javax.annotation.processing.Generated("copilot-sdk-codegen") +@JsonInclude(JsonInclude.Include.NON_NULL) +@JsonIgnoreProperties(ignoreUnknown = true) +public record McpPlanProvenance( + /** Authority associated with the validated card, without path, query, or credentials. Inert untrusted data. */ + @JsonProperty("authority") String authority, + /** ISO 8601 timestamp at which the runtime completed strict parsing and schema validation of the card content. */ + @JsonProperty("validatedAt") String validatedAt, + /** Semantic digest of the exact validated JSON content bound to the plan handle. */ + @JsonProperty("cardDigest") CardDigest cardDigest, + /** JSON MCP media type the validated card was interpreted as. */ + @JsonProperty("mediaType") McpServerCardMediaType mediaType +) { +} diff --git a/java/sdk/src/generated/java/com/github/copilot/generated/rpc/McpPlanResourceIdentity.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/McpPlanResourceIdentity.java new file mode 100644 index 0000000000..abe525c1dc --- /dev/null +++ b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/McpPlanResourceIdentity.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; + +/** + * Normalised identity of the MCP server a plan targets, independent of how the card spelled it. + * + * @since 1.0.0 + */ +@javax.annotation.processing.Generated("copilot-sdk-codegen") +@JsonInclude(JsonInclude.Include.NON_NULL) +@JsonIgnoreProperties(ignoreUnknown = true) +public record McpPlanResourceIdentity( + /** Canonical, normalised name of the server, for example `io.github.owner/server`. */ + @JsonProperty("canonicalName") String canonicalName, + /** Local configuration key the server would be recorded under. */ + @JsonProperty("serverName") String serverName, + /** Version advertised by the card, when it declares one. */ + @JsonProperty("version") String version, + /** Registry identifier of the server, when it came from a registry. */ + @JsonProperty("registryId") String registryId +) { +} diff --git a/java/sdk/src/generated/java/com/github/copilot/generated/rpc/McpPlanScope.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/McpPlanScope.java new file mode 100644 index 0000000000..41f5d72016 --- /dev/null +++ b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/McpPlanScope.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 javax.annotation.processing.Generated; + +/** + * Configuration scope an MCP install plan targets + * + * @since 1.0.0 + */ +@javax.annotation.processing.Generated("copilot-sdk-codegen") +public enum McpPlanScope { + /** The {@code user} variant. */ + USER("user"); + + private final String value; + McpPlanScope(String value) { this.value = value; } + @com.fasterxml.jackson.annotation.JsonValue + public String getValue() { return value; } + @com.fasterxml.jackson.annotation.JsonCreator + public static McpPlanScope fromValue(String value) { + for (McpPlanScope v : values()) { + if (v.value.equals(value)) return v; + } + throw new IllegalArgumentException("Unknown McpPlanScope value: " + value); + } +} diff --git a/java/sdk/src/generated/java/com/github/copilot/generated/rpc/McpPlanTarget.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/McpPlanTarget.java new file mode 100644 index 0000000000..95362a4cca --- /dev/null +++ b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/McpPlanTarget.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; + +/** + * Where a plan would be written. + * + * @since 1.0.0 + */ +@javax.annotation.processing.Generated("copilot-sdk-codegen") +@JsonInclude(JsonInclude.Include.NON_NULL) +@JsonIgnoreProperties(ignoreUnknown = true) +public record McpPlanTarget( + /** Configuration scope the plan targets. */ + @JsonProperty("scope") McpPlanScope scope, + /** Configuration key the server would be recorded under within that scope. */ + @JsonProperty("configKey") String configKey +) { +} diff --git a/java/src/generated/java/com/github/copilot/generated/rpc/McpResource.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/McpResource.java similarity index 100% rename from java/src/generated/java/com/github/copilot/generated/rpc/McpResource.java rename to java/sdk/src/generated/java/com/github/copilot/generated/rpc/McpResource.java diff --git a/java/src/generated/java/com/github/copilot/generated/rpc/McpResourceAnnotations.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/McpResourceAnnotations.java similarity index 100% rename from java/src/generated/java/com/github/copilot/generated/rpc/McpResourceAnnotations.java rename to java/sdk/src/generated/java/com/github/copilot/generated/rpc/McpResourceAnnotations.java diff --git a/java/src/generated/java/com/github/copilot/generated/rpc/McpResourceContent.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/McpResourceContent.java similarity index 100% rename from java/src/generated/java/com/github/copilot/generated/rpc/McpResourceContent.java rename to java/sdk/src/generated/java/com/github/copilot/generated/rpc/McpResourceContent.java diff --git a/java/src/generated/java/com/github/copilot/generated/rpc/McpResourceIcon.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/McpResourceIcon.java similarity index 100% rename from java/src/generated/java/com/github/copilot/generated/rpc/McpResourceIcon.java rename to java/sdk/src/generated/java/com/github/copilot/generated/rpc/McpResourceIcon.java diff --git a/java/src/generated/java/com/github/copilot/generated/rpc/McpResourceTemplate.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/McpResourceTemplate.java similarity index 100% rename from java/src/generated/java/com/github/copilot/generated/rpc/McpResourceTemplate.java rename to java/sdk/src/generated/java/com/github/copilot/generated/rpc/McpResourceTemplate.java 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/src/generated/java/com/github/copilot/generated/rpc/McpServer.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/McpServer.java similarity index 97% rename from java/src/generated/java/com/github/copilot/generated/rpc/McpServer.java rename to java/sdk/src/generated/java/com/github/copilot/generated/rpc/McpServer.java index 382c54c40f..14a9118d0b 100644 --- a/java/src/generated/java/com/github/copilot/generated/rpc/McpServer.java +++ b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/McpServer.java @@ -23,7 +23,7 @@ public record McpServer( /** 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/rpc/McpServerCardMediaType.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/McpServerCardMediaType.java new file mode 100644 index 0000000000..4258f7d4d4 --- /dev/null +++ b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/McpServerCardMediaType.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; + +/** + * JSON MCP card media type accepted for install planning + * + * @since 1.0.0 + */ +@javax.annotation.processing.Generated("copilot-sdk-codegen") +public enum McpServerCardMediaType { + /** The {@code application/mcp-server-card+json} variant. */ + APPLICATION_MCP_SERVER_CARD_JSON("application/mcp-server-card+json"), + /** The {@code application/mcp-server+json} variant. */ + APPLICATION_MCP_SERVER_JSON("application/mcp-server+json"); + + private final String value; + McpServerCardMediaType(String value) { this.value = value; } + @com.fasterxml.jackson.annotation.JsonValue + public String getValue() { return value; } + @com.fasterxml.jackson.annotation.JsonCreator + public static McpServerCardMediaType fromValue(String value) { + for (McpServerCardMediaType v : values()) { + if (v.value.equals(value)) return v; + } + throw new IllegalArgumentException("Unknown McpServerCardMediaType value: " + value); + } +} diff --git a/java/src/generated/java/com/github/copilot/generated/rpc/McpServerFailureInfo.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/McpServerFailureInfo.java similarity index 100% rename from java/src/generated/java/com/github/copilot/generated/rpc/McpServerFailureInfo.java rename to java/sdk/src/generated/java/com/github/copilot/generated/rpc/McpServerFailureInfo.java diff --git a/java/src/generated/java/com/github/copilot/generated/rpc/McpServerNeedsAuthInfo.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/McpServerNeedsAuthInfo.java similarity index 100% rename from java/src/generated/java/com/github/copilot/generated/rpc/McpServerNeedsAuthInfo.java rename to java/sdk/src/generated/java/com/github/copilot/generated/rpc/McpServerNeedsAuthInfo.java 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/src/generated/java/com/github/copilot/generated/rpc/McpServerStatus.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/McpServerStatus.java similarity index 93% rename from java/src/generated/java/com/github/copilot/generated/rpc/McpServerStatus.java rename to java/sdk/src/generated/java/com/github/copilot/generated/rpc/McpServerStatus.java index db463a7377..4c1fb46b28 100644 --- a/java/src/generated/java/com/github/copilot/generated/rpc/McpServerStatus.java +++ b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/McpServerStatus.java @@ -10,7 +10,7 @@ import javax.annotation.processing.Generated; /** - * Connection status: connected, failed, needs-auth, pending, disabled, or not_configured + * Connection status: connected, failed, needs-auth, pending, disabled, stopped, or not_configured * * @since 1.0.0 */ @@ -26,6 +26,8 @@ public enum McpServerStatus { PENDING("pending"), /** The {@code disabled} variant. */ DISABLED("disabled"), + /** The {@code stopped} variant. */ + STOPPED("stopped"), /** The {@code not_configured} variant. */ NOT_CONFIGURED("not_configured"); 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/McpTaskMetadata.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/McpTaskMetadata.java new file mode 100644 index 0000000000..1b7fccb29f --- /dev/null +++ b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/McpTaskMetadata.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; + +/** + * Metadata controlling an MCP task's lifetime. + * + * @since 1.0.0 + */ +@javax.annotation.processing.Generated("copilot-sdk-codegen") +@JsonInclude(JsonInclude.Include.NON_NULL) +@JsonIgnoreProperties(ignoreUnknown = true) +public record McpTaskMetadata( + /** Task time-to-live. */ + @JsonProperty("ttl") Long ttl +) { +} diff --git a/java/src/generated/java/com/github/copilot/generated/rpc/McpToolUi.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/McpToolUi.java similarity index 100% rename from java/src/generated/java/com/github/copilot/generated/rpc/McpToolUi.java rename to java/sdk/src/generated/java/com/github/copilot/generated/rpc/McpToolUi.java diff --git a/java/src/generated/java/com/github/copilot/generated/rpc/McpToolUiVisibility.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/McpToolUiVisibility.java similarity index 100% rename from java/src/generated/java/com/github/copilot/generated/rpc/McpToolUiVisibility.java rename to java/sdk/src/generated/java/com/github/copilot/generated/rpc/McpToolUiVisibility.java diff --git a/java/src/generated/java/com/github/copilot/generated/rpc/McpTools.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/McpTools.java similarity index 100% rename from java/src/generated/java/com/github/copilot/generated/rpc/McpTools.java rename to java/sdk/src/generated/java/com/github/copilot/generated/rpc/McpTools.java 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 0000000000..63d327a415 --- /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 60% 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 c55fc026f6..a652e8f4f6 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 @@ -36,9 +36,17 @@ public record Model( @JsonProperty("supportedReasoningEfforts") List supportedReasoningEfforts, /** Default reasoning effort level (only present if model supports reasoning effort) */ @JsonProperty("defaultReasoningEffort") String defaultReasoningEffort, + /** Context-window tiers this model offers, when the provider advertises them independently of tiered token pricing. Copilot models carry their tiers in `billing.tokenPrices`; a provider that has no pricing to publish (an agent host reached over AHP, for example) declares them here instead, so the model picker can still offer the tier toggle. */ + @JsonProperty("supportedContextTiers") List supportedContextTiers, /** Model capability category for grouping in the model picker */ @JsonProperty("modelPickerCategory") ModelPickerCategory modelPickerCategory, /** Relative cost tier for token-based billing users */ - @JsonProperty("modelPickerPriceCategory") ModelPickerPriceCategory modelPickerPriceCategory + @JsonProperty("modelPickerPriceCategory") ModelPickerPriceCategory modelPickerPriceCategory, + /** Warning text the service requires hosts to surface for this model. Present only when the service published at least one warning. */ + @JsonProperty("warningText") ModelWarningText warningText, + /** Informational notices the service published for this model, such as an upcoming change or a recommended alternative. Present only when the service published at least one notice. Hosts should surface these without implying anything is wrong with the model. */ + @JsonProperty("infoMessages") List infoMessages, + /** Warnings the service published for this model, such as a deprecated client version. Present only when the service published at least one warning. The model remains usable; hosts should surface these as advisory rather than blocking. */ + @JsonProperty("warningMessages") List warningMessages ) { } diff --git a/java/src/generated/java/com/github/copilot/generated/rpc/ModelBilling.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/ModelBilling.java similarity index 93% rename from java/src/generated/java/com/github/copilot/generated/rpc/ModelBilling.java rename to java/sdk/src/generated/java/com/github/copilot/generated/rpc/ModelBilling.java index f8298dd624..f72f4b5cf5 100644 --- a/java/src/generated/java/com/github/copilot/generated/rpc/ModelBilling.java +++ b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/ModelBilling.java @@ -27,7 +27,7 @@ public record ModelBilling( @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 time-boxed discount. */ + /** 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/src/generated/java/com/github/copilot/generated/rpc/ModelBillingPromo.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/ModelBillingPromo.java similarity index 81% rename from java/src/generated/java/com/github/copilot/generated/rpc/ModelBillingPromo.java rename to java/sdk/src/generated/java/com/github/copilot/generated/rpc/ModelBillingPromo.java index 731e298355..087ca1c15a 100644 --- a/java/src/generated/java/com/github/copilot/generated/rpc/ModelBillingPromo.java +++ b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/ModelBillingPromo.java @@ -13,7 +13,7 @@ import javax.annotation.processing.Generated; /** - * Active server-driven promotion for a model, including its discount and expiry. + * Active server-driven promotion for a model, including its discount and optional expiry. * * @since 1.0.0 */ @@ -25,9 +25,9 @@ public record ModelBillingPromo( @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. Always present: the API only surfaces a promo whose expiry parses and is in the future. Consumers should treat a past value as expired. */ + /** 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. */ + /** 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/src/generated/java/com/github/copilot/generated/rpc/ModelBillingTokenPrices.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/ModelBillingTokenPrices.java similarity index 93% rename from java/src/generated/java/com/github/copilot/generated/rpc/ModelBillingTokenPrices.java rename to java/sdk/src/generated/java/com/github/copilot/generated/rpc/ModelBillingTokenPrices.java index 56e06fe22f..e6eae8c0e5 100644 --- a/java/src/generated/java/com/github/copilot/generated/rpc/ModelBillingTokenPrices.java +++ b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/ModelBillingTokenPrices.java @@ -31,6 +31,8 @@ public record ModelBillingTokenPrices( @JsonProperty("cacheReadPrice") Double cacheReadPrice, /** AI Credits cost per billing batch of cache-write (cache creation) tokens. */ @JsonProperty("cacheWritePrice") Double cacheWritePrice, + /** AI Credits cost per billing batch of 1-hour cache-write (cache creation) tokens. */ + @JsonProperty("cacheWrite1hPrice") Double cacheWrite1hPrice, /** 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. */ diff --git a/java/src/generated/java/com/github/copilot/generated/rpc/ModelBillingTokenPricesLongContext.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/ModelBillingTokenPricesLongContext.java similarity index 92% rename from java/src/generated/java/com/github/copilot/generated/rpc/ModelBillingTokenPricesLongContext.java rename to java/sdk/src/generated/java/com/github/copilot/generated/rpc/ModelBillingTokenPricesLongContext.java index bb67515793..7d108d3708 100644 --- a/java/src/generated/java/com/github/copilot/generated/rpc/ModelBillingTokenPricesLongContext.java +++ b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/ModelBillingTokenPricesLongContext.java @@ -31,6 +31,8 @@ public record ModelBillingTokenPricesLongContext( @JsonProperty("cacheReadPrice") Double cacheReadPrice, /** AI Credits cost per billing batch of cache-write (cache creation) tokens. */ @JsonProperty("cacheWritePrice") Double cacheWritePrice, + /** AI Credits cost per billing batch of 1-hour cache-write (cache creation) tokens. */ + @JsonProperty("cacheWrite1hPrice") Double cacheWrite1hPrice, /** 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. */ 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 100% 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 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 100% 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 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 100% 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 diff --git a/java/sdk/src/generated/java/com/github/copilot/generated/rpc/ModelChangeSource.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/ModelChangeSource.java new file mode 100644 index 0000000000..6e5d4ea8da --- /dev/null +++ b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/ModelChangeSource.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; + +/** + * Origin of an effective session model change. + * + * @since 1.0.0 + */ +@javax.annotation.processing.Generated("copilot-sdk-codegen") +public enum ModelChangeSource { + /** The {@code model_command} variant. */ + MODEL_COMMAND("model_command"), + /** The {@code settings_command} variant. */ + SETTINGS_COMMAND("settings_command"), + /** The {@code config_command} variant. */ + CONFIG_COMMAND("config_command"), + /** The {@code model_picker} variant. */ + MODEL_PICKER("model_picker"), + /** The {@code managed_settings} variant. */ + MANAGED_SETTINGS("managed_settings"), + /** The {@code repo_settings} variant. */ + REPO_SETTINGS("repo_settings"), + /** The {@code startup} variant. */ + STARTUP("startup"), + /** The {@code agent} variant. */ + AGENT("agent"), + /** The {@code plan_mode} variant. */ + PLAN_MODE("plan_mode"), + /** The {@code automatic} variant. */ + AUTOMATIC("automatic"), + /** The {@code sdk} variant. */ + SDK("sdk"); + + private final String value; + ModelChangeSource(String value) { this.value = value; } + @com.fasterxml.jackson.annotation.JsonValue + public String getValue() { return value; } + @com.fasterxml.jackson.annotation.JsonCreator + public static ModelChangeSource fromValue(String value) { + for (ModelChangeSource v : values()) { + if (v.value.equals(value)) return v; + } + throw new IllegalArgumentException("Unknown ModelChangeSource value: " + value); + } +} diff --git a/java/sdk/src/generated/java/com/github/copilot/generated/rpc/ModelMessage.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/ModelMessage.java new file mode 100644 index 0000000000..35e8a17386 --- /dev/null +++ b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/ModelMessage.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 service-published message about a model, carrying a stable machine-readable code alongside human-readable text. + * + * @since 1.0.0 + */ +@javax.annotation.processing.Generated("copilot-sdk-codegen") +@JsonInclude(JsonInclude.Include.NON_NULL) +@JsonIgnoreProperties(ignoreUnknown = true) +public record ModelMessage( + /** Stable machine-readable identifier for the message, such as `client_version_deprecated`. Hosts can key custom presentation off this; unrecognized codes should fall back to displaying `message`. */ + @JsonProperty("code") String code, + /** Human-readable message text intended for display to the user. */ + @JsonProperty("message") String message +) { +} 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/sdk/src/generated/java/com/github/copilot/generated/rpc/ModelPickerPersistenceRequest.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/ModelPickerPersistenceRequest.java new file mode 100644 index 0000000000..48612cdfa5 --- /dev/null +++ b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/ModelPickerPersistenceRequest.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; + +@javax.annotation.processing.Generated("copilot-sdk-codegen") +@JsonInclude(JsonInclude.Include.NON_NULL) +@JsonIgnoreProperties(ignoreUnknown = true) +public record ModelPickerPersistenceRequest( + /** Filesystem and environment context used to resolve settings persistence. */ + @JsonProperty("settingsContext") ModelPickerSettingsContext settingsContext, + /** Whether reasoning effort was explicitly selected and should be persisted. */ + @JsonProperty("reasoningEffortExplicit") Boolean reasoningEffortExplicit, + /** Whether context tier was explicitly selected and should be persisted. */ + @JsonProperty("contextTierExplicit") Boolean contextTierExplicit +) { +} 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/sdk/src/generated/java/com/github/copilot/generated/rpc/ModelPickerSettingsContext.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/ModelPickerSettingsContext.java new file mode 100644 index 0000000000..04eec742eb --- /dev/null +++ b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/ModelPickerSettingsContext.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; + +/** + * Filesystem and environment context used to resolve model-picker settings. + * + * @since 1.0.0 + */ +@javax.annotation.processing.Generated("copilot-sdk-codegen") +@JsonInclude(JsonInclude.Include.NON_NULL) +@JsonIgnoreProperties(ignoreUnknown = true) +public record ModelPickerSettingsContext( + /** Optional Copilot configuration directory containing persisted settings. */ + @JsonProperty("configDir") String configDir, + /** User home directory used when resolving persisted settings. */ + @JsonProperty("homeDirectory") String homeDirectory, + /** Environment variables consulted while resolving model-picker settings. */ + @JsonProperty("environment") Map environment +) { +} 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/ModelSwitchConfirmation.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/ModelSwitchConfirmation.java new file mode 100644 index 0000000000..4a75be2b10 --- /dev/null +++ b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/ModelSwitchConfirmation.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; + +@javax.annotation.processing.Generated("copilot-sdk-codegen") +@JsonInclude(JsonInclude.Include.NON_NULL) +@JsonIgnoreProperties(ignoreUnknown = true) +public record ModelSwitchConfirmation( + /** Display name of the model that requires compaction confirmation. */ + @JsonProperty("targetModelDisplayName") String targetModelDisplayName, + /** Current conversation token count before switching models. */ + @JsonProperty("currentTokens") Double currentTokens, + /** Target model token limit used by the compaction preflight. */ + @JsonProperty("targetLimit") Double targetLimit +) { +} diff --git a/java/sdk/src/generated/java/com/github/copilot/generated/rpc/ModelWarningText.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/ModelWarningText.java new file mode 100644 index 0000000000..817be420c5 --- /dev/null +++ b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/ModelWarningText.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; + +/** + * Service-published warning text that hosts should display when presenting a model. + * + * @since 1.0.0 + */ +@javax.annotation.processing.Generated("copilot-sdk-codegen") +@JsonInclude(JsonInclude.Include.NON_NULL) +@JsonIgnoreProperties(ignoreUnknown = true) +public record ModelWarningText( + /** Data-retention warning for the model. The text may contain Markdown links and should be rendered as Markdown when supported. */ + @JsonProperty("dataRetention") String dataRetention +) { +} 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 0000000000..9797a2d67f --- /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 0000000000..d5bcad93ac --- /dev/null +++ b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/ModelsListParams.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 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( + /** Opaque account identifier returned by `account.getAllUsers`. When omitted, the current account is used. */ + @JsonProperty("selectionId") String selectionId, + /** GitHub token accepted for compatibility with existing SDK clients. When provided, resolves this token instead of using the current account. */ + @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 100% 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 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 0000000000..dc57bca4f3 --- /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; + +/** + * External SDK input for a named custom model provider. Ingested by the native protocol boundary before host dispatch. + * + * @since 1.0.0 + */ +@javax.annotation.processing.Generated("copilot-sdk-codegen") +@JsonInclude(JsonInclude.Include.NON_NULL) +@JsonIgnoreProperties(ignoreUnknown = true) +public record NamedProviderConfig( + /** Unique provider name used to qualify model selection IDs. */ + @JsonProperty("name") String name, + /** Provider protocol family. */ + @JsonProperty("type") ProviderConfigType type, + /** Wire API used to communicate with the provider. */ + @JsonProperty("wireApi") ProviderConfigWireApi wireApi, + /** Transport used to communicate with the provider. */ + @JsonProperty("transport") ProviderConfigTransport transport, + /** Base URL for provider API requests. */ + @JsonProperty("baseUrl") String baseUrl, + /** Static API key used to authenticate provider requests. */ + @JsonProperty("apiKey") String apiKey, + /** Static bearer token used to authenticate provider requests. */ + @JsonProperty("bearerToken") String bearerToken, + /** Azure authentication configuration for the provider. */ + @JsonProperty("azure") ProviderConfigAzure azure, + /** Additional HTTP headers included with provider requests. */ + @JsonProperty("headers") Map headers, + /** Whether the host supplies bearer tokens dynamically. */ + @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 100% 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 diff --git a/java/src/generated/java/com/github/copilot/generated/rpc/OptionsUpdateAdditionalContentExclusionPolicy.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/OptionsUpdateAdditionalContentExclusionPolicy.java similarity index 92% rename from java/src/generated/java/com/github/copilot/generated/rpc/OptionsUpdateAdditionalContentExclusionPolicy.java rename to java/sdk/src/generated/java/com/github/copilot/generated/rpc/OptionsUpdateAdditionalContentExclusionPolicy.java index 2864bbd99b..3efd398a0c 100644 --- a/java/src/generated/java/com/github/copilot/generated/rpc/OptionsUpdateAdditionalContentExclusionPolicy.java +++ b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/OptionsUpdateAdditionalContentExclusionPolicy.java @@ -22,7 +22,9 @@ @JsonInclude(JsonInclude.Include.NON_NULL) @JsonIgnoreProperties(ignoreUnknown = true) public record OptionsUpdateAdditionalContentExclusionPolicy( + /** Content-exclusion rules to apply. */ @JsonProperty("rules") List rules, + /** Opaque policy update timestamp supplied by the host. */ @JsonProperty("last_updated_at") Object lastUpdatedAt, /** Allowed values for the `OptionsUpdateAdditionalContentExclusionPolicyScope` enumeration. */ @JsonProperty("scope") OptionsUpdateAdditionalContentExclusionPolicyScope scope diff --git a/java/src/generated/java/com/github/copilot/generated/rpc/OptionsUpdateAdditionalContentExclusionPolicyRule.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/OptionsUpdateAdditionalContentExclusionPolicyRule.java similarity index 89% rename from java/src/generated/java/com/github/copilot/generated/rpc/OptionsUpdateAdditionalContentExclusionPolicyRule.java rename to java/sdk/src/generated/java/com/github/copilot/generated/rpc/OptionsUpdateAdditionalContentExclusionPolicyRule.java index 135a7c7f85..047dc9fa01 100644 --- a/java/src/generated/java/com/github/copilot/generated/rpc/OptionsUpdateAdditionalContentExclusionPolicyRule.java +++ b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/OptionsUpdateAdditionalContentExclusionPolicyRule.java @@ -22,8 +22,11 @@ @JsonInclude(JsonInclude.Include.NON_NULL) @JsonIgnoreProperties(ignoreUnknown = true) public record OptionsUpdateAdditionalContentExclusionPolicyRule( + /** Path patterns covered by this rule. */ @JsonProperty("paths") List paths, + /** Conditions of which at least one must match. */ @JsonProperty("ifAnyMatch") List ifAnyMatch, + /** Conditions none of which may match. */ @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/src/generated/java/com/github/copilot/generated/rpc/OptionsUpdateAdditionalContentExclusionPolicyRuleSource.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/OptionsUpdateAdditionalContentExclusionPolicyRuleSource.java similarity index 93% rename from java/src/generated/java/com/github/copilot/generated/rpc/OptionsUpdateAdditionalContentExclusionPolicyRuleSource.java rename to java/sdk/src/generated/java/com/github/copilot/generated/rpc/OptionsUpdateAdditionalContentExclusionPolicyRuleSource.java index a363722801..43ec75b1a1 100644 --- a/java/src/generated/java/com/github/copilot/generated/rpc/OptionsUpdateAdditionalContentExclusionPolicyRuleSource.java +++ b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/OptionsUpdateAdditionalContentExclusionPolicyRuleSource.java @@ -21,7 +21,9 @@ @JsonInclude(JsonInclude.Include.NON_NULL) @JsonIgnoreProperties(ignoreUnknown = true) public record OptionsUpdateAdditionalContentExclusionPolicyRuleSource( + /** Name of the policy source. */ @JsonProperty("name") String name, + /** Type of the policy source. */ @JsonProperty("type") String type ) { } diff --git a/java/src/generated/java/com/github/copilot/generated/rpc/OptionsUpdateAdditionalContentExclusionPolicyScope.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/OptionsUpdateAdditionalContentExclusionPolicyScope.java similarity index 100% rename from java/src/generated/java/com/github/copilot/generated/rpc/OptionsUpdateAdditionalContentExclusionPolicyScope.java rename to java/sdk/src/generated/java/com/github/copilot/generated/rpc/OptionsUpdateAdditionalContentExclusionPolicyScope.java diff --git a/java/src/generated/java/com/github/copilot/generated/rpc/OptionsUpdateContextTier.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/OptionsUpdateContextTier.java similarity index 100% rename from java/src/generated/java/com/github/copilot/generated/rpc/OptionsUpdateContextTier.java rename to java/sdk/src/generated/java/com/github/copilot/generated/rpc/OptionsUpdateContextTier.java 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/src/generated/java/com/github/copilot/generated/rpc/OptionsUpdateReasoningSummary.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/OptionsUpdateReasoningSummary.java similarity index 100% rename from java/src/generated/java/com/github/copilot/generated/rpc/OptionsUpdateReasoningSummary.java rename to java/sdk/src/generated/java/com/github/copilot/generated/rpc/OptionsUpdateReasoningSummary.java 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 100% 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 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 0000000000..5200f4cd51 --- /dev/null +++ b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/PermissionDecisionContext.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 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, + /** Whether the responding client could ask a user interactively, was running headlessly, or had no response path. Omit when the client cannot determine this authoritatively. */ + @JsonProperty("responseCapability") PermissionResponseCapability responseCapability +) { +} 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 0000000000..d46c460a29 --- /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 0000000000..56f5793c5e --- /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 assisted_approval} variant. */ + ASSISTED_APPROVAL("assisted_approval"), + /** 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 0000000000..c6d2db8c5f --- /dev/null +++ b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/PermissionDecisionSurface.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; + +/** + * 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 acp} variant. */ + ACP("acp"), + /** 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/sdk/src/generated/java/com/github/copilot/generated/rpc/PermissionMode.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/PermissionMode.java new file mode 100644 index 0000000000..1f4ea9b6bc --- /dev/null +++ b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/PermissionMode.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 permission mode. + * + * @since 1.0.0 + */ +@javax.annotation.processing.Generated("copilot-sdk-codegen") +public enum PermissionMode { + /** The {@code manual} variant. */ + MANUAL("manual"), + /** The {@code assisted} variant. */ + ASSISTED("assisted"), + /** The {@code allow-all} variant. */ + ALLOW_ALL("allow-all"); + + private final String value; + PermissionMode(String value) { this.value = value; } + @com.fasterxml.jackson.annotation.JsonValue + public String getValue() { return value; } + @com.fasterxml.jackson.annotation.JsonCreator + public static PermissionMode fromValue(String value) { + for (PermissionMode v : values()) { + if (v.value.equals(value)) return v; + } + throw new IllegalArgumentException("Unknown PermissionMode value: " + value); + } +} diff --git a/java/src/generated/java/com/github/copilot/generated/rpc/PermissionsSetAllowAllSource.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/PermissionModeSource.java similarity index 68% rename from java/src/generated/java/com/github/copilot/generated/rpc/PermissionsSetAllowAllSource.java rename to java/sdk/src/generated/java/com/github/copilot/generated/rpc/PermissionModeSource.java index a7ff9ae9aa..534760c746 100644 --- a/java/src/generated/java/com/github/copilot/generated/rpc/PermissionsSetAllowAllSource.java +++ b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/PermissionModeSource.java @@ -10,30 +10,32 @@ import javax.annotation.processing.Generated; /** - * Optional source for allow-all telemetry. Defaults to `rpc` when omitted for SDK callers. + * Optional source for permission-mode telemetry. Defaults to `rpc` when omitted for SDK callers. * * @since 1.0.0 */ @javax.annotation.processing.Generated("copilot-sdk-codegen") -public enum PermissionsSetAllowAllSource { +public enum PermissionModeSource { /** 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 user_setting} variant. */ + USER_SETTING("user_setting"), /** The {@code rpc} variant. */ RPC("rpc"); private final String value; - PermissionsSetAllowAllSource(String value) { this.value = value; } + PermissionModeSource(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()) { + public static PermissionModeSource fromValue(String value) { + for (PermissionModeSource v : values()) { if (v.value.equals(value)) return v; } - throw new IllegalArgumentException("Unknown PermissionsSetAllowAllSource value: " + value); + throw new IllegalArgumentException("Unknown PermissionModeSource value: " + value); } } 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 80% 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 index 29aef6c66f..56dbd73dd8 100644 --- 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 @@ -24,7 +24,7 @@ public record PermissionPathsConfig( /** If true, the runtime allows access to all paths without prompting. Equivalent to constructing an UnrestrictedPathManager. */ @JsonProperty("unrestricted") Boolean unrestricted, - /** 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). */ + /** Additional directories to allow tool access to (in addition to the session's working directory). Conventional `.github/skills/` and `.github/agents/` definitions under them also join the session catalogs when their subsystem gates are enabled, so supplying a directory is a trust decision for configuration stored there. When `unrestricted` is true, these are still pre-populated on the UnrestrictedPathManager so they remain visible via getDirectories() (e.g. for @-mention completion). */ @JsonProperty("additionalDirectories") List additionalDirectories, /** Whether to include the system temp directory in the allowed list (defaults to true). Ignored when `unrestricted` is true. */ @JsonProperty("includeTempDirectory") Boolean includeTempDirectory, diff --git a/java/sdk/src/generated/java/com/github/copilot/generated/rpc/PermissionResponseCapability.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/PermissionResponseCapability.java new file mode 100644 index 0000000000..c52bfd3234 --- /dev/null +++ b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/PermissionResponseCapability.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; + +/** + * Response capability available to the client when it settled a permission request. + * + * @since 1.0.0 + */ +@javax.annotation.processing.Generated("copilot-sdk-codegen") +public enum PermissionResponseCapability { + /** The {@code interactive} variant. */ + INTERACTIVE("interactive"), + /** The {@code headless} variant. */ + HEADLESS("headless"), + /** The {@code none} variant. */ + NONE("none"); + + private final String value; + PermissionResponseCapability(String value) { this.value = value; } + @com.fasterxml.jackson.annotation.JsonValue + public String getValue() { return value; } + @com.fasterxml.jackson.annotation.JsonCreator + public static PermissionResponseCapability fromValue(String value) { + for (PermissionResponseCapability v : values()) { + if (v.value.equals(value)) return v; + } + throw new IllegalArgumentException("Unknown PermissionResponseCapability value: " + value); + } +} 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 100% 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 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/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 92% 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 249c7598d9..e451bfe490 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 @@ -22,7 +22,9 @@ @JsonInclude(JsonInclude.Include.NON_NULL) @JsonIgnoreProperties(ignoreUnknown = true) public record PermissionsConfigureAdditionalContentExclusionPolicy( + /** Content-exclusion rules to apply. */ @JsonProperty("rules") List rules, + /** Opaque policy update timestamp supplied by the host. */ @JsonProperty("last_updated_at") Object lastUpdatedAt, /** Allowed values for the `PermissionsConfigureAdditionalContentExclusionPolicyScope` enumeration. */ @JsonProperty("scope") PermissionsConfigureAdditionalContentExclusionPolicyScope scope 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 90% 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 b1afc50fcd..4515f55d7c 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 @@ -22,8 +22,11 @@ @JsonInclude(JsonInclude.Include.NON_NULL) @JsonIgnoreProperties(ignoreUnknown = true) public record PermissionsConfigureAdditionalContentExclusionPolicyRule( + /** Path patterns covered by this rule. */ @JsonProperty("paths") List paths, + /** Conditions of which at least one must match. */ @JsonProperty("ifAnyMatch") List ifAnyMatch, + /** Conditions none of which may match. */ @JsonProperty("ifNoneMatch") List ifNoneMatch, /** 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 93% 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 f592ae7991..e4eae24027 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 @@ -21,7 +21,9 @@ @JsonInclude(JsonInclude.Include.NON_NULL) @JsonIgnoreProperties(ignoreUnknown = true) public record PermissionsConfigureAdditionalContentExclusionPolicyRuleSource( + /** Name of the policy source. */ @JsonProperty("name") String name, + /** Type of the policy source. */ @JsonProperty("type") String type ) { } 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/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 95% 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 index b86b09dfa3..0bf52d53df 100644 --- 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 @@ -22,6 +22,8 @@ public enum PermissionsSetApproveAllSource { SLASH_COMMAND("slash_command"), /** The {@code autopilot_confirmation} variant. */ AUTOPILOT_CONFIRMATION("autopilot_confirmation"), + /** The {@code user_setting} variant. */ + USER_SETTING("user_setting"), /** The {@code rpc} variant. */ RPC("rpc"); 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 100% 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 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 100% 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 diff --git a/java/src/generated/java/com/github/copilot/generated/rpc/PlanSqlTodoDependency.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/PlanSqlTodoDependency.java similarity index 100% rename from java/src/generated/java/com/github/copilot/generated/rpc/PlanSqlTodoDependency.java rename to java/sdk/src/generated/java/com/github/copilot/generated/rpc/PlanSqlTodoDependency.java diff --git a/java/src/generated/java/com/github/copilot/generated/rpc/PlanSqlTodosRow.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/PlanSqlTodosRow.java similarity index 76% rename from java/src/generated/java/com/github/copilot/generated/rpc/PlanSqlTodosRow.java rename to java/sdk/src/generated/java/com/github/copilot/generated/rpc/PlanSqlTodosRow.java index bee0a48546..56e0e3dfcc 100644 --- a/java/src/generated/java/com/github/copilot/generated/rpc/PlanSqlTodosRow.java +++ b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/PlanSqlTodosRow.java @@ -28,6 +28,8 @@ public record PlanSqlTodosRow( /** Todo description. */ @JsonProperty("description") String description, /** Todo status. */ - @JsonProperty("status") String status + @JsonProperty("status") String status, + /** Todo creation time, as stored by the session SQL schema's `datetime('now')` default: `YYYY-MM-DD HH:MM:SS` in UTC. Lets clients attribute todos to the work item that created them (e.g. scoping a goal's progress to the todos it produced) rather than to the whole session. */ + @JsonProperty("createdAt") String createdAt ) { } 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 100% 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 diff --git a/java/src/generated/java/com/github/copilot/generated/rpc/PluginUpdateAllEntry.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/PluginUpdateAllEntry.java similarity index 100% rename from java/src/generated/java/com/github/copilot/generated/rpc/PluginUpdateAllEntry.java rename to java/sdk/src/generated/java/com/github/copilot/generated/rpc/PluginUpdateAllEntry.java diff --git a/java/sdk/src/generated/java/com/github/copilot/generated/rpc/PluginsBuiltinSetParams.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/PluginsBuiltinSetParams.java new file mode 100644 index 0000000000..f0d77fe641 --- /dev/null +++ b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/PluginsBuiltinSetParams.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; + +/** + * Trusted built-in plugin directories to use for this runtime 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) +public record PluginsBuiltinSetParams( + /** Complete replacement set of trusted built-in plugin directories. Every entry must be an absolute local filesystem path no longer than 4096 characters. */ + @JsonProperty("paths") List paths +) { +} diff --git a/java/src/generated/java/com/github/copilot/generated/rpc/PluginsDisableParams.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/PluginsDisableParams.java similarity index 100% rename from java/src/generated/java/com/github/copilot/generated/rpc/PluginsDisableParams.java rename to java/sdk/src/generated/java/com/github/copilot/generated/rpc/PluginsDisableParams.java diff --git a/java/src/generated/java/com/github/copilot/generated/rpc/PluginsEnableParams.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/PluginsEnableParams.java similarity index 100% rename from java/src/generated/java/com/github/copilot/generated/rpc/PluginsEnableParams.java rename to java/sdk/src/generated/java/com/github/copilot/generated/rpc/PluginsEnableParams.java diff --git a/java/src/generated/java/com/github/copilot/generated/rpc/PluginsInstallParams.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/PluginsInstallParams.java similarity index 100% rename from java/src/generated/java/com/github/copilot/generated/rpc/PluginsInstallParams.java rename to java/sdk/src/generated/java/com/github/copilot/generated/rpc/PluginsInstallParams.java diff --git a/java/src/generated/java/com/github/copilot/generated/rpc/PluginsInstallResult.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/PluginsInstallResult.java similarity index 100% rename from java/src/generated/java/com/github/copilot/generated/rpc/PluginsInstallResult.java rename to java/sdk/src/generated/java/com/github/copilot/generated/rpc/PluginsInstallResult.java diff --git a/java/src/generated/java/com/github/copilot/generated/rpc/PluginsListResult.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/PluginsListResult.java similarity index 100% rename from java/src/generated/java/com/github/copilot/generated/rpc/PluginsListResult.java rename to java/sdk/src/generated/java/com/github/copilot/generated/rpc/PluginsListResult.java diff --git a/java/src/generated/java/com/github/copilot/generated/rpc/PluginsMarketplacesAddParams.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/PluginsMarketplacesAddParams.java similarity index 100% rename from java/src/generated/java/com/github/copilot/generated/rpc/PluginsMarketplacesAddParams.java rename to java/sdk/src/generated/java/com/github/copilot/generated/rpc/PluginsMarketplacesAddParams.java diff --git a/java/src/generated/java/com/github/copilot/generated/rpc/PluginsMarketplacesAddResult.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/PluginsMarketplacesAddResult.java similarity index 100% rename from java/src/generated/java/com/github/copilot/generated/rpc/PluginsMarketplacesAddResult.java rename to java/sdk/src/generated/java/com/github/copilot/generated/rpc/PluginsMarketplacesAddResult.java diff --git a/java/src/generated/java/com/github/copilot/generated/rpc/PluginsMarketplacesBrowseParams.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/PluginsMarketplacesBrowseParams.java similarity index 100% rename from java/src/generated/java/com/github/copilot/generated/rpc/PluginsMarketplacesBrowseParams.java rename to java/sdk/src/generated/java/com/github/copilot/generated/rpc/PluginsMarketplacesBrowseParams.java diff --git a/java/src/generated/java/com/github/copilot/generated/rpc/PluginsMarketplacesBrowseResult.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/PluginsMarketplacesBrowseResult.java similarity index 100% rename from java/src/generated/java/com/github/copilot/generated/rpc/PluginsMarketplacesBrowseResult.java rename to java/sdk/src/generated/java/com/github/copilot/generated/rpc/PluginsMarketplacesBrowseResult.java diff --git a/java/src/generated/java/com/github/copilot/generated/rpc/PluginsMarketplacesListResult.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/PluginsMarketplacesListResult.java similarity index 100% rename from java/src/generated/java/com/github/copilot/generated/rpc/PluginsMarketplacesListResult.java rename to java/sdk/src/generated/java/com/github/copilot/generated/rpc/PluginsMarketplacesListResult.java 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 0000000000..a390962b50 --- /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/src/generated/java/com/github/copilot/generated/rpc/PluginsMarketplacesRefreshResult.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/PluginsMarketplacesRefreshResult.java similarity index 100% rename from java/src/generated/java/com/github/copilot/generated/rpc/PluginsMarketplacesRefreshResult.java rename to java/sdk/src/generated/java/com/github/copilot/generated/rpc/PluginsMarketplacesRefreshResult.java diff --git a/java/src/generated/java/com/github/copilot/generated/rpc/PluginsMarketplacesRemoveParams.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/PluginsMarketplacesRemoveParams.java similarity index 100% rename from java/src/generated/java/com/github/copilot/generated/rpc/PluginsMarketplacesRemoveParams.java rename to java/sdk/src/generated/java/com/github/copilot/generated/rpc/PluginsMarketplacesRemoveParams.java diff --git a/java/src/generated/java/com/github/copilot/generated/rpc/PluginsMarketplacesRemoveResult.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/PluginsMarketplacesRemoveResult.java similarity index 100% rename from java/src/generated/java/com/github/copilot/generated/rpc/PluginsMarketplacesRemoveResult.java rename to java/sdk/src/generated/java/com/github/copilot/generated/rpc/PluginsMarketplacesRemoveResult.java diff --git a/java/src/generated/java/com/github/copilot/generated/rpc/PluginsUninstallParams.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/PluginsUninstallParams.java similarity index 100% rename from java/src/generated/java/com/github/copilot/generated/rpc/PluginsUninstallParams.java rename to java/sdk/src/generated/java/com/github/copilot/generated/rpc/PluginsUninstallParams.java diff --git a/java/src/generated/java/com/github/copilot/generated/rpc/PluginsUpdateAllResult.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/PluginsUpdateAllResult.java similarity index 100% rename from java/src/generated/java/com/github/copilot/generated/rpc/PluginsUpdateAllResult.java rename to java/sdk/src/generated/java/com/github/copilot/generated/rpc/PluginsUpdateAllResult.java diff --git a/java/src/generated/java/com/github/copilot/generated/rpc/PluginsUpdateParams.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/PluginsUpdateParams.java similarity index 100% rename from java/src/generated/java/com/github/copilot/generated/rpc/PluginsUpdateParams.java rename to java/sdk/src/generated/java/com/github/copilot/generated/rpc/PluginsUpdateParams.java diff --git a/java/src/generated/java/com/github/copilot/generated/rpc/PluginsUpdateResult.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/PluginsUpdateResult.java similarity index 100% rename from java/src/generated/java/com/github/copilot/generated/rpc/PluginsUpdateResult.java rename to java/sdk/src/generated/java/com/github/copilot/generated/rpc/PluginsUpdateResult.java diff --git a/java/src/generated/java/com/github/copilot/generated/rpc/PermissionsAllowAllMode.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/ProtocolExternalToolDefer.java similarity index 61% rename from java/src/generated/java/com/github/copilot/generated/rpc/PermissionsAllowAllMode.java rename to java/sdk/src/generated/java/com/github/copilot/generated/rpc/ProtocolExternalToolDefer.java index db24a2bad1..58f1ec24d5 100644 --- a/java/src/generated/java/com/github/copilot/generated/rpc/PermissionsAllowAllMode.java +++ b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/ProtocolExternalToolDefer.java @@ -10,28 +10,26 @@ import javax.annotation.processing.Generated; /** - * Current or requested allow-all mode. + * Controls whether the runtime may defer loading an external tool definition. * * @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"), +public enum ProtocolExternalToolDefer { /** The {@code auto} variant. */ - AUTO("auto"); + AUTO("auto"), + /** The {@code never} variant. */ + NEVER("never"); private final String value; - PermissionsAllowAllMode(String value) { this.value = value; } + ProtocolExternalToolDefer(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()) { + public static ProtocolExternalToolDefer fromValue(String value) { + for (ProtocolExternalToolDefer v : values()) { if (v.value.equals(value)) return v; } - throw new IllegalArgumentException("Unknown PermissionsAllowAllMode value: " + value); + throw new IllegalArgumentException("Unknown ProtocolExternalToolDefer value: " + value); } } diff --git a/java/sdk/src/generated/java/com/github/copilot/generated/rpc/ProtocolExternalToolDefinition.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/ProtocolExternalToolDefinition.java new file mode 100644 index 0000000000..5e7095700c --- /dev/null +++ b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/ProtocolExternalToolDefinition.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.Map; +import javax.annotation.processing.Generated; + +/** + * Serializable definition of a caller-implemented tool whose execution is handled over the SDK connection. + * + * @since 1.0.0 + */ +@javax.annotation.processing.Generated("copilot-sdk-codegen") +@JsonInclude(JsonInclude.Include.NON_NULL) +@JsonIgnoreProperties(ignoreUnknown = true) +public record ProtocolExternalToolDefinition( + /** Unique model-visible tool name. */ + @JsonProperty("name") String name, + /** Model-visible explanation of what the tool does. */ + @JsonProperty("description") String description, + /** Optional human-readable display title. */ + @JsonProperty("title") String title, + /** JSON Schema describing the tool's input arguments. */ + @JsonProperty("parameters") Map parameters, + /** Whether this definition replaces a built-in tool with the same name. */ + @JsonProperty("overridesBuiltInTool") Boolean overridesBuiltInTool, + /** Whether execution bypasses the normal tool permission prompt. */ + @JsonProperty("skipPermission") Boolean skipPermission, + /** Tool-loading deferral policy. */ + @JsonProperty("defer") ProtocolExternalToolDefer defer, + /** Whether the tool executes commands in a terminal. */ + @JsonProperty("isTerminal") Boolean isTerminal, + /** Optional caller-defined metadata associated with the tool. */ + @JsonProperty("metadata") Map metadata +) { +} diff --git a/java/src/generated/java/com/github/copilot/generated/rpc/ProviderConfig.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/ProviderConfig.java similarity index 92% rename from java/src/generated/java/com/github/copilot/generated/rpc/ProviderConfig.java rename to java/sdk/src/generated/java/com/github/copilot/generated/rpc/ProviderConfig.java index ee21c07d1b..25cc365ab0 100644 --- a/java/src/generated/java/com/github/copilot/generated/rpc/ProviderConfig.java +++ b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/ProviderConfig.java @@ -38,6 +38,10 @@ public record ProviderConfig( @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, + /** Overrides for model capabilities when they cannot be inferred from modelId. */ + @JsonProperty("modelCapabilities") ModelCapabilitiesOverride modelCapabilities, + /** Provider name used for model and telemetry attribution. */ + @JsonProperty("providerName") String providerName, /** 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. */ diff --git a/java/src/generated/java/com/github/copilot/generated/rpc/ProviderConfigAzure.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/ProviderConfigAzure.java similarity index 100% rename from java/src/generated/java/com/github/copilot/generated/rpc/ProviderConfigAzure.java rename to java/sdk/src/generated/java/com/github/copilot/generated/rpc/ProviderConfigAzure.java diff --git a/java/src/generated/java/com/github/copilot/generated/rpc/ProviderConfigTransport.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/ProviderConfigTransport.java similarity index 100% rename from java/src/generated/java/com/github/copilot/generated/rpc/ProviderConfigTransport.java rename to java/sdk/src/generated/java/com/github/copilot/generated/rpc/ProviderConfigTransport.java diff --git a/java/src/generated/java/com/github/copilot/generated/rpc/ProviderConfigType.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/ProviderConfigType.java similarity index 100% rename from java/src/generated/java/com/github/copilot/generated/rpc/ProviderConfigType.java rename to java/sdk/src/generated/java/com/github/copilot/generated/rpc/ProviderConfigType.java diff --git a/java/src/generated/java/com/github/copilot/generated/rpc/ProviderConfigWireApi.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/ProviderConfigWireApi.java similarity index 100% rename from java/src/generated/java/com/github/copilot/generated/rpc/ProviderConfigWireApi.java rename to java/sdk/src/generated/java/com/github/copilot/generated/rpc/ProviderConfigWireApi.java diff --git a/java/src/generated/java/com/github/copilot/generated/rpc/ProviderEndpointTransport.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/ProviderEndpointTransport.java similarity index 100% rename from java/src/generated/java/com/github/copilot/generated/rpc/ProviderEndpointTransport.java rename to java/sdk/src/generated/java/com/github/copilot/generated/rpc/ProviderEndpointTransport.java diff --git a/java/src/generated/java/com/github/copilot/generated/rpc/ProviderEndpointType.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/ProviderEndpointType.java similarity index 100% rename from java/src/generated/java/com/github/copilot/generated/rpc/ProviderEndpointType.java rename to java/sdk/src/generated/java/com/github/copilot/generated/rpc/ProviderEndpointType.java diff --git a/java/src/generated/java/com/github/copilot/generated/rpc/ProviderEndpointWireApi.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/ProviderEndpointWireApi.java similarity index 100% rename from java/src/generated/java/com/github/copilot/generated/rpc/ProviderEndpointWireApi.java rename to java/sdk/src/generated/java/com/github/copilot/generated/rpc/ProviderEndpointWireApi.java diff --git a/java/src/generated/java/com/github/copilot/generated/rpc/ProviderModelConfig.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/ProviderModelConfig.java similarity index 87% rename from java/src/generated/java/com/github/copilot/generated/rpc/ProviderModelConfig.java rename to java/sdk/src/generated/java/com/github/copilot/generated/rpc/ProviderModelConfig.java index c9f2630ed3..8e92701bad 100644 --- a/java/src/generated/java/com/github/copilot/generated/rpc/ProviderModelConfig.java +++ b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/ProviderModelConfig.java @@ -23,7 +23,7 @@ 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. */ + /** Name of the configured provider 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, @@ -32,11 +32,11 @@ public record ProviderModelConfig( /** 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, + @JsonProperty("maxPromptTokens") Long maxPromptTokens, /** Maximum context window tokens for the model. */ - @JsonProperty("maxContextWindowTokens") Double maxContextWindowTokens, + @JsonProperty("maxContextWindowTokens") Long maxContextWindowTokens, /** Maximum output tokens for the model. */ - @JsonProperty("maxOutputTokens") Double maxOutputTokens, + @JsonProperty("maxOutputTokens") Long maxOutputTokens, /** Optional capability overrides (vision, tool_calls, reasoning, etc.). */ @JsonProperty("capabilities") ModelCapabilitiesOverride capabilities ) { diff --git a/java/src/generated/java/com/github/copilot/generated/rpc/ProviderSessionToken.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/ProviderSessionToken.java similarity index 100% rename from java/src/generated/java/com/github/copilot/generated/rpc/ProviderSessionToken.java rename to java/sdk/src/generated/java/com/github/copilot/generated/rpc/ProviderSessionToken.java diff --git a/java/src/generated/java/com/github/copilot/generated/rpc/ProviderTokenGetTokenParams.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/ProviderTokenGetTokenParams.java similarity index 92% rename from java/src/generated/java/com/github/copilot/generated/rpc/ProviderTokenGetTokenParams.java rename to java/sdk/src/generated/java/com/github/copilot/generated/rpc/ProviderTokenGetTokenParams.java index a3e3cad7eb..1181e3ec6c 100644 --- a/java/src/generated/java/com/github/copilot/generated/rpc/ProviderTokenGetTokenParams.java +++ b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/ProviderTokenGetTokenParams.java @@ -26,7 +26,7 @@ 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`. */ + /** 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 the configured provider name. */ @JsonProperty("providerName") String providerName ) { } diff --git a/java/src/generated/java/com/github/copilot/generated/rpc/ProviderTokenGetTokenResult.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/ProviderTokenGetTokenResult.java similarity index 100% rename from java/src/generated/java/com/github/copilot/generated/rpc/ProviderTokenGetTokenResult.java rename to java/sdk/src/generated/java/com/github/copilot/generated/rpc/ProviderTokenGetTokenResult.java 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 0000000000..d1056f8721 --- /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/src/generated/java/com/github/copilot/generated/rpc/QueuePendingItems.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/QueuePendingItems.java similarity index 66% rename from java/src/generated/java/com/github/copilot/generated/rpc/QueuePendingItems.java rename to java/sdk/src/generated/java/com/github/copilot/generated/rpc/QueuePendingItems.java index 8767e91d0d..f3b2f99188 100644 --- a/java/src/generated/java/com/github/copilot/generated/rpc/QueuePendingItems.java +++ b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/QueuePendingItems.java @@ -21,9 +21,13 @@ @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 + @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/src/generated/java/com/github/copilot/generated/rpc/RemoteControlConfig.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/RemoteControlConfig.java similarity index 100% rename from java/src/generated/java/com/github/copilot/generated/rpc/RemoteControlConfig.java rename to java/sdk/src/generated/java/com/github/copilot/generated/rpc/RemoteControlConfig.java diff --git a/java/src/generated/java/com/github/copilot/generated/rpc/RemoteControlConfigExistingMcSession.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/RemoteControlConfigExistingMcSession.java similarity index 100% rename from java/src/generated/java/com/github/copilot/generated/rpc/RemoteControlConfigExistingMcSession.java rename to java/sdk/src/generated/java/com/github/copilot/generated/rpc/RemoteControlConfigExistingMcSession.java diff --git a/java/sdk/src/generated/java/com/github/copilot/generated/rpc/RemoteSessionHostStatus.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/RemoteSessionHostStatus.java new file mode 100644 index 0000000000..50b6355d93 --- /dev/null +++ b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/RemoteSessionHostStatus.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; + +/** + * What a remote host says one of its sessions is doing right now. Deliberately coarse: this is what a host can report for EVERY session in a catalogue listing, without a client subscribing to each one. AHP's `SessionSummary.status` is the source today; `input-needed` covers both a permission prompt and an `ask_user` question, since the summary does not say which. + * + * @since 1.0.0 + */ +@javax.annotation.processing.Generated("copilot-sdk-codegen") +public enum RemoteSessionHostStatus { + /** The {@code idle} variant. */ + IDLE("idle"), + /** The {@code working} variant. */ + WORKING("working"), + /** The {@code input-needed} variant. */ + INPUT_NEEDED("input-needed"), + /** The {@code error} variant. */ + ERROR("error"); + + private final String value; + RemoteSessionHostStatus(String value) { this.value = value; } + @com.fasterxml.jackson.annotation.JsonValue + public String getValue() { return value; } + @com.fasterxml.jackson.annotation.JsonCreator + public static RemoteSessionHostStatus fromValue(String value) { + for (RemoteSessionHostStatus v : values()) { + if (v.value.equals(value)) return v; + } + throw new IllegalArgumentException("Unknown RemoteSessionHostStatus value: " + value); + } +} diff --git a/java/src/generated/java/com/github/copilot/generated/rpc/RemoteSessionMetadataRepository.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/RemoteSessionMetadataRepository.java similarity index 100% rename from java/src/generated/java/com/github/copilot/generated/rpc/RemoteSessionMetadataRepository.java rename to java/sdk/src/generated/java/com/github/copilot/generated/rpc/RemoteSessionMetadataRepository.java diff --git a/java/src/generated/java/com/github/copilot/generated/rpc/RemoteSessionMetadataTaskType.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/RemoteSessionMetadataTaskType.java similarity index 100% rename from java/src/generated/java/com/github/copilot/generated/rpc/RemoteSessionMetadataTaskType.java rename to java/sdk/src/generated/java/com/github/copilot/generated/rpc/RemoteSessionMetadataTaskType.java diff --git a/java/src/generated/java/com/github/copilot/generated/rpc/RemoteSessionMetadataValue.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/RemoteSessionMetadataValue.java similarity index 79% rename from java/src/generated/java/com/github/copilot/generated/rpc/RemoteSessionMetadataValue.java rename to java/sdk/src/generated/java/com/github/copilot/generated/rpc/RemoteSessionMetadataValue.java index 46f1077d9e..3ff7338d4a 100644 --- a/java/src/generated/java/com/github/copilot/generated/rpc/RemoteSessionMetadataValue.java +++ b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/RemoteSessionMetadataValue.java @@ -49,6 +49,10 @@ public record RemoteSessionMetadataValue( /** 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 + @JsonProperty("state") String state, + /** Live status as the owning host reports it in its session listing, so a row for a session running elsewhere can show that it is running. Absent for hosts that publish no such status (the cloud task managers), which read as idle. */ + @JsonProperty("hostStatus") RemoteSessionHostStatus hostStatus, + /** Host-supplied human description of what the session is doing right now ("running tests", "waiting for approval"). Optional in the protocol and absent on hosts that do not publish it, so never rely on it -- it enriches `hostStatus`, it does not replace it. */ + @JsonProperty("hostActivity") String hostActivity ) { } 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 0000000000..1ab906bb10 --- /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/src/generated/java/com/github/copilot/generated/rpc/RpcCaller.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/RpcCaller.java similarity index 100% rename from java/src/generated/java/com/github/copilot/generated/rpc/RpcCaller.java rename to java/sdk/src/generated/java/com/github/copilot/generated/rpc/RpcCaller.java 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/src/generated/java/com/github/copilot/generated/rpc/RunOptions.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/RunOptions.java similarity index 79% rename from java/src/generated/java/com/github/copilot/generated/rpc/RunOptions.java rename to java/sdk/src/generated/java/com/github/copilot/generated/rpc/RunOptions.java index 92e4c401f8..11ac51827a 100644 --- a/java/src/generated/java/com/github/copilot/generated/rpc/RunOptions.java +++ b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/RunOptions.java @@ -23,6 +23,10 @@ public record RunOptions( /** Per-invocation resource ceiling overrides. */ @JsonProperty("limits") FactoryRunLimits limits, + /** Whether to notify the originating session when the factory completes. */ + @JsonProperty("notifyOnComplete") Boolean notifyOnComplete, + /** Whether to emit factory phase names to the session transcript. */ + @JsonProperty("logPhaseNames") Boolean logPhaseNames, /** Run identifier whose journal and progress should seed this resumed run. */ @JsonProperty("resumeFromRunId") String resumeFromRunId ) { diff --git a/java/src/generated/java/com/github/copilot/generated/rpc/SandboxConfig.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SandboxConfig.java similarity index 54% rename from java/src/generated/java/com/github/copilot/generated/rpc/SandboxConfig.java rename to java/sdk/src/generated/java/com/github/copilot/generated/rpc/SandboxConfig.java index 3460560b28..beda6b20a2 100644 --- a/java/src/generated/java/com/github/copilot/generated/rpc/SandboxConfig.java +++ b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SandboxConfig.java @@ -27,9 +27,9 @@ public record SandboxConfig( @JsonProperty("userPolicy") SandboxConfigUserPolicy userPolicy, /** Whether to auto-add the current working directory to readwritePaths. Default: true. */ @JsonProperty("addCurrentWorkingDirectory") Boolean addCurrentWorkingDirectory, - /** Whether to inject the Copilot GitHub token as an `http..extraheader` so authenticated HTTPS git works inside the sandbox without the shell-based credential helper the sandbox blocks. Default: false (opt-in). */ - @JsonProperty("gitAuth") Boolean gitAuth, - /** 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("ghAuth") Boolean ghAuth + /** Credential-injection capability flags. */ + @JsonProperty("auth") SandboxConfigAuth auth, + /** Whether to auto-grant read access to tool directories discovered on PATH and in toolchain environment variables (GOROOT, JAVA_HOME, VIRTUAL_ENV, and similar), and to common developer-tool caches, config, and toolchains. Writable grants cover scratch caches, the Unix GitHub CLI cache, and Cargo's registry, git store, and lock/tracker files. A relocated CARGO_HOME gets the same narrow split: registry and git are read-write; bin is read-only; the home root, config.toml, and credentials.toml stay ungranted. Set to false to disable every grant listed above; user-installed toolchains and caches then need explicit userPolicy.filesystem readonlyPaths and readwritePaths entries. The working directory (see addCurrentWorkingDirectory), temporary storage, session log paths, and system locations follow their own rules and stay granted. 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 0000000000..cb4efc78e7 --- /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. For the same capability independent of sandboxing, and matched to the credential's GitHub host, see `shell.credentials`; the two are additive. + * + * @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/SandboxConfigSource.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SandboxConfigSource.java new file mode 100644 index 0000000000..73760b08a2 --- /dev/null +++ b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SandboxConfigSource.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; + +/** + * Origin of the sandbox choice supplied by an internal client. + * + * @since 1.0.0 + */ +@javax.annotation.processing.Generated("copilot-sdk-codegen") +public enum SandboxConfigSource { + /** The {@code never_configured} variant. */ + NEVER_CONFIGURED("never_configured"), + /** The {@code user_enabled} variant. */ + USER_ENABLED("user_enabled"), + /** The {@code user_disabled} variant. */ + USER_DISABLED("user_disabled"), + /** The {@code session_flag} variant. */ + SESSION_FLAG("session_flag"), + /** The {@code session_disabled} variant. */ + SESSION_DISABLED("session_disabled"), + /** The {@code unsupported_host} variant. */ + UNSUPPORTED_HOST("unsupported_host"), + /** The {@code repository_policy} variant. */ + REPOSITORY_POLICY("repository_policy"); + + private final String value; + SandboxConfigSource(String value) { this.value = value; } + @com.fasterxml.jackson.annotation.JsonValue + public String getValue() { return value; } + @com.fasterxml.jackson.annotation.JsonCreator + public static SandboxConfigSource fromValue(String value) { + for (SandboxConfigSource v : values()) { + if (v.value.equals(value)) return v; + } + throw new IllegalArgumentException("Unknown SandboxConfigSource value: " + value); + } +} diff --git a/java/src/generated/java/com/github/copilot/generated/rpc/SandboxConfigUserPolicy.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SandboxConfigUserPolicy.java similarity index 100% rename from java/src/generated/java/com/github/copilot/generated/rpc/SandboxConfigUserPolicy.java rename to java/sdk/src/generated/java/com/github/copilot/generated/rpc/SandboxConfigUserPolicy.java diff --git a/java/src/generated/java/com/github/copilot/generated/rpc/SandboxConfigUserPolicyExperimental.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SandboxConfigUserPolicyExperimental.java similarity index 100% rename from java/src/generated/java/com/github/copilot/generated/rpc/SandboxConfigUserPolicyExperimental.java rename to java/sdk/src/generated/java/com/github/copilot/generated/rpc/SandboxConfigUserPolicyExperimental.java diff --git a/java/src/generated/java/com/github/copilot/generated/rpc/SandboxConfigUserPolicyExperimentalSeatbelt.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SandboxConfigUserPolicyExperimentalSeatbelt.java similarity index 100% rename from java/src/generated/java/com/github/copilot/generated/rpc/SandboxConfigUserPolicyExperimentalSeatbelt.java rename to java/sdk/src/generated/java/com/github/copilot/generated/rpc/SandboxConfigUserPolicyExperimentalSeatbelt.java diff --git a/java/src/generated/java/com/github/copilot/generated/rpc/SandboxConfigUserPolicyFilesystem.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SandboxConfigUserPolicyFilesystem.java similarity index 100% rename from java/src/generated/java/com/github/copilot/generated/rpc/SandboxConfigUserPolicyFilesystem.java rename to java/sdk/src/generated/java/com/github/copilot/generated/rpc/SandboxConfigUserPolicyFilesystem.java diff --git a/java/src/generated/java/com/github/copilot/generated/rpc/SandboxConfigUserPolicyNetwork.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SandboxConfigUserPolicyNetwork.java similarity index 70% rename from java/src/generated/java/com/github/copilot/generated/rpc/SandboxConfigUserPolicyNetwork.java rename to java/sdk/src/generated/java/com/github/copilot/generated/rpc/SandboxConfigUserPolicyNetwork.java index 9b8b53c816..1e56acb53f 100644 --- a/java/src/generated/java/com/github/copilot/generated/rpc/SandboxConfigUserPolicyNetwork.java +++ b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SandboxConfigUserPolicyNetwork.java @@ -24,6 +24,8 @@ 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 + @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 0000000000..74ff86919e --- /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/src/generated/java/com/github/copilot/generated/rpc/SandboxConfigUserPolicySeatbelt.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SandboxConfigUserPolicySeatbelt.java similarity index 100% rename from java/src/generated/java/com/github/copilot/generated/rpc/SandboxConfigUserPolicySeatbelt.java rename to java/sdk/src/generated/java/com/github/copilot/generated/rpc/SandboxConfigUserPolicySeatbelt.java diff --git a/java/src/generated/java/com/github/copilot/generated/rpc/ScheduleEntry.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/ScheduleEntry.java similarity index 100% rename from java/src/generated/java/com/github/copilot/generated/rpc/ScheduleEntry.java rename to java/sdk/src/generated/java/com/github/copilot/generated/rpc/ScheduleEntry.java 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 100% 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 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 100% 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 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/src/generated/java/com/github/copilot/generated/rpc/SendMessageItem.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SendMessageItem.java similarity index 87% rename from java/src/generated/java/com/github/copilot/generated/rpc/SendMessageItem.java rename to java/sdk/src/generated/java/com/github/copilot/generated/rpc/SendMessageItem.java index bdb37cd9fd..4a6696c01d 100644 --- a/java/src/generated/java/com/github/copilot/generated/rpc/SendMessageItem.java +++ b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SendMessageItem.java @@ -32,7 +32,7 @@ public record SendMessageItem( @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 match one of three forms: the literal `system`, `command-` for messages originating from a command (e.g. slash command, Mission Control command), or `schedule-` for messages originating from a scheduled job. */ + /** 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/src/generated/java/com/github/copilot/generated/rpc/ServerAccountApi.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/ServerAccountApi.java similarity index 76% rename from java/src/generated/java/com/github/copilot/generated/rpc/ServerAccountApi.java rename to java/sdk/src/generated/java/com/github/copilot/generated/rpc/ServerAccountApi.java index 4b7cf718ee..0adbf18092 100644 --- a/java/src/generated/java/com/github/copilot/generated/rpc/ServerAccountApi.java +++ b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/ServerAccountApi.java @@ -28,14 +28,27 @@ public final class ServerAccountApi { } /** - * Optional GitHub token used to look up quota for a specific user instead of the global auth context. + * Optional opaque account selection or compatibility GitHub token used to look up quota. + *

+ * 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 caller.invoke("account.getQuota", java.util.Map.of(), AccountGetQuotaResult.class); + return getQuota(null); + } + + /** + * Optional opaque account selection or compatibility GitHub token used to look up quota. + * + * @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); } /** @@ -61,7 +74,7 @@ public CompletableFuture> getAllUsers() { } /** - * Credentials to store after successful authentication + * Credentials to validate and store. Omit login to resolve the authenticated user from the token. * * @apiNote This method is experimental and may change in a future version. * @since 1.0.0 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 100% 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 diff --git a/java/src/generated/java/com/github/copilot/generated/rpc/ServerAgentsApi.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/ServerAgentsApi.java similarity index 100% rename from java/src/generated/java/com/github/copilot/generated/rpc/ServerAgentsApi.java rename to java/sdk/src/generated/java/com/github/copilot/generated/rpc/ServerAgentsApi.java diff --git a/java/sdk/src/generated/java/com/github/copilot/generated/rpc/ServerCatalogApi.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/ServerCatalogApi.java new file mode 100644 index 0000000000..9b320cbb39 --- /dev/null +++ b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/ServerCatalogApi.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 catalog} namespace. + * + * @since 1.0.0 + */ +@javax.annotation.processing.Generated("copilot-sdk-codegen") +public final class ServerCatalogApi { + + private final RpcCaller caller; + + /** @param caller the RPC transport function */ + ServerCatalogApi(RpcCaller caller) { + this.caller = caller; + } + + /** + * A bounded catalog search. Both the query length and the result count are capped by the schema so a caller cannot request an unbounded scan. + * + * @apiNote This method is experimental and may change in a future version. + * @since 1.0.0 + */ + @CopilotExperimental + public CompletableFuture search(CatalogSearchParams params) { + return caller.invoke("catalog.search", params, CatalogSearchResult.class); + } + +} diff --git a/java/src/generated/java/com/github/copilot/generated/rpc/ServerCommandsApi.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/ServerCommandsApi.java similarity index 100% rename from java/src/generated/java/com/github/copilot/generated/rpc/ServerCommandsApi.java rename to java/sdk/src/generated/java/com/github/copilot/generated/rpc/ServerCommandsApi.java diff --git a/java/src/generated/java/com/github/copilot/generated/rpc/SessionQueueApi.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/ServerExtensionsApi.java similarity index 55% rename from java/src/generated/java/com/github/copilot/generated/rpc/SessionQueueApi.java rename to java/sdk/src/generated/java/com/github/copilot/generated/rpc/ServerExtensionsApi.java index 9b880e134f..7bc74b441f 100644 --- a/java/src/generated/java/com/github/copilot/generated/rpc/SessionQueueApi.java +++ b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/ServerExtensionsApi.java @@ -12,53 +12,51 @@ import javax.annotation.processing.Generated; /** - * API methods for the {@code queue} namespace. + * API methods for the {@code extensions} namespace. * * @since 1.0.0 */ @javax.annotation.processing.Generated("copilot-sdk-codegen") -public final class SessionQueueApi { +public final class ServerExtensionsApi { private final RpcCaller caller; - private final String sessionId; /** @param caller the RPC transport function */ - SessionQueueApi(RpcCaller caller, String sessionId) { + ServerExtensionsApi(RpcCaller caller) { this.caller = caller; - this.sessionId = sessionId; } /** - * Identifies the target session. + * 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 pendingItems() { - return caller.invoke("session.queue.pendingItems", java.util.Map.of("sessionId", this.sessionId), SessionQueuePendingItemsResult.class); + public CompletableFuture discover() { + return caller.invoke("extensions.discover", java.util.Map.of(), ExtensionsDiscoverResult.class); } /** - * Identifies the target session. + * 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 removeMostRecent() { - return caller.invoke("session.queue.removeMostRecent", java.util.Map.of("sessionId", this.sessionId), SessionQueueRemoveMostRecentResult.class); + public CompletableFuture enable(ExtensionsEnableParams params) { + return caller.invoke("extensions.enable", params, Void.class); } /** - * Identifies the target session. + * 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 clear() { - return caller.invoke("session.queue.clear", java.util.Map.of("sessionId", this.sessionId), Void.class); + public CompletableFuture disable(ExtensionsDisableParams params) { + return caller.invoke("extensions.disable", params, Void.class); } } diff --git a/java/src/generated/java/com/github/copilot/generated/rpc/ServerInstructionsApi.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/ServerInstructionsApi.java similarity index 100% rename from java/src/generated/java/com/github/copilot/generated/rpc/ServerInstructionsApi.java rename to java/sdk/src/generated/java/com/github/copilot/generated/rpc/ServerInstructionsApi.java diff --git a/java/src/generated/java/com/github/copilot/generated/rpc/ServerLlmInferenceApi.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/ServerLlmInferenceApi.java similarity index 100% rename from java/src/generated/java/com/github/copilot/generated/rpc/ServerLlmInferenceApi.java rename to java/sdk/src/generated/java/com/github/copilot/generated/rpc/ServerLlmInferenceApi.java 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 0000000000..e85b7b987a --- /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 74% 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 b29c27fa4c..88dd7621fd 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 @@ -41,4 +41,15 @@ public CompletableFuture discover(McpDiscoverParams params) { return caller.invoke("mcp.discover", params, McpDiscoverResult.class); } + /** + * A side-effect-free request for an MCP install plan. Computing a plan never writes configuration, stores a secret, or reloads MCP servers. + * + * @apiNote This method is experimental and may change in a future version. + * @since 1.0.0 + */ + @CopilotExperimental + public CompletableFuture planInstall(McpPlanInstallParams params) { + return caller.invoke("mcp.planInstall", params, McpPlanInstallResult.class); + } + } diff --git a/java/src/generated/java/com/github/copilot/generated/rpc/ServerMcpConfigApi.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/ServerMcpConfigApi.java similarity index 100% rename from java/src/generated/java/com/github/copilot/generated/rpc/ServerMcpConfigApi.java rename to java/sdk/src/generated/java/com/github/copilot/generated/rpc/ServerMcpConfigApi.java 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 0000000000..e4fd3cbc53 --- /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 opaque account selection or compatibility GitHub token used to list models. + *

+ * 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 opaque account selection or compatibility GitHub token used to list models. + * + * @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/src/generated/java/com/github/copilot/generated/rpc/ServerPluginsApi.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/ServerPluginsApi.java similarity index 95% rename from java/src/generated/java/com/github/copilot/generated/rpc/ServerPluginsApi.java rename to java/sdk/src/generated/java/com/github/copilot/generated/rpc/ServerPluginsApi.java index 20dc6ab15a..a7a28f5d1c 100644 --- a/java/src/generated/java/com/github/copilot/generated/rpc/ServerPluginsApi.java +++ b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/ServerPluginsApi.java @@ -21,12 +21,15 @@ public final class ServerPluginsApi { private final RpcCaller caller; + /** API methods for the {@code plugins.builtin} sub-namespace. */ + public final ServerPluginsBuiltinApi builtin; /** 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.builtin = new ServerPluginsBuiltinApi(caller); this.marketplaces = new ServerPluginsMarketplacesApi(caller); } diff --git a/java/src/generated/java/com/github/copilot/generated/rpc/ServerModelsApi.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/ServerPluginsBuiltinApi.java similarity index 70% rename from java/src/generated/java/com/github/copilot/generated/rpc/ServerModelsApi.java rename to java/sdk/src/generated/java/com/github/copilot/generated/rpc/ServerPluginsBuiltinApi.java index 64ccc62cde..0610fcb28e 100644 --- a/java/src/generated/java/com/github/copilot/generated/rpc/ServerModelsApi.java +++ b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/ServerPluginsBuiltinApi.java @@ -12,29 +12,29 @@ import javax.annotation.processing.Generated; /** - * API methods for the {@code models} namespace. + * API methods for the {@code plugins.builtin} namespace. * * @since 1.0.0 */ @javax.annotation.processing.Generated("copilot-sdk-codegen") -public final class ServerModelsApi { +public final class ServerPluginsBuiltinApi { private final RpcCaller caller; /** @param caller the RPC transport function */ - ServerModelsApi(RpcCaller caller) { + ServerPluginsBuiltinApi(RpcCaller caller) { this.caller = caller; } /** - * Optional GitHub token used to list models for a specific user instead of the global auth context. + * Trusted built-in plugin directories to use for this runtime process. * * @apiNote This method is experimental and may change in a future version. * @since 1.0.0 */ @CopilotExperimental - public CompletableFuture list() { - return caller.invoke("models.list", java.util.Map.of(), ModelsListResult.class); + public CompletableFuture set(PluginsBuiltinSetParams params) { + return caller.invoke("plugins.builtin.set", params, Void.class); } } diff --git a/java/src/generated/java/com/github/copilot/generated/rpc/ServerPluginsMarketplacesApi.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/ServerPluginsMarketplacesApi.java similarity index 83% rename from java/src/generated/java/com/github/copilot/generated/rpc/ServerPluginsMarketplacesApi.java rename to java/sdk/src/generated/java/com/github/copilot/generated/rpc/ServerPluginsMarketplacesApi.java index 47b239a0c0..e01bbeeec7 100644 --- a/java/src/generated/java/com/github/copilot/generated/rpc/ServerPluginsMarketplacesApi.java +++ b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/ServerPluginsMarketplacesApi.java @@ -72,13 +72,26 @@ public CompletableFuture browse(PluginsMarketpl /** * 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 caller.invoke("plugins.marketplaces.refresh", java.util.Map.of(), PluginsMarketplacesRefreshResult.class); + 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/src/generated/java/com/github/copilot/generated/rpc/ServerRpc.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/ServerRpc.java similarity index 80% rename from java/src/generated/java/com/github/copilot/generated/rpc/ServerRpc.java rename to java/sdk/src/generated/java/com/github/copilot/generated/rpc/ServerRpc.java index 033fe8bf3e..111cee2560 100644 --- a/java/src/generated/java/com/github/copilot/generated/rpc/ServerRpc.java +++ b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/ServerRpc.java @@ -35,6 +35,10 @@ public final class ServerRpc { 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 catalog} namespace. */ + public final ServerCatalogApi catalog; /** API methods for the {@code plugins} namespace. */ public final ServerPluginsApi plugins; /** API methods for the {@code skills} namespace. */ @@ -47,6 +51,8 @@ public final class ServerRpc { 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. */ @@ -70,12 +76,15 @@ public ServerRpc(RpcCaller caller) { this.account = new ServerAccountApi(caller); this.secrets = new ServerSecretsApi(caller); this.mcp = new ServerMcpApi(caller); + this.extensions = new ServerExtensionsApi(caller); + this.catalog = new ServerCatalogApi(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); @@ -95,7 +104,7 @@ public CompletableFuture ping(PingParams params) { } /** - * Parameters for the `server.connect` handshake: an optional connection token and optional connection-level opt-ins (e.g. GitHub telemetry forwarding). + * Connection-level opt-ins for the `server.connect` handshake. Transport authentication is consumed by the native protocol boundary before dispatch. * * @apiNote This method is experimental and may change in a future version. * @since 1.0.0 @@ -105,4 +114,15 @@ 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/src/generated/java/com/github/copilot/generated/rpc/ServerRuntimeApi.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/ServerRuntimeApi.java similarity index 100% rename from java/src/generated/java/com/github/copilot/generated/rpc/ServerRuntimeApi.java rename to java/sdk/src/generated/java/com/github/copilot/generated/rpc/ServerRuntimeApi.java 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 100% 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 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 100% 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 diff --git a/java/src/generated/java/com/github/copilot/generated/rpc/ServerSessionsApi.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/ServerSessionsApi.java similarity index 83% rename from java/src/generated/java/com/github/copilot/generated/rpc/ServerSessionsApi.java rename to java/sdk/src/generated/java/com/github/copilot/generated/rpc/ServerSessionsApi.java index 7e3b4d90d8..52481a7d73 100644 --- a/java/src/generated/java/com/github/copilot/generated/rpc/ServerSessionsApi.java +++ b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/ServerSessionsApi.java @@ -33,8 +33,8 @@ public final class ServerSessionsApi { * @since 1.0.0 */ @CopilotExperimental - public CompletableFuture open() { - return caller.invoke("sessions.open", java.util.Map.of(), SessionsOpenResult.class); + public CompletableFuture open(SessionsOpenParams params) { + return caller.invoke("sessions.open", params, SessionsOpenResult.class); } /** @@ -61,13 +61,48 @@ public CompletableFuture connect(SessionsConnectParams pa /** * 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 caller.invoke("sessions.list", java.util.Map.of(), SessionsListResult.class); + 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); } /** @@ -169,6 +204,17 @@ public CompletableFuture bulkDelete(SessionsBulkDelete 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). * @@ -292,13 +338,26 @@ public CompletableFuture setRemoteContro /** * 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 caller.invoke("sessions.stopRemoteControl", java.util.Map.of(), SessionsStopRemoteControlResult.class); + 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); } /** 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 92% 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 3498245262..b1d409d9d9 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 @@ -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) */ diff --git a/java/src/generated/java/com/github/copilot/generated/rpc/ServerSkillsApi.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/ServerSkillsApi.java similarity index 100% rename from java/src/generated/java/com/github/copilot/generated/rpc/ServerSkillsApi.java rename to java/sdk/src/generated/java/com/github/copilot/generated/rpc/ServerSkillsApi.java 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 74% 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 688288a118..c29770bf14 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 @@ -37,4 +37,15 @@ public CompletableFuture setDisabledSkills(SkillsConfigSetDisabledSkillsPa return caller.invoke("skills.config.setDisabledSkills", params, Void.class); } + /** + * Adds or removes a single skill from the global disabled list, leaving every other entry untouched. + * + * @apiNote This method is experimental and may change in a future version. + * @since 1.0.0 + */ + @CopilotExperimental + public CompletableFuture setSkillDisabled(SkillsConfigSetSkillDisabledParams params) { + return caller.invoke("skills.config.setSkillDisabled", 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 100% 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 diff --git a/java/src/generated/java/com/github/copilot/generated/rpc/ServerUserApi.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/ServerUserApi.java similarity index 100% rename from java/src/generated/java/com/github/copilot/generated/rpc/ServerUserApi.java rename to java/sdk/src/generated/java/com/github/copilot/generated/rpc/ServerUserApi.java diff --git a/java/src/generated/java/com/github/copilot/generated/rpc/ServerUserSettingsApi.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/ServerUserSettingsApi.java similarity index 100% rename from java/src/generated/java/com/github/copilot/generated/rpc/ServerUserSettingsApi.java rename to java/sdk/src/generated/java/com/github/copilot/generated/rpc/ServerUserSettingsApi.java 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 100% 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 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 100% 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 diff --git a/java/src/generated/java/com/github/copilot/generated/rpc/SessionAgentApi.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionAgentApi.java similarity index 66% rename from java/src/generated/java/com/github/copilot/generated/rpc/SessionAgentApi.java rename to java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionAgentApi.java index 37d6dafce9..d2499fe3a5 100644 --- a/java/src/generated/java/com/github/copilot/generated/rpc/SessionAgentApi.java +++ b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionAgentApi.java @@ -31,14 +31,48 @@ public final class SessionAgentApi { } /** - * Identifies the target session. + * 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 caller.invoke("session.agent.list", java.util.Map.of("sessionId", this.sessionId), SessionAgentListResult.class); + 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); } /** 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 100% 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 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 100% 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 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 100% 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 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 0000000000..00743cff66 --- /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 92% 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 acd240285d..3eefc2fd88 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 @@ -15,7 +15,7 @@ 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 @@ -25,7 +25,7 @@ @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 100% 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 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 100% 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 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 100% 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 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 100% 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 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 0000000000..4395a195ed --- /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/SessionAuthStatus.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionAuthStatus.java new file mode 100644 index 0000000000..6f9d876dd8 --- /dev/null +++ b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionAuthStatus.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; + +/** + * 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 SessionAuthStatus( + /** 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/SessionPluginsReloadParams.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionCancelAllBackgroundAgentsParams.java similarity index 89% rename from java/src/generated/java/com/github/copilot/generated/rpc/SessionPluginsReloadParams.java rename to java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionCancelAllBackgroundAgentsParams.java index f48c7ee88f..0851f331ee 100644 --- a/java/src/generated/java/com/github/copilot/generated/rpc/SessionPluginsReloadParams.java +++ b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionCancelAllBackgroundAgentsParams.java @@ -14,7 +14,7 @@ import javax.annotation.processing.Generated; /** - * Optional flags controlling which side effects the reload performs. + * Identifies the target session. * * @apiNote This method is experimental and may change in a future version. * @since 1.0.0 @@ -23,7 +23,7 @@ @javax.annotation.processing.Generated("copilot-sdk-codegen") @JsonInclude(JsonInclude.Include.NON_NULL) @JsonIgnoreProperties(ignoreUnknown = true) -public record SessionPluginsReloadParams( +public record SessionCancelAllBackgroundAgentsParams( /** Target session identifier */ @JsonProperty("sessionId") String sessionId ) { diff --git a/java/src/generated/java/com/github/copilot/generated/rpc/SessionCanvasActionApi.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionCanvasActionApi.java similarity index 100% rename from java/src/generated/java/com/github/copilot/generated/rpc/SessionCanvasActionApi.java rename to java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionCanvasActionApi.java diff --git a/java/src/generated/java/com/github/copilot/generated/rpc/SessionCanvasActionInvokeParams.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionCanvasActionInvokeParams.java similarity index 100% rename from java/src/generated/java/com/github/copilot/generated/rpc/SessionCanvasActionInvokeParams.java rename to java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionCanvasActionInvokeParams.java diff --git a/java/src/generated/java/com/github/copilot/generated/rpc/SessionCanvasActionInvokeResult.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionCanvasActionInvokeResult.java similarity index 100% rename from java/src/generated/java/com/github/copilot/generated/rpc/SessionCanvasActionInvokeResult.java rename to java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionCanvasActionInvokeResult.java 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 94% 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 88a320e0be..e7cfc4be2f 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 @@ -26,12 +26,15 @@ public final class SessionCanvasApi { /** API methods for the {@code canvas.action} sub-namespace. */ public final SessionCanvasActionApi action; + /** API methods for the {@code canvas.provider} sub-namespace. */ + public final SessionCanvasProviderApi provider; /** @param caller the RPC transport function */ SessionCanvasApi(RpcCaller caller, String sessionId) { this.caller = caller; this.sessionId = sessionId; this.action = new SessionCanvasActionApi(caller, sessionId); + this.provider = new SessionCanvasProviderApi(caller, sessionId); } /** 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 100% 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 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 100% 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 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 100% 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 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 100% 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 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 100% 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 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 100% 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 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 100% 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 diff --git a/java/src/generated/java/com/github/copilot/generated/rpc/SessionMcpOauthApi.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionCanvasProviderApi.java similarity index 67% rename from java/src/generated/java/com/github/copilot/generated/rpc/SessionMcpOauthApi.java rename to java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionCanvasProviderApi.java index 7b7f7b82bd..95fc7ca660 100644 --- a/java/src/generated/java/com/github/copilot/generated/rpc/SessionMcpOauthApi.java +++ b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionCanvasProviderApi.java @@ -12,12 +12,12 @@ import javax.annotation.processing.Generated; /** - * API methods for the {@code mcp.oauth} namespace. + * API methods for the {@code canvas.provider} namespace. * * @since 1.0.0 */ @javax.annotation.processing.Generated("copilot-sdk-codegen") -public final class SessionMcpOauthApi { +public final class SessionCanvasProviderApi { private static final com.fasterxml.jackson.databind.ObjectMapper MAPPER = RpcMapper.INSTANCE; @@ -25,13 +25,13 @@ public final class SessionMcpOauthApi { private final String sessionId; /** @param caller the RPC transport function */ - SessionMcpOauthApi(RpcCaller caller, String sessionId) { + SessionCanvasProviderApi(RpcCaller caller, String sessionId) { this.caller = caller; this.sessionId = sessionId; } /** - * Pending MCP OAuth request ID and host-provided token or cancellation response. + * Internal canvas provider registration parameters. *

* Note: the {@code sessionId} field in the params record is overridden * by the session-scoped wrapper; any value provided is ignored. @@ -40,14 +40,14 @@ public final class SessionMcpOauthApi { * @since 1.0.0 */ @CopilotExperimental - public CompletableFuture handlePendingRequest(SessionMcpOauthHandlePendingRequestParams params) { + public CompletableFuture register(SessionCanvasProviderRegisterParams 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); + return caller.invoke("session.canvas.provider.register", _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. + * Internal canvas provider unregistration parameters. *

* Note: the {@code sessionId} field in the params record is overridden * by the session-scoped wrapper; any value provided is ignored. @@ -56,10 +56,10 @@ public CompletableFuture handlePendin * @since 1.0.0 */ @CopilotExperimental - public CompletableFuture login(SessionMcpOauthLoginParams params) { + public CompletableFuture unregister(SessionCanvasProviderUnregisterParams 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); + return caller.invoke("session.canvas.provider.unregister", _p, Void.class); } } diff --git a/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionCanvasProviderRegisterParams.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionCanvasProviderRegisterParams.java new file mode 100644 index 0000000000..3047576670 --- /dev/null +++ b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionCanvasProviderRegisterParams.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 canvas provider registration 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 SessionCanvasProviderRegisterParams( + /** Target session identifier */ + @JsonProperty("sessionId") String sessionId, + /** Connection identifier for callback routing */ + @JsonProperty("connectionId") String connectionId, + /** Provider metadata supplied by the host */ + @JsonProperty("info") Object info, + /** Canvas contributions supplied by the provider */ + @JsonProperty("canvases") List canvases +) { +} diff --git a/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionCanvasProviderUnregisterParams.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionCanvasProviderUnregisterParams.java new file mode 100644 index 0000000000..f7b637ac65 --- /dev/null +++ b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionCanvasProviderUnregisterParams.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 canvas provider unregistration 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 SessionCanvasProviderUnregisterParams( + /** Target session identifier */ + @JsonProperty("sessionId") String sessionId, + /** Connection identifier to unregister */ + @JsonProperty("connectionId") String connectionId +) { +} diff --git a/java/src/generated/java/com/github/copilot/generated/rpc/SessionCapability.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionCapability.java similarity index 100% rename from java/src/generated/java/com/github/copilot/generated/rpc/SessionCapability.java rename to java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionCapability.java 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 75% 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 0cb7bb5517..405819efce 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 @@ -32,13 +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); } /** @@ -57,6 +75,22 @@ public CompletableFuture invoke(SessionCommandsInv return caller.invoke("session.commands.invoke", _p, SlashCommandInvocationResult.class); } + /** + * The pending slash-command invocation effect to finalize, plus whether the host applied or cancelled 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 finalizeInvocationEffect(SessionCommandsFinalizeInvocationEffectParams params) { + com.fasterxml.jackson.databind.node.ObjectNode _p = MAPPER.valueToTree(params); + _p.put("sessionId", this.sessionId); + return caller.invoke("session.commands.finalizeInvocationEffect", _p, SessionCommandsFinalizeInvocationEffectResult.class); + } + /** * Pending command request ID and an optional error if the client handler failed. *

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 100% 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 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 100% 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 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 100% 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 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 100% 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 diff --git a/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionCommandsFinalizeInvocationEffectParams.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionCommandsFinalizeInvocationEffectParams.java new file mode 100644 index 0000000000..2a1b75f5b8 --- /dev/null +++ b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionCommandsFinalizeInvocationEffectParams.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.Map; +import javax.annotation.processing.Generated; + +/** + * The pending slash-command invocation effect to finalize, plus whether the host applied or cancelled 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 SessionCommandsFinalizeInvocationEffectParams( + /** Target session identifier */ + @JsonProperty("sessionId") String sessionId, + /** The slash-command result object that produced the pending effect, echoed back unchanged. */ + @JsonProperty("effect") Map effect, + /** Whether the host applied or cancelled the pending invocation effect. */ + @JsonProperty("outcome") CommandsInvocationEffectOutcome outcome +) { +} diff --git a/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionCommandsFinalizeInvocationEffectResult.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionCommandsFinalizeInvocationEffectResult.java new file mode 100644 index 0000000000..523a68564e --- /dev/null +++ b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionCommandsFinalizeInvocationEffectResult.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; + +/** + * Whether finalizing the invocation effect succeeded, and the failure reason when it did not. + * + * @apiNote This method is experimental and may change in a future version. + * @since 1.0.0 + */ +@CopilotExperimental +@javax.annotation.processing.Generated("copilot-sdk-codegen") +@JsonInclude(JsonInclude.Include.NON_NULL) +@JsonIgnoreProperties(ignoreUnknown = true) +public record SessionCommandsFinalizeInvocationEffectResult( + /** Whether the pending invocation effect was finalized successfully. */ + @JsonProperty("success") Boolean success, + /** Failure reason when the invocation effect could not be finalized. */ + @JsonProperty("error") String error +) { +} 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 100% 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 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 100% 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 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 88% 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 01d9488259..0921ba8ef5 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 @@ -29,6 +29,8 @@ public record SessionCommandsInvokeParams( /** Command name. Leading slashes are stripped and the name is matched case-insensitively. */ @JsonProperty("name") String name, /** Raw input after the command name */ - @JsonProperty("input") String input + @JsonProperty("input") String input, + /** Optional client surface that initiated the invocation */ + @JsonProperty("origin") CommandsInvocationOrigin origin ) { } 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 0000000000..0e2dd73aa4 --- /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 100% 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 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 100% 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 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 100% 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 diff --git a/java/src/generated/java/com/github/copilot/generated/rpc/SessionCompletionItem.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionCompletionItem.java similarity index 100% rename from java/src/generated/java/com/github/copilot/generated/rpc/SessionCompletionItem.java rename to java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionCompletionItem.java diff --git a/java/src/generated/java/com/github/copilot/generated/rpc/SessionCompletionsApi.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionCompletionsApi.java similarity index 100% rename from java/src/generated/java/com/github/copilot/generated/rpc/SessionCompletionsApi.java rename to java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionCompletionsApi.java diff --git a/java/src/generated/java/com/github/copilot/generated/rpc/SessionCompletionsGetTriggerCharactersParams.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionCompletionsGetTriggerCharactersParams.java similarity index 100% rename from java/src/generated/java/com/github/copilot/generated/rpc/SessionCompletionsGetTriggerCharactersParams.java rename to java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionCompletionsGetTriggerCharactersParams.java diff --git a/java/src/generated/java/com/github/copilot/generated/rpc/SessionCompletionsGetTriggerCharactersResult.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionCompletionsGetTriggerCharactersResult.java similarity index 100% rename from java/src/generated/java/com/github/copilot/generated/rpc/SessionCompletionsGetTriggerCharactersResult.java rename to java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionCompletionsGetTriggerCharactersResult.java diff --git a/java/src/generated/java/com/github/copilot/generated/rpc/SessionCompletionsRequestParams.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionCompletionsRequestParams.java similarity index 100% rename from java/src/generated/java/com/github/copilot/generated/rpc/SessionCompletionsRequestParams.java rename to java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionCompletionsRequestParams.java diff --git a/java/src/generated/java/com/github/copilot/generated/rpc/SessionCompletionsRequestResult.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionCompletionsRequestResult.java similarity index 100% rename from java/src/generated/java/com/github/copilot/generated/rpc/SessionCompletionsRequestResult.java rename to java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionCompletionsRequestResult.java diff --git a/java/src/generated/java/com/github/copilot/generated/rpc/SessionScheduleApi.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionContentExclusionApi.java similarity index 63% rename from java/src/generated/java/com/github/copilot/generated/rpc/SessionScheduleApi.java rename to java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionContentExclusionApi.java index 2e42c1bc30..eb621e6b49 100644 --- a/java/src/generated/java/com/github/copilot/generated/rpc/SessionScheduleApi.java +++ b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionContentExclusionApi.java @@ -12,12 +12,12 @@ import javax.annotation.processing.Generated; /** - * API methods for the {@code schedule} namespace. + * API methods for the {@code contentExclusion} namespace. * * @since 1.0.0 */ @javax.annotation.processing.Generated("copilot-sdk-codegen") -public final class SessionScheduleApi { +public final class SessionContentExclusionApi { private static final com.fasterxml.jackson.databind.ObjectMapper MAPPER = RpcMapper.INSTANCE; @@ -25,24 +25,13 @@ public final class SessionScheduleApi { private final String sessionId; /** @param caller the RPC transport function */ - SessionScheduleApi(RpcCaller caller, String sessionId) { + SessionContentExclusionApi(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); - } - - /** - * Identifier of the scheduled prompt to remove. + * 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. @@ -51,10 +40,10 @@ public CompletableFuture list() { * @since 1.0.0 */ @CopilotExperimental - public CompletableFuture stop(SessionScheduleStopParams params) { + public CompletableFuture checkPaths(SessionContentExclusionCheckPathsParams 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); + 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 0000000000..0c61f6c910 --- /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 0000000000..956ffc44d3 --- /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 100% 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 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/src/generated/java/com/github/copilot/generated/rpc/SessionDebugApi.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionDebugApi.java similarity index 100% rename from java/src/generated/java/com/github/copilot/generated/rpc/SessionDebugApi.java rename to java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionDebugApi.java diff --git a/java/src/generated/java/com/github/copilot/generated/rpc/SessionDebugCollectLogsParams.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionDebugCollectLogsParams.java similarity index 100% rename from java/src/generated/java/com/github/copilot/generated/rpc/SessionDebugCollectLogsParams.java rename to java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionDebugCollectLogsParams.java diff --git a/java/src/generated/java/com/github/copilot/generated/rpc/SessionDebugCollectLogsResult.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionDebugCollectLogsResult.java similarity index 100% rename from java/src/generated/java/com/github/copilot/generated/rpc/SessionDebugCollectLogsResult.java rename to java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionDebugCollectLogsResult.java 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 100% 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 diff --git a/java/src/generated/java/com/github/copilot/generated/rpc/SessionEventLogReadParams.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionEventLogReadParams.java similarity index 50% rename from java/src/generated/java/com/github/copilot/generated/rpc/SessionEventLogReadParams.java rename to java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionEventLogReadParams.java index d330d616d1..bbc5abb7c2 100644 --- a/java/src/generated/java/com/github/copilot/generated/rpc/SessionEventLogReadParams.java +++ b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionEventLogReadParams.java @@ -11,6 +11,7 @@ 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; /** @@ -30,11 +31,17 @@ public record SessionEventLogReadParams( @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). */ + /** 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 + @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 0000000000..857578d0fb --- /dev/null +++ b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionEventLogReadResult.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 com.github.copilot.generated.SessionEvent; +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/src/generated/java/com/github/copilot/generated/rpc/SessionEventLogRegisterInterestParams.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionEventLogRegisterInterestParams.java similarity index 100% rename from java/src/generated/java/com/github/copilot/generated/rpc/SessionEventLogRegisterInterestParams.java rename to java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionEventLogRegisterInterestParams.java 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 100% 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 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 100% 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 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 100% 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 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 100% 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 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 100% 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 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 100% 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 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 100% 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 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 100% 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 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 100% 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 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 100% 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 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 100% 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 diff --git a/java/src/generated/java/com/github/copilot/generated/rpc/SessionExtensionsSendAttachmentsToMessageParams.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionExtensionsSendAttachmentsToMessageParams.java similarity index 100% rename from java/src/generated/java/com/github/copilot/generated/rpc/SessionExtensionsSendAttachmentsToMessageParams.java rename to java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionExtensionsSendAttachmentsToMessageParams.java diff --git a/java/src/generated/java/com/github/copilot/generated/rpc/SessionFactoryAgentParams.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionFactoryAgentParams.java similarity index 91% rename from java/src/generated/java/com/github/copilot/generated/rpc/SessionFactoryAgentParams.java rename to java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionFactoryAgentParams.java index 7f31066fc4..6ab02c27eb 100644 --- a/java/src/generated/java/com/github/copilot/generated/rpc/SessionFactoryAgentParams.java +++ b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionFactoryAgentParams.java @@ -28,6 +28,8 @@ public record SessionFactoryAgentParams( @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. */ diff --git a/java/src/generated/java/com/github/copilot/generated/rpc/SessionFactoryAgentResult.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionFactoryAgentResult.java similarity index 100% rename from java/src/generated/java/com/github/copilot/generated/rpc/SessionFactoryAgentResult.java rename to java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionFactoryAgentResult.java 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 0000000000..e9a3e9f08a --- /dev/null +++ b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionFactoryApi.java @@ -0,0 +1,213 @@ +/*--------------------------------------------------------------------------------------------- + * Copyright (c) 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); + } + + /** + * Internal parameters for invoking a registered factory from a tool. + *

+ * 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 runFromTool(SessionFactoryRunFromToolParams params) { + com.fasterxml.jackson.databind.node.ObjectNode _p = MAPPER.valueToTree(params); + _p.put("sessionId", this.sessionId); + return caller.invoke("session.factory.runFromTool", _p, SessionFactoryRunFromToolResult.class); + } + + /** + * Internal parameters for resuming a factory run from a tool. + *

+ * 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 resumeFromTool(SessionFactoryResumeFromToolParams params) { + com.fasterxml.jackson.databind.node.ObjectNode _p = MAPPER.valueToTree(params); + _p.put("sessionId", this.sessionId); + return caller.invoke("session.factory.resumeFromTool", _p, SessionFactoryResumeFromToolResult.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/src/generated/java/com/github/copilot/generated/rpc/SessionFactoryCancelParams.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionFactoryCancelParams.java similarity index 100% rename from java/src/generated/java/com/github/copilot/generated/rpc/SessionFactoryCancelParams.java rename to java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionFactoryCancelParams.java diff --git a/java/src/generated/java/com/github/copilot/generated/rpc/SessionFactoryCancelResult.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionFactoryCancelResult.java similarity index 100% rename from java/src/generated/java/com/github/copilot/generated/rpc/SessionFactoryCancelResult.java rename to java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionFactoryCancelResult.java 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/SessionFactoryGetRunDetailParams.java similarity index 84% 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/SessionFactoryGetRunDetailParams.java index 4ea732727d..b4563d4b35 100644 --- a/java/src/generated/java/com/github/copilot/generated/rpc/SessionModeSetParams.java +++ b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionFactoryGetRunDetailParams.java @@ -14,7 +14,7 @@ import javax.annotation.processing.Generated; /** - * Agent interaction mode to apply to the session. + * Parameters for retrieving a factory run. * * @apiNote This method is experimental and may change in a future version. * @since 1.0.0 @@ -23,10 +23,10 @@ @javax.annotation.processing.Generated("copilot-sdk-codegen") @JsonInclude(JsonInclude.Include.NON_NULL) @JsonIgnoreProperties(ignoreUnknown = true) -public record SessionModeSetParams( +public record SessionFactoryGetRunDetailParams( /** Target session identifier */ @JsonProperty("sessionId") String sessionId, - /** The session mode the agent is operating in */ - @JsonProperty("mode") SessionMode mode + /** 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 0000000000..01204cb832 --- /dev/null +++ b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionFactoryGetRunDetailResult.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.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( + /** Factory run identifier. */ + @JsonProperty("runId") String runId, + /** Registered factory name. */ + @JsonProperty("factoryName") String factoryName, + /** Human-readable factory description. */ + @JsonProperty("description") String description, + /** Current factory run status. */ + @JsonProperty("status") FactoryRunStatus status, + /** Monotonic durable run revision. */ + @JsonProperty("revision") Long revision, + /** Epoch milliseconds when the run was created. */ + @JsonProperty("createdAt") Long createdAt, + /** Epoch milliseconds when execution first started, or null before start. */ + @JsonProperty("startedAt") Long startedAt, + /** Epoch milliseconds when the durable run was last updated. */ + @JsonProperty("updatedAt") Long updatedAt, + /** Epoch milliseconds when the run completed, or null while nonterminal. */ + @JsonProperty("completedAt") Long completedAt, + /** Current phase identity, or null before any phase is entered. */ + @JsonProperty("currentPhase") FactoryCurrentPhase currentPhase, + /** Number of phases declared by the factory. */ + @JsonProperty("declaredPhaseCount") Long declaredPhaseCount, + /** Number of direct factory agents currently live. */ + @JsonProperty("liveAgentCount") Long liveAgentCount, + /** Total direct factory agents spawned across all attempts. */ + @JsonProperty("totalSpawnedAgentCount") Long totalSpawnedAgentCount, + /** Durable resource consumption. */ + @JsonProperty("consumed") FactoryRunConsumed consumed, + /** Resource ceilings declared by the factory. */ + @JsonProperty("declaredLimits") FactoryDeclaredLimits declaredLimits, + /** Approved effective resource ceilings, or null until approved. */ + @JsonProperty("approved") FactoryDeclaredLimits approved, + /** Epoch milliseconds when this live-overlay snapshot was observed. */ + @JsonProperty("observedAt") Long observedAt, + /** Epoch milliseconds when the current active segment started, or null while inactive. */ + @JsonProperty("activeSegmentStartedAt") Long activeSegmentStartedAt, + /** Terminal run outcome, or null while nonterminal. */ + @JsonProperty("terminal") FactoryRunTerminal terminal, + /** Lifecycle and timing observations for each factory phase. */ + @JsonProperty("phases") List phases, + /** Durable identities and live statuses for direct factory agents. */ + @JsonProperty("agents") List agents, + /** Bidirectional page of durable factory progress. */ + @JsonProperty("progress") FactoryProgressPage progress +) { +} diff --git a/java/src/generated/java/com/github/copilot/generated/rpc/SessionFactoryGetRunParams.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionFactoryGetRunParams.java similarity index 100% rename from java/src/generated/java/com/github/copilot/generated/rpc/SessionFactoryGetRunParams.java rename to java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionFactoryGetRunParams.java 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 0000000000..8445943cba --- /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 0000000000..2a4cb78cb2 --- /dev/null +++ b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionFactoryGetRunProgressResult.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; + +/** + * 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( + /** Progress records in sequence order. */ + @JsonProperty("records") List records, + /** Oldest sequence number in this page, or null when empty. */ + @JsonProperty("oldestSeq") Long oldestSeq, + /** Newest sequence number in this page, or null when empty. */ + @JsonProperty("newestSeq") Long newestSeq, + /** Whether progress records older than this page exist. */ + @JsonProperty("hasMoreOlder") Boolean hasMoreOlder, + /** Whether progress records newer than this page exist. */ + @JsonProperty("hasMoreNewer") Boolean hasMoreNewer, + /** Run revision reflected by this page. */ + @JsonProperty("revision") Long revision +) { +} diff --git a/java/src/generated/java/com/github/copilot/generated/rpc/SessionFactoryGetRunResult.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionFactoryGetRunResult.java similarity index 100% rename from java/src/generated/java/com/github/copilot/generated/rpc/SessionFactoryGetRunResult.java rename to java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionFactoryGetRunResult.java diff --git a/java/src/generated/java/com/github/copilot/generated/rpc/SessionFactoryJournalApi.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionFactoryJournalApi.java similarity index 100% rename from java/src/generated/java/com/github/copilot/generated/rpc/SessionFactoryJournalApi.java rename to java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionFactoryJournalApi.java diff --git a/java/src/generated/java/com/github/copilot/generated/rpc/SessionFactoryJournalGetParams.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionFactoryJournalGetParams.java similarity index 90% rename from java/src/generated/java/com/github/copilot/generated/rpc/SessionFactoryJournalGetParams.java rename to java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionFactoryJournalGetParams.java index a9b0acc7c1..251ca946cb 100644 --- a/java/src/generated/java/com/github/copilot/generated/rpc/SessionFactoryJournalGetParams.java +++ b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionFactoryJournalGetParams.java @@ -28,6 +28,8 @@ public record SessionFactoryJournalGetParams( @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/src/generated/java/com/github/copilot/generated/rpc/SessionFactoryJournalGetResult.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionFactoryJournalGetResult.java similarity index 100% rename from java/src/generated/java/com/github/copilot/generated/rpc/SessionFactoryJournalGetResult.java rename to java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionFactoryJournalGetResult.java diff --git a/java/src/generated/java/com/github/copilot/generated/rpc/SessionFactoryJournalPutParams.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionFactoryJournalPutParams.java similarity index 90% rename from java/src/generated/java/com/github/copilot/generated/rpc/SessionFactoryJournalPutParams.java rename to java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionFactoryJournalPutParams.java index 84478dbb7d..06467b2657 100644 --- a/java/src/generated/java/com/github/copilot/generated/rpc/SessionFactoryJournalPutParams.java +++ b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionFactoryJournalPutParams.java @@ -28,6 +28,8 @@ public record SessionFactoryJournalPutParams( @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. */ 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 0000000000..41de4ae4a6 --- /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 0000000000..d081003e47 --- /dev/null +++ b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionFactoryListRunsResult.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; + +/** + * 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( + /** Factory run summaries in durable creation order. */ + @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/src/generated/java/com/github/copilot/generated/rpc/SessionFactoryLogParams.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionFactoryLogParams.java similarity index 90% rename from java/src/generated/java/com/github/copilot/generated/rpc/SessionFactoryLogParams.java rename to java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionFactoryLogParams.java index 7618869e33..b4f52617f1 100644 --- a/java/src/generated/java/com/github/copilot/generated/rpc/SessionFactoryLogParams.java +++ b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionFactoryLogParams.java @@ -29,6 +29,8 @@ public record SessionFactoryLogParams( @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/SessionFactoryResumeFromToolParams.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionFactoryResumeFromToolParams.java new file mode 100644 index 0000000000..3a54179329 --- /dev/null +++ b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionFactoryResumeFromToolParams.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 parameters for resuming a factory run from a tool. + * + * @apiNote This method is experimental and may change in a future version. + * @since 1.0.0 + */ +@CopilotExperimental +@javax.annotation.processing.Generated("copilot-sdk-codegen") +@JsonInclude(JsonInclude.Include.NON_NULL) +@JsonIgnoreProperties(ignoreUnknown = true) +public record SessionFactoryResumeFromToolParams( + /** Target session identifier */ + @JsonProperty("sessionId") String sessionId, + /** Factory run identifier. */ + @JsonProperty("runId") String runId, + /** Optional per-invocation resource ceiling overrides. */ + @JsonProperty("limits") FactoryRunLimits limits, + /** Opaque identifier of the originating tool call. */ + @JsonProperty("toolCallId") String toolCallId +) { +} diff --git a/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionFactoryResumeFromToolResult.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionFactoryResumeFromToolResult.java new file mode 100644 index 0000000000..d4566384c5 --- /dev/null +++ b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionFactoryResumeFromToolResult.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 SessionFactoryResumeFromToolResult( + /** 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/SessionFactoryResumeParams.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionFactoryResumeParams.java new file mode 100644 index 0000000000..edb39e0811 --- /dev/null +++ b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionFactoryResumeParams.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 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, + /** Whether to notify the originating session when the factory completes. */ + @JsonProperty("notifyOnComplete") Boolean notifyOnComplete, + /** Whether to emit factory phase names to the session transcript. */ + @JsonProperty("logPhaseNames") Boolean logPhaseNames +) { +} 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 0000000000..b4cfcae116 --- /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/SessionFactoryRunFromToolParams.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionFactoryRunFromToolParams.java new file mode 100644 index 0000000000..dab8ae120d --- /dev/null +++ b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionFactoryRunFromToolParams.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; + +/** + * Internal parameters for invoking a registered factory from a tool. + * + * @apiNote This method is experimental and may change in a future version. + * @since 1.0.0 + */ +@CopilotExperimental +@javax.annotation.processing.Generated("copilot-sdk-codegen") +@JsonInclude(JsonInclude.Include.NON_NULL) +@JsonIgnoreProperties(ignoreUnknown = true) +public record SessionFactoryRunFromToolParams( + /** Target session identifier */ + @JsonProperty("sessionId") String sessionId, + /** Registered factory name. */ + @JsonProperty("name") String name, + /** Factory input value. */ + @JsonProperty("args") Object args, + /** Tool-originated factory invocation options. */ + @JsonProperty("options") FactoryToolRunOptions options, + /** Opaque identifier of the originating tool call. */ + @JsonProperty("toolCallId") String toolCallId +) { +} diff --git a/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionFactoryRunFromToolResult.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionFactoryRunFromToolResult.java new file mode 100644 index 0000000000..71b12f94f1 --- /dev/null +++ b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionFactoryRunFromToolResult.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 SessionFactoryRunFromToolResult( + /** 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/SessionFactoryRunParams.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionFactoryRunParams.java similarity index 100% rename from java/src/generated/java/com/github/copilot/generated/rpc/SessionFactoryRunParams.java rename to java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionFactoryRunParams.java diff --git a/java/src/generated/java/com/github/copilot/generated/rpc/SessionFactoryRunResult.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionFactoryRunResult.java similarity index 100% rename from java/src/generated/java/com/github/copilot/generated/rpc/SessionFactoryRunResult.java rename to java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionFactoryRunResult.java 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 100% 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 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 100% 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 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 100% 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 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 100% 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 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 100% 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 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 100% 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 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 100% 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 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 100% 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 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 100% 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 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 100% 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 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 100% 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 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 100% 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 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 100% 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 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 100% 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 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 100% 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 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 100% 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 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 100% 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 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 100% 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 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 100% 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 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 100% 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 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 93% 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 47e30ebca5..9258635886 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 @@ -15,7 +15,7 @@ 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 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 91% 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 index 53370c0984..ff14d3ec1b 100644 --- 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 @@ -10,7 +10,6 @@ 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; @@ -18,10 +17,8 @@ /** * Query results including rows, columns, and rows affected, or a filesystem error if execution 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/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 0000000000..e25eaed867 --- /dev/null +++ b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionFsSqliteTransactionError.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; + +/** + * 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( + /** Machine-readable classification of the transaction failure. */ + @JsonProperty("errorClass") SessionFsSqliteTransactionErrorClass errorClass, + /** Human-readable transaction failure message. */ + @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 0000000000..4e184a19a4 --- /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 0000000000..f7699ff8f0 --- /dev/null +++ b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionFsSqliteTransactionParams.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; + +/** + * 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, + /** Ordered SQL statements to execute in one transaction. */ + @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 0000000000..1b662f4047 --- /dev/null +++ b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionFsSqliteTransactionResult.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; + +/** + * 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( + /** Per-statement query results in input order. */ + @JsonProperty("results") List results, + /** Classified transaction failure, when execution did not succeed. */ + @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 0000000000..f56f268ba1 --- /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 100% 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 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 100% 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 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 100% 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 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 0000000000..729979b5e2 --- /dev/null +++ b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionGitHubAuthApi.java @@ -0,0 +1,164 @@ +/*--------------------------------------------------------------------------------------------- + * Copyright (c) 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 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); + } + + /** + * Identifies the target session. + * + * @apiNote This method is experimental and may change in a future version. + * @since 1.0.0 + */ + @CopilotExperimental + public CompletableFuture getCurrentAuthInfo() { + return caller.invoke("session.gitHubAuth.getCurrentAuthInfo", 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> getAllAuthAvailable() { + return caller.invoke("session.gitHubAuth.getAllAuthAvailable", java.util.Map.of("sessionId", this.sessionId), RpcMapper.INSTANCE.getTypeFactory().constructCollectionType(List.class, SessionAuthStatus.class)); + } + + /** + * Identifies the target session. + * + * @apiNote This method is experimental and may change in a future version. + * @since 1.0.0 + */ + @CopilotExperimental + public CompletableFuture refreshCopilotUser() { + return caller.invoke("session.gitHubAuth.refreshCopilotUser", java.util.Map.of("sessionId", this.sessionId), Void.class); + } + + /** + * Internal GitHub login 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 login(SessionGitHubAuthLoginParams params) { + com.fasterxml.jackson.databind.node.ObjectNode _p = MAPPER.valueToTree(params); + _p.put("sessionId", this.sessionId); + return caller.invoke("session.gitHubAuth.login", _p, AuthInfo.class); + } + + /** + * Parameters for switching the session's active authentication. + *

+ * 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 switchToAuth(SessionGitHubAuthSwitchToAuthParams params) { + com.fasterxml.jackson.databind.node.ObjectNode _p = MAPPER.valueToTree(params); + _p.put("sessionId", this.sessionId); + return caller.invoke("session.gitHubAuth.switchToAuth", _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 logout() { + return caller.invoke("session.gitHubAuth.logout", java.util.Map.of("sessionId", this.sessionId), Void.class); + } + + /** + * Parameters identifying a GitHub authentication to log out. + *

+ * 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 logoutUser(SessionGitHubAuthLogoutUserParams params) { + com.fasterxml.jackson.databind.node.ObjectNode _p = MAPPER.valueToTree(params); + _p.put("sessionId", this.sessionId); + return caller.invoke("session.gitHubAuth.logoutUser", _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> lastAuthErrors() { + return caller.invoke("session.gitHubAuth.lastAuthErrors", java.util.Map.of("sessionId", this.sessionId), RpcMapper.INSTANCE.getTypeFactory().constructCollectionType(List.class, AuthValidationError.class)); + } + +} diff --git a/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionGitHubAuthGetAllAuthAvailableParams.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionGitHubAuthGetAllAuthAvailableParams.java new file mode 100644 index 0000000000..446642d743 --- /dev/null +++ b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionGitHubAuthGetAllAuthAvailableParams.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 SessionGitHubAuthGetAllAuthAvailableParams( + /** Target session identifier */ + @JsonProperty("sessionId") String sessionId +) { +} diff --git a/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionGitHubAuthGetCurrentAuthInfoParams.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionGitHubAuthGetCurrentAuthInfoParams.java new file mode 100644 index 0000000000..88838f951d --- /dev/null +++ b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionGitHubAuthGetCurrentAuthInfoParams.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 SessionGitHubAuthGetCurrentAuthInfoParams( + /** Target session identifier */ + @JsonProperty("sessionId") String sessionId +) { +} diff --git a/java/src/generated/java/com/github/copilot/generated/rpc/SessionGitHubAuthGetStatusParams.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionGitHubAuthGetStatusParams.java similarity index 100% rename from java/src/generated/java/com/github/copilot/generated/rpc/SessionGitHubAuthGetStatusParams.java rename to java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionGitHubAuthGetStatusParams.java diff --git a/java/src/generated/java/com/github/copilot/generated/rpc/SessionGitHubAuthGetStatusResult.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionGitHubAuthGetStatusResult.java similarity index 100% rename from java/src/generated/java/com/github/copilot/generated/rpc/SessionGitHubAuthGetStatusResult.java rename to java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionGitHubAuthGetStatusResult.java diff --git a/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionGitHubAuthLastAuthErrorsParams.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionGitHubAuthLastAuthErrorsParams.java new file mode 100644 index 0000000000..d4fc156b28 --- /dev/null +++ b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionGitHubAuthLastAuthErrorsParams.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 SessionGitHubAuthLastAuthErrorsParams( + /** Target session identifier */ + @JsonProperty("sessionId") String sessionId +) { +} diff --git a/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionGitHubAuthLoginParams.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionGitHubAuthLoginParams.java new file mode 100644 index 0000000000..e0d777956f --- /dev/null +++ b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionGitHubAuthLoginParams.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; + +/** + * Internal GitHub login 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 SessionGitHubAuthLoginParams( + /** Target session identifier */ + @JsonProperty("sessionId") String sessionId, + /** GitHub host URL */ + @JsonProperty("host") String host, + /** GitHub login */ + @JsonProperty("login") String login, + /** GitHub authentication token */ + @JsonProperty("token") String token, + /** Whether to persist the token after login */ + @JsonProperty("persist") Boolean persist +) { +} diff --git a/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionGitHubAuthLogoutParams.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionGitHubAuthLogoutParams.java new file mode 100644 index 0000000000..172778d616 --- /dev/null +++ b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionGitHubAuthLogoutParams.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 SessionGitHubAuthLogoutParams( + /** Target session identifier */ + @JsonProperty("sessionId") String sessionId +) { +} diff --git a/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionGitHubAuthLogoutUserParams.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionGitHubAuthLogoutUserParams.java new file mode 100644 index 0000000000..1aafec7811 --- /dev/null +++ b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionGitHubAuthLogoutUserParams.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 identifying a GitHub authentication 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 SessionGitHubAuthLogoutUserParams( + /** Target session identifier */ + @JsonProperty("sessionId") String sessionId, + /** Authentication information to log out */ + @JsonProperty("authInfo") Object authInfo +) { +} diff --git a/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionGitHubAuthRefreshCopilotUserParams.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionGitHubAuthRefreshCopilotUserParams.java new file mode 100644 index 0000000000..d0b9d33e56 --- /dev/null +++ b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionGitHubAuthRefreshCopilotUserParams.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 SessionGitHubAuthRefreshCopilotUserParams( + /** Target session identifier */ + @JsonProperty("sessionId") String sessionId +) { +} diff --git a/java/src/generated/java/com/github/copilot/generated/rpc/SessionGitHubAuthSetCredentialsParams.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionGitHubAuthSetCredentialsParams.java similarity index 100% rename from java/src/generated/java/com/github/copilot/generated/rpc/SessionGitHubAuthSetCredentialsParams.java rename to java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionGitHubAuthSetCredentialsParams.java diff --git a/java/src/generated/java/com/github/copilot/generated/rpc/SessionGitHubAuthSetCredentialsResult.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionGitHubAuthSetCredentialsResult.java similarity index 100% rename from java/src/generated/java/com/github/copilot/generated/rpc/SessionGitHubAuthSetCredentialsResult.java rename to java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionGitHubAuthSetCredentialsResult.java diff --git a/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionGitHubAuthSwitchToAuthParams.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionGitHubAuthSwitchToAuthParams.java new file mode 100644 index 0000000000..7cd6f72b41 --- /dev/null +++ b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionGitHubAuthSwitchToAuthParams.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 switching the session's active 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 SessionGitHubAuthSwitchToAuthParams( + /** Target session identifier */ + @JsonProperty("sessionId") String sessionId, + /** Authentication information to activate */ + @JsonProperty("authInfo") Object authInfo, + /** Optional token paired with the authentication information */ + @JsonProperty("token") String token +) { +} 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 100% 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 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 100% 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 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 0000000000..ad44d864de --- /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 100% 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 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 100% 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 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 0000000000..e52c27ecec --- /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 0000000000..4b3d8502cd --- /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 0000000000..d25c80b55a --- /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 100% 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 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 0000000000..d780d76b38 --- /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 0000000000..99dcc0fabf --- /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 0000000000..dd92709e2b --- /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 0000000000..976597c4fa --- /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 0000000000..bf93f3e245 --- /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 0000000000..d069ca9928 --- /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 100% 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 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 100% 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 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 100% 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 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 0000000000..f5ae17d622 --- /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/src/generated/java/com/github/copilot/generated/rpc/SessionInstalledPlugin.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionInstalledPlugin.java similarity index 61% rename from java/src/generated/java/com/github/copilot/generated/rpc/SessionInstalledPlugin.java rename to java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionInstalledPlugin.java index ee1bc71544..db8ea12026 100644 --- a/java/src/generated/java/com/github/copilot/generated/rpc/SessionInstalledPlugin.java +++ b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionInstalledPlugin.java @@ -34,6 +34,10 @@ public record SessionInstalledPlugin( /** 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 + @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, + /** Absolute path of the marketplace directory a live plugin was resolved from. Present only on live, never-persisted records β€” those synthesized at session start for a directory/local marketplace, whose cache_path points at the real plugin directory on disk rather than a copy under the installed-plugins cache. Its presence is what marks a record as live, and no record carrying it is ever written to the persisted installedPlugins key. */ + @JsonProperty("installed_from") String installedFrom ) { } 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 100% 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 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 100% 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 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 100% 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 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 0000000000..6e16ad1dd8 --- /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 0000000000..a57804cf82 --- /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/src/generated/java/com/github/copilot/generated/rpc/SessionGitHubAuthApi.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionLimitPredictionApi.java similarity index 59% rename from java/src/generated/java/com/github/copilot/generated/rpc/SessionGitHubAuthApi.java rename to java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionLimitPredictionApi.java index 93fb871501..a64f82afae 100644 --- a/java/src/generated/java/com/github/copilot/generated/rpc/SessionGitHubAuthApi.java +++ b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionLimitPredictionApi.java @@ -12,12 +12,12 @@ import javax.annotation.processing.Generated; /** - * API methods for the {@code gitHubAuth} namespace. + * API methods for the {@code limitPrediction} namespace. * * @since 1.0.0 */ @javax.annotation.processing.Generated("copilot-sdk-codegen") -public final class SessionGitHubAuthApi { +public final class SessionLimitPredictionApi { private static final com.fasterxml.jackson.databind.ObjectMapper MAPPER = RpcMapper.INSTANCE; @@ -25,24 +25,26 @@ public final class SessionGitHubAuthApi { private final String sessionId; /** @param caller the RPC transport function */ - SessionGitHubAuthApi(RpcCaller caller, String sessionId) { + SessionLimitPredictionApi(RpcCaller caller, String sessionId) { this.caller = caller; this.sessionId = sessionId; } /** - * Identifies the target session. + * 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 getStatus() { - return caller.invoke("session.gitHubAuth.getStatus", java.util.Map.of("sessionId", this.sessionId), SessionGitHubAuthGetStatusResult.class); + public CompletableFuture predict() { + return predict(null); } /** - * New auth credentials to install on the session. Omit to leave credentials unchanged. + * 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. @@ -51,10 +53,10 @@ public CompletableFuture getStatus() { * @since 1.0.0 */ @CopilotExperimental - public CompletableFuture setCredentials(SessionGitHubAuthSetCredentialsParams params) { - com.fasterxml.jackson.databind.node.ObjectNode _p = MAPPER.valueToTree(params); + 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.gitHubAuth.setCredentials", _p, SessionGitHubAuthSetCredentialsResult.class); + 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 0000000000..2387c5498c --- /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 0000000000..539602931d --- /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 0000000000..f4329bb71b --- /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 0000000000..b02e82ca84 --- /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 0000000000..0c2f489d9f --- /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 0000000000..632018f4d0 --- /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 0000000000..3f4b3ebe2e --- /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 0000000000..c22baa1183 --- /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 0000000000..21d3de43c4 --- /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 0000000000..ad2a6f82c1 --- /dev/null +++ b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionLimitPredictionTierOption.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; + +/** + * 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( + /** Semantic usage tier. */ + @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 0000000000..76ee7c8820 --- /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/src/generated/java/com/github/copilot/generated/rpc/SessionLimitsConfig.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionLimitsConfig.java similarity index 100% rename from java/src/generated/java/com/github/copilot/generated/rpc/SessionLimitsConfig.java rename to java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionLimitsConfig.java 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 0000000000..c5b92cb042 --- /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 100% 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 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 100% 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 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 100% 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 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 100% 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 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 0000000000..8d52a1eb1e --- /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. `allow-auto-only` blocks full allow-all but permits advisory auto-approval. Any other value is accepted rather than failing the session, but is enforced as `disable`: the key is only present to restrict something, so a mode this runtime cannot interpret fails closed to the most restrictive one it knows. Omit the key entirely to impose no restriction. */ + @JsonProperty("disableBypassPermissionsMode") String 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 0000000000..cecaca8c17 --- /dev/null +++ b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionManagedSettings.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; + +/** + * 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( + /** Managed permission policy injected by the SDK host. */ + @JsonProperty("permissions") SessionManagedPermissions permissions +) { +} diff --git a/java/src/generated/java/com/github/copilot/generated/rpc/SessionMcpApi.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionMcpApi.java similarity index 94% rename from java/src/generated/java/com/github/copilot/generated/rpc/SessionMcpApi.java rename to java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionMcpApi.java index 172f6e5075..ed66b7bc15 100644 --- a/java/src/generated/java/com/github/copilot/generated/rpc/SessionMcpApi.java +++ b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionMcpApi.java @@ -113,6 +113,17 @@ public CompletableFuture reload() { return caller.invoke("session.mcp.reload", 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 moveLoadingToBackground() { + return caller.invoke("session.mcp.moveLoadingToBackground", java.util.Map.of("sessionId", this.sessionId), SessionMcpMoveLoadingToBackgroundResult.class); + } + /** * Opaque MCP reload configuration. *

@@ -189,7 +200,7 @@ public CompletableFuture removeGitHub() { } /** - * Opaque auth info used to configure GitHub MCP. + * Credential-free authentication identity 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. @@ -205,7 +216,7 @@ public CompletableFuture configureGitHub(Sessio } /** - * Server name and configuration for an individual MCP server start. + * 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. 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 100% 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 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 100% 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 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 100% 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 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 100% 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 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 100% 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 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 100% 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 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 100% 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 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 100% 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 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 100% 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 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 100% 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 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 100% 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 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 100% 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 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 100% 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 diff --git a/java/src/generated/java/com/github/copilot/generated/rpc/SessionMcpConfigureGitHubParams.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionMcpConfigureGitHubParams.java similarity index 94% rename from java/src/generated/java/com/github/copilot/generated/rpc/SessionMcpConfigureGitHubParams.java rename to java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionMcpConfigureGitHubParams.java index 2f709a8dda..e46a0af8f0 100644 --- a/java/src/generated/java/com/github/copilot/generated/rpc/SessionMcpConfigureGitHubParams.java +++ b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionMcpConfigureGitHubParams.java @@ -14,7 +14,7 @@ import javax.annotation.processing.Generated; /** - * Opaque auth info used to configure GitHub MCP. + * Credential-free authentication identity used to configure GitHub MCP. * * @apiNote This method is experimental and may change in a future version. * @since 1.0.0 diff --git a/java/src/generated/java/com/github/copilot/generated/rpc/SessionMcpConfigureGitHubResult.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionMcpConfigureGitHubResult.java similarity index 100% rename from java/src/generated/java/com/github/copilot/generated/rpc/SessionMcpConfigureGitHubResult.java rename to java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionMcpConfigureGitHubResult.java 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 100% 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 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 100% 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 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 100% 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 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 100% 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 diff --git a/java/src/generated/java/com/github/copilot/generated/rpc/SessionMcpHeadersApi.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionMcpHeadersApi.java similarity index 100% rename from java/src/generated/java/com/github/copilot/generated/rpc/SessionMcpHeadersApi.java rename to java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionMcpHeadersApi.java diff --git a/java/src/generated/java/com/github/copilot/generated/rpc/SessionMcpHeadersHandlePendingHeadersRefreshRequestParams.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionMcpHeadersHandlePendingHeadersRefreshRequestParams.java similarity index 100% rename from java/src/generated/java/com/github/copilot/generated/rpc/SessionMcpHeadersHandlePendingHeadersRefreshRequestParams.java rename to java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionMcpHeadersHandlePendingHeadersRefreshRequestParams.java diff --git a/java/src/generated/java/com/github/copilot/generated/rpc/SessionMcpHeadersHandlePendingHeadersRefreshRequestResult.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionMcpHeadersHandlePendingHeadersRefreshRequestResult.java similarity index 100% rename from java/src/generated/java/com/github/copilot/generated/rpc/SessionMcpHeadersHandlePendingHeadersRefreshRequestResult.java rename to java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionMcpHeadersHandlePendingHeadersRefreshRequestResult.java diff --git a/java/src/generated/java/com/github/copilot/generated/rpc/SessionMcpIsServerRunningParams.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionMcpIsServerRunningParams.java similarity index 100% rename from java/src/generated/java/com/github/copilot/generated/rpc/SessionMcpIsServerRunningParams.java rename to java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionMcpIsServerRunningParams.java diff --git a/java/src/generated/java/com/github/copilot/generated/rpc/SessionMcpIsServerRunningResult.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionMcpIsServerRunningResult.java similarity index 100% rename from java/src/generated/java/com/github/copilot/generated/rpc/SessionMcpIsServerRunningResult.java rename to java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionMcpIsServerRunningResult.java 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 100% 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 diff --git a/java/src/generated/java/com/github/copilot/generated/rpc/SessionMcpListResult.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionMcpListResult.java similarity index 100% rename from java/src/generated/java/com/github/copilot/generated/rpc/SessionMcpListResult.java rename to java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionMcpListResult.java diff --git a/java/src/generated/java/com/github/copilot/generated/rpc/SessionMcpListToolsParams.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionMcpListToolsParams.java similarity index 100% rename from java/src/generated/java/com/github/copilot/generated/rpc/SessionMcpListToolsParams.java rename to java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionMcpListToolsParams.java diff --git a/java/src/generated/java/com/github/copilot/generated/rpc/SessionMcpListToolsResult.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionMcpListToolsResult.java similarity index 100% rename from java/src/generated/java/com/github/copilot/generated/rpc/SessionMcpListToolsResult.java rename to java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionMcpListToolsResult.java diff --git a/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionMcpMoveLoadingToBackgroundParams.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionMcpMoveLoadingToBackgroundParams.java new file mode 100644 index 0000000000..9c3305c3bd --- /dev/null +++ b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionMcpMoveLoadingToBackgroundParams.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 SessionMcpMoveLoadingToBackgroundParams( + /** Target session identifier */ + @JsonProperty("sessionId") String sessionId +) { +} diff --git a/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionMcpMoveLoadingToBackgroundResult.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionMcpMoveLoadingToBackgroundResult.java new file mode 100644 index 0000000000..8890481647 --- /dev/null +++ b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionMcpMoveLoadingToBackgroundResult.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 in-flight MCP loading to the background. + * + * @apiNote This method is experimental and may change in a future version. + * @since 1.0.0 + */ +@CopilotExperimental +@javax.annotation.processing.Generated("copilot-sdk-codegen") +@JsonInclude(JsonInclude.Include.NON_NULL) +@JsonIgnoreProperties(ignoreUnknown = true) +public record SessionMcpMoveLoadingToBackgroundResult( + /** Whether an in-flight MCP load was moved to the background, releasing turns that were waiting on it. False when no MCP load was in flight or the waiting turns had already been released. */ + @JsonProperty("movedToBackground") Boolean movedToBackground +) { +} diff --git a/java/src/generated/java/com/github/copilot/generated/rpc/SessionFactoryApi.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionMcpOauthApi.java similarity index 65% rename from java/src/generated/java/com/github/copilot/generated/rpc/SessionFactoryApi.java rename to java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionMcpOauthApi.java index 703a2e711e..cf4a3601ef 100644 --- a/java/src/generated/java/com/github/copilot/generated/rpc/SessionFactoryApi.java +++ b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionMcpOauthApi.java @@ -12,30 +12,26 @@ import javax.annotation.processing.Generated; /** - * API methods for the {@code factory} namespace. + * API methods for the {@code mcp.oauth} namespace. * * @since 1.0.0 */ @javax.annotation.processing.Generated("copilot-sdk-codegen") -public final class SessionFactoryApi { +public final class SessionMcpOauthApi { 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) { + SessionMcpOauthApi(RpcCaller caller, String sessionId) { this.caller = caller; this.sessionId = sessionId; - this.journal = new SessionFactoryJournalApi(caller, sessionId); } /** - * Parameters for invoking a registered factory. + * 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. @@ -44,14 +40,14 @@ public final class SessionFactoryApi { * @since 1.0.0 */ @CopilotExperimental - public CompletableFuture run(SessionFactoryRunParams params) { + public CompletableFuture handlePendingRequest(SessionMcpOauthHandlePendingRequestParams 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); + return caller.invoke("session.mcp.oauth.handlePendingRequest", _p, SessionMcpOauthHandlePendingRequestResult.class); } /** - * Parameters for retrieving a factory run. + * 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. @@ -60,14 +56,14 @@ public CompletableFuture run(SessionFactoryRunParams pa * @since 1.0.0 */ @CopilotExperimental - public CompletableFuture getRun(SessionFactoryGetRunParams params) { + public CompletableFuture authenticationStateChanged(SessionMcpOauthAuthenticationStateChangedParams 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); + return caller.invoke("session.mcp.oauth.authenticationStateChanged", _p, Void.class); } /** - * Parameters for cancelling a factory run. + * 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. @@ -76,14 +72,14 @@ public CompletableFuture getRun(SessionFactoryGetRun * @since 1.0.0 */ @CopilotExperimental - public CompletableFuture cancel(SessionFactoryCancelParams params) { + public CompletableFuture login(SessionMcpOauthLoginParams 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); + return caller.invoke("session.mcp.oauth.login", _p, SessionMcpOauthLoginResult.class); } /** - * Parameters for recording factory progress. + * Remote MCP server name for a passive OAuth status probe. *

* Note: the {@code sessionId} field in the params record is overridden * by the session-scoped wrapper; any value provided is ignored. @@ -92,14 +88,14 @@ public CompletableFuture cancel(SessionFactoryCancel * @since 1.0.0 */ @CopilotExperimental - public CompletableFuture log(SessionFactoryLogParams params) { + public CompletableFuture probe(SessionMcpOauthProbeParams 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); + return caller.invoke("session.mcp.oauth.probe", _p, McpOauthProbeResult.class); } /** - * Parameters for one factory-scoped subagent call. + * 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. @@ -108,10 +104,10 @@ public CompletableFuture log(SessionFactoryLogParams params) { * @since 1.0.0 */ @CopilotExperimental - public CompletableFuture agent(SessionFactoryAgentParams params) { + public CompletableFuture respond(SessionMcpOauthRespondParams 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); + 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 0000000000..b773e1bf77 --- /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/src/generated/java/com/github/copilot/generated/rpc/SessionMcpOauthHandlePendingRequestParams.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionMcpOauthHandlePendingRequestParams.java similarity index 100% rename from java/src/generated/java/com/github/copilot/generated/rpc/SessionMcpOauthHandlePendingRequestParams.java rename to java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionMcpOauthHandlePendingRequestParams.java diff --git a/java/src/generated/java/com/github/copilot/generated/rpc/SessionMcpOauthHandlePendingRequestResult.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionMcpOauthHandlePendingRequestResult.java similarity index 100% rename from java/src/generated/java/com/github/copilot/generated/rpc/SessionMcpOauthHandlePendingRequestResult.java rename to java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionMcpOauthHandlePendingRequestResult.java diff --git a/java/src/generated/java/com/github/copilot/generated/rpc/SessionMcpOauthLoginParams.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionMcpOauthLoginParams.java similarity index 100% rename from java/src/generated/java/com/github/copilot/generated/rpc/SessionMcpOauthLoginParams.java rename to java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionMcpOauthLoginParams.java 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 100% 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 diff --git a/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionMcpOauthProbeParams.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionMcpOauthProbeParams.java new file mode 100644 index 0000000000..1980398e08 --- /dev/null +++ b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionMcpOauthProbeParams.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; + +/** + * Remote MCP server name for a passive OAuth status probe. + * + * @apiNote This method is experimental and may change in a future version. + * @since 1.0.0 + */ +@CopilotExperimental +@javax.annotation.processing.Generated("copilot-sdk-codegen") +@JsonInclude(JsonInclude.Include.NON_NULL) +@JsonIgnoreProperties(ignoreUnknown = true) +public record SessionMcpOauthProbeParams( + /** Target session identifier */ + @JsonProperty("sessionId") String sessionId, + /** Name of the configured remote MCP server to probe. */ + @JsonProperty("serverName") String serverName +) { +} 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 0000000000..ca79468c15 --- /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 0000000000..1b1267cb57 --- /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/src/generated/java/com/github/copilot/generated/rpc/SessionMcpRegisterExternalClientParams.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionMcpRegisterExternalClientParams.java similarity index 100% rename from java/src/generated/java/com/github/copilot/generated/rpc/SessionMcpRegisterExternalClientParams.java rename to java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionMcpRegisterExternalClientParams.java 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 100% 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 diff --git a/java/src/generated/java/com/github/copilot/generated/rpc/SessionMcpReloadWithConfigParams.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionMcpReloadWithConfigParams.java similarity index 100% rename from java/src/generated/java/com/github/copilot/generated/rpc/SessionMcpReloadWithConfigParams.java rename to java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionMcpReloadWithConfigParams.java diff --git a/java/src/generated/java/com/github/copilot/generated/rpc/SessionMcpReloadWithConfigResult.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionMcpReloadWithConfigResult.java similarity index 90% rename from java/src/generated/java/com/github/copilot/generated/rpc/SessionMcpReloadWithConfigResult.java rename to java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionMcpReloadWithConfigResult.java index ba4fcf3b79..eba9a21c11 100644 --- a/java/src/generated/java/com/github/copilot/generated/rpc/SessionMcpReloadWithConfigResult.java +++ b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionMcpReloadWithConfigResult.java @@ -28,6 +28,8 @@ public record SessionMcpReloadWithConfigResult( /** Servers filtered out before startup */ @JsonProperty("filteredServers") List filteredServers, /** Non-default servers allowed by policy */ - @JsonProperty("allowedServers") List allowedServers + @JsonProperty("allowedServers") List allowedServers, + /** Servers whose connection attempt failed. */ + @JsonProperty("failedServers") List failedServers ) { } 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 100% 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 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 100% 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 diff --git a/java/src/generated/java/com/github/copilot/generated/rpc/SessionMcpResourcesApi.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionMcpResourcesApi.java similarity index 100% rename from java/src/generated/java/com/github/copilot/generated/rpc/SessionMcpResourcesApi.java rename to java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionMcpResourcesApi.java diff --git a/java/src/generated/java/com/github/copilot/generated/rpc/SessionMcpResourcesListParams.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionMcpResourcesListParams.java similarity index 100% rename from java/src/generated/java/com/github/copilot/generated/rpc/SessionMcpResourcesListParams.java rename to java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionMcpResourcesListParams.java diff --git a/java/src/generated/java/com/github/copilot/generated/rpc/SessionMcpResourcesListResult.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionMcpResourcesListResult.java similarity index 100% rename from java/src/generated/java/com/github/copilot/generated/rpc/SessionMcpResourcesListResult.java rename to java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionMcpResourcesListResult.java diff --git a/java/src/generated/java/com/github/copilot/generated/rpc/SessionMcpResourcesListTemplatesParams.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionMcpResourcesListTemplatesParams.java similarity index 100% rename from java/src/generated/java/com/github/copilot/generated/rpc/SessionMcpResourcesListTemplatesParams.java rename to java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionMcpResourcesListTemplatesParams.java diff --git a/java/src/generated/java/com/github/copilot/generated/rpc/SessionMcpResourcesListTemplatesResult.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionMcpResourcesListTemplatesResult.java similarity index 100% rename from java/src/generated/java/com/github/copilot/generated/rpc/SessionMcpResourcesListTemplatesResult.java rename to java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionMcpResourcesListTemplatesResult.java diff --git a/java/src/generated/java/com/github/copilot/generated/rpc/SessionMcpResourcesReadParams.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionMcpResourcesReadParams.java similarity index 100% rename from java/src/generated/java/com/github/copilot/generated/rpc/SessionMcpResourcesReadParams.java rename to java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionMcpResourcesReadParams.java diff --git a/java/src/generated/java/com/github/copilot/generated/rpc/SessionMcpResourcesReadResult.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionMcpResourcesReadResult.java similarity index 100% rename from java/src/generated/java/com/github/copilot/generated/rpc/SessionMcpResourcesReadResult.java rename to java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionMcpResourcesReadResult.java diff --git a/java/src/generated/java/com/github/copilot/generated/rpc/SessionMcpRestartServerParams.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionMcpRestartServerParams.java similarity index 100% rename from java/src/generated/java/com/github/copilot/generated/rpc/SessionMcpRestartServerParams.java rename to java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionMcpRestartServerParams.java 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 100% 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 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 100% 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 diff --git a/java/src/generated/java/com/github/copilot/generated/rpc/SessionMcpStartServerParams.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionMcpStartServerParams.java similarity index 82% rename from java/src/generated/java/com/github/copilot/generated/rpc/SessionMcpStartServerParams.java rename to java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionMcpStartServerParams.java index e4c14e30e4..9f6d5d73e4 100644 --- a/java/src/generated/java/com/github/copilot/generated/rpc/SessionMcpStartServerParams.java +++ b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionMcpStartServerParams.java @@ -14,7 +14,7 @@ import javax.annotation.processing.Generated; /** - * Server name and configuration for an individual MCP server start. + * 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 @@ -28,7 +28,7 @@ public record SessionMcpStartServerParams( @JsonProperty("sessionId") String sessionId, /** Name of the MCP server to start */ @JsonProperty("serverName") String serverName, - /** MCP server configuration (stdio process or remote HTTP/SSE) */ + /** 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/src/generated/java/com/github/copilot/generated/rpc/SessionMcpStopServerParams.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionMcpStopServerParams.java similarity index 100% rename from java/src/generated/java/com/github/copilot/generated/rpc/SessionMcpStopServerParams.java rename to java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionMcpStopServerParams.java diff --git a/java/src/generated/java/com/github/copilot/generated/rpc/SessionMcpUnregisterExternalClientParams.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionMcpUnregisterExternalClientParams.java similarity index 100% rename from java/src/generated/java/com/github/copilot/generated/rpc/SessionMcpUnregisterExternalClientParams.java rename to java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionMcpUnregisterExternalClientParams.java diff --git a/java/src/generated/java/com/github/copilot/generated/rpc/SessionMetadataActivityParams.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionMetadataActivityParams.java similarity index 100% rename from java/src/generated/java/com/github/copilot/generated/rpc/SessionMetadataActivityParams.java rename to java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionMetadataActivityParams.java diff --git a/java/src/generated/java/com/github/copilot/generated/rpc/SessionMetadataActivityResult.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionMetadataActivityResult.java similarity index 100% rename from java/src/generated/java/com/github/copilot/generated/rpc/SessionMetadataActivityResult.java rename to java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionMetadataActivityResult.java diff --git a/java/src/generated/java/com/github/copilot/generated/rpc/SessionMetadataApi.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionMetadataApi.java similarity index 100% rename from java/src/generated/java/com/github/copilot/generated/rpc/SessionMetadataApi.java rename to java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionMetadataApi.java 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 100% 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 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 100% 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 diff --git a/java/src/generated/java/com/github/copilot/generated/rpc/SessionMetadataGetContextAttributionParams.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionMetadataGetContextAttributionParams.java similarity index 100% rename from java/src/generated/java/com/github/copilot/generated/rpc/SessionMetadataGetContextAttributionParams.java rename to java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionMetadataGetContextAttributionParams.java diff --git a/java/src/generated/java/com/github/copilot/generated/rpc/SessionMetadataGetContextAttributionResult.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionMetadataGetContextAttributionResult.java similarity index 58% rename from java/src/generated/java/com/github/copilot/generated/rpc/SessionMetadataGetContextAttributionResult.java rename to java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionMetadataGetContextAttributionResult.java index ef7fba44d9..c27f37afb0 100644 --- a/java/src/generated/java/com/github/copilot/generated/rpc/SessionMetadataGetContextAttributionResult.java +++ b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionMetadataGetContextAttributionResult.java @@ -36,12 +36,47 @@ public record SessionMetadataGetContextAttributionResult( 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( diff --git a/java/src/generated/java/com/github/copilot/generated/rpc/SessionMetadataGetContextHeaviestMessagesParams.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionMetadataGetContextHeaviestMessagesParams.java similarity index 100% rename from java/src/generated/java/com/github/copilot/generated/rpc/SessionMetadataGetContextHeaviestMessagesParams.java rename to java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionMetadataGetContextHeaviestMessagesParams.java diff --git a/java/src/generated/java/com/github/copilot/generated/rpc/SessionMetadataGetContextHeaviestMessagesResult.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionMetadataGetContextHeaviestMessagesResult.java similarity index 100% rename from java/src/generated/java/com/github/copilot/generated/rpc/SessionMetadataGetContextHeaviestMessagesResult.java rename to java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionMetadataGetContextHeaviestMessagesResult.java 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 100% 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 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 100% 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 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 100% 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 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 100% 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 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 100% 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 diff --git a/java/src/generated/java/com/github/copilot/generated/rpc/SessionMetadataSetWorkingDirectoryParams.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionMetadataSetWorkingDirectoryParams.java similarity index 100% rename from java/src/generated/java/com/github/copilot/generated/rpc/SessionMetadataSetWorkingDirectoryParams.java rename to java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionMetadataSetWorkingDirectoryParams.java diff --git a/java/src/generated/java/com/github/copilot/generated/rpc/SessionMetadataSetWorkingDirectoryResult.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionMetadataSetWorkingDirectoryResult.java similarity index 100% rename from java/src/generated/java/com/github/copilot/generated/rpc/SessionMetadataSetWorkingDirectoryResult.java rename to java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionMetadataSetWorkingDirectoryResult.java 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 100% 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 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 100% 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 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 91% 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 58311ff651..0f4989a920 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 @@ -51,10 +51,10 @@ public CompletableFuture get() { * @since 1.0.0 */ @CopilotExperimental - public CompletableFuture set(SessionModeSetParams params) { + public CompletableFuture set(SessionModeSetParams params) { com.fasterxml.jackson.databind.node.ObjectNode _p = MAPPER.valueToTree(params); _p.put("sessionId", this.sessionId); - return caller.invoke("session.mode.set", _p, Void.class); + return caller.invoke("session.mode.set", _p, SessionModeSetResult.class); } } 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 100% 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 diff --git a/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionModeSetParams.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionModeSetParams.java new file mode 100644 index 0000000000..4c01d16d03 --- /dev/null +++ b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionModeSetParams.java @@ -0,0 +1,52 @@ +/*--------------------------------------------------------------------------------------------- + * Copyright (c) Microsoft Corporation. All rights reserved. + *--------------------------------------------------------------------------------------------*/ + +// AUTO-GENERATED FILE - DO NOT EDIT +// Generated from: api.schema.json + +package com.github.copilot.generated.rpc; + +import com.fasterxml.jackson.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) +public record SessionModeSetParams( + /** Target session identifier */ + @JsonProperty("sessionId") String sessionId, + /** The session mode the agent is operating in */ + @JsonProperty("mode") SessionMode mode, + /** Session whose plan-mode base state should be inherited. */ + @JsonProperty("inheritPlanBaseFromSessionId") String inheritPlanBaseFromSessionId, + /** Whether a dedicated plan model is configured. */ + @JsonProperty("planModelConfigured") Boolean planModelConfigured, + /** Dedicated model to use in plan mode, when configured. */ + @JsonProperty("planModel") String planModel, + /** Reasoning effort to use with the dedicated plan model. */ + @JsonProperty("planReasoningEffort") String planReasoningEffort, + /** Context tier to use with the dedicated plan model. */ + @JsonProperty("planContextTier") String planContextTier, + /** Explicit response to a model-switch compaction preflight. */ + @JsonProperty("compactionDecision") String compactionDecision, + /** Whether leaving plan mode should restore the session's previous model. */ + @JsonProperty("restorePlanModel") Boolean restorePlanModel, + /** Whether the selected plan model should be persisted. */ + @JsonProperty("persistPlanSelection") Boolean persistPlanSelection, + /** Settings context used when persisting the selected plan model. */ + @JsonProperty("pickerSettingsContext") ModelPickerSettingsContext pickerSettingsContext, + /** Action to perform when leaving plan mode. */ + @JsonProperty("planExitAction") String planExitAction +) { +} diff --git a/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionModeSetResult.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionModeSetResult.java new file mode 100644 index 0000000000..e3af446682 --- /dev/null +++ b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionModeSetResult.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 com.github.copilot.CopilotExperimental; +import java.util.List; +import javax.annotation.processing.Generated; + +/** + * Outcome of a session mode change, including any model switch it triggered and follow-up the host must perform. + * + * @apiNote This method is experimental and may change in a future version. + * @since 1.0.0 + */ +@CopilotExperimental +@javax.annotation.processing.Generated("copilot-sdk-codegen") +@JsonInclude(JsonInclude.Include.NON_NULL) +@JsonIgnoreProperties(ignoreUnknown = true) +public record SessionModeSetResult( + /** Lifecycle status of the requested mode change. */ + @JsonProperty("status") String status, + /** Whether applying the mode changed the active model. */ + @JsonProperty("modelChanged") Boolean modelChanged, + /** Compaction confirmation required before the mode change can complete. */ + @JsonProperty("confirmation") ModelSwitchConfirmation confirmation, + /** User-facing warning produced while applying the mode change. */ + @JsonProperty("warning") String warning, + /** User-facing outcome message for the model switch triggered by the mode change. */ + @JsonProperty("message") String message, + /** Deprecation warnings associated with the model selected by the mode change. */ + @JsonProperty("deprecationWarnings") List deprecationWarnings, + /** Whether the host must defer implementing the requested mode change. */ + @JsonProperty("deferImplementation") Boolean deferImplementation, + /** Whether the host should arm an interactive continuation after the mode change. */ + @JsonProperty("armInteractiveContinuation") Boolean armInteractiveContinuation +) { +} diff --git a/java/src/generated/java/com/github/copilot/generated/rpc/SessionModelApi.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionModelApi.java similarity index 66% rename from java/src/generated/java/com/github/copilot/generated/rpc/SessionModelApi.java rename to java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionModelApi.java index 34be1729de..12777c9a1f 100644 --- a/java/src/generated/java/com/github/copilot/generated/rpc/SessionModelApi.java +++ b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionModelApi.java @@ -57,6 +57,22 @@ public CompletableFuture switchTo(SessionModelSwitch return caller.invoke("session.model.switchTo", _p, SessionModelSwitchToResult.class); } + /** + * Managed, repository, and CLI model overrides to overlay onto the session at startup. + *

+ * 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 applyStartupOverlay(SessionModelApplyStartupOverlayParams params) { + com.fasterxml.jackson.databind.node.ObjectNode _p = MAPPER.valueToTree(params); + _p.put("sessionId", this.sessionId); + return caller.invoke("session.model.applyStartupOverlay", _p, SessionModelApplyStartupOverlayResult.class); + } + /** * Reasoning effort level to apply to the currently selected model. *

@@ -75,13 +91,31 @@ public CompletableFuture setReasoningEffor /** * 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 caller.invoke("session.model.list", java.util.Map.of("sessionId", this.sessionId), SessionModelListResult.class); + 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/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionModelApplyStartupOverlayParams.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionModelApplyStartupOverlayParams.java new file mode 100644 index 0000000000..a1d25ae7ec --- /dev/null +++ b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionModelApplyStartupOverlayParams.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; + +/** + * Managed, repository, and CLI model overrides to overlay onto the session at startup. + * + * @apiNote This method is experimental and may change in a future version. + * @since 1.0.0 + */ +@CopilotExperimental +@javax.annotation.processing.Generated("copilot-sdk-codegen") +@JsonInclude(JsonInclude.Include.NON_NULL) +@JsonIgnoreProperties(ignoreUnknown = true) +public record SessionModelApplyStartupOverlayParams( + /** Target session identifier */ + @JsonProperty("sessionId") String sessionId, + /** Model required by device-managed policy, when configured. */ + @JsonProperty("deviceManagedModel") String deviceManagedModel, + /** Model required by server-managed policy, when configured. */ + @JsonProperty("serverManagedModel") String serverManagedModel, + /** Model selected by repository settings, when configured. */ + @JsonProperty("repoModel") String repoModel, + /** Reasoning effort selected by repository settings, when configured. */ + @JsonProperty("repoReasoningEffort") String repoReasoningEffort, + /** Context tier selected by repository settings, when configured. */ + @JsonProperty("repoContextTier") String repoContextTier, + /** Model explicitly selected by the CLI, when provided. */ + @JsonProperty("cliModel") String cliModel, + /** Whether the overlay is being applied while resuming a deferred session. */ + @JsonProperty("deferredResume") Boolean deferredResume +) { +} diff --git a/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionModelApplyStartupOverlayResult.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionModelApplyStartupOverlayResult.java new file mode 100644 index 0000000000..f29e249c32 --- /dev/null +++ b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionModelApplyStartupOverlayResult.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 com.github.copilot.CopilotExperimental; +import java.util.List; +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 SessionModelApplyStartupOverlayResult( + /** 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, + /** Lifecycle result for the requested switch */ + @JsonProperty("status") String status, + /** Compaction confirmation projection when status is confirmation_required */ + @JsonProperty("confirmation") ModelSwitchConfirmation confirmation, + /** Persistence failure encountered after applying the model switch. */ + @JsonProperty("persistenceError") String persistenceError, + /** User-facing outcome message for the model switch. */ + @JsonProperty("message") String message, + /** User-facing warning produced while applying the model switch. */ + @JsonProperty("warning") String warning, + /** Deprecation warnings associated with the selected model or options. */ + @JsonProperty("deprecationWarnings") List deprecationWarnings +) { +} 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 100% 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 diff --git a/java/src/generated/java/com/github/copilot/generated/rpc/SessionModelGetCurrentResult.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionModelGetCurrentResult.java similarity index 100% rename from java/src/generated/java/com/github/copilot/generated/rpc/SessionModelGetCurrentResult.java rename to java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionModelGetCurrentResult.java diff --git a/java/src/generated/java/com/github/copilot/generated/rpc/SessionModelListParams.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionModelListParams.java similarity index 79% rename from java/src/generated/java/com/github/copilot/generated/rpc/SessionModelListParams.java rename to java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionModelListParams.java index 154ca5c22c..dc521fe2e6 100644 --- a/java/src/generated/java/com/github/copilot/generated/rpc/SessionModelListParams.java +++ b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionModelListParams.java @@ -14,7 +14,7 @@ import javax.annotation.processing.Generated; /** - * Optional listing options. + * 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 @@ -25,6 +25,8 @@ @JsonIgnoreProperties(ignoreUnknown = true) public record SessionModelListParams( /** Target session identifier */ - @JsonProperty("sessionId") String sessionId + @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/src/generated/java/com/github/copilot/generated/rpc/SessionModelListResult.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionModelListResult.java similarity index 100% rename from java/src/generated/java/com/github/copilot/generated/rpc/SessionModelListResult.java rename to java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionModelListResult.java diff --git a/java/src/generated/java/com/github/copilot/generated/rpc/SessionModelPriceCategory.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionModelPriceCategory.java similarity index 92% rename from java/src/generated/java/com/github/copilot/generated/rpc/SessionModelPriceCategory.java rename to java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionModelPriceCategory.java index 295f6a01f0..be637e9488 100644 --- a/java/src/generated/java/com/github/copilot/generated/rpc/SessionModelPriceCategory.java +++ b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionModelPriceCategory.java @@ -21,7 +21,9 @@ @JsonInclude(JsonInclude.Include.NON_NULL) @JsonIgnoreProperties(ignoreUnknown = true) public record SessionModelPriceCategory( + /** CAPI model identifier. */ @JsonProperty("id") String id, + /** Cost category assigned to the model. */ @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 100% 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 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 100% 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 diff --git a/java/src/generated/java/com/github/copilot/generated/rpc/SessionModelSwitchToParams.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionModelSwitchToParams.java similarity index 51% rename from java/src/generated/java/com/github/copilot/generated/rpc/SessionModelSwitchToParams.java rename to java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionModelSwitchToParams.java index 580ab3bab2..a7c60d28cd 100644 --- a/java/src/generated/java/com/github/copilot/generated/rpc/SessionModelSwitchToParams.java +++ b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionModelSwitchToParams.java @@ -28,7 +28,7 @@ public record SessionModelSwitchToParams( @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. "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. */ @JsonProperty("reasoningEffort") String reasoningEffort, /** Reasoning summary mode to request for supported model clients */ @JsonProperty("reasoningSummary") ReasoningSummary reasoningSummary, @@ -37,6 +37,22 @@ public record SessionModelSwitchToParams( /** 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 + @JsonProperty("contextTier") ContextTier contextTier, + /** Origin to record on the effective `session.model_change` event. Defaults to `sdk` when omitted. */ + @JsonProperty("source") ModelChangeSource source, + /** 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, + /** Explicit response to a model-switch compaction preflight. Omit to request a confirmation projection when compaction is necessary. */ + @JsonProperty("compactionDecision") String compactionDecision, + /** When true, evaluate context-window compaction policy before applying the switch. */ + @JsonProperty("runCompactionPreflight") Boolean runCompactionPreflight, + /** Optional repository settings scope to persist after the switch commits. */ + @JsonProperty("repoScope") String repoScope, + /** Settings scope used when persisting the selected model. */ + @JsonProperty("modelChangeScope") String modelChangeScope, + /** Require the target to be currently available and enabled before applying the switch. */ + @JsonProperty("requireAvailable") Boolean requireAvailable, + /** Optional settings context and explicit-override flags used to persist a picker selection. */ + @JsonProperty("pickerPersistence") ModelPickerPersistenceRequest pickerPersistence ) { } 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 0000000000..fb143abc30 --- /dev/null +++ b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionModelSwitchToResult.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 com.github.copilot.CopilotExperimental; +import java.util.List; +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, + /** Lifecycle result for the requested switch */ + @JsonProperty("status") String status, + /** Compaction confirmation projection when status is confirmation_required */ + @JsonProperty("confirmation") ModelSwitchConfirmation confirmation, + /** Persistence failure encountered after applying the model switch. */ + @JsonProperty("persistenceError") String persistenceError, + /** User-facing outcome message for the model switch. */ + @JsonProperty("message") String message, + /** User-facing warning produced while applying the model switch. */ + @JsonProperty("warning") String warning, + /** Deprecation warnings associated with the selected model or options. */ + @JsonProperty("deprecationWarnings") List deprecationWarnings +) { +} 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 100% 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 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 100% 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 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 100% 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 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 100% 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 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 100% 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 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 100% 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 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 0000000000..34706a68e1 --- /dev/null +++ b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionOpenOptions.java @@ -0,0 +1,165 @@ +/*--------------------------------------------------------------------------------------------- + * Copyright (c) Microsoft Corporation. All rights reserved. + *--------------------------------------------------------------------------------------------*/ + +// AUTO-GENERATED FILE - DO NOT EDIT +// Generated from: api.schema.json + +package 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). Conventional `.github/skills/` and `.github/agents/` definitions under each directory also join the session's project catalogs when their existing subsystem gates are enabled: added-root skills require both `enableConfigDiscovery` and effective `enableSkills`; added-root agents require `enableConfigDiscovery`. Supplying a directory therefore activates configuration from it and should be treated as a trust decision. 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 during session creation and cold resume and is not persisted, so a cold resume must re-supply the directories. */ + @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, + /** Origin of the sandbox choice. The runtime uses this only for internal telemetry provenance; managed policy is derived independently. */ + @JsonProperty("sandboxConfigSource") SandboxConfigSource sandboxConfigSource, + /** 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, + /** Built-in skill names to include in this session. When specified, only these runtime-bundled skills are available. Skills from other sources with the same name remain available. */ + @JsonProperty("includedBuiltinSkills") List includedBuiltinSkills, + /** 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 for supported Anthropic and OpenAI models, 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 0000000000..3ee2252d16 --- /dev/null +++ b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionOpenOptionsAdditionalContentExclusionPolicy.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.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( + /** Content-exclusion rules to apply. */ + @JsonProperty("rules") List rules, + /** Opaque policy update timestamp supplied by the host. */ + @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 0000000000..480235747a --- /dev/null +++ b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionOpenOptionsAdditionalContentExclusionPolicyRule.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; + +/** + * 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( + /** Path patterns covered by this rule. */ + @JsonProperty("paths") List paths, + /** Conditions of which at least one must match. */ + @JsonProperty("ifAnyMatch") List ifAnyMatch, + /** Conditions none of which may match. */ + @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 0000000000..a119c9da76 --- /dev/null +++ b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionOpenOptionsAdditionalContentExclusionPolicyRuleSource.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; + +/** + * 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( + /** Name of the policy source. */ + @JsonProperty("name") String name, + /** Type of the policy source. */ + @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 0000000000..66296cd190 --- /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 0000000000..cfbfeaa742 --- /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 0000000000..391e45a290 --- /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 100% 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 diff --git a/java/src/generated/java/com/github/copilot/generated/rpc/SessionOptionsUpdateParams.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionOptionsUpdateParams.java similarity index 89% rename from java/src/generated/java/com/github/copilot/generated/rpc/SessionOptionsUpdateParams.java rename to java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionOptionsUpdateParams.java index fb8c25b3da..2e8a069a4b 100644 --- a/java/src/generated/java/com/github/copilot/generated/rpc/SessionOptionsUpdateParams.java +++ b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionOptionsUpdateParams.java @@ -32,7 +32,7 @@ public record SessionOptionsUpdateParams( @JsonProperty("model") String model, /** Per-property model capability overrides for the selected model. */ @JsonProperty("modelCapabilitiesOverrides") ModelCapabilitiesOverride modelCapabilitiesOverrides, - /** 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. */ @JsonProperty("reasoningEffort") String reasoningEffort, /** Reasoning summary mode for supported model clients. */ @JsonProperty("reasoningSummary") OptionsUpdateReasoningSummary reasoningSummary, @@ -66,12 +66,16 @@ public record SessionOptionsUpdateParams( @JsonProperty("toolFilterPrecedence") OptionsUpdateToolFilterPrecedence toolFilterPrecedence, /** Whether shell-script safety heuristics are enabled. */ @JsonProperty("enableScriptSafety") Boolean enableScriptSafety, - /** Shell init profile (`None` or `NonInteractive`). */ + /** 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, - /** Per-shell process flags (e.g., `pwsh` arguments). */ + /** PowerShell process flags applied to built-in and user-requested shell commands. */ @JsonProperty("shellProcessFlags") List shellProcessFlags, /** Resolved sandbox configuration. */ @JsonProperty("sandboxConfig") SandboxConfig sandboxConfig, + /** Origin of the sandbox choice. The runtime uses this only for internal telemetry provenance; managed policy is derived independently. */ + @JsonProperty("sandboxConfigSource") SandboxConfigSource sandboxConfigSource, /** 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). */ @@ -80,9 +84,11 @@ public record SessionOptionsUpdateParams( @JsonProperty("allowAllMcpServerInstructions") Boolean allowAllMcpServerInstructions, /** Additional directories to search for skills. */ @JsonProperty("skillDirectories") List skillDirectories, + /** Built-in skill names to include in this session. When specified, only these runtime-bundled skills are available. Skills from other sources with the same name remain available. Set to null to remove the allowlist restriction. */ + @JsonProperty("includedBuiltinSkills") List includedBuiltinSkills, /** 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. */ + /** 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, @@ -116,6 +122,8 @@ public record SessionOptionsUpdateParams( @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). */ diff --git a/java/src/generated/java/com/github/copilot/generated/rpc/SessionOptionsUpdateResult.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionOptionsUpdateResult.java similarity index 100% rename from java/src/generated/java/com/github/copilot/generated/rpc/SessionOptionsUpdateResult.java rename to java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionOptionsUpdateResult.java 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 88% 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 aba3177083..8b397f2d4d 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 @@ -103,7 +103,7 @@ public CompletableFuture setApproveAll(Se } /** - * Allow-all mode to apply for the session. + * Permission 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. @@ -112,10 +112,10 @@ public CompletableFuture setApproveAll(Se * @since 1.0.0 */ @CopilotExperimental - public CompletableFuture setAllowAll(SessionPermissionsSetAllowAllParams params) { + public CompletableFuture setMode(SessionPermissionsSetModeParams params) { com.fasterxml.jackson.databind.node.ObjectNode _p = MAPPER.valueToTree(params); _p.put("sessionId", this.sessionId); - return caller.invoke("session.permissions.setAllowAll", _p, SessionPermissionsSetAllowAllResult.class); + return caller.invoke("session.permissions.setMode", _p, SessionPermissionsSetModeResult.class); } /** @@ -125,8 +125,8 @@ public CompletableFuture setAllowAll(Sessio * @since 1.0.0 */ @CopilotExperimental - public CompletableFuture getAllowAll() { - return caller.invoke("session.permissions.getAllowAll", java.util.Map.of("sessionId", this.sessionId), SessionPermissionsGetAllowAllResult.class); + public CompletableFuture getMode() { + return caller.invoke("session.permissions.getMode", java.util.Map.of("sessionId", this.sessionId), SessionPermissionsGetModeResult.class); } /** @@ -162,14 +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 */ @CopilotExperimental - public CompletableFuture resetSessionApprovals() { - return caller.invoke("session.permissions.resetSessionApprovals", java.util.Map.of("sessionId", this.sessionId), SessionPermissionsResetSessionApprovalsResult.class); + 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); } /** 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 100% 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 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 100% 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 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 100% 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 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 100% 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 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 100% 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 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 100% 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 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 100% 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 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/SessionPermissionsGetModeParams.java similarity index 95% 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/SessionPermissionsGetModeParams.java index 761640a4fb..5d41d3c6a2 100644 --- a/java/src/generated/java/com/github/copilot/generated/rpc/SessionPermissionsGetAllowAllParams.java +++ b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionPermissionsGetModeParams.java @@ -23,7 +23,7 @@ @javax.annotation.processing.Generated("copilot-sdk-codegen") @JsonInclude(JsonInclude.Include.NON_NULL) @JsonIgnoreProperties(ignoreUnknown = true) -public record SessionPermissionsGetAllowAllParams( +public record SessionPermissionsGetModeParams( /** Target session identifier */ @JsonProperty("sessionId") String sessionId ) { diff --git a/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionPermissionsGetModeResult.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionPermissionsGetModeResult.java new file mode 100644 index 0000000000..1ccb45375c --- /dev/null +++ b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionPermissionsGetModeResult.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; + +/** + * Current 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 SessionPermissionsGetModeResult( + /** Current permission mode */ + @JsonProperty("mode") PermissionMode mode +) { +} diff --git a/java/src/generated/java/com/github/copilot/generated/rpc/SessionPermissionsHandlePendingPermissionRequestParams.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionPermissionsHandlePendingPermissionRequestParams.java similarity index 82% rename from java/src/generated/java/com/github/copilot/generated/rpc/SessionPermissionsHandlePendingPermissionRequestParams.java rename to java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionPermissionsHandlePendingPermissionRequestParams.java index 075dcee26a..a4d2ba67e5 100644 --- a/java/src/generated/java/com/github/copilot/generated/rpc/SessionPermissionsHandlePendingPermissionRequestParams.java +++ b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionPermissionsHandlePendingPermissionRequestParams.java @@ -29,6 +29,8 @@ public record SessionPermissionsHandlePendingPermissionRequestParams( /** Request ID of the pending permission request */ @JsonProperty("requestId") String requestId, /** The client's response to the pending permission prompt */ - @JsonProperty("result") Object result + @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 100% 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 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 100% 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 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 100% 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 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 100% 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 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 100% 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 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 100% 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 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 100% 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 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 100% 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 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 100% 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 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 100% 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 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 100% 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 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 100% 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 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 82% 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 e5f35a2264..48ee26e0d9 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 @@ -26,7 +26,7 @@ public record SessionPermissionsPathsAddParams( /** Target session identifier */ @JsonProperty("sessionId") String sessionId, - /** Directory to add to the allow-list. The runtime resolves and validates the path before adding. */ + /** Directory to add to the allow-list. The runtime resolves and validates the path before adding, then loads conventional `.github/skills/` and `.github/agents/` definitions under it when their subsystem gates are enabled. Adding the directory is therefore also a trust decision for configuration stored there. */ @JsonProperty("path") String path ) { } 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 100% 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 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 100% 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 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 100% 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 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 100% 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 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 100% 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 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 100% 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 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 100% 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 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 100% 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 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 100% 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 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 100% 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 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 100% 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 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 100% 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 diff --git a/java/src/generated/java/com/github/copilot/generated/rpc/SessionPermissionsResetSessionApprovalsParams.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionPermissionsResetSessionApprovalsParams.java similarity index 78% rename from java/src/generated/java/com/github/copilot/generated/rpc/SessionPermissionsResetSessionApprovalsParams.java rename to java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionPermissionsResetSessionApprovalsParams.java index 881c081ab0..68ef9814d6 100644 --- a/java/src/generated/java/com/github/copilot/generated/rpc/SessionPermissionsResetSessionApprovalsParams.java +++ b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionPermissionsResetSessionApprovalsParams.java @@ -14,7 +14,7 @@ import javax.annotation.processing.Generated; /** - * No parameters; clears all session-scoped tool permission approvals. + * 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 @@ -25,6 +25,8 @@ @JsonIgnoreProperties(ignoreUnknown = true) public record SessionPermissionsResetSessionApprovalsParams( /** Target session identifier */ - @JsonProperty("sessionId") String sessionId + @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 100% 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 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 100% 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 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 100% 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 diff --git a/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionPermissionsSetModeParams.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionPermissionsSetModeParams.java new file mode 100644 index 0000000000..712d460243 --- /dev/null +++ b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionPermissionsSetModeParams.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; + +/** + * Permission 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 SessionPermissionsSetModeParams( + /** Target session identifier */ + @JsonProperty("sessionId") String sessionId, + /** Permission mode to apply */ + @JsonProperty("mode") PermissionMode mode, + /** Optional judge model id for assisted mode. When omitted, the session resolves the provider default: `gpt-5.5` for CAPI sessions and the active session model for BYOK sessions. */ + @JsonProperty("assistedApprovalModel") String assistedApprovalModel, + /** Optional source for permission-mode telemetry. Defaults to `rpc` when omitted for SDK callers. */ + @JsonProperty("source") PermissionModeSource source +) { +} diff --git a/java/src/generated/java/com/github/copilot/generated/rpc/SessionPermissionsSetAllowAllResult.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionPermissionsSetModeResult.java similarity index 73% rename from java/src/generated/java/com/github/copilot/generated/rpc/SessionPermissionsSetAllowAllResult.java rename to java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionPermissionsSetModeResult.java index 9b14d8f6ad..1ee34568ea 100644 --- a/java/src/generated/java/com/github/copilot/generated/rpc/SessionPermissionsSetAllowAllResult.java +++ b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionPermissionsSetModeResult.java @@ -14,7 +14,7 @@ import javax.annotation.processing.Generated; /** - * Indicates whether the operation succeeded and reports the post-mutation state. + * Indicates whether the requested permission mode was applied and reports the authoritative post-mutation mode. * * @apiNote This method is experimental and may change in a future version. * @since 1.0.0 @@ -23,12 +23,10 @@ @javax.annotation.processing.Generated("copilot-sdk-codegen") @JsonInclude(JsonInclude.Include.NON_NULL) @JsonIgnoreProperties(ignoreUnknown = true) -public record SessionPermissionsSetAllowAllResult( +public record SessionPermissionsSetModeResult( /** 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 + /** Authoritative permission mode after the mutation */ + @JsonProperty("mode") PermissionMode mode ) { } 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 100% 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 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 100% 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 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 100% 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 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 100% 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 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 100% 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 diff --git a/java/src/generated/java/com/github/copilot/generated/rpc/SessionPlanApi.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionPlanApi.java similarity index 100% rename from java/src/generated/java/com/github/copilot/generated/rpc/SessionPlanApi.java rename to java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionPlanApi.java 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 100% 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 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 100% 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 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 100% 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 diff --git a/java/src/generated/java/com/github/copilot/generated/rpc/SessionPlanReadSqlTodosParams.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionPlanReadSqlTodosParams.java similarity index 100% rename from java/src/generated/java/com/github/copilot/generated/rpc/SessionPlanReadSqlTodosParams.java rename to java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionPlanReadSqlTodosParams.java diff --git a/java/src/generated/java/com/github/copilot/generated/rpc/SessionPlanReadSqlTodosResult.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionPlanReadSqlTodosResult.java similarity index 91% rename from java/src/generated/java/com/github/copilot/generated/rpc/SessionPlanReadSqlTodosResult.java rename to java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionPlanReadSqlTodosResult.java index 1230bbc02f..48dfd6e809 100644 --- a/java/src/generated/java/com/github/copilot/generated/rpc/SessionPlanReadSqlTodosResult.java +++ b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionPlanReadSqlTodosResult.java @@ -25,7 +25,7 @@ @JsonInclude(JsonInclude.Include.NON_NULL) @JsonIgnoreProperties(ignoreUnknown = true) public record SessionPlanReadSqlTodosResult( - /** Rows from the session SQL todos table, ordered by creation time and id. */ + /** Rows from the session SQL todos table, ordered by creation time with insertion order used to break ties when available and id used for WITHOUT ROWID tables. */ @JsonProperty("rows") List rows ) { } diff --git a/java/src/generated/java/com/github/copilot/generated/rpc/SessionPlanReadSqlTodosWithDependenciesParams.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionPlanReadSqlTodosWithDependenciesParams.java similarity index 100% rename from java/src/generated/java/com/github/copilot/generated/rpc/SessionPlanReadSqlTodosWithDependenciesParams.java rename to java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionPlanReadSqlTodosWithDependenciesParams.java diff --git a/java/src/generated/java/com/github/copilot/generated/rpc/SessionPlanReadSqlTodosWithDependenciesResult.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionPlanReadSqlTodosWithDependenciesResult.java similarity index 89% rename from java/src/generated/java/com/github/copilot/generated/rpc/SessionPlanReadSqlTodosWithDependenciesResult.java rename to java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionPlanReadSqlTodosWithDependenciesResult.java index 505d083036..4e2ad62e0d 100644 --- a/java/src/generated/java/com/github/copilot/generated/rpc/SessionPlanReadSqlTodosWithDependenciesResult.java +++ b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionPlanReadSqlTodosWithDependenciesResult.java @@ -25,7 +25,7 @@ @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. */ + /** Rows from the session SQL todos table, ordered by creation time with insertion order used to break ties when available and id used for WITHOUT ROWID tables. 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 100% 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 diff --git a/java/src/generated/java/com/github/copilot/generated/rpc/SessionPluginsApi.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionPluginsApi.java similarity index 63% rename from java/src/generated/java/com/github/copilot/generated/rpc/SessionPluginsApi.java rename to java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionPluginsApi.java index 0b1e4dfef6..fa4da43dc3 100644 --- a/java/src/generated/java/com/github/copilot/generated/rpc/SessionPluginsApi.java +++ b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionPluginsApi.java @@ -19,6 +19,8 @@ @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; @@ -41,13 +43,31 @@ public CompletableFuture list() { /** * 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 caller.invoke("session.plugins.reload", java.util.Map.of("sessionId", this.sessionId), Void.class); + 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 100% 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 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 100% 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 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 0000000000..b844a21c8b --- /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/src/generated/java/com/github/copilot/generated/rpc/SessionProviderAddParams.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionProviderAddParams.java similarity index 100% rename from java/src/generated/java/com/github/copilot/generated/rpc/SessionProviderAddParams.java rename to java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionProviderAddParams.java diff --git a/java/src/generated/java/com/github/copilot/generated/rpc/SessionProviderAddResult.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionProviderAddResult.java similarity index 100% rename from java/src/generated/java/com/github/copilot/generated/rpc/SessionProviderAddResult.java rename to java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionProviderAddResult.java diff --git a/java/src/generated/java/com/github/copilot/generated/rpc/SessionProviderApi.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionProviderApi.java similarity index 70% rename from java/src/generated/java/com/github/copilot/generated/rpc/SessionProviderApi.java rename to java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionProviderApi.java index 4a6fdc1861..b4c6b8ccdc 100644 --- a/java/src/generated/java/com/github/copilot/generated/rpc/SessionProviderApi.java +++ b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionProviderApi.java @@ -32,13 +32,31 @@ public final class SessionProviderApi { /** * 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 caller.invoke("session.provider.getEndpoint", java.util.Map.of("sessionId", this.sessionId), SessionProviderGetEndpointResult.class); + 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); } /** diff --git a/java/src/generated/java/com/github/copilot/generated/rpc/SessionProviderGetEndpointParams.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionProviderGetEndpointParams.java similarity index 73% rename from java/src/generated/java/com/github/copilot/generated/rpc/SessionProviderGetEndpointParams.java rename to java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionProviderGetEndpointParams.java index 09e992a784..c885b47cd1 100644 --- a/java/src/generated/java/com/github/copilot/generated/rpc/SessionProviderGetEndpointParams.java +++ b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionProviderGetEndpointParams.java @@ -14,7 +14,7 @@ import javax.annotation.processing.Generated; /** - * Optional model identifier to scope the endpoint snapshot to. + * 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 @@ -25,6 +25,8 @@ @JsonIgnoreProperties(ignoreUnknown = true) public record SessionProviderGetEndpointParams( /** Target session identifier */ - @JsonProperty("sessionId") String sessionId + @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/src/generated/java/com/github/copilot/generated/rpc/SessionProviderGetEndpointResult.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionProviderGetEndpointResult.java similarity index 100% rename from java/src/generated/java/com/github/copilot/generated/rpc/SessionProviderGetEndpointResult.java rename to java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionProviderGetEndpointResult.java 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 0000000000..6e40bdfeba --- /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 0000000000..4973e31075 --- /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 0000000000..77e6decb9b --- /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 100% 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 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 0000000000..6449ce7666 --- /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 0000000000..bbc3715880 --- /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 0000000000..7b3dff9ef5 --- /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 0000000000..0187e814b8 --- /dev/null +++ b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionQueueDuplicateAtParams.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 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, + /** Stable opaque ID of the queued item to duplicate. */ + @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 0000000000..0be932f95e --- /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 0000000000..1a0ec546ae --- /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 0000000000..324765b4a2 --- /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 0000000000..b6b29057d8 --- /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 0000000000..1e6cc52577 --- /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/src/generated/java/com/github/copilot/generated/rpc/SessionHistoryCompactParams.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionQueueHasPendingParams.java similarity index 92% rename from java/src/generated/java/com/github/copilot/generated/rpc/SessionHistoryCompactParams.java rename to java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionQueueHasPendingParams.java index 9dc6a0ee94..e587fec4cb 100644 --- a/java/src/generated/java/com/github/copilot/generated/rpc/SessionHistoryCompactParams.java +++ b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionQueueHasPendingParams.java @@ -14,7 +14,7 @@ import javax.annotation.processing.Generated; /** - * Optional compaction parameters. + * Identifies the target session. * * @apiNote This method is experimental and may change in a future version. * @since 1.0.0 @@ -23,7 +23,7 @@ @javax.annotation.processing.Generated("copilot-sdk-codegen") @JsonInclude(JsonInclude.Include.NON_NULL) @JsonIgnoreProperties(ignoreUnknown = true) -public record SessionHistoryCompactParams( +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 0000000000..5373856a45 --- /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 0000000000..11f0f76533 --- /dev/null +++ b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionQueueInsertAtParams.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 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, + /** Queued message contents and delivery metadata. */ + @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 0000000000..1d4805e8cc --- /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 0000000000..0a584f50c8 --- /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/src/generated/java/com/github/copilot/generated/rpc/SessionCommandsListParams.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionQueueMoveItemResult.java similarity index 80% rename from java/src/generated/java/com/github/copilot/generated/rpc/SessionCommandsListParams.java rename to java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionQueueMoveItemResult.java index 6cd085b38e..431a081754 100644 --- a/java/src/generated/java/com/github/copilot/generated/rpc/SessionCommandsListParams.java +++ b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionQueueMoveItemResult.java @@ -14,7 +14,7 @@ import javax.annotation.processing.Generated; /** - * Optional filters controlling which command sources to include in the listing. + * Result of moving a queued item. * * @apiNote This method is experimental and may change in a future version. * @since 1.0.0 @@ -23,8 +23,8 @@ @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 +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 100% 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 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 82% 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 7b096480ca..a74d54e245 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 @@ -28,6 +28,8 @@ public record SessionQueuePendingItemsResult( /** Pending queued items in submission order. Includes user messages, queued slash commands, and queued model changes; omits internal system items. */ @JsonProperty("items") List items, /** Display text for messages currently in the immediate steering queue (interjections sent during a running turn). */ - @JsonProperty("steeringMessages") List steeringMessages + @JsonProperty("steeringMessages") List steeringMessages, + /** How many leading entries of `steeringMessages` have already been folded into the running turn (and so have an emitted `user.message`), as opposed to still waiting for one. Absent for hosts that do not distinguish the two. */ + @JsonProperty("inFlightSteeringCount") Long inFlightSteeringCount ) { } diff --git a/java/src/generated/java/com/github/copilot/generated/rpc/SessionAgentListParams.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionQueueProcessParams.java similarity index 96% rename from java/src/generated/java/com/github/copilot/generated/rpc/SessionAgentListParams.java rename to java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionQueueProcessParams.java index 44636f59d2..8c8edfe554 100644 --- a/java/src/generated/java/com/github/copilot/generated/rpc/SessionAgentListParams.java +++ b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionQueueProcessParams.java @@ -23,7 +23,7 @@ @javax.annotation.processing.Generated("copilot-sdk-codegen") @JsonInclude(JsonInclude.Include.NON_NULL) @JsonIgnoreProperties(ignoreUnknown = true) -public record SessionAgentListParams( +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 0000000000..5e890f85d9 --- /dev/null +++ b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionQueueRemoveAtParams.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 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, + /** Stable opaque ID of the queued item to remove. */ + @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 0000000000..0f5d95487d --- /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 100% 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 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 100% 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 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 0000000000..9d23f47eb4 --- /dev/null +++ b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionQueueSendNowParams.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 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, + /** Stable opaque ID of the queued item to steer into the live turn. */ + @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 0000000000..584bd59d18 --- /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 0000000000..4674978d3e --- /dev/null +++ b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionQueueSetDrainPausedParams.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 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, + /** Whether queued-lane draining should be paused. */ + @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 0000000000..dff5db8a8d --- /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 0000000000..7ae1076d63 --- /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 0000000000..5f315d5724 --- /dev/null +++ b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionQueueUpdateTextParams.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 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, + /** Stable opaque ID of the queued item to edit. */ + @JsonProperty("id") String id, + /** Replacement prompt sent to the model. */ + @JsonProperty("prompt") String prompt, + /** Optional replacement prompt displayed to the user. */ + @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 0000000000..3809f5bd68 --- /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 100% 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 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 100% 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 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 100% 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 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 100% 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 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 100% 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 diff --git a/java/src/generated/java/com/github/copilot/generated/rpc/SessionRpc.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionRpc.java similarity index 83% rename from java/src/generated/java/com/github/copilot/generated/rpc/SessionRpc.java rename to java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionRpc.java index 3ec3464d05..05cfd396d4 100644 --- a/java/src/generated/java/com/github/copilot/generated/rpc/SessionRpc.java +++ b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionRpc.java @@ -85,6 +85,8 @@ public final class SessionRpc { 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. */ @@ -95,6 +97,8 @@ public final class SessionRpc { 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. */ @@ -139,11 +143,13 @@ public SessionRpc(RpcCaller caller, String 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); @@ -192,6 +198,22 @@ public CompletableFuture sendMessages(SessionSendMess 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 *

@@ -208,6 +230,33 @@ public CompletableFuture abort(SessionAbortParams params) { 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 *

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 0000000000..0a099bdf4a --- /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 0000000000..7952fdc88b --- /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 0000000000..08a9cd33bb --- /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 0000000000..193dea1b4c --- /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 0000000000..31580758cb --- /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/src/generated/java/com/github/copilot/generated/rpc/SessionPermissionsGetAllowAllResult.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionScheduleAddResult.java similarity index 75% rename from java/src/generated/java/com/github/copilot/generated/rpc/SessionPermissionsGetAllowAllResult.java rename to java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionScheduleAddResult.java index 28d9915df2..021c784c37 100644 --- a/java/src/generated/java/com/github/copilot/generated/rpc/SessionPermissionsGetAllowAllResult.java +++ b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionScheduleAddResult.java @@ -14,7 +14,7 @@ import javax.annotation.processing.Generated; /** - * Current allow-all permission mode. + * 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 @@ -23,10 +23,10 @@ @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 +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 0000000000..17a89c1b2d --- /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 0000000000..65f8745baf --- /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/src/generated/java/com/github/copilot/generated/rpc/SessionWorkspacesApi.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionScheduleApi.java similarity index 57% rename from java/src/generated/java/com/github/copilot/generated/rpc/SessionWorkspacesApi.java rename to java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionScheduleApi.java index 690328176b..f983f84f71 100644 --- a/java/src/generated/java/com/github/copilot/generated/rpc/SessionWorkspacesApi.java +++ b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionScheduleApi.java @@ -12,12 +12,12 @@ import javax.annotation.processing.Generated; /** - * API methods for the {@code workspaces} namespace. + * API methods for the {@code schedule} namespace. * * @since 1.0.0 */ @javax.annotation.processing.Generated("copilot-sdk-codegen") -public final class SessionWorkspacesApi { +public final class SessionScheduleApi { private static final com.fasterxml.jackson.databind.ObjectMapper MAPPER = RpcMapper.INSTANCE; @@ -25,7 +25,7 @@ public final class SessionWorkspacesApi { private final String sessionId; /** @param caller the RPC transport function */ - SessionWorkspacesApi(RpcCaller caller, String sessionId) { + SessionScheduleApi(RpcCaller caller, String sessionId) { this.caller = caller; this.sessionId = sessionId; } @@ -37,8 +37,8 @@ public final class SessionWorkspacesApi { * @since 1.0.0 */ @CopilotExperimental - public CompletableFuture getWorkspace() { - return caller.invoke("session.workspaces.getWorkspace", java.util.Map.of("sessionId", this.sessionId), SessionWorkspacesGetWorkspaceResult.class); + public CompletableFuture list() { + return caller.invoke("session.schedule.list", java.util.Map.of("sessionId", this.sessionId), SessionScheduleListResult.class); } /** @@ -48,12 +48,23 @@ public CompletableFuture getWorkspace() { * @since 1.0.0 */ @CopilotExperimental - public CompletableFuture listFiles() { - return caller.invoke("session.workspaces.listFiles", java.util.Map.of("sessionId", this.sessionId), SessionWorkspacesListFilesResult.class); + public CompletableFuture hydrate() { + return caller.invoke("session.schedule.hydrate", java.util.Map.of("sessionId", this.sessionId), Void.class); } /** - * Relative path of the workspace file to read. + * 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. @@ -62,14 +73,14 @@ public CompletableFuture listFiles() { * @since 1.0.0 */ @CopilotExperimental - public CompletableFuture readFile(SessionWorkspacesReadFileParams params) { + public CompletableFuture add(SessionScheduleAddParams 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); + return caller.invoke("session.schedule.add", _p, SessionScheduleAddResult.class); } /** - * Relative path and UTF-8 content for the workspace file to create or overwrite. + * 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. @@ -78,25 +89,30 @@ public CompletableFuture readFile(SessionWorksp * @since 1.0.0 */ @CopilotExperimental - public CompletableFuture createFile(SessionWorkspacesCreateFileParams params) { + public CompletableFuture addCron(SessionScheduleAddCronParams 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); + return caller.invoke("session.schedule.addCron", _p, SessionScheduleAddCronResult.class); } /** - * Identifies the target session. + * 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 listCheckpoints() { - return caller.invoke("session.workspaces.listCheckpoints", java.util.Map.of("sessionId", this.sessionId), SessionWorkspacesListCheckpointsResult.class); + 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); } /** - * Checkpoint number to read. + * 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. @@ -105,14 +121,14 @@ public CompletableFuture listCheckpoints * @since 1.0.0 */ @CopilotExperimental - public CompletableFuture readCheckpoint(SessionWorkspacesReadCheckpointParams params) { + public CompletableFuture addSelfPaced(SessionScheduleAddSelfPacedParams 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); + return caller.invoke("session.schedule.addSelfPaced", _p, SessionScheduleAddSelfPacedResult.class); } /** - * Pasted content to save as a UTF-8 file in the session workspace. + * 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. @@ -121,14 +137,14 @@ public CompletableFuture readCheckpoint(S * @since 1.0.0 */ @CopilotExperimental - public CompletableFuture saveLargePaste(SessionWorkspacesSaveLargePasteParams params) { + public CompletableFuture rearmSelfPaced(SessionScheduleRearmSelfPacedParams 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); + return caller.invoke("session.schedule.rearmSelfPaced", _p, SessionScheduleRearmSelfPacedResult.class); } /** - * Parameters for computing a workspace diff. + * 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. @@ -137,10 +153,10 @@ public CompletableFuture saveLargePaste(S * @since 1.0.0 */ @CopilotExperimental - public CompletableFuture diff(SessionWorkspacesDiffParams params) { + public CompletableFuture stop(SessionScheduleStopParams 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); + 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 0000000000..7eb31df7f6 --- /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 0000000000..84c8e7a501 --- /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 0000000000..32ec85c7d4 --- /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 100% 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 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 100% 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 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 0000000000..d1999311c2 --- /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 0000000000..0280fbaccb --- /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 100% 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 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 100% 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 diff --git a/java/src/generated/java/com/github/copilot/generated/rpc/SessionSendMessagesParams.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionSendMessagesParams.java similarity index 84% rename from java/src/generated/java/com/github/copilot/generated/rpc/SessionSendMessagesParams.java rename to java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionSendMessagesParams.java index 2d66b4fe16..2943192041 100644 --- a/java/src/generated/java/com/github/copilot/generated/rpc/SessionSendMessagesParams.java +++ b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionSendMessagesParams.java @@ -42,7 +42,7 @@ public record SessionSendMessagesParams( @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. */ + /** 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/src/generated/java/com/github/copilot/generated/rpc/SessionSendMessagesResult.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionSendMessagesResult.java similarity index 100% rename from java/src/generated/java/com/github/copilot/generated/rpc/SessionSendMessagesResult.java rename to java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionSendMessagesResult.java 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 82% 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 7762c56831..f19c85ebe2 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 @@ -42,7 +42,7 @@ 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. Must match one of three forms: the literal `system`, `command-` for messages originating from a command (e.g. slash command, Mission Control command), or `schedule-` for messages originating from a scheduled job. */ + /** 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, @@ -52,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 100% 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 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 0000000000..762fe6ef39 --- /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/src/generated/java/com/github/copilot/generated/rpc/SessionSettingsApi.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionSettingsApi.java similarity index 100% rename from java/src/generated/java/com/github/copilot/generated/rpc/SessionSettingsApi.java rename to java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionSettingsApi.java diff --git a/java/src/generated/java/com/github/copilot/generated/rpc/SessionSettingsBuiltInToolAvailabilitySnapshot.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionSettingsBuiltInToolAvailabilitySnapshot.java similarity index 89% rename from java/src/generated/java/com/github/copilot/generated/rpc/SessionSettingsBuiltInToolAvailabilitySnapshot.java rename to java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionSettingsBuiltInToolAvailabilitySnapshot.java index 98e6df29fa..8a714d5ccb 100644 --- a/java/src/generated/java/com/github/copilot/generated/rpc/SessionSettingsBuiltInToolAvailabilitySnapshot.java +++ b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionSettingsBuiltInToolAvailabilitySnapshot.java @@ -21,7 +21,9 @@ @JsonInclude(JsonInclude.Include.NON_NULL) @JsonIgnoreProperties(ignoreUnknown = true) public record SessionSettingsBuiltInToolAvailabilitySnapshot( + /** Whether the report-progress tool is available. */ @JsonProperty("reportProgress") Boolean reportProgress, + /** Whether the create-pull-request tool is available. */ @JsonProperty("createPullRequest") Boolean createPullRequest ) { } diff --git a/java/src/generated/java/com/github/copilot/generated/rpc/SessionSettingsEvaluatePredicateParams.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionSettingsEvaluatePredicateParams.java similarity index 100% rename from java/src/generated/java/com/github/copilot/generated/rpc/SessionSettingsEvaluatePredicateParams.java rename to java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionSettingsEvaluatePredicateParams.java diff --git a/java/src/generated/java/com/github/copilot/generated/rpc/SessionSettingsEvaluatePredicateResult.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionSettingsEvaluatePredicateResult.java similarity index 93% rename from java/src/generated/java/com/github/copilot/generated/rpc/SessionSettingsEvaluatePredicateResult.java rename to java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionSettingsEvaluatePredicateResult.java index 1f4a7ed320..3ab56b8ca6 100644 --- a/java/src/generated/java/com/github/copilot/generated/rpc/SessionSettingsEvaluatePredicateResult.java +++ b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionSettingsEvaluatePredicateResult.java @@ -24,6 +24,7 @@ @JsonInclude(JsonInclude.Include.NON_NULL) @JsonIgnoreProperties(ignoreUnknown = true) public record SessionSettingsEvaluatePredicateResult( + /** Whether the named settings predicate evaluated to enabled. */ @JsonProperty("enabled") Boolean enabled ) { } diff --git a/java/src/generated/java/com/github/copilot/generated/rpc/SessionSettingsJobSnapshot.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionSettingsJobSnapshot.java similarity index 87% rename from java/src/generated/java/com/github/copilot/generated/rpc/SessionSettingsJobSnapshot.java rename to java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionSettingsJobSnapshot.java index 463660d8a1..8a807e391c 100644 --- a/java/src/generated/java/com/github/copilot/generated/rpc/SessionSettingsJobSnapshot.java +++ b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionSettingsJobSnapshot.java @@ -21,8 +21,11 @@ @JsonInclude(JsonInclude.Include.NON_NULL) @JsonIgnoreProperties(ignoreUnknown = true) public record SessionSettingsJobSnapshot( + /** GitHub Actions event type for the job. */ @JsonProperty("eventType") String eventType, + /** Whether this is the workflow's trigger job. */ @JsonProperty("isTriggerJob") Boolean isTriggerJob, + /** Availability of job-specific built-in tools. */ @JsonProperty("builtInToolAvailability") SessionSettingsBuiltInToolAvailabilitySnapshot builtInToolAvailability ) { } diff --git a/java/src/generated/java/com/github/copilot/generated/rpc/SessionSettingsModelSnapshot.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionSettingsModelSnapshot.java similarity index 83% rename from java/src/generated/java/com/github/copilot/generated/rpc/SessionSettingsModelSnapshot.java rename to java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionSettingsModelSnapshot.java index ce515c74db..e1eb54a251 100644 --- a/java/src/generated/java/com/github/copilot/generated/rpc/SessionSettingsModelSnapshot.java +++ b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionSettingsModelSnapshot.java @@ -21,9 +21,13 @@ @JsonInclude(JsonInclude.Include.NON_NULL) @JsonIgnoreProperties(ignoreUnknown = true) public record SessionSettingsModelSnapshot( + /** Selected model identifier. */ @JsonProperty("model") String model, + /** Default reasoning effort for the selected model. */ @JsonProperty("defaultReasoningEffort") String defaultReasoningEffort, + /** Agent job identifier for the session. */ @JsonProperty("instanceId") String instanceId, + /** Agent service callback URL for job and progress updates. */ @JsonProperty("callbackUrl") String callbackUrl ) { } diff --git a/java/src/generated/java/com/github/copilot/generated/rpc/SessionSettingsOnlineEvaluationSnapshot.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionSettingsOnlineEvaluationSnapshot.java similarity index 89% rename from java/src/generated/java/com/github/copilot/generated/rpc/SessionSettingsOnlineEvaluationSnapshot.java rename to java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionSettingsOnlineEvaluationSnapshot.java index b1a5be6f3a..999e1a2cbf 100644 --- a/java/src/generated/java/com/github/copilot/generated/rpc/SessionSettingsOnlineEvaluationSnapshot.java +++ b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionSettingsOnlineEvaluationSnapshot.java @@ -21,7 +21,9 @@ @JsonInclude(JsonInclude.Include.NON_NULL) @JsonIgnoreProperties(ignoreUnknown = true) public record SessionSettingsOnlineEvaluationSnapshot( + /** Whether online evaluation is disabled. */ @JsonProperty("disableOnlineEvaluation") Boolean disableOnlineEvaluation, + /** Whether online-evaluation output-file generation is enabled. */ @JsonProperty("enableOnlineEvaluationOutputFile") Boolean enableOnlineEvaluationOutputFile ) { } diff --git a/java/src/generated/java/com/github/copilot/generated/rpc/SessionSettingsPredicateName.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionSettingsPredicateName.java similarity index 100% rename from java/src/generated/java/com/github/copilot/generated/rpc/SessionSettingsPredicateName.java rename to java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionSettingsPredicateName.java diff --git a/java/src/generated/java/com/github/copilot/generated/rpc/SessionSettingsRepoSnapshot.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionSettingsRepoSnapshot.java similarity index 74% rename from java/src/generated/java/com/github/copilot/generated/rpc/SessionSettingsRepoSnapshot.java rename to java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionSettingsRepoSnapshot.java index 960853c527..3651346bd8 100644 --- a/java/src/generated/java/com/github/copilot/generated/rpc/SessionSettingsRepoSnapshot.java +++ b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionSettingsRepoSnapshot.java @@ -21,17 +21,29 @@ @JsonInclude(JsonInclude.Include.NON_NULL) @JsonIgnoreProperties(ignoreUnknown = true) public record SessionSettingsRepoSnapshot( + /** Repository name. */ @JsonProperty("name") String name, + /** GitHub repository database ID. */ @JsonProperty("id") Double id, + /** Checked-out repository branch. */ @JsonProperty("branch") String branch, + /** Checked-out commit SHA. */ @JsonProperty("commit") String commit, + /** Whether the repository is writable. */ @JsonProperty("readWrite") Boolean readWrite, + /** Repository owner login. */ @JsonProperty("ownerName") String ownerName, + /** GitHub repository owner database ID. */ @JsonProperty("ownerId") Double ownerId, + /** GitHub server base URL. */ @JsonProperty("serverUrl") String serverUrl, + /** GitHub server host name. */ @JsonProperty("host") String host, + /** Protocol used to access the GitHub host. */ @JsonProperty("hostProtocol") String hostProtocol, + /** GitHub secret-scanning service URL. */ @JsonProperty("secretScanningUrl") String secretScanningUrl, + /** Number of commits in the pull request. */ @JsonProperty("prCommitCount") Double prCommitCount ) { } diff --git a/java/src/generated/java/com/github/copilot/generated/rpc/SessionSettingsSnapshotParams.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionSettingsSnapshotParams.java similarity index 100% rename from java/src/generated/java/com/github/copilot/generated/rpc/SessionSettingsSnapshotParams.java rename to java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionSettingsSnapshotParams.java diff --git a/java/src/generated/java/com/github/copilot/generated/rpc/SessionSettingsSnapshotResult.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionSettingsSnapshotResult.java similarity index 75% rename from java/src/generated/java/com/github/copilot/generated/rpc/SessionSettingsSnapshotResult.java rename to java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionSettingsSnapshotResult.java index 0851474d64..1bcfe166fc 100644 --- a/java/src/generated/java/com/github/copilot/generated/rpc/SessionSettingsSnapshotResult.java +++ b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionSettingsSnapshotResult.java @@ -24,14 +24,23 @@ @JsonInclude(JsonInclude.Include.NON_NULL) @JsonIgnoreProperties(ignoreUnknown = true) public record SessionSettingsSnapshotResult( + /** Agent runtime version selector copied from the session settings, such as `latest` or a runtime release identifier. */ @JsonProperty("version") String version, + /** Name of the SDK client that created the session. */ @JsonProperty("clientName") String clientName, + /** Session timeout in milliseconds. */ @JsonProperty("timeoutMs") Double timeoutMs, + /** Session start time as Unix epoch milliseconds. */ @JsonProperty("startTimeMs") Double startTimeMs, + /** Redacted repository and host settings. */ @JsonProperty("repo") SessionSettingsRepoSnapshot repo, + /** Redacted model routing settings. */ @JsonProperty("model") SessionSettingsModelSnapshot model, + /** Redacted validation and memory-tool settings. */ @JsonProperty("validation") SessionSettingsValidationSnapshot validation, + /** Redacted job settings. */ @JsonProperty("job") SessionSettingsJobSnapshot job, + /** Online-evaluation settings safe for SDK consumers. */ @JsonProperty("onlineEvaluation") SessionSettingsOnlineEvaluationSnapshot onlineEvaluation ) { } diff --git a/java/src/generated/java/com/github/copilot/generated/rpc/SessionSettingsValidationSnapshot.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionSettingsValidationSnapshot.java similarity index 74% rename from java/src/generated/java/com/github/copilot/generated/rpc/SessionSettingsValidationSnapshot.java rename to java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionSettingsValidationSnapshot.java index 375cfdfec1..314cc5b2b4 100644 --- a/java/src/generated/java/com/github/copilot/generated/rpc/SessionSettingsValidationSnapshot.java +++ b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionSettingsValidationSnapshot.java @@ -21,14 +21,23 @@ @JsonInclude(JsonInclude.Include.NON_NULL) @JsonIgnoreProperties(ignoreUnknown = true) public record SessionSettingsValidationSnapshot( + /** General validation timeout budget in seconds. */ @JsonProperty("timeout") Double timeout, + /** Dependabot validation timeout budget in seconds. */ @JsonProperty("dependabotTimeout") Double dependabotTimeout, + /** Whether CodeQL validation is enabled. */ @JsonProperty("codeqlEnabled") Boolean codeqlEnabled, + /** Whether code-review validation is enabled. */ @JsonProperty("codeReviewEnabled") Boolean codeReviewEnabled, + /** Model used for code-review validation. */ @JsonProperty("codeReviewModel") String codeReviewModel, + /** Whether advisory validation is enabled. */ @JsonProperty("advisoryEnabled") Boolean advisoryEnabled, + /** Whether secret-scanning validation is enabled. */ @JsonProperty("secretScanningEnabled") Boolean secretScanningEnabled, + /** Whether the memory-store tool is enabled. */ @JsonProperty("memoryStoreEnabled") Boolean memoryStoreEnabled, + /** Whether the memory-vote tool is enabled. */ @JsonProperty("memoryVoteEnabled") Boolean memoryVoteEnabled ) { } diff --git a/java/src/generated/java/com/github/copilot/generated/rpc/SessionShellApi.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionShellApi.java similarity index 100% rename from java/src/generated/java/com/github/copilot/generated/rpc/SessionShellApi.java rename to java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionShellApi.java diff --git a/java/src/generated/java/com/github/copilot/generated/rpc/SessionShellCancelUserRequestedParams.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionShellCancelUserRequestedParams.java similarity index 100% rename from java/src/generated/java/com/github/copilot/generated/rpc/SessionShellCancelUserRequestedParams.java rename to java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionShellCancelUserRequestedParams.java diff --git a/java/src/generated/java/com/github/copilot/generated/rpc/SessionShellCancelUserRequestedResult.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionShellCancelUserRequestedResult.java similarity index 100% rename from java/src/generated/java/com/github/copilot/generated/rpc/SessionShellCancelUserRequestedResult.java rename to java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionShellCancelUserRequestedResult.java 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 100% 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 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 100% 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 diff --git a/java/src/generated/java/com/github/copilot/generated/rpc/SessionShellExecuteUserRequestedParams.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionShellExecuteUserRequestedParams.java similarity index 100% rename from java/src/generated/java/com/github/copilot/generated/rpc/SessionShellExecuteUserRequestedParams.java rename to java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionShellExecuteUserRequestedParams.java diff --git a/java/src/generated/java/com/github/copilot/generated/rpc/SessionShellExecuteUserRequestedResult.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionShellExecuteUserRequestedResult.java similarity index 100% rename from java/src/generated/java/com/github/copilot/generated/rpc/SessionShellExecuteUserRequestedResult.java rename to java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionShellExecuteUserRequestedResult.java 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 100% 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 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 100% 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 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 100% 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 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 100% 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 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 100% 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 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 100% 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 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 100% 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 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 100% 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 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 100% 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 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 100% 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 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 100% 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 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 100% 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 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 100% 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 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 0000000000..2914e3c30c --- /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 100% 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 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 100% 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 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 100% 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 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 100% 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 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 100% 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 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 100% 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 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 100% 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 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 100% 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 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 100% 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 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 100% 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 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 100% 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 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 100% 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 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 100% 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 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 100% 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 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 100% 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 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 100% 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 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 100% 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 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 100% 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 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 100% 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 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 95% 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 82daeec5e6..87da305a6c 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 @@ -30,7 +30,7 @@ public record SessionTasksStartAgentParams( @JsonProperty("agentType") String agentType, /** Task prompt for the agent */ @JsonProperty("prompt") String prompt, - /** Short name for the agent, used to generate a human-readable ID */ + /** Friendly, non-unique name used when displaying the agent */ @JsonProperty("name") String name, /** Short description of the task */ @JsonProperty("description") String description, 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 100% 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 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 100% 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 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 100% 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 diff --git a/java/src/generated/java/com/github/copilot/generated/rpc/SessionTelemetryGetEngagementIdParams.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionTelemetryGetEngagementIdParams.java similarity index 100% rename from java/src/generated/java/com/github/copilot/generated/rpc/SessionTelemetryGetEngagementIdParams.java rename to java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionTelemetryGetEngagementIdParams.java diff --git a/java/src/generated/java/com/github/copilot/generated/rpc/SessionTelemetryGetEngagementIdResult.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionTelemetryGetEngagementIdResult.java similarity index 100% rename from java/src/generated/java/com/github/copilot/generated/rpc/SessionTelemetryGetEngagementIdResult.java rename to java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionTelemetryGetEngagementIdResult.java 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 100% 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 diff --git a/java/src/generated/java/com/github/copilot/generated/rpc/SessionToolsApi.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionToolsApi.java similarity index 52% rename from java/src/generated/java/com/github/copilot/generated/rpc/SessionToolsApi.java rename to java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionToolsApi.java index 0f4b058827..62593a3588 100644 --- a/java/src/generated/java/com/github/copilot/generated/rpc/SessionToolsApi.java +++ b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionToolsApi.java @@ -30,6 +30,54 @@ public final class SessionToolsApi { this.sessionId = sessionId; } + /** + * A tool name and arguments to execute through the session's native invocation pipeline. + *

+ * 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 execute(SessionToolsExecuteParams params) { + com.fasterxml.jackson.databind.node.ObjectNode _p = MAPPER.valueToTree(params); + _p.put("sessionId", this.sessionId); + return caller.invoke("session.tools.execute", _p, Void.class); + } + + /** + * Options controlling how Rust-owned built-in tool descriptors are materialized. + *

+ * 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 getBuiltinDescriptors(SessionToolsGetBuiltinDescriptorsParams params) { + com.fasterxml.jackson.databind.node.ObjectNode _p = MAPPER.valueToTree(params); + _p.put("sessionId", this.sessionId); + return caller.invoke("session.tools.getBuiltinDescriptors", _p, SessionToolsGetBuiltinDescriptorsResult.class); + } + + /** + * Task-completion tool arguments and final result used to build a label-safe session event payload. + *

+ * 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 taskCompleteEventData(SessionToolsTaskCompleteEventDataParams params) { + com.fasterxml.jackson.databind.node.ObjectNode _p = MAPPER.valueToTree(params); + _p.put("sessionId", this.sessionId); + return caller.invoke("session.tools.taskCompleteEventData", _p, SessionToolsTaskCompleteEventDataResult.class); + } + /** * Pending external tool call request ID, with the tool result or an error describing why it failed. *

@@ -68,6 +116,22 @@ public CompletableFuture getCurrentMetadat return caller.invoke("session.tools.getCurrentMetadata", java.util.Map.of("sessionId", this.sessionId), SessionToolsGetCurrentMetadataResult.class); } + /** + * Complete externally implemented tool list for the calling connection. An empty list removes every tool previously supplied by that connection. + *

+ * 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(SessionToolsSetParams params) { + com.fasterxml.jackson.databind.node.ObjectNode _p = MAPPER.valueToTree(params); + _p.put("sessionId", this.sessionId); + return caller.invoke("session.tools.set", _p, Void.class); + } + /** * Subagent settings to apply to the current session *

diff --git a/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionToolsExecuteParams.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionToolsExecuteParams.java new file mode 100644 index 0000000000..e60023c3aa --- /dev/null +++ b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionToolsExecuteParams.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; + +/** + * A tool name and arguments to execute through the session's native invocation pipeline. + * + * @apiNote This method is experimental and may change in a future version. + * @since 1.0.0 + */ +@CopilotExperimental +@javax.annotation.processing.Generated("copilot-sdk-codegen") +@JsonInclude(JsonInclude.Include.NON_NULL) +@JsonIgnoreProperties(ignoreUnknown = true) +public record SessionToolsExecuteParams( + /** Target session identifier */ + @JsonProperty("sessionId") String sessionId, + /** Name of the currently offered tool to execute. */ + @JsonProperty("name") String name, + /** Arguments supplied to the tool. */ + @JsonProperty("arguments") Object arguments, + /** Optional identifier used to correlate this invocation with its tool call. */ + @JsonProperty("toolCallId") String toolCallId +) { +} diff --git a/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionToolsGetBuiltinDescriptorsParams.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionToolsGetBuiltinDescriptorsParams.java new file mode 100644 index 0000000000..43dd20e722 --- /dev/null +++ b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionToolsGetBuiltinDescriptorsParams.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; + +/** + * Options controlling how Rust-owned built-in tool descriptors are materialized. + * + * @apiNote This method is experimental and may change in a future version. + * @since 1.0.0 + */ +@CopilotExperimental +@javax.annotation.processing.Generated("copilot-sdk-codegen") +@JsonInclude(JsonInclude.Include.NON_NULL) +@JsonIgnoreProperties(ignoreUnknown = true) +public record SessionToolsGetBuiltinDescriptorsParams( + /** Target session identifier */ + @JsonProperty("sessionId") String sessionId, + /** Whether descriptors should favor fewer user-intervention prompts. */ + @JsonProperty("reduceUserIntervention") Boolean reduceUserIntervention, + /** Whether tool descriptors should include authoring metadata. */ + @JsonProperty("includeAuthor") Boolean includeAuthor, + /** Whether semantic skill lookup is available. */ + @JsonProperty("skillEmbeddingEnabled") Boolean skillEmbeddingEnabled, + /** Shell-specific names and description lines for shell tools. */ + @JsonProperty("shellConfig") ToolsShellDescriptorConfig shellConfig, + /** Whether the configured shell supports PowerShell 7 syntax. */ + @JsonProperty("shellSupportsPowerShell7Syntax") Boolean shellSupportsPowerShell7Syntax, + /** Default shell timeout in milliseconds. */ + @JsonProperty("shellTimeoutMs") Double shellTimeoutMs, + /** Whether background task completion notifications are enabled. */ + @JsonProperty("backgroundTaskNotificationsEnabled") Boolean backgroundTaskNotificationsEnabled +) { +} diff --git a/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionToolsGetBuiltinDescriptorsResult.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionToolsGetBuiltinDescriptorsResult.java new file mode 100644 index 0000000000..1f33321e73 --- /dev/null +++ b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionToolsGetBuiltinDescriptorsResult.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; + +/** + * Rust-owned built-in tool descriptors 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 SessionToolsGetBuiltinDescriptorsResult( + /** Built-in tool descriptors materialized for the session. */ + @JsonProperty("tools") List tools +) { +} diff --git a/java/src/generated/java/com/github/copilot/generated/rpc/SessionToolsGetCurrentMetadataParams.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionToolsGetCurrentMetadataParams.java similarity index 100% rename from java/src/generated/java/com/github/copilot/generated/rpc/SessionToolsGetCurrentMetadataParams.java rename to java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionToolsGetCurrentMetadataParams.java diff --git a/java/src/generated/java/com/github/copilot/generated/rpc/SessionToolsGetCurrentMetadataResult.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionToolsGetCurrentMetadataResult.java similarity index 100% rename from java/src/generated/java/com/github/copilot/generated/rpc/SessionToolsGetCurrentMetadataResult.java rename to java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionToolsGetCurrentMetadataResult.java 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 100% 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 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 100% 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 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 100% 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 diff --git a/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionToolsSetParams.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionToolsSetParams.java new file mode 100644 index 0000000000..3edd6afad3 --- /dev/null +++ b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionToolsSetParams.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; + +/** + * Complete externally implemented tool list for the calling connection. An empty list removes every tool previously supplied by that connection. + * + * @apiNote This method is experimental and may change in a future version. + * @since 1.0.0 + */ +@CopilotExperimental +@javax.annotation.processing.Generated("copilot-sdk-codegen") +@JsonInclude(JsonInclude.Include.NON_NULL) +@JsonIgnoreProperties(ignoreUnknown = true) +public record SessionToolsSetParams( + /** Target session identifier */ + @JsonProperty("sessionId") String sessionId, + /** Complete replacement list for the calling connection. */ + @JsonProperty("tools") List tools +) { +} diff --git a/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionToolsTaskCompleteEventDataParams.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionToolsTaskCompleteEventDataParams.java new file mode 100644 index 0000000000..9902fb8a99 --- /dev/null +++ b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionToolsTaskCompleteEventDataParams.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; + +/** + * Task-completion tool arguments and final result used to build a label-safe session event payload. + * + * @apiNote This method is experimental and may change in a future version. + * @since 1.0.0 + */ +@CopilotExperimental +@javax.annotation.processing.Generated("copilot-sdk-codegen") +@JsonInclude(JsonInclude.Include.NON_NULL) +@JsonIgnoreProperties(ignoreUnknown = true) +public record SessionToolsTaskCompleteEventDataParams( + /** Target session identifier */ + @JsonProperty("sessionId") String sessionId, + /** Arguments supplied to the completed task_complete tool call. */ + @JsonProperty("toolArgs") Object toolArgs, + /** Final expanded result returned by the task_complete tool. */ + @JsonProperty("finalResult") ToolResultExpanded finalResult +) { +} diff --git a/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionToolsTaskCompleteEventDataResult.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionToolsTaskCompleteEventDataResult.java new file mode 100644 index 0000000000..f95ad8a76e --- /dev/null +++ b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionToolsTaskCompleteEventDataResult.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; + +/** + * Task completion notification with summary from the 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 SessionToolsTaskCompleteEventDataResult( + /** 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/rpc/SessionToolsUpdateSubagentSettingsParams.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionToolsUpdateSubagentSettingsParams.java similarity index 100% rename from java/src/generated/java/com/github/copilot/generated/rpc/SessionToolsUpdateSubagentSettingsParams.java rename to java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionToolsUpdateSubagentSettingsParams.java 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 100% 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 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 79% 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 ad754767e5..72207e55bb 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 @@ -11,6 +11,7 @@ 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; /** @@ -26,9 +27,15 @@ public record SessionUiElicitationParams( /** Target session identifier */ @JsonProperty("sessionId") String sessionId, + /** Elicitation mode. Omitted and form are equivalent for structured elicitation. */ + @JsonProperty("mode") McpElicitationFormMode mode, /** Message describing what information is needed from the user */ @JsonProperty("message") String message, /** JSON Schema describing the form fields to present to the user */ - @JsonProperty("requestedSchema") UIElicitationSchema requestedSchema + @JsonProperty("requestedSchema") UIElicitationSchema requestedSchema, + /** MCP request metadata. */ + @JsonProperty("_meta") Map> meta, + /** MCP task metadata. */ + @JsonProperty("task") McpTaskMetadata task ) { } 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 b290cc7c64..bf250f9d7d 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 @@ -28,6 +28,8 @@ public record SessionUiElicitationResult( /** The user's response: accept (submitted), decline (rejected), or cancel (dismissed) */ @JsonProperty("action") UIElicitationResponseAction action, /** The form values submitted by the user (present when action is 'accept') */ - @JsonProperty("content") Map content + @JsonProperty("content") Map content, + /** MCP response metadata. */ + @JsonProperty("_meta") Map> meta ) { } diff --git a/java/src/generated/java/com/github/copilot/generated/rpc/SessionUiEphemeralQueryParams.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionUiEphemeralQueryParams.java similarity index 100% rename from java/src/generated/java/com/github/copilot/generated/rpc/SessionUiEphemeralQueryParams.java rename to java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionUiEphemeralQueryParams.java diff --git a/java/src/generated/java/com/github/copilot/generated/rpc/SessionUiEphemeralQueryResult.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionUiEphemeralQueryResult.java similarity index 84% rename from java/src/generated/java/com/github/copilot/generated/rpc/SessionUiEphemeralQueryResult.java rename to java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionUiEphemeralQueryResult.java index 6ac9058b04..e8b6dd90cb 100644 --- a/java/src/generated/java/com/github/copilot/generated/rpc/SessionUiEphemeralQueryResult.java +++ b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionUiEphemeralQueryResult.java @@ -14,7 +14,7 @@ import javax.annotation.processing.Generated; /** - * Transient answer generated from current conversation context. + * Completed transient query. Ordered chunks and the terminal outcome are also delivered through `ui.ephemeral_query` session events while it runs. * * @apiNote This method is experimental and may change in a future version. * @since 1.0.0 @@ -24,7 +24,7 @@ @JsonInclude(JsonInclude.Include.NON_NULL) @JsonIgnoreProperties(ignoreUnknown = true) public record SessionUiEphemeralQueryResult( - /** Full assistant response text. */ + /** Answer returned by the model */ @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 100% 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 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 100% 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 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 100% 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 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 100% 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 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 100% 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 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 100% 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 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 100% 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 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 100% 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 diff --git a/java/src/generated/java/com/github/copilot/generated/rpc/SessionUiHandlePendingSessionLimitsExhaustedParams.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionUiHandlePendingSessionLimitsExhaustedParams.java similarity index 100% rename from java/src/generated/java/com/github/copilot/generated/rpc/SessionUiHandlePendingSessionLimitsExhaustedParams.java rename to java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionUiHandlePendingSessionLimitsExhaustedParams.java diff --git a/java/src/generated/java/com/github/copilot/generated/rpc/SessionUiHandlePendingSessionLimitsExhaustedResult.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionUiHandlePendingSessionLimitsExhaustedResult.java similarity index 100% rename from java/src/generated/java/com/github/copilot/generated/rpc/SessionUiHandlePendingSessionLimitsExhaustedResult.java rename to java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionUiHandlePendingSessionLimitsExhaustedResult.java 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 100% 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 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 100% 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 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 100% 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 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 100% 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 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 100% 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 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 100% 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 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 100% 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 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 100% 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 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 92% 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 69db5a56d3..a38afd7042 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 @@ -42,6 +42,8 @@ public record SessionUsageGetMetricsResult( @JsonProperty("codeChanges") UsageMetricsCodeChanges codeChanges, /** Per-model token and request metrics, keyed by model identifier */ @JsonProperty("modelMetrics") Map modelMetrics, + /** Per-agent usage metrics, keyed by agent instance identifier. The main conversation uses the stable key `main`. */ + @JsonProperty("agentMetrics") Map agentMetrics, /** Currently active model identifier */ @JsonProperty("currentModel") String currentModel, /** Input tokens from the most recent main-agent API call */ diff --git a/java/src/generated/java/com/github/copilot/generated/rpc/SessionVisibilityApi.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionVisibilityApi.java similarity index 100% rename from java/src/generated/java/com/github/copilot/generated/rpc/SessionVisibilityApi.java rename to java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionVisibilityApi.java diff --git a/java/src/generated/java/com/github/copilot/generated/rpc/SessionVisibilityGetParams.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionVisibilityGetParams.java similarity index 100% rename from java/src/generated/java/com/github/copilot/generated/rpc/SessionVisibilityGetParams.java rename to java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionVisibilityGetParams.java diff --git a/java/src/generated/java/com/github/copilot/generated/rpc/SessionVisibilityGetResult.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionVisibilityGetResult.java similarity index 100% rename from java/src/generated/java/com/github/copilot/generated/rpc/SessionVisibilityGetResult.java rename to java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionVisibilityGetResult.java diff --git a/java/src/generated/java/com/github/copilot/generated/rpc/SessionVisibilitySetParams.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionVisibilitySetParams.java similarity index 100% rename from java/src/generated/java/com/github/copilot/generated/rpc/SessionVisibilitySetParams.java rename to java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionVisibilitySetParams.java diff --git a/java/src/generated/java/com/github/copilot/generated/rpc/SessionVisibilitySetResult.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionVisibilitySetResult.java similarity index 100% rename from java/src/generated/java/com/github/copilot/generated/rpc/SessionVisibilitySetResult.java rename to java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionVisibilitySetResult.java diff --git a/java/src/generated/java/com/github/copilot/generated/rpc/SessionVisibilityStatus.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionVisibilityStatus.java similarity index 100% rename from java/src/generated/java/com/github/copilot/generated/rpc/SessionVisibilityStatus.java rename to java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionVisibilityStatus.java 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 0000000000..2a1c247bf5 --- /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 0000000000..6dd474df60 --- /dev/null +++ b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionWorkspacesAddSummaryResult.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.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( + /** Metadata for the persisted summary. */ + @JsonProperty("summary") Map summary, + /** Refreshed metadata for the containing workspace. */ + @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 0000000000..aaacb046f0 --- /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 0000000000..fc4b25c9dc --- /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 0000000000..8fe0a849dd --- /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 100% 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 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 0000000000..81f59d7a0a --- /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/src/generated/java/com/github/copilot/generated/rpc/SessionHistoryTruncateResult.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionWorkspacesDeleteAutopilotObjectiveResult.java similarity index 81% rename from java/src/generated/java/com/github/copilot/generated/rpc/SessionHistoryTruncateResult.java rename to java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionWorkspacesDeleteAutopilotObjectiveResult.java index 5b5043b609..3fa3f35f26 100644 --- a/java/src/generated/java/com/github/copilot/generated/rpc/SessionHistoryTruncateResult.java +++ b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionWorkspacesDeleteAutopilotObjectiveResult.java @@ -14,7 +14,7 @@ import javax.annotation.processing.Generated; /** - * Number of events that were removed by the truncation. + * Result of deleting the autopilot objective file. * * @apiNote This method is experimental and may change in a future version. * @since 1.0.0 @@ -23,8 +23,8 @@ @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 +public record SessionWorkspacesDeleteAutopilotObjectiveResult( + /** True when a file was deleted. */ + @JsonProperty("deleted") Boolean deleted ) { } diff --git a/java/src/generated/java/com/github/copilot/generated/rpc/SessionWorkspacesDiffParams.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionWorkspacesDiffParams.java similarity index 100% rename from java/src/generated/java/com/github/copilot/generated/rpc/SessionWorkspacesDiffParams.java rename to java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionWorkspacesDiffParams.java diff --git a/java/src/generated/java/com/github/copilot/generated/rpc/SessionWorkspacesDiffResult.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionWorkspacesDiffResult.java similarity index 64% rename from java/src/generated/java/com/github/copilot/generated/rpc/SessionWorkspacesDiffResult.java rename to java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionWorkspacesDiffResult.java index a3c8ce96e6..21beab3ead 100644 --- a/java/src/generated/java/com/github/copilot/generated/rpc/SessionWorkspacesDiffResult.java +++ b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionWorkspacesDiffResult.java @@ -33,7 +33,9 @@ public record SessionWorkspacesDiffResult( @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 + /** 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 0000000000..aaa71621ff --- /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 0000000000..c2d7e9ce37 --- /dev/null +++ b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionWorkspacesEnsureResult.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.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( + /** Stable workspace identifier. */ + @JsonProperty("id") String id, + /** Current working directory associated with the workspace. */ + @JsonProperty("cwd") String cwd, + /** Git repository root associated with the workspace. */ + @JsonProperty("git_root") String gitRoot, + /** Repository identifier associated with the workspace. */ + @JsonProperty("repository") String repository, + /** Allowed values for the `WorkspacesWorkspaceDetailsHostType` enumeration. */ + @JsonProperty("host_type") WorkspacesWorkspaceDetailsHostType hostType, + /** Current Git branch. */ + @JsonProperty("branch") String branch, + /** Workspace display name. */ + @JsonProperty("name") String name, + /** Name of the client that created the workspace. */ + @JsonProperty("client_name") String clientName, + /** Whether the workspace name was explicitly chosen by the user. */ + @JsonProperty("user_named") Boolean userNamed, + /** Number of persisted summaries in the workspace. */ + @JsonProperty("summary_count") Long summaryCount, + /** Timestamp when the workspace was created. */ + @JsonProperty("created_at") OffsetDateTime createdAt, + /** Timestamp when the workspace was last updated. */ + @JsonProperty("updated_at") OffsetDateTime updatedAt, + /** Whether the workspace session can be steered remotely. */ + @JsonProperty("remote_steerable") Boolean remoteSteerable, + /** Mission Control task identifier associated with the workspace. */ + @JsonProperty("mc_task_id") String mcTaskId, + /** Mission Control session identifier associated with the workspace. */ + @JsonProperty("mc_session_id") String mcSessionId, + /** Most recent Mission Control event identifier observed for the workspace. */ + @JsonProperty("mc_last_event_id") String mcLastEventId, + /** Whether the per-session Chronicle upgrade prompt was dismissed for the workspace. */ + @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 100% 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 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 71% 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 217ac7d449..6f4714a594 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 @@ -34,23 +34,39 @@ public record SessionWorkspacesGetWorkspaceResult( @JsonIgnoreProperties(ignoreUnknown = true) @JsonInclude(JsonInclude.Include.NON_NULL) public record SessionWorkspacesGetWorkspaceResultWorkspace( + /** Stable workspace identifier. */ @JsonProperty("id") String id, + /** Current working directory associated with the workspace. */ @JsonProperty("cwd") String cwd, + /** Git repository root associated with the workspace. */ @JsonProperty("git_root") String gitRoot, + /** Repository identifier associated with the workspace. */ @JsonProperty("repository") String repository, /** Allowed values for the `WorkspacesWorkspaceDetailsHostType` enumeration. */ @JsonProperty("host_type") WorkspacesWorkspaceDetailsHostType hostType, + /** Current Git branch. */ @JsonProperty("branch") String branch, + /** Workspace display name. */ @JsonProperty("name") String name, + /** Name of the client that created the workspace. */ @JsonProperty("client_name") String clientName, + /** Whether the workspace name was explicitly chosen by the user. */ @JsonProperty("user_named") Boolean userNamed, + /** Number of persisted summaries in the workspace. */ @JsonProperty("summary_count") Long summaryCount, + /** Timestamp when the workspace was created. */ @JsonProperty("created_at") OffsetDateTime createdAt, + /** Timestamp when the workspace was last updated. */ @JsonProperty("updated_at") OffsetDateTime updatedAt, + /** Whether the workspace session can be steered remotely. */ @JsonProperty("remote_steerable") Boolean remoteSteerable, + /** Mission Control task identifier associated with the workspace. */ @JsonProperty("mc_task_id") String mcTaskId, + /** Mission Control session identifier associated with the workspace. */ @JsonProperty("mc_session_id") String mcSessionId, + /** Most recent Mission Control event identifier observed for the workspace. */ @JsonProperty("mc_last_event_id") String mcLastEventId, + /** Whether the per-session Chronicle upgrade prompt was dismissed for the workspace. */ @JsonProperty("chronicle_sync_dismissed") Boolean chronicleSyncDismissed ) { } 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 100% 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 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 100% 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 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 100% 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 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 100% 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 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 0000000000..67d03a9549 --- /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 0000000000..7b2e157b56 --- /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 100% 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 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 100% 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 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 100% 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 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 100% 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 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 100% 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 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 100% 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 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 0000000000..43d392e48c --- /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 0000000000..1dc348e67e --- /dev/null +++ b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionWorkspacesTruncateSummariesResult.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.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( + /** Stable workspace identifier. */ + @JsonProperty("id") String id, + /** Current working directory associated with the workspace. */ + @JsonProperty("cwd") String cwd, + /** Git repository root associated with the workspace. */ + @JsonProperty("git_root") String gitRoot, + /** Repository identifier associated with the workspace. */ + @JsonProperty("repository") String repository, + /** Allowed values for the `WorkspacesWorkspaceDetailsHostType` enumeration. */ + @JsonProperty("host_type") WorkspacesWorkspaceDetailsHostType hostType, + /** Current Git branch. */ + @JsonProperty("branch") String branch, + /** Workspace display name. */ + @JsonProperty("name") String name, + /** Name of the client that created the workspace. */ + @JsonProperty("client_name") String clientName, + /** Whether the workspace name was explicitly chosen by the user. */ + @JsonProperty("user_named") Boolean userNamed, + /** Number of persisted summaries in the workspace. */ + @JsonProperty("summary_count") Long summaryCount, + /** Timestamp when the workspace was created. */ + @JsonProperty("created_at") OffsetDateTime createdAt, + /** Timestamp when the workspace was last updated. */ + @JsonProperty("updated_at") OffsetDateTime updatedAt, + /** Whether the workspace session can be steered remotely. */ + @JsonProperty("remote_steerable") Boolean remoteSteerable, + /** Mission Control task identifier associated with the workspace. */ + @JsonProperty("mc_task_id") String mcTaskId, + /** Mission Control session identifier associated with the workspace. */ + @JsonProperty("mc_session_id") String mcSessionId, + /** Most recent Mission Control event identifier observed for the workspace. */ + @JsonProperty("mc_last_event_id") String mcLastEventId, + /** Whether the per-session Chronicle upgrade prompt was dismissed for the workspace. */ + @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 0000000000..af45fead51 --- /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 0000000000..03731650a8 --- /dev/null +++ b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionWorkspacesUpdateMetadataResult.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.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( + /** Stable workspace identifier. */ + @JsonProperty("id") String id, + /** Current working directory associated with the workspace. */ + @JsonProperty("cwd") String cwd, + /** Git repository root associated with the workspace. */ + @JsonProperty("git_root") String gitRoot, + /** Repository identifier associated with the workspace. */ + @JsonProperty("repository") String repository, + /** Allowed values for the `WorkspacesWorkspaceDetailsHostType` enumeration. */ + @JsonProperty("host_type") WorkspacesWorkspaceDetailsHostType hostType, + /** Current Git branch. */ + @JsonProperty("branch") String branch, + /** Workspace display name. */ + @JsonProperty("name") String name, + /** Name of the client that created the workspace. */ + @JsonProperty("client_name") String clientName, + /** Whether the workspace name was explicitly chosen by the user. */ + @JsonProperty("user_named") Boolean userNamed, + /** Number of persisted summaries in the workspace. */ + @JsonProperty("summary_count") Long summaryCount, + /** Timestamp when the workspace was created. */ + @JsonProperty("created_at") OffsetDateTime createdAt, + /** Timestamp when the workspace was last updated. */ + @JsonProperty("updated_at") OffsetDateTime updatedAt, + /** Whether the workspace session can be steered remotely. */ + @JsonProperty("remote_steerable") Boolean remoteSteerable, + /** Mission Control task identifier associated with the workspace. */ + @JsonProperty("mc_task_id") String mcTaskId, + /** Mission Control session identifier associated with the workspace. */ + @JsonProperty("mc_session_id") String mcSessionId, + /** Most recent Mission Control event identifier observed for the workspace. */ + @JsonProperty("mc_last_event_id") String mcLastEventId, + /** Whether the per-session Chronicle upgrade prompt was dismissed for the workspace. */ + @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 0000000000..fb116ed307 --- /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 0000000000..9b69713e97 --- /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 100% 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 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 100% 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 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 100% 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 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 100% 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 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 100% 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 diff --git a/java/src/generated/java/com/github/copilot/generated/rpc/SessionsConfigureSessionExtensionsParams.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionsConfigureSessionExtensionsParams.java similarity index 100% rename from java/src/generated/java/com/github/copilot/generated/rpc/SessionsConfigureSessionExtensionsParams.java rename to java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionsConfigureSessionExtensionsParams.java 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 100% 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 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 100% 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 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 0000000000..788811e348 --- /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 100% 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 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 100% 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 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 100% 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 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 100% 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 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 100% 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 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 100% 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 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 100% 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 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 100% 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 diff --git a/java/src/generated/java/com/github/copilot/generated/rpc/SessionsGetBoardEntryCountParams.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionsGetBoardEntryCountParams.java similarity index 100% rename from java/src/generated/java/com/github/copilot/generated/rpc/SessionsGetBoardEntryCountParams.java rename to java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionsGetBoardEntryCountParams.java diff --git a/java/src/generated/java/com/github/copilot/generated/rpc/SessionsGetBoardEntryCountResult.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionsGetBoardEntryCountResult.java similarity index 100% rename from java/src/generated/java/com/github/copilot/generated/rpc/SessionsGetBoardEntryCountResult.java rename to java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionsGetBoardEntryCountResult.java 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 100% 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 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 100% 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 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 100% 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 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 100% 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 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 0000000000..cfa2e6326e --- /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 0000000000..6546b00fe0 --- /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 100% 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 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 100% 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 diff --git a/java/src/generated/java/com/github/copilot/generated/rpc/SessionsGetRemoteControlStatusResult.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionsGetRemoteControlStatusResult.java similarity index 100% rename from java/src/generated/java/com/github/copilot/generated/rpc/SessionsGetRemoteControlStatusResult.java rename to java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionsGetRemoteControlStatusResult.java 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 100% 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 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 0000000000..4e453121bc --- /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 0000000000..51cc266e63 --- /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 0000000000..61e01b1c7a --- /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/src/generated/java/com/github/copilot/generated/rpc/SessionsListResult.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionsListResult.java similarity index 100% rename from java/src/generated/java/com/github/copilot/generated/rpc/SessionsListResult.java rename to java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionsListResult.java 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 100% 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 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 100% 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 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 0000000000..1554425a77 --- /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 0000000000..8e4a74bd88 --- /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 0000000000..0394cffa6e --- /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 0000000000..bb67c43387 --- /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 0000000000..39d7eff421 --- /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 0000000000..dd97950248 --- /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/src/generated/java/com/github/copilot/generated/rpc/SessionsOpenProgress.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionsOpenProgress.java similarity index 100% rename from java/src/generated/java/com/github/copilot/generated/rpc/SessionsOpenProgress.java rename to java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionsOpenProgress.java diff --git a/java/src/generated/java/com/github/copilot/generated/rpc/SessionsOpenProgressStatus.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionsOpenProgressStatus.java similarity index 100% rename from java/src/generated/java/com/github/copilot/generated/rpc/SessionsOpenProgressStatus.java rename to java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionsOpenProgressStatus.java diff --git a/java/src/generated/java/com/github/copilot/generated/rpc/SessionsOpenProgressStep.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionsOpenProgressStep.java similarity index 100% rename from java/src/generated/java/com/github/copilot/generated/rpc/SessionsOpenProgressStep.java rename to java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionsOpenProgressStep.java 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 0000000000..a51660d809 --- /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/src/generated/java/com/github/copilot/generated/rpc/SessionsOpenResult.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionsOpenResult.java similarity index 100% rename from java/src/generated/java/com/github/copilot/generated/rpc/SessionsOpenResult.java rename to java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionsOpenResult.java 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 0000000000..664e5a0052 --- /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 0000000000..a93afe7741 --- /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/src/generated/java/com/github/copilot/generated/rpc/SessionsOpenStatus.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionsOpenStatus.java similarity index 100% rename from java/src/generated/java/com/github/copilot/generated/rpc/SessionsOpenStatus.java rename to java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionsOpenStatus.java 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 100% 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 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 100% 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 diff --git a/java/src/generated/java/com/github/copilot/generated/rpc/SessionsRegisterExtensionToolsOnSessionOptions.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionsRegisterExtensionToolsOnSessionOptions.java similarity index 100% rename from java/src/generated/java/com/github/copilot/generated/rpc/SessionsRegisterExtensionToolsOnSessionOptions.java rename to java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionsRegisterExtensionToolsOnSessionOptions.java diff --git a/java/src/generated/java/com/github/copilot/generated/rpc/SessionsRegisterExtensionToolsOnSessionParams.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionsRegisterExtensionToolsOnSessionParams.java similarity index 100% rename from java/src/generated/java/com/github/copilot/generated/rpc/SessionsRegisterExtensionToolsOnSessionParams.java rename to java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionsRegisterExtensionToolsOnSessionParams.java diff --git a/java/src/generated/java/com/github/copilot/generated/rpc/SessionsRegisterExtensionToolsOnSessionResult.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionsRegisterExtensionToolsOnSessionResult.java similarity index 100% rename from java/src/generated/java/com/github/copilot/generated/rpc/SessionsRegisterExtensionToolsOnSessionResult.java rename to java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionsRegisterExtensionToolsOnSessionResult.java 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 100% 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 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 100% 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 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 100% 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 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 100% 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 diff --git a/java/src/generated/java/com/github/copilot/generated/rpc/SessionsSetRemoteControlSteeringParams.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionsSetRemoteControlSteeringParams.java similarity index 100% rename from java/src/generated/java/com/github/copilot/generated/rpc/SessionsSetRemoteControlSteeringParams.java rename to java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionsSetRemoteControlSteeringParams.java diff --git a/java/src/generated/java/com/github/copilot/generated/rpc/SessionsSetRemoteControlSteeringResult.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionsSetRemoteControlSteeringResult.java similarity index 100% rename from java/src/generated/java/com/github/copilot/generated/rpc/SessionsSetRemoteControlSteeringResult.java rename to java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionsSetRemoteControlSteeringResult.java diff --git a/java/src/generated/java/com/github/copilot/generated/rpc/SessionsStartRemoteControlParams.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionsStartRemoteControlParams.java similarity index 100% rename from java/src/generated/java/com/github/copilot/generated/rpc/SessionsStartRemoteControlParams.java rename to java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionsStartRemoteControlParams.java diff --git a/java/src/generated/java/com/github/copilot/generated/rpc/SessionsStartRemoteControlResult.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionsStartRemoteControlResult.java similarity index 100% rename from java/src/generated/java/com/github/copilot/generated/rpc/SessionsStartRemoteControlResult.java rename to java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionsStartRemoteControlResult.java 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 0000000000..3cd2065d6e --- /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/src/generated/java/com/github/copilot/generated/rpc/SessionsStopRemoteControlResult.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionsStopRemoteControlResult.java similarity index 100% rename from java/src/generated/java/com/github/copilot/generated/rpc/SessionsStopRemoteControlResult.java rename to java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionsStopRemoteControlResult.java diff --git a/java/src/generated/java/com/github/copilot/generated/rpc/SessionsTransferRemoteControlParams.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionsTransferRemoteControlParams.java similarity index 100% rename from java/src/generated/java/com/github/copilot/generated/rpc/SessionsTransferRemoteControlParams.java rename to java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionsTransferRemoteControlParams.java diff --git a/java/src/generated/java/com/github/copilot/generated/rpc/SessionsTransferRemoteControlResult.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionsTransferRemoteControlResult.java similarity index 100% rename from java/src/generated/java/com/github/copilot/generated/rpc/SessionsTransferRemoteControlResult.java rename to java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionsTransferRemoteControlResult.java diff --git a/java/sdk/src/generated/java/com/github/copilot/generated/rpc/ShellCredentials.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/ShellCredentials.java new file mode 100644 index 0000000000..53567c98db --- /dev/null +++ b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/ShellCredentials.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 javax.annotation.processing.Generated; + +/** + * Command-scoped GitHub credential injection for the shell commands an agent runs. + +Each channel is opt-in and independent, and injection is scoped to the individual command +spawn: the credential is resolved from the session's *current* authentication at every spawn +and reaches only spawns whose script actually invokes `git` or `gh`. Because nothing is +retained between spawns, replacing the session credential (`session.gitHubAuth.setCredentials`) +changes what the next spawned command presents β€” which seeding a credential into the runtime +process's own environment cannot do, since a child's environment is fixed at `exec`. + +The credential is matched to the host it authenticates to, so a github.com credential is never +presented to a GitHub Enterprise host and vice versa. Where a channel cannot express that +boundary it injects nothing rather than crossing it -- see `gh` below. + +This is independent of `sandboxConfig`: it is a decision about which identity the agent +presents, not about what the agent may touch, and it works on every platform whether or not +an OS sandboxing backend is available. `sandboxConfig.auth` remains the sandbox-scoped +spelling and is additive with this one. + * + * @since 1.0.0 + */ +@javax.annotation.processing.Generated("copilot-sdk-codegen") +@JsonInclude(JsonInclude.Include.NON_NULL) +@JsonIgnoreProperties(ignoreUnknown = true) +public record ShellCredentials( + /** Whether to authenticate the agent's `git` commands as the session's GitHub credential, by +injecting an `http..extraheader` (plus `insteadOf` rewrites so SSH-spelled remotes for +that host use the authenticated HTTPS transport). Applied only to a spawn that runs a +remote-contacting `git` subcommand. Default: false (opt-in). */ + @JsonProperty("git") Boolean git, + /** Whether to authenticate the agent's `gh` commands as the session's GitHub credential, by +exporting `GH_TOKEN` to a spawn that runs `gh`. Any inherited `gh` credential is removed from +spawns that do not, so the credential stays command-scoped. + +Applies to a github.com credential only. `gh` picks its credential variable from the host a +command targets rather than the one the credential belongs to, and the command can choose that +target, so `GH_ENTERPRISE_TOKEN` would offer a single-tenant enterprise credential to every +other enterprise host. A session whose credential is enterprise-scoped therefore runs `gh` +unauthenticated; its `git` commands are unaffected, because `http..extraheader` is scoped +to one host by construction. Default: false (opt-in). */ + @JsonProperty("gh") Boolean gh +) { +} 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 0000000000..7d27a55b5d --- /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 0000000000..31789619e8 --- /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 0000000000..63d7ba7dc2 --- /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 0000000000..ea152a59fc --- /dev/null +++ b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/ShellOptions.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; + +/** + * 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, + /** Command-scoped GitHub credential injection for shell commands. */ + @JsonProperty("credentials") ShellCredentials credentials +) { +} 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/src/generated/java/com/github/copilot/generated/rpc/Skill.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/Skill.java similarity index 92% rename from java/src/generated/java/com/github/copilot/generated/rpc/Skill.java rename to java/sdk/src/generated/java/com/github/copilot/generated/rpc/Skill.java index 4ad4116871..88e7eb1169 100644 --- a/java/src/generated/java/com/github/copilot/generated/rpc/Skill.java +++ b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/Skill.java @@ -23,6 +23,8 @@ 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) */ diff --git a/java/src/generated/java/com/github/copilot/generated/rpc/SkillDiscoveryPath.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SkillDiscoveryPath.java similarity index 100% rename from java/src/generated/java/com/github/copilot/generated/rpc/SkillDiscoveryPath.java rename to java/sdk/src/generated/java/com/github/copilot/generated/rpc/SkillDiscoveryPath.java diff --git a/java/src/generated/java/com/github/copilot/generated/rpc/SkillDiscoveryScope.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SkillDiscoveryScope.java similarity index 100% rename from java/src/generated/java/com/github/copilot/generated/rpc/SkillDiscoveryScope.java rename to java/sdk/src/generated/java/com/github/copilot/generated/rpc/SkillDiscoveryScope.java 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 100% 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 diff --git a/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SkillsConfigSetSkillDisabledParams.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SkillsConfigSetSkillDisabledParams.java new file mode 100644 index 0000000000..cce64217c2 --- /dev/null +++ b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SkillsConfigSetSkillDisabledParams.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; + +/** + * Adds or removes a single skill from the global disabled list, leaving every other entry untouched. + * + * @apiNote This method is experimental and may change in a future version. + * @since 1.0.0 + */ +@CopilotExperimental +@javax.annotation.processing.Generated("copilot-sdk-codegen") +@JsonInclude(JsonInclude.Include.NON_NULL) +@JsonIgnoreProperties(ignoreUnknown = true) +public record SkillsConfigSetSkillDisabledParams( + /** Name of the skill to add to or remove from the disabled list */ + @JsonProperty("name") String name, + /** True to disable the skill, false to enable it */ + @JsonProperty("disabled") Boolean disabled +) { +} 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 100% 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 diff --git a/java/src/generated/java/com/github/copilot/generated/rpc/SkillsDiscoverResult.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SkillsDiscoverResult.java similarity index 100% rename from java/src/generated/java/com/github/copilot/generated/rpc/SkillsDiscoverResult.java rename to java/sdk/src/generated/java/com/github/copilot/generated/rpc/SkillsDiscoverResult.java diff --git a/java/src/generated/java/com/github/copilot/generated/rpc/SkillsGetDiscoveryPathsParams.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SkillsGetDiscoveryPathsParams.java similarity index 100% rename from java/src/generated/java/com/github/copilot/generated/rpc/SkillsGetDiscoveryPathsParams.java rename to java/sdk/src/generated/java/com/github/copilot/generated/rpc/SkillsGetDiscoveryPathsParams.java diff --git a/java/src/generated/java/com/github/copilot/generated/rpc/SkillsGetDiscoveryPathsResult.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SkillsGetDiscoveryPathsResult.java similarity index 100% rename from java/src/generated/java/com/github/copilot/generated/rpc/SkillsGetDiscoveryPathsResult.java rename to java/sdk/src/generated/java/com/github/copilot/generated/rpc/SkillsGetDiscoveryPathsResult.java 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 100% 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 diff --git a/java/src/generated/java/com/github/copilot/generated/rpc/SlashCommandAgentPromptResult.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SlashCommandAgentPromptResult.java similarity index 100% rename from java/src/generated/java/com/github/copilot/generated/rpc/SlashCommandAgentPromptResult.java rename to java/sdk/src/generated/java/com/github/copilot/generated/rpc/SlashCommandAgentPromptResult.java diff --git a/java/src/generated/java/com/github/copilot/generated/rpc/SlashCommandCompletedResult.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SlashCommandCompletedResult.java similarity index 100% rename from java/src/generated/java/com/github/copilot/generated/rpc/SlashCommandCompletedResult.java rename to java/sdk/src/generated/java/com/github/copilot/generated/rpc/SlashCommandCompletedResult.java 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 100% 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 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 100% 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 diff --git a/java/src/generated/java/com/github/copilot/generated/rpc/SlashCommandInputChoice.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SlashCommandInputChoice.java similarity index 100% rename from java/src/generated/java/com/github/copilot/generated/rpc/SlashCommandInputChoice.java rename to java/sdk/src/generated/java/com/github/copilot/generated/rpc/SlashCommandInputChoice.java 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/src/generated/java/com/github/copilot/generated/rpc/SlashCommandInvocationResult.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SlashCommandInvocationResult.java similarity index 76% rename from java/src/generated/java/com/github/copilot/generated/rpc/SlashCommandInvocationResult.java rename to java/sdk/src/generated/java/com/github/copilot/generated/rpc/SlashCommandInvocationResult.java index 336c0eda84..9c0d0979cc 100644 --- a/java/src/generated/java/com/github/copilot/generated/rpc/SlashCommandInvocationResult.java +++ b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SlashCommandInvocationResult.java @@ -22,7 +22,11 @@ @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") + @JsonSubTypes.Type(value = SlashCommandSelectSubcommandResult.class, name = "select-subcommand"), + @JsonSubTypes.Type(value = SlashCommandInvocationResultAddTimelineEntry.class, name = "add-timeline-entry"), + @JsonSubTypes.Type(value = SlashCommandInvocationResultShowDialog.class, name = "show-dialog"), + @JsonSubTypes.Type(value = SlashCommandInvocationResultSetModel.class, name = "set-model"), + @JsonSubTypes.Type(value = SlashCommandInvocationResultSetPlanModel.class, name = "set-plan-model") }) @JsonIgnoreProperties(ignoreUnknown = true) @javax.annotation.processing.Generated("copilot-sdk-codegen") diff --git a/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SlashCommandInvocationResultAddTimelineEntry.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SlashCommandInvocationResultAddTimelineEntry.java new file mode 100644 index 0000000000..890ed79664 --- /dev/null +++ b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SlashCommandInvocationResultAddTimelineEntry.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; + +/** + * Variant {@code add-timeline-entry} of {@link SlashCommandInvocationResult}. + * + * @since 1.0.0 + */ +@JsonIgnoreProperties(ignoreUnknown = true) +@JsonInclude(JsonInclude.Include.NON_NULL) +@javax.annotation.processing.Generated("copilot-sdk-codegen") +public final class SlashCommandInvocationResultAddTimelineEntry extends SlashCommandInvocationResult { + + @JsonProperty("kind") + private final String kind = "add-timeline-entry"; + + @Override + public String getKind() { return kind; } + + /** Timeline entry the host should append. */ + @JsonProperty("entry") + private SlashCommandTimelineEntry entry; + + /** Optional text the host should prefill into the input editor. */ + @JsonProperty("prefillInput") + private String prefillInput; + + /** Whether command execution changed persisted runtime settings. */ + @JsonProperty("runtimeSettingsChanged") + private Boolean runtimeSettingsChanged; + + public SlashCommandTimelineEntry getEntry() { return entry; } + public void setEntry(SlashCommandTimelineEntry entry) { this.entry = entry; } + + public String getPrefillInput() { return prefillInput; } + public void setPrefillInput(String prefillInput) { this.prefillInput = prefillInput; } + + 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/SlashCommandInvocationResultSetModel.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SlashCommandInvocationResultSetModel.java new file mode 100644 index 0000000000..95e4d8544c --- /dev/null +++ b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SlashCommandInvocationResultSetModel.java @@ -0,0 +1,80 @@ +/*--------------------------------------------------------------------------------------------- + * Copyright (c) Microsoft Corporation. All rights reserved. + *--------------------------------------------------------------------------------------------*/ + +// AUTO-GENERATED FILE - DO NOT EDIT +// Generated from: api.schema.json + +package 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; + +/** + * Variant {@code set-model} of {@link SlashCommandInvocationResult}. + * + * @since 1.0.0 + */ +@JsonIgnoreProperties(ignoreUnknown = true) +@JsonInclude(JsonInclude.Include.NON_NULL) +@javax.annotation.processing.Generated("copilot-sdk-codegen") +public final class SlashCommandInvocationResultSetModel extends SlashCommandInvocationResult { + + @JsonProperty("kind") + private final String kind = "set-model"; + + @Override + public String getKind() { return kind; } + + /** Model selected by the command. */ + @JsonProperty("model") + private String model; + + /** Settings scope modified by the command. */ + @JsonProperty("scope") + private String scope; + + /** User-facing warning produced while selecting the model. */ + @JsonProperty("warning") + private String warning; + + /** Reasoning effort selected for the model. */ + @JsonProperty("reasoningEffort") + private String reasoningEffort; + + /** User-settings snapshot to restore if the host cancels the model switch. */ + @JsonProperty("revertOnCancel") + private Map revertOnCancel; + + /** Repository settings scope modified by the command. */ + @JsonProperty("repoScope") + private String repoScope; + + /** Whether command execution changed persisted runtime settings. */ + @JsonProperty("runtimeSettingsChanged") + private Boolean runtimeSettingsChanged; + + public String getModel() { return model; } + public void setModel(String model) { this.model = model; } + + public String getScope() { return scope; } + public void setScope(String scope) { this.scope = scope; } + + public String getWarning() { return warning; } + public void setWarning(String warning) { this.warning = warning; } + + public String getReasoningEffort() { return reasoningEffort; } + public void setReasoningEffort(String reasoningEffort) { this.reasoningEffort = reasoningEffort; } + + public Map getRevertOnCancel() { return revertOnCancel; } + public void setRevertOnCancel(Map revertOnCancel) { this.revertOnCancel = revertOnCancel; } + + public String getRepoScope() { return repoScope; } + public void setRepoScope(String repoScope) { this.repoScope = repoScope; } + + 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/SlashCommandInvocationResultSetPlanModel.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SlashCommandInvocationResultSetPlanModel.java new file mode 100644 index 0000000000..b57c5a0f52 --- /dev/null +++ b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SlashCommandInvocationResultSetPlanModel.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; + +/** + * Variant {@code set-plan-model} of {@link SlashCommandInvocationResult}. + * + * @since 1.0.0 + */ +@JsonIgnoreProperties(ignoreUnknown = true) +@JsonInclude(JsonInclude.Include.NON_NULL) +@javax.annotation.processing.Generated("copilot-sdk-codegen") +public final class SlashCommandInvocationResultSetPlanModel extends SlashCommandInvocationResult { + + @JsonProperty("kind") + private final String kind = "set-plan-model"; + + @Override + public String getKind() { return kind; } + + /** Dedicated model selected for plan mode. */ + @JsonProperty("planModel") + private String planModel; + + /** User-facing confirmation message for the plan-model selection. */ + @JsonProperty("message") + private String message; + + /** Whether command execution changed persisted runtime settings. */ + @JsonProperty("runtimeSettingsChanged") + private Boolean runtimeSettingsChanged; + + public String getPlanModel() { return planModel; } + public void setPlanModel(String planModel) { this.planModel = planModel; } + + 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/sdk/src/generated/java/com/github/copilot/generated/rpc/SlashCommandInvocationResultShowDialog.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SlashCommandInvocationResultShowDialog.java new file mode 100644 index 0000000000..c8ef4b0702 --- /dev/null +++ b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SlashCommandInvocationResultShowDialog.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; + +/** + * Variant {@code show-dialog} of {@link SlashCommandInvocationResult}. + * + * @since 1.0.0 + */ +@JsonIgnoreProperties(ignoreUnknown = true) +@JsonInclude(JsonInclude.Include.NON_NULL) +@javax.annotation.processing.Generated("copilot-sdk-codegen") +public final class SlashCommandInvocationResultShowDialog extends SlashCommandInvocationResult { + + @JsonProperty("kind") + private final String kind = "show-dialog"; + + @Override + public String getKind() { return kind; } + + /** Dialog the host should display. */ + @JsonProperty("dialog") + private SlashCommandModelPickerDialog dialog; + + /** Whether command execution changed persisted runtime settings. */ + @JsonProperty("runtimeSettingsChanged") + private Boolean runtimeSettingsChanged; + + public SlashCommandModelPickerDialog getDialog() { return dialog; } + public void setDialog(SlashCommandModelPickerDialog dialog) { this.dialog = dialog; } + + 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/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/SlashCommandModelPickerDialog.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SlashCommandModelPickerDialog.java new file mode 100644 index 0000000000..68ba4d29c5 --- /dev/null +++ b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SlashCommandModelPickerDialog.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; + +@javax.annotation.processing.Generated("copilot-sdk-codegen") +@JsonInclude(JsonInclude.Include.NON_NULL) +@JsonIgnoreProperties(ignoreUnknown = true) +public record SlashCommandModelPickerDialog( + /** Discriminator for a model-picker dialog. */ + @JsonProperty("kind") String kind, + /** Model that should be enabled before it can be selected. */ + @JsonProperty("modelToEnable") String modelToEnable, + /** Settings scope the picker should modify. */ + @JsonProperty("scope") String scope, + /** Model-selection target represented by the picker. */ + @JsonProperty("target") String target +) { +} diff --git a/java/src/generated/java/com/github/copilot/generated/rpc/SlashCommandSelectSubcommandOption.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SlashCommandSelectSubcommandOption.java similarity index 100% rename from java/src/generated/java/com/github/copilot/generated/rpc/SlashCommandSelectSubcommandOption.java rename to java/sdk/src/generated/java/com/github/copilot/generated/rpc/SlashCommandSelectSubcommandOption.java diff --git a/java/src/generated/java/com/github/copilot/generated/rpc/SlashCommandSelectSubcommandResult.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SlashCommandSelectSubcommandResult.java similarity index 100% rename from java/src/generated/java/com/github/copilot/generated/rpc/SlashCommandSelectSubcommandResult.java rename to java/sdk/src/generated/java/com/github/copilot/generated/rpc/SlashCommandSelectSubcommandResult.java diff --git a/java/src/generated/java/com/github/copilot/generated/rpc/SlashCommandTextResult.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SlashCommandTextResult.java similarity index 100% rename from java/src/generated/java/com/github/copilot/generated/rpc/SlashCommandTextResult.java rename to java/sdk/src/generated/java/com/github/copilot/generated/rpc/SlashCommandTextResult.java diff --git a/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SlashCommandTimelineEntry.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SlashCommandTimelineEntry.java new file mode 100644 index 0000000000..a238d7fb67 --- /dev/null +++ b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SlashCommandTimelineEntry.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; + +@javax.annotation.processing.Generated("copilot-sdk-codegen") +@JsonInclude(JsonInclude.Include.NON_NULL) +@JsonIgnoreProperties(ignoreUnknown = true) +public record SlashCommandTimelineEntry( + /** Timeline entry presentation type. */ + @JsonProperty("type") String type, + /** Text displayed for the timeline entry. */ + @JsonProperty("text") String text, + /** Optional URL associated with the timeline entry. */ + @JsonProperty("url") String url +) { +} diff --git a/java/src/generated/java/com/github/copilot/generated/rpc/SubagentSettingsEntry.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SubagentSettingsEntry.java similarity index 100% rename from java/src/generated/java/com/github/copilot/generated/rpc/SubagentSettingsEntry.java rename to java/sdk/src/generated/java/com/github/copilot/generated/rpc/SubagentSettingsEntry.java diff --git a/java/src/generated/java/com/github/copilot/generated/rpc/SubagentSettingsEntryContextTier.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SubagentSettingsEntryContextTier.java similarity index 100% rename from java/src/generated/java/com/github/copilot/generated/rpc/SubagentSettingsEntryContextTier.java rename to java/sdk/src/generated/java/com/github/copilot/generated/rpc/SubagentSettingsEntryContextTier.java diff --git a/java/sdk/src/generated/java/com/github/copilot/generated/rpc/TaskCompletionDecision.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/TaskCompletionDecision.java new file mode 100644 index 0000000000..e8ed6ef167 --- /dev/null +++ b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/TaskCompletionDecision.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; + +@javax.annotation.processing.Generated("copilot-sdk-codegen") +@JsonInclude(JsonInclude.Include.NON_NULL) +@JsonIgnoreProperties(ignoreUnknown = true) +public record TaskCompletionDecision( + /** Semantic result of evaluating the task completion request. */ + @JsonProperty("outcome") TaskCompletionOutcome outcome, + /** Rationale for the completion decision, when one is available. */ + @JsonProperty("reason") String reason, + /** Whether the rationale was derived from completion-reviewer output. */ + @JsonProperty("reviewerDerived") Boolean reviewerDerived, + /** Information-flow metadata captured from the completion reviewer. */ + @JsonProperty("reviewerResultMeta") Object reviewerResultMeta, + /** Active autopilot objective evaluated by the completion reviewer. */ + @JsonProperty("objectiveId") Long objectiveId, + /** Whether completion was accepted after the reviewer-rejection budget was exhausted. */ + @JsonProperty("completionRejectionBudgetExhausted") Boolean completionRejectionBudgetExhausted, + /** Objective eligibility token captured when the decision was evaluated. */ + @JsonProperty("completionEligibilityToken") Long completionEligibilityToken +) { +} diff --git a/java/sdk/src/generated/java/com/github/copilot/generated/rpc/TaskCompletionOutcome.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/TaskCompletionOutcome.java new file mode 100644 index 0000000000..18bf78cdc8 --- /dev/null +++ b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/TaskCompletionOutcome.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; + +/** + * 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/sdk/src/generated/java/com/github/copilot/generated/rpc/TokenAuthInfo.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/TokenAuthInfo.java new file mode 100644 index 0000000000..77f580b862 --- /dev/null +++ b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/TokenAuthInfo.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; + +/** + * Authentication-info input variant for SDK-configured token authentication, carrying host and the secret token value. + * + * @since 1.0.0 + */ +@JsonIgnoreProperties(ignoreUnknown = true) +@JsonInclude(JsonInclude.Include.NON_NULL) +@javax.annotation.processing.Generated("copilot-sdk-codegen") +public final class TokenAuthInfo extends AuthInfo { + + @JsonProperty("type") + private final String type = "token"; + + @Override + public String getType() { return type; } + + /** Authentication host. */ + @JsonProperty("host") + private String host; + + /** The token value itself. Treat as a secret. */ + @JsonProperty("token") + private String token; + + /** Opaque native GitHub credential registration backing this token identity, when applicable. */ + @JsonProperty("registrationId") + private String registrationId; + + /** 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. */ + @JsonProperty("copilotUser") + private CopilotUserResponse copilotUser; + + public String getHost() { return host; } + public void setHost(String host) { this.host = host; } + + public String getToken() { return token; } + public void setToken(String token) { this.token = token; } + + public String getRegistrationId() { return registrationId; } + public void setRegistrationId(String registrationId) { this.registrationId = registrationId; } + + public CopilotUserResponse getCopilotUser() { return copilotUser; } + public void setCopilotUser(CopilotUserResponse copilotUser) { this.copilotUser = copilotUser; } +} diff --git a/java/sdk/src/generated/java/com/github/copilot/generated/rpc/TokenProviderAuthInfo.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/TokenProviderAuthInfo.java new file mode 100644 index 0000000000..6bdb811e2b --- /dev/null +++ b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/TokenProviderAuthInfo.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; + +/** + * Authentication-info variant backed by an SDK GitHub token callback. It carries routing metadata but never a plaintext token. + * + * @since 1.0.0 + */ +@JsonIgnoreProperties(ignoreUnknown = true) +@JsonInclude(JsonInclude.Include.NON_NULL) +@javax.annotation.processing.Generated("copilot-sdk-codegen") +public final class TokenProviderAuthInfo extends AuthInfo { + + @JsonProperty("type") + private final String type = "token-provider"; + + @Override + public String getType() { return type; } + + /** Authentication host. */ + @JsonProperty("host") + private String host; + + /** Opaque SDK callback registration identifier. */ + @JsonProperty("registrationId") + private String registrationId; + + /** Snapshot of the authenticated user's Copilot subscription info, if known. */ + @JsonProperty("copilotUser") + private CopilotUserResponse copilotUser; + + public String getHost() { return host; } + public void setHost(String host) { this.host = host; } + + public String getRegistrationId() { return registrationId; } + public void setRegistrationId(String registrationId) { this.registrationId = registrationId; } + + public CopilotUserResponse getCopilotUser() { return copilotUser; } + public void setCopilotUser(CopilotUserResponse copilotUser) { this.copilotUser = copilotUser; } +} 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 100% 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 diff --git a/java/sdk/src/generated/java/com/github/copilot/generated/rpc/ToolResultExpanded.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/ToolResultExpanded.java new file mode 100644 index 0000000000..47527cfec8 --- /dev/null +++ b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/ToolResultExpanded.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 java.util.List; +import java.util.Map; +import javax.annotation.processing.Generated; + +/** + * Expanded canonical result returned by a session tool. + * + * @since 1.0.0 + */ +@javax.annotation.processing.Generated("copilot-sdk-codegen") +@JsonInclude(JsonInclude.Include.NON_NULL) +@JsonIgnoreProperties(ignoreUnknown = true) +public record ToolResultExpanded( + /** Text result returned to the model. */ + @JsonProperty("textResultForLlm") String textResultForLlm, + /** Execution outcome classification. */ + @JsonProperty("resultType") ToolResultType resultType, + /** Base64-encoded binary results returned to the model. */ + @JsonProperty("binaryResultsForLlm") List binaryResultsForLlm, + /** Detailed log content available for session display. */ + @JsonProperty("sessionLog") String sessionLog, + /** Error message for an unsuccessful execution. */ + @JsonProperty("error") String error, + /** Tool-specific telemetry payload. */ + @JsonProperty("toolTelemetry") Object toolTelemetry, + /** Whether large-output post-processing should be skipped. */ + @JsonProperty("skipLargeOutputProcessing") Boolean skipLargeOutputProcessing, + /** Messages to inject after the tool result. */ + @JsonProperty("newMessages") List newMessages, + /** Structured content blocks returned to the model. */ + @JsonProperty("contents") List contents, + /** Deferred tool names made available by this result. */ + @JsonProperty("toolReferences") List toolReferences, + /** Sources returned by the tool that the model may cite. */ + @JsonProperty("citableSources") List citableSources, + /** Skill invocation metadata produced by the tool. */ + @JsonProperty("skillInvocation") Object skillInvocation, + /** Whether post-tool-use failure hooks have already processed this result. */ + @JsonProperty("postToolUseFailureHooksProcessed") Boolean postToolUseFailureHooksProcessed, + /** Optional UI resource produced by the tool. */ + @JsonProperty("uiResource") Object uiResource, + /** Metadata propagated with the tool result, including information-flow labels. */ + @JsonProperty("mcpMeta") Map mcpMeta, + /** Structured result content in addition to the model-facing text. */ + @JsonProperty("structuredContent") Object structuredContent, + /** Completion-review decision produced by the task-completion tool. */ + @JsonProperty("taskCompletionDecision") TaskCompletionDecision taskCompletionDecision +) { +} diff --git a/java/sdk/src/generated/java/com/github/copilot/generated/rpc/ToolResultNewMessage.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/ToolResultNewMessage.java new file mode 100644 index 0000000000..da203a0e98 --- /dev/null +++ b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/ToolResultNewMessage.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 message injected by a tool result. + * + * @since 1.0.0 + */ +@javax.annotation.processing.Generated("copilot-sdk-codegen") +@JsonInclude(JsonInclude.Include.NON_NULL) +@JsonIgnoreProperties(ignoreUnknown = true) +public record ToolResultNewMessage( + /** Message content to inject after the tool result. */ + @JsonProperty("content") String content, + /** Source attributed to the injected message. */ + @JsonProperty("source") String source +) { +} diff --git a/java/sdk/src/generated/java/com/github/copilot/generated/rpc/ToolResultType.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/ToolResultType.java new file mode 100644 index 0000000000..bc3b5ae2ac --- /dev/null +++ b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/ToolResultType.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; + +/** + * Execution outcome classification. + * + * @since 1.0.0 + */ +@javax.annotation.processing.Generated("copilot-sdk-codegen") +public enum ToolResultType { + /** The {@code success} variant. */ + SUCCESS("success"), + /** The {@code failure} variant. */ + FAILURE("failure"), + /** The {@code timeout} variant. */ + TIMEOUT("timeout"), + /** The {@code rejected} variant. */ + REJECTED("rejected"), + /** The {@code denied} variant. */ + DENIED("denied"); + + private final String value; + ToolResultType(String value) { this.value = value; } + @com.fasterxml.jackson.annotation.JsonValue + public String getValue() { return value; } + @com.fasterxml.jackson.annotation.JsonCreator + public static ToolResultType fromValue(String value) { + for (ToolResultType v : values()) { + if (v.value.equals(value)) return v; + } + throw new IllegalArgumentException("Unknown ToolResultType value: " + value); + } +} 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 100% 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 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 100% 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 diff --git a/java/sdk/src/generated/java/com/github/copilot/generated/rpc/ToolsShellDescriptorConfig.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/ToolsShellDescriptorConfig.java new file mode 100644 index 0000000000..fdd5a716a5 --- /dev/null +++ b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/ToolsShellDescriptorConfig.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.List; +import javax.annotation.processing.Generated; + +/** + * Shell-specific names and description lines used to materialize built-in shell tool descriptors. + * + * @since 1.0.0 + */ +@javax.annotation.processing.Generated("copilot-sdk-codegen") +@JsonInclude(JsonInclude.Include.NON_NULL) +@JsonIgnoreProperties(ignoreUnknown = true) +public record ToolsShellDescriptorConfig( + /** Stable shell type identifier. */ + @JsonProperty("shellType") String shellType, + /** Human-readable shell name. */ + @JsonProperty("displayName") String displayName, + /** Tool name used to start shell commands. */ + @JsonProperty("shellToolName") String shellToolName, + /** Tool name used to read shell output. */ + @JsonProperty("readShellToolName") String readShellToolName, + /** Tool name used to stop shell commands. */ + @JsonProperty("stopShellToolName") String stopShellToolName, + /** Tool name used to list active shells. */ + @JsonProperty("listShellsToolName") String listShellsToolName, + /** Additional model-facing shell description lines. */ + @JsonProperty("descriptionLines") List descriptionLines +) { +} 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 87% 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 index e157ee727b..d611a8b447 100644 --- 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 @@ -25,6 +25,8 @@ public record UIElicitationResponse( /** The user's response: accept (submitted), decline (rejected), or cancel (dismissed) */ @JsonProperty("action") UIElicitationResponseAction action, /** The form values submitted by the user (present when action is 'accept') */ - @JsonProperty("content") Map content + @JsonProperty("content") Map content, + /** MCP response metadata. */ + @JsonProperty("_meta") Map> meta ) { } 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/src/generated/java/com/github/copilot/generated/rpc/UIExitPlanModeResponse.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/UIExitPlanModeResponse.java similarity index 76% rename from java/src/generated/java/com/github/copilot/generated/rpc/UIExitPlanModeResponse.java rename to java/sdk/src/generated/java/com/github/copilot/generated/rpc/UIExitPlanModeResponse.java index d74d1b5042..b65b28fc10 100644 --- a/java/src/generated/java/com/github/copilot/generated/rpc/UIExitPlanModeResponse.java +++ b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/UIExitPlanModeResponse.java @@ -28,6 +28,8 @@ public record UIExitPlanModeResponse( /** 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 + @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/src/generated/java/com/github/copilot/generated/rpc/UISessionLimitsExhaustedResponse.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/UISessionLimitsExhaustedResponse.java similarity index 100% rename from java/src/generated/java/com/github/copilot/generated/rpc/UISessionLimitsExhaustedResponse.java rename to java/sdk/src/generated/java/com/github/copilot/generated/rpc/UISessionLimitsExhaustedResponse.java diff --git a/java/src/generated/java/com/github/copilot/generated/rpc/UISessionLimitsExhaustedResponseAction.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/UISessionLimitsExhaustedResponseAction.java similarity index 100% rename from java/src/generated/java/com/github/copilot/generated/rpc/UISessionLimitsExhaustedResponseAction.java rename to java/sdk/src/generated/java/com/github/copilot/generated/rpc/UISessionLimitsExhaustedResponseAction.java 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 100% 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 diff --git a/java/sdk/src/generated/java/com/github/copilot/generated/rpc/UsageMetricsAgentMetric.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/UsageMetricsAgentMetric.java new file mode 100644 index 0000000000..457ba2109e --- /dev/null +++ b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/UsageMetricsAgentMetric.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; + +/** + * Usage attributed to one agent instance, including its identity, API duration, AI units, and per-model breakdown. + * + * @since 1.0.0 + */ +@javax.annotation.processing.Generated("copilot-sdk-codegen") +@JsonInclude(JsonInclude.Include.NON_NULL) +@JsonIgnoreProperties(ignoreUnknown = true) +public record UsageMetricsAgentMetric( + /** Configured agent name, when this is a subagent */ + @JsonProperty("agentName") String agentName, + /** Human-readable label for this subagent invocation, copied from the originating `subagent.started` event. For task-tool subagents this is the invocation's task description rather than the agent's configured display name, so group by `agentName` for stable per-agent labels. */ + @JsonProperty("agentDisplayName") String agentDisplayName, + /** Time spent in model API calls by this agent, in milliseconds */ + @JsonProperty("totalApiDurationMs") Long totalApiDurationMs, + /** Accumulated nano-AI units cost for this agent */ + @JsonProperty("totalNanoAiu") Double totalNanoAiu, + /** Per-model usage for this agent, keyed by model identifier */ + @JsonProperty("modelMetrics") Map modelMetrics +) { +} 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 100% 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 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 100% 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 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 100% 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 diff --git a/java/sdk/src/generated/java/com/github/copilot/generated/rpc/UserAuthInfo.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/UserAuthInfo.java new file mode 100644 index 0000000000..6f136a17c2 --- /dev/null +++ b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/UserAuthInfo.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; + +/** + * Authentication-info variant for OAuth user auth, with host and login; the token remains in the runtime secret store. + * + * @since 1.0.0 + */ +@JsonIgnoreProperties(ignoreUnknown = true) +@JsonInclude(JsonInclude.Include.NON_NULL) +@javax.annotation.processing.Generated("copilot-sdk-codegen") +public final class UserAuthInfo extends AuthInfo { + + @JsonProperty("type") + private final String type = "user"; + + @Override + public String getType() { return type; } + + /** Authentication host. */ + @JsonProperty("host") + private String host; + + /** OAuth user login. */ + @JsonProperty("login") + private String login; + + /** 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. */ + @JsonProperty("copilotUser") + private CopilotUserResponse copilotUser; + + public String getHost() { return host; } + public void setHost(String host) { this.host = host; } + + public String getLogin() { return login; } + public void setLogin(String login) { this.login = login; } + + public CopilotUserResponse getCopilotUser() { return copilotUser; } + public void setCopilotUser(CopilotUserResponse copilotUser) { this.copilotUser = copilotUser; } +} diff --git a/java/src/generated/java/com/github/copilot/generated/rpc/UserSettingMetadata.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/UserSettingMetadata.java similarity index 100% rename from java/src/generated/java/com/github/copilot/generated/rpc/UserSettingMetadata.java rename to java/sdk/src/generated/java/com/github/copilot/generated/rpc/UserSettingMetadata.java diff --git a/java/src/generated/java/com/github/copilot/generated/rpc/UserSettingsGetResult.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/UserSettingsGetResult.java similarity index 100% rename from java/src/generated/java/com/github/copilot/generated/rpc/UserSettingsGetResult.java rename to java/sdk/src/generated/java/com/github/copilot/generated/rpc/UserSettingsGetResult.java diff --git a/java/src/generated/java/com/github/copilot/generated/rpc/UserSettingsSetParams.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/UserSettingsSetParams.java similarity index 100% rename from java/src/generated/java/com/github/copilot/generated/rpc/UserSettingsSetParams.java rename to java/sdk/src/generated/java/com/github/copilot/generated/rpc/UserSettingsSetParams.java diff --git a/java/src/generated/java/com/github/copilot/generated/rpc/UserSettingsSetResult.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/UserSettingsSetResult.java similarity index 100% rename from java/src/generated/java/com/github/copilot/generated/rpc/UserSettingsSetResult.java rename to java/sdk/src/generated/java/com/github/copilot/generated/rpc/UserSettingsSetResult.java diff --git a/java/src/generated/java/com/github/copilot/generated/rpc/Verbosity.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/Verbosity.java similarity index 100% rename from java/src/generated/java/com/github/copilot/generated/rpc/Verbosity.java rename to java/sdk/src/generated/java/com/github/copilot/generated/rpc/Verbosity.java 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 f091bc2799..e63b92b569 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 100% 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 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 100% 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 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/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 similarity index 100% rename from java/src/generated/java/com/github/copilot/generated/rpc/package-info.java rename to java/sdk/src/generated/java/com/github/copilot/generated/rpc/package-info.java diff --git a/java/src/main/java/com/github/copilot/AllowCopilotExperimental.java b/java/sdk/src/main/java/com/github/copilot/AllowCopilotExperimental.java similarity index 100% rename from java/src/main/java/com/github/copilot/AllowCopilotExperimental.java rename to java/sdk/src/main/java/com/github/copilot/AllowCopilotExperimental.java 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 100% rename from java/src/main/java/com/github/copilot/CliServerManager.java rename to java/sdk/src/main/java/com/github/copilot/CliServerManager.java 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/src/main/java/com/github/copilot/CopilotClient.java b/java/sdk/src/main/java/com/github/copilot/CopilotClient.java similarity index 75% rename from java/src/main/java/com/github/copilot/CopilotClient.java rename to java/sdk/src/main/java/com/github/copilot/CopilotClient.java index 7244c8c0a5..ea2b0b67dd 100644 --- a/java/src/main/java/com/github/copilot/CopilotClient.java +++ b/java/sdk/src/main/java/com/github/copilot/CopilotClient.java @@ -5,8 +5,11 @@ 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; @@ -21,8 +24,15 @@ 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; @@ -107,11 +117,14 @@ public final class CopilotClient implements AutoCloseable { private final CliServerManager serverManager; private final LifecycleEventManager lifecycleManager = new LifecycleEventManager(); private final Map sessions = new ConcurrentHashMap<>(); + private final GitHubTokenProviderRegistry gitHubTokenProviders = new GitHubTokenProviderRegistry(); 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(); @@ -131,7 +144,30 @@ public CopilotClient() { * 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()) { @@ -199,6 +235,275 @@ public CopilotClient(CopilotClientOptions 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. * @@ -227,11 +532,15 @@ private CompletableFuture startCore() { private Connection startCoreBody() { Process process = null; + JsonRpcClient rpc = null; + InProcessTransport inProcessTransport = null; long startNanos = System.nanoTime(); try { - JsonRpcClient rpc; - - if (optionsHost != null && optionsPort != null) { + 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 { @@ -245,11 +554,14 @@ private Connection startCoreBody() { LoggingHelpers.logTiming(LOG, Level.FINE, "CopilotClient.start transport setup complete. Elapsed={Elapsed}", startNanos); - Connection connection = new Connection(rpc, process, new ServerRpc(rpc::invoke)); + 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(rpc); + RpcHandlerDispatcher dispatcher = new RpcHandlerDispatcher(sessions, lifecycleManager::dispatch, executor, + gitHubTokenProviders); + dispatcher.registerHandlers(connectedRpc); // Register the LLM inference request handler when configured. com.github.copilot.CopilotRequestHandler requestHandler = this.options.getRequestHandler(); @@ -257,7 +569,7 @@ private Connection startCoreBody() { if (hasLlmInference) { LlmInferenceAdapter llmAdapter = new LlmInferenceAdapter(requestHandler, () -> connection.serverRpc().llmInference, executor); - llmAdapter.registerHandlers(rpc); + llmAdapter.registerHandlers(connectedRpc); } // Register the GitHub telemetry forwarding handler when configured. @@ -265,7 +577,7 @@ private Connection startCoreBody() { .getOnGitHubTelemetry(); if (onGitHubTelemetry != null) { GitHubTelemetryAdapter telemetryAdapter = new GitHubTelemetryAdapter(onGitHubTelemetry); - telemetryAdapter.registerHandlers(rpc); + telemetryAdapter.registerHandlers(connectedRpc); } // Verify protocol version @@ -273,6 +585,15 @@ private Connection startCoreBody() { 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(); @@ -289,6 +610,16 @@ private Connection startCoreBody() { 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( @@ -398,6 +729,7 @@ public CompletableFuture stop() { closeFutures.add(future); } sessions.clear(); + gitHubTokenProviders.clear(); return CompletableFuture.allOf(closeFutures.toArray(new CompletableFuture[0])) .thenCompose(v -> cleanupConnection(true)); @@ -411,6 +743,7 @@ public CompletableFuture stop() { public CompletableFuture forceStop() { disposed = true; sessions.clear(); + gitHubTokenProviders.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 @@ -438,7 +771,7 @@ private CompletableFuture cleanupConnection(boolean gracefulRuntimeShutdow } CompletableFuture shutdownFuture = CompletableFuture.completedFuture(null); - if (gracefulRuntimeShutdown && connection.process != 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) @@ -465,6 +798,9 @@ private CompletableFuture cleanupConnection(boolean gracefulRuntimeShutdow if (connection.process != null) { cleanupCliProcess(connection.process, !gracefulRuntimeShutdown || error != null); } + if (connection.runtimeHost != null) { + closeRuntimeHost(connection.runtimeHost); + } return (Void) null; }); }).thenCompose(result -> result); @@ -541,6 +877,10 @@ public CompletableFuture createSession(SessionConfig config) { + "For example, to allow all permissions, use: " + "new SessionConfig().setOnPermissionRequest(PermissionHandler.APPROVE_ALL)")); } + if (config.getGitHubToken() != null && config.getGitHubTokenProvider() != null) { + return CompletableFuture.failedFuture( + new IllegalArgumentException("gitHubToken and gitHubTokenProvider are mutually exclusive")); + } return ensureConnected().thenCompose(connection -> { long totalNanos = System.nanoTime(); // For cloud sessions, let the CLI/server assign the session id @@ -593,7 +933,7 @@ public CompletableFuture createSession(SessionConfig config) { registeredIdHolder[0] = localSessionId; } - var request = SessionRequestBuilder.buildCreateRequest(config, localSessionId); + var request = SessionRequestBuilder.buildCreateRequest(config, localSessionId, options.getMode()); if (extracted.wireSystemMessage() != config.getSystemMessage()) { request.setSystemMessage(extracted.wireSystemMessage()); } @@ -646,6 +986,16 @@ public CompletableFuture createSession(SessionConfig config) { } } + GitHubTokenProviderRegistry.Registration tokenRegistration = config.getGitHubTokenProvider() == null + ? null + : gitHubTokenProviders.register(config.getGitHubTokenProvider()); + if (tokenRegistration != null) { + request.setGitHubTokenProviderRegistrationId(tokenRegistration.id()); + if (preRegisteredSessionHolder[0] != null) { + preRegisteredSessionHolder[0].setGitHubTokenProviderRegistration(tokenRegistration); + } + } + long rpcNanos = System.nanoTime(); return connection.rpc.invoke("session.create", request, CreateSessionResponse.class) .thenCompose(response -> { @@ -664,6 +1014,9 @@ public CompletableFuture createSession(SessionConfig config) { CopilotSession session = preRegisteredSessionHolder[0] != null ? preRegisteredSessionHolder[0] : initializeSession.apply(returnedId); + if (tokenRegistration != null) { + session.setGitHubTokenProviderRegistration(tokenRegistration); + } registeredIdHolder[0] = returnedId; CompletableFuture interest = config.getOnMcpAuthRequest() != null ? session.getRpc().eventLog.registerInterest( @@ -678,8 +1031,13 @@ public CompletableFuture createSession(SessionConfig config) { return updateSessionOptionsForMode(session, config.getSkipCustomInstructions().orElse(null), config.getCustomAgentsLocalOnly().orElse(null), config.getCoauthorEnabled().orElse(null), - config.getManageScheduleEnabled().orElse(null)); + config.getManageScheduleEnabled().orElse(null), config.getIncludedBuiltinSkills()); }).thenApply(v -> { + if (tokenRegistration != null) { + tokenRegistration.claim(session.getSessionId()); + } else { + gitHubTokenProviders.retire(session.getSessionId()); + } LoggingHelpers.logTiming(LOG, Level.FINE, "CopilotClient.createSession complete. Elapsed={Elapsed}, SessionId=" + session.getSessionId(), @@ -690,6 +1048,9 @@ public CompletableFuture createSession(SessionConfig config) { if (registeredIdHolder[0] != null) { sessions.remove(registeredIdHolder[0]); } + if (tokenRegistration != null) { + tokenRegistration.close(); + } LoggingHelpers.logTiming(LOG, Level.WARNING, ex, "CopilotClient.createSession failed. Elapsed={Elapsed}, SessionId=" + (registeredIdHolder[0] != null ? registeredIdHolder[0] : ""), @@ -737,10 +1098,15 @@ public CompletableFuture resumeSession(String sessionId, ResumeS + "For example, to allow all permissions, use: " + "new ResumeSessionConfig().setOnPermissionRequest(PermissionHandler.APPROVE_ALL)")); } + if (config.getGitHubToken() != null && config.getGitHubTokenProvider() != null) { + return CompletableFuture.failedFuture( + new IllegalArgumentException("gitHubToken and gitHubTokenProvider are mutually exclusive")); + } return ensureConnected().thenCompose(connection -> { long totalNanos = System.nanoTime(); // Register the session before the RPC call to avoid missing early events. long setupNanos = System.nanoTime(); + CopilotSession replacedSession = sessions.get(sessionId); var session = new CopilotSession(sessionId, connection.rpc); session.setExecutor(executor); SessionRequestBuilder.configureSession(session, config); @@ -754,7 +1120,7 @@ public CompletableFuture resumeSession(String sessionId, ResumeS if (extracted.transformCallbacks() != null) { session.registerTransformCallbacks(extracted.transformCallbacks()); } - var request = SessionRequestBuilder.buildResumeRequest(sessionId, config); + var request = SessionRequestBuilder.buildResumeRequest(sessionId, config, options.getMode()); if (extracted.wireSystemMessage() != config.getSystemMessage()) { request.setSystemMessage(extracted.wireSystemMessage()); } @@ -805,6 +1171,14 @@ public CompletableFuture resumeSession(String sessionId, ResumeS } } + GitHubTokenProviderRegistry.Registration tokenRegistration = config.getGitHubTokenProvider() == null + ? null + : gitHubTokenProviders.register(config.getGitHubTokenProvider()); + if (tokenRegistration != null) { + request.setGitHubTokenProviderRegistrationId(tokenRegistration.id()); + session.setGitHubTokenProviderRegistration(tokenRegistration); + } + long rpcNanos = System.nanoTime(); return connection.rpc.invoke("session.resume", request, ResumeSessionResponse.class) .thenCompose(response -> { @@ -834,15 +1208,20 @@ public CompletableFuture resumeSession(String sessionId, ResumeS 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 -> { + config.getManageScheduleEnabled().orElse(null), config.getIncludedBuiltinSkills()) + .thenApply(v -> { LoggingHelpers.logTiming(LOG, Level.FINE, "CopilotClient.resumeSession complete. Elapsed={Elapsed}, SessionId=" + sessionId, totalNanos); + if (tokenRegistration != null) { + tokenRegistration.claim(session.getSessionId()); + } else { + gitHubTokenProviders.retire(session.getSessionId()); + } return session; }); }).exceptionally(ex -> { @@ -852,6 +1231,12 @@ public CompletableFuture resumeSession(String sessionId, ResumeS if (!sessionId.equals(activeId)) { sessions.remove(activeId); } + if (replacedSession != null) { + sessions.putIfAbsent(sessionId, replacedSession); + } + if (tokenRegistration != null) { + tokenRegistration.close(); + } LoggingHelpers.logTiming(LOG, Level.WARNING, ex, "CopilotClient.resumeSession failed. Elapsed={Elapsed}, SessionId=" + sessionId, totalNanos); @@ -860,14 +1245,22 @@ public CompletableFuture resumeSession(String sessionId, ResumeS }); } + CompletableFuture updateSessionOptionsForMode(CopilotSession session, Boolean skipCustomInstructions, + Boolean customAgentsLocalOnly, Boolean coauthorEnabled, Boolean manageScheduleEnabled) { + return updateSessionOptionsForMode(session, skipCustomInstructions, customAgentsLocalOnly, coauthorEnabled, + manageScheduleEnabled, null); + } + /** * 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. + * {@code installedPlugins=[]} is unconditional under empty mode. + * {@code includedBuiltinSkills} defaults to an empty list, but callers can + * explicitly allow selected runtime-bundled skills. In + * {@link CopilotClientMode#COPILOT_CLI COPILOT_CLI} mode only explicitly-set + * fields are forwarded. * * @param session * the session to patch @@ -879,16 +1272,21 @@ public CompletableFuture resumeSession(String sessionId, ResumeS * caller-supplied value, or {@code null} if not set * @param manageScheduleEnabled * caller-supplied value, or {@code null} if not set + * @param includedBuiltinSkills + * caller-supplied built-in skill allowlist, 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 customAgentsLocalOnly, Boolean coauthorEnabled, Boolean manageScheduleEnabled, + List includedBuiltinSkills) { Boolean patchSkip = null; Boolean patchAgents = null; Boolean patchCoauthor = null; Boolean patchSchedule = null; List patchPlugins = null; + List patchSkills = null; boolean hasAnyPatch = false; if (options.getMode() == CopilotClientMode.EMPTY) { @@ -897,6 +1295,7 @@ CompletableFuture updateSessionOptionsForMode(CopilotSession session, Bool patchCoauthor = coauthorEnabled != null ? coauthorEnabled : false; patchSchedule = manageScheduleEnabled != null ? manageScheduleEnabled : false; patchPlugins = List.of(); + patchSkills = includedBuiltinSkills != null ? includedBuiltinSkills : List.of(); hasAnyPatch = true; } else { if (skipCustomInstructions != null) { @@ -915,6 +1314,10 @@ CompletableFuture updateSessionOptionsForMode(CopilotSession session, Bool patchSchedule = manageScheduleEnabled; hasAnyPatch = true; } + if (includedBuiltinSkills != null) { + patchSkills = includedBuiltinSkills; + hasAnyPatch = true; + } } if (!hasAnyPatch) { @@ -941,13 +1344,16 @@ CompletableFuture updateSessionOptionsForMode(CopilotSession session, Bool null, // excludedBuiltinAgents null, // toolFilterPrecedence null, // enableScriptSafety + null, // shell null, // shellInitProfile null, // shellProcessFlags null, // sandboxConfig + null, // sandboxConfigSource null, // logInteractiveShells null, // envValueMode null, // allowAllMcpServerInstructions null, // skillDirectories + patchSkills, // includedBuiltinSkills null, // disabledSkills null, // enableOnDemandInstructionDiscovery null, // maxInlineBinaryBytes @@ -966,6 +1372,7 @@ CompletableFuture updateSessionOptionsForMode(CopilotSession session, Bool null, // enableReasoningSummaries null, // agentContext null, // eventsLogDirectory + null, // eventsLogIncludesSubagents null, // additionalContentExclusionPolicies patchSchedule, // manageScheduleEnabled null, // sessionCapabilities @@ -1169,7 +1576,10 @@ public CompletableFuture deleteSession(String sessionId) { if (!response.success()) { throw new RuntimeException("Failed to delete session " + sessionId + ": " + response.error()); } - sessions.remove(sessionId); + CopilotSession session = sessions.remove(sessionId); + if (session != null) { + session.releaseGitHubTokenProviderRegistration(); + } })); } @@ -1351,6 +1761,9 @@ public void close() { LOG.log(Level.FINE, "Error during close", e); } finally { shutdownOwnedExecutor(); + if (closeHook != null) { + closeHook.run(); + } } } @@ -1390,7 +1803,8 @@ private void shutdownOwnedExecutor() { } } - private static record Connection(JsonRpcClient rpc, Process process, ServerRpc serverRpc) { + private static record Connection(JsonRpcClient rpc, Process process, ServerRpc serverRpc, + AutoCloseable runtimeHost) { }; } diff --git a/java/src/main/java/com/github/copilot/CopilotExperimental.java b/java/sdk/src/main/java/com/github/copilot/CopilotExperimental.java similarity index 100% rename from java/src/main/java/com/github/copilot/CopilotExperimental.java rename to java/sdk/src/main/java/com/github/copilot/CopilotExperimental.java diff --git a/java/src/main/java/com/github/copilot/CopilotExperimentalProcessor.java b/java/sdk/src/main/java/com/github/copilot/CopilotExperimentalProcessor.java similarity index 100% rename from java/src/main/java/com/github/copilot/CopilotExperimentalProcessor.java rename to java/sdk/src/main/java/com/github/copilot/CopilotExperimentalProcessor.java diff --git a/java/src/main/java/com/github/copilot/CopilotRequestContext.java b/java/sdk/src/main/java/com/github/copilot/CopilotRequestContext.java similarity index 100% rename from java/src/main/java/com/github/copilot/CopilotRequestContext.java rename to java/sdk/src/main/java/com/github/copilot/CopilotRequestContext.java diff --git a/java/src/main/java/com/github/copilot/CopilotRequestHandler.java b/java/sdk/src/main/java/com/github/copilot/CopilotRequestHandler.java similarity index 100% rename from java/src/main/java/com/github/copilot/CopilotRequestHandler.java rename to java/sdk/src/main/java/com/github/copilot/CopilotRequestHandler.java diff --git a/java/src/main/java/com/github/copilot/CopilotRequestTransport.java b/java/sdk/src/main/java/com/github/copilot/CopilotRequestTransport.java similarity index 100% rename from java/src/main/java/com/github/copilot/CopilotRequestTransport.java rename to java/sdk/src/main/java/com/github/copilot/CopilotRequestTransport.java 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 96% rename from java/src/main/java/com/github/copilot/CopilotSession.java rename to java/sdk/src/main/java/com/github/copilot/CopilotSession.java index b8b253de2e..f3a35967d3 100644 --- a/java/src/main/java/com/github/copilot/CopilotSession.java +++ b/java/sdk/src/main/java/com/github/copilot/CopilotSession.java @@ -57,6 +57,7 @@ import com.github.copilot.generated.SessionErrorEvent; import com.github.copilot.generated.SessionEvent; import com.github.copilot.generated.SessionIdleEvent; +import com.github.copilot.generated.SessionMode; import com.github.copilot.generated.rpc.OpenCanvasInstance; import com.github.copilot.rpc.AgentInfo; import com.github.copilot.rpc.AutoModeSwitchHandler; @@ -110,6 +111,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. @@ -185,6 +187,7 @@ public final class CopilotSession implements AutoCloseable { 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<>(); @@ -196,6 +199,7 @@ public final class CopilotSession implements AutoCloseable { private volatile Map>> transformCallbacks; private final ScheduledExecutorService timeoutScheduler; private volatile Executor executor; + private volatile GitHubTokenProviderRegistry.Registration gitHubTokenProviderRegistration; /** Tracks whether this session instance has been terminated via close(). */ private volatile boolean isTerminated = false; @@ -250,6 +254,18 @@ void setExecutor(Executor executor) { this.executor = executor; } + void setGitHubTokenProviderRegistration(GitHubTokenProviderRegistry.Registration registration) { + this.gitHubTokenProviderRegistration = registration; + } + + synchronized void releaseGitHubTokenProviderRegistration() { + GitHubTokenProviderRegistry.Registration registration = gitHubTokenProviderRegistration; + gitHubTokenProviderRegistration = null; + if (registration != null) { + registration.close(); + } + } + /** * Gets the unique identifier for this session. * @@ -547,7 +563,8 @@ public CompletableFuture sendAndWait(MessageOptions optio + sessionId, totalNanos); } - } else if (evt instanceof SessionIdleEvent) { + } else if (evt instanceof SessionIdleEvent idleEvent + && (idleEvent.getData() == null || idleEvent.getData().mode() != SessionMode.AUTOPILOT)) { LoggingHelpers.logTiming(LOG, Level.FINE, "CopilotSession.sendAndWait idle received. Elapsed={Elapsed}, SessionId=" + sessionId, totalNanos); @@ -999,7 +1016,7 @@ private void executeToolAndRespondAsync(String requestId, String toolName, Strin * future completes exceptionally. */ private SessionUiHandlePendingElicitationParams buildElicitationCancelParams(String requestId) { - var cancelResult = new UIElicitationResponse(UIElicitationResponseAction.CANCEL, null); + var cancelResult = new UIElicitationResponse(UIElicitationResponseAction.CANCEL, null, null); return new SessionUiHandlePendingElicitationParams(sessionId, requestId, cancelResult); } @@ -1013,6 +1030,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()); @@ -1022,18 +1040,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); } @@ -1045,7 +1064,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); } @@ -1208,7 +1228,7 @@ private void handleElicitationRequestAsync(ElicitationContext context, String re ? result.getAction().getValue() : ElicitationResultAction.CANCEL.getValue(); var parsedAction = UIElicitationResponseAction.fromValue(actionStr); - var elicitationResult = new UIElicitationResponse(parsedAction, result.getContent()); + var elicitationResult = new UIElicitationResponse(parsedAction, result.getContent(), null); getRpc().ui.handlePendingElicitation( new SessionUiHandlePendingElicitationParams(sessionId, requestId, elicitationResult)); } catch (Exception e) { @@ -1263,10 +1283,10 @@ private final class SessionUiApiImpl implements SessionUiApi { @Override public CompletableFuture elicitation(ElicitationParams params) { assertElicitation(); - return getRpc().ui.elicitation(new SessionUiElicitationParams(sessionId, params.getMessage(), + return getRpc().ui.elicitation(new SessionUiElicitationParams(sessionId, null, params.getMessage(), new UIElicitationSchema(params.getRequestedSchema().getType(), - params.getRequestedSchema().getProperties(), params.getRequestedSchema().getRequired()))) - .thenApply(resp -> { + params.getRequestedSchema().getProperties(), params.getRequestedSchema().getRequired()), + null, null)).thenApply(resp -> { var result = new ElicitationResult(); if (resp.action() != null) { for (ElicitationResultAction a : ElicitationResultAction.values()) { @@ -1288,8 +1308,9 @@ public CompletableFuture elicitation(ElicitationParams params public CompletableFuture confirm(String message) { assertElicitation(); var field = Map.of("type", "boolean", "default", (Object) true); - return getRpc().ui.elicitation(new SessionUiElicitationParams(sessionId, message, - new UIElicitationSchema("object", Map.of("confirmed", (Object) field), List.of("confirmed")))) + return getRpc().ui + .elicitation(new SessionUiElicitationParams(sessionId, null, message, new UIElicitationSchema( + "object", Map.of("confirmed", (Object) field), List.of("confirmed")), null, null)) .thenApply(resp -> { if (resp.action() == UIElicitationResponseAction.ACCEPT && resp.content() != null) { Object val = resp.content().get("confirmed"); @@ -1311,8 +1332,9 @@ public CompletableFuture confirm(String message) { public CompletableFuture select(String message, String[] options) { assertElicitation(); var field = Map.of("type", (Object) "string", "enum", (Object) options); - return getRpc().ui.elicitation(new SessionUiElicitationParams(sessionId, message, - new UIElicitationSchema("object", Map.of("selection", (Object) field), List.of("selection")))) + return getRpc().ui + .elicitation(new SessionUiElicitationParams(sessionId, null, message, new UIElicitationSchema( + "object", Map.of("selection", (Object) field), List.of("selection")), null, null)) .thenApply(resp -> { if (resp.action() == UIElicitationResponseAction.ACCEPT && resp.content() != null) { Object val = resp.content().get("selection"); @@ -1341,9 +1363,8 @@ public CompletableFuture input(String message, InputOptions options) { if (options.getDefaultValue() != null) field.put("default", options.getDefaultValue()); } - return getRpc().ui - .elicitation(new SessionUiElicitationParams(sessionId, message, - new UIElicitationSchema("object", Map.of("value", (Object) field), List.of("value")))) + return getRpc().ui.elicitation(new SessionUiElicitationParams(sessionId, null, message, + new UIElicitationSchema("object", Map.of("value", (Object) field), List.of("value")), null, null)) .thenApply(resp -> { if (resp.action() == UIElicitationResponseAction.ACCEPT && resp.content() != null) { Object val = resp.content().get("value"); @@ -1378,6 +1399,10 @@ void registerPermissionHandler(PermissionHandler handler) { permissionHandler.set(handler); } + void setManagedSettingsEnabled(boolean managedSettingsEnabled) { + this.managedSettingsEnabled = managedSettingsEnabled; + } + void registerMcpAuthHandler(McpAuthHandler handler) { mcpAuthHandler.set(handler); } @@ -1403,6 +1428,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(); @@ -1861,6 +1887,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); @@ -1964,7 +2001,8 @@ public CompletableFuture abort() { * 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 @@ -1972,9 +2010,8 @@ public CompletableFuture abort() { */ public CompletableFuture setModel(String model, String reasoningEffort) { ensureNotTerminated(); - return getRpc().model - .switchTo(new SessionModelSwitchToParams(sessionId, model, reasoningEffort, null, null, null, null)) - .thenApply(r -> null); + return getRpc().model.switchTo(new SessionModelSwitchToParams(sessionId, model, reasoningEffort, null, null, + null, null, null, null, null, null, null, null, null, null)).thenApply(r -> null); } /** @@ -1994,7 +2031,8 @@ public CompletableFuture setModel(String model, String reasoningEffort) { * 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 @@ -2053,8 +2091,10 @@ public CompletableFuture setModel(String model, String reasoningEffort, St var generatedReasoningSummary = reasoningSummary == null ? null : com.github.copilot.generated.rpc.ReasoningSummary.fromValue(reasoningSummary); - return getRpc().model.switchTo(new SessionModelSwitchToParams(sessionId, model, reasoningEffort, - generatedReasoningSummary, null, generatedCapabilities, null)).thenApply(r -> null); + return getRpc().model + .switchTo(new SessionModelSwitchToParams(sessionId, model, reasoningEffort, generatedReasoningSummary, + null, generatedCapabilities, null, null, null, null, null, null, null, null, null)) + .thenApply(r -> null); } /** @@ -2276,6 +2316,7 @@ public void close() { } timeoutScheduler.shutdownNow(); + releaseGitHubTokenProviderRegistration(); try { rpc.invoke("session.destroy", Map.of("sessionId", sessionId), Void.class).get(5, TimeUnit.SECONDS); diff --git a/java/src/main/java/com/github/copilot/CopilotWebSocketCloseStatus.java b/java/sdk/src/main/java/com/github/copilot/CopilotWebSocketCloseStatus.java similarity index 100% rename from java/src/main/java/com/github/copilot/CopilotWebSocketCloseStatus.java rename to java/sdk/src/main/java/com/github/copilot/CopilotWebSocketCloseStatus.java diff --git a/java/src/main/java/com/github/copilot/CopilotWebSocketForwarder.java b/java/sdk/src/main/java/com/github/copilot/CopilotWebSocketForwarder.java similarity index 100% rename from java/src/main/java/com/github/copilot/CopilotWebSocketForwarder.java rename to java/sdk/src/main/java/com/github/copilot/CopilotWebSocketForwarder.java diff --git a/java/src/main/java/com/github/copilot/CopilotWebSocketHandler.java b/java/sdk/src/main/java/com/github/copilot/CopilotWebSocketHandler.java similarity index 100% rename from java/src/main/java/com/github/copilot/CopilotWebSocketHandler.java rename to java/sdk/src/main/java/com/github/copilot/CopilotWebSocketHandler.java diff --git a/java/src/main/java/com/github/copilot/CopilotWebSocketMessage.java b/java/sdk/src/main/java/com/github/copilot/CopilotWebSocketMessage.java similarity index 100% rename from java/src/main/java/com/github/copilot/CopilotWebSocketMessage.java rename to java/sdk/src/main/java/com/github/copilot/CopilotWebSocketMessage.java 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/src/main/java/com/github/copilot/GitHubTelemetryAdapter.java b/java/sdk/src/main/java/com/github/copilot/GitHubTelemetryAdapter.java similarity index 100% rename from java/src/main/java/com/github/copilot/GitHubTelemetryAdapter.java rename to java/sdk/src/main/java/com/github/copilot/GitHubTelemetryAdapter.java diff --git a/java/sdk/src/main/java/com/github/copilot/GitHubTokenProviderRegistry.java b/java/sdk/src/main/java/com/github/copilot/GitHubTokenProviderRegistry.java new file mode 100644 index 0000000000..59b4f61469 --- /dev/null +++ b/java/sdk/src/main/java/com/github/copilot/GitHubTokenProviderRegistry.java @@ -0,0 +1,79 @@ +/*--------------------------------------------------------------------------------------------- + * Copyright (c) Microsoft Corporation. All rights reserved. + *--------------------------------------------------------------------------------------------*/ + +package com.github.copilot; + +import java.util.HashMap; +import java.util.Map; +import java.util.UUID; + +import com.github.copilot.rpc.GitHubTokenProvider; + +final class GitHubTokenProviderRegistry { + + private final Map providers = new HashMap<>(); + private final Map sessionOwners = new HashMap<>(); + + synchronized Registration register(GitHubTokenProvider provider) { + String id = UUID.randomUUID().toString(); + providers.put(id, provider); + return new Registration(this, id); + } + + synchronized GitHubTokenProvider get(String registrationId) { + return providers.get(registrationId); + } + + private synchronized void claim(String registrationId, String sessionId) { + String previous = sessionOwners.put(sessionId, registrationId); + if (previous != null && !previous.equals(registrationId)) { + providers.remove(previous); + } + } + + private synchronized void unregister(String registrationId) { + providers.remove(registrationId); + sessionOwners.values().removeIf(registrationId::equals); + } + + synchronized void retire(String sessionId) { + String registrationId = sessionOwners.remove(sessionId); + if (registrationId != null) { + providers.remove(registrationId); + } + } + + synchronized void clear() { + providers.clear(); + sessionOwners.clear(); + } + + static final class Registration implements AutoCloseable { + + private final GitHubTokenProviderRegistry registry; + private final String id; + private boolean closed; + + private Registration(GitHubTokenProviderRegistry registry, String id) { + this.registry = registry; + this.id = id; + } + + String id() { + return id; + } + + void claim(String sessionId) { + registry.claim(id, sessionId); + } + + @Override + public synchronized void close() { + if (!closed) { + closed = true; + registry.unregister(id); + } + } + } +} 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 82% rename from java/src/main/java/com/github/copilot/JsonRpcClient.java rename to java/sdk/src/main/java/com/github/copilot/JsonRpcClient.java index 5303c4f500..7eda069d23 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; @@ -27,6 +28,7 @@ import com.fasterxml.jackson.databind.JsonNode; import com.fasterxml.jackson.databind.ObjectMapper; import com.fasterxml.jackson.databind.SerializationFeature; +import com.fasterxml.jackson.databind.node.ObjectNode; import com.fasterxml.jackson.datatype.jsr310.JavaTimeModule; import com.github.copilot.rpc.JsonRpcError; import com.github.copilot.rpc.JsonRpcRequest; @@ -46,6 +48,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 +56,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(); } @@ -93,6 +110,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). @@ -191,7 +221,39 @@ private synchronized void sendMessage(Object message) throws IOException { outputStream.write(content); outputStream.flush(); - LOG.fine("Sent: " + json); + if (LOG.isLoggable(Level.FINE)) { + LOG.fine("Sent: " + redactCredentialsForLogging(json)); + } + } + + static String redactCredentialsForLogging(String json) { + try { + JsonNode root = MAPPER.readTree(json); + redactCredentials(root); + return MAPPER.writeValueAsString(root); + } catch (JsonProcessingException error) { + return ""; + } + } + + private static void redactCredentials(JsonNode node) { + if (node.isObject()) { + var object = (ObjectNode) node; + object.properties().forEach(entry -> { + if (isCredentialField(entry.getKey())) { + object.put(entry.getKey(), ""); + } else { + redactCredentials(entry.getValue()); + } + }); + } else if (node.isArray()) { + node.forEach(JsonRpcClient::redactCredentials); + } + } + + private static boolean isCredentialField(String name) { + return name.equals("accessToken") || name.equals("gitHubToken") || name.equals("bearerToken") + || name.equals("apiKey"); } private void startReader() { @@ -344,6 +406,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/src/main/java/com/github/copilot/LlmInferenceAdapter.java b/java/sdk/src/main/java/com/github/copilot/LlmInferenceAdapter.java similarity index 100% rename from java/src/main/java/com/github/copilot/LlmInferenceAdapter.java rename to java/sdk/src/main/java/com/github/copilot/LlmInferenceAdapter.java diff --git a/java/src/main/java/com/github/copilot/LlmInferenceExchange.java b/java/sdk/src/main/java/com/github/copilot/LlmInferenceExchange.java similarity index 100% rename from java/src/main/java/com/github/copilot/LlmInferenceExchange.java rename to java/sdk/src/main/java/com/github/copilot/LlmInferenceExchange.java diff --git a/java/src/main/java/com/github/copilot/LlmWebSocketResponseBridge.java b/java/sdk/src/main/java/com/github/copilot/LlmWebSocketResponseBridge.java similarity index 100% rename from java/src/main/java/com/github/copilot/LlmWebSocketResponseBridge.java rename to java/sdk/src/main/java/com/github/copilot/LlmWebSocketResponseBridge.java 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 d2dff958dc..0dd8a5dc98 100644 --- a/java/src/main/java/com/github/copilot/RpcHandlerDispatcher.java +++ b/java/sdk/src/main/java/com/github/copilot/RpcHandlerDispatcher.java @@ -20,7 +20,12 @@ import com.github.copilot.rpc.AutoModeSwitchRequest; import com.github.copilot.rpc.ExitPlanModeRequest; import com.github.copilot.rpc.BearerTokenProvider; +import com.github.copilot.rpc.GitHubTokenProviderArgs; +import com.github.copilot.rpc.GitHubTokenProviderResult; import com.github.copilot.rpc.ProviderTokenArgs; +import com.github.copilot.generated.rpc.GitHubTokenAcquireRequest; +import com.github.copilot.generated.rpc.GitHubTokenAcquireResultCancelled; +import com.github.copilot.generated.rpc.GitHubTokenAcquireResultToken; import com.github.copilot.rpc.PermissionRequestResult; import com.github.copilot.rpc.PermissionRequestResultKind; import com.github.copilot.rpc.SessionLifecycleEvent; @@ -51,6 +56,7 @@ final class RpcHandlerDispatcher { private final Map sessions; private final LifecycleEventDispatcher lifecycleDispatcher; private final Executor executor; + private final GitHubTokenProviderRegistry gitHubTokenProviders; /** * Creates a dispatcher with session registry and lifecycle dispatcher. @@ -63,10 +69,11 @@ final class RpcHandlerDispatcher { * the executor for async dispatch, or {@code null} for default */ RpcHandlerDispatcher(Map sessions, LifecycleEventDispatcher lifecycleDispatcher, - Executor executor) { + Executor executor, GitHubTokenProviderRegistry gitHubTokenProviders) { this.sessions = sessions; this.lifecycleDispatcher = lifecycleDispatcher; this.executor = executor; + this.gitHubTokenProviders = gitHubTokenProviders; } /** @@ -92,6 +99,71 @@ void registerHandlers(JsonRpcClient rpc) { (requestId, params) -> handleSystemMessageTransform(rpc, requestId, params)); rpc.registerMethodHandler("providerToken.getToken", (requestId, params) -> handleProviderTokenGetToken(rpc, requestId, params)); + rpc.registerMethodHandler("gitHubToken.getToken", + (requestId, params) -> handleGitHubTokenGetToken(rpc, requestId, params)); + } + + private void handleGitHubTokenGetToken(JsonRpcClient rpc, String requestId, JsonNode params) { + runAsync(() -> { + final long requestIdLong = parseRequestId(requestId, "gitHubToken.getToken"); + if (requestIdLong == -1) { + return; + } + try { + GitHubTokenAcquireRequest request = MAPPER.treeToValue(params, GitHubTokenAcquireRequest.class); + var provider = gitHubTokenProviders.get(request.registrationId()); + if (provider == null) { + rpc.sendErrorResponse(requestIdLong, -32603, "Unknown GitHub token provider registration"); + return; + } + + var resultFuture = provider + .getToken(new GitHubTokenProviderArgs(request.host(), request.sessionId(), request.reason())); + if (resultFuture == null) { + rpc.sendErrorResponse(requestIdLong, -32603, "GitHub token provider returned a null future"); + return; + } + resultFuture.thenAccept(result -> sendGitHubTokenResult(rpc, requestIdLong, result)) + .exceptionally(error -> { + try { + Throwable cause = error instanceof java.util.concurrent.CompletionException + && error.getCause() != null ? error.getCause() : error; + rpc.sendErrorResponse(requestIdLong, -32603, + "GitHub token provider failed: " + cause.getMessage()); + } catch (IOException sendError) { + LOG.log(Level.SEVERE, "Error sending GitHub token provider error", sendError); + } + return null; + }); + } catch (Exception error) { + try { + rpc.sendErrorResponse(requestIdLong, -32603, + "GitHub token provider handler failed: " + error.getMessage()); + } catch (IOException sendError) { + LOG.log(Level.SEVERE, "Error sending GitHub token provider handler error", sendError); + } + } + }); + } + + private void sendGitHubTokenResult(JsonRpcClient rpc, long requestId, GitHubTokenProviderResult result) { + try { + if (result == null) { + rpc.sendErrorResponse(requestId, -32603, "GitHub token provider returned a null result"); + return; + } + if (result.isCancelled()) { + rpc.sendResponse(requestId, new GitHubTokenAcquireResultCancelled()); + return; + } + var wireResult = new GitHubTokenAcquireResultToken(); + wireResult.setAccessToken(result.getAccessToken()); + wireResult.setExpiresIn(result.getExpiresIn()); + wireResult.setTokenType(result.getTokenType()); + rpc.sendResponse(requestId, wireResult); + } catch (IOException error) { + LOG.log(Level.SEVERE, "Error sending GitHub token provider result", error); + } } private void handleSessionEvent(JsonNode params) { 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/src/main/java/com/github/copilot/SessionRequestBuilder.java b/java/sdk/src/main/java/com/github/copilot/SessionRequestBuilder.java similarity index 87% rename from java/src/main/java/com/github/copilot/SessionRequestBuilder.java rename to java/sdk/src/main/java/com/github/copilot/SessionRequestBuilder.java index 57d9a46a21..4254c04ec4 100644 --- a/java/src/main/java/com/github/copilot/SessionRequestBuilder.java +++ b/java/sdk/src/main/java/com/github/copilot/SessionRequestBuilder.java @@ -7,9 +7,11 @@ 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; @@ -97,6 +99,10 @@ static ExtractedTransforms extractTransformCallbacks(SystemMessageConfig systemM * @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); @@ -104,6 +110,7 @@ static CreateSessionRequest buildCreateRequest(SessionConfig config, String sess request.setEnvValueMode("direct"); request.setSessionId(sessionId); if (config == null) { + request.setCustomAgentsLocalOnly(resolveCustomAgentsLocalOnly(null, mode)); return request; } @@ -123,7 +130,10 @@ static CreateSessionRequest buildCreateRequest(SessionConfig config, String sess 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); } @@ -131,6 +141,7 @@ static CreateSessionRequest buildCreateRequest(SessionConfig config, String sess request.setHooks(true); } request.setWorkingDirectory(config.getWorkingDirectory()); + request.setAdditionalDirectories(config.getAdditionalDirectories()); if (config.isStreaming()) { request.setStreaming(true); } @@ -138,6 +149,8 @@ static CreateSessionRequest buildCreateRequest(SessionConfig config, String sess 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()); @@ -148,6 +161,7 @@ static CreateSessionRequest buildCreateRequest(SessionConfig config, String sess 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); @@ -176,6 +190,7 @@ static CreateSessionRequest buildCreateRequest(SessionConfig config, String sess if (config.isEnableMcpApps()) { request.setRequestMcpApps(true); } + request.setGitHubMcpToolConfig(config.getGitHubMcpToolConfig()); if (config.getOnExitPlanMode() != null) { request.setRequestExitPlanMode(true); } @@ -187,6 +202,7 @@ static CreateSessionRequest buildCreateRequest(SessionConfig config, String sess request.setCloud(config.getCloud()); request.setExpAssignments(config.getExpAssignments()); config.getEnableManagedSettings().ifPresent(request::setEnableManagedSettings); + request.setManagedSettings(config.getManagedSettings()); return request; } @@ -217,6 +233,11 @@ static CreateSessionRequest buildCreateRequest(SessionConfig config) { * @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 @@ -225,6 +246,7 @@ static ResumeSessionRequest buildResumeRequest(String sessionId, ResumeSessionCo request.setEnvValueMode("direct"); if (config == null) { + request.setCustomAgentsLocalOnly(resolveCustomAgentsLocalOnly(null, mode)); return request; } @@ -244,7 +266,10 @@ static ResumeSessionRequest buildResumeRequest(String sessionId, ResumeSessionCo 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); } @@ -252,6 +277,7 @@ static ResumeSessionRequest buildResumeRequest(String sessionId, ResumeSessionCo 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); @@ -276,6 +302,8 @@ static ResumeSessionRequest buildResumeRequest(String sessionId, ResumeSessionCo 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()); @@ -285,6 +313,7 @@ static ResumeSessionRequest buildResumeRequest(String sessionId, ResumeSessionCo request.setToolSearch(config.getToolSearch()); request.setMemory(config.getMemory()); request.setDisabledSkills(config.getDisabledSkills()); + request.setDisabledMcpServers(config.getDisabledMcpServers()); request.setInfiniteSessions(config.getInfiniteSessions()); request.setModelCapabilities(config.getModelCapabilities()); @@ -300,6 +329,7 @@ static ResumeSessionRequest buildResumeRequest(String sessionId, ResumeSessionCo if (config.isEnableMcpApps()) { request.setRequestMcpApps(true); } + request.setGitHubMcpToolConfig(config.getGitHubMcpToolConfig()); if (config.getOnExitPlanMode() != null) { request.setRequestExitPlanMode(true); } @@ -310,10 +340,25 @@ static ResumeSessionRequest buildResumeRequest(String sessionId, ResumeSessionCo 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. * @@ -333,6 +378,8 @@ static void configureSession(CopilotSession session, SessionConfig config) { 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()); } @@ -383,6 +430,8 @@ static void configureSession(CopilotSession session, ResumeSessionConfig config) 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()); } 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 100% rename from java/src/main/java/com/github/copilot/SystemMessageMode.java rename to java/sdk/src/main/java/com/github/copilot/SystemMessageMode.java 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 0000000000..4198f08f02 --- /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 0000000000..5e7d2d461a --- /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 0000000000..ba3c3c40a5 --- /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 0000000000..3aa8ca9e4d --- /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 0000000000..6733f4afb2 --- /dev/null +++ b/java/sdk/src/main/java/com/github/copilot/ffi/NativeRuntimeLoader.java @@ -0,0 +1,506 @@ +/*--------------------------------------------------------------------------------------------- + * 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.AccessDeniedException; +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 | AccessDeniedException ex) { + // Windows can report AccessDeniedException instead of + // FileAlreadyExistsException when another publisher wins the race. + 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 0000000000..597feea9e0 --- /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 0000000000..466cf794bc --- /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 0000000000..977182d5f4 --- /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 0000000000..b0824fa9a7 --- /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 0000000000..5bec1c327c --- /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/src/main/java/com/github/copilot/package-info.java b/java/sdk/src/main/java/com/github/copilot/package-info.java similarity index 100% rename from java/src/main/java/com/github/copilot/package-info.java rename to java/sdk/src/main/java/com/github/copilot/package-info.java diff --git a/java/src/main/java/com/github/copilot/rpc/AgentInfo.java b/java/sdk/src/main/java/com/github/copilot/rpc/AgentInfo.java similarity index 100% rename from java/src/main/java/com/github/copilot/rpc/AgentInfo.java rename to java/sdk/src/main/java/com/github/copilot/rpc/AgentInfo.java 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/src/main/java/com/github/copilot/rpc/AgentStopHandler.java b/java/sdk/src/main/java/com/github/copilot/rpc/AgentStopHandler.java similarity index 100% rename from java/src/main/java/com/github/copilot/rpc/AgentStopHandler.java rename to java/sdk/src/main/java/com/github/copilot/rpc/AgentStopHandler.java diff --git a/java/src/main/java/com/github/copilot/rpc/AgentStopHookInput.java b/java/sdk/src/main/java/com/github/copilot/rpc/AgentStopHookInput.java similarity index 100% rename from java/src/main/java/com/github/copilot/rpc/AgentStopHookInput.java rename to java/sdk/src/main/java/com/github/copilot/rpc/AgentStopHookInput.java diff --git a/java/src/main/java/com/github/copilot/rpc/AgentStopHookOutput.java b/java/sdk/src/main/java/com/github/copilot/rpc/AgentStopHookOutput.java similarity index 100% rename from java/src/main/java/com/github/copilot/rpc/AgentStopHookOutput.java rename to java/sdk/src/main/java/com/github/copilot/rpc/AgentStopHookOutput.java 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 100% 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 diff --git a/java/src/main/java/com/github/copilot/rpc/BearerTokenProvider.java b/java/sdk/src/main/java/com/github/copilot/rpc/BearerTokenProvider.java similarity index 100% rename from java/src/main/java/com/github/copilot/rpc/BearerTokenProvider.java rename to java/sdk/src/main/java/com/github/copilot/rpc/BearerTokenProvider.java 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 100% 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 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/src/main/java/com/github/copilot/rpc/CapiSessionOptions.java b/java/sdk/src/main/java/com/github/copilot/rpc/CapiSessionOptions.java similarity index 100% rename from java/src/main/java/com/github/copilot/rpc/CapiSessionOptions.java rename to java/sdk/src/main/java/com/github/copilot/rpc/CapiSessionOptions.java 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 92% 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 index 20b8d5b63d..892f124d58 100644 --- a/java/src/main/java/com/github/copilot/rpc/CommandWireDefinition.java +++ b/java/sdk/src/main/java/com/github/copilot/rpc/CommandWireDefinition.java @@ -31,7 +31,7 @@ public CommandWireDefinition() { /** Creates a definition with name and description. */ public CommandWireDefinition(String name, String description) { this.name = name; - this.description = description; + this.description = description == null ? "" : description; } /** Gets the command name. @return the name */ @@ -52,7 +52,7 @@ public String getDescription() { /** Sets the description. @param description the description @return this */ public CommandWireDefinition setDescription(String description) { - this.description = description; + this.description = description == null ? "" : description; return this; } } 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 89% 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 0d4494d738..d3515509b5 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,11 +4,15 @@ 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; @@ -19,8 +23,6 @@ import com.github.copilot.CopilotExperimental; import com.github.copilot.CopilotRequestHandler; import com.github.copilot.generated.rpc.GitHubTelemetryNotification; -import java.util.Optional; -import java.util.OptionalInt; /** * Configuration options for creating a @@ -48,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; @@ -119,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. *

@@ -204,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.). * @@ -248,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; } @@ -751,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; diff --git a/java/src/main/java/com/github/copilot/rpc/CopilotExpAssignmentResponse.java b/java/sdk/src/main/java/com/github/copilot/rpc/CopilotExpAssignmentResponse.java similarity index 100% rename from java/src/main/java/com/github/copilot/rpc/CopilotExpAssignmentResponse.java rename to java/sdk/src/main/java/com/github/copilot/rpc/CopilotExpAssignmentResponse.java diff --git a/java/src/main/java/com/github/copilot/rpc/CreateSessionRequest.java b/java/sdk/src/main/java/com/github/copilot/rpc/CreateSessionRequest.java similarity index 87% rename from java/src/main/java/com/github/copilot/rpc/CreateSessionRequest.java rename to java/sdk/src/main/java/com/github/copilot/rpc/CreateSessionRequest.java index 9a9f4f152f..403893987d 100644 --- a/java/src/main/java/com/github/copilot/rpc/CreateSessionRequest.java +++ b/java/sdk/src/main/java/com/github/copilot/rpc/CreateSessionRequest.java @@ -80,6 +80,9 @@ public final class CreateSessionRequest { @JsonProperty("enableCitations") private Boolean enableCitations; + @JsonProperty("enableFileChangeTracking") + private Boolean enableFileChangeTracking; + @JsonProperty("sessionLimits") private SessionLimitsConfig sessionLimits; @@ -95,6 +98,9 @@ public final class CreateSessionRequest { @JsonProperty("workingDirectory") private String workingDirectory; + @JsonProperty("additionalDirectories") + private List additionalDirectories; + @JsonProperty("streaming") private Boolean streaming; @@ -116,6 +122,9 @@ public final class CreateSessionRequest { @JsonProperty("customAgents") private List customAgents; + @JsonProperty("customAgentsLocalOnly") + private Boolean customAgentsLocalOnly; + @JsonProperty("defaultAgent") private DefaultAgentConfig defaultAgent; @@ -146,6 +155,9 @@ public final class CreateSessionRequest { @JsonProperty("disabledSkills") private List disabledSkills; + @JsonProperty("disabledMcpServers") + private List disabledMcpServers; + @JsonProperty("configDir") private String configDirectory; @@ -193,6 +205,13 @@ public final class CreateSessionRequest { @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; @@ -205,6 +224,9 @@ public final class CreateSessionRequest { @JsonProperty("gitHubToken") private String gitHubToken; + @JsonProperty("gitHubTokenProviderRegistrationId") + private String gitHubTokenProviderRegistrationId; + @JsonProperty("remoteSession") private String remoteSession; @@ -218,6 +240,10 @@ public final class CreateSessionRequest { @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; @@ -414,6 +440,21 @@ 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; @@ -492,6 +533,21 @@ 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; @@ -552,6 +608,19 @@ 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; @@ -656,6 +725,18 @@ 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; @@ -902,6 +983,40 @@ 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; @@ -949,6 +1064,21 @@ public void setGitHubToken(String gitHubToken) { this.gitHubToken = gitHubToken; } + /** + * Gets the token-provider registration ID. @return the opaque registration ID + */ + public String getGitHubTokenProviderRegistrationId() { + return gitHubTokenProviderRegistrationId; + } + + /** + * Sets the token-provider registration ID. @param registrationId the opaque + * registration ID + */ + public void setGitHubTokenProviderRegistrationId(String registrationId) { + this.gitHubTokenProviderRegistrationId = registrationId; + } + /** Gets the remote session mode. @return the remote session mode */ public String getRemoteSession() { return remoteSession; @@ -1005,4 +1135,17 @@ public void setEnableManagedSettings(boolean enableManagedSettings) { 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/src/main/java/com/github/copilot/rpc/CreateSessionResponse.java b/java/sdk/src/main/java/com/github/copilot/rpc/CreateSessionResponse.java similarity index 100% rename from java/src/main/java/com/github/copilot/rpc/CreateSessionResponse.java rename to java/sdk/src/main/java/com/github/copilot/rpc/CreateSessionResponse.java 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 100% 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 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/sdk/src/main/java/com/github/copilot/rpc/DisableBypassPermissionsModes.java b/java/sdk/src/main/java/com/github/copilot/rpc/DisableBypassPermissionsModes.java new file mode 100644 index 0000000000..cf98f0526d --- /dev/null +++ b/java/sdk/src/main/java/com/github/copilot/rpc/DisableBypassPermissionsModes.java @@ -0,0 +1,23 @@ +/*--------------------------------------------------------------------------------------------- + * Copyright (c) Microsoft Corporation. All rights reserved. + *--------------------------------------------------------------------------------------------*/ +package com.github.copilot.rpc; + +/** + * Known values for the managed bypass-permissions policy. + * + *

+ * The wire contract is an open string so callers can pass newer fail-closed + * modes directly to + * {@link ManagedSettingsPermissions#setDisableBypassPermissionsMode(String)}. + */ +public final class DisableBypassPermissionsModes { + /** Turns off bypass-permissions mode. */ + public static final String DISABLE = "disable"; + + /** Permits bypass only for automatic operations. */ + public static final String ALLOW_AUTO_ONLY = "allow-auto-only"; + + private DisableBypassPermissionsModes() { + } +} 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/src/main/java/com/github/copilot/rpc/ExpConfigEntry.java b/java/sdk/src/main/java/com/github/copilot/rpc/ExpConfigEntry.java similarity index 100% rename from java/src/main/java/com/github/copilot/rpc/ExpConfigEntry.java rename to java/sdk/src/main/java/com/github/copilot/rpc/ExpConfigEntry.java 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 0000000000..75a8e30163 --- /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/sdk/src/main/java/com/github/copilot/rpc/GitHubTokenProvider.java b/java/sdk/src/main/java/com/github/copilot/rpc/GitHubTokenProvider.java new file mode 100644 index 0000000000..daefc2f8d8 --- /dev/null +++ b/java/sdk/src/main/java/com/github/copilot/rpc/GitHubTokenProvider.java @@ -0,0 +1,31 @@ +/*--------------------------------------------------------------------------------------------- + * Copyright (c) Microsoft Corporation. All rights reserved. + *--------------------------------------------------------------------------------------------*/ + +package com.github.copilot.rpc; + +import java.util.concurrent.CompletableFuture; + +/** + * Acquires rotating GitHub tokens for one session. + *

+ * Implementations return either a token with a positive remaining lifetime or + * an explicit cancellation. Production GitHub tokens typically last eight + * hours. Initial cancellation, callback errors, and invalid token responses + * reject session creation or resume instead of falling back to ambient + * authentication. + * + * @since 1.0.0 + */ +@FunctionalInterface +public interface GitHubTokenProvider { + + /** + * Acquires a GitHub token for the supplied host and session context. + * + * @param args + * callback context + * @return a future containing a token or cancellation result + */ + CompletableFuture getToken(GitHubTokenProviderArgs args); +} diff --git a/java/sdk/src/main/java/com/github/copilot/rpc/GitHubTokenProviderArgs.java b/java/sdk/src/main/java/com/github/copilot/rpc/GitHubTokenProviderArgs.java new file mode 100644 index 0000000000..283d3c4c7f --- /dev/null +++ b/java/sdk/src/main/java/com/github/copilot/rpc/GitHubTokenProviderArgs.java @@ -0,0 +1,22 @@ +/*--------------------------------------------------------------------------------------------- + * Copyright (c) Microsoft Corporation. All rights reserved. + *--------------------------------------------------------------------------------------------*/ + +package com.github.copilot.rpc; + +import com.github.copilot.generated.rpc.GitHubTokenAcquireReason; + +/** + * Context supplied when a session needs a GitHub token. + * + * @param host + * effective GitHub host for which a token is required + * @param sessionId + * session receiving the token, or {@code null} before a cloud + * session has been assigned an ID + * @param reason + * whether this is the initial acquisition or a refresh + * @since 1.0.0 + */ +public record GitHubTokenProviderArgs(String host, String sessionId, GitHubTokenAcquireReason reason) { +} diff --git a/java/sdk/src/main/java/com/github/copilot/rpc/GitHubTokenProviderResult.java b/java/sdk/src/main/java/com/github/copilot/rpc/GitHubTokenProviderResult.java new file mode 100644 index 0000000000..9425286431 --- /dev/null +++ b/java/sdk/src/main/java/com/github/copilot/rpc/GitHubTokenProviderResult.java @@ -0,0 +1,113 @@ +/*--------------------------------------------------------------------------------------------- + * Copyright (c) Microsoft Corporation. All rights reserved. + *--------------------------------------------------------------------------------------------*/ + +package com.github.copilot.rpc; + +import java.util.Objects; + +/** + * Result of acquiring a session-scoped GitHub token. + *

+ * Token values are redacted from {@link #toString()}. + * + * @since 1.0.0 + */ +public final class GitHubTokenProviderResult { + + private final String accessToken; + private final long expiresIn; + private final String tokenType; + private final boolean cancelled; + + private GitHubTokenProviderResult(String accessToken, long expiresIn, String tokenType, boolean cancelled) { + this.accessToken = accessToken; + this.expiresIn = expiresIn; + this.tokenType = tokenType; + this.cancelled = cancelled; + } + + /** + * Creates a token result. + * + * @param accessToken + * GitHub access token + * @param expiresIn + * positive remaining lifetime in seconds when the callback completes + * @return the token result + */ + public static GitHubTokenProviderResult token(String accessToken, long expiresIn) { + return token(accessToken, expiresIn, null); + } + + /** + * Creates a token result with an explicit OAuth token type. + * + * @param accessToken + * GitHub access token + * @param expiresIn + * positive remaining lifetime in seconds when the callback completes + * @param tokenType + * OAuth token type, or {@code null} to use the runtime's bearer + * default + * @return the token result + */ + public static GitHubTokenProviderResult token(String accessToken, long expiresIn, String tokenType) { + Objects.requireNonNull(accessToken, "accessToken must not be null"); + return new GitHubTokenProviderResult(accessToken, expiresIn, tokenType, false); + } + + /** + * Creates an explicit cancellation result. + * + * @return the cancellation result + */ + public static GitHubTokenProviderResult cancelled() { + return new GitHubTokenProviderResult(null, 0, null, true); + } + + /** + * Gets whether acquisition was cancelled. + * + * @return {@code true} for a cancellation result + */ + public boolean isCancelled() { + return cancelled; + } + + /** + * Gets the access token. + * + * @return the token, or {@code null} for cancellation + */ + public String getAccessToken() { + return accessToken; + } + + /** + * Gets the remaining token lifetime. + * + * @return remaining lifetime in seconds + */ + public long getExpiresIn() { + return expiresIn; + } + + /** + * Gets the OAuth token type. + * + * @return token type, or {@code null} for the runtime default + */ + public String getTokenType() { + return tokenType; + } + + @Override + public String toString() { + if (cancelled) { + return "GitHubTokenProviderResult{cancelled}"; + } + return "GitHubTokenProviderResult{accessToken=, expiresIn=" + expiresIn + ", tokenType=" + tokenType + + "}"; + } +} 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 0000000000..274f8b89dc --- /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 0000000000..39e8fcf55a --- /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 0000000000..6755d959b3 --- /dev/null +++ b/java/sdk/src/main/java/com/github/copilot/rpc/ManagedSettingsPermissions.java @@ -0,0 +1,91 @@ +/*--------------------------------------------------------------------------------------------- + * 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 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 String 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 String getDisableBypassPermissionsMode() { + return disableBypassPermissionsMode; + } + + /** + * Restricts bypass/allow-all permission modes. See + * {@link DisableBypassPermissionsModes} for known values. Newer values are + * forwarded unchanged so runtime policies remain fail-closed. + * + * @param value + * bypass-permissions policy + * @return this policy + */ + public ManagedSettingsPermissions setDisableBypassPermissionsMode(String 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/src/main/java/com/github/copilot/rpc/McpAuthHandler.java b/java/sdk/src/main/java/com/github/copilot/rpc/McpAuthHandler.java similarity index 100% rename from java/src/main/java/com/github/copilot/rpc/McpAuthHandler.java rename to java/sdk/src/main/java/com/github/copilot/rpc/McpAuthHandler.java diff --git a/java/src/main/java/com/github/copilot/rpc/McpAuthInvocation.java b/java/sdk/src/main/java/com/github/copilot/rpc/McpAuthInvocation.java similarity index 100% rename from java/src/main/java/com/github/copilot/rpc/McpAuthInvocation.java rename to java/sdk/src/main/java/com/github/copilot/rpc/McpAuthInvocation.java diff --git a/java/src/main/java/com/github/copilot/rpc/McpAuthRequest.java b/java/sdk/src/main/java/com/github/copilot/rpc/McpAuthRequest.java similarity index 100% rename from java/src/main/java/com/github/copilot/rpc/McpAuthRequest.java rename to java/sdk/src/main/java/com/github/copilot/rpc/McpAuthRequest.java diff --git a/java/src/main/java/com/github/copilot/rpc/McpAuthResult.java b/java/sdk/src/main/java/com/github/copilot/rpc/McpAuthResult.java similarity index 100% rename from java/src/main/java/com/github/copilot/rpc/McpAuthResult.java rename to java/sdk/src/main/java/com/github/copilot/rpc/McpAuthResult.java diff --git a/java/src/main/java/com/github/copilot/rpc/McpAuthToken.java b/java/sdk/src/main/java/com/github/copilot/rpc/McpAuthToken.java similarity index 100% rename from java/src/main/java/com/github/copilot/rpc/McpAuthToken.java rename to java/sdk/src/main/java/com/github/copilot/rpc/McpAuthToken.java 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 99% 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 index 8ce739ffbd..c68aecb63f 100644 --- a/java/src/main/java/com/github/copilot/rpc/McpStdioServerConfig.java +++ b/java/sdk/src/main/java/com/github/copilot/rpc/McpStdioServerConfig.java @@ -45,7 +45,7 @@ public final class McpStdioServerConfig extends McpServerConfig { @JsonProperty("env") private Map env; - @JsonProperty("workingDirectory") + @JsonProperty("cwd") private String workingDirectory; /** diff --git a/java/src/main/java/com/github/copilot/rpc/MemoryConfiguration.java b/java/sdk/src/main/java/com/github/copilot/rpc/MemoryConfiguration.java similarity index 100% rename from java/src/main/java/com/github/copilot/rpc/MemoryConfiguration.java rename to java/sdk/src/main/java/com/github/copilot/rpc/MemoryConfiguration.java 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 100% 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 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/src/main/java/com/github/copilot/rpc/ModelBilling.java b/java/sdk/src/main/java/com/github/copilot/rpc/ModelBilling.java similarity index 100% rename from java/src/main/java/com/github/copilot/rpc/ModelBilling.java rename to java/sdk/src/main/java/com/github/copilot/rpc/ModelBilling.java 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/src/main/java/com/github/copilot/rpc/NamedProviderConfig.java b/java/sdk/src/main/java/com/github/copilot/rpc/NamedProviderConfig.java similarity index 100% rename from java/src/main/java/com/github/copilot/rpc/NamedProviderConfig.java rename to java/sdk/src/main/java/com/github/copilot/rpc/NamedProviderConfig.java diff --git a/java/src/main/java/com/github/copilot/rpc/ParamCoercion.java b/java/sdk/src/main/java/com/github/copilot/rpc/ParamCoercion.java similarity index 100% rename from java/src/main/java/com/github/copilot/rpc/ParamCoercion.java rename to java/sdk/src/main/java/com/github/copilot/rpc/ParamCoercion.java diff --git a/java/src/main/java/com/github/copilot/rpc/ParamSchema.java b/java/sdk/src/main/java/com/github/copilot/rpc/ParamSchema.java similarity index 100% rename from java/src/main/java/com/github/copilot/rpc/ParamSchema.java rename to java/sdk/src/main/java/com/github/copilot/rpc/ParamSchema.java diff --git a/java/src/main/java/com/github/copilot/rpc/PermissionHandler.java b/java/sdk/src/main/java/com/github/copilot/rpc/PermissionHandler.java similarity index 65% rename from java/src/main/java/com/github/copilot/rpc/PermissionHandler.java rename to java/sdk/src/main/java/com/github/copilot/rpc/PermissionHandler.java index bd8e70b750..58639beda2 100644 --- a/java/src/main/java/com/github/copilot/rpc/PermissionHandler.java +++ b/java/sdk/src/main/java/com/github/copilot/rpc/PermissionHandler.java @@ -17,6 +17,11 @@ * * 

{@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
@@ -29,6 +34,11 @@
  * 			.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 @@ -43,12 +53,21 @@ public interface PermissionHandler { /** - * A pre-built handler that approves all permission requests. + * A pre-built handler that approves permission requests when managed settings + * are disabled. * * @since 1.0.11 */ - PermissionHandler APPROVE_ALL = (request, invocation) -> CompletableFuture - .completedFuture(new PermissionRequestResult().setKind(PermissionRequestResultKind.APPROVED)); + 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. diff --git a/java/src/main/java/com/github/copilot/rpc/PermissionInvocation.java b/java/sdk/src/main/java/com/github/copilot/rpc/PermissionInvocation.java similarity index 60% rename from java/src/main/java/com/github/copilot/rpc/PermissionInvocation.java rename to java/sdk/src/main/java/com/github/copilot/rpc/PermissionInvocation.java index bda5bdde0a..10988cc1b7 100644 --- a/java/src/main/java/com/github/copilot/rpc/PermissionInvocation.java +++ b/java/sdk/src/main/java/com/github/copilot/rpc/PermissionInvocation.java @@ -16,6 +16,7 @@ public final class PermissionInvocation { private String sessionId; + private boolean managedSettingsEnabled; /** * Gets the session ID where the permission was requested. @@ -37,4 +38,25 @@ 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 0000000000..fc49332b8a --- /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/src/main/java/com/github/copilot/rpc/PermissionRequestResult.java b/java/sdk/src/main/java/com/github/copilot/rpc/PermissionRequestResult.java similarity index 74% rename from java/src/main/java/com/github/copilot/rpc/PermissionRequestResult.java rename to java/sdk/src/main/java/com/github/copilot/rpc/PermissionRequestResult.java index 2e5c60100a..6546291cf7 100644 --- a/java/src/main/java/com/github/copilot/rpc/PermissionRequestResult.java +++ b/java/sdk/src/main/java/com/github/copilot/rpc/PermissionRequestResult.java @@ -6,8 +6,10 @@ 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. @@ -42,6 +44,15 @@ public final class PermissionRequestResult { @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. * @@ -168,4 +179,35 @@ 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/src/main/java/com/github/copilot/rpc/ProviderConfig.java b/java/sdk/src/main/java/com/github/copilot/rpc/ProviderConfig.java similarity index 100% rename from java/src/main/java/com/github/copilot/rpc/ProviderConfig.java rename to java/sdk/src/main/java/com/github/copilot/rpc/ProviderConfig.java diff --git a/java/src/main/java/com/github/copilot/rpc/ProviderModelConfig.java b/java/sdk/src/main/java/com/github/copilot/rpc/ProviderModelConfig.java similarity index 100% rename from java/src/main/java/com/github/copilot/rpc/ProviderModelConfig.java rename to java/sdk/src/main/java/com/github/copilot/rpc/ProviderModelConfig.java diff --git a/java/src/main/java/com/github/copilot/rpc/ProviderTokenArgs.java b/java/sdk/src/main/java/com/github/copilot/rpc/ProviderTokenArgs.java similarity index 100% rename from java/src/main/java/com/github/copilot/rpc/ProviderTokenArgs.java rename to java/sdk/src/main/java/com/github/copilot/rpc/ProviderTokenArgs.java 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 86% 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 a3dd336cf5..a55c3454e7 100644 --- a/java/src/main/java/com/github/copilot/rpc/ResumeSessionConfig.java +++ b/java/sdk/src/main/java/com/github/copilot/rpc/ResumeSessionConfig.java @@ -53,7 +53,9 @@ public class ResumeSessionConfig { 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; @@ -67,6 +69,7 @@ public class ResumeSessionConfig { private UserInputHandler onUserInputRequest; private SessionHooks hooks; private String workingDirectory; + private List additionalDirectories; private String configDirectory; private Boolean enableConfigDiscovery; private Boolean skipEmbeddingRetrieval; @@ -86,12 +89,14 @@ public class ResumeSessionConfig { private DefaultAgentConfig defaultAgent; private String agent; private List skillDirectories; + private List includedBuiltinSkills; 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; @@ -99,10 +104,14 @@ public class ResumeSessionConfig { private ExitPlanModeHandler onExitPlanMode; private AutoModeSwitchHandler onAutoModeSwitch; private boolean enableMcpApps; + private GitHubMcpToolConfig githubMcpToolConfig; private String gitHubToken; + @JsonIgnore + private GitHubTokenProvider gitHubTokenProvider; private String remoteSession; private CopilotExpAssignmentResponse expAssignments; private Boolean enableManagedSettings; + private ManagedSettings managedSettings; /** * Gets the AI model to use. @@ -448,6 +457,41 @@ public ResumeSessionConfig clearEnableCitations() { 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. * @@ -471,6 +515,52 @@ public ResumeSessionConfig setSessionLimits(SessionLimitsConfig 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. * @@ -526,11 +616,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 @@ -636,7 +726,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; @@ -645,7 +736,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 @@ -811,6 +902,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. * @@ -847,12 +959,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 @@ -1384,6 +1492,28 @@ public ResumeSessionConfig setSkillDirectories(List skillDirectories) { return this; } + /** + * Gets the runtime-bundled skill allowlist. + * + * @return the built-in skill names, or {@code null} when unspecified + */ + public List getIncludedBuiltinSkills() { + return includedBuiltinSkills == null ? null : Collections.unmodifiableList(includedBuiltinSkills); + } + + /** + * Sets the runtime-bundled skill allowlist. In empty mode, omitting this option + * excludes all built-in skills; specifying names opts those built-ins back in. + * + * @param includedBuiltinSkills + * the built-in skill names to allow + * @return this config for method chaining + */ + public ResumeSessionConfig setIncludedBuiltinSkills(List includedBuiltinSkills) { + this.includedBuiltinSkills = includedBuiltinSkills; + return this; + } + /** * Gets the additional directories to search for custom instruction files. * @@ -1510,6 +1640,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. * @@ -1634,6 +1787,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. * @@ -1715,6 +1889,33 @@ public ResumeSessionConfig setGitHubToken(String gitHubToken) { return this; } + /** + * Gets the rotating GitHub token provider for the resumed session. + * + * @return the provider, or {@code null} when a static token is used + */ + public GitHubTokenProvider getGitHubTokenProvider() { + return gitHubTokenProvider; + } + + /** + * Sets the rotating GitHub token provider for the resumed session. + *

+ * The provider receives only the effective host, optional assigned session ID, + * and acquisition reason. It must return a positive remaining lifetime in + * seconds when its callback completes. Production GitHub tokens typically last + * eight hours. This option is mutually exclusive with + * {@link #setGitHubToken(String)}. + * + * @param gitHubTokenProvider + * provider used for initial acquisition and refresh + * @return this config instance for method chaining + */ + public ResumeSessionConfig setGitHubTokenProvider(GitHubTokenProvider gitHubTokenProvider) { + this.gitHubTokenProvider = gitHubTokenProvider; + return this; + } + /** * Gets the per-session remote behavior control. *

@@ -1798,6 +1999,24 @@ public ResumeSessionConfig setEnableManagedSettings(boolean enableManagedSetting 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. *

@@ -1827,7 +2046,9 @@ public ResumeSessionConfig clone() { 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; @@ -1836,6 +2057,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; @@ -1854,6 +2078,9 @@ public ResumeSessionConfig clone() { copy.defaultAgent = this.defaultAgent; copy.agent = this.agent; copy.skillDirectories = this.skillDirectories != null ? new ArrayList<>(this.skillDirectories) : null; + copy.includedBuiltinSkills = this.includedBuiltinSkills != null + ? new ArrayList<>(this.includedBuiltinSkills) + : null; copy.instructionDirectories = this.instructionDirectories != null ? new ArrayList<>(this.instructionDirectories) : null; @@ -1862,6 +2089,7 @@ public ResumeSessionConfig clone() { 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; @@ -1870,10 +2098,13 @@ public ResumeSessionConfig clone() { copy.onExitPlanMode = this.onExitPlanMode; copy.onAutoModeSwitch = this.onAutoModeSwitch; copy.enableMcpApps = this.enableMcpApps; + copy.githubMcpToolConfig = this.githubMcpToolConfig; copy.gitHubToken = this.gitHubToken; + copy.gitHubTokenProvider = this.gitHubTokenProvider; copy.remoteSession = this.remoteSession; 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/ResumeSessionRequest.java b/java/sdk/src/main/java/com/github/copilot/rpc/ResumeSessionRequest.java similarity index 87% rename from java/src/main/java/com/github/copilot/rpc/ResumeSessionRequest.java rename to java/sdk/src/main/java/com/github/copilot/rpc/ResumeSessionRequest.java index a81ed49dde..9b8e897fda 100644 --- a/java/src/main/java/com/github/copilot/rpc/ResumeSessionRequest.java +++ b/java/sdk/src/main/java/com/github/copilot/rpc/ResumeSessionRequest.java @@ -82,6 +82,9 @@ public final class ResumeSessionRequest { @JsonProperty("enableCitations") private Boolean enableCitations; + @JsonProperty("enableFileChangeTracking") + private Boolean enableFileChangeTracking; + @JsonProperty("sessionLimits") private SessionLimitsConfig sessionLimits; @@ -97,6 +100,9 @@ public final class ResumeSessionRequest { @JsonProperty("workingDirectory") private String workingDirectory; + @JsonProperty("additionalDirectories") + private List additionalDirectories; + @JsonProperty("configDir") private String configDirectory; @@ -159,6 +165,9 @@ public final class ResumeSessionRequest { @JsonProperty("customAgents") private List customAgents; + @JsonProperty("customAgentsLocalOnly") + private Boolean customAgentsLocalOnly; + @JsonProperty("defaultAgent") private DefaultAgentConfig defaultAgent; @@ -186,6 +195,9 @@ public final class ResumeSessionRequest { @JsonProperty("disabledSkills") private List disabledSkills; + @JsonProperty("disabledMcpServers") + private List disabledMcpServers; + @JsonProperty("infiniteSessions") private InfiniteSessionConfig infiniteSessions; @@ -198,6 +210,13 @@ public final class ResumeSessionRequest { @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; @@ -210,6 +229,9 @@ public final class ResumeSessionRequest { @JsonProperty("gitHubToken") private String gitHubToken; + @JsonProperty("gitHubTokenProviderRegistrationId") + private String gitHubTokenProviderRegistrationId; + @JsonProperty("remoteSession") private String remoteSession; @@ -220,6 +242,10 @@ public final class ResumeSessionRequest { @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; @@ -419,6 +445,21 @@ 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; @@ -497,6 +538,21 @@ 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; @@ -778,6 +834,19 @@ 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; @@ -872,6 +941,18 @@ 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; @@ -927,6 +1008,40 @@ 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; @@ -974,6 +1089,21 @@ public void setGitHubToken(String gitHubToken) { this.gitHubToken = gitHubToken; } + /** + * Gets the token-provider registration ID. @return the opaque registration ID + */ + public String getGitHubTokenProviderRegistrationId() { + return gitHubTokenProviderRegistrationId; + } + + /** + * Sets the token-provider registration ID. @param registrationId the opaque + * registration ID + */ + public void setGitHubTokenProviderRegistrationId(String registrationId) { + this.gitHubTokenProviderRegistrationId = registrationId; + } + /** Gets the remote session mode. @return the remote session mode */ public String getRemoteSession() { return remoteSession; @@ -1020,4 +1150,17 @@ public void setEnableManagedSettings(boolean enableManagedSettings) { 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/src/main/java/com/github/copilot/rpc/ResumeSessionResponse.java b/java/sdk/src/main/java/com/github/copilot/rpc/ResumeSessionResponse.java similarity index 100% rename from java/src/main/java/com/github/copilot/rpc/ResumeSessionResponse.java rename to java/sdk/src/main/java/com/github/copilot/rpc/ResumeSessionResponse.java 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 0000000000..a0c8eec5c6 --- /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 100% 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 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 100% 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 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 87% 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 0e02482de4..9f6ddb5efa 100644 --- a/java/src/main/java/com/github/copilot/rpc/SessionConfig.java +++ b/java/sdk/src/main/java/com/github/copilot/rpc/SessionConfig.java @@ -57,7 +57,9 @@ public class SessionConfig { 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; @@ -67,6 +69,7 @@ public class SessionConfig { private UserInputHandler onUserInputRequest; private SessionHooks hooks; private String workingDirectory; + private List additionalDirectories; private boolean streaming; private Boolean includeSubAgentStreamingEvents; private Map mcpServers; @@ -76,12 +79,14 @@ public class SessionConfig { private String agent; private InfiniteSessionConfig infiniteSessions; private List skillDirectories; + private List includedBuiltinSkills; 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; @@ -99,11 +104,15 @@ public class SessionConfig { private ExitPlanModeHandler onExitPlanMode; private AutoModeSwitchHandler onAutoModeSwitch; private boolean enableMcpApps; + private GitHubMcpToolConfig githubMcpToolConfig; private String gitHubToken; + @JsonIgnore + private GitHubTokenProvider gitHubTokenProvider; private String remoteSession; private CloudSessionOptions cloud; private CopilotExpAssignmentResponse expAssignments; private Boolean enableManagedSettings; + private ManagedSettings managedSettings; /** * Gets the custom session ID. @@ -177,7 +186,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; @@ -186,8 +196,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 @@ -550,6 +560,40 @@ public SessionConfig clearEnableCitations() { 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. * @@ -573,6 +617,52 @@ public SessionConfig setSessionLimits(SessionLimitsConfig 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. * @@ -631,11 +721,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 @@ -861,6 +951,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. * @@ -1067,6 +1178,28 @@ public SessionConfig setSkillDirectories(List skillDirectories) { return this; } + /** + * Gets the runtime-bundled skill allowlist. + * + * @return the built-in skill names, or {@code null} when unspecified + */ + public List getIncludedBuiltinSkills() { + return includedBuiltinSkills == null ? null : Collections.unmodifiableList(includedBuiltinSkills); + } + + /** + * Sets the runtime-bundled skill allowlist. In empty mode, omitting this option + * excludes all built-in skills; specifying names opts those built-ins back in. + * + * @param includedBuiltinSkills + * the built-in skill names to allow + * @return this config instance for method chaining + */ + public SessionConfig setIncludedBuiltinSkills(List includedBuiltinSkills) { + this.includedBuiltinSkills = includedBuiltinSkills; + return this; + } + /** * Gets the additional directories to search for custom instruction files. * @@ -1197,6 +1330,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. * @@ -1234,14 +1390,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 @@ -1718,6 +1868,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. * @@ -1799,6 +1970,33 @@ public SessionConfig setGitHubToken(String gitHubToken) { return this; } + /** + * Gets the rotating GitHub token provider for this session. + * + * @return the provider, or {@code null} when a static token is used + */ + public GitHubTokenProvider getGitHubTokenProvider() { + return gitHubTokenProvider; + } + + /** + * Sets the rotating GitHub token provider for this session. + *

+ * The provider receives only the effective host, optional assigned session ID, + * and acquisition reason. It must return a positive remaining lifetime in + * seconds when its callback completes. Production GitHub tokens typically last + * eight hours. This option is mutually exclusive with + * {@link #setGitHubToken(String)}. + * + * @param gitHubTokenProvider + * provider used for initial acquisition and refresh + * @return this config instance for method chaining + */ + public SessionConfig setGitHubTokenProvider(GitHubTokenProvider gitHubTokenProvider) { + this.gitHubTokenProvider = gitHubTokenProvider; + return this; + } + /** * Gets the per-session remote behavior control. *

@@ -1917,10 +2115,11 @@ public Optional getEnableManagedSettings() { * (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}. + * the session's static {@link #getGitHubToken() gitHubToken} or + * {@link #getGitHubTokenProvider() gitHubTokenProvider}. Requires one of those + * credentials; if both are 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 @@ -1931,6 +2130,29 @@ public SessionConfig setEnableManagedSettings(boolean 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. *

@@ -1964,7 +2186,9 @@ public SessionConfig clone() { 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; @@ -1973,6 +2197,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; @@ -1981,6 +2208,9 @@ public SessionConfig clone() { copy.agent = this.agent; copy.infiniteSessions = this.infiniteSessions; copy.skillDirectories = this.skillDirectories != null ? new ArrayList<>(this.skillDirectories) : null; + copy.includedBuiltinSkills = this.includedBuiltinSkills != null + ? new ArrayList<>(this.includedBuiltinSkills) + : null; copy.instructionDirectories = this.instructionDirectories != null ? new ArrayList<>(this.instructionDirectories) : null; @@ -1989,6 +2219,7 @@ public SessionConfig clone() { 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; @@ -2007,11 +2238,14 @@ public SessionConfig clone() { copy.onExitPlanMode = this.onExitPlanMode; copy.onAutoModeSwitch = this.onAutoModeSwitch; copy.enableMcpApps = this.enableMcpApps; + copy.githubMcpToolConfig = this.githubMcpToolConfig; copy.gitHubToken = this.gitHubToken; + copy.gitHubTokenProvider = this.gitHubTokenProvider; 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 88% 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 9cf68684dd..e476f888ed 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,6 +42,7 @@ public class SessionHooks { private PostToolUseHandler onPostToolUse; private PostToolUseFailureHandler onPostToolUseFailure; private UserPromptSubmittedHandler onUserPromptSubmitted; + private UserPromptTransformedHandler onUserPromptTransformed; private SessionStartHandler onSessionStart; private SessionEndHandler onSessionEnd; private AgentStopHandler onAgentStop; @@ -161,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. * @@ -237,7 +261,7 @@ public SessionHooks setOnAgentStop(AgentStopHandler onAgentStop) { */ public boolean hasHooks() { return onPreToolUse != null || onPreMcpToolCall != null || onPostToolUse != null || onPostToolUseFailure != null - || onUserPromptSubmitted != null || onSessionStart != null || onSessionEnd != null - || onAgentStop != 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 0000000000..7d0923e0fe --- /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 100% 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 diff --git a/java/src/main/java/com/github/copilot/rpc/SystemMessageSections.java b/java/sdk/src/main/java/com/github/copilot/rpc/SystemMessageSections.java similarity index 100% rename from java/src/main/java/com/github/copilot/rpc/SystemMessageSections.java rename to java/sdk/src/main/java/com/github/copilot/rpc/SystemMessageSections.java diff --git a/java/src/main/java/com/github/copilot/rpc/SystemPromptSections.java b/java/sdk/src/main/java/com/github/copilot/rpc/SystemPromptSections.java similarity index 100% rename from java/src/main/java/com/github/copilot/rpc/SystemPromptSections.java rename to java/sdk/src/main/java/com/github/copilot/rpc/SystemPromptSections.java 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 0000000000..648321a219 --- /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 100% 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 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/src/main/java/com/github/copilot/rpc/ToolDefer.java b/java/sdk/src/main/java/com/github/copilot/rpc/ToolDefer.java similarity index 100% rename from java/src/main/java/com/github/copilot/rpc/ToolDefer.java rename to java/sdk/src/main/java/com/github/copilot/rpc/ToolDefer.java diff --git a/java/src/main/java/com/github/copilot/rpc/ToolDefinition.java b/java/sdk/src/main/java/com/github/copilot/rpc/ToolDefinition.java similarity index 93% rename from java/src/main/java/com/github/copilot/rpc/ToolDefinition.java rename to java/sdk/src/main/java/com/github/copilot/rpc/ToolDefinition.java index ccf0ef5309..de274b66a1 100644 --- a/java/src/main/java/com/github/copilot/rpc/ToolDefinition.java +++ b/java/sdk/src/main/java/com/github/copilot/rpc/ToolDefinition.java @@ -78,6 +78,11 @@ * @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 @@ -87,13 +92,13 @@ public record ToolDefinition(@JsonProperty("name") String name, @JsonProperty("d @JsonProperty("parameters") Object parameters, @JsonIgnore ToolHandler handler, @JsonProperty("overridesBuiltInTool") Boolean overridesBuiltInTool, @JsonProperty("skipPermission") Boolean skipPermission, @JsonProperty("defer") ToolDefer defer, - @JsonProperty("metadata") Map metadata) { + @JsonProperty("metadata") Map metadata, @JsonProperty("isTerminal") Boolean isTerminal) { /** - * Creates a tool definition without a {@code metadata} bag. + * Creates a tool definition without a {@code metadata} bag or terminality hint. *

* Convenience overload equivalent to the canonical constructor with - * {@code metadata} set to {@code null}. + * {@code metadata} and {@code isTerminal} set to {@code null}. * * @param name * the unique name of the tool @@ -114,7 +119,37 @@ public record ToolDefinition(@JsonProperty("name") String name, @JsonProperty("d */ 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); + 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); } /** @@ -304,7 +339,8 @@ public static List fromClass(Class clazz) { */ @CopilotExperimental public ToolDefinition overridesBuiltInTool(boolean value) { - return new ToolDefinition(name, description, parameters, handler, value, skipPermission, defer, metadata); + return new ToolDefinition(name, description, parameters, handler, value, skipPermission, defer, metadata, + isTerminal); } /** @@ -318,7 +354,8 @@ public ToolDefinition overridesBuiltInTool(boolean value) { */ @CopilotExperimental public ToolDefinition skipPermission(boolean value) { - return new ToolDefinition(name, description, parameters, handler, overridesBuiltInTool, value, defer, metadata); + return new ToolDefinition(name, description, parameters, handler, overridesBuiltInTool, value, defer, metadata, + isTerminal); } /** @@ -333,7 +370,7 @@ public ToolDefinition skipPermission(boolean value) { @CopilotExperimental public ToolDefinition defer(ToolDefer value) { return new ToolDefinition(name, description, parameters, handler, overridesBuiltInTool, skipPermission, value, - metadata); + metadata, isTerminal); } /** @@ -348,7 +385,22 @@ public ToolDefinition defer(ToolDefer value) { @CopilotExperimental public ToolDefinition metadata(Map value) { return new ToolDefinition(name, description, parameters, handler, overridesBuiltInTool, skipPermission, defer, - value); + 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); } // ------------------------------------------------------------------ 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 100% 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 diff --git a/java/src/main/java/com/github/copilot/rpc/ToolResultObject.java b/java/sdk/src/main/java/com/github/copilot/rpc/ToolResultObject.java similarity index 100% rename from java/src/main/java/com/github/copilot/rpc/ToolResultObject.java rename to java/sdk/src/main/java/com/github/copilot/rpc/ToolResultObject.java diff --git a/java/src/main/java/com/github/copilot/rpc/ToolSearchConfig.java b/java/sdk/src/main/java/com/github/copilot/rpc/ToolSearchConfig.java similarity index 100% rename from java/src/main/java/com/github/copilot/rpc/ToolSearchConfig.java rename to java/sdk/src/main/java/com/github/copilot/rpc/ToolSearchConfig.java 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 0000000000..c260985845 --- /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 0000000000..ac8496078f --- /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 0000000000..ea17596585 --- /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 0000000000..615f4ea7b9 --- /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/src/main/java/com/github/copilot/rpc/package-info.java b/java/sdk/src/main/java/com/github/copilot/rpc/package-info.java similarity index 100% rename from java/src/main/java/com/github/copilot/rpc/package-info.java rename to java/sdk/src/main/java/com/github/copilot/rpc/package-info.java diff --git a/java/src/main/java/com/github/copilot/tool/CopilotTool.java b/java/sdk/src/main/java/com/github/copilot/tool/CopilotTool.java similarity index 97% rename from java/src/main/java/com/github/copilot/tool/CopilotTool.java rename to java/sdk/src/main/java/com/github/copilot/tool/CopilotTool.java index db9e3ca62d..28cd759288 100644 --- a/java/src/main/java/com/github/copilot/tool/CopilotTool.java +++ b/java/sdk/src/main/java/com/github/copilot/tool/CopilotTool.java @@ -48,6 +48,9 @@ /** 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; diff --git a/java/src/main/java/com/github/copilot/tool/CopilotToolMetadataProvider.java b/java/sdk/src/main/java/com/github/copilot/tool/CopilotToolMetadataProvider.java similarity index 100% rename from java/src/main/java/com/github/copilot/tool/CopilotToolMetadataProvider.java rename to java/sdk/src/main/java/com/github/copilot/tool/CopilotToolMetadataProvider.java diff --git a/java/src/main/java/com/github/copilot/tool/CopilotToolParam.java b/java/sdk/src/main/java/com/github/copilot/tool/CopilotToolParam.java similarity index 100% rename from java/src/main/java/com/github/copilot/tool/CopilotToolParam.java rename to java/sdk/src/main/java/com/github/copilot/tool/CopilotToolParam.java diff --git a/java/src/main/java/com/github/copilot/tool/CopilotToolProcessor.java b/java/sdk/src/main/java/com/github/copilot/tool/CopilotToolProcessor.java similarity index 99% rename from java/src/main/java/com/github/copilot/tool/CopilotToolProcessor.java rename to java/sdk/src/main/java/com/github/copilot/tool/CopilotToolProcessor.java index dbc6921afa..f88c1ac7c8 100644 --- a/java/src/main/java/com/github/copilot/tool/CopilotToolProcessor.java +++ b/java/sdk/src/main/java/com/github/copilot/tool/CopilotToolProcessor.java @@ -317,6 +317,7 @@ private void writeToolDefinition(PrintWriter out, ExecutableElement method) { 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, @@ -329,6 +330,7 @@ private void writeToolDefinition(PrintWriter out, ExecutableElement 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("); @@ -341,7 +343,8 @@ private void writeToolDefinition(PrintWriter out, ExecutableElement method) { out.println(" " + overridesArg + ","); out.println(" " + skipPermArg + ","); out.println(" " + deferArg + ","); - out.println(" " + metadataSource(annotation)); + out.println(" " + metadataSource(annotation) + ","); + out.println(" " + isTerminalArg); out.print(" )"); } diff --git a/java/src/main/java/com/github/copilot/tool/Param.java b/java/sdk/src/main/java/com/github/copilot/tool/Param.java similarity index 100% rename from java/src/main/java/com/github/copilot/tool/Param.java rename to java/sdk/src/main/java/com/github/copilot/tool/Param.java diff --git a/java/src/main/java/com/github/copilot/tool/SchemaGenerator.java b/java/sdk/src/main/java/com/github/copilot/tool/SchemaGenerator.java similarity index 100% rename from java/src/main/java/com/github/copilot/tool/SchemaGenerator.java rename to java/sdk/src/main/java/com/github/copilot/tool/SchemaGenerator.java diff --git a/java/src/main/java/module-info.java b/java/sdk/src/main/java/module-info.java similarity index 94% rename from java/src/main/java/module-info.java rename to java/sdk/src/main/java/module-info.java index 38bc1f93d5..8bc2dbd55c 100644 --- a/java/src/main/java/module-info.java +++ b/java/sdk/src/main/java/module-info.java @@ -12,6 +12,7 @@ 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; @@ -25,6 +26,7 @@ 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 0000000000..a67346b889 --- /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/src/main/resources/META-INF/services/javax.annotation.processing.Processor b/java/sdk/src/main/resources/META-INF/services/javax.annotation.processing.Processor similarity index 100% rename from java/src/main/resources/META-INF/services/javax.annotation.processing.Processor rename to java/sdk/src/main/resources/META-INF/services/javax.annotation.processing.Processor 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 0000000000..2900464443 --- /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 100% rename from java/src/test/java/com/github/copilot/AgentInfoTest.java rename to java/sdk/src/test/java/com/github/copilot/AgentInfoTest.java 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 0000000000..fa353e6277 --- /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/src/test/java/com/github/copilot/ByokBearerTokenProviderE2ETest.java b/java/sdk/src/test/java/com/github/copilot/ByokBearerTokenProviderE2ETest.java similarity index 100% rename from java/src/test/java/com/github/copilot/ByokBearerTokenProviderE2ETest.java rename to java/sdk/src/test/java/com/github/copilot/ByokBearerTokenProviderE2ETest.java 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 92% rename from java/src/test/java/com/github/copilot/CapiProxy.java rename to java/sdk/src/test/java/com/github/copilot/CapiProxy.java index 6484f05818..3124cc3d6b 100644 --- a/java/src/test/java/com/github/copilot/CapiProxy.java +++ b/java/sdk/src/test/java/com/github/copilot/CapiProxy.java @@ -57,16 +57,15 @@ public class CapiProxy implements AutoCloseable { private static final ObjectMapper MAPPER = new ObjectMapper(); private static final Pattern LISTENING_PATTERN = Pattern.compile("Listening: (http://[^\\s]+)(?:\\s+(\\{.*\\}))?$"); + private static final HttpClient HTTP_CLIENT = HttpClient.newHttpClient(); private Process process; private String proxyUrl; private String connectProxyUrl; private String caFilePath; - private final HttpClient httpClient; private BufferedReader stdoutReader; public CapiProxy() { - this.httpClient = HttpClient.newHttpClient(); } /** @@ -93,9 +92,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 @@ -211,7 +211,7 @@ public void configure(String filePath, String workDir, TestInfo testInfo) throws HttpRequest request = HttpRequest.newBuilder().uri(URI.create(proxyUrl + "/config")) .header("Content-Type", "application/json").POST(HttpRequest.BodyPublishers.ofString(body)).build(); - HttpResponse response = httpClient.send(request, HttpResponse.BodyHandlers.ofString()); + HttpResponse response = HTTP_CLIENT.send(request, HttpResponse.BodyHandlers.ofString()); if (response.statusCode() != 200) { throw new IOException("Proxy config failed with status " + response.statusCode() + ": " + response.body()); } @@ -233,7 +233,7 @@ public List> getExchanges() throws IOException, InterruptedE HttpRequest request = HttpRequest.newBuilder().uri(URI.create(proxyUrl + "/exchanges")).GET().build(); - HttpResponse response = httpClient.send(request, HttpResponse.BodyHandlers.ofString()); + HttpResponse response = HTTP_CLIENT.send(request, HttpResponse.BodyHandlers.ofString()); if (response.statusCode() != 200) { throw new IOException("Failed to get exchanges: " + response.statusCode()); } @@ -283,7 +283,7 @@ public void setCopilotUserByToken(String token, String login, String copilotPlan HttpRequest request = HttpRequest.newBuilder().uri(URI.create(proxyUrl + "/copilot-user-config")) .header("Content-Type", "application/json").POST(HttpRequest.BodyPublishers.ofString(body)).build(); - HttpResponse response = httpClient.send(request, HttpResponse.BodyHandlers.ofString()); + HttpResponse response = HTTP_CLIENT.send(request, HttpResponse.BodyHandlers.ofString()); if (response.statusCode() != 200) { throw new IOException( "Failed to set copilot user config: " + response.statusCode() + ": " + response.body()); @@ -330,7 +330,7 @@ public void setCopilotUserByToken(String token, Map response) 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()); + HttpResponse response2 = HTTP_CLIENT.send(request, HttpResponse.BodyHandlers.ofString()); if (response2.statusCode() != 200) { throw new IOException( "Failed to set copilot user config: " + response2.statusCode() + ": " + response2.body()); @@ -375,7 +375,7 @@ public void stop(boolean skipWritingCache) throws IOException, InterruptedExcept HttpRequest request = HttpRequest.newBuilder().uri(URI.create(stopUrl)) .POST(HttpRequest.BodyPublishers.noBody()).build(); - httpClient.send(request, HttpResponse.BodyHandlers.ofString()); + HTTP_CLIENT.send(request, HttpResponse.BodyHandlers.ofString()); } catch (Exception e) { // Best effort - ignore errors } @@ -516,6 +516,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/CapiProxyTest.java b/java/sdk/src/test/java/com/github/copilot/CapiProxyTest.java new file mode 100644 index 0000000000..9ac044a2b8 --- /dev/null +++ b/java/sdk/src/test/java/com/github/copilot/CapiProxyTest.java @@ -0,0 +1,21 @@ +/*--------------------------------------------------------------------------------------------- + * Copyright (c) Microsoft Corporation. All rights reserved. + *--------------------------------------------------------------------------------------------*/ + +package com.github.copilot; + +import static org.junit.jupiter.api.Assertions.assertTrue; + +import java.lang.reflect.Modifier; + +import org.junit.jupiter.api.Test; + +class CapiProxyTest { + + @Test + void proxyInstancesShareHttpClientResources() throws Exception { + var field = CapiProxy.class.getDeclaredField("HTTP_CLIENT"); + assertTrue(Modifier.isStatic(field.getModifiers()), + "E2E contexts must not retain one HttpClient selector manager per test class"); + } +} diff --git a/java/src/test/java/com/github/copilot/CapiSessionOptionsTest.java b/java/sdk/src/test/java/com/github/copilot/CapiSessionOptionsTest.java similarity index 100% rename from java/src/test/java/com/github/copilot/CapiSessionOptionsTest.java rename to java/sdk/src/test/java/com/github/copilot/CapiSessionOptionsTest.java 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 96% rename from java/src/test/java/com/github/copilot/CliServerManagerTest.java rename to java/sdk/src/test/java/com/github/copilot/CliServerManagerTest.java index b445d6153a..68555a35b4 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); diff --git a/java/src/test/java/com/github/copilot/ClientOptionsE2ETest.java b/java/sdk/src/test/java/com/github/copilot/ClientOptionsE2ETest.java similarity index 100% rename from java/src/test/java/com/github/copilot/ClientOptionsE2ETest.java rename to java/sdk/src/test/java/com/github/copilot/ClientOptionsE2ETest.java 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 97% rename from java/src/test/java/com/github/copilot/CommandsTest.java rename to java/sdk/src/test/java/com/github/copilot/CommandsTest.java index 0da8822a2b..f5f8424391 100644 --- a/java/src/test/java/com/github/copilot/CommandsTest.java +++ b/java/sdk/src/test/java/com/github/copilot/CommandsTest.java @@ -95,7 +95,7 @@ void buildCreateRequestIncludesCommandWireDefinitions() { assertEquals("deploy", request.getCommands().get(0).getName()); assertEquals("Deploy", request.getCommands().get(0).getDescription()); assertEquals("rollback", request.getCommands().get(1).getName()); - assertNull(request.getCommands().get(1).getDescription()); + assertEquals("", request.getCommands().get(1).getDescription()); } @Test @@ -130,11 +130,11 @@ void commandWireDefinitionHasNameAndDescription() { } @Test - void commandWireDefinitionNullDescriptionAllowed() { + void commandWireDefinitionNormalizesNullDescription() { var wire = new CommandWireDefinition("rollback", null); assertEquals("rollback", wire.getName()); - assertNull(wire.getDescription()); + assertEquals("", wire.getDescription()); } @Test 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 92% rename from java/src/test/java/com/github/copilot/ConfigCloneTest.java rename to java/sdk/src/test/java/com/github/copilot/ConfigCloneTest.java index 6986ef7f0e..4c5a3fbef0 100644 --- a/java/src/test/java/com/github/copilot/ConfigCloneTest.java +++ b/java/sdk/src/test/java/com/github/copilot/ConfigCloneTest.java @@ -120,6 +120,7 @@ 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)); @@ -133,6 +134,7 @@ 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()); @@ -146,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(); @@ -156,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 @@ -177,13 +181,14 @@ void sessionConfigSessionPolicyOptionsCloned() { var sessionLimits = new SessionLimitsConfig(30.0); var excludedAgents = new ArrayList<>(List.of("explore")); SessionConfig original = new SessionConfig().setExcludedBuiltInAgents(excludedAgents).setEnableCitations(true) - .setSessionLimits(sessionLimits); + .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()); } @@ -194,6 +199,7 @@ 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)); @@ -205,6 +211,7 @@ 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()); @@ -229,13 +236,14 @@ void resumeSessionConfigSessionPolicyOptionsCloned() { var sessionLimits = new SessionLimitsConfig(30.0); var excludedAgents = new ArrayList<>(List.of("explore")); ResumeSessionConfig original = new ResumeSessionConfig().setExcludedBuiltInAgents(excludedAgents) - .setEnableCitations(true).setSessionLimits(sessionLimits); + .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()); } @@ -377,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() { @@ -440,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()); } @@ -453,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 93% rename from java/src/test/java/com/github/copilot/CopilotClientTest.java rename to java/sdk/src/test/java/com/github/copilot/CopilotClientTest.java index d977563aeb..4cfd7f4c48 100644 --- a/java/src/test/java/com/github/copilot/CopilotClientTest.java +++ b/java/sdk/src/test/java/com/github/copilot/CopilotClientTest.java @@ -8,6 +8,8 @@ import org.junit.jupiter.api.Test; import com.github.copilot.rpc.CopilotClientOptions; +import com.github.copilot.rpc.DeleteSessionResponse; +import com.github.copilot.rpc.GitHubTokenProviderResult; import com.github.copilot.rpc.PermissionHandler; import com.github.copilot.rpc.PingResponse; import com.github.copilot.rpc.SessionConfig; @@ -111,6 +113,35 @@ void testForceStopAndExternalStopDoNotRequestRuntimeShutdown() throws Exception verify(externalRpc, never()).invoke(eq("runtime.shutdown"), any(), eq(Void.class)); } + @Test + @SuppressWarnings("unchecked") + void testDeleteSessionReleasesGitHubTokenProvider() throws Exception { + var client = new CopilotClient(new CopilotClientOptions().setAutoStart(false)); + var rpc = mock(JsonRpcClient.class); + when(rpc.invoke(eq("session.delete"), any(), eq(DeleteSessionResponse.class))) + .thenReturn(CompletableFuture.completedFuture(new DeleteSessionResponse(true, null))); + when(rpc.invoke(eq("session.destroy"), any(), eq(Void.class))) + .thenReturn(CompletableFuture.completedFuture(null)); + setConnectionFuture(client, rpc, null); + + var registry = new GitHubTokenProviderRegistry(); + var registration = registry + .register(args -> CompletableFuture.completedFuture(GitHubTokenProviderResult.cancelled())); + var session = new CopilotSession("delete-session", rpc); + session.setGitHubTokenProviderRegistration(registration); + Field sessionsField = CopilotClient.class.getDeclaredField("sessions"); + sessionsField.setAccessible(true); + ((Map) sessionsField.get(client)).put(session.getSessionId(), session); + + try { + client.deleteSession(session.getSessionId()).join(); + assertNull(registry.get(registration.id())); + } finally { + session.close(); + client.close(); + } + } + @Test void testClientConstruction() { var client = new CopilotClient(); @@ -610,9 +641,9 @@ void testListModels_WithCustomHandler_WorksWithoutStart() throws Exception { 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); + com.github.copilot.generated.rpc.ServerRpc.class, AutoCloseable.class); constructor.setAccessible(true); - var connection = constructor.newInstance(rpc, process, null); + var connection = constructor.newInstance(rpc, process, null, null); Field field = CopilotClient.class.getDeclaredField("connectionFuture"); field.setAccessible(true); 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 0000000000..46223d56d8 --- /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/src/test/java/com/github/copilot/CopilotExperimentalProcessorTest.java b/java/sdk/src/test/java/com/github/copilot/CopilotExperimentalProcessorTest.java similarity index 100% rename from java/src/test/java/com/github/copilot/CopilotExperimentalProcessorTest.java rename to java/sdk/src/test/java/com/github/copilot/CopilotExperimentalProcessorTest.java diff --git a/java/src/test/java/com/github/copilot/CopilotRequestCancelErrorE2ETest.java b/java/sdk/src/test/java/com/github/copilot/CopilotRequestCancelErrorE2ETest.java similarity index 100% rename from java/src/test/java/com/github/copilot/CopilotRequestCancelErrorE2ETest.java rename to java/sdk/src/test/java/com/github/copilot/CopilotRequestCancelErrorE2ETest.java diff --git a/java/src/test/java/com/github/copilot/CopilotRequestHandlerE2ETest.java b/java/sdk/src/test/java/com/github/copilot/CopilotRequestHandlerE2ETest.java similarity index 100% rename from java/src/test/java/com/github/copilot/CopilotRequestHandlerE2ETest.java rename to java/sdk/src/test/java/com/github/copilot/CopilotRequestHandlerE2ETest.java diff --git a/java/src/test/java/com/github/copilot/CopilotRequestSessionIdE2ETest.java b/java/sdk/src/test/java/com/github/copilot/CopilotRequestSessionIdE2ETest.java similarity index 100% rename from java/src/test/java/com/github/copilot/CopilotRequestSessionIdE2ETest.java rename to java/sdk/src/test/java/com/github/copilot/CopilotRequestSessionIdE2ETest.java diff --git a/java/src/test/java/com/github/copilot/CopilotRequestTestSupport.java b/java/sdk/src/test/java/com/github/copilot/CopilotRequestTestSupport.java similarity index 99% rename from java/src/test/java/com/github/copilot/CopilotRequestTestSupport.java rename to java/sdk/src/test/java/com/github/copilot/CopilotRequestTestSupport.java index ecbf92068f..aa173ef30e 100644 --- a/java/src/test/java/com/github/copilot/CopilotRequestTestSupport.java +++ b/java/sdk/src/test/java/com/github/copilot/CopilotRequestTestSupport.java @@ -72,7 +72,8 @@ static CopilotClient newLlmClient(E2ETestContext ctx, CopilotRequestHandler hand env.put(entry.substring(0, eq), entry.substring(eq + 1)); } } - return ctx.createClient(new CopilotClientOptions().setEnvironment(env).setRequestHandler(handler)); + return ctx.createClient( + new CopilotClientOptions().setCliPath(ctx.getCliPath()).setEnvironment(env).setRequestHandler(handler)); } /** 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 100% rename from java/src/test/java/com/github/copilot/CopilotSessionTest.java rename to java/sdk/src/test/java/com/github/copilot/CopilotSessionTest.java 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 156c968489..79e968cd39 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 89% rename from java/src/test/java/com/github/copilot/DataObjectCoverageTest.java rename to java/sdk/src/test/java/com/github/copilot/DataObjectCoverageTest.java index f38a038368..c0b0324e3c 100644 --- a/java/src/test/java/com/github/copilot/DataObjectCoverageTest.java +++ b/java/sdk/src/test/java/com/github/copilot/DataObjectCoverageTest.java @@ -8,6 +8,7 @@ import org.junit.jupiter.api.Test; +import com.fasterxml.jackson.databind.ObjectMapper; import com.fasterxml.jackson.databind.node.JsonNodeFactory; import com.fasterxml.jackson.databind.node.ObjectNode; import com.github.copilot.rpc.CustomAgentConfig; @@ -139,6 +140,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 @@ -303,6 +325,15 @@ void mcpStdioServerConfigCoversGettersAndFluentSetters() { assertEquals(30, cfg.getTimeout()); } + @Test + void mcpStdioServerConfigSerializesWorkingDirectoryAsCwd() { + var json = new ObjectMapper() + .valueToTree(new McpStdioServerConfig().setCommand("node").setWorkingDirectory("/workspace")); + + assertEquals("/workspace", json.path("cwd").asText()); + assertFalse(json.has("workingDirectory")); + } + @Test void modelCapabilitiesOverrideCoversNestedSupportsAndLimits() { var supports = new ModelCapabilitiesOverride.Supports().setVision(true).setReasoningEffort(false); 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 f7170f4fde..4e1396aa93 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 77% rename from java/src/test/java/com/github/copilot/E2ETestContext.java rename to java/sdk/src/test/java/com/github/copilot/E2ETestContext.java index f524b33dab..cb302a8cd2 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, @@ -62,8 +65,8 @@ public class E2ETestContext implements AutoCloseable { */ 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); + private static final Pattern USER_ROLE_PATTERN = Pattern.compile("^(\\s*)-\\s+role:\\s+user\\s*$"); + private static final Pattern CONTENT_PATTERN = Pattern.compile("^(\\s*)content:\\s*(.*)$"); private final String cliPath; private final Path homeDir; @@ -71,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, @@ -223,25 +227,109 @@ public List getExpectedUserPrompts() { return List.of(); } try { - String content = Files.readString(currentSnapshotFile); - List prompts = new ArrayList<>(); - Matcher matcher = USER_CONTENT_PATTERN.matcher(content); - while (matcher.find()) { - String prompt = matcher.group(1).trim(); - // Remove quotes if present - if ((prompt.startsWith("\"") && prompt.endsWith("\"")) - || (prompt.startsWith("'") && prompt.endsWith("'"))) { - prompt = prompt.substring(1, prompt.length() - 1); + return parseExpectedUserPrompts(Files.readString(currentSnapshotFile)); + } catch (IOException e) { + LOG.warning("Failed to read snapshot file: " + e.getMessage()); + return List.of(); + } + } + + static List parseExpectedUserPrompts(String yaml) { + String[] lines = yaml.split("\\R", -1); + List prompts = new ArrayList<>(); + + for (int i = 0; i < lines.length; i++) { + Matcher roleMatcher = USER_ROLE_PATTERN.matcher(lines[i]); + if (!roleMatcher.matches()) { + continue; + } + + int roleIndent = roleMatcher.group(1).length(); + for (i++; i < lines.length; i++) { + String line = lines[i]; + if (!line.isBlank() && leadingWhitespace(line) <= roleIndent) { + i--; + break; + } + + Matcher contentMatcher = CONTENT_PATTERN.matcher(line); + if (!contentMatcher.matches()) { + continue; } - if (!prompts.contains(prompt)) { + + int contentIndent = contentMatcher.group(1).length(); + String value = contentMatcher.group(2).trim(); + List continuation = new ArrayList<>(); + while (i + 1 < lines.length + && (lines[i + 1].isBlank() || leadingWhitespace(lines[i + 1]) > contentIndent)) { + continuation.add(lines[++i]); + } + + String prompt = isBlockScalar(value) + ? parseBlockScalar(value.charAt(0), continuation) + : parsePlainScalar(value, continuation); + if (!prompt.isEmpty() && !prompts.contains(prompt)) { prompts.add(prompt); } + break; + } + } + + return prompts; + } + + private static String parsePlainScalar(String firstLine, List continuation) { + StringBuilder value = new StringBuilder(unquote(firstLine)); + for (String line : continuation) { + if (!line.isBlank()) { + if (!value.isEmpty()) { + value.append(' '); + } + value.append(line.trim()); } - return prompts; - } catch (IOException e) { - LOG.warning("Failed to read snapshot file: " + e.getMessage()); - return List.of(); } + return value.toString(); + } + + private static String parseBlockScalar(char style, List lines) { + int contentIndent = lines.stream().filter(line -> !line.isBlank()).mapToInt(E2ETestContext::leadingWhitespace) + .min().orElse(0); + StringBuilder value = new StringBuilder(); + boolean previousWasContent = false; + for (String line : lines) { + String text = line.isBlank() ? "" : line.substring(Math.min(contentIndent, line.length())); + if (text.isEmpty()) { + value.append('\n'); + previousWasContent = false; + } else { + if (previousWasContent) { + value.append(style == '>' ? ' ' : '\n'); + } + value.append(text); + previousWasContent = true; + } + } + return value.toString().stripTrailing(); + } + + private static boolean isBlockScalar(String value) { + return value.matches("[>|][+-]?"); + } + + private static String unquote(String value) { + if (value.length() >= 2 && ((value.startsWith("\"") && value.endsWith("\"")) + || (value.startsWith("'") && value.endsWith("'")))) { + return value.substring(1, value.length() - 1); + } + return value; + } + + private static int leadingWhitespace(String value) { + int index = 0; + while (index < value.length() && Character.isWhitespace(value.charAt(index))) { + index++; + } + return index; } /** @@ -322,10 +410,8 @@ public Map getEnvironment() { * @return a new CopilotClient */ public CopilotClient createClient() { - CopilotClientOptions options = new CopilotClientOptions().setCliPath(cliPath).setCwd(workDir.toString()) - .setEnvironment(getEnvironment()).setGitHubToken(DEFAULT_GITHUB_TOKEN); - - return new CopilotClient(options); + CopilotClientOptions options = new CopilotClientOptions().setGitHubToken(DEFAULT_GITHUB_TOKEN); + return createClient(options); } /** @@ -338,6 +424,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); } @@ -347,11 +458,30 @@ public CopilotClient createClient(CopilotClientOptions options) { if (options.getEnvironment() == null || options.getEnvironment().isEmpty()) { options.setEnvironment(getEnvironment()); } - if (options.getGitHubToken() == null) { - options.setGitHubToken(DEFAULT_GITHUB_TOKEN); + 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; } /** @@ -428,6 +558,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) diff --git a/java/sdk/src/test/java/com/github/copilot/E2ETestContextTest.java b/java/sdk/src/test/java/com/github/copilot/E2ETestContextTest.java new file mode 100644 index 0000000000..bf307f6547 --- /dev/null +++ b/java/sdk/src/test/java/com/github/copilot/E2ETestContextTest.java @@ -0,0 +1,39 @@ +/*--------------------------------------------------------------------------------------------- + * Copyright (c) Microsoft Corporation. All rights reserved. + *--------------------------------------------------------------------------------------------*/ + +package com.github.copilot; + +import static org.junit.jupiter.api.Assertions.assertEquals; + +import java.util.List; + +import org.junit.jupiter.api.Test; + +class E2ETestContextTest { + + @Test + void expectedUserPromptsParseFoldedBlockScalars() { + String snapshot = """ + conversations: + - messages: + - role: user + content: First prompt + continued here. + - role: assistant + content: response + - role: user + content: >- + + + Agent completed successfully. + + + """; + + assertEquals( + List.of("First prompt continued here.", + "\nAgent completed successfully.\n"), + E2ETestContext.parseExpectedUserPrompts(snapshot)); + } +} 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 32579ffc4e..46f6741a04 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 78764db0fb..a8319475c6 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/src/test/java/com/github/copilot/FakeUpstreamServer.java b/java/sdk/src/test/java/com/github/copilot/FakeUpstreamServer.java similarity index 97% rename from java/src/test/java/com/github/copilot/FakeUpstreamServer.java rename to java/sdk/src/test/java/com/github/copilot/FakeUpstreamServer.java index 7af60d4d38..909cd14069 100644 --- a/java/src/test/java/com/github/copilot/FakeUpstreamServer.java +++ b/java/sdk/src/test/java/com/github/copilot/FakeUpstreamServer.java @@ -162,7 +162,10 @@ private void serveHttp(InputStream in, OutputStream out, String path, Map headers) throws Exception { String key = headers.get("sec-websocket-key"); - MessageDigest sha1 = MessageDigest.getInstance("SHA-1"); + // 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" 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 100% rename from java/src/test/java/com/github/copilot/ForwardCompatibilityTest.java rename to java/sdk/src/test/java/com/github/copilot/ForwardCompatibilityTest.java diff --git a/java/src/test/java/com/github/copilot/GitHubTelemetryForwardingIT.java b/java/sdk/src/test/java/com/github/copilot/GitHubTelemetryForwardingIT.java similarity index 100% rename from java/src/test/java/com/github/copilot/GitHubTelemetryForwardingIT.java rename to java/sdk/src/test/java/com/github/copilot/GitHubTelemetryForwardingIT.java diff --git a/java/src/test/java/com/github/copilot/GitHubTelemetryTest.java b/java/sdk/src/test/java/com/github/copilot/GitHubTelemetryTest.java similarity index 91% rename from java/src/test/java/com/github/copilot/GitHubTelemetryTest.java rename to java/sdk/src/test/java/com/github/copilot/GitHubTelemetryTest.java index 8e35bd9a92..7b0deb9977 100644 --- a/java/src/test/java/com/github/copilot/GitHubTelemetryTest.java +++ b/java/sdk/src/test/java/com/github/copilot/GitHubTelemetryTest.java @@ -259,23 +259,24 @@ void sendTelemetry(Object params) throws Exception { private void acceptLoop() { try { Socket socket = serverSocket.accept(); - JsonRpcClient server = JsonRpcClient.fromSocket(socket); - server.registerMethodHandler("connect", (id, params) -> { - connectParams.complete(params); - respond(server, id, Map.of("protocolVersion", 2)); + 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())); }); - server.registerMethodHandler("session.create", (id, params) -> { - createParams.complete(params); - respond(server, id, Map.of("sessionId", params.path("sessionId").asText("created"), "workspacePath", - "/workspace")); - }); - server.registerMethodHandler("session.resume", (id, params) -> { - resumeParams.complete(params); - respond(server, id, Map.of("sessionId", params.path("sessionId").asText("resume-1"), - "workspacePath", "/workspace")); - }); - server.registerMethodHandler("session.destroy", (id, params) -> respond(server, id, Map.of())); - server.registerMethodHandler("runtime.shutdown", (id, params) -> respond(server, id, Map.of())); ready.complete(server); } catch (IOException e) { ready.completeExceptionally(e); diff --git a/java/sdk/src/test/java/com/github/copilot/GitHubTokenProviderRegistryTest.java b/java/sdk/src/test/java/com/github/copilot/GitHubTokenProviderRegistryTest.java new file mode 100644 index 0000000000..8f2c7d3314 --- /dev/null +++ b/java/sdk/src/test/java/com/github/copilot/GitHubTokenProviderRegistryTest.java @@ -0,0 +1,74 @@ +/*--------------------------------------------------------------------------------------------- + * 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.assertNull; +import static org.junit.jupiter.api.Assertions.assertInstanceOf; +import static org.junit.jupiter.api.Assertions.assertThrows; + +import java.util.concurrent.CompletableFuture; +import java.util.concurrent.CompletionException; + +import org.junit.jupiter.api.Test; + +import com.github.copilot.rpc.GitHubTokenProviderResult; +import com.github.copilot.rpc.PermissionHandler; +import com.github.copilot.rpc.ResumeSessionConfig; +import com.github.copilot.rpc.SessionConfig; + +class GitHubTokenProviderRegistryTest { + + @Test + void staticTokenAndProviderAreMutuallyExclusive() { + try (var client = new CopilotClient()) { + var create = new SessionConfig().setGitHubToken("static") + .setGitHubTokenProvider( + args -> CompletableFuture.completedFuture(GitHubTokenProviderResult.cancelled())) + .setOnPermissionRequest(PermissionHandler.APPROVE_ALL); + var createError = assertThrows(CompletionException.class, () -> client.createSession(create).join()); + assertInstanceOf(IllegalArgumentException.class, createError.getCause()); + + var resume = new ResumeSessionConfig().setGitHubToken("static") + .setGitHubTokenProvider( + args -> CompletableFuture.completedFuture(GitHubTokenProviderResult.cancelled())) + .setOnPermissionRequest(PermissionHandler.APPROVE_ALL); + var resumeError = assertThrows(CompletionException.class, + () -> client.resumeSession("session", resume).join()); + assertInstanceOf(IllegalArgumentException.class, resumeError.getCause()); + } + } + + @Test + void registrationRollbackAndResumeReplacementAreIsolated() { + var registry = new GitHubTokenProviderRegistry(); + var first = registry.register(args -> CompletableFuture.completedFuture(GitHubTokenProviderResult.cancelled())); + var second = registry + .register(args -> CompletableFuture.completedFuture(GitHubTokenProviderResult.cancelled())); + + assertNotNull(registry.get(first.id())); + assertNotNull(registry.get(second.id())); + first.claim("session-1"); + second.claim("session-1"); + assertNull(registry.get(first.id())); + assertNotNull(registry.get(second.id())); + + first.close(); + assertNotNull(registry.get(second.id())); + second.close(); + assertNull(registry.get(second.id())); + + var retired = registry + .register(args -> CompletableFuture.completedFuture(GitHubTokenProviderResult.cancelled())); + retired.claim("session-2"); + registry.retire("session-2"); + assertNull(registry.get(retired.id())); + + var failed = registry + .register(args -> CompletableFuture.completedFuture(GitHubTokenProviderResult.cancelled())); + failed.close(); + assertNull(registry.get(failed.id())); + } +} diff --git a/java/src/test/java/com/github/copilot/HooksTest.java b/java/sdk/src/test/java/com/github/copilot/HooksTest.java similarity index 87% rename from java/src/test/java/com/github/copilot/HooksTest.java rename to java/sdk/src/test/java/com/github/copilot/HooksTest.java index 98cb962fc0..c3833891cc 100644 --- a/java/src/test/java/com/github/copilot/HooksTest.java +++ b/java/sdk/src/test/java/com/github/copilot/HooksTest.java @@ -27,6 +27,8 @@ 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). @@ -267,4 +269,34 @@ void testInvokeAgentStopHookAndApplyBlockResponse() throws Exception { 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 100% rename from java/src/test/java/com/github/copilot/JsonIncludeNonNullTest.java rename to java/sdk/src/test/java/com/github/copilot/JsonIncludeNonNullTest.java 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 94% rename from java/src/test/java/com/github/copilot/JsonRpcClientTest.java rename to java/sdk/src/test/java/com/github/copilot/JsonRpcClientTest.java index 3491ac8ab4..009f15c200 100644 --- a/java/src/test/java/com/github/copilot/JsonRpcClientTest.java +++ b/java/sdk/src/test/java/com/github/copilot/JsonRpcClientTest.java @@ -115,6 +115,22 @@ void testNotify() throws Exception { } } + @Test + void testCredentialValuesAreRedactedOnlyFromDiagnosticRendering() throws Exception { + String json = """ + {"jsonrpc":"2.0","result":{"accessToken":"secret","nested":{"gitHubToken":"static"}}, + "metadata":{"tokenType":"Bearer"}} + """; + + String rendered = JsonRpcClient.redactCredentialsForLogging(json); + + assertFalse(rendered.contains("secret")); + assertFalse(rendered.contains("static")); + assertEquals("", MAPPER.readTree(rendered).at("/result/accessToken").asText()); + assertEquals("", MAPPER.readTree(rendered).at("/result/nested/gitHubToken").asText()); + assertEquals("Bearer", MAPPER.readTree(rendered).at("/metadata/tokenType").asText()); + } + // ---- isConnected() ---- @Test @@ -133,14 +149,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 +159,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 +171,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/src/test/java/com/github/copilot/LowLevelToolDefinitionIT.java b/java/sdk/src/test/java/com/github/copilot/LowLevelToolDefinitionIT.java similarity index 100% rename from java/src/test/java/com/github/copilot/LowLevelToolDefinitionIT.java rename to java/sdk/src/test/java/com/github/copilot/LowLevelToolDefinitionIT.java 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 0000000000..d6341b26c5 --- /dev/null +++ b/java/sdk/src/test/java/com/github/copilot/ManagedSettingsTest.java @@ -0,0 +1,98 @@ +/*--------------------------------------------------------------------------------------------- + * 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.rpc.DisableBypassPermissionsModes; +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(DisableBypassPermissionsModes.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 acceptsFutureBypassPermissionsModes() throws Exception { + var permissions = new ManagedSettingsPermissions().setDisableBypassPermissionsMode("future-fail-closed-mode"); + var json = new ObjectMapper().writeValueAsString(permissions); + + assertTrue(json.contains("\"disableBypassPermissionsMode\":\"future-fail-closed-mode\"")); + } + + @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 99% rename from java/src/test/java/com/github/copilot/McpAndAgentsTest.java rename to java/sdk/src/test/java/com/github/copilot/McpAndAgentsTest.java index f39e56eab3..06d9dca39e 100644 --- a/java/src/test/java/com/github/copilot/McpAndAgentsTest.java +++ b/java/sdk/src/test/java/com/github/copilot/McpAndAgentsTest.java @@ -131,7 +131,6 @@ void testShouldAcceptMcpServerConfigurationOnSessionResume() throws Exception { CopilotSession session1 = client .createSession(new SessionConfig().setOnPermissionRequest(PermissionHandler.APPROVE_ALL)).get(); String sessionId = session1.getSessionId(); - session1.sendAndWait(new MessageOptions().setPrompt("What is 1+1?")).get(60, TimeUnit.SECONDS); // Resume with MCP servers var mcpServers = createTestMcpServers("test-server"); diff --git a/java/src/test/java/com/github/copilot/McpAuthInterestRegistrationTest.java b/java/sdk/src/test/java/com/github/copilot/McpAuthInterestRegistrationTest.java similarity index 100% rename from java/src/test/java/com/github/copilot/McpAuthInterestRegistrationTest.java rename to java/sdk/src/test/java/com/github/copilot/McpAuthInterestRegistrationTest.java diff --git a/java/src/test/java/com/github/copilot/McpOAuthE2ETest.java b/java/sdk/src/test/java/com/github/copilot/McpOAuthE2ETest.java similarity index 100% rename from java/src/test/java/com/github/copilot/McpOAuthE2ETest.java rename to java/sdk/src/test/java/com/github/copilot/McpOAuthE2ETest.java diff --git a/java/src/test/java/com/github/copilot/McpOAuthResumeE2ETest.java b/java/sdk/src/test/java/com/github/copilot/McpOAuthResumeE2ETest.java similarity index 100% rename from java/src/test/java/com/github/copilot/McpOAuthResumeE2ETest.java rename to java/sdk/src/test/java/com/github/copilot/McpOAuthResumeE2ETest.java 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 100% rename from java/src/test/java/com/github/copilot/MetadataApiTest.java rename to java/sdk/src/test/java/com/github/copilot/MetadataApiTest.java 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 5128a31ace..942b2efe6d 100644 --- a/java/src/test/java/com/github/copilot/ModeHandlersTest.java +++ b/java/sdk/src/test/java/com/github/copilot/ModeHandlersTest.java @@ -7,18 +7,19 @@ 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; 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.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; @@ -68,7 +69,6 @@ private void configureAuthenticatedUser(String testName) throws Exception { } @Test - @Disabled("Snapshot needs re-recording for CLI 1.0.57: https://github.com/github/copilot-sdk/issues/1547") void shouldInvokeExitPlanModeHandlerWhenModelUsesTool() throws Exception { final String summary = "Greeting file implementation plan"; configureAuthenticatedUser("should_invoke_exit_plan_mode_handler_when_model_uses_tool"); @@ -99,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/src/test/java/com/github/copilot/MultiProviderConfigTest.java b/java/sdk/src/test/java/com/github/copilot/MultiProviderConfigTest.java similarity index 100% rename from java/src/test/java/com/github/copilot/MultiProviderConfigTest.java rename to java/sdk/src/test/java/com/github/copilot/MultiProviderConfigTest.java diff --git a/java/src/test/java/com/github/copilot/MultiProviderRegistryE2ETest.java b/java/sdk/src/test/java/com/github/copilot/MultiProviderRegistryE2ETest.java similarity index 100% rename from java/src/test/java/com/github/copilot/MultiProviderRegistryE2ETest.java rename to java/sdk/src/test/java/com/github/copilot/MultiProviderRegistryE2ETest.java 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 100% rename from java/src/test/java/com/github/copilot/PerSessionAuthTest.java rename to java/sdk/src/test/java/com/github/copilot/PerSessionAuthTest.java 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 0000000000..c1ca9191b0 --- /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 100% rename from java/src/test/java/com/github/copilot/PreMcpToolCallHookTest.java rename to java/sdk/src/test/java/com/github/copilot/PreMcpToolCallHookTest.java 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 100% rename from java/src/test/java/com/github/copilot/ProviderConfigTest.java rename to java/sdk/src/test/java/com/github/copilot/ProviderConfigTest.java diff --git a/java/src/test/java/com/github/copilot/ProviderEndpointE2ETest.java b/java/sdk/src/test/java/com/github/copilot/ProviderEndpointE2ETest.java similarity index 100% rename from java/src/test/java/com/github/copilot/ProviderEndpointE2ETest.java rename to java/sdk/src/test/java/com/github/copilot/ProviderEndpointE2ETest.java 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 88% rename from java/src/test/java/com/github/copilot/RpcHandlerDispatcherTest.java rename to java/sdk/src/test/java/com/github/copilot/RpcHandlerDispatcherTest.java index 76c2d41b29..1cb3ae82ec 100644 --- a/java/src/test/java/com/github/copilot/RpcHandlerDispatcherTest.java +++ b/java/sdk/src/test/java/com/github/copilot/RpcHandlerDispatcherTest.java @@ -15,6 +15,7 @@ import java.util.concurrent.CompletableFuture; import java.util.concurrent.ConcurrentHashMap; import java.util.concurrent.CopyOnWriteArrayList; +import java.util.concurrent.atomic.AtomicReference; import java.util.function.BiConsumer; import org.junit.jupiter.api.AfterEach; @@ -32,6 +33,9 @@ import com.github.copilot.rpc.ToolDefinition; import com.github.copilot.rpc.ToolResultObject; import com.github.copilot.rpc.UserInputResponse; +import com.github.copilot.generated.rpc.GitHubTokenAcquireReason; +import com.github.copilot.rpc.GitHubTokenProviderArgs; +import com.github.copilot.rpc.GitHubTokenProviderResult; /** * Unit tests for {@link RpcHandlerDispatcher} focusing on coverage gaps @@ -51,6 +55,7 @@ class RpcHandlerDispatcherTest { private RpcHandlerDispatcher dispatcher; private InputStream responseStream; private Map> handlers; + private GitHubTokenProviderRegistry gitHubTokenProviders; @BeforeEach void setup() throws Exception { @@ -66,7 +71,8 @@ void setup() throws Exception { sessions = new ConcurrentHashMap<>(); lifecycleEvents = new CopyOnWriteArrayList<>(); - dispatcher = new RpcHandlerDispatcher(sessions, lifecycleEvents::add, null); + gitHubTokenProviders = new GitHubTokenProviderRegistry(); + dispatcher = new RpcHandlerDispatcher(sessions, lifecycleEvents::add, null, gitHubTokenProviders); dispatcher.registerHandlers(rpc); // Extract the registered handlers via reflection so we can invoke them directly @@ -119,6 +125,57 @@ private CopilotSession createSession(String sessionId) { return session; } + @Test + void gitHubTokenCallbackMapsRequestAndTokenResult() throws Exception { + AtomicReference received = new AtomicReference<>(); + var registration = gitHubTokenProviders.register(args -> { + received.set(args); + return CompletableFuture.completedFuture(GitHubTokenProviderResult.token("secret", 28_800, "bearer")); + }); + ObjectNode params = MAPPER.createObjectNode(); + params.put("registrationId", registration.id()); + params.put("host", "github.example"); + params.put("sessionId", "session-1"); + params.put("reason", "initial"); + + invokeHandler("gitHubToken.getToken", "80", params); + + JsonNode response = readResponse(); + assertEquals("token", response.at("/result/kind").asText()); + assertEquals("secret", response.at("/result/accessToken").asText()); + assertEquals(28_800, response.at("/result/expiresIn").asLong()); + assertEquals("github.example", received.get().host()); + assertEquals("session-1", received.get().sessionId()); + assertEquals(GitHubTokenAcquireReason.INITIAL, received.get().reason()); + } + + @Test + void gitHubTokenCallbackPreservesCancellationAndErrors() throws Exception { + var cancelled = gitHubTokenProviders + .register(args -> CompletableFuture.completedFuture(GitHubTokenProviderResult.cancelled())); + ObjectNode cancelledParams = MAPPER.createObjectNode(); + cancelledParams.put("registrationId", cancelled.id()); + cancelledParams.put("host", "github.com"); + cancelledParams.put("reason", "refresh"); + invokeHandler("gitHubToken.getToken", "81", cancelledParams); + assertEquals("cancelled", readResponse().at("/result/kind").asText()); + + var failed = gitHubTokenProviders.register( + args -> CompletableFuture.failedFuture(new IllegalStateException("credential service unavailable"))); + ObjectNode failedParams = cancelledParams.deepCopy(); + failedParams.put("registrationId", failed.id()); + invokeHandler("gitHubToken.getToken", "82", failedParams); + JsonNode error = readResponse(); + assertEquals(-32603, error.at("/error/code").asInt()); + assertTrue(error.at("/error/message").asText().contains("credential service unavailable")); + + failedParams.put("registrationId", "unknown"); + invokeHandler("gitHubToken.getToken", "83", failedParams); + JsonNode unknown = readResponse(); + assertEquals(-32603, unknown.at("/error/code").asInt()); + assertTrue(unknown.at("/error/message").asText().contains("Unknown GitHub token provider registration")); + } + // ===== session.event tests ===== @Test diff --git a/java/src/test/java/com/github/copilot/RpcServerE2ETest.java b/java/sdk/src/test/java/com/github/copilot/RpcServerE2ETest.java similarity index 100% rename from java/src/test/java/com/github/copilot/RpcServerE2ETest.java rename to java/sdk/src/test/java/com/github/copilot/RpcServerE2ETest.java diff --git a/java/src/test/java/com/github/copilot/RpcServerMiscE2ETest.java b/java/sdk/src/test/java/com/github/copilot/RpcServerMiscE2ETest.java similarity index 98% rename from java/src/test/java/com/github/copilot/RpcServerMiscE2ETest.java rename to java/sdk/src/test/java/com/github/copilot/RpcServerMiscE2ETest.java index 1db801d841..3b06e4d1f7 100644 --- a/java/src/test/java/com/github/copilot/RpcServerMiscE2ETest.java +++ b/java/sdk/src/test/java/com/github/copilot/RpcServerMiscE2ETest.java @@ -106,7 +106,8 @@ void testShouldLoginListGetCurrentAuthAndLogoutAccount() throws Exception { 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); + var logout = client.getRpc().account.logout(new AccountLogoutParams(null, authInfo)).get(30, + TimeUnit.SECONDS); assertFalse(logout.hasMoreUsers()); assertNull(client.getRpc().account.getCurrentAuth().get(30, TimeUnit.SECONDS).authInfo()); } diff --git a/java/src/test/java/com/github/copilot/RpcSessionStateExtrasE2ETest.java b/java/sdk/src/test/java/com/github/copilot/RpcSessionStateExtrasE2ETest.java similarity index 96% rename from java/src/test/java/com/github/copilot/RpcSessionStateExtrasE2ETest.java rename to java/sdk/src/test/java/com/github/copilot/RpcSessionStateExtrasE2ETest.java index 83365455e7..18045f3e86 100644 --- a/java/src/test/java/com/github/copilot/RpcSessionStateExtrasE2ETest.java +++ b/java/sdk/src/test/java/com/github/copilot/RpcSessionStateExtrasE2ETest.java @@ -59,14 +59,13 @@ void testShouldAddByokProviderAndModelAtRuntime() throws Exception { 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)))) + 4096L, 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)) - .get(30, TimeUnit.SECONDS); + session.getRpc().model.switchTo(new SessionModelSwitchToParams(null, selectionId, null, null, null, + null, null, null, null, null, null, null, null, null, null)).get(30, TimeUnit.SECONDS); var current = session.getRpc().model.getCurrent().get(30, TimeUnit.SECONDS); assertEquals(selectionId, current.modelId()); } diff --git a/java/src/test/java/com/github/copilot/RpcTasksAndHandlersE2ETest.java b/java/sdk/src/test/java/com/github/copilot/RpcTasksAndHandlersE2ETest.java similarity index 100% rename from java/src/test/java/com/github/copilot/RpcTasksAndHandlersE2ETest.java rename to java/sdk/src/test/java/com/github/copilot/RpcTasksAndHandlersE2ETest.java 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 98% rename from java/src/test/java/com/github/copilot/RpcWrappersTest.java rename to java/sdk/src/test/java/com/github/copilot/RpcWrappersTest.java index 7493c6e470..3bb9001f35 100644 --- a/java/src/test/java/com/github/copilot/RpcWrappersTest.java +++ b/java/sdk/src/test/java/com/github/copilot/RpcWrappersTest.java @@ -205,7 +205,8 @@ 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, null, null); + var switchParams = new SessionModelSwitchToParams(null, "gpt-5", null, null, null, null, null, null, null, null, + null, null, null, null, null); session.model.switchTo(switchParams); assertEquals(1, stub.calls.size()); @@ -230,8 +231,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 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/src/test/java/com/github/copilot/SessionCanvasSnapshotTest.java b/java/sdk/src/test/java/com/github/copilot/SessionCanvasSnapshotTest.java similarity index 100% rename from java/src/test/java/com/github/copilot/SessionCanvasSnapshotTest.java rename to java/sdk/src/test/java/com/github/copilot/SessionCanvasSnapshotTest.java diff --git a/java/src/test/java/com/github/copilot/SessionConfigE2ETest.java b/java/sdk/src/test/java/com/github/copilot/SessionConfigE2ETest.java similarity index 100% rename from java/src/test/java/com/github/copilot/SessionConfigE2ETest.java rename to java/sdk/src/test/java/com/github/copilot/SessionConfigE2ETest.java 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 96% rename from java/src/test/java/com/github/copilot/SessionEventDeserializationTest.java rename to java/sdk/src/test/java/com/github/copilot/SessionEventDeserializationTest.java index 516d1ecf4a..8d9b70a348 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 = """ @@ -2553,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 94% rename from java/src/test/java/com/github/copilot/SessionEventHandlingTest.java rename to java/sdk/src/test/java/com/github/copilot/SessionEventHandlingTest.java index 1cf3ceff1f..529c42f2bb 100644 --- a/java/src/test/java/com/github/copilot/SessionEventHandlingTest.java +++ b/java/sdk/src/test/java/com/github/copilot/SessionEventHandlingTest.java @@ -5,11 +5,14 @@ package com.github.copilot; import static org.junit.jupiter.api.Assertions.*; +import static org.mockito.ArgumentMatchers.*; +import static org.mockito.Mockito.*; import java.io.Closeable; import java.lang.reflect.Method; import java.util.ArrayList; import java.util.List; +import java.util.concurrent.CompletableFuture; import java.util.concurrent.ConcurrentHashMap; import java.util.concurrent.CountDownLatch; import java.util.concurrent.TimeUnit; @@ -24,7 +27,10 @@ import com.github.copilot.generated.SessionEvent; import com.github.copilot.generated.AssistantMessageEvent; import com.github.copilot.generated.SessionIdleEvent; +import com.github.copilot.generated.SessionMode; import com.github.copilot.generated.SessionStartEvent; +import com.github.copilot.rpc.MessageOptions; +import com.github.copilot.rpc.SendMessageResponse; /** * Unit tests for session event handling API. @@ -85,6 +91,33 @@ void testTypedEventHandler() { assertEquals("Second message", receivedMessages.get(1).getData().content()); } + @Test + void testSendAndWaitSkipsAutopilotContinuationIdle() throws Exception { + var rpc = mock(JsonRpcClient.class); + when(rpc.invoke(eq("session.send"), any(), eq(SendMessageResponse.class))) + .thenReturn(CompletableFuture.completedFuture(new SendMessageResponse("message-1"))); + when(rpc.invoke(eq("session.destroy"), any(), eq(Void.class))) + .thenReturn(CompletableFuture.completedFuture(null)); + session = new CopilotSession("test-session-id", rpc); + + try { + var pending = session.sendAndWait(new MessageOptions().setPrompt("keep going")); + + dispatchEvent(createAssistantMessageEvent("intermediate")); + dispatchEvent(createSessionIdleEvent(SessionMode.AUTOPILOT)); + assertFalse(pending.isDone(), "Autopilot continuation idle must not complete sendAndWait"); + + dispatchEvent(createAssistantMessageEvent("final")); + dispatchEvent(createSessionIdleEvent(SessionMode.INTERACTIVE)); + + var result = pending.get(5, TimeUnit.SECONDS); + assertNotNull(result); + assertEquals("final", result.getData().content()); + } finally { + session.close(); + } + } + @Test void testMultipleTypedHandlers() { var messages = new ArrayList(); @@ -180,7 +213,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, null, null, null)); dispatchEvent(startEvent); AssistantMessageEvent msgEvent = createAssistantMessageEvent("Test content"); @@ -857,7 +890,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, null, null, null); event.setData(data); return event; } @@ -865,7 +898,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, null, null, null, null, null); event.setData(data); return event; } @@ -873,4 +906,10 @@ private AssistantMessageEvent createAssistantMessageEvent(String content) { private SessionIdleEvent createSessionIdleEvent() { return new SessionIdleEvent(); } + + private SessionIdleEvent createSessionIdleEvent(SessionMode mode) { + var event = new SessionIdleEvent(); + event.setData(new SessionIdleEvent.SessionIdleEventData(null, mode)); + 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 161839a533..dad75db528 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 93% rename from java/src/test/java/com/github/copilot/SessionHandlerTest.java rename to java/sdk/src/test/java/com/github/copilot/SessionHandlerTest.java index 05994df8d8..345fdccff9 100644 --- a/java/src/test/java/com/github/copilot/SessionHandlerTest.java +++ b/java/sdk/src/test/java/com/github/copilot/SessionHandlerTest.java @@ -26,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. @@ -225,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 diff --git a/java/src/test/java/com/github/copilot/SessionRequestBuilderTest.java b/java/sdk/src/test/java/com/github/copilot/SessionRequestBuilderTest.java similarity index 84% rename from java/src/test/java/com/github/copilot/SessionRequestBuilderTest.java rename to java/sdk/src/test/java/com/github/copilot/SessionRequestBuilderTest.java index 652be026b1..9d76d18ee2 100644 --- a/java/src/test/java/com/github/copilot/SessionRequestBuilderTest.java +++ b/java/sdk/src/test/java/com/github/copilot/SessionRequestBuilderTest.java @@ -16,6 +16,7 @@ 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; @@ -24,6 +25,8 @@ 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.GitHubTokenProviderResult; import com.github.copilot.rpc.LargeToolOutputConfig; import com.github.copilot.rpc.MemoryConfiguration; import com.github.copilot.rpc.ResumeSessionConfig; @@ -54,6 +57,27 @@ void testBuildCreateRequestNullConfig() { assertEquals("direct", request.getEnvValueMode(), "envValueMode should be 'direct' even for null config"); } + @Test + void testGitHubTokenProviderRegistrationWireFieldHasExactCasing() throws Exception { + var create = SessionRequestBuilder.buildCreateRequest(new SessionConfig(), "create-session"); + create.setGitHubTokenProviderRegistrationId("create-registration"); + var resume = SessionRequestBuilder.buildResumeRequest("resume-session", new ResumeSessionConfig()); + resume.setGitHubTokenProviderRegistrationId("resume-registration"); + var mapper = JsonRpcClient.getObjectMapper(); + + assertEquals("create-registration", + mapper.readTree(mapper.writeValueAsBytes(create)).path("gitHubTokenProviderRegistrationId").asText()); + assertEquals("resume-registration", + mapper.readTree(mapper.writeValueAsBytes(resume)).path("gitHubTokenProviderRegistrationId").asText()); + assertFalse(mapper.readTree(mapper.writeValueAsBytes(create)).has("gitHubToken")); + } + + @Test + void testGitHubTokenProviderResultRedactsToken() { + var result = GitHubTokenProviderResult.token("do-not-print", 28_800); + assertFalse(result.toString().contains("do-not-print")); + } + @Test void testBuildCreateRequestHooksNonNullButEmpty() { // Hooks object exists but hasHooks() returns false @@ -88,6 +112,36 @@ void testBuildCreateRequestAlwaysSetsRequestPermissionTrue() { "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"); @@ -95,6 +149,13 @@ void testBuildCreateRequestSetsClientName() { 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"); @@ -102,6 +163,26 @@ void testBuildCreateRequestSetsReasoningSummary() { 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"); @@ -110,13 +191,17 @@ void testBuildCreateRequestSetsContextTier() { } @Test - void testBuildCreateRequestSetsPluginDirectoriesAndLargeOutput() { + void testBuildCreateRequestSetsPluginDirectoriesAndLargeOutput() throws Exception { var largeOutput = new LargeToolOutputConfig().setEnabled(true).setMaxSizeBytes(1024L) .setOutputDirectory("/tmp/out"); - var config = new SessionConfig().setPluginDirectories(List.of("/plugins/a")).setLargeOutput(largeOutput); + 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 @@ -166,12 +251,13 @@ void testBuildCreateRequestForwardsExplicitMcpOAuthTokenStorage() { void testBuildCreateRequestForwardsSessionPolicyOptions() { var sessionLimits = new SessionLimitsConfig(30.0); var config = new SessionConfig().setExcludedBuiltInAgents(List.of("explore")).setEnableCitations(true) - .setSessionLimits(sessionLimits); + .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()); } @@ -208,6 +294,27 @@ void testBuildResumeRequestOmitsEnableSessionTelemetryWhenNotSet() { 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"), @@ -289,6 +396,13 @@ void testBuildResumeRequestSetsClientName() { 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) @@ -343,12 +457,13 @@ void testBuildResumeRequestForwardsExplicitMcpOAuthTokenStorage() { void testBuildResumeRequestForwardsSessionPolicyOptions() { var sessionLimits = new SessionLimitsConfig(30.0); var config = new ResumeSessionConfig().setExcludedBuiltInAgents(List.of("explore")).setEnableCitations(true) - .setSessionLimits(sessionLimits); + .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()); } @@ -373,13 +488,17 @@ void testBuildResumeRequestSetsContextTier() { } @Test - void testBuildResumeRequestSetsPluginDirectoriesAndLargeOutput() { + void testBuildResumeRequestSetsPluginDirectoriesAndLargeOutput() throws Exception { var largeOutput = new LargeToolOutputConfig().setEnabled(false).setMaxSizeBytes(2048L) .setOutputDirectory("/tmp/resume"); - var config = new ResumeSessionConfig().setPluginDirectories(List.of("/plugins/r")).setLargeOutput(largeOutput); + 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 @@ -958,4 +1077,23 @@ void testClonePreservesAndForwardsExpAssignments() throws Exception { 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/src/test/java/com/github/copilot/SessionTodosChangedTest.java b/java/sdk/src/test/java/com/github/copilot/SessionTodosChangedTest.java similarity index 100% rename from java/src/test/java/com/github/copilot/SessionTodosChangedTest.java rename to java/sdk/src/test/java/com/github/copilot/SessionTodosChangedTest.java 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/src/test/java/com/github/copilot/SlashCommandsIT.java b/java/sdk/src/test/java/com/github/copilot/SlashCommandsIT.java similarity index 94% rename from java/src/test/java/com/github/copilot/SlashCommandsIT.java rename to java/sdk/src/test/java/com/github/copilot/SlashCommandsIT.java index 634c0bad9b..998d533bb3 100644 --- a/java/src/test/java/com/github/copilot/SlashCommandsIT.java +++ b/java/sdk/src/test/java/com/github/copilot/SlashCommandsIT.java @@ -22,6 +22,8 @@ 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; @@ -41,6 +43,7 @@ * 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; @@ -90,9 +93,9 @@ void listCommandsReturnsAtLeast20() throws Exception { @Test void autoPilotToggle() throws Exception { SlashCommandInvocationResult first = session.getRpc().commands - .invoke(new SessionCommandsInvokeParams(null, "autopilot", null)).get(15, TimeUnit.SECONDS); + .invoke(new SessionCommandsInvokeParams(null, "autopilot", null, null)).get(15, TimeUnit.SECONDS); SlashCommandInvocationResult second = session.getRpc().commands - .invoke(new SessionCommandsInvokeParams(null, "autopilot", null)).get(15, TimeUnit.SECONDS); + .invoke(new SessionCommandsInvokeParams(null, "autopilot", null, null)).get(15, TimeUnit.SECONDS); String firstOutput = extractDisplayText(first); String secondOutput = extractDisplayText(second); @@ -125,7 +128,7 @@ void autoPilotToggle() throws Exception { @Test void listDirs() throws Exception { SlashCommandInvocationResult result = session.getRpc().commands - .invoke(new SessionCommandsInvokeParams(null, "list-dirs", null)).get(15, TimeUnit.SECONDS); + .invoke(new SessionCommandsInvokeParams(null, "list-dirs", null, null)).get(15, TimeUnit.SECONDS); String output = extractDisplayText(result); assertTrue(Pattern.compile("(?s)^.*Total: [0-9]+ directories.*$").matcher(output).matches(), @@ -144,19 +147,20 @@ void addDir() throws Exception { String addDirPathString = addDirPath.toString(); SlashCommandInvocationResult beforeListResult = session.getRpc().commands - .invoke(new SessionCommandsInvokeParams(null, "list-dirs", null)).get(15, TimeUnit.SECONDS); + .invoke(new SessionCommandsInvokeParams(null, "list-dirs", null, 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); + .invoke(new SessionCommandsInvokeParams(null, "add-dir", addDirPathString, null)) + .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); + .invoke(new SessionCommandsInvokeParams(null, "list-dirs", null, null)).get(15, TimeUnit.SECONDS); String afterListOutput = extractDisplayText(afterListResult); System.out.println("/list-dirs (after /add-dir) result:"); System.out.println(afterListOutput); @@ -168,7 +172,7 @@ void addDir() throws Exception { @Test void usage() throws Exception { SlashCommandInvocationResult result = session.getRpc().commands - .invoke(new SessionCommandsInvokeParams(null, "usage", null)).get(15, TimeUnit.SECONDS); + .invoke(new SessionCommandsInvokeParams(null, "usage", null, null)).get(15, TimeUnit.SECONDS); String output = extractDisplayText(result); assertTrue(Pattern.compile("(?s)^.*Changes:.*$").matcher(output).matches(), 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 631496a8f7..3701cf9c13 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/src/test/java/com/github/copilot/SubagentHooksE2ETest.java b/java/sdk/src/test/java/com/github/copilot/SubagentHooksE2ETest.java similarity index 100% rename from java/src/test/java/com/github/copilot/SubagentHooksE2ETest.java rename to java/sdk/src/test/java/com/github/copilot/SubagentHooksE2ETest.java diff --git a/java/src/test/java/com/github/copilot/SystemMessageSectionsIT.java b/java/sdk/src/test/java/com/github/copilot/SystemMessageSectionsIT.java similarity index 100% rename from java/src/test/java/com/github/copilot/SystemMessageSectionsIT.java rename to java/sdk/src/test/java/com/github/copilot/SystemMessageSectionsIT.java 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 100% rename from java/src/test/java/com/github/copilot/TelemetryConfigTest.java rename to java/sdk/src/test/java/com/github/copilot/TelemetryConfigTest.java 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 0000000000..f7187ae676 --- /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 100% rename from java/src/test/java/com/github/copilot/TestUtil.java rename to java/sdk/src/test/java/com/github/copilot/TestUtil.java 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/src/test/java/com/github/copilot/ToolDefinitionTest.java b/java/sdk/src/test/java/com/github/copilot/ToolDefinitionTest.java similarity index 100% rename from java/src/test/java/com/github/copilot/ToolDefinitionTest.java rename to java/sdk/src/test/java/com/github/copilot/ToolDefinitionTest.java 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/src/test/java/com/github/copilot/ToolResultObjectSerializationTest.java b/java/sdk/src/test/java/com/github/copilot/ToolResultObjectSerializationTest.java similarity index 100% rename from java/src/test/java/com/github/copilot/ToolResultObjectSerializationTest.java rename to java/sdk/src/test/java/com/github/copilot/ToolResultObjectSerializationTest.java 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 100% rename from java/src/test/java/com/github/copilot/ToolResultsTest.java rename to java/sdk/src/test/java/com/github/copilot/ToolResultsTest.java 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 88% rename from java/src/test/java/com/github/copilot/UpdateSessionOptionsForModeTest.java rename to java/sdk/src/test/java/com/github/copilot/UpdateSessionOptionsForModeTest.java index d02ea3097d..24b4257a52 100644 --- a/java/src/test/java/com/github/copilot/UpdateSessionOptionsForModeTest.java +++ b/java/sdk/src/test/java/com/github/copilot/UpdateSessionOptionsForModeTest.java @@ -10,6 +10,7 @@ import java.net.ServerSocket; import java.net.Socket; import java.nio.charset.StandardCharsets; +import java.util.List; import org.junit.jupiter.api.Test; @@ -144,6 +145,8 @@ void copilotCliMode_skipCustomInstructionsSet_patchContainsOnlyThatField() throw assertTrue(pair.lastParams.path("manageScheduleEnabled").isMissingNode(), "manageScheduleEnabled should be absent"); assertTrue(pair.lastParams.path("installedPlugins").isMissingNode(), "installedPlugins should be absent"); + assertTrue(pair.lastParams.path("includedBuiltinSkills").isMissingNode(), + "includedBuiltinSkills should be absent in COPILOT_CLI mode"); client.close(); } } @@ -154,13 +157,14 @@ void copilotCliMode_allFieldsSet_allPropagated() throws Exception { var session = new CopilotSession("sess-1", pair.rpcClient); var client = new CopilotClient(new CopilotClientOptions().setAutoStart(false)); - client.updateSessionOptionsForMode(session, false, true, true, false).get(); + client.updateSessionOptionsForMode(session, false, true, true, false, List.of("code-review")).get(); assertEquals("session.options.update", pair.lastMethod); assertFalse(pair.lastParams.get("skipCustomInstructions").asBoolean()); assertTrue(pair.lastParams.get("customAgentsLocalOnly").asBoolean()); assertTrue(pair.lastParams.get("coauthorEnabled").asBoolean()); assertFalse(pair.lastParams.get("manageScheduleEnabled").asBoolean()); + assertEquals("code-review", pair.lastParams.get("includedBuiltinSkills").get(0).asText()); client.close(); } } @@ -197,6 +201,9 @@ void emptyMode_noFieldsSet_safeDefaultsSent() throws Exception { assertFalse(pair.lastParams.get("manageScheduleEnabled").asBoolean(), "default: schedule disabled"); assertTrue(pair.lastParams.get("installedPlugins").isArray(), "installedPlugins should be empty array"); assertEquals(0, pair.lastParams.get("installedPlugins").size()); + assertTrue(pair.lastParams.get("includedBuiltinSkills").isArray(), + "includedBuiltinSkills should be empty array"); + assertEquals(0, pair.lastParams.get("includedBuiltinSkills").size()); client.close(); } } @@ -218,6 +225,25 @@ void emptyMode_callerOverridesWin() throws Exception { assertTrue(pair.lastParams.get("installedPlugins").isArray(), "installedPlugins always empty in EMPTY mode"); assertEquals(0, pair.lastParams.get("installedPlugins").size()); + assertTrue(pair.lastParams.get("includedBuiltinSkills").isArray(), + "includedBuiltinSkills always empty in EMPTY mode"); + assertEquals(0, pair.lastParams.get("includedBuiltinSkills").size()); + client.close(); + } + } + + @Test + void emptyMode_explicitBuiltinSkillAllowlistWins() throws Exception { + try (var pair = new AutoReplyPair()) { + var session = new CopilotSession("sess-1", pair.rpcClient); + var client = new CopilotClient(new CopilotClientOptions().setMode(CopilotClientMode.EMPTY) + .setCopilotHome("/tmp/copilot-home").setAutoStart(false)); + + client.updateSessionOptionsForMode(session, null, null, null, null, List.of("code-review")).get(); + + assertEquals("session.options.update", pair.lastMethod); + assertEquals(1, pair.lastParams.get("includedBuiltinSkills").size()); + assertEquals("code-review", pair.lastParams.get("includedBuiltinSkills").get(0).asText()); client.close(); } } 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/src/test/java/com/github/copilot/e2e/ErgonomicTestTools$$CopilotToolMeta.java b/java/sdk/src/test/java/com/github/copilot/e2e/ErgonomicTestTools$$CopilotToolMeta.java similarity index 100% rename from java/src/test/java/com/github/copilot/e2e/ErgonomicTestTools$$CopilotToolMeta.java rename to java/sdk/src/test/java/com/github/copilot/e2e/ErgonomicTestTools$$CopilotToolMeta.java diff --git a/java/src/test/java/com/github/copilot/e2e/ErgonomicTestTools.java b/java/sdk/src/test/java/com/github/copilot/e2e/ErgonomicTestTools.java similarity index 100% rename from java/src/test/java/com/github/copilot/e2e/ErgonomicTestTools.java rename to java/sdk/src/test/java/com/github/copilot/e2e/ErgonomicTestTools.java diff --git a/java/src/test/java/com/github/copilot/e2e/ErgonomicToolDefinitionIT.java b/java/sdk/src/test/java/com/github/copilot/e2e/ErgonomicToolDefinitionIT.java similarity index 100% rename from java/src/test/java/com/github/copilot/e2e/ErgonomicToolDefinitionIT.java rename to java/sdk/src/test/java/com/github/copilot/e2e/ErgonomicToolDefinitionIT.java 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 0000000000..23408faa2a --- /dev/null +++ b/java/sdk/src/test/java/com/github/copilot/e2e/InProcessTransportIT.java @@ -0,0 +1,127 @@ +/*--------------------------------------------------------------------------------------------- + * 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 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.AllowCopilotExperimental; +import com.github.copilot.CopilotClient; +import com.github.copilot.CopilotSession; +import com.github.copilot.E2ETestContext; +import com.github.copilot.ffi.InProcessEnvGuard; +import com.github.copilot.generated.AssistantMessageEvent; +import com.github.copilot.generated.SessionIdleEvent; +import com.github.copilot.rpc.CopilotClientOptions; +import com.github.copilot.rpc.MessageOptions; +import com.github.copilot.rpc.PermissionHandler; +import com.github.copilot.rpc.PingResponse; +import com.github.copilot.rpc.RuntimeConnection; +import com.github.copilot.rpc.SessionConfig; + +/** + * 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}. Coverage includes both a + * purely local {@code ping} round-trip and a replay-backed session turn that + * exercises authentication, tool initialization, model traffic, and + * asynchronous session event delivery over the FFI transport. + * + *

+ * {@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(); + } + } + } + + @Test + void shouldCreateSessionAndCompleteTurnOverInProcessFfi() throws Exception { + ctx.configureForTest("session", "should_receive_session_events"); + + try (CopilotClient client = ctx.createClient(); + CopilotSession session = client + .createSession(new SessionConfig().setOnPermissionRequest(PermissionHandler.APPROVE_ALL)) + .get(30, TimeUnit.SECONDS)) { + var idleReceived = new CompletableFuture(); + session.on(SessionIdleEvent.class, idleReceived::complete); + + AssistantMessageEvent response = session.sendAndWait(new MessageOptions().setPrompt("What is 100+200?")) + .get(60, TimeUnit.SECONDS); + + assertNotNull(response); + assertEquals("100 + 200 = 300", response.getData().content()); + assertNotNull(idleReceived.get(5, TimeUnit.SECONDS)); + } + } +} 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 0000000000..12de4e5b73 --- /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 0000000000..9321618575 --- /dev/null +++ b/java/sdk/src/test/java/com/github/copilot/e2e/RewindIT.java @@ -0,0 +1,136 @@ +/*--------------------------------------------------------------------------------------------- + * 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 static org.junit.jupiter.api.Assumptions.assumeFalse; + +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 { + assumeFalse(System.getProperty("os.name").startsWith("Windows"), + "blocked on CLI 1.0.81 file-change tracking regression on Windows"); + + 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(30); + SessionHistoryListRewindPointsResult result; + do { + result = session.getRpc().history.listRewindPoints().get(10, TimeUnit.SECONDS); + if (result.unavailableReason() == null && !result.points().isEmpty() + && Boolean.TRUE.equals(result.points().get(0).canRestoreFiles())) { + return result; + } + TimeUnit.MILLISECONDS.sleep(100); + } while (System.nanoTime() < deadline); + + assertNull(result.unavailableReason(), "Timed out waiting for rewind points to become available"); + assertFalse(result.points().isEmpty(), "Timed out waiting for a rewind point"); + assertTrue(Boolean.TRUE.equals(result.points().get(0).canRestoreFiles()), + "Timed out waiting for rewind file restoration 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 0000000000..3f626e133f --- /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 0000000000..cc98d24f6b --- /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 0000000000..43df713715 --- /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 0000000000..e37a7cfc82 --- /dev/null +++ b/java/sdk/src/test/java/com/github/copilot/ffi/JnaNativeBindingTest.java @@ -0,0 +1,346 @@ +/*--------------------------------------------------------------------------------------------- + * 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() throws Exception { + Path nativeLib = resolveNativeLib(); + assumeTrue(nativeLib != null, "Native runtime not available (run with -Pinprocess)"); + Path altDir = Path.of("target", "jna-test-runtime"); + Files.createDirectories(altDir); + Path altPath = altDir.resolve("runtime-copy-reset.node"); + Files.copy(nativeLib, altPath, java.nio.file.StandardCopyOption.REPLACE_EXISTING); + + 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 0000000000..fc8bd51011 --- /dev/null +++ b/java/sdk/src/test/java/com/github/copilot/ffi/NativeRuntimeLoaderTest.java @@ -0,0 +1,584 @@ +/*--------------------------------------------------------------------------------------------- + * 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 = PlatformDetector.detectClassifier(); + private static final String OTHER_CLASSIFIER = TEST_CLASSIFIER.equals("darwin-arm64") + ? "linux-x64" + : "darwin-arm64"; + private static final String TEST_CLI_FILENAME = TEST_CLASSIFIER.startsWith("win32") + ? NativeRuntimeLoader.CLI_FILENAME_WINDOWS + : NativeRuntimeLoader.CLI_FILENAME; + 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() throws Exception { + Path workingDirectory = Path.of("").toAbsolutePath(); + Path fakeCliDir = Files.createTempDirectory(Path.of("target").toAbsolutePath(), "relative-cli-test-"); + 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 { + // 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 { + 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 { + 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 { + 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(TEST_CLI_FILENAME))); + assertBytesEqual(OTHER_BINARY_CONTENT, Files.readAllBytes(secondRuntime)); + assertBytesEqual(OTHER_CLI_CONTENT, Files.readAllBytes(secondRuntime.getParent().resolve(TEST_CLI_FILENAME))); + } + + @Test + void extractToCacheThrowsWhenClasspathResourceMissing(@TempDir Path tempDir) { + 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 { + 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 { + 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 { + 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 { + 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 { + assumeTrue(!TEST_CLASSIFIER.startsWith("win32")); + 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(TEST_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 { + 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 { + // 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) { + 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 { + assumeTrue(!TEST_CLASSIFIER.startsWith("win32")); + 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(TEST_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 { + 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 { + 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 { + 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 { + 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) { + 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 { + 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 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(TEST_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(TEST_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 0000000000..82049ea6af --- /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 0000000000..6fd9616706 --- /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 100% 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 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 a4c9344631..fd0fdaaea1 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 @@ -126,7 +126,8 @@ void sessionRpc_mode_set_merges_sessionId() { var stub = new StubCaller(); var session = new SessionRpc(stub, "sess-mode-set"); - var modeParams = new SessionModeSetParams(null, null); + var modeParams = new SessionModeSetParams(null, null, null, null, null, null, null, null, null, null, null, + null); session.mode.set(modeParams); assertEquals(1, stub.calls.size()); @@ -466,7 +467,7 @@ void sessionRpc_ui_elicitation_merges_sessionId() { var stub = new StubCaller(); var session = new SessionRpc(stub, "sess-ui"); - var uiParams = new SessionUiElicitationParams(null, "Please provide info", null); + var uiParams = new SessionUiElicitationParams(null, null, "Please provide info", null, null, null); session.ui.elicitation(uiParams); assertEquals(1, stub.calls.size()); @@ -498,7 +499,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 +552,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 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 94% 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 2b6b0164d5..602089d012 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 @@ -297,7 +301,8 @@ void sessionModeGetParams_record() { @Test void sessionModeSetParams_record() { - var params = new SessionModeSetParams("sess-30", SessionMode.PLAN); + var params = new SessionModeSetParams("sess-30", SessionMode.PLAN, null, null, null, null, null, null, null, + null, null, null); assertEquals("sess-30", params.sessionId()); assertEquals(SessionMode.PLAN, params.mode()); } @@ -321,21 +326,24 @@ void sessionModelGetCurrentParams_record() { @Test void sessionModelSwitchToParams_record() { - var params = new SessionModelSwitchToParams("sess-32", "claude-sonnet-4.5", "high", null, null, null, null); + var params = new SessionModelSwitchToParams("sess-32", "claude-sonnet-4.5", "high", null, null, null, null, + null, null, null, 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 @@ -428,7 +436,7 @@ void sessionToolsHandlePendingToolCallParams_record() { @Test void sessionUiElicitationParams_record() { - var params = new SessionUiElicitationParams("sess-45", "What is your name?", null); + var params = new SessionUiElicitationParams("sess-45", null, "What is your name?", null, null, null); assertEquals("sess-45", params.sessionId()); assertEquals("What is your name?", params.message()); assertNull(params.requestedSchema()); @@ -462,7 +470,7 @@ void pingResult_fields() { @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()); @@ -473,7 +481,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()); @@ -490,7 +498,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()); @@ -499,7 +507,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()); } @@ -614,8 +622,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 @@ -652,8 +662,9 @@ void sessionModelGetCurrentResult_record() { @Test void sessionModelSwitchToResult_record() { - var result = new SessionModelSwitchToResult("gpt-5"); + var result = new SessionModelSwitchToResult("gpt-5", true, null, null, null, null, null, null); assertEquals("gpt-5", result.modelId()); + assertEquals(true, result.deferred()); } @Test @@ -697,11 +708,12 @@ void sessionShellKillResult_record() { @Test void sessionSkillsListResult_nested() { - var item = new Skill("deploy", "Deploy the app", SkillSource.PROJECT, true, true, "/skills/deploy.md", null, - 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()); } @@ -720,7 +732,7 @@ void sessionToolsHandlePendingToolCallResult_record() { @Test void sessionUiElicitationResult_accept() { - var result = new SessionUiElicitationResult(UIElicitationResponseAction.ACCEPT, Map.of("name", "Alice")); + var result = new SessionUiElicitationResult(UIElicitationResponseAction.ACCEPT, Map.of("name", "Alice"), null); assertEquals(UIElicitationResponseAction.ACCEPT, result.action()); assertEquals("Alice", result.content().get("name")); } @@ -745,8 +757,8 @@ void sessionUiHandlePendingElicitationResult_record() { @Test void sessionUsageGetMetricsResult_nested() { var changes = new UsageMetricsCodeChanges(100L, 50L, 5L, null); - var result = new SessionUsageGetMetricsResult(0.5, 10L, null, null, 2000L, null, changes, null, "gpt-5", 1000L, - 500L); + var result = new SessionUsageGetMetricsResult(0.5, 10L, null, null, 2000L, null, changes, null, null, "gpt-5", + 1000L, 500L); assertEquals(0.5, result.totalPremiumRequestCost()); assertEquals(10L, result.totalUserRequests()); assertNotNull(result.codeChanges()); @@ -806,7 +818,8 @@ void modelsListResult_nested() { var policy = new ModelPolicy(ModelPolicyState.ENABLED, 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, null); + var modelItem = new Model("gpt-5", "GPT-5", capabilities, policy, billing, null, null, null, null, null, null, + null, null); var result = new ModelsListResult(List.of(modelItem)); assertEquals(1, result.models().size()); @@ -842,7 +855,8 @@ void sessionModelSwitchToParams_nested_records() { var limits = new ModelCapabilitiesOverrideLimits(100000L, 8192L, 128000L, limitsVision); var supports = new ModelCapabilitiesOverrideSupports(true, true, null); var capabilities = new ModelCapabilitiesOverride(supports, limits); - var params = new SessionModelSwitchToParams("sess-m", "gpt-5", null, null, null, capabilities, null); + var params = new SessionModelSwitchToParams("sess-m", "gpt-5", null, null, null, capabilities, null, null, null, + null, null, null, null, null, null); assertEquals("gpt-5", params.modelId()); assertNotNull(params.modelCapabilities()); @@ -857,7 +871,7 @@ void sessionModelSwitchToParams_nested_records() { @Test void sessionUiElicitationParams_nested_schema() { var schema = new UIElicitationSchema("object", Map.of("name", Map.of("type", "string")), List.of("name")); - var params = new SessionUiElicitationParams("sess-elicit", "Please fill form", schema); + var params = new SessionUiElicitationParams("sess-elicit", null, "Please fill form", schema, null, null); assertEquals("sess-elicit", params.sessionId()); assertEquals("object", params.requestedSchema().type()); assertTrue(params.requestedSchema().required().contains("name")); diff --git a/java/src/test/java/com/github/copilot/rpc/ParamCoercionTest.java b/java/sdk/src/test/java/com/github/copilot/rpc/ParamCoercionTest.java similarity index 100% rename from java/src/test/java/com/github/copilot/rpc/ParamCoercionTest.java rename to java/sdk/src/test/java/com/github/copilot/rpc/ParamCoercionTest.java diff --git a/java/src/test/java/com/github/copilot/rpc/ParamSchemaTest.java b/java/sdk/src/test/java/com/github/copilot/rpc/ParamSchemaTest.java similarity index 100% rename from java/src/test/java/com/github/copilot/rpc/ParamSchemaTest.java rename to java/sdk/src/test/java/com/github/copilot/rpc/ParamSchemaTest.java 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 0000000000..1097b9ea0e --- /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, null); + } + + @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, null); + + 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/src/test/java/com/github/copilot/rpc/RecordInvocationArgs.java b/java/sdk/src/test/java/com/github/copilot/rpc/RecordInvocationArgs.java similarity index 100% rename from java/src/test/java/com/github/copilot/rpc/RecordInvocationArgs.java rename to java/sdk/src/test/java/com/github/copilot/rpc/RecordInvocationArgs.java diff --git a/java/src/test/java/com/github/copilot/rpc/ToolDefinitionFromObjectTest.java b/java/sdk/src/test/java/com/github/copilot/rpc/ToolDefinitionFromObjectTest.java similarity index 100% rename from java/src/test/java/com/github/copilot/rpc/ToolDefinitionFromObjectTest.java rename to java/sdk/src/test/java/com/github/copilot/rpc/ToolDefinitionFromObjectTest.java 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 0000000000..850dfa251f --- /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/src/test/java/com/github/copilot/rpc/ToolDefinitionLambdaTest.java b/java/sdk/src/test/java/com/github/copilot/rpc/ToolDefinitionLambdaTest.java similarity index 100% rename from java/src/test/java/com/github/copilot/rpc/ToolDefinitionLambdaTest.java rename to java/sdk/src/test/java/com/github/copilot/rpc/ToolDefinitionLambdaTest.java diff --git a/java/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 similarity index 100% rename from java/src/test/java/com/github/copilot/rpc/fixtures/ArgCoercionTools$$CopilotToolMeta.java rename to java/sdk/src/test/java/com/github/copilot/rpc/fixtures/ArgCoercionTools$$CopilotToolMeta.java diff --git a/java/src/test/java/com/github/copilot/rpc/fixtures/ArgCoercionTools.java b/java/sdk/src/test/java/com/github/copilot/rpc/fixtures/ArgCoercionTools.java similarity index 100% rename from java/src/test/java/com/github/copilot/rpc/fixtures/ArgCoercionTools.java rename to java/sdk/src/test/java/com/github/copilot/rpc/fixtures/ArgCoercionTools.java diff --git a/java/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 similarity index 100% rename from java/src/test/java/com/github/copilot/rpc/fixtures/DateTimeTools$$CopilotToolMeta.java rename to java/sdk/src/test/java/com/github/copilot/rpc/fixtures/DateTimeTools$$CopilotToolMeta.java diff --git a/java/src/test/java/com/github/copilot/rpc/fixtures/DateTimeTools.java b/java/sdk/src/test/java/com/github/copilot/rpc/fixtures/DateTimeTools.java similarity index 100% rename from java/src/test/java/com/github/copilot/rpc/fixtures/DateTimeTools.java rename to java/sdk/src/test/java/com/github/copilot/rpc/fixtures/DateTimeTools.java diff --git a/java/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 similarity index 100% rename from java/src/test/java/com/github/copilot/rpc/fixtures/DefaultValueTools$$CopilotToolMeta.java rename to java/sdk/src/test/java/com/github/copilot/rpc/fixtures/DefaultValueTools$$CopilotToolMeta.java diff --git a/java/src/test/java/com/github/copilot/rpc/fixtures/DefaultValueTools.java b/java/sdk/src/test/java/com/github/copilot/rpc/fixtures/DefaultValueTools.java similarity index 100% rename from java/src/test/java/com/github/copilot/rpc/fixtures/DefaultValueTools.java rename to java/sdk/src/test/java/com/github/copilot/rpc/fixtures/DefaultValueTools.java diff --git a/java/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 similarity index 100% rename from java/src/test/java/com/github/copilot/rpc/fixtures/InvocationAwareTools$$CopilotToolMeta.java rename to java/sdk/src/test/java/com/github/copilot/rpc/fixtures/InvocationAwareTools$$CopilotToolMeta.java diff --git a/java/src/test/java/com/github/copilot/rpc/fixtures/InvocationAwareTools.java b/java/sdk/src/test/java/com/github/copilot/rpc/fixtures/InvocationAwareTools.java similarity index 100% rename from java/src/test/java/com/github/copilot/rpc/fixtures/InvocationAwareTools.java rename to java/sdk/src/test/java/com/github/copilot/rpc/fixtures/InvocationAwareTools.java diff --git a/java/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 similarity index 100% rename from java/src/test/java/com/github/copilot/rpc/fixtures/MultiReturnTools$$CopilotToolMeta.java rename to java/sdk/src/test/java/com/github/copilot/rpc/fixtures/MultiReturnTools$$CopilotToolMeta.java diff --git a/java/src/test/java/com/github/copilot/rpc/fixtures/MultiReturnTools.java b/java/sdk/src/test/java/com/github/copilot/rpc/fixtures/MultiReturnTools.java similarity index 100% rename from java/src/test/java/com/github/copilot/rpc/fixtures/MultiReturnTools.java rename to java/sdk/src/test/java/com/github/copilot/rpc/fixtures/MultiReturnTools.java diff --git a/java/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 similarity index 100% rename from java/src/test/java/com/github/copilot/rpc/fixtures/OptionalParamTools$$CopilotToolMeta.java rename to java/sdk/src/test/java/com/github/copilot/rpc/fixtures/OptionalParamTools$$CopilotToolMeta.java diff --git a/java/src/test/java/com/github/copilot/rpc/fixtures/OptionalParamTools.java b/java/sdk/src/test/java/com/github/copilot/rpc/fixtures/OptionalParamTools.java similarity index 100% rename from java/src/test/java/com/github/copilot/rpc/fixtures/OptionalParamTools.java rename to java/sdk/src/test/java/com/github/copilot/rpc/fixtures/OptionalParamTools.java diff --git a/java/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 similarity index 100% rename from java/src/test/java/com/github/copilot/rpc/fixtures/OverrideTools$$CopilotToolMeta.java rename to java/sdk/src/test/java/com/github/copilot/rpc/fixtures/OverrideTools$$CopilotToolMeta.java diff --git a/java/src/test/java/com/github/copilot/rpc/fixtures/OverrideTools.java b/java/sdk/src/test/java/com/github/copilot/rpc/fixtures/OverrideTools.java similarity index 100% rename from java/src/test/java/com/github/copilot/rpc/fixtures/OverrideTools.java rename to java/sdk/src/test/java/com/github/copilot/rpc/fixtures/OverrideTools.java diff --git a/java/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 similarity index 100% rename from java/src/test/java/com/github/copilot/rpc/fixtures/SimpleTools$$CopilotToolMeta.java rename to java/sdk/src/test/java/com/github/copilot/rpc/fixtures/SimpleTools$$CopilotToolMeta.java diff --git a/java/src/test/java/com/github/copilot/rpc/fixtures/SimpleTools.java b/java/sdk/src/test/java/com/github/copilot/rpc/fixtures/SimpleTools.java similarity index 100% rename from java/src/test/java/com/github/copilot/rpc/fixtures/SimpleTools.java rename to java/sdk/src/test/java/com/github/copilot/rpc/fixtures/SimpleTools.java diff --git a/java/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 similarity index 100% rename from java/src/test/java/com/github/copilot/rpc/fixtures/StaticInvocationTools$$CopilotToolMeta.java rename to java/sdk/src/test/java/com/github/copilot/rpc/fixtures/StaticInvocationTools$$CopilotToolMeta.java diff --git a/java/src/test/java/com/github/copilot/rpc/fixtures/StaticInvocationTools.java b/java/sdk/src/test/java/com/github/copilot/rpc/fixtures/StaticInvocationTools.java similarity index 100% rename from java/src/test/java/com/github/copilot/rpc/fixtures/StaticInvocationTools.java rename to java/sdk/src/test/java/com/github/copilot/rpc/fixtures/StaticInvocationTools.java diff --git a/java/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 similarity index 100% rename from java/src/test/java/com/github/copilot/rpc/fixtures/StaticTools$$CopilotToolMeta.java rename to java/sdk/src/test/java/com/github/copilot/rpc/fixtures/StaticTools$$CopilotToolMeta.java diff --git a/java/src/test/java/com/github/copilot/rpc/fixtures/StaticTools.java b/java/sdk/src/test/java/com/github/copilot/rpc/fixtures/StaticTools.java similarity index 100% rename from java/src/test/java/com/github/copilot/rpc/fixtures/StaticTools.java rename to java/sdk/src/test/java/com/github/copilot/rpc/fixtures/StaticTools.java diff --git a/java/src/test/java/com/github/copilot/tool/CopilotToolAnnotationTest.java b/java/sdk/src/test/java/com/github/copilot/tool/CopilotToolAnnotationTest.java similarity index 100% rename from java/src/test/java/com/github/copilot/tool/CopilotToolAnnotationTest.java rename to java/sdk/src/test/java/com/github/copilot/tool/CopilotToolAnnotationTest.java diff --git a/java/src/test/java/com/github/copilot/tool/CopilotToolProcessorTest.java b/java/sdk/src/test/java/com/github/copilot/tool/CopilotToolProcessorTest.java similarity index 97% rename from java/src/test/java/com/github/copilot/tool/CopilotToolProcessorTest.java rename to java/sdk/src/test/java/com/github/copilot/tool/CopilotToolProcessorTest.java index f0623d92ed..e7012c644f 100644 --- a/java/src/test/java/com/github/copilot/tool/CopilotToolProcessorTest.java +++ b/java/sdk/src/test/java/com/github/copilot/tool/CopilotToolProcessorTest.java @@ -620,8 +620,8 @@ public String doSomething(@CopilotToolParam("Input") String input) { 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 )"), - "Expected metadata constructor argument to be null when metadata is absent, got:\n" + generated); + assertTrue(normalizedGenerated.contains(" null,\n null\n )"), + "Expected metadata and isTerminal constructor arguments to be null when absent, got:\n" + generated); } @Test @@ -1243,6 +1243,28 @@ public String grep(@CopilotToolParam("Query") String query) { "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 @@ -1252,7 +1274,8 @@ void generatesCombinedFlags() { import com.github.copilot.tool.CopilotTool; import com.github.copilot.rpc.ToolDefer; public class CombinedTools { - @CopilotTool(value = "Combined", overridesBuiltInTool = true, skipPermission = true, defer = ToolDefer.AUTO) + @CopilotTool(value = "Combined", overridesBuiltInTool = true, skipPermission = true, + isTerminal = true, defer = ToolDefer.AUTO) public String doAll() { return "done"; } @@ -1268,11 +1291,10 @@ public String doAll() { 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 β€” should be 2 (overridesBuiltInTool + - // skipPermission) + // Count Boolean.TRUE occurrences β€” override, skipPermission, and isTerminal. long boolCount = generated.lines().filter(l -> l.contains("Boolean.TRUE")).count(); - assertEquals(2, boolCount, - "Expected 2 Boolean.TRUE lines (overridesBuiltInTool + skipPermission), got:\n" + generated); + assertEquals(3, boolCount, + "Expected 3 Boolean.TRUE lines (override + skipPermission + isTerminal), got:\n" + generated); } // ── Test: ToolDefer.NONE results in regular create ────────────────────────── diff --git a/java/src/test/java/com/github/copilot/tool/ParamTest.java b/java/sdk/src/test/java/com/github/copilot/tool/ParamTest.java similarity index 100% rename from java/src/test/java/com/github/copilot/tool/ParamTest.java rename to java/sdk/src/test/java/com/github/copilot/tool/ParamTest.java diff --git a/java/src/test/java/com/github/copilot/tool/SchemaGeneratorTest.java b/java/sdk/src/test/java/com/github/copilot/tool/SchemaGeneratorTest.java similarity index 100% rename from java/src/test/java/com/github/copilot/tool/SchemaGeneratorTest.java rename to java/sdk/src/test/java/com/github/copilot/tool/SchemaGeneratorTest.java 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/rpc/NamedProviderConfig.java b/java/src/generated/java/com/github/copilot/generated/rpc/NamedProviderConfig.java deleted file mode 100644 index 9ee1c5a956..0000000000 --- a/java/src/generated/java/com/github/copilot/generated/rpc/NamedProviderConfig.java +++ /dev/null @@ -1,46 +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.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/SessionEventLogReadResult.java b/java/src/generated/java/com/github/copilot/generated/rpc/SessionEventLogReadResult.java deleted file mode 100644 index 7383e05003..0000000000 --- a/java/src/generated/java/com/github/copilot/generated/rpc/SessionEventLogReadResult.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 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( - /** 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/SessionHistoryApi.java b/java/src/generated/java/com/github/copilot/generated/rpc/SessionHistoryApi.java deleted file mode 100644 index fa2f47b38b..0000000000 --- a/java/src/generated/java/com/github/copilot/generated/rpc/SessionHistoryApi.java +++ /dev/null @@ -1,93 +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.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. - * - * @apiNote This method is experimental and may change in a future version. - * @since 1.0.0 - */ - @CopilotExperimental - 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 - */ - @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 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); - } - -} 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 89584bc29c..0000000000 --- a/java/src/generated/java/com/github/copilot/generated/rpc/SessionModelSwitchToResult.java +++ /dev/null @@ -1,30 +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 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 -) { -} 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 7bde47bc81..0000000000 --- a/java/src/generated/java/com/github/copilot/generated/rpc/SessionPermissionsSetAllowAllParams.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 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's active model is used. */ - @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/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 51a303feb0..0000000000 --- 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/test/java/com/github/copilot/PermissionRequestResultTest.java b/java/src/test/java/com/github/copilot/PermissionRequestResultTest.java deleted file mode 100644 index 4a1ff03137..0000000000 --- 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/nodejs/.npmrc b/nodejs/.npmrc new file mode 100644 index 0000000000..100721e01a --- /dev/null +++ b/nodejs/.npmrc @@ -0,0 +1 @@ +omit-lockfile-registry-resolved=true diff --git a/nodejs/README.md b/nodejs/README.md index e591c7dbc6..93f9c3fa6b 100644 --- a/nodejs/README.md +++ b/nodejs/README.md @@ -36,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, @@ -71,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 @@ -125,16 +131,31 @@ 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. +- `gitHubTokenProvider?: GitHubTokenProvider` - Acquires rotating, session-scoped GitHub tokens. Token results require a positive `expiresIn` value in seconds remaining when the callback completes; production tokens typically last eight hours. Cannot be combined with `gitHubToken`. - `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. +```typescript +const session = await client.createSession({ + gitHubTokenProvider: async ({ host }) => ({ + kind: "token", + accessToken: await acquireTokenForHost(host), + expiresIn: 8 * 60 * 60, + }), +}); +``` + +Initial acquisition runs during session creation or resume. Cancellation, provider errors, and invalid token responses reject that operation instead of falling back to ambient authentication. Idle sessions refresh only before their next credential-consuming operation; there is no background refresh timer. + ##### `resumeSession(sessionId: string, config?: ResumeSessionConfig): Promise` Resume an existing session. Returns the session with `workspacePath` populated if infinite sessions were enabled. @@ -855,7 +876,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"; @@ -866,9 +887,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"; @@ -876,6 +899,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 @@ -913,7 +941,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 @@ -1094,6 +1122,21 @@ try { } ``` +## Development + +From the repository root: + +```bash +cd test/harness +npm ci +``` + +```bash +cd nodejs +npm ci +npm test +``` + ## License MIT diff --git a/nodejs/docs/agent-author.md b/nodejs/docs/agent-author.md index 9071814425..6b9366a7e6 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 1bac87982e..63389c491d 100644 --- a/nodejs/docs/examples.md +++ b/nodejs/docs/examples.md @@ -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 @@ -417,9 +417,9 @@ session.on("assistant.message", (event) => { | `assistant.message` | Agent's final response | `content`, `messageId`, `toolRequests` | | `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` | @@ -677,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 8b36de8a50..3b7161f055 100644 --- a/nodejs/docs/extensions.md +++ b/nodejs/docs/extensions.md @@ -53,7 +53,29 @@ const session = await joinSession({ The `session` object provides methods for sending messages, logging to the timeline, listening to events, and accessing the RPC API. See the `.d.ts` files in the SDK package for full type information. +## Requesting Sensitive Environment Variables + +The CLI strips sensitive environment variables (for example `GITHUB_TOKEN`) from every extension process before it starts. An extension that needs one asks for it by name: + +```js +import { joinSession } from "@github/copilot-sdk/extension"; + +const session = await joinSession({ + requestedEnvironmentVariables: ["GITHUB_TOKEN"], +}); + +// Granted values are in process.env once joinSession resolves. +const token = process.env.GITHUB_TOKEN; +``` + +The CLI prompts the user with the extension's name and the exact list of variables requested. If the user approves, only those variables reach this extension and their values are written into `process.env` before `joinSession()` resolves. If the user denies, `joinSession()` rejects, the extension does not load, and its tools never reach the model. + +An approval is remembered against the exact set of names the user saw, so an extension that later asks for an additional variable prompts again. Names that are unset, or that the CLI does not filter from extensions, are not prompted for. + +An approved extension can pass a granted value to anything it starts, so ask only for what the extension genuinely needs. + ## 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 0000000000..903a3de8b1 --- /dev/null +++ b/nodejs/docs/factories.md @@ -0,0 +1,258 @@ +# 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" } }, + }, + }, + }, + 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. Every limit is optional and must be positive when present; an omitted limit leaves that dimension unbounded, except that an omitted `maxConcurrentSubagents` falls back to `maxTotalSubagents`, so a declared total cap also bounds concurrency. + +Set a ceiling only from real knowledge of what the factory costs, or because the user named one. A guessed ceiling does not make a run safer: it stops a healthy run partway with `factory_limit_reached`, after that run has already spent credits. An agent authoring or invoking a factory on the user's behalf has no basis for estimating a number, so it should leave `limits` unset and bound the work with the factory's own counters instead. Omitting limits does not remove oversight of a model-initiated run: `run_factory` requests permission first, and that prompt shows the effective limits. SDK-initiated `run` and `resume` do not request permission, so an SDK caller that wants a ceiling sets it deliberately, from the cost it already knows. + +```js +// Only when the cost profile is known, or the user asked for this ceiling. +limits: { maxTotalSubagents: 10 }, +``` + +- `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 0000000000..8ae403d55a --- /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 any 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 bound a wide fan-out with the factory's own counters. Do not invent a ceiling to compensate, and see [Resource limits](./factories.md#resource-limits) for when declaring one is appropriate. `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 45837520bf..3b8e6cb861 100644 --- a/nodejs/package-lock.json +++ b/nodejs/package-lock.json @@ -9,7 +9,7 @@ "version": "0.0.0-dev", "license": "MIT", "dependencies": { - "@github/copilot": "^1.0.73", + "@github/copilot": "^1.0.82-0", "koffi": "^3.1.0", "vscode-jsonrpc": "^8.2.1", "zod": "^4.3.6" @@ -40,7 +40,6 @@ }, "node_modules/@apidevtools/json-schema-ref-parser": { "version": "11.9.3", - "resolved": "https://registry.npmjs.org/@apidevtools/json-schema-ref-parser/-/json-schema-ref-parser-11.9.3.tgz", "integrity": "sha512-60vepv88RwcJtSHrD6MjIL6Ta3SOYbgfnkHb+ppAVK+o9mXprRtulx7VlRl3lN3bbvysAfCS7WMVfhUYemB0IQ==", "dev": true, "license": "MIT", @@ -58,7 +57,6 @@ }, "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", @@ -70,7 +68,6 @@ }, "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", @@ -81,7 +78,6 @@ }, "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", @@ -92,7 +88,6 @@ }, "node_modules/@esbuild/aix-ppc64": { "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" @@ -109,7 +104,6 @@ }, "node_modules/@esbuild/android-arm": { "version": "0.28.1", - "resolved": "https://registry.npmjs.org/@esbuild/android-arm/-/android-arm-0.28.1.tgz", "integrity": "sha512-0k2F129Xdio1TdJfzJ8sy1Q47vUD2NnwdhiAf7drUN1EBTfPf4hsFCtmMgu/6m8JSzsBrlmVjudMBQqOfG8usQ==", "cpu": [ "arm" @@ -126,7 +120,6 @@ }, "node_modules/@esbuild/android-arm64": { "version": "0.28.1", - "resolved": "https://registry.npmjs.org/@esbuild/android-arm64/-/android-arm64-0.28.1.tgz", "integrity": "sha512-34EGEbCIAgosYz6goLcopX6Mo7NyGv9tfwEM2/7Ce2VcVRk568iSvniGWcUXIy7wEDR1wzolcxcriFVrWYcwBg==", "cpu": [ "arm64" @@ -143,7 +136,6 @@ }, "node_modules/@esbuild/android-x64": { "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" @@ -160,7 +152,6 @@ }, "node_modules/@esbuild/darwin-arm64": { "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" @@ -177,7 +168,6 @@ }, "node_modules/@esbuild/darwin-x64": { "version": "0.28.1", - "resolved": "https://registry.npmjs.org/@esbuild/darwin-x64/-/darwin-x64-0.28.1.tgz", "integrity": "sha512-zfdzgK9ACBNZLI/CyHTOx81SyNbM6YXn7rxSgX97VjyiPl9W1i4Ka4fgKECEoFCKGpvBj5qArWIGgQjOwkgskQ==", "cpu": [ "x64" @@ -194,7 +184,6 @@ }, "node_modules/@esbuild/freebsd-arm64": { "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" @@ -211,7 +200,6 @@ }, "node_modules/@esbuild/freebsd-x64": { "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" @@ -228,7 +216,6 @@ }, "node_modules/@esbuild/linux-arm": { "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" @@ -245,7 +232,6 @@ }, "node_modules/@esbuild/linux-arm64": { "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" @@ -262,7 +248,6 @@ }, "node_modules/@esbuild/linux-ia32": { "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" @@ -279,7 +264,6 @@ }, "node_modules/@esbuild/linux-loong64": { "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" @@ -296,7 +280,6 @@ }, "node_modules/@esbuild/linux-mips64el": { "version": "0.28.1", - "resolved": "https://registry.npmjs.org/@esbuild/linux-mips64el/-/linux-mips64el-0.28.1.tgz", "integrity": "sha512-mRObBZeHh2OxcBFPWE/FjylkRgZdYuiTR3vaTozquCGOH14iP9oN4x4Ge81CoIDYQrXmIxpFumJBu5MtZpnQJQ==", "cpu": [ "mips64el" @@ -313,7 +296,6 @@ }, "node_modules/@esbuild/linux-ppc64": { "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" @@ -330,7 +312,6 @@ }, "node_modules/@esbuild/linux-riscv64": { "version": "0.28.1", - "resolved": "https://registry.npmjs.org/@esbuild/linux-riscv64/-/linux-riscv64-0.28.1.tgz", "integrity": "sha512-kw0owk1o0GFETUJyW0jc0G4Yzs0BHZn0JDZ8JRT088vjJYX777BAs1fDGxAC+q831qOs2DTC96mNsG2opdfyyQ==", "cpu": [ "riscv64" @@ -347,7 +328,6 @@ }, "node_modules/@esbuild/linux-s390x": { "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" @@ -364,7 +344,6 @@ }, "node_modules/@esbuild/linux-x64": { "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" @@ -381,7 +360,6 @@ }, "node_modules/@esbuild/netbsd-arm64": { "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" @@ -398,7 +376,6 @@ }, "node_modules/@esbuild/netbsd-x64": { "version": "0.28.1", - "resolved": "https://registry.npmjs.org/@esbuild/netbsd-x64/-/netbsd-x64-0.28.1.tgz", "integrity": "sha512-aeL6lAnN89Hz43Mlh1G8ARasbuoYvSITDEx0tHh5b7jJnHcssqgjy9Yx430GDpmCa6OyrKoS0aNRjKundRizGg==", "cpu": [ "x64" @@ -415,7 +392,6 @@ }, "node_modules/@esbuild/openbsd-arm64": { "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" @@ -432,7 +408,6 @@ }, "node_modules/@esbuild/openbsd-x64": { "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" @@ -449,7 +424,6 @@ }, "node_modules/@esbuild/openharmony-arm64": { "version": "0.28.1", - "resolved": "https://registry.npmjs.org/@esbuild/openharmony-arm64/-/openharmony-arm64-0.28.1.tgz", "integrity": "sha512-ge+Z7EXFNt2BO1oAMsVpiQ8EwndV9i1xXerAeTIK7AtPs3bKFXQM7nlRxDSIUIMeueR1CNXxqztLzdNeReKBJg==", "cpu": [ "arm64" @@ -466,7 +440,6 @@ }, "node_modules/@esbuild/sunos-x64": { "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" @@ -483,7 +456,6 @@ }, "node_modules/@esbuild/win32-arm64": { "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" @@ -500,7 +472,6 @@ }, "node_modules/@esbuild/win32-ia32": { "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" @@ -517,7 +488,6 @@ }, "node_modules/@esbuild/win32-x64": { "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" @@ -534,7 +504,6 @@ }, "node_modules/@eslint-community/eslint-utils": { "version": "4.9.1", - "resolved": "https://registry.npmjs.org/@eslint-community/eslint-utils/-/eslint-utils-4.9.1.tgz", "integrity": "sha512-phrYmNiYppR7znFEdqgfWHXR6NCkZEK7hwWDHZUjit/2/U0r6XvkDl0SYnoM51Hq7FhCGdLDT6zxCCOY1hexsQ==", "dev": true, "license": "MIT", @@ -553,7 +522,6 @@ }, "node_modules/@eslint-community/regexpp": { "version": "4.12.2", - "resolved": "https://registry.npmjs.org/@eslint-community/regexpp/-/regexpp-4.12.2.tgz", "integrity": "sha512-EriSTlt5OC9/7SXkRSCAhfSxxoSUgBm33OH+IkwbdpgoqsSsUg7y3uh+IICI/Qg4BBWr3U2i39RpmycbxMq4ew==", "dev": true, "license": "MIT", @@ -563,7 +531,6 @@ }, "node_modules/@eslint/config-array": { "version": "0.21.1", - "resolved": "https://registry.npmjs.org/@eslint/config-array/-/config-array-0.21.1.tgz", "integrity": "sha512-aw1gNayWpdI/jSYVgzN5pL0cfzU02GT3NBpeT/DXbx1/1x7ZKxFPd9bwrzygx/qiwIQiJ1sw/zD8qY/kRvlGHA==", "dev": true, "license": "Apache-2.0", @@ -578,7 +545,6 @@ }, "node_modules/@eslint/config-array/node_modules/minimatch": { "version": "3.1.5", - "resolved": "https://registry.npmjs.org/minimatch/-/minimatch-3.1.5.tgz", "integrity": "sha512-VgjWUsnnT6n+NUk6eZq77zeFdpW2LWDzP6zFGrCbHXiYNul5Dzqk2HHQ5uFH2DNW5Xbp8+jVzaeNt94ssEEl4w==", "dev": true, "license": "ISC", @@ -591,7 +557,6 @@ }, "node_modules/@eslint/config-helpers": { "version": "0.4.2", - "resolved": "https://registry.npmjs.org/@eslint/config-helpers/-/config-helpers-0.4.2.tgz", "integrity": "sha512-gBrxN88gOIf3R7ja5K9slwNayVcZgK6SOUORm2uBzTeIEfeVaIhOpCtTox3P6R7o2jLFwLFTLnC7kU/RGcYEgw==", "dev": true, "license": "Apache-2.0", @@ -604,7 +569,6 @@ }, "node_modules/@eslint/core": { "version": "0.17.0", - "resolved": "https://registry.npmjs.org/@eslint/core/-/core-0.17.0.tgz", "integrity": "sha512-yL/sLrpmtDaFEiUj1osRP4TI2MDz1AddJL+jZ7KSqvBuliN4xqYY54IfdN8qD8Toa6g1iloph1fxQNkjOxrrpQ==", "dev": true, "license": "Apache-2.0", @@ -617,7 +581,6 @@ }, "node_modules/@eslint/eslintrc": { "version": "3.3.3", - "resolved": "https://registry.npmjs.org/@eslint/eslintrc/-/eslintrc-3.3.3.tgz", "integrity": "sha512-Kr+LPIUVKz2qkx1HAMH8q1q6azbqBAsXJUxBl/ODDuVPX45Z9DfwB8tPjTi6nNZ8BuM3nbJxC5zCAg5elnBUTQ==", "dev": true, "license": "MIT", @@ -641,7 +604,6 @@ }, "node_modules/@eslint/eslintrc/node_modules/ignore": { "version": "5.3.2", - "resolved": "https://registry.npmjs.org/ignore/-/ignore-5.3.2.tgz", "integrity": "sha512-hsBTNUqQTDwkWtcdYI2i06Y/nUBEsNEDJKjWdigLvegy8kDuJAS8uRlpkkcQpyEXL0Z/pjDy5HBmMjRCJ2gq+g==", "dev": true, "license": "MIT", @@ -651,7 +613,6 @@ }, "node_modules/@eslint/eslintrc/node_modules/minimatch": { "version": "3.1.5", - "resolved": "https://registry.npmjs.org/minimatch/-/minimatch-3.1.5.tgz", "integrity": "sha512-VgjWUsnnT6n+NUk6eZq77zeFdpW2LWDzP6zFGrCbHXiYNul5Dzqk2HHQ5uFH2DNW5Xbp8+jVzaeNt94ssEEl4w==", "dev": true, "license": "ISC", @@ -664,7 +625,6 @@ }, "node_modules/@eslint/js": { "version": "9.39.2", - "resolved": "https://registry.npmjs.org/@eslint/js/-/js-9.39.2.tgz", "integrity": "sha512-q1mjIoW1VX4IvSocvM/vbTiveKC4k9eLrajNEuSsmjymSDEbpGddtpfOoN7YGAqBK3NG+uqo8ia4PDTt8buCYA==", "dev": true, "license": "MIT", @@ -677,7 +637,6 @@ }, "node_modules/@eslint/object-schema": { "version": "2.1.7", - "resolved": "https://registry.npmjs.org/@eslint/object-schema/-/object-schema-2.1.7.tgz", "integrity": "sha512-VtAOaymWVfZcmZbp6E2mympDIHvyjXs/12LqWYjVw6qjrfF+VK+fyG33kChz3nnK+SU5/NeHOqrTEHS8sXO3OA==", "dev": true, "license": "Apache-2.0", @@ -687,7 +646,6 @@ }, "node_modules/@eslint/plugin-kit": { "version": "0.4.1", - "resolved": "https://registry.npmjs.org/@eslint/plugin-kit/-/plugin-kit-0.4.1.tgz", "integrity": "sha512-43/qtrDUokr7LJqoF2c3+RInu/t4zfrpYdoSDfYyhg52rwLV6TnOvdG4fXm7IkSB3wErkcmJS9iEhjVtOSEjjA==", "dev": true, "license": "Apache-2.0", @@ -700,9 +658,8 @@ } }, "node_modules/@github/copilot": { - "version": "1.0.73", - "resolved": "https://registry.npmjs.org/@github/copilot/-/copilot-1.0.73.tgz", - "integrity": "sha512-8I2Ejg2CX/PQA3c2H8W1zuqhniCeR1q1/bD8CrV53/ZLw8GF7DAV0xQpwa8ELYvFgjXb6AADojafCKwdbVef+A==", + "version": "1.0.82-0", + "integrity": "sha512-fSZVNAzFFYaS6btYD0+cKF7SrrtOklhpkPs/cIMZY7Fgxoa6rfZrlTWXlQNgNIdwLp51XxwTfxnZO+D9+MQ5yg==", "license": "SEE LICENSE IN LICENSE.md", "dependencies": { "detect-libc": "^2.1.2" @@ -711,20 +668,19 @@ "copilot": "npm-loader.js" }, "optionalDependencies": { - "@github/copilot-darwin-arm64": "1.0.73", - "@github/copilot-darwin-x64": "1.0.73", - "@github/copilot-linux-arm64": "1.0.73", - "@github/copilot-linux-x64": "1.0.73", - "@github/copilot-linuxmusl-arm64": "1.0.73", - "@github/copilot-linuxmusl-x64": "1.0.73", - "@github/copilot-win32-arm64": "1.0.73", - "@github/copilot-win32-x64": "1.0.73" + "@github/copilot-darwin-arm64": "1.0.82-0", + "@github/copilot-darwin-x64": "1.0.82-0", + "@github/copilot-linux-arm64": "1.0.82-0", + "@github/copilot-linux-x64": "1.0.82-0", + "@github/copilot-linuxmusl-arm64": "1.0.82-0", + "@github/copilot-linuxmusl-x64": "1.0.82-0", + "@github/copilot-win32-arm64": "1.0.82-0", + "@github/copilot-win32-x64": "1.0.82-0" } }, "node_modules/@github/copilot-darwin-arm64": { - "version": "1.0.73", - "resolved": "https://registry.npmjs.org/@github/copilot-darwin-arm64/-/copilot-darwin-arm64-1.0.73.tgz", - "integrity": "sha512-5jv7t2sw35/zI0cPze38hG6239NT5/q/Emjx6gLibYkolDqMDJjpm17Ps7tc8oafUEOiMQMb+ar7+qi6rSiGJA==", + "version": "1.0.82-0", + "integrity": "sha512-TzBYfyvxcw3z9Mu7U8TsFo/Nq7m5XS6ahT71aPL+gx/YId0kmenI27b9daXsK6LA1D0gsFGwNBDKINddqntt1g==", "cpu": [ "arm64" ], @@ -738,9 +694,8 @@ } }, "node_modules/@github/copilot-darwin-x64": { - "version": "1.0.73", - "resolved": "https://registry.npmjs.org/@github/copilot-darwin-x64/-/copilot-darwin-x64-1.0.73.tgz", - "integrity": "sha512-l794k6Ahb11AG2FQT/P4TEWxWblzM1h8aQQCzG8jBWp8dfwjhyYjJ+d+0CWQzM3Fc1ddNUZRjKXCUsfvFjiZhQ==", + "version": "1.0.82-0", + "integrity": "sha512-Lm/U5Q8kN8yEeBTWKTfIxXAgXaT6zqdBzAAO7lA4DWHZ92AEeZZiVTs6jEWsQ2aWB2uMs6zbn0vi6t+/jIqCGw==", "cpu": [ "x64" ], @@ -754,9 +709,8 @@ } }, "node_modules/@github/copilot-linux-arm64": { - "version": "1.0.73", - "resolved": "https://registry.npmjs.org/@github/copilot-linux-arm64/-/copilot-linux-arm64-1.0.73.tgz", - "integrity": "sha512-Zu0W5nupJjNeem0brqU/pG+VY0IWr6EWr/FsC90g5SEDiaM4VhVNVWcz8t0E3DQCSYetV6IBaNMtjs/3uIIiDQ==", + "version": "1.0.82-0", + "integrity": "sha512-YERVMC1Q4p6l6KQHL5rVOI52rWbvgp9IwyzUBaVSGrfFuqu5BEvZ9bgHPsxTYi3Npkt5KVOXEyPMU5rAY09qQQ==", "cpu": [ "arm64" ], @@ -770,9 +724,8 @@ } }, "node_modules/@github/copilot-linux-x64": { - "version": "1.0.73", - "resolved": "https://registry.npmjs.org/@github/copilot-linux-x64/-/copilot-linux-x64-1.0.73.tgz", - "integrity": "sha512-k33XIr6/PVp+K+5F/zv3No4PPaNImvHz73mcbIw63oxh5iiacXjgr0WqbBIS5s/rkhOWjNPIkbof/TTPZ7mQjA==", + "version": "1.0.82-0", + "integrity": "sha512-z2hxMVjqt4+xDRFTZv3/0K3X+aqcJhd6zPO2JxCpOVTh5CNZFaWk+XIa2iXAPWxFqdKJsQ4muXMl3zInaAOkRw==", "cpu": [ "x64" ], @@ -786,9 +739,8 @@ } }, "node_modules/@github/copilot-linuxmusl-arm64": { - "version": "1.0.73", - "resolved": "https://registry.npmjs.org/@github/copilot-linuxmusl-arm64/-/copilot-linuxmusl-arm64-1.0.73.tgz", - "integrity": "sha512-HJWzhfD3oaiIgfRAHkNWzp17fELtshqM9HVN5n+lFEmSO2EETCEh0P1lhJc4m+FYfXSJnL0raAqVuyaNMuPoPw==", + "version": "1.0.82-0", + "integrity": "sha512-EcUCv2PKhBzCCvpTaS511VYTDWyhudyIRPvBpc9gFNO3hjlgiNDusf4k9vP6+E3/lHenwGYzMsyRHcYIOy4vcQ==", "cpu": [ "arm64" ], @@ -802,9 +754,8 @@ } }, "node_modules/@github/copilot-linuxmusl-x64": { - "version": "1.0.73", - "resolved": "https://registry.npmjs.org/@github/copilot-linuxmusl-x64/-/copilot-linuxmusl-x64-1.0.73.tgz", - "integrity": "sha512-/BpOXSb16wHEu8I1SaKiLszQ4Kvu4+Z4uCn7W0bv4xI4fPZwTEG0u3zgaI2W9Ao3+aBl0XRpPmpWzE9ziYEq+w==", + "version": "1.0.82-0", + "integrity": "sha512-1fKVjUiZ1tdb0/d/re90EpFGXhlIPfjENp2Wo/2Kj592dWO3+IwM2qV/AOdMQ4pacW5iYHII7nibx1/EYq3LGQ==", "cpu": [ "x64" ], @@ -818,9 +769,8 @@ } }, "node_modules/@github/copilot-win32-arm64": { - "version": "1.0.73", - "resolved": "https://registry.npmjs.org/@github/copilot-win32-arm64/-/copilot-win32-arm64-1.0.73.tgz", - "integrity": "sha512-DbPeXiYzQjpOy9oboaBvuCzjRwfcL987c3bG09cK1crdCDrKfkTJ7NXpcp1KWRPIRFO1FQm1qToNE89J+L3uvg==", + "version": "1.0.82-0", + "integrity": "sha512-H341wuxQHhwe/yLmORHzwC3DGzFZgGzh+TpwfyK2zjeYVbwDZ3Bax8M+9CzIED9jIBdEfAmfGzxKUHFugpXTtQ==", "cpu": [ "arm64" ], @@ -834,9 +784,8 @@ } }, "node_modules/@github/copilot-win32-x64": { - "version": "1.0.73", - "resolved": "https://registry.npmjs.org/@github/copilot-win32-x64/-/copilot-win32-x64-1.0.73.tgz", - "integrity": "sha512-8D3E1l5i+N5Eq8HIOQpx+Zbcb3MXdFxszksM2gqq175Z1S7Zna67oY4GoR3psxlbIpSyHKiLEBWYiaps6ayHWw==", + "version": "1.0.82-0", + "integrity": "sha512-f1ba3gG8NaoYWFHtHaHcLN4It7mclkWdCOXvwFPqPEwqCEIx/+Zh6VHiOeIcNWRS0elRP6QYDCKaTDy1TW27uQ==", "cpu": [ "x64" ], @@ -851,14 +800,12 @@ }, "node_modules/@glideapps/ts-necessities": { "version": "2.2.3", - "resolved": "https://registry.npmjs.org/@glideapps/ts-necessities/-/ts-necessities-2.2.3.tgz", "integrity": "sha512-gXi0awOZLHk3TbW55GZLCPP6O+y/b5X1pBXKBVckFONSwF1z1E5ND2BGJsghQFah+pW7pkkyFb2VhUQI2qhL5w==", "dev": true, "license": "MIT" }, "node_modules/@humanfs/core": { "version": "0.19.1", - "resolved": "https://registry.npmjs.org/@humanfs/core/-/core-0.19.1.tgz", "integrity": "sha512-5DyQ4+1JEUzejeK1JGICcideyfUbGixgS9jNgex5nqkW+cY7WZhxBigmieN5Qnw9ZosSNVC9KQKyb+GUaGyKUA==", "dev": true, "license": "Apache-2.0", @@ -868,7 +815,6 @@ }, "node_modules/@humanfs/node": { "version": "0.16.7", - "resolved": "https://registry.npmjs.org/@humanfs/node/-/node-0.16.7.tgz", "integrity": "sha512-/zUx+yOsIrG4Y43Eh2peDeKCxlRt/gET6aHfaKpuq267qXdYDFViVHfMaLyygZOnl0kGWxFIgsBy8QFuTLUXEQ==", "dev": true, "license": "Apache-2.0", @@ -882,7 +828,6 @@ }, "node_modules/@humanwhocodes/module-importer": { "version": "1.0.1", - "resolved": "https://registry.npmjs.org/@humanwhocodes/module-importer/-/module-importer-1.0.1.tgz", "integrity": "sha512-bxveV4V8v5Yb4ncFTT3rPSgZBOpCkjfK0y4oVVVJwIuDVBRMDXrPyXRL988i5ap9m9bnyEEjWfm5WkBmtffLfA==", "dev": true, "license": "Apache-2.0", @@ -896,7 +841,6 @@ }, "node_modules/@humanwhocodes/retry": { "version": "0.4.3", - "resolved": "https://registry.npmjs.org/@humanwhocodes/retry/-/retry-0.4.3.tgz", "integrity": "sha512-bV0Tgo9K4hfPCek+aMAn81RppFKv2ySDQeMoSZuvTASywNTnVJCArCZE2FWqpvIatKu7VMRLWlR1EazvVhDyhQ==", "dev": true, "license": "Apache-2.0", @@ -910,21 +854,18 @@ }, "node_modules/@jridgewell/sourcemap-codec": { "version": "1.5.5", - "resolved": "https://registry.npmjs.org/@jridgewell/sourcemap-codec/-/sourcemap-codec-1.5.5.tgz", "integrity": "sha512-cYQ9310grqxueWbl+WuIUIaiUaDcj7WOq5fVhEljNVgRfOUhY9fy2zTvfoqWsnebh8Sl70VScFbICvJnLKB0Og==", "dev": true, "license": "MIT" }, "node_modules/@jsdevtools/ono": { "version": "7.1.3", - "resolved": "https://registry.npmjs.org/@jsdevtools/ono/-/ono-7.1.3.tgz", "integrity": "sha512-4JQNk+3mVzK3xh2rqd6RB4J46qUR19azEHBneZyTZM+c456qOrbbM/5xcR8huNCCcbVt7+UmizG6GuUvPvKUYg==", "dev": true, "license": "MIT" }, "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" @@ -940,7 +881,6 @@ }, "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": [ "x64" @@ -956,7 +896,6 @@ }, "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" @@ -972,7 +911,6 @@ }, "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": [ "ia32" @@ -988,7 +926,6 @@ }, "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" @@ -1004,7 +941,6 @@ }, "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" @@ -1020,7 +956,6 @@ }, "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": [ "ia32" @@ -1036,7 +971,6 @@ }, "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": [ "loong64" @@ -1052,7 +986,6 @@ }, "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": [ "riscv64" @@ -1068,7 +1001,6 @@ }, "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": [ "x64" @@ -1084,7 +1016,6 @@ }, "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": [ "ia32" @@ -1100,7 +1031,6 @@ }, "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": [ "x64" @@ -1116,7 +1046,6 @@ }, "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" @@ -1132,7 +1061,6 @@ }, "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" @@ -1148,7 +1076,6 @@ }, "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", @@ -1167,7 +1094,6 @@ }, "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", @@ -1177,7 +1103,6 @@ }, "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", @@ -1187,7 +1112,6 @@ }, "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" @@ -1204,7 +1128,6 @@ }, "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" @@ -1221,7 +1144,6 @@ }, "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" @@ -1238,7 +1160,6 @@ }, "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" @@ -1255,7 +1176,6 @@ }, "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" @@ -1272,7 +1192,6 @@ }, "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" @@ -1289,7 +1208,6 @@ }, "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": [ "arm64" @@ -1306,7 +1224,6 @@ }, "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" @@ -1323,7 +1240,6 @@ }, "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" @@ -1340,7 +1256,6 @@ }, "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" @@ -1357,7 +1272,6 @@ }, "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" @@ -1374,7 +1288,6 @@ }, "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" @@ -1391,7 +1304,6 @@ }, "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": [ "wasm32" @@ -1410,7 +1322,6 @@ }, "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": [ "arm64" @@ -1427,7 +1338,6 @@ }, "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" @@ -1444,21 +1354,18 @@ }, "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", @@ -1469,7 +1376,6 @@ }, "node_modules/@types/chai": { "version": "5.2.3", - "resolved": "https://registry.npmjs.org/@types/chai/-/chai-5.2.3.tgz", "integrity": "sha512-Mw558oeA9fFbv65/y4mHtXDs9bPnFMZAL/jxdPFUpOHHIXX91mcgEHbS5Lahr+pwZFR8A7GQleRWeI6cGFC2UA==", "dev": true, "license": "MIT", @@ -1480,35 +1386,30 @@ }, "node_modules/@types/deep-eql": { "version": "4.0.2", - "resolved": "https://registry.npmjs.org/@types/deep-eql/-/deep-eql-4.0.2.tgz", "integrity": "sha512-c9h9dVVMigMPc4bwTvC5dxqtqJZwQPePsWjPlpSOnojbor6pGqdk541lfA7AqFQr5pB1BRdq0juY9db81BwyFw==", "dev": true, "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==", "dev": true, "license": "MIT" }, "node_modules/@types/json-schema": { "version": "7.0.15", - "resolved": "https://registry.npmjs.org/@types/json-schema/-/json-schema-7.0.15.tgz", "integrity": "sha512-5+fP8P8MFNC+AyZCDxrB2pkZFPGzqQWUzpSeuuVLvm8VMcorNYavBqoFcxK8bQz4Qsbn4oUEEem4wDLfcysGHA==", "dev": true, "license": "MIT" }, "node_modules/@types/lodash": { "version": "4.17.21", - "resolved": "https://registry.npmjs.org/@types/lodash/-/lodash-4.17.21.tgz", "integrity": "sha512-FOvQ0YPD5NOfPgMzJihoT+Za5pdkDJWcbpuj1DjaKZIr/gxodQjY/uWEFlTNqW2ugXHUiL8lRQgw63dzKHZdeQ==", "dev": true, "license": "MIT" }, "node_modules/@types/node": { "version": "25.3.3", - "resolved": "https://registry.npmjs.org/@types/node/-/node-25.3.3.tgz", "integrity": "sha512-DpzbrH7wIcBaJibpKo9nnSQL0MTRdnWttGyE5haGwK86xgMOkFLp7vEyfQPGLOJh5wNYiJ3V9PmUMDhV9u8kkQ==", "dev": true, "license": "MIT", @@ -1518,7 +1419,6 @@ }, "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", @@ -1528,7 +1428,6 @@ }, "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", "integrity": "sha512-Jz9ZztpB37dNC+HU2HI28Bs9QXpzCz+y/twHOwhyrIRdbuVDxSytJNDl6z/aAKlaRIwC7y8wJdkBv7FxYGgi0A==", "dev": true, "license": "MIT", @@ -1557,7 +1456,6 @@ }, "node_modules/@typescript-eslint/parser": { "version": "8.56.1", - "resolved": "https://registry.npmjs.org/@typescript-eslint/parser/-/parser-8.56.1.tgz", "integrity": "sha512-klQbnPAAiGYFyI02+znpBRLyjL4/BrBd0nyWkdC0s/6xFLkXYQ8OoRrSkqacS1ddVxf/LDyODIKbQ5TgKAf/Fg==", "dev": true, "license": "MIT", @@ -1582,7 +1480,6 @@ }, "node_modules/@typescript-eslint/project-service": { "version": "8.56.1", - "resolved": "https://registry.npmjs.org/@typescript-eslint/project-service/-/project-service-8.56.1.tgz", "integrity": "sha512-TAdqQTzHNNvlVFfR+hu2PDJrURiwKsUvxFn1M0h95BB8ah5jejas08jUWG4dBA68jDMI988IvtfdAI53JzEHOQ==", "dev": true, "license": "MIT", @@ -1604,7 +1501,6 @@ }, "node_modules/@typescript-eslint/scope-manager": { "version": "8.56.1", - "resolved": "https://registry.npmjs.org/@typescript-eslint/scope-manager/-/scope-manager-8.56.1.tgz", "integrity": "sha512-YAi4VDKcIZp0O4tz/haYKhmIDZFEUPOreKbfdAN3SzUDMcPhJ8QI99xQXqX+HoUVq8cs85eRKnD+rne2UAnj2w==", "dev": true, "license": "MIT", @@ -1622,7 +1518,6 @@ }, "node_modules/@typescript-eslint/tsconfig-utils": { "version": "8.56.1", - "resolved": "https://registry.npmjs.org/@typescript-eslint/tsconfig-utils/-/tsconfig-utils-8.56.1.tgz", "integrity": "sha512-qOtCYzKEeyr3aR9f28mPJqBty7+DBqsdd63eO0yyDwc6vgThj2UjWfJIcsFeSucYydqcuudMOprZ+x1SpF3ZuQ==", "dev": true, "license": "MIT", @@ -1639,7 +1534,6 @@ }, "node_modules/@typescript-eslint/type-utils": { "version": "8.56.1", - "resolved": "https://registry.npmjs.org/@typescript-eslint/type-utils/-/type-utils-8.56.1.tgz", "integrity": "sha512-yB/7dxi7MgTtGhZdaHCemf7PuwrHMenHjmzgUW1aJpO+bBU43OycnM3Wn+DdvDO/8zzA9HlhaJ0AUGuvri4oGg==", "dev": true, "license": "MIT", @@ -1664,7 +1558,6 @@ }, "node_modules/@typescript-eslint/types": { "version": "8.56.1", - "resolved": "https://registry.npmjs.org/@typescript-eslint/types/-/types-8.56.1.tgz", "integrity": "sha512-dbMkdIUkIkchgGDIv7KLUpa0Mda4IYjo4IAMJUZ+3xNoUXxMsk9YtKpTHSChRS85o+H9ftm51gsK1dZReY9CVw==", "dev": true, "license": "MIT", @@ -1678,7 +1571,6 @@ }, "node_modules/@typescript-eslint/typescript-estree": { "version": "8.56.1", - "resolved": "https://registry.npmjs.org/@typescript-eslint/typescript-estree/-/typescript-estree-8.56.1.tgz", "integrity": "sha512-qzUL1qgalIvKWAf9C1HpvBjif+Vm6rcT5wZd4VoMb9+Km3iS3Cv9DY6dMRMDtPnwRAFyAi7YXJpTIEXLvdfPxg==", "dev": true, "license": "MIT", @@ -1706,7 +1598,6 @@ }, "node_modules/@typescript-eslint/utils": { "version": "8.56.1", - "resolved": "https://registry.npmjs.org/@typescript-eslint/utils/-/utils-8.56.1.tgz", "integrity": "sha512-HPAVNIME3tABJ61siYlHzSWCGtOoeP2RTIaHXFMPqjrQKCGB9OgUVdiNgH7TJS2JNIQ5qQ4RsAUDuGaGme/KOA==", "dev": true, "license": "MIT", @@ -1730,7 +1621,6 @@ }, "node_modules/@typescript-eslint/visitor-keys": { "version": "8.56.1", - "resolved": "https://registry.npmjs.org/@typescript-eslint/visitor-keys/-/visitor-keys-8.56.1.tgz", "integrity": "sha512-KiROIzYdEV85YygXw6BI/Dx4fnBlFQu6Mq4QE4MOH9fFnhohw6wX/OAvDY2/C+ut0I3RSPKenvZJIVYqJNkhEw==", "dev": true, "license": "MIT", @@ -1748,7 +1638,6 @@ }, "node_modules/@typescript-eslint/visitor-keys/node_modules/eslint-visitor-keys": { "version": "5.0.1", - "resolved": "https://registry.npmjs.org/eslint-visitor-keys/-/eslint-visitor-keys-5.0.1.tgz", "integrity": "sha512-tD40eHxA35h0PEIZNeIjkHoDR4YjjJp34biM0mDvplBe//mB+IHCqHDGV7pxF+7MklTvighcCPPZC7ynWyjdTA==", "dev": true, "license": "Apache-2.0", @@ -1761,7 +1650,6 @@ }, "node_modules/@vitest/expect": { "version": "4.1.8", - "resolved": "https://registry.npmjs.org/@vitest/expect/-/expect-4.1.8.tgz", "integrity": "sha512-h3nDO677RDLEGlBxyQ5CW8RlMThSKSRLUePLOx09gNIWRL40edgA1GCZSZgf1W55MFAG6/Sw14KeaAnqv0NKdQ==", "dev": true, "license": "MIT", @@ -1779,7 +1667,6 @@ }, "node_modules/@vitest/mocker": { "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", @@ -1806,7 +1693,6 @@ }, "node_modules/@vitest/pretty-format": { "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", @@ -1819,7 +1705,6 @@ }, "node_modules/@vitest/runner": { "version": "4.1.8", - "resolved": "https://registry.npmjs.org/@vitest/runner/-/runner-4.1.8.tgz", "integrity": "sha512-EmVxeBAfMJvycdjd6Hm+RbFBbA9fKvo0Kx37hNpBYoYeavH3RNsBXWDooR1mgD52dCrxIIuP7UotpfiwOikvcg==", "dev": true, "license": "MIT", @@ -1833,7 +1718,6 @@ }, "node_modules/@vitest/snapshot": { "version": "4.1.8", - "resolved": "https://registry.npmjs.org/@vitest/snapshot/-/snapshot-4.1.8.tgz", "integrity": "sha512-acfZboRmAIf05DEKcBQy33VXojFJjtUdLyo7oOmV9kebb2xdU01UknNiPuPZoJZQyO7DF0gZdTGTpeAzET9QPQ==", "dev": true, "license": "MIT", @@ -1849,7 +1733,6 @@ }, "node_modules/@vitest/spy": { "version": "4.1.8", - "resolved": "https://registry.npmjs.org/@vitest/spy/-/spy-4.1.8.tgz", "integrity": "sha512-6EevtBp6OZOPF7bmz36HrGMeP3txgVSrgebWxHOafDXGkhIzfXK14f8KF6MuFfgXXUeHxmpD3BQxkV00/3s5mA==", "dev": true, "license": "MIT", @@ -1859,7 +1742,6 @@ }, "node_modules/@vitest/utils": { "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", @@ -1874,7 +1756,6 @@ }, "node_modules/abort-controller": { "version": "3.0.0", - "resolved": "https://registry.npmjs.org/abort-controller/-/abort-controller-3.0.0.tgz", "integrity": "sha512-h8lQ8tacZYnR3vNQTgibj+tODHI5/+l06Au2Pcriv/Gmet0eaj4TwWH41sO9wnHDiQsEj19q0drzdWdeAHtweg==", "dev": true, "license": "MIT", @@ -1887,7 +1768,6 @@ }, "node_modules/acorn": { "version": "8.15.0", - "resolved": "https://registry.npmjs.org/acorn/-/acorn-8.15.0.tgz", "integrity": "sha512-NZyJarBfL7nWwIq+FDL6Zp/yHEhePMNnnJ0y3qfieCrmNvYct8uvtiV41UvlSe6apAfk0fY1FbWx+NwfmpvtTg==", "dev": true, "license": "MIT", @@ -1900,7 +1780,6 @@ }, "node_modules/acorn-jsx": { "version": "5.3.2", - "resolved": "https://registry.npmjs.org/acorn-jsx/-/acorn-jsx-5.3.2.tgz", "integrity": "sha512-rq9s+JNhf0IChjtDXxllJ7g41oZk5SlXtp0LHwyA5cejwn7vKmKp4pPri6YEePv2PU65sAsegbXtIinmDFDXgQ==", "dev": true, "license": "MIT", @@ -1910,7 +1789,6 @@ }, "node_modules/ajv": { "version": "6.15.0", - "resolved": "https://registry.npmjs.org/ajv/-/ajv-6.15.0.tgz", "integrity": "sha512-fgFx7Hfoq60ytK2c7DhnF8jIvzYgOMxfugjLOSMHjLIPgenqa7S7oaagATUq99mV6IYvN2tRmC0wnTYX6iPbMw==", "dev": true, "license": "MIT", @@ -1927,14 +1805,12 @@ }, "node_modules/argparse": { "version": "2.0.1", - "resolved": "https://registry.npmjs.org/argparse/-/argparse-2.0.1.tgz", "integrity": "sha512-8+9WqebbFzpX9OR+Wa6O29asIogeRMzcGtAINdpMHHyAg10f05aSFVBbcEqGf/PXw1EjAZ+q2/bEBg3DvurK3Q==", "dev": true, "license": "Python-2.0" }, "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", @@ -1944,14 +1820,12 @@ }, "node_modules/balanced-match": { "version": "1.0.2", - "resolved": "https://registry.npmjs.org/balanced-match/-/balanced-match-1.0.2.tgz", "integrity": "sha512-3oSeUO0TMV67hN1AmbXsK4yaqU7tjiHlbxRDZOpH0KW9+CeX4bRAaX0Anxt0tx2MrpRpWwQaPwIlISEJhYU5Pw==", "dev": true, "license": "MIT" }, "node_modules/base64-js": { "version": "1.5.1", - "resolved": "https://registry.npmjs.org/base64-js/-/base64-js-1.5.1.tgz", "integrity": "sha512-AKpaYlHn8t4SVbOHCy+b5+KKgvR4vrsD8vbvrbiQJps7fKDTkjkDry6ji0rUJjC0kzbNePLwzxq8iypo41qeWA==", "dev": true, "funding": [ @@ -1972,7 +1846,6 @@ }, "node_modules/brace-expansion": { "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", @@ -1983,14 +1856,12 @@ }, "node_modules/browser-or-node": { "version": "3.0.0", - "resolved": "https://registry.npmjs.org/browser-or-node/-/browser-or-node-3.0.0.tgz", "integrity": "sha512-iczIdVJzGEYhP5DqQxYM9Hh7Ztpqqi+CXZpSmX8ALFs9ecXkQIeqRyM6TfxEfMVpwhl3dSuDvxdzzo9sUOIVBQ==", "dev": true, "license": "MIT" }, "node_modules/buffer": { "version": "6.0.3", - "resolved": "https://registry.npmjs.org/buffer/-/buffer-6.0.3.tgz", "integrity": "sha512-FTiCpNxtwiZZHEZbcbTIcZjERVICn9yq/pDFkTl95/AxzD1naBctN7YO68riM/gLSDY7sdrMby8hofADYuuqOA==", "dev": true, "funding": [ @@ -2015,7 +1886,6 @@ }, "node_modules/callsites": { "version": "3.1.0", - "resolved": "https://registry.npmjs.org/callsites/-/callsites-3.1.0.tgz", "integrity": "sha512-P8BjAsXvZS+VIDUI11hHCQEv74YT67YUi5JJFNWIqL235sBmjX4+qx9Muvls5ivyNENctx46xQLQ3aTuE7ssaQ==", "dev": true, "license": "MIT", @@ -2025,7 +1895,6 @@ }, "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", @@ -2035,7 +1904,6 @@ }, "node_modules/chalk": { "version": "4.1.2", - "resolved": "https://registry.npmjs.org/chalk/-/chalk-4.1.2.tgz", "integrity": "sha512-oKnbhFyRIXpUuez8iBMmyEa4nbj4IOQyuhc/wy9kY7/WVPcwIO9VA668Pu8RkO7+0G76SLROeyw9CpQ061i4mA==", "dev": true, "license": "MIT", @@ -2052,7 +1920,6 @@ }, "node_modules/chalk/node_modules/ansi-styles": { "version": "4.3.0", - "resolved": "https://registry.npmjs.org/ansi-styles/-/ansi-styles-4.3.0.tgz", "integrity": "sha512-zbB9rCJAT1rbjiVDb2hqKFHNYLxgtk8NURxZ3IZwD3F6NtxbXZQCnnSi1Lkx+IDohdPlFp222wVALIheZJQSEg==", "dev": true, "license": "MIT", @@ -2068,14 +1935,12 @@ }, "node_modules/collection-utils": { "version": "1.0.1", - "resolved": "https://registry.npmjs.org/collection-utils/-/collection-utils-1.0.1.tgz", "integrity": "sha512-LA2YTIlR7biSpXkKYwwuzGjwL5rjWEZVOSnvdUc7gObvWe4WkjxOpfrdhoP7Hs09YWDVfg0Mal9BpAqLfVEzQg==", "dev": true, "license": "Apache-2.0" }, "node_modules/color-convert": { "version": "2.0.1", - "resolved": "https://registry.npmjs.org/color-convert/-/color-convert-2.0.1.tgz", "integrity": "sha512-RRECPsj7iu/xb5oKYcsFHSppFNnsj/52OVTRKb4zP5onXwVF3zVmmToNcOfGC+CRDpfK/U584fMg38ZHCaElKQ==", "dev": true, "license": "MIT", @@ -2088,28 +1953,24 @@ }, "node_modules/color-name": { "version": "1.1.4", - "resolved": "https://registry.npmjs.org/color-name/-/color-name-1.1.4.tgz", "integrity": "sha512-dOy+3AuW3a2wNbZHIuMZpTcgjGuLU/uBL/ubcZF9OXbDo8ff4O8yVp5Bf0efS8uEoYo5q4Fx7dY9OgQGXgAsQA==", "dev": true, "license": "MIT" }, "node_modules/concat-map": { "version": "0.0.1", - "resolved": "https://registry.npmjs.org/concat-map/-/concat-map-0.0.1.tgz", "integrity": "sha512-/Srv4dswyQNBfohGpz9o6Yb3Gz3SrUDqBH5rTuhGR7ahtlbYKnVxw2bCFMRljaA7EXHaXZ8wsHdodFvbkhKmqg==", "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", "integrity": "sha512-uKm5PU+MHTootlWEY+mZ4vvXoCn4fLQxT9dSc1sXVMSFkINTJVN8cAQROpwcKm8bJ/c7rgZVIBWzH5T78sNZZw==", "dev": true, "license": "MIT", @@ -2119,7 +1980,6 @@ }, "node_modules/cross-spawn": { "version": "7.0.6", - "resolved": "https://registry.npmjs.org/cross-spawn/-/cross-spawn-7.0.6.tgz", "integrity": "sha512-uV2QOWP2nWzsy2aMp8aRibhi9dlzF5Hgh5SHaB9OiTGEyDTiJJyx0uy51QXdyWbtAHNua4XJzUKca3OzKUd3vA==", "dev": true, "license": "MIT", @@ -2134,7 +1994,6 @@ }, "node_modules/debug": { "version": "4.4.3", - "resolved": "https://registry.npmjs.org/debug/-/debug-4.4.3.tgz", "integrity": "sha512-RGwwWnwQvkVfavKVt22FGLw+xYSdzARwm0ru6DhTVA3umU5hZc28V3kO4stgYryrTlLpuvgI9GiijltAjNbcqA==", "dev": true, "license": "MIT", @@ -2152,14 +2011,12 @@ }, "node_modules/deep-is": { "version": "0.1.4", - "resolved": "https://registry.npmjs.org/deep-is/-/deep-is-0.1.4.tgz", "integrity": "sha512-oIPzksmTg4/MriiaYGO+okXDT7ztn/w3Eptv/+gSIdMdKsJo0u4CfYNFJPy+4SKMuCqGw2wxnA+URMg3t8a/bQ==", "dev": true, "license": "MIT" }, "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==", "license": "Apache-2.0", "engines": { @@ -2168,14 +2025,12 @@ }, "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/esbuild": { "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, @@ -2217,7 +2072,6 @@ }, "node_modules/escape-string-regexp": { "version": "4.0.0", - "resolved": "https://registry.npmjs.org/escape-string-regexp/-/escape-string-regexp-4.0.0.tgz", "integrity": "sha512-TtpcNJ3XAzx3Gq8sWRzJaVajRs0uVxA2YAkdb1jm2YkPz4G6egUFAyA3n5vtEIZefPk5Wa4UXbKuS5fKkJWdgA==", "dev": true, "license": "MIT", @@ -2230,7 +2084,6 @@ }, "node_modules/eslint": { "version": "9.39.2", - "resolved": "https://registry.npmjs.org/eslint/-/eslint-9.39.2.tgz", "integrity": "sha512-LEyamqS7W5HB3ujJyvi0HQK/dtVINZvd5mAAp9eT5S/ujByGjiZLCzPcHVzuXbpJDJF/cxwHlfceVUDZ2lnSTw==", "dev": true, "license": "MIT", @@ -2290,7 +2143,6 @@ }, "node_modules/eslint-scope": { "version": "8.4.0", - "resolved": "https://registry.npmjs.org/eslint-scope/-/eslint-scope-8.4.0.tgz", "integrity": "sha512-sNXOfKCn74rt8RICKMvJS7XKV/Xk9kA7DyJr8mJik3S7Cwgy3qlkkmyS2uQB3jiJg6VNdZd/pDBJu0nvG2NlTg==", "dev": true, "license": "BSD-2-Clause", @@ -2307,7 +2159,6 @@ }, "node_modules/eslint-visitor-keys": { "version": "3.4.3", - "resolved": "https://registry.npmjs.org/eslint-visitor-keys/-/eslint-visitor-keys-3.4.3.tgz", "integrity": "sha512-wpc+LXeiyiisxPlEkUzU6svyS1frIO3Mgxj1fdy7Pm8Ygzguax2N3Fa/D/ag1WqbOprdI+uY6wMUl8/a2G+iag==", "dev": true, "license": "Apache-2.0", @@ -2320,7 +2171,6 @@ }, "node_modules/eslint/node_modules/eslint-visitor-keys": { "version": "4.2.1", - "resolved": "https://registry.npmjs.org/eslint-visitor-keys/-/eslint-visitor-keys-4.2.1.tgz", "integrity": "sha512-Uhdk5sfqcee/9H/rCOJikYz67o0a2Tw2hGRPOG2Y1R2dg7brRe1uG0yaNQDHu+TO/uQPF/5eCapvYSmHUjt7JQ==", "dev": true, "license": "Apache-2.0", @@ -2333,7 +2183,6 @@ }, "node_modules/eslint/node_modules/ignore": { "version": "5.3.2", - "resolved": "https://registry.npmjs.org/ignore/-/ignore-5.3.2.tgz", "integrity": "sha512-hsBTNUqQTDwkWtcdYI2i06Y/nUBEsNEDJKjWdigLvegy8kDuJAS8uRlpkkcQpyEXL0Z/pjDy5HBmMjRCJ2gq+g==", "dev": true, "license": "MIT", @@ -2343,7 +2192,6 @@ }, "node_modules/eslint/node_modules/minimatch": { "version": "3.1.5", - "resolved": "https://registry.npmjs.org/minimatch/-/minimatch-3.1.5.tgz", "integrity": "sha512-VgjWUsnnT6n+NUk6eZq77zeFdpW2LWDzP6zFGrCbHXiYNul5Dzqk2HHQ5uFH2DNW5Xbp8+jVzaeNt94ssEEl4w==", "dev": true, "license": "ISC", @@ -2356,7 +2204,6 @@ }, "node_modules/espree": { "version": "10.4.0", - "resolved": "https://registry.npmjs.org/espree/-/espree-10.4.0.tgz", "integrity": "sha512-j6PAQ2uUr79PZhBjP5C5fhl8e39FmRnOjsD5lGnWrFU8i2G776tBK7+nP8KuQUTTyAZUwfQqXAgrVH5MbH9CYQ==", "dev": true, "license": "BSD-2-Clause", @@ -2374,7 +2221,6 @@ }, "node_modules/espree/node_modules/eslint-visitor-keys": { "version": "4.2.1", - "resolved": "https://registry.npmjs.org/eslint-visitor-keys/-/eslint-visitor-keys-4.2.1.tgz", "integrity": "sha512-Uhdk5sfqcee/9H/rCOJikYz67o0a2Tw2hGRPOG2Y1R2dg7brRe1uG0yaNQDHu+TO/uQPF/5eCapvYSmHUjt7JQ==", "dev": true, "license": "Apache-2.0", @@ -2387,7 +2233,6 @@ }, "node_modules/esquery": { "version": "1.6.0", - "resolved": "https://registry.npmjs.org/esquery/-/esquery-1.6.0.tgz", "integrity": "sha512-ca9pw9fomFcKPvFLXhBKUK90ZvGibiGOvRJNbjljY7s7uq/5YO4BOzcYtJqExdx99rF6aAcnRxHmcUHcz6sQsg==", "dev": true, "license": "BSD-3-Clause", @@ -2400,7 +2245,6 @@ }, "node_modules/esrecurse": { "version": "4.3.0", - "resolved": "https://registry.npmjs.org/esrecurse/-/esrecurse-4.3.0.tgz", "integrity": "sha512-KmfKL3b6G+RXvP8N1vr3Tq1kL/oCFgn2NYXEtqP8/L3pKapUA4G8cFVaoF3SU323CD4XypR/ffioHmkti6/Tag==", "dev": true, "license": "BSD-2-Clause", @@ -2413,7 +2257,6 @@ }, "node_modules/estraverse": { "version": "5.3.0", - "resolved": "https://registry.npmjs.org/estraverse/-/estraverse-5.3.0.tgz", "integrity": "sha512-MMdARuVEQziNTeJD8DgMqmhwR11BRQ/cBP+pLtYdSTnf3MIO8fFeiINEbX36ZdNlfU/7A9f3gUw49B3oQsvwBA==", "dev": true, "license": "BSD-2-Clause", @@ -2423,7 +2266,6 @@ }, "node_modules/estree-walker": { "version": "3.0.3", - "resolved": "https://registry.npmjs.org/estree-walker/-/estree-walker-3.0.3.tgz", "integrity": "sha512-7RUKfXgSMMkzt6ZuXmqapOurLGPPfgj6l9uRZ7lRGolvk0y2yocc35LdcxKC5PQZdn2DMqioAQ2NoWcrTKmm6g==", "dev": true, "license": "MIT", @@ -2433,7 +2275,6 @@ }, "node_modules/esutils": { "version": "2.0.3", - "resolved": "https://registry.npmjs.org/esutils/-/esutils-2.0.3.tgz", "integrity": "sha512-kVscqXk4OCp68SZ0dkgEKVi6/8ij300KBWTJq32P/dYeWTSwK41WyTxalN1eRmA5Z9UU/LX9D7FWSmV9SAYx6g==", "dev": true, "license": "BSD-2-Clause", @@ -2443,7 +2284,6 @@ }, "node_modules/event-target-shim": { "version": "5.0.1", - "resolved": "https://registry.npmjs.org/event-target-shim/-/event-target-shim-5.0.1.tgz", "integrity": "sha512-i/2XbnSz/uxRCU6+NdVJgKWDTM427+MqYbkQzD321DuCQJUqOuJKIA0IM2+W2xtYHdKOmZ4dR6fExsd4SXL+WQ==", "dev": true, "license": "MIT", @@ -2453,7 +2293,6 @@ }, "node_modules/events": { "version": "3.3.0", - "resolved": "https://registry.npmjs.org/events/-/events-3.3.0.tgz", "integrity": "sha512-mQw+2fkQbALzQ7V0MY0IqdnXNOeTtP4r0lN9z7AAawCXgqea7bDii20AYrIBrFd/Hx0M2Ocz6S111CaFkUcb0Q==", "dev": true, "license": "MIT", @@ -2463,7 +2302,6 @@ }, "node_modules/expect-type": { "version": "1.3.0", - "resolved": "https://registry.npmjs.org/expect-type/-/expect-type-1.3.0.tgz", "integrity": "sha512-knvyeauYhqjOYvQ66MznSMs83wmHrCycNEN6Ao+2AeYEfxUIkuiVxdEa1qlGEPK+We3n0THiDciYSsCcgW/DoA==", "dev": true, "license": "Apache-2.0", @@ -2473,28 +2311,24 @@ }, "node_modules/fast-deep-equal": { "version": "3.1.3", - "resolved": "https://registry.npmjs.org/fast-deep-equal/-/fast-deep-equal-3.1.3.tgz", "integrity": "sha512-f3qQ9oQy9j2AhBe/H9VC91wLmKBCCU/gDOnKNAYG5hswO7BLKj09Hc5HYNz9cGI++xlpDCIgDaitVs03ATR84Q==", "dev": true, "license": "MIT" }, "node_modules/fast-json-stable-stringify": { "version": "2.1.0", - "resolved": "https://registry.npmjs.org/fast-json-stable-stringify/-/fast-json-stable-stringify-2.1.0.tgz", "integrity": "sha512-lhd/wF+Lk98HZoTCtlVraHtfh5XYijIjalXck7saUtuanSDyLMxnHhSXEDJqHxD7msR8D0uCmqlkwjCV8xvwHw==", "dev": true, "license": "MIT" }, "node_modules/fast-levenshtein": { "version": "2.0.6", - "resolved": "https://registry.npmjs.org/fast-levenshtein/-/fast-levenshtein-2.0.6.tgz", "integrity": "sha512-DCXu6Ifhqcks7TZKY3Hxp3y6qphY5SJZmrWMDrKcERSOXWQdMhU9Ig/PYrzyw/ul9jOIyh0N4M0tbC5hodg8dw==", "dev": true, "license": "MIT" }, "node_modules/fdir": { "version": "6.5.0", - "resolved": "https://registry.npmjs.org/fdir/-/fdir-6.5.0.tgz", "integrity": "sha512-tIbYtZbucOs0BRGqPJkshJUYdL+SDH7dVM8gjy+ERp3WAUjLEFJE+02kanyHtwjWOnwrKYBiwAmM0p4kLJAnXg==", "dev": true, "license": "MIT", @@ -2512,7 +2346,6 @@ }, "node_modules/file-entry-cache": { "version": "8.0.0", - "resolved": "https://registry.npmjs.org/file-entry-cache/-/file-entry-cache-8.0.0.tgz", "integrity": "sha512-XXTUwCvisa5oacNGRP9SfNtYBNAMi+RPwBFmblZEF7N7swHYQS6/Zfk7SRwx4D5j3CH211YNRco1DEMNVfZCnQ==", "dev": true, "license": "MIT", @@ -2525,7 +2358,6 @@ }, "node_modules/find-up": { "version": "5.0.0", - "resolved": "https://registry.npmjs.org/find-up/-/find-up-5.0.0.tgz", "integrity": "sha512-78/PXT1wlLLDgTzDs7sjq9hzz0vXD+zn+7wypEe4fXQxCmdmqfGsEPQxmiCSQI3ajFV91bVSsvNtrJRiW6nGng==", "dev": true, "license": "MIT", @@ -2542,7 +2374,6 @@ }, "node_modules/flat-cache": { "version": "4.0.1", - "resolved": "https://registry.npmjs.org/flat-cache/-/flat-cache-4.0.1.tgz", "integrity": "sha512-f7ccFPK3SXFHpx15UIGyRJ/FJQctuKZ0zVuN3frBo4HnK3cay9VEW0R6yPYFHC0AgqhukPzKjq22t5DmAyqGyw==", "dev": true, "license": "MIT", @@ -2556,14 +2387,12 @@ }, "node_modules/flatted": { "version": "3.4.2", - "resolved": "https://registry.npmjs.org/flatted/-/flatted-3.4.2.tgz", "integrity": "sha512-PjDse7RzhcPkIJwy5t7KPWQSZ9cAbzQXcafsetQoD7sOJRQlGikNbx7yZp2OotDnJyrDcbyRq3Ttb18iYOqkxA==", "dev": true, "license": "ISC" }, "node_modules/fsevents": { "version": "2.3.3", - "resolved": "https://registry.npmjs.org/fsevents/-/fsevents-2.3.3.tgz", "integrity": "sha512-5xoDfX+fL7faATnagmWPpbFtwh/R77WmMMqqHGS65C3vvB0YHrgF+B1YmZ3441tMj5n63k0212XNoJwzlhffQw==", "dev": true, "hasInstallScript": true, @@ -2578,7 +2407,6 @@ }, "node_modules/glob": { "version": "13.0.6", - "resolved": "https://registry.npmjs.org/glob/-/glob-13.0.6.tgz", "integrity": "sha512-Wjlyrolmm8uDpm/ogGyXZXb1Z+Ca2B8NbJwqBVg0axK9GbBeoS7yGV6vjXnYdGm6X53iehEuxxbyiKp8QmN4Vw==", "dev": true, "license": "BlueOak-1.0.0", @@ -2596,7 +2424,6 @@ }, "node_modules/glob-parent": { "version": "6.0.2", - "resolved": "https://registry.npmjs.org/glob-parent/-/glob-parent-6.0.2.tgz", "integrity": "sha512-XxwI8EOhVQgWp6iDL+3b0r86f4d6AX6zSU55HfB4ydCEuXLXc5FcYeOu+nnGftS4TEju/11rt4KJPTMgbfmv4A==", "dev": true, "license": "ISC", @@ -2609,7 +2436,6 @@ }, "node_modules/globals": { "version": "14.0.0", - "resolved": "https://registry.npmjs.org/globals/-/globals-14.0.0.tgz", "integrity": "sha512-oahGvuMGQlPw/ivIYBjVSrWAfWLBeku5tpPE2fOPLi+WHffIWbuh2tCjhyQhTBPMf5E9jDEH4FOmTYgYwbKwtQ==", "dev": true, "license": "MIT", @@ -2622,7 +2448,6 @@ }, "node_modules/has-flag": { "version": "4.0.0", - "resolved": "https://registry.npmjs.org/has-flag/-/has-flag-4.0.0.tgz", "integrity": "sha512-EykJT/Q1KjTWctppgIAgfSO0tKVuZUjhgMr17kqTumMl6Afv3EISleU7qZUzoXDFTAHTDC4NOoG/ZxU3EvlMPQ==", "dev": true, "license": "MIT", @@ -2632,7 +2457,6 @@ }, "node_modules/ieee754": { "version": "1.2.1", - "resolved": "https://registry.npmjs.org/ieee754/-/ieee754-1.2.1.tgz", "integrity": "sha512-dcyqhDvX1C46lXZcVqCpK+FtMRQVdIMN6/Df5js2zouUsqG7I6sFxitIC+7KYK29KdXOLHdu9zL4sFnoVQnqaA==", "dev": true, "funding": [ @@ -2653,7 +2477,6 @@ }, "node_modules/ignore": { "version": "7.0.5", - "resolved": "https://registry.npmjs.org/ignore/-/ignore-7.0.5.tgz", "integrity": "sha512-Hs59xBNfUIunMFgWAbGX5cq6893IbWg4KnrjbYwX3tx0ztorVgTDA6B2sxf8ejHJ4wz8BqGUMYlnzNBer5NvGg==", "dev": true, "license": "MIT", @@ -2663,7 +2486,6 @@ }, "node_modules/import-fresh": { "version": "3.3.1", - "resolved": "https://registry.npmjs.org/import-fresh/-/import-fresh-3.3.1.tgz", "integrity": "sha512-TR3KfrTZTYLPB6jUjfx6MF9WcWrHL9su5TObK4ZkYgBdWKPOFoSoQIdEuTuR82pmtxH2spWG9h6etwfr1pLBqQ==", "dev": true, "license": "MIT", @@ -2680,7 +2502,6 @@ }, "node_modules/imurmurhash": { "version": "0.1.4", - "resolved": "https://registry.npmjs.org/imurmurhash/-/imurmurhash-0.1.4.tgz", "integrity": "sha512-JmXMZ6wuvDmLiHEml9ykzqO6lwFbof0GG4IkcGaENdCRDDmMVnny7s5HsIgHCbaq0w2MyPhDqkhTUgS2LU2PHA==", "dev": true, "license": "MIT", @@ -2690,7 +2511,6 @@ }, "node_modules/is-extglob": { "version": "2.1.1", - "resolved": "https://registry.npmjs.org/is-extglob/-/is-extglob-2.1.1.tgz", "integrity": "sha512-SbKbANkN603Vi4jEZv49LeVJMn4yGwsbzZworEoyEiutsN3nJYdbO36zfhGJ6QEDpOZIFkDtnq5JRxmvl3jsoQ==", "dev": true, "license": "MIT", @@ -2700,7 +2520,6 @@ }, "node_modules/is-glob": { "version": "4.0.3", - "resolved": "https://registry.npmjs.org/is-glob/-/is-glob-4.0.3.tgz", "integrity": "sha512-xelSayHH36ZgE7ZWhli7pW34hNbNl8Ojv5KVmkJD4hBdD3th8Tfk9vYasLM+mXWOZhFkgZfxhLSnrwRr4elSSg==", "dev": true, "license": "MIT", @@ -2713,28 +2532,24 @@ }, "node_modules/is-url": { "version": "1.2.4", - "resolved": "https://registry.npmjs.org/is-url/-/is-url-1.2.4.tgz", "integrity": "sha512-ITvGim8FhRiYe4IQ5uHSkj7pVaPDrCTkNd3yq3cV7iZAcJdHTUMPMEHcqSOy9xZ9qFenQCvi+2wjH9a1nXqHww==", "dev": true, "license": "MIT" }, "node_modules/isexe": { "version": "2.0.0", - "resolved": "https://registry.npmjs.org/isexe/-/isexe-2.0.0.tgz", "integrity": "sha512-RHxMLp9lnKHGHRng9QFhRCMbYAcVpn69smSGcq3f36xjgVVWThj4qqLbTLlq7Ssj8B+fIQ1EuCEGI2lKsyQeIw==", "dev": true, "license": "ISC" }, "node_modules/js-base64": { "version": "3.7.8", - "resolved": "https://registry.npmjs.org/js-base64/-/js-base64-3.7.8.tgz", "integrity": "sha512-hNngCeKxIUQiEUN3GPJOkz4wF/YvdUdbNL9hsBcMQTkKzboD7T/q3OYOuuPZLUE6dBxSGpwhk5mwuDud7JVAow==", "dev": true, "license": "BSD-3-Clause" }, "node_modules/js-yaml": { "version": "4.2.0", - "resolved": "https://registry.npmjs.org/js-yaml/-/js-yaml-4.2.0.tgz", "integrity": "sha512-ePWsvanv0DWuDRsW8dnt+R4jQ31SCRCQ7hhNcPXZPsoBZiemuZNYGf7adZdqX2D86j6rvKp3RpCxVTSb8WQlOw==", "dev": true, "funding": [ @@ -2757,21 +2572,18 @@ }, "node_modules/json-buffer": { "version": "3.0.1", - "resolved": "https://registry.npmjs.org/json-buffer/-/json-buffer-3.0.1.tgz", "integrity": "sha512-4bV5BfR2mqfQTJm+V5tPPdf+ZpuhiIvTuAB5g8kcrXOZpTT/QwwVRWBywX1ozr6lEuPdbHxwaJlm9G6mI2sfSQ==", "dev": true, "license": "MIT" }, "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==", "dev": true, "license": "(AFL-2.1 OR BSD-3-Clause)" }, "node_modules/json-schema-to-typescript": { "version": "15.0.4", - "resolved": "https://registry.npmjs.org/json-schema-to-typescript/-/json-schema-to-typescript-15.0.4.tgz", "integrity": "sha512-Su9oK8DR4xCmDsLlyvadkXzX6+GGXJpbhwoLtOGArAG61dvbW4YQmSEno2y66ahpIdmLMg6YUf/QHLgiwvkrHQ==", "dev": true, "license": "MIT", @@ -2795,21 +2607,18 @@ }, "node_modules/json-schema-traverse": { "version": "0.4.1", - "resolved": "https://registry.npmjs.org/json-schema-traverse/-/json-schema-traverse-0.4.1.tgz", "integrity": "sha512-xbbCH5dCYU5T8LcEhhuh7HJ88HXuW3qsI3Y0zOZFKfZEHcpWiHU/Jxzk629Brsab/mMiHQti9wMP+845RPe3Vg==", "dev": true, "license": "MIT" }, "node_modules/json-stable-stringify-without-jsonify": { "version": "1.0.1", - "resolved": "https://registry.npmjs.org/json-stable-stringify-without-jsonify/-/json-stable-stringify-without-jsonify-1.0.1.tgz", "integrity": "sha512-Bdboy+l7tA3OGW6FjyFHWkP5LuByj1Tk33Ljyq0axyzdk9//JSi2u3fP1QSmd1KNwq6VOKYGlAu87CisVir6Pw==", "dev": true, "license": "MIT" }, "node_modules/keyv": { "version": "4.5.4", - "resolved": "https://registry.npmjs.org/keyv/-/keyv-4.5.4.tgz", "integrity": "sha512-oxVHkHR/EJf2CNXnWxRLW6mg7JyCCUcG0DtEGmL2ctUo1PNTin1PUil+r/+4r5MpVgC/fn1kjsx7mjSujKqIpw==", "dev": true, "license": "MIT", @@ -2819,7 +2628,6 @@ }, "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", @@ -2845,7 +2653,6 @@ }, "node_modules/levn": { "version": "0.4.1", - "resolved": "https://registry.npmjs.org/levn/-/levn-0.4.1.tgz", "integrity": "sha512-+bT2uH4E5LGE7h/n3evcS/sQlJXCpIp6ym8OWJ5eV6+67Dsql/LaaT7qJBAt2rzfoa/5QBGBhxDix1dMt2kQKQ==", "dev": true, "license": "MIT", @@ -2859,7 +2666,6 @@ }, "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", @@ -2889,7 +2695,6 @@ }, "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" @@ -2910,7 +2715,6 @@ }, "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" @@ -2931,7 +2735,6 @@ }, "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" @@ -2952,7 +2755,6 @@ }, "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" @@ -2973,7 +2775,6 @@ }, "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" @@ -2994,7 +2795,6 @@ }, "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" @@ -3015,7 +2815,6 @@ }, "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" @@ -3036,7 +2835,6 @@ }, "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" @@ -3057,7 +2855,6 @@ }, "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" @@ -3078,7 +2875,6 @@ }, "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" @@ -3099,7 +2895,6 @@ }, "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" @@ -3120,7 +2915,6 @@ }, "node_modules/locate-path": { "version": "6.0.0", - "resolved": "https://registry.npmjs.org/locate-path/-/locate-path-6.0.0.tgz", "integrity": "sha512-iPZK6eYjbxRu3uB4/WZ3EsEIMJFMqAoopl3R+zuq0UjcAm/MO6KCweDgPfP3elTztoKP3KtnVHxTn2NHBSDVUw==", "dev": true, "license": "MIT", @@ -3136,21 +2930,18 @@ }, "node_modules/lodash": { "version": "4.18.1", - "resolved": "https://registry.npmjs.org/lodash/-/lodash-4.18.1.tgz", "integrity": "sha512-dMInicTPVE8d1e5otfwmmjlxkZoUpiVLwyeTdUsi/Caj/gfzzblBcCE5sRHV/AsjuCmxWrte2TNGSYuCeCq+0Q==", "dev": true, "license": "MIT" }, "node_modules/lodash.merge": { "version": "4.6.2", - "resolved": "https://registry.npmjs.org/lodash.merge/-/lodash.merge-4.6.2.tgz", "integrity": "sha512-0KpjqXRVvrYyCsX1swR/XTK0va6VQkQM6MNo7PqW77ByjAhoARA8EfrP1N4+KlKj8YS0ZUCtRT/YUuhyYDujIQ==", "dev": true, "license": "MIT" }, "node_modules/lru-cache": { "version": "11.2.6", - "resolved": "https://registry.npmjs.org/lru-cache/-/lru-cache-11.2.6.tgz", "integrity": "sha512-ESL2CrkS/2wTPfuend7Zhkzo2u0daGJ/A2VucJOgQ/C48S/zB8MMeMHSGKYpXhIjbPxfuezITkaBH1wqv00DDQ==", "dev": true, "license": "BlueOak-1.0.0", @@ -3160,7 +2951,6 @@ }, "node_modules/magic-string": { "version": "0.30.21", - "resolved": "https://registry.npmjs.org/magic-string/-/magic-string-0.30.21.tgz", "integrity": "sha512-vd2F4YUyEXKGcLHoq+TEyCjxueSeHnFxyyjNp80yg0XV4vUhnDer/lvvlqM/arB5bXQN5K2/3oinyCRyx8T2CQ==", "dev": true, "license": "MIT", @@ -3170,7 +2960,6 @@ }, "node_modules/minimatch": { "version": "10.2.4", - "resolved": "https://registry.npmjs.org/minimatch/-/minimatch-10.2.4.tgz", "integrity": "sha512-oRjTw/97aTBN0RHbYCdtF1MQfvusSIBQM0IZEgzl6426+8jSC0nF1a/GmnVLpfB9yyr6g6FTqWqiZVbxrtaCIg==", "dev": true, "license": "BlueOak-1.0.0", @@ -3186,7 +2975,6 @@ }, "node_modules/minimatch/node_modules/balanced-match": { "version": "4.0.4", - "resolved": "https://registry.npmjs.org/balanced-match/-/balanced-match-4.0.4.tgz", "integrity": "sha512-BLrgEcRTwX2o6gGxGOCNyMvGSp35YofuYzw9h1IMTRmKqttAZZVU67bdb9Pr2vUHA8+j3i2tJfjO6C6+4myGTA==", "dev": true, "license": "MIT", @@ -3196,7 +2984,6 @@ }, "node_modules/minimatch/node_modules/brace-expansion": { "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", @@ -3209,7 +2996,6 @@ }, "node_modules/minimist": { "version": "1.2.8", - "resolved": "https://registry.npmjs.org/minimist/-/minimist-1.2.8.tgz", "integrity": "sha512-2yyAR8qBkN3YuheJanUpWC5U3bb5osDywNB8RzDVlDwDHbocAJveqqj1u8+SVD7jkWT4yvsHCpWqqWqAxb0zCA==", "dev": true, "license": "MIT", @@ -3219,7 +3005,6 @@ }, "node_modules/minipass": { "version": "7.1.3", - "resolved": "https://registry.npmjs.org/minipass/-/minipass-7.1.3.tgz", "integrity": "sha512-tEBHqDnIoM/1rXME1zgka9g6Q2lcoCkxHLuc7ODJ5BxbP5d4c2Z5cGgtXAku59200Cx7diuHTOYfSBD8n6mm8A==", "dev": true, "license": "BlueOak-1.0.0", @@ -3229,15 +3014,13 @@ }, "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.12", - "resolved": "https://registry.npmjs.org/nanoid/-/nanoid-3.3.12.tgz", - "integrity": "sha512-ZB9RH/39qpq5Vu6Y+NmUaFhQR6pp+M2Xt76XBnEwDaGcVAqhlvxrl3B2bKS5D3NH3QR76v3aSrKaF/Kiy7lEtQ==", + "version": "3.3.17", + "integrity": "sha512-xQLf0A3HOMlgHq0n247/LRuAOYmB7dXJ/DvAxGvsSBij45XtBSmQycu+F8ODbHwns/XyFZagyL1+J0Offw1E0g==", "dev": true, "funding": [ { @@ -3255,14 +3038,12 @@ }, "node_modules/natural-compare": { "version": "1.4.0", - "resolved": "https://registry.npmjs.org/natural-compare/-/natural-compare-1.4.0.tgz", "integrity": "sha512-OWND8ei3VtNC9h7V60qff3SVobHr996CTwgxubgyQYEpg290h9J0buyECNNJexkFm5sOajh5G116RYA1c8ZMSw==", "dev": true, "license": "MIT" }, "node_modules/node-fetch": { "version": "2.7.0", - "resolved": "https://registry.npmjs.org/node-fetch/-/node-fetch-2.7.0.tgz", "integrity": "sha512-c4FRfUm/dbcWZ7U+1Wq0AwCyFL+3nt2bEw05wfxSz+DWpWsitgmSgYmy2dQdWyKC1694ELPqMs/YzUSNozLt8A==", "dev": true, "license": "MIT", @@ -3283,7 +3064,6 @@ }, "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": [ @@ -3294,7 +3074,6 @@ }, "node_modules/optionator": { "version": "0.9.4", - "resolved": "https://registry.npmjs.org/optionator/-/optionator-0.9.4.tgz", "integrity": "sha512-6IpQ7mKUxRcZNLIObR0hz7lxsapSSIYNZJwXPGeF0mTVqGKFIXj1DQcMoT22S3ROcLyY/rz0PWaWZ9ayWmad9g==", "dev": true, "license": "MIT", @@ -3312,7 +3091,6 @@ }, "node_modules/p-limit": { "version": "3.1.0", - "resolved": "https://registry.npmjs.org/p-limit/-/p-limit-3.1.0.tgz", "integrity": "sha512-TYOanM3wGwNGsZN2cVTYPArw454xnXj5qmWF1bEoAc4+cU/ol7GVh7odevjp1FNHduHc3KZMcFduxU5Xc6uJRQ==", "dev": true, "license": "MIT", @@ -3328,7 +3106,6 @@ }, "node_modules/p-locate": { "version": "5.0.0", - "resolved": "https://registry.npmjs.org/p-locate/-/p-locate-5.0.0.tgz", "integrity": "sha512-LaNjtRWUBY++zB5nE/NwcaoMylSPk+S+ZHNB1TzdbMJMny6dynpAGt7X/tl/QYq3TIeE6nxHppbo2LGymrG5Pw==", "dev": true, "license": "MIT", @@ -3344,21 +3121,18 @@ }, "node_modules/package-json-from-dist": { "version": "1.0.1", - "resolved": "https://registry.npmjs.org/package-json-from-dist/-/package-json-from-dist-1.0.1.tgz", "integrity": "sha512-UEZIS3/by4OC8vL3P2dTXRETpebLI2NiI5vIrjaD/5UtrkFX/tNbwjTSRAGC/+7CAo2pIcBaRgWmcBBHcsaCIw==", "dev": true, "license": "BlueOak-1.0.0" }, "node_modules/pako": { "version": "1.0.11", - "resolved": "https://registry.npmjs.org/pako/-/pako-1.0.11.tgz", "integrity": "sha512-4hLB8Py4zZce5s4yd9XzopqwVv/yGNhV1Bl8NTmCq1763HeK2+EwVTv+leGeL13Dnh2wfbqowVPXCIO0z4taYw==", "dev": true, "license": "(MIT AND Zlib)" }, "node_modules/parent-module": { "version": "1.0.1", - "resolved": "https://registry.npmjs.org/parent-module/-/parent-module-1.0.1.tgz", "integrity": "sha512-GQ2EWRpQV8/o+Aw8YqtfZZPfNRWZYkbidE9k5rpl/hC3vtHHBfGm2Ifi6qWV+coDGkrUKZAxE3Lot5kcsRlh+g==", "dev": true, "license": "MIT", @@ -3371,7 +3145,6 @@ }, "node_modules/path-exists": { "version": "4.0.0", - "resolved": "https://registry.npmjs.org/path-exists/-/path-exists-4.0.0.tgz", "integrity": "sha512-ak9Qy5Q7jYb2Wwcey5Fpvg2KoAc/ZIhLSLOSBmRmygPsGwkVVt0fZa0qrtMz+m6tJTAHfZQ8FnmB4MG4LWy7/w==", "dev": true, "license": "MIT", @@ -3381,7 +3154,6 @@ }, "node_modules/path-key": { "version": "3.1.1", - "resolved": "https://registry.npmjs.org/path-key/-/path-key-3.1.1.tgz", "integrity": "sha512-ojmeN0qd+y0jszEtoY48r0Peq5dwMEkIlCOu6Q5f41lfkswXuKtYrhgoTpLnyIcHm24Uhqx+5Tqm2InSwLhE6Q==", "dev": true, "license": "MIT", @@ -3391,7 +3163,6 @@ }, "node_modules/path-scurry": { "version": "2.0.2", - "resolved": "https://registry.npmjs.org/path-scurry/-/path-scurry-2.0.2.tgz", "integrity": "sha512-3O/iVVsJAPsOnpwWIeD+d6z/7PmqApyQePUtCndjatj/9I5LylHvt5qluFaBT3I5h3r1ejfR056c+FCv+NnNXg==", "dev": true, "license": "BlueOak-1.0.0", @@ -3408,21 +3179,18 @@ }, "node_modules/pathe": { "version": "2.0.3", - "resolved": "https://registry.npmjs.org/pathe/-/pathe-2.0.3.tgz", "integrity": "sha512-WUjGcAqP1gQacoQe+OBJsFA7Ld4DyXuUIjZ5cc75cLHvJ7dtNsTugphxIADwspS+AraAUePCKrSVtPLFj/F88w==", "dev": true, "license": "MIT" }, "node_modules/picocolors": { "version": "1.1.1", - "resolved": "https://registry.npmjs.org/picocolors/-/picocolors-1.1.1.tgz", "integrity": "sha512-xceH2snhtb5M9liqDsmEw56le376mTZkEX/jEb/RxNFyegNul7eNslCXP9FDj/Lcu0X8KEyMceP2ntpaHrDEVA==", "dev": true, "license": "ISC" }, "node_modules/picomatch": { "version": "4.0.4", - "resolved": "https://registry.npmjs.org/picomatch/-/picomatch-4.0.4.tgz", "integrity": "sha512-QP88BAKvMam/3NxH6vj2o21R6MjxZUAd6nlwAS/pnGvN9IVLocLHxGYIzFhg6fUQ+5th6P4dv4eW9jX3DSIj7A==", "dev": true, "license": "MIT", @@ -3435,7 +3203,6 @@ }, "node_modules/pluralize": { "version": "8.0.0", - "resolved": "https://registry.npmjs.org/pluralize/-/pluralize-8.0.0.tgz", "integrity": "sha512-Nc3IT5yHzflTfbjgqWcCPpo7DaKy4FnpB0l/zCAW0Tc7jxAiuqSxHasntB3D7887LSrA93kDJ9IXovxJYxyLCA==", "dev": true, "license": "MIT", @@ -3444,9 +3211,8 @@ } }, "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", + "integrity": "sha512-DTPx3RWSSnWyzLxQnlH0rJP+EW5ekl16ZU4/psbIhA0e53kJfdgaN5vKM+xP7yJtXVu+nfdVFmlgFDEKAe4Pyw==", "dev": true, "funding": [ { @@ -3464,7 +3230,7 @@ ], "license": "MIT", "dependencies": { - "nanoid": "^3.3.12", + "nanoid": "^3.3.16", "picocolors": "^1.1.1", "source-map-js": "^1.2.1" }, @@ -3474,7 +3240,6 @@ }, "node_modules/prelude-ls": { "version": "1.2.1", - "resolved": "https://registry.npmjs.org/prelude-ls/-/prelude-ls-1.2.1.tgz", "integrity": "sha512-vkcDPrRZo1QZLbn5RLGPpg/WmIQ65qoWWhcGKf/b5eplkkarX0m9z8ppCat4mlOqUsWpyNuYgO3VRyrYHSzX5g==", "dev": true, "license": "MIT", @@ -3484,7 +3249,6 @@ }, "node_modules/prettier": { "version": "3.8.1", - "resolved": "https://registry.npmjs.org/prettier/-/prettier-3.8.1.tgz", "integrity": "sha512-UOnG6LftzbdaHZcKoPFtOcCKztrQ57WkHDeRD9t/PTQtmT0NHSeWWepj6pS0z/N7+08BHFDQVUrfmfMRcZwbMg==", "dev": true, "license": "MIT", @@ -3500,7 +3264,6 @@ }, "node_modules/process": { "version": "0.11.10", - "resolved": "https://registry.npmjs.org/process/-/process-0.11.10.tgz", "integrity": "sha512-cdGef/drWFoydD1JsMzuFf8100nZl+GT+yacc2bEced5f9Rjk4z+WtFUTBu9PhOi9j/jfmBPu0mMEY4wIdAF8A==", "dev": true, "license": "MIT", @@ -3510,7 +3273,6 @@ }, "node_modules/punycode": { "version": "2.3.1", - "resolved": "https://registry.npmjs.org/punycode/-/punycode-2.3.1.tgz", "integrity": "sha512-vYt7UD1U9Wg6138shLtLOvdAu+8DsC/ilFtEVHcH+wydcSpNE20AfSOduf6MkRFahL5FY7X1oU7nKVZFtfq8Fg==", "dev": true, "license": "MIT", @@ -3520,7 +3282,6 @@ }, "node_modules/quicktype-core": { "version": "23.2.6", - "resolved": "https://registry.npmjs.org/quicktype-core/-/quicktype-core-23.2.6.tgz", "integrity": "sha512-asfeSv7BKBNVb9WiYhFRBvBZHcRutPRBwJMxW0pefluK4kkKu4lv0IvZBwFKvw2XygLcL1Rl90zxWDHYgkwCmA==", "dev": true, "license": "Apache-2.0", @@ -3543,7 +3304,6 @@ }, "node_modules/readable-stream": { "version": "4.5.2", - "resolved": "https://registry.npmjs.org/readable-stream/-/readable-stream-4.5.2.tgz", "integrity": "sha512-yjavECdqeZ3GLXNgRXgeQEdz9fvDDkNKyHnbHRFtOr7/LcfgBcmct7t/ET+HaCTqfh06OzoAxrkN/IfjJBVe+g==", "dev": true, "license": "MIT", @@ -3560,7 +3320,6 @@ }, "node_modules/resolve-from": { "version": "4.0.0", - "resolved": "https://registry.npmjs.org/resolve-from/-/resolve-from-4.0.0.tgz", "integrity": "sha512-pb/MYmXstAkysRFx8piNI1tGFNQIFA3vkE3Gq4EuA1dF6gHp/+vgZqsCGJapvy8N3Q+4o7FwvquPJcnZ7RYy4g==", "dev": true, "license": "MIT", @@ -3570,7 +3329,6 @@ }, "node_modules/rimraf": { "version": "6.1.3", - "resolved": "https://registry.npmjs.org/rimraf/-/rimraf-6.1.3.tgz", "integrity": "sha512-LKg+Cr2ZF61fkcaK1UdkH2yEBBKnYjTyWzTJT6KNPcSPaiT7HSdhtMXQuN5wkTX0Xu72KQ1l8S42rlmexS2hSA==", "dev": true, "license": "BlueOak-1.0.0", @@ -3590,7 +3348,6 @@ }, "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", @@ -3624,7 +3381,6 @@ }, "node_modules/safe-buffer": { "version": "5.2.1", - "resolved": "https://registry.npmjs.org/safe-buffer/-/safe-buffer-5.2.1.tgz", "integrity": "sha512-rp3So07KcdmmKbGvgaNxQSJr7bGVSVk5S9Eq1F+ppbRo70+YeaDxkw5Dd8NPN+GD6bjnYm2VuPuCXmpuYvmCXQ==", "dev": true, "funding": [ @@ -3645,7 +3401,6 @@ }, "node_modules/semver": { "version": "7.7.3", - "resolved": "https://registry.npmjs.org/semver/-/semver-7.7.3.tgz", "integrity": "sha512-SdsKMrI9TdgjdweUSR9MweHA4EJ8YxHn8DFaDisvhVlUOe4BF1tLD7GAj0lIqWVl+dPb/rExr0Btby5loQm20Q==", "dev": true, "license": "ISC", @@ -3658,7 +3413,6 @@ }, "node_modules/shebang-command": { "version": "2.0.0", - "resolved": "https://registry.npmjs.org/shebang-command/-/shebang-command-2.0.0.tgz", "integrity": "sha512-kHxr2zZpYtdmrN1qDjrrX/Z1rR1kG8Dx+gkpK1G4eXmvXswmcE1hTWBWYUzlraYw1/yZp6YuDY77YtvbN0dmDA==", "dev": true, "license": "MIT", @@ -3671,7 +3425,6 @@ }, "node_modules/shebang-regex": { "version": "3.0.0", - "resolved": "https://registry.npmjs.org/shebang-regex/-/shebang-regex-3.0.0.tgz", "integrity": "sha512-7++dFhtcx3353uBaq8DDR4NuxBetBzC7ZQOhmTQInHEd6bSrXdiEyzCvG07Z44UYdLShWUyXt5M/yhz8ekcb1A==", "dev": true, "license": "MIT", @@ -3681,14 +3434,12 @@ }, "node_modules/siginfo": { "version": "2.0.0", - "resolved": "https://registry.npmjs.org/siginfo/-/siginfo-2.0.0.tgz", "integrity": "sha512-ybx0WO1/8bSBLEWXZvEd7gMW3Sn3JFlW3TvX1nREbDLRNQNaeNN8WK0meBwPdAaOI7TtRRRJn/Es1zhrrCHu7g==", "dev": true, "license": "ISC" }, "node_modules/source-map-js": { "version": "1.2.1", - "resolved": "https://registry.npmjs.org/source-map-js/-/source-map-js-1.2.1.tgz", "integrity": "sha512-UXWMKhLOwVKb728IUtQPXxfYU+usdybtUrK/8uGE8CQMvrhOpwvzDBwj0QhSL7MQc7vIsISBG8VQ8+IDQxpfQA==", "dev": true, "license": "BSD-3-Clause", @@ -3698,21 +3449,18 @@ }, "node_modules/stackback": { "version": "0.0.2", - "resolved": "https://registry.npmjs.org/stackback/-/stackback-0.0.2.tgz", "integrity": "sha512-1XMJE5fQo1jGH6Y/7ebnwPOBEkIEnT4QF32d5R1+VXdXveM0IBMJt8zfaxX1P3QhVwrYe+576+jkANtSS2mBbw==", "dev": true, "license": "MIT" }, "node_modules/std-env": { "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/string_decoder": { "version": "1.3.0", - "resolved": "https://registry.npmjs.org/string_decoder/-/string_decoder-1.3.0.tgz", "integrity": "sha512-hkRX8U1WjJFd8LsDJ2yQ/wWWxaopEsABU1XfkM8A+j0+85JAGppt16cr1Whg6KIbb4okU6Mql6BOj+uup/wKeA==", "dev": true, "license": "MIT", @@ -3722,7 +3470,6 @@ }, "node_modules/strip-json-comments": { "version": "3.1.1", - "resolved": "https://registry.npmjs.org/strip-json-comments/-/strip-json-comments-3.1.1.tgz", "integrity": "sha512-6fPc+R4ihwqP6N/aIv2f1gMH8lOVtWQHoqC4yK6oSDVVocumAsfCqjkXnqiYMhmMwS/mEHLp7Vehlt3ql6lEig==", "dev": true, "license": "MIT", @@ -3735,7 +3482,6 @@ }, "node_modules/supports-color": { "version": "7.2.0", - "resolved": "https://registry.npmjs.org/supports-color/-/supports-color-7.2.0.tgz", "integrity": "sha512-qpCAvRl9stuOHveKsn7HncJRvv501qIacKzQlO/+Lwxc9+0q2wLyv4Dfvt80/DPn2pqOBsJdDiogXGR9+OvwRw==", "dev": true, "license": "MIT", @@ -3748,21 +3494,18 @@ }, "node_modules/tiny-inflate": { "version": "1.0.3", - "resolved": "https://registry.npmjs.org/tiny-inflate/-/tiny-inflate-1.0.3.tgz", "integrity": "sha512-pkY1fj1cKHb2seWDy0B16HeWyczlJA9/WW3u3c4z/NiWDsO3DOU5D7nhTLE9CF0yXv/QZFY7sEJmj24dK+Rrqw==", "dev": true, "license": "MIT" }, "node_modules/tinybench": { "version": "2.9.0", - "resolved": "https://registry.npmjs.org/tinybench/-/tinybench-2.9.0.tgz", "integrity": "sha512-0+DUvqWMValLmha6lr4kD8iAMK1HzV0/aKnCtWb9v9641TnP/MFb7Pc2bxoxQjTXAErryXVgUOfv2YqNllqGeg==", "dev": true, "license": "MIT" }, "node_modules/tinyexec": { "version": "1.0.2", - "resolved": "https://registry.npmjs.org/tinyexec/-/tinyexec-1.0.2.tgz", "integrity": "sha512-W/KYk+NFhkmsYpuHq5JykngiOCnxeVL8v8dFnqxSD8qEEdRfXk1SDM6JzNqcERbcGYj9tMrDQBYV9cjgnunFIg==", "dev": true, "license": "MIT", @@ -3772,7 +3515,6 @@ }, "node_modules/tinyglobby": { "version": "0.2.17", - "resolved": "https://registry.npmjs.org/tinyglobby/-/tinyglobby-0.2.17.tgz", "integrity": "sha512-wXR/dYpcqKmfWpEdZjiKJOwCNFndD0DMnrW/cYjVGttEkBfVgcLFHoNrlj47mjOVic9yyNu65alsgF4NQyTa2g==", "dev": true, "license": "MIT", @@ -3789,7 +3531,6 @@ }, "node_modules/tinyrainbow": { "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", @@ -3799,14 +3540,12 @@ }, "node_modules/tr46": { "version": "0.0.3", - "resolved": "https://registry.npmjs.org/tr46/-/tr46-0.0.3.tgz", "integrity": "sha512-N3WMsuqV66lT30CrXNbEjx4GEwlow3v6rr4mCcv6prnfwhS01rkgyFdjPNBYd9br7LpXV1+Emh01fHnq2Gdgrw==", "dev": true, "license": "MIT" }, "node_modules/ts-api-utils": { "version": "2.4.0", - "resolved": "https://registry.npmjs.org/ts-api-utils/-/ts-api-utils-2.4.0.tgz", "integrity": "sha512-3TaVTaAv2gTiMB35i3FiGJaRfwb3Pyn/j3m/bfAvGe8FB7CF6u+LMYqYlDh7reQf7UNvoTvdfAqHGmPGOSsPmA==", "dev": true, "license": "MIT", @@ -3819,7 +3558,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", @@ -3827,7 +3565,6 @@ }, "node_modules/tsx": { "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", @@ -3846,7 +3583,6 @@ }, "node_modules/type-check": { "version": "0.4.0", - "resolved": "https://registry.npmjs.org/type-check/-/type-check-0.4.0.tgz", "integrity": "sha512-XleUoc9uwGXqjWwXaUTZAmzMcFZ5858QA2vvx1Ur5xIcixXIP+8LnFDgRplU30us6teqdlskFfu+ae4K79Ooew==", "dev": true, "license": "MIT", @@ -3859,7 +3595,6 @@ }, "node_modules/typescript": { "version": "5.9.3", - "resolved": "https://registry.npmjs.org/typescript/-/typescript-5.9.3.tgz", "integrity": "sha512-jl1vZzPDinLr9eUt3J/t7V6FgNEw9QjvBPdysz9KfQDD41fQrC2Y4vKQdiaUpFT4bXlb1RHhLpp8wtm6M5TgSw==", "dev": true, "license": "Apache-2.0", @@ -3873,14 +3608,12 @@ }, "node_modules/undici-types": { "version": "7.18.2", - "resolved": "https://registry.npmjs.org/undici-types/-/undici-types-7.18.2.tgz", "integrity": "sha512-AsuCzffGHJybSaRrmr5eHr81mwJU3kjw6M+uprWvCXiNeN9SOGwQ3Jn8jb8m3Z6izVgknn1R0FTCEAP2QrLY/w==", "dev": true, "license": "MIT" }, "node_modules/unicode-properties": { "version": "1.4.1", - "resolved": "https://registry.npmjs.org/unicode-properties/-/unicode-properties-1.4.1.tgz", "integrity": "sha512-CLjCCLQ6UuMxWnbIylkisbRj31qxHPAurvena/0iwSVbQ2G1VY5/HjV0IRabOEbDHlzZlRdCrD4NhB0JtU40Pg==", "dev": true, "license": "MIT", @@ -3891,7 +3624,6 @@ }, "node_modules/unicode-trie": { "version": "2.0.0", - "resolved": "https://registry.npmjs.org/unicode-trie/-/unicode-trie-2.0.0.tgz", "integrity": "sha512-x7bc76x0bm4prf1VLg79uhAzKw8DVboClSN5VxJuQ+LKDOVEW9CdH+VY7SP+vX7xCYQqzzgQpFqz15zeLvAtZQ==", "dev": true, "license": "MIT", @@ -3902,14 +3634,12 @@ }, "node_modules/unicode-trie/node_modules/pako": { "version": "0.2.9", - "resolved": "https://registry.npmjs.org/pako/-/pako-0.2.9.tgz", "integrity": "sha512-NUcwaKxUxWrZLpDG+z/xZaCgQITkA/Dv4V/T6bw7VON6l1Xz/VnrBqrYjZQ12TamKHzITTfOEIYUj48y2KXImA==", "dev": true, "license": "MIT" }, "node_modules/uri-js": { "version": "4.4.1", - "resolved": "https://registry.npmjs.org/uri-js/-/uri-js-4.4.1.tgz", "integrity": "sha512-7rKUyy33Q1yc98pQ1DAmLtwX109F7TIfWlW1Ydo8Wl1ii1SeHieeh0HHfPeL2fMXK6z0s8ecKs9frCuLJvndBg==", "dev": true, "license": "BSD-2-Clause", @@ -3919,14 +3649,12 @@ }, "node_modules/urijs": { "version": "1.19.11", - "resolved": "https://registry.npmjs.org/urijs/-/urijs-1.19.11.tgz", "integrity": "sha512-HXgFDgDommxn5/bIv0cnQZsPhHDA90NPHD6+c/v21U5+Sx5hoP8+dP9IZXBU1gIfvdRfhG8cel9QNPeionfcCQ==", "dev": true, "license": "MIT" }, "node_modules/vite": { "version": "8.0.16", - "resolved": "https://registry.npmjs.org/vite/-/vite-8.0.16.tgz", "integrity": "sha512-h9bXPmJichP5fLmVQo3PyaGSDE2n3aPuomeAlVRm0JLmt4rY6zmPKd59HYI4LNW8oTK7tlTsuC7l/m7awx9Jcw==", "dev": true, "license": "MIT", @@ -4004,7 +3732,6 @@ }, "node_modules/vitest": { "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", @@ -4094,7 +3821,6 @@ }, "node_modules/vscode-jsonrpc": { "version": "8.2.1", - "resolved": "https://registry.npmjs.org/vscode-jsonrpc/-/vscode-jsonrpc-8.2.1.tgz", "integrity": "sha512-kdjOSJ2lLIn7r1rtrMbbNCHjyMPfRnowdKjBQ+mGq6NAW5QY2bEZC/khaC5OR8svbbjvLEaIXkOq45e2X9BIbQ==", "license": "MIT", "engines": { @@ -4103,14 +3829,12 @@ }, "node_modules/webidl-conversions": { "version": "3.0.1", - "resolved": "https://registry.npmjs.org/webidl-conversions/-/webidl-conversions-3.0.1.tgz", "integrity": "sha512-2JAn3z8AR6rjK8Sm8orRC0h/bcl/DqL7tRPdGZ4I1CjdF+EaMLmYxBHyXuKL849eucPFhvBoxMsflfOb8kxaeQ==", "dev": true, "license": "BSD-2-Clause" }, "node_modules/whatwg-url": { "version": "5.0.0", - "resolved": "https://registry.npmjs.org/whatwg-url/-/whatwg-url-5.0.0.tgz", "integrity": "sha512-saE57nupxk6v3HY35+jzBwYa0rKSy0XR8JSxZPwgLr7ys0IBzhGviA1/TUGJLmSVqs8pb9AnvICXEuOHLprYTw==", "dev": true, "license": "MIT", @@ -4121,7 +3845,6 @@ }, "node_modules/which": { "version": "2.0.2", - "resolved": "https://registry.npmjs.org/which/-/which-2.0.2.tgz", "integrity": "sha512-BLI3Tl1TW3Pvl70l3yq3Y64i+awpwXqsGBYWkkqMtnbXgrMD+yj7rhW0kuEDxzJaYXGjEW5ogapKNMEKNMjibA==", "dev": true, "license": "ISC", @@ -4137,7 +3860,6 @@ }, "node_modules/why-is-node-running": { "version": "2.3.0", - "resolved": "https://registry.npmjs.org/why-is-node-running/-/why-is-node-running-2.3.0.tgz", "integrity": "sha512-hUrmaWBdVDcxvYqnyh09zunKzROWjbZTiNy8dBEjkS7ehEDQibXJ7XvlmtbwuTclUiIyN+CyXQD4Vmko8fNm8w==", "dev": true, "license": "MIT", @@ -4154,7 +3876,6 @@ }, "node_modules/word-wrap": { "version": "1.2.5", - "resolved": "https://registry.npmjs.org/word-wrap/-/word-wrap-1.2.5.tgz", "integrity": "sha512-BN22B5eaMMI9UMtjrGd5g5eCYPpCPDUy0FJXbYsaT5zYxjFOckS53SQDE3pWkVoWpHXVb3BrYcEN4Twa55B5cA==", "dev": true, "license": "MIT", @@ -4164,14 +3885,12 @@ }, "node_modules/wordwrap": { "version": "1.0.0", - "resolved": "https://registry.npmjs.org/wordwrap/-/wordwrap-1.0.0.tgz", "integrity": "sha512-gvVzJFlPycKc5dZN4yPkP8w7Dc37BtP1yczEneOb4uq34pXZcvrtRTmWV8W+Ume+XCxKgbjM+nevkyFPMybd4Q==", "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", @@ -4193,7 +3912,6 @@ }, "node_modules/yaml": { "version": "2.9.0", - "resolved": "https://registry.npmjs.org/yaml/-/yaml-2.9.0.tgz", "integrity": "sha512-2AvhNX3mb8zd6Zy7INTtSpl1F15HW6Wnqj0srWlkKLcpYl/gMIMJiyuGq2KeI2YFxUPjdlB+3Lc10seMLtL4cA==", "dev": true, "license": "ISC", @@ -4209,7 +3927,6 @@ }, "node_modules/yocto-queue": { "version": "0.1.0", - "resolved": "https://registry.npmjs.org/yocto-queue/-/yocto-queue-0.1.0.tgz", "integrity": "sha512-rVksvsnNCdJ/ohGc6xgPwyN8eheCxsiLM8mxuE/t/mOVqJewPuO1miLpTHQiRgTKCLexL4MeAFVagts7HmNZ2Q==", "dev": true, "license": "MIT", @@ -4222,7 +3939,6 @@ }, "node_modules/zod": { "version": "4.3.6", - "resolved": "https://registry.npmjs.org/zod/-/zod-4.3.6.tgz", "integrity": "sha512-rftlrkhHZOcjDwkGlnUtZZkvaPHCsDATp4pGpuOOMDaTdDDXF91wuVDJoWoPsKX/3YPQ5fHuF3STjcYyKr+Qhg==", "license": "MIT", "funding": { diff --git a/nodejs/package.json b/nodejs/package.json index aadba0ecee..89863520e0 100644 --- a/nodejs/package.json +++ b/nodejs/package.json @@ -56,7 +56,7 @@ "author": "GitHub", "license": "MIT", "dependencies": { - "@github/copilot": "^1.0.73", + "@github/copilot": "^1.0.82-0", "koffi": "^3.1.0", "vscode-jsonrpc": "^8.2.1", "zod": "^4.3.6" diff --git a/nodejs/samples/package-lock.json b/nodejs/samples/package-lock.json index a12f7eedd4..ad675a88c7 100644 --- a/nodejs/samples/package-lock.json +++ b/nodejs/samples/package-lock.json @@ -18,7 +18,7 @@ "version": "0.0.0-dev", "license": "MIT", "dependencies": { - "@github/copilot": "^1.0.73", + "@github/copilot": "^1.0.82-0", "koffi": "^3.1.0", "vscode-jsonrpc": "^8.2.1", "zod": "^4.3.6" diff --git a/nodejs/src/client.ts b/nodejs/src/client.ts index 61f4a99416..9b853aa597 100644 --- a/nodejs/src/client.ts +++ b/nodejs/src/client.ts @@ -16,7 +16,7 @@ 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, @@ -35,6 +35,8 @@ import { } from "./generated/rpc.js"; import type { GitHubTelemetryNotification, + GitHubTokenAcquireRequest, + GitHubTokenAcquireResult, OpenCanvasInstance, SessionUpdateOptionsParams, } from "./generated/rpc.js"; @@ -54,9 +56,11 @@ import type { CustomAgentConfig, ExitPlanModeRequest, ExitPlanModeResult, + ExtensionJoinOptions, ForegroundSessionInfo, GetAuthStatusResponse, BearerTokenProvider, + GitHubTokenProvider, GetStatusResponse, InternalRuntimeConnection, RuntimeConnection, @@ -85,6 +89,7 @@ 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. @@ -376,11 +381,9 @@ function getBundledCliPath(): string { // ESM: resolve via import.meta.resolve 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"); + const packageEntryUrl = import.meta.resolve(packageName); + const packageEntryPath = fileURLToPath(packageEntryUrl); + return join(dirname(packageEntryPath), "index.js"); } catch { // Try the next candidate platform package. } @@ -521,8 +524,13 @@ export class CopilotClient { /** 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 = {}; + private githubTokenProviders = new Map< + string, + { provider: GitHubTokenProvider; sessionId?: string; committed: boolean } + >(); /** * Typed server-scoped RPC methods. @@ -681,6 +689,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") { @@ -830,11 +848,6 @@ export class CopilotClient { private setupClientGlobalHandlers(): void { const handlers: import("./generated/rpc.js").ClientGlobalApiHandlers = {}; - // `hooks.invoke` is a client-global RPC method whose payload carries a - // `sessionId`; route each invocation to the matching session's dispatcher. - handlers.hooks = { - invoke: async (params) => await this.handleHooksInvoke(params), - }; if (this.requestHandler) { handlers.llmInference = createCopilotRequestAdapter(this.requestHandler, () => { if (!this.connection) { @@ -856,9 +869,65 @@ export class CopilotClient { }, }; } + handlers.gitHubToken = { + getToken: (params) => this.acquireGitHubToken(params), + }; this.clientGlobalHandlers = handlers; } + private async acquireGitHubToken( + params: GitHubTokenAcquireRequest + ): Promise { + const registration = this.githubTokenProviders.get(params.registrationId); + if (!registration) { + throw new Error( + `No GitHub token provider registered for registration ID "${params.registrationId}"` + ); + } + return await registration.provider({ + host: params.host, + sessionId: params.sessionId ?? registration.sessionId, + reason: params.reason, + }); + } + + private registerGitHubTokenProvider( + provider: GitHubTokenProvider | undefined, + sessionId?: string + ): string | undefined { + if (!provider) { + return undefined; + } + const registrationId = randomUUID(); + this.githubTokenProviders.set(registrationId, { provider, sessionId, committed: false }); + return registrationId; + } + + private assignGitHubTokenProvider(registrationId: string | undefined, sessionId: string): void { + if (!registrationId) { + return; + } + const registration = this.githubTokenProviders.get(registrationId); + if (registration) { + registration.sessionId = sessionId; + } + } + + private commitGitHubTokenProvider(sessionId: string, registrationId?: string): void { + for (const [candidateId, registration] of this.githubTokenProviders) { + if (registration.sessionId === sessionId && registration.committed) { + this.githubTokenProviders.delete(candidateId); + } + } + const registration = registrationId + ? this.githubTokenProviders.get(registrationId) + : undefined; + if (registration) { + registration.sessionId = sessionId; + registration.committed = true; + } + } + /** * Starts the CLI server and establishes a connection. * @@ -898,6 +967,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", { @@ -998,6 +1078,7 @@ export class CopilotClient { session._markDisconnected(); } this.sessions.clear(); + this.githubTokenProviders.clear(); // Ask SDK-owned runtimes to flush and clean up before we tear down // their transport/process. External runtimes may be shared, so only @@ -1180,6 +1261,7 @@ export class CopilotClient { session._markDisconnected(); } this.sessions.clear(); + this.githubTokenProviders.clear(); // Force close connection. Suppress writer failures first so teardown // write rejections don't surface as unhandled rejections. @@ -1323,11 +1405,17 @@ export class CopilotClient { 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 @@ -1378,7 +1466,8 @@ export class CopilotClient { * * In empty mode, defaults the four overridable feature flags to safe values * (caller values from `config` win). `installedPlugins=[]` is unconditional - * in empty mode β€” apps that need custom plugins should switch modes. + * in empty mode. `includedBuiltinSkills` defaults to `[]`, but callers can + * explicitly allow selected runtime-bundled skills. */ private async updateSessionOptionsForMode( session: CopilotSession, @@ -1391,6 +1480,7 @@ export class CopilotClient { patch.coauthorEnabled = config.coauthorEnabled ?? false; patch.manageScheduleEnabled = config.manageScheduleEnabled ?? false; patch.installedPlugins = []; + patch.includedBuiltinSkills = config.includedBuiltinSkills ?? []; } else { if (config.skipCustomInstructions !== undefined) patch.skipCustomInstructions = config.skipCustomInstructions; @@ -1400,6 +1490,8 @@ export class CopilotClient { patch.coauthorEnabled = config.coauthorEnabled; if (config.manageScheduleEnabled !== undefined) patch.manageScheduleEnabled = config.manageScheduleEnabled; + if (config.includedBuiltinSkills !== undefined) + patch.includedBuiltinSkills = config.includedBuiltinSkills; } if (Object.keys(patch).length === 0) { return; @@ -1421,11 +1513,16 @@ export class CopilotClient { } async createSession(config: SessionConfig): Promise { + if (config.gitHubToken !== undefined && config.gitHubTokenProvider !== undefined) { + throw new Error("gitHubToken and gitHubTokenProvider are mutually exclusive"); + } if (!this.connection) { 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 @@ -1438,6 +1535,11 @@ export class CopilotClient { const callerSessionId = config.sessionId; const useServerGeneratedId = config.cloud != null && callerSessionId == null; const localSessionId = useServerGeneratedId ? undefined : (callerSessionId ?? randomUUID()); + const toolFilterOptions = this.resolveToolFilterOptions(config); + const gitHubTokenProviderRegistrationId = this.registerGitHubTokenProvider( + config.gitHubTokenProvider, + localSessionId + ); // Strip non-serializable bearerTokenProvider callbacks from provider configs, // replacing them with a wire flag; keep the callbacks for session-side @@ -1461,7 +1563,19 @@ export class CopilotClient { this.connection!, undefined, this.onGetTraceContext, - { mcpAuthHandler: config.onMcpAuthRequest } + { + mcpAuthHandler: config.onMcpAuthRequest, + managedSettingsEnabled: + config.enableManagedSettings === true || + config.managedSettings !== undefined, + onDisconnected: + gitHubTokenProviderRegistrationId === undefined + ? undefined + : () => + this.githubTokenProviders.delete( + gitHubTokenProviderRegistrationId + ), + } ); s.registerTools(config.tools); s.registerCanvases(config.canvases); @@ -1504,12 +1618,17 @@ export class CopilotClient { // processing (e.g. sessionFs.writeFile for workspace metadata) can be // routed to the correct handlers. if (localSessionId !== undefined) { - session = initializeSession(localSessionId); - registeredId = localSessionId; + try { + session = initializeSession(localSessionId); + registeredId = localSessionId; + } catch (error) { + if (gitHubTokenProviderRegistrationId !== undefined) { + this.githubTokenProviders.delete(gitHubTokenProviderRegistrationId); + } + throw error; + } } - const toolFilterOptions = this.resolveToolFilterOptions(config); - try { const response = await this.connection!.sendRequest("session.create", { ...(await getTraceContext(this.onGetTraceContext)), @@ -1518,6 +1637,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, @@ -1527,6 +1647,7 @@ export class CopilotClient { skipPermission: tool.skipPermission, defer: tool.defer, metadata: tool.metadata, + isTerminal: tool.isTerminal, })), toolSearch: config.toolSearch, canvases: config.canvases?.map((canvas) => canvas.declaration), @@ -1537,7 +1658,7 @@ export class CopilotClient { canvasProvider: config.canvasProvider, commands: config.commands?.map((cmd) => ({ name: cmd.name, - description: cmd.description, + description: cmd.description ?? "", })), systemMessage: wireSystemMessage, availableTools: toolFilterOptions.availableTools, @@ -1550,6 +1671,7 @@ export class CopilotClient { models: config.models, enableSessionTelemetry: config.enableSessionTelemetry, enableCitations: config.enableCitations, + enableFileChangeTracking: config.enableFileChangeTracking, sessionLimits: config.sessionLimits, modelCapabilities: config.modelCapabilities, largeOutput: toWireLargeOutput(config.largeOutput), @@ -1557,10 +1679,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, streaming: config.streaming, includeSubAgentStreamingEvents: config.includeSubAgentStreamingEvents ?? true, ...(this.onGitHubTelemetry != null @@ -1570,6 +1696,7 @@ export class CopilotClient { mcpOAuthTokenStorage: config.mcpOAuthTokenStorage, envValueMode: "direct", customAgents: toWireCustomAgents(config.customAgents), + customAgentsLocalOnly: config.customAgentsLocalOnly, defaultAgent: config.defaultAgent, agent: config.agent, configDir: config.configDirectory, @@ -1586,13 +1713,16 @@ export class CopilotClient { pluginDirectories: config.pluginDirectories, instructionDirectories: config.instructionDirectories, disabledSkills: config.disabledSkills, + disabledMcpServers: config.disabledMcpServers, infiniteSessions: config.infiniteSessions, memory: config.memory, gitHubToken: config.gitHubToken, + gitHubTokenProviderRegistrationId, remoteSession: config.remoteSession, cloud: config.cloud, expAssignments: config.expAssignments, enableManagedSettings: config.enableManagedSettings, + managedSettings: config.managedSettings, }); const { @@ -1618,6 +1748,7 @@ export class CopilotClient { session = initializeSession(returnedSessionId); registeredId = returnedSessionId; } + this.assignGitHubTokenProvider(gitHubTokenProviderRegistrationId, returnedSessionId); if (config.onMcpAuthRequest) { await this.connection!.sendRequest("session.eventLog.registerInterest", { sessionId: returnedSessionId, @@ -1628,10 +1759,14 @@ export class CopilotClient { session.setCapabilities(capabilities); await this.updateSessionOptionsForMode(session, config); + this.commitGitHubTokenProvider(returnedSessionId, gitHubTokenProviderRegistrationId); } catch (e) { if (registeredId !== undefined) { this.sessions.delete(registeredId); } + if (gitHubTokenProviderRegistrationId !== undefined) { + this.githubTokenProviders.delete(gitHubTokenProviderRegistrationId); + } throw e; } @@ -1663,6 +1798,28 @@ export class CopilotClient { * ``` */ async resumeSession(sessionId: string, config: ResumeSessionConfig): Promise { + return this.resumeSessionInternal(sessionId, config); + } + + /** @internal */ + async resumeSessionForExtension( + sessionId: string, + config: ResumeSessionConfig, + factories?: FactoryHandle[], + extensionOptions?: ExtensionJoinOptions + ): Promise { + return this.resumeSessionInternal(sessionId, config, factories, extensionOptions); + } + + private async resumeSessionInternal( + sessionId: string, + config: ResumeSessionConfig, + factories?: FactoryHandle[], + extensionOptions?: ExtensionJoinOptions + ): Promise { + if (config.gitHubToken !== undefined && config.gitHubTokenProvider !== undefined) { + throw new Error("gitHubToken and gitHubTokenProvider are mutually exclusive"); + } if (!this.connection) { await this.start(); } @@ -1674,11 +1831,16 @@ export class CopilotClient { this.connection!, undefined, this.onGetTraceContext, - { mcpAuthHandler: config.onMcpAuthRequest } + { + 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, @@ -1704,7 +1866,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( @@ -1721,6 +1885,15 @@ export class CopilotClient { this.setupSessionFs(session, config); const toolFilterOptions = this.resolveToolFilterOptions(config); + const gitHubTokenProviderRegistrationId = this.registerGitHubTokenProvider( + config.gitHubTokenProvider, + sessionId + ); + if (gitHubTokenProviderRegistrationId !== undefined) { + session._setOnDisconnected(() => + this.githubTokenProviders.delete(gitHubTokenProviderRegistrationId) + ); + } try { const response = await this.connection!.sendRequest("session.resume", { @@ -1730,6 +1903,7 @@ 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, @@ -1738,6 +1912,7 @@ export class CopilotClient { enableSessionTelemetry: config.enableSessionTelemetry, excludedBuiltinAgents: config.excludedBuiltinAgents, enableCitations: config.enableCitations, + enableFileChangeTracking: config.enableFileChangeTracking, sessionLimits: config.sessionLimits, tools: config.tools?.map((tool) => ({ name: tool.name, @@ -1747,9 +1922,11 @@ export class CopilotClient { 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, @@ -1757,7 +1934,7 @@ export class CopilotClient { canvasProvider: config.canvasProvider, commands: config.commands?.map((cmd) => ({ name: cmd.name, - description: cmd.description, + description: cmd.description ?? "", })), provider: bearerWireProvider, capi: config.capi, @@ -1770,10 +1947,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, @@ -1793,23 +1974,50 @@ export class CopilotClient { 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, memory: config.memory, disableResume: config.suppressResumeEvent, continuePendingWork: config.continuePendingWork, gitHubToken: config.gitHubToken, + gitHubTokenProviderRegistrationId, remoteSession: config.remoteSession, openCanvases: config.openCanvases, expAssignments: config.expAssignments, enableManagedSettings: config.enableManagedSettings, + managedSettings: config.managedSettings, + ...(extensionOptions?.requestedEnvironmentVariables + ? { + requestedEnvironmentVariables: + extensionOptions.requestedEnvironmentVariables, + } + : {}), }); + // The host answers an approved environment request with the resolved + // values, and this method consumes the response, so the grant has to be + // applied here β€” no caller ever sees it. Only the names the user + // approved may reach the extension, so a host that answers with + // anything extra cannot widen the grant. + if (extensionOptions?.requestedEnvironmentVariables) { + const requested = new Set(extensionOptions.requestedEnvironmentVariables); + const { grantedEnvironmentVariables } = response as { + grantedEnvironmentVariables?: Record; + }; + for (const [name, value] of Object.entries(grantedEnvironmentVariables ?? {})) { + if (requested.has(name)) { + process.env[name] = value; + } + } + } + const { workspacePath, capabilities, openCanvases } = response as { sessionId: string; workspacePath?: string; @@ -1827,8 +2035,12 @@ export class CopilotClient { } await this.updateSessionOptionsForMode(session, config); + this.commitGitHubTokenProvider(sessionId, gitHubTokenProviderRegistrationId); } catch (e) { this.sessions.delete(sessionId); + if (gitHubTokenProviderRegistrationId !== undefined) { + this.githubTokenProviders.delete(gitHubTokenProviderRegistrationId); + } throw e; } @@ -2072,8 +2284,9 @@ export class CopilotClient { throw new Error(`Failed to delete session ${sessionId}: ${error || "Unknown error"}`); } - // Remove from local sessions map if present + const session = this.sessions.get(sessionId); this.sessions.delete(sessionId); + session?._runOnDisconnected(); } /** @@ -2823,8 +3036,20 @@ export class CopilotClient { // β€” 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"; + this.githubTokenProviders.clear(); }); this.connection.onError((_error) => { diff --git a/nodejs/src/extension.ts b/nodejs/src/extension.ts index 72bde93bde..d756308734 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,71 @@ export type JoinSessionConfig = Omit< "onPermissionRequest" | "extensionSdkPath" > & { onPermissionRequest?: PermissionHandler; + /** + * Names of sensitive environment variables this extension needs, such as + * `"GITHUB_TOKEN"`. + * + * The Copilot CLI strips sensitive variables from every extension process + * before it starts, so an extension that needs one must ask for it by name. + * The CLI prompts the user with the extension's name and the exact list of + * variables requested. On approval the granted values are written into this + * process's `process.env` before {@link joinSession} resolves, so they are + * readable afterwards. On denial the join rejects and the extension does not + * load, so its tools never reach the model. + * + * An approval is remembered against the exact set of names the user saw, so + * asking for an additional variable later prompts again. Names that are unset + * or that the CLI does not filter from extensions are not prompted for. An + * empty list means the same as omitting the option: nothing is requested. + * + * Requires a Copilot CLI that supports extension environment access; older + * CLIs ignore the request and grant nothing. + * + * @example + * ```typescript + * const session = await joinSession({ + * requestedEnvironmentVariables: ["GITHUB_TOKEN"], + * }); + * const token = process.env.GITHUB_TOKEN; + * ``` + */ + requestedEnvironmentVariables?: string[]; + /** + * 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 +120,24 @@ 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/generated/rpc.ts b/nodejs/src/generated/rpc.ts index cf009115e1..db0ea63dcc 100644 --- a/nodejs/src/generated/rpc.ts +++ b/nodejs/src/generated/rpc.ts @@ -5,10 +5,20 @@ import type { MessageConnection } from "vscode-jsonrpc/node.js"; -import type { AbortReason, Attachment, ContextTier, EmbeddedBlobResourceContents, EmbeddedTextResourceContents, McpServerSource, McpServerStatus, PermissionPromptRequest, PermissionRule, ReasoningSummary, SessionEvent, SessionLimitsConfig, SessionMode, ShutdownType, SkillSource, UserToolSessionApproval, Verbosity } from "./session-events.js"; +import type { AbortReason, Attachment, ContextTier, EmbeddedBlobResourceContents, EmbeddedTextResourceContents, McpOauthHttpResponse, McpOauthWWWAuthenticateParams, McpServerSource, McpServerStatus, ModelChangeSource, PermissionMode, PermissionPromptRequest, PermissionRule, ReasoningSummary, SessionEvent, SessionLimitsConfig, SessionMode, ShutdownType, SkillSource, TaskCompleteData, TaskCompletionOutcome, 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. + * Authentication credentials accepted only at native protocol ingress. Runtime outputs use credential-free `AuthIdentity` metadata. * * This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema * via the `definition` "AuthInfo". @@ -18,10 +28,21 @@ export type AuthInfo = | HMACAuthInfo | EnvAuthInfo | TokenAuthInfo + | TokenProviderAuthInfo | CopilotApiTokenAuthInfo | UserAuthInfo | GhCliAuthInfo | ApiKeyAuthInfo; +/** + * User to log out + * + * This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema + * via the `definition` "AccountLogoutRequest". + */ +/** @experimental */ +export type AccountLogoutRequest = { + [k: string]: unknown | undefined; +}; /** * Resolved Anthropic adaptive-thinking capability for a model. * @@ -68,6 +89,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 * @@ -202,20 +244,6 @@ export type AgentRegistrySpawnValidationErrorField = | "model" /** The permissionMode parameter */ | "permissionMode"; -/** - * Current or requested allow-all mode. - * - * This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema - * via the `definition` "PermissionsAllowAllMode". - */ -/** @experimental */ -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 * @@ -236,8 +264,399 @@ export type AuthInfoType = | "api-key" /** Authentication from a GitHub token. */ | "token" + /** Authentication from an SDK GitHub token callback. */ + | "token-provider" /** Authentication from a Copilot API token. */ | "copilot-api-token"; +/** + * Validation errors from the most recent authentication attempt. + * + * This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema + * via the `definition` "AuthValidationErrors". + */ +/** @experimental */ +export type AuthValidationErrors = AuthValidationError[]; +/** + * Root JSON Schema type for a built-in tool input. + * + * This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema + * via the `definition` "BuiltinToolInputSchemaType". + */ +/** @experimental */ +export type BuiltinToolInputSchemaType = /** The tool accepts a JSON object. */ "object"; +/** + * Custom input-format kind. + * + * This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema + * via the `definition` "BuiltinToolFormatType". + */ +/** @experimental */ +export type BuiltinToolFormatType = /** The tool input is parsed with the supplied grammar. */ "grammar"; +/** + * Telemetry-safety policy for a built-in tool. + * + * This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema + * via the `definition` "BuiltinToolSafeForTelemetry". + */ +/** @experimental */ +export type BuiltinToolSafeForTelemetry = boolean | BuiltinToolSafeTelemetryFields; +/** + * 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` "CanvasActionInvokeResult". + */ +/** @experimental */ +export type CanvasActionInvokeResult = JsonValue; +/** + * Canonical digest algorithm for a validated MCP card + * + * This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema + * via the `definition` "CardDigestAlgorithm". + */ +/** @experimental */ +export type CardDigestAlgorithm = /** SHA-256 over RFC 8785 canonical JSON encoded as UTF-8. */ "sha256-rfc8785"; +/** + * SHA-256 digest encoded as exactly 64 lowercase hexadecimal characters. + * + * This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema + * via the `definition` "CardDigestValue". + */ +/** @experimental */ +export type CardDigestValue = string; +/** + * Where a candidate's card came from. Exactly one of a URL or embedded data: the union has no variant carrying both, and no variant carrying neither, so the rule holds structurally rather than by validation. + * + * This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema + * via the `definition` "CatalogCandidateSource". + */ +/** @experimental */ +export type CatalogCandidateSource = CatalogCandidateSourceUrl | CatalogCandidateSourceEmbedded; +/** + * Why the catalog authority did not accept the caller's identity + * + * This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema + * via the `definition` "CatalogAuthenticationRequiredReason". + */ +/** @experimental */ +export type CatalogAuthenticationRequiredReason = + /** No credential was presented, so there is nothing to refresh and the caller must sign in. */ + | "no-credential" + /** A credential was presented and its lifetime has elapsed. A silent refresh is worth attempting before prompting anyone. */ + | "credential-expired" + /** A credential was presented and the authority refused it, for example because it was revoked, malformed, or issued for another audience. Refreshing the same rejected credential is not useful; the caller must sign in again. */ + | "credential-rejected"; +/** + * One inert catalog result, represented as an MCP server or discovery-only AI skill variant so kind, media type, provenance, and installability cannot contradict each other. + * + * This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema + * via the `definition` "CatalogCandidate". + */ +/** @experimental */ +export type CatalogCandidate = CatalogMcpServerCandidate | CatalogAiSkillCandidate; +/** + * JSON MCP card media type accepted for install planning + * + * This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema + * via the `definition` "McpServerCardMediaType". + */ +/** @experimental */ +export type McpServerCardMediaType = + /** The current MCP server card media type. */ + | "application/mcp-server-card+json" + /** The legacy MCP server card media type, accepted for compatibility. */ + | "application/mcp-server+json"; +/** + * Whether an MCP server candidate can be planned for installation + * + * This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema + * via the `definition` "CatalogMcpServerInstallability". + */ +/** @experimental */ +export type CatalogMcpServerInstallability = + /** An install plan can be computed for this MCP server candidate. */ + | "installable" + /** Policy forbids installing this MCP server candidate. */ + | "not-installable-policy"; +/** + * What kind of resource a catalog candidate describes + * + * This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema + * via the `definition` "CatalogCandidateKind". + */ +/** @experimental */ +export type CatalogCandidateKind = + /** An MCP server, which can be planned for installation. */ + | "mcp-server" + /** An AI skill, which is discoverable but not installable through this surface. */ + | "ai-skill"; +/** + * A wire feature a caller can require of the catalog surface, negotiated per request. A grant means the runtime understands the feature's contract, not that the deployment has enabled the operation; typed unavailable results report availability separately. + * + * This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema + * via the `definition` "CatalogCapability". + */ +/** @experimental */ +export type CatalogCapability = + /** Understands the current `application/mcp-server-card+json` media type. */ + | "mcp-server-card" + /** Understands the legacy `application/mcp-server+json` media type. */ + | "legacy-mcp-server-card" + /** Understands `application/ai-skill` candidates as discovery-only and typed non-installable. */ + | "ai-skill-discovery" + /** Understands side-effect-free MCP install-plan requests, results, and plan handles; `planning-unavailable` separately reports that planning is not enabled. */ + | "mcp-install-planning" + /** Understands plans that enumerate every eligible transport rather than a single preferred one. */ + | "multiple-transport-choice"; +/** + * Bounded extensible wire-feature identifier. Known values are described by `CatalogCapability`; newer callers may send future identifiers so an older runtime can return a typed negotiation refusal instead of failing schema validation. Capability negotiation establishes contract understanding, while each operation's result separately reports runtime availability. + * + * This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema + * via the `definition` "CatalogCapabilityId". + */ +/** @experimental */ +export type CatalogCapabilityId = string; +/** + * Which wire-contract rule an upstream response broke + * + * This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema + * via the `definition` "CatalogContractViolationReason". + */ +/** @experimental */ +export type CatalogContractViolationReason = + /** A result carried both a URL and embedded data, when exactly one is permitted. */ + | "both-url-and-data" + /** A result carried neither a URL nor embedded data, when exactly one is required. */ + | "neither-url-nor-data" + /** Two results claimed the same normalised identity. */ + | "duplicate-identity" + /** A result declared no media type, or one this contract does not model. */ + | "unknown-media-type"; +/** + * Which kind of opaque handle was presented + * + * This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema + * via the `definition` "CatalogHandleType". + */ +/** @experimental */ +export type CatalogHandleType = + /** A search candidate handle. */ + | "candidate" + /** An install plan handle. */ + | "plan"; +/** + * Why a presented handle was rejected + * + * This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema + * via the `definition` "CatalogHandleRejectionReason". + */ +/** @experimental */ +export type CatalogHandleRejectionReason = + /** The handle is unparseable, unknown, or was issued for a different operation. */ + | "invalid" + /** The handle's time to live has elapsed. */ + | "stale" + /** The handle has already been used, and handles are single-use. */ + | "replayed" + /** The handle was issued by a different runtime instance. */ + | "foreign"; +/** + * Which request field was rejected before any work was done + * + * This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema + * via the `definition` "CatalogInvalidRequestField". + */ +/** @experimental */ +export type CatalogInvalidRequestField = + /** The search query was empty or longer than permitted. */ + | "query" + /** The requested result count fell outside its permitted range. */ + | "limit" + /** The requested candidate kinds were empty or contained a duplicate. */ + | "kinds" + /** The negotiation block was missing or malformed. */ + | "contract" + /** The plan source was missing or malformed. */ + | "source" + /** The supplied card was missing its media type, URL, or data. */ + | "card" + /** The requested configuration scope is not one this runtime writes. */ + | "scope"; +/** + * How a card failed validation + * + * This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema + * via the `definition` "CatalogMalformedCardReason". + */ +/** @experimental */ +export type CatalogMalformedCardReason = + /** The document is not well-formed JSON. */ + | "invalid-json" + /** The document does not satisfy its media type's schema. */ + | "schema-violation" + /** The declared media type is not one this runtime understands. */ + | "unsupported-media-type" + /** A field the media type requires is absent. */ + | "missing-required-field" + /** The document exceeded the permitted size. */ + | "size-limit-exceeded"; +/** + * Media type a catalog card is interpreted as + * + * This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema + * via the `definition` "CatalogMediaType". + */ +/** @experimental */ +export type CatalogMediaType = + /** The current MCP server card media type. */ + | "application/mcp-server-card+json" + /** The legacy MCP server card media type, accepted for compatibility. */ + | "application/mcp-server+json" + /** An AI skill card. Representable and searchable, but typed non-installable. */ + | "application/ai-skill"; +/** + * Why capability and protocol-version negotiation refused a caller + * + * This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema + * via the `definition` "CatalogNegotiationRefusedReason". + */ +/** @experimental */ +export type CatalogNegotiationRefusedReason = + /** The caller's protocol version is below the lowest this runtime serves. */ + | "unsupported-protocol-version" + /** The caller requires at least one capability this runtime cannot honour. */ + | "unsupported-capability"; +/** + * Categorised network failure, low cardinality so it can be aggregated without carrying a URL + * + * This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema + * via the `definition` "CatalogNetworkFailureReason". + */ +/** @experimental */ +export type CatalogNetworkFailureReason = + /** No network is available, so nothing was attempted. */ + | "offline" + /** The authority's name could not be resolved. */ + | "dns" + /** The request exceeded its time budget. */ + | "timeout" + /** The TLS handshake or certificate validation failed. */ + | "tls" + /** The connection was refused or reset. */ + | "connection-refused" + /** The authority returned a status the runtime treats as a failure. */ + | "http-status" + /** The response exceeded the permitted size. */ + | "response-too-large" + /** A redirect was refused by the runtime's redirect policy. */ + | "redirect-rejected"; +/** + * Why a discoverable candidate cannot be installed + * + * This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema + * via the `definition` "CatalogNotInstallableReason". + */ +/** @experimental */ +export type CatalogNotInstallableReason = + /** This kind of resource is not installable through this surface. */ + | "kind-not-installable" + /** AI skills are discoverable but have no typed importer in this phase. */ + | "ai-skill-not-installable" + /** Policy forbids installing this candidate. */ + | "policy-forbids"; +/** + * Which authority produced a policy decision + * + * This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema + * via the `definition` "McpPlanPolicySource". + */ +/** @experimental */ +export type McpPlanPolicySource = + /** No policy applied, so the server is permitted by default. */ + | "none" + /** An enterprise allowlist evaluated the server. */ + | "enterprise-allowlist" + /** The registry the card came from evaluated the server. */ + | "registry-policy" + /** Local trust settings evaluated the server. */ + | "local-trust"; +/** + * Outcome of a catalog.search call: either bounded inert candidates, or one typed refusal. Never a partial success. + * + * This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema + * via the `definition` "CatalogSearchResult". + */ +/** @experimental */ +export type CatalogSearchResult = + | CatalogSearchSucceeded + | CatalogNegotiationRefusedError + | CatalogUnsupportedKindError + | CatalogInvalidRequestError + | CatalogAuthenticationRequiredError + | CatalogPolicyRejectedError + | CatalogNetworkFailureError + | CatalogUnsafeRetrievalError + | CatalogMalformedCardError + | CatalogContractViolationError + | CatalogUnavailableError; +/** + * Which hardened-fetch control refused a retrieval + * + * This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema + * via the `definition` "CatalogUnsafeRetrievalReason". + */ +/** @experimental */ +export type CatalogUnsafeRetrievalReason = + /** The URL used a scheme the runtime refuses to fetch. */ + | "blocked-scheme" + /** The URL embedded credentials. */ + | "credentials-in-url" + /** The URL resolved to a loopback, private, link-local, or cloud metadata address. */ + | "blocked-address" + /** A redirect target resolved to a blocked address. */ + | "redirect-to-blocked-address" + /** The configured proxy policy refused the request. */ + | "proxy-rejected" + /** The authority is not permitted for card retrieval. */ + | "host-not-permitted"; +/** + * Why a catalog operation is not available on this runtime + * + * This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema + * via the `definition` "CatalogUnavailableReason". + */ +/** @experimental */ +export type CatalogUnavailableReason = + /** Bounded search is not wired up on this runtime build. */ + | "search-unavailable" + /** Install planning is not wired up on this runtime build. */ + | "planning-unavailable" + /** No catalog authority is configured for this runtime. */ + | "authority-not-configured" + /** The surface is disabled by policy on this runtime. */ + | "disabled-by-policy"; +/** + * Why no usable transport could be offered + * + * This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema + * via the `definition` "CatalogUnavailableTransportReason". + */ +/** @experimental */ +export type CatalogUnavailableTransportReason = + /** The card advertises no transport this runtime can use. */ + | "no-eligible-transport" + /** Every advertised transport is of a kind this runtime does not implement. */ + | "transport-not-supported" + /** Eligible remotes could not be enumerated, so no explicit choice can be offered. */ + | "remote-enumeration-unavailable"; /** * Coarse command category for grouping and behavior: runtime built-in, skill-backed command, or SDK/client-owned command * @@ -260,6 +679,46 @@ export type SlashCommandKind = */ /** @experimental */ export type SlashCommandInputCompletion = /** Input should complete filesystem directories. */ "directory"; +/** + * Whether a pending slash-command invocation effect was applied or cancelled by the host. + * + * This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema + * via the `definition` "CommandsInvocationEffectOutcome". + */ +/** @experimental */ +export type CommandsInvocationEffectOutcome = + /** The host applied the pending invocation effect. */ + | "applied" + /** The host cancelled the pending invocation effect, so any provisional state must be reverted. */ + | "cancelled"; + +/** @experimental */ +export type CommandsInvocationOrigin = "settings"; +/** + * 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. * @@ -327,6 +786,9 @@ export type DebugCollectLogsDestination = * When true, create the archive atomically without overwriting an existing file by appending ` (N)` before the extension as needed. Defaults to false. */ noOverwrite?: boolean; + /** + * Destination variant discriminator. + */ kind: "archive"; } | { @@ -334,6 +796,9 @@ export type DebugCollectLogsDestination = * Directory where redacted files should be staged. The directory is created if needed. */ outputDirectory: string; + /** + * Destination variant discriminator. + */ kind: "directory"; }; /** @@ -372,6 +837,32 @@ export type DebugCollectLogsResultKind = | "archive" /** A directory containing redacted files was written. */ | "directory"; +/** + * 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 * @@ -409,7 +900,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". @@ -510,35 +1013,76 @@ export type ExternalToolTextResultForLlmContentResourceDetails = | EmbeddedTextResourceContents | EmbeddedBlobResourceContents; /** - * 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"; + * 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" + /** Renewing the durable owner lease that proves this process still owns the run. */ + | "refreshLease"; /** - * Machine-readable factory run failure. + * Current or terminal state of a factory run. * * This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema - * via the `definition` "FactoryRunFailure". + * via the `definition` "FactoryRunStatus". */ /** @experimental */ -export type FactoryRunFailure = - | { - kind: FactoryRunFailureKind; - /** - * Approved effective ceiling that was reached. +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; + /** + * Factory failure variant discriminator. + */ type: "factory_limit_reached"; } | { @@ -550,7 +1094,39 @@ export type FactoryRunFailure = * Human-readable reason the resume did not proceed. */ reason: string; + /** + * Factory failure variant discriminator. + */ type: "factory_resume_declined"; + } + | { + /** + * Stable failure code. + */ + code: string; + operation: FactoryDurableOperation; + /** + * Factory run identifier. + */ + runId: string; + /** + * Factory failure variant discriminator. + */ + type: "factory_durable_failure"; + } + | { + /** + * Factory run identifier. + */ + runId: string; + /** + * Confirmed usage in nano-AIU, representing the floor of what the run spent. + */ + drainedNanoAiu: number; + /** + * Factory failure variant discriminator. + */ + type: "factory_accounting_incomplete"; }; /** * Cumulative resource ceiling that stopped a factory run. @@ -562,28 +1138,38 @@ export type FactoryRunFailure = export type FactoryRunFailureKind = /** The run admitted the approved maximum total number of subagents. */ | "maxTotalSubagents" - /** The run reached the approved timeout deadline. */ - | "timeout"; + /** 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"; /** - * Current or terminal state of a factory run. + * Kind of factory progress line. * * This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema - * via the `definition` "FactoryRunStatus". + * via the `definition` "FactoryLogLineKind". */ /** @experimental */ -export type FactoryRunStatus = - /** The run was minted and is awaiting approval. */ +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 run is executing. */ - | "running" - /** The run completed successfully. */ + /** The phase is currently entered and accumulating active time. */ + | "active" + /** The phase was entered and has since been closed. */ | "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"; + /** 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. * @@ -596,6 +1182,156 @@ export type FilterMapping = [k: string]: ContentFilterMode; } | ContentFilterMode; +/** + * Why the runtime is requesting a GitHub credential. + * + * This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema + * via the `definition` "GitHubTokenAcquireReason". + */ +/** @experimental */ +export type GitHubTokenAcquireReason = + /** The runtime is acquiring the registration's first credential. */ + | "initial" + /** The runtime is replacing a credential that is approaching expiry. */ + | "refresh"; +/** + * SDK host response to a GitHub credential request. + * + * This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema + * via the `definition` "GitHubTokenAcquireResult". + */ +/** @experimental */ +export type GitHubTokenAcquireResult = + | { + /** + * GitHub access token acquired by the SDK host. + */ + accessToken: string; + /** + * OAuth token type. Defaults to bearer when omitted. + */ + tokenType?: string; + /** + * Remaining token lifetime in seconds when callback execution completes. It must exceed the one-hour preflight refresh threshold. + */ + expiresIn: number; + /** + * GitHub credential response variant discriminator. + */ + kind: "token"; + } + | { + /** + * GitHub credential response variant discriminator. + */ + kind: "cancelled"; + }; +/** + * 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. * @@ -864,13 +1600,21 @@ export type McpAppsSetHostContextDetailsPlatform = /** Host runs on a mobile device */ | "mobile"; /** - * MCP server configuration (stdio process or remote HTTP/SSE) + * Serializable MCP server configuration (stdio process or remote HTTP/SSE) * * This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema - * via the `definition` "McpServerConfig". + * via the `definition` "McpSerializableServerConfig". + */ +/** @experimental */ +export type McpSerializableServerConfig = McpServerConfigStdio | McpServerConfigHttp; +/** + * Telemetry-obfuscation policy for an MCP server's tools. + * + * This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema + * via the `definition` "McpSafeForTelemetry". */ /** @experimental */ -export type McpServerConfig = McpServerConfigStdio | McpServerConfigHttp; +export type McpSafeForTelemetry = boolean | McpSafeForTelemetryFields; /** * Set to `true` to use defaults, or provide an object with additional auth or OIDC settings. * @@ -891,6 +1635,18 @@ export type McpServerConfigDeferTools = | "auto" /** Tools are always included in the initial tool list, even when tool search is enabled. */ | "never"; +/** + * Local MCP transport type. + * + * This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema + * via the `definition` "McpServerConfigStdioType". + */ +/** @experimental */ +export type McpServerConfigStdioType = + /** Legacy alias for the local stdio transport. */ + | "local" + /** Server communicates over stdio with a local child process. */ + | "stdio"; /** * Remote transport type. Defaults to "http" when omitted. * @@ -915,6 +1671,14 @@ export type McpServerConfigHttpOauthGrantType = | "authorization_code" /** Headless client credentials flow using the configured OAuth client. */ | "client_credentials"; +/** + * Structured MCP elicitation mode. + * + * This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema + * via the `definition` "McpElicitationFormMode". + */ +/** @experimental */ +export type McpElicitationFormMode = "form"; /** * Host response: supply dynamic headers or decline this refresh. * @@ -930,11 +1694,173 @@ export type McpHeadersHandlePendingHeadersRefreshRequest = headers: { [k: string]: string | undefined; }; + /** + * Headers-refresh response variant discriminator. + */ kind: "headers"; } | { + /** + * Headers-refresh response variant discriminator. + */ kind: "none"; }; +/** + * One eligible way to run the server, represented as a tagged package or remote variant so package identity and endpoint states cannot contradict the install method. + * + * This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema + * via the `definition` "McpPlanTransportChoice". + */ +/** @experimental */ +export type McpPlanTransportChoice = McpPlanTransportChoicePackage | McpPlanTransportChoiceRemote; +/** + * Transport exposed by a locally launched package + * + * This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema + * via the `definition` "McpPlanPackageTransport". + */ +/** @experimental */ +export type McpPlanPackageTransport = + /** A locally launched process spoken to over standard input and output. */ + "stdio"; +/** + * Discriminator for a package-backed transport choice + * + * This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema + * via the `definition` "McpPlanPackageInstallMethod". + */ +/** @experimental */ +export type McpPlanPackageInstallMethod = /** Install and run a local package. */ "package"; +/** + * One non-secret value a transport choice needs, represented as a scalar or enumerated variant so enum values cannot be missing or attached to another type. + * + * This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema + * via the `definition` "McpPlanRequiredValue". + */ +/** @experimental */ +export type McpPlanRequiredValue = McpPlanRequiredValueScalar | McpPlanRequiredValueEnum; +/** + * Discriminator for a scalar required value + * + * This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema + * via the `definition` "McpPlanRequiredValueScalarKind". + */ +/** @experimental */ +export type McpPlanRequiredValueScalarKind = /** The value uses one scalar type. */ "scalar"; +/** + * Where a required value is applied when the planned server is launched + * + * This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema + * via the `definition` "McpPlanValueCategory". + */ +/** @experimental */ +export type McpPlanValueCategory = + /** Set as an environment variable on the launched process. */ + | "environment-variable" + /** Passed to the runtime that launches the package. */ + | "runtime-argument" + /** Passed to the packaged server itself. */ + | "package-argument" + /** Sent as a request header to a remote endpoint. */ + | "header" + /** Substituted into the remote endpoint URL. */ + | "url-variable"; +/** + * Scalar type a required value must conform to + * + * This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema + * via the `definition` "McpPlanScalarValueType". + */ +/** @experimental */ +export type McpPlanScalarValueType = + /** Free text. */ + | "string" + /** A number. */ + | "number" + /** A boolean. */ + | "boolean" + /** A filesystem path. */ + | "path"; +/** + * Discriminator for an enumerated required value + * + * This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema + * via the `definition` "McpPlanRequiredValueEnumKind". + */ +/** @experimental */ +export type McpPlanRequiredValueEnumKind = /** The value uses a fixed non-empty enumeration. */ "enum"; +/** + * Discriminator for an enumerated required value + * + * This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema + * via the `definition` "McpPlanEnumValueType". + */ +/** @experimental */ +export type McpPlanEnumValueType = /** One of a fixed, non-empty set of permitted values. */ "enum"; +/** + * A runtime-assigned secret placeholder. The identifier is carried once, inside the placeholder, so it cannot contradict a separate secret-id field. + * + * This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema + * via the `definition` "McpPlanSecretReference". + */ +/** @experimental */ +export type McpPlanSecretReference = string; +/** + * Transport exposed by a remote endpoint + * + * This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema + * via the `definition` "McpPlanRemoteTransport". + */ +/** @experimental */ +export type McpPlanRemoteTransport = + /** An HTTP endpoint. */ + | "http" + /** A streamable HTTP endpoint. */ + | "streamable-http" + /** A server-sent events endpoint. */ + | "sse"; +/** + * Discriminator for a remote-endpoint transport choice + * + * This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema + * via the `definition` "McpPlanRemoteInstallMethod". + */ +/** @experimental */ +export type McpPlanRemoteInstallMethod = /** Connect to a remote endpoint. */ "remote"; +/** + * Configuration scope an MCP install plan targets + * + * This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema + * via the `definition` "McpPlanScope". + */ +/** @experimental */ +export type McpPlanScope = /** The user's own MCP configuration. */ "user"; +/** + * What policy decided for a planned server + * + * This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema + * via the `definition` "McpPlanPolicyDecision". + */ +/** @experimental */ +export type McpPlanPolicyDecision = + /** Policy permits the server. */ + | "allowed" + /** Policy forbids the server, so the plan cannot be applied. */ + | "blocked" + /** Policy permits the server only after an explicit approval. */ + | "requires-approval"; +/** + * Whether a planned configuration change would create or modify an entry + * + * This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema + * via the `definition` "McpPlanConfigurationOperation". + */ +/** @experimental */ +export type McpPlanConfigurationOperation = + /** Creates a configuration entry that does not exist yet. */ + | "add" + /** Modifies a configuration entry that already exists. */ + | "update"; /** * Consumer allowed to call an MCP tool. * @@ -961,16 +1887,22 @@ export type McpOauthPendingRequestResponse = */ accessToken: string; /** - * OAuth token type. Defaults to Bearer when omitted. + * OAuth token type. Defaults to bearer when omitted. */ tokenType?: string; /** * Token lifetime in seconds, if known. */ expiresIn?: number; + /** + * OAuth response variant discriminator. + */ kind: "token"; } | { + /** + * OAuth response variant discriminator. + */ kind: "cancelled"; }; /** @@ -986,19 +1918,161 @@ export type McpOauthLoginGrantType = /** 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. + * Why a passive MCP OAuth probe determined authentication is needed. * * This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema - * via the `definition` "McpSamplingExecutionAction". + * via the `definition` "McpOauthProbeNeedsAuthReason". */ /** @experimental */ -export type McpSamplingExecutionAction = - /** The sampling inference completed and produced a result. */ +export type McpOauthProbeNeedsAuthReason = + /** No token was sent and the server requires authentication. */ + | "initial" + /** A cached token was sent and rejected. */ + | "refresh" + /** The server returned a 403 insufficient_scope challenge, indicating additional scopes or audience are needed. */ + | "upscope"; +/** + * Passive MCP OAuth probe result. `authenticated` means the server accepted the probe request while an OAuth-origin access token was attached; it does not prove the server required or independently validated that token. The probe does not make a second unauthenticated request. Failed is an expected probe-domain outcome; JSON-RPC errors are reserved for API-call failures. + * + * This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema + * via the `definition` "McpOauthProbeResult". + */ +/** @experimental */ +export type McpOauthProbeResult = + | { + httpResponse: McpOauthHttpResponse; + /** + * Probe outcome variant discriminator. + */ + status: "no-auth-required"; + } + | { + httpResponse: McpOauthHttpResponse; + /** + * Probe outcome variant discriminator. + */ + status: "authenticated"; + } + | { + httpResponse: McpOauthHttpResponse; + reason: McpOauthProbeNeedsAuthReason; + wwwAuthenticateParams?: McpOauthWWWAuthenticateParams; + /** + * Probe outcome variant discriminator. + */ + status: "needs-auth"; + } + | { + /** + * Human-readable probe failure detail. + */ + error: string; + httpResponse?: McpOauthHttpResponse; + /** + * Probe outcome variant discriminator. + */ + status: "failed"; + }; +/** + * What an install plan is computed from: a candidate handle from a previous search, or a card supplied directly. + * + * This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema + * via the `definition` "McpPlanInstallSource". + */ +/** @experimental */ +export type McpPlanInstallSource = McpPlanInstallSourceCandidate | McpPlanInstallSourceCard; +/** + * Discriminator for a candidate-backed install-plan source + * + * This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema + * via the `definition` "McpPlanInstallSourceCandidateKind". + */ +/** @experimental */ +export type McpPlanInstallSourceCandidateKind = /** Plan from a candidate returned by catalog search. */ "candidate"; +/** + * Discriminator for a caller-supplied-card install-plan source + * + * This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema + * via the `definition` "McpPlanInstallSourceCardKind". + */ +/** @experimental */ +export type McpPlanInstallSourceCardKind = /** Plan directly from a caller-supplied card. */ "card"; +/** + * A card supplied directly by the caller. Exactly one of a URL or embedded data, encoded structurally so neither both nor neither can be expressed. + * + * This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema + * via the `definition` "McpServerCardReference". + */ +/** @experimental */ +export type McpServerCardReference = McpServerCardUrl | McpServerCardEmbedded; +/** + * Discriminator for a URL-backed MCP server card + * + * This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema + * via the `definition` "McpServerCardUrlKind". + */ +/** @experimental */ +export type McpServerCardUrlKind = /** Retrieve the card from its URL. */ "url"; +/** + * Discriminator for an embedded MCP server card + * + * This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema + * via the `definition` "McpServerCardEmbeddedKind". + */ +/** @experimental */ +export type McpServerCardEmbeddedKind = /** Use the embedded card document. */ "embedded"; +/** + * Outcome of an mcp.planInstall call: either a normalised plan, or one typed refusal. Nothing is written in either case. + * + * This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema + * via the `definition` "McpPlanInstallResult". + */ +/** @experimental */ +export type McpPlanInstallResult = + | McpPlanInstallPlanned + | CatalogNegotiationRefusedError + | CatalogHandleRejectedError + | CatalogInvalidRequestError + | CatalogAuthenticationRequiredError + | CatalogPolicyRejectedError + | CatalogNetworkFailureError + | CatalogUnsafeRetrievalError + | CatalogMalformedCardError + | CatalogContractViolationError + | CatalogUnavailableTransportError + | CatalogNotInstallableError + | CatalogUnavailableError; +/** + * MCP server configuration (stdio, remote HTTP/SSE, or in-process) + * + * This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema + * via the `definition` "McpServerConfig". + */ +/** @experimental */ +export type McpServerConfig = (McpServerConfigStdio | McpServerConfigHttp) | undefined; +/** + * 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. + * + * This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema + * via the `definition` "McpSamplingExecutionAction". + */ +/** @experimental */ +export type McpSamplingExecutionAction = + /** The sampling inference completed and produced a result. */ | "success" /** The sampling inference failed or was rejected. */ | "failure" /** The sampling inference was cancelled before completion. */ | "cancelled"; +/** + * In-process MCP transport type. + * + * This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema + * via the `definition` "McpServerConfigMemoryType". + */ +/** @experimental */ +/** @internal */ +export type McpServerConfigMemoryType = "memory"; /** * 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". * @@ -1023,6 +2097,63 @@ 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`. */ @@ -1195,6 +2326,23 @@ 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. * @@ -1334,7 +2482,9 @@ export type PermissionDecisionApproveForSessionApproval = | PermissionDecisionApproveForSessionApprovalMemory | PermissionDecisionApproveForSessionApprovalCustomTool | PermissionDecisionApproveForSessionApprovalExtensionManagement - | PermissionDecisionApproveForSessionApprovalExtensionPermissionAccess; + | PermissionDecisionApproveForSessionApprovalFactory + | PermissionDecisionApproveForSessionApprovalExtensionPermissionAccess + | PermissionDecisionApproveForSessionApprovalExtensionEnvAccess; /** * Approval to persist for this location * @@ -1351,7 +2501,71 @@ export type PermissionDecisionApproveForLocationApproval = | PermissionDecisionApproveForLocationApprovalMemory | PermissionDecisionApproveForLocationApprovalCustomTool | PermissionDecisionApproveForLocationApprovalExtensionManagement - | PermissionDecisionApproveForLocationApprovalExtensionPermissionAccess; + | PermissionDecisionApproveForLocationApprovalFactory + | PermissionDecisionApproveForLocationApprovalExtensionPermissionAccess + | PermissionDecisionApproveForLocationApprovalExtensionEnvAccess; +/** + * 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 assisted-approval judge recommendation. */ + | "assisted_approval" + /** 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" + /** An Agent Client Protocol host. */ + | "acp" + /** A generic Copilot SDK client. */ + | "sdk"; +/** + * Response capability available to the client when it settled a permission request. + * + * This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema + * via the `definition` "PermissionResponseCapability". + */ +/** @experimental */ +export type PermissionResponseCapability = + /** The client could ask a user for this decision. */ + | "interactive" + /** The client could return an automated response but could not ask a user. */ + | "headless" + /** The client had no response path available. */ + | "none"; /** * Tool approval to persist and apply * @@ -1368,7 +2582,9 @@ export type PermissionsLocationsAddToolApprovalDetails = | PermissionsLocationsAddToolApprovalDetailsMemory | PermissionsLocationsAddToolApprovalDetailsCustomTool | PermissionsLocationsAddToolApprovalDetailsExtensionManagement - | PermissionsLocationsAddToolApprovalDetailsExtensionPermissionAccess; + | PermissionsLocationsAddToolApprovalDetailsFactory + | PermissionsLocationsAddToolApprovalDetailsExtensionPermissionAccess + | PermissionsLocationsAddToolApprovalDetailsExtensionEnvAccess; /** * Whether the location is a git repo or directory * @@ -1381,6 +2597,24 @@ export type PermissionLocationType = | "repo" /** The permission location is persisted at the working directory. */ | "dir"; +/** + * Optional source for permission-mode telemetry. Defaults to `rpc` when omitted for SDK callers. + * + * This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema + * via the `definition` "PermissionModeSource". + */ +/** @experimental */ +export type PermissionModeSource = + /** The mode was set from a CLI command-line flag. */ + | "cli_flag" + /** The mode was set by a slash command. */ + | "slash_command" + /** The mode was set by confirming autopilot behavior. */ + | "autopilot_confirmation" + /** The mode was set at startup by the `defaultPermissionMode` user setting. */ + | "user_setting" + /** The mode was set through an RPC caller. */ + | "rpc"; /** * Allowed values for the `PermissionsConfigureAdditionalContentExclusionPolicyScope` enumeration. * @@ -1409,34 +2643,65 @@ export type PermissionsModifyRulesScope = * Optional source for allow-all telemetry. Defaults to `rpc` when omitted for SDK callers. * * This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema - * via the `definition` "PermissionsSetAllowAllSource". + * via the `definition` "PermissionsSetApproveAllSource". */ /** @experimental */ -export type PermissionsSetAllowAllSource = +export type PermissionsSetApproveAllSource = /** Allow-all was enabled from a CLI command-line flag. */ | "cli_flag" /** Allow-all was enabled by a slash command. */ | "slash_command" /** Allow-all was enabled by confirming autopilot behavior. */ | "autopilot_confirmation" + /** Allow-all was enabled at startup by the `defaultPermissionMode` user setting. */ + | "user_setting" /** Allow-all was enabled through an RPC caller. */ | "rpc"; /** - * Optional source for allow-all telemetry. Defaults to `rpc` when omitted for SDK callers. + * Optional flags controlling which side effects the reload performs. * * This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema - * via the `definition` "PermissionsSetApproveAllSource". + * via the `definition` "PluginsReloadRequest". */ /** @experimental */ -export type PermissionsSetApproveAllSource = - /** Allow-all was enabled from a CLI command-line flag. */ - | "cli_flag" - /** Allow-all was enabled by a slash command. */ - | "slash_command" - /** Allow-all was enabled by confirming autopilot behavior. */ - | "autopilot_confirmation" - /** Allow-all was enabled through an RPC caller. */ - | "rpc"; +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; + }; +/** + * Controls whether the runtime may defer loading an external tool definition. + * + * This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema + * via the `definition` "ProtocolExternalToolDefer". + */ +/** @experimental */ +export type ProtocolExternalToolDefer = + /** The runtime may defer the tool according to its tool-loading policy. */ + | "auto" + /** The runtime must include the tool without deferring it. */ + | "never"; /** * Provider family. Matches the `type` field of a BYOK provider config. * @@ -1475,6 +2740,23 @@ export type ProviderEndpointTransport = | "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; + }; /** * Attachment union accepted by push input, covering files, directories, GitHub objects, blobs, snippets, and extension context. * @@ -1512,6 +2794,34 @@ export type PushAttachmentGitHubReferenceType = | "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. + * + * This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema + * via the `definition` "SendMode". + */ +/** @experimental */ +export type SendMode = + /** Append the message to the normal session queue. */ + | "enqueue" + /** Interject the message during the in-progress turn. */ + | "immediate"; /** * Whether this item is a queued user message or a queued slash command / model change * @@ -1550,6 +2860,22 @@ export type RemoteSessionMode = | "export" /** Enable both remote session export and remote steering. */ | "on"; +/** + * What a remote host says one of its sessions is doing right now. Deliberately coarse: this is what a host can report for EVERY session in a catalogue listing, without a client subscribing to each one. AHP's `SessionSummary.status` is the source today; `input-needed` covers both a permission prompt and an `ask_user` question, since the summary does not say which. + * + * This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema + * via the `definition` "RemoteSessionHostStatus". + */ +/** @experimental */ +export type RemoteSessionHostStatus = + /** No turn is running. */ + | "idle" + /** A turn is running. */ + | "working" + /** The session is blocked on the user: a permission prompt or an `ask_user` question. */ + | "input-needed" + /** The session ended its last turn in an error. */ + | "error"; /** * Whether the remote task originated from CCA or CLI `--remote`. * @@ -1563,33 +2889,36 @@ export type RemoteSessionMetadataTaskType = /** CLI remote task. */ | "cli"; /** - * The UI mode the agent was in when this message was sent. Defaults to the session's current mode. + * Origin of the sandbox choice supplied by an internal client. * * This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema - * via the `definition` "SendAgentMode". + * via the `definition` "SandboxConfigSource". */ /** @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"; +/** @internal */ +export type SandboxConfigSource = + /** The client applied the default because no sandbox preference was configured. */ + | "never_configured" + /** The user's persisted settings enabled the sandbox. */ + | "user_enabled" + /** The user's persisted settings disabled the sandbox. */ + | "user_disabled" + /** A command-line flag selected the sandbox state for this session. */ + | "session_flag" + /** The user disabled the sandbox for the current session. */ + | "session_disabled" + /** The client disabled the sandbox because the host cannot enforce it. */ + | "unsupported_host" + /** A repository policy selected the sandbox state. */ + | "repository_policy"; /** - * How to deliver the message. `enqueue` (default) appends to the message queue. `immediate` interjects during an in-progress turn. + * Current authentication information, or null when no authentication is active. * * This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema - * via the `definition` "SendMode". + * via the `definition` "SessionAuthInfoResult". */ /** @experimental */ -export type SendMode = - /** Append the message to the normal session queue. */ - | "enqueue" - /** Interject the message during the in-progress turn. */ - | "immediate"; +export type SessionAuthInfoResult = AuthIdentity | null; /** * Session capability enabled for this session * @@ -1670,6 +2999,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) * @@ -1682,6 +3025,100 @@ export type SessionInstalledPluginSource = | 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; + /** + * Prediction result variant discriminator. + */ + kind: "available"; + } + | { + reason: SessionLimitPredictionUnavailableReason; + /** + * Prediction result variant discriminator. + */ + 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. * @@ -1762,6 +3199,30 @@ export type SessionOpenOptionsReasoningSummary = | "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. * @@ -1863,6 +3324,21 @@ export type SessionsOpenProgressStatus = | "in-progress" /** The step has completed successfully. */ | "complete"; +/** + * Authentication credentials accepted by session.gitHubAuth.setCredentials. Session-owned token-provider identities cannot be installed through this method. + * + * This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema + * via the `definition` "SettableAuthInfo". + */ +/** @experimental */ +export type SettableAuthInfo = + | HMACAuthInfo + | EnvAuthInfo + | SettableTokenAuthInfo + | CopilotApiTokenAuthInfo + | UserAuthInfo + | GhCliAuthInfo + | ApiKeyAuthInfo; /** * Rust-owned settings predicates exposed across the SDK boundary. Raw feature-flag names are intentionally not part of the contract. * @@ -1976,7 +3452,11 @@ export type SlashCommandInvocationResult = | SlashCommandTextResult | SlashCommandAgentPromptResult | SlashCommandCompletedResult - | SlashCommandSelectSubcommandResult; + | SlashCommandSelectSubcommandResult + | SlashCommandAddTimelineEntryResult + | SlashCommandShowDialogResult + | SlashCommandSetModelResult + | SlashCommandSetPlanModelResult; /** * Subagent settings to apply, or null to clear the live session override * @@ -2076,6 +3556,32 @@ export type TaskShellInfoAttachmentMode = */ /** @experimental */ export type TaskProgress = (TaskAgentProgress | TaskShellProgress) | null; +/** + * Canonical result returned by a session tool. + * + * This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema + * via the `definition` "ToolResult". + */ +/** @experimental */ +export type ToolResult = string | ToolResultExpanded; +/** + * Execution outcome classification. + * + * This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema + * via the `definition` "ToolResultType". + */ +/** @experimental */ +export type ToolResultType = + /** The tool completed successfully. */ + | "success" + /** The tool failed. */ + | "failure" + /** The tool exceeded its execution timeout. */ + | "timeout" + /** The tool request was rejected before execution. */ + | "rejected" + /** Permission policy denied the tool request. */ + | "denied"; /** * User's choice for auto-mode switching: yes (allow this turn), yes_always (allow + persist as setting), or no (decline). * @@ -2240,6 +3746,38 @@ export type WorkspacesWorkspaceDetailsHostType = */ /** @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; +/** + * Authentication accounts available to the internal session host. + * + * This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema + * via the `definition` "SessionGitHubAuthGetAllAuthAvailableResult". + */ +/** @experimental */ +export type SessionGitHubAuthGetAllAuthAvailableResult = SessionAuthStatus[]; +/** + * Whether the current authentication was logged out. + * + * This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema + * via the `definition` "SessionGitHubAuthLogoutResult". + */ +/** @experimental */ +export type SessionGitHubAuthLogoutResult = boolean; +/** + * Whether the requested authentication was logged out. + * + * This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema + * via the `definition` "SessionGitHubAuthLogoutUserResult". + */ +/** @experimental */ +export type SessionGitHubAuthLogoutUserResult = boolean; /** * Parameters for aborting the current turn @@ -2269,7 +3807,7 @@ export interface AbortResult { error?: string; } /** - * Authenticated account entry returned by `account.getAllUsers`, with auth info and an optional associated token. + * Authenticated account entry returned by `account.getAllUsers`. * * This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema * via the `definition` "AccountAllUsers". @@ -2277,13 +3815,17 @@ export interface AbortResult { /** @experimental */ export interface AccountAllUsers { authInfo: AuthInfo; + /** + * Opaque identifier accepted by account and model selection APIs + */ + selectionId?: string; /** * Associated token, if available */ token?: string; } /** - * Authentication-info variant for GitHub-internal HMAC auth, carrying the public GitHub host and HMAC secret. + * Authentication-info input 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` "HMACAuthInfo". @@ -2365,6 +3907,9 @@ export interface CopilotUserResponse { [k: string]: unknown | undefined; } | ({ + /** + * GitHub login of the organization. + */ login?: | ( | { @@ -2373,6 +3918,9 @@ export interface CopilotUserResponse { | string ) | null; + /** + * Display name of the organization. + */ name?: | ( | { @@ -2461,10 +4009,26 @@ export interface CopilotUserResponse { */ /** @experimental */ export interface CopilotUserResponseEndpoints { + /** + * Copilot API endpoint URL. + */ api?: string; + /** + * Origin-tracker endpoint URL. + */ "origin-tracker"?: string; + /** + * Copilot proxy endpoint URL. + */ proxy?: string; + /** + * Copilot telemetry endpoint URL. + */ telemetry?: string; + /** + * Experimental-service endpoint URL. + */ + exp?: string; } /** * Quota snapshot map from the raw Copilot user-response passthrough, with chat, completions, premium-interactions, and other entries. @@ -2666,7 +4230,7 @@ export interface CopilotUserResponseQuotaSnapshotsPremiumInteractions { token_based_billing?: boolean; } /** - * Authentication-info variant for a token sourced from an environment variable, with host, optional login, token, and env var name. + * Authentication-info input 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". @@ -2696,7 +4260,7 @@ export interface EnvAuthInfo { copilotUser?: CopilotUserResponse; } /** - * Authentication-info variant for SDK-configured token authentication, carrying host and the secret token value. + * Authentication-info input 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". @@ -2715,6 +4279,32 @@ export interface TokenAuthInfo { * The token value itself. Treat as a secret. */ token: string; + /** + * Opaque native GitHub credential registration backing this token identity, when applicable. + */ + registrationId?: string; + copilotUser?: CopilotUserResponse; +} +/** + * Authentication-info variant backed by an SDK GitHub token callback. It carries routing metadata but never a plaintext token. + * + * This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema + * via the `definition` "TokenProviderAuthInfo". + */ +/** @experimental */ +export interface TokenProviderAuthInfo { + /** + * SDK callback-backed GitHub token authentication. + */ + type: "token-provider"; + /** + * Authentication host. + */ + host: string; + /** + * Opaque SDK callback registration identifier. + */ + registrationId: string; copilotUser?: CopilotUserResponse; } /** @@ -2758,7 +4348,7 @@ export interface UserAuthInfo { copilotUser?: CopilotUserResponse; } /** - * Authentication-info variant for GitHub CLI credentials, carrying host, login, and the `gh auth token` value. + * Authentication-info input 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". @@ -2784,7 +4374,7 @@ export interface GhCliAuthInfo { copilotUser?: CopilotUserResponse; } /** - * Authentication-info variant for API-key authentication to a non-GitHub LLM provider, carrying the secret `apiKey` and host. + * Authentication-info input 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". @@ -2823,7 +4413,11 @@ export interface AccountGetCurrentAuthResult { /** @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. + * Opaque account identifier returned by `account.getAllUsers`. When omitted, the current account is used. + */ + selectionId?: string; + /** + * GitHub token accepted for compatibility with existing SDK clients. When provided, resolves this token instead of using the current account. */ gitHubToken?: string; } @@ -2884,7 +4478,7 @@ export interface AccountQuotaSnapshot { resetDate?: string; } /** - * Credentials to store after successful authentication + * Credentials to validate and store. Omit login to resolve the authenticated user from the token. * * This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema * via the `definition` "AccountLoginRequest". @@ -2896,9 +4490,9 @@ export interface AccountLoginRequest { */ host: string; /** - * User login/username + * User login/username. When omitted, the runtime validates the token and resolves the login from GitHub. */ - login: string; + login?: string; /** * GitHub authentication token */ @@ -2917,16 +4511,6 @@ export interface AccountLoginResult { */ 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 * @@ -2989,7 +4573,7 @@ export interface AgentGetCurrentResult { agent?: AgentInfo | null; } /** - * Custom agent metadata, including identifiers, display details, source, tools, model, MCP servers, skills, and file path. + * 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". @@ -2997,7 +4581,7 @@ export interface AgentGetCurrentResult { /** @experimental */ export interface AgentInfo { /** - * Unique identifier of the custom agent + * Name of the agent. Use `id` as the stable selection identifier. */ name: string; /** @@ -3026,7 +4610,7 @@ export interface AgentInfo { */ tools?: string[]; /** - * 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. */ model?: string; /** @@ -3035,15 +4619,19 @@ export interface AgentInfo { * @experimental */ mcpServers?: { - [k: string]: unknown | undefined; + [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; } /** - * Custom agents available to the session. + * Agents available to the session. * * This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema * via the `definition` "AgentList". @@ -3051,7 +4639,7 @@ export interface AgentInfo { /** @experimental */ export interface AgentList { /** - * Available custom agents + * Available agents */ agents: AgentInfo[]; } @@ -3080,12 +4668,6 @@ export interface AgentRegistryLiveTargetEntry { * 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 */ @@ -3125,6 +4707,12 @@ export interface AgentRegistryLiveTargetEntry { * Wall-clock milliseconds since the watcher last observed this entry (heartbeat freshness) */ lastSeenMs: number; + /** + * Connection token (null when the target is unauthenticated) + * + * @internal + */ + token?: string | null; } /** * Per-spawn log-capture outcome; populated from spawnLiveTarget. @@ -3312,6 +4900,23 @@ export interface AgentSelectRequest { 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. * @@ -3330,126 +4935,234 @@ export interface AgentsGetDiscoveryPathsRequest { excludeHostAgents?: boolean; } /** - * Indicates whether the operation succeeded and reports the post-mutation state. + * Credential-free authentication identity safe to expose to hosts and user interfaces. * * This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema - * via the `definition` "AllowAllPermissionSetResult". + * via the `definition` "AuthIdentity". */ /** @experimental */ -export interface AllowAllPermissionSetResult { +export interface AuthIdentity { + type: AuthInfoType; /** - * Whether the operation succeeded + * Authentication host */ - success: boolean; + host: string; /** - * Authoritative full allow-all state after the mutation + * Authenticated login, when available */ - 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 { + login?: string; /** - * Whether full allow-all permissions are currently active + * Name of the environment variable that supplied the credential, when applicable */ - enabled: boolean; - mode?: PermissionsAllowAllMode; + envVar?: string; + /** + * Opaque SDK GitHub credential registration backing this identity. Routing metadata only; never a credential. + */ + registrationId?: string; + copilotUser?: CopilotUserResponse; } /** - * Cancellation result for a user-requested shell command. + * Validation error from an authentication attempt. * * This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema - * via the `definition` "CancelUserRequestedShellCommandResult". + * via the `definition` "AuthValidationError". */ /** @experimental */ -export interface CancelUserRequestedShellCommandResult { +export interface AuthValidationError { /** - * Whether an in-flight execution was found and signalled to cancel + * Authentication validation error message */ - cancelled: boolean; + message: string; + /** + * Optional message returned by GitHub + */ + githubMessage?: string; } /** - * Canvas action that the agent or host can invoke. To discover the input schema for a particular action, call the list_canvas_capabilities tool. + * 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` "CanvasAction". + * via the `definition` "BuiltInModelCatalog". */ /** @experimental */ -export interface CanvasAction { +export interface BuiltInModelCatalog { /** - * Action name exposed by the canvas provider - */ - name: string; - /** - * Description of the action + * Built-in model entries. */ - description?: string; - inputSchema?: CanvasJsonSchema; + models: BuiltInModelCatalogEntry[]; } /** - * JSON Schema for canvas open input + * A well-known model in the runtime's built-in catalog. * * This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema - * via the `definition` "CanvasJsonSchema". + * via the `definition` "BuiltInModelCatalogEntry". */ /** @experimental */ -export interface CanvasJsonSchema { - [k: string]: unknown | undefined; +export interface BuiltInModelCatalogEntry { + /** + * Well-known runtime model ID suitable for provider or provider-model metadata. This is not necessarily the provider-facing deployment or model name and does not indicate CAPI entitlement or provider availability. + */ + id: string; } /** - * Canvas action invocation parameters. + * Rust-owned metadata and input schema for a built-in tool. * * This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema - * via the `definition` "CanvasActionInvokeRequest". + * via the `definition` "BuiltinToolDescriptor". */ /** @experimental */ -export interface CanvasActionInvokeRequest { +export interface BuiltinToolDescriptor { /** - * Open canvas instance identifier + * Stable name used to invoke the built-in tool. */ - instanceId: string; + name: string; /** - * Action name to invoke + * Optional human-readable title for the tool. */ - actionName: string; + title: string | null; /** - * Action input + * Model-facing description of the tool's behavior. */ - input?: { - [k: string]: unknown | undefined; - }; + description: string; + /** + * JSON Schema for the tool input, or null when the tool uses a custom format. + */ + inputSchema: BuiltinToolInputSchema | null; + /** + * Optional supplemental usage instructions for the tool. + */ + instructions: string | null; + /** + * Optional tool category discriminator. + */ + type: string | null; + /** + * Optional custom input format used instead of a JSON Schema. + */ + format: BuiltinToolFormat | null; + safeForTelemetry: BuiltinToolSafeForTelemetry; + /** + * Whether the tool executes commands in a terminal. + */ + isTerminal: boolean; + /** + * Whether the tool provides a specialized intention summary. + */ + hasSummariseIntention: boolean; } /** - * Provider-supplied action result. + * JSON Schema object accepted by a built-in tool. * * This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema - * via the `definition` "CanvasActionInvokeResult". + * via the `definition` "BuiltinToolInputSchema". */ /** @experimental */ -export interface CanvasActionInvokeResult { - [k: string]: unknown | undefined; +export interface BuiltinToolInputSchema { + type: BuiltinToolInputSchemaType; + [k: string]: JsonValue | undefined; } /** - * Canvas close parameters. + * Custom grammar input format accepted by a built-in tool. * * This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema - * via the `definition` "CanvasCloseRequest". + * via the `definition` "BuiltinToolFormat". */ /** @experimental */ -export interface CanvasCloseRequest { +export interface BuiltinToolFormat { + type: BuiltinToolFormatType; /** - * Open canvas instance identifier + * Grammar syntax used by the format definition. */ - instanceId: string; + syntax: string; + /** + * Grammar definition accepted by the tool. + */ + definition: string; } /** - * Host context supplied by the runtime. + * Per-field telemetry-safety policy for a built-in tool. + * + * This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema + * via the `definition` "BuiltinToolSafeTelemetryFields". + */ +/** @experimental */ +export interface BuiltinToolSafeTelemetryFields { + /** + * Whether the tool name may be included in telemetry without obfuscation. + */ + name?: boolean; + /** + * Whether tool input names may be included in telemetry without obfuscation. + */ + inputsNames?: boolean; +} +/** + * 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". @@ -3578,9 +5291,7 @@ export interface OpenCanvasInstance { /** * Input supplied when the instance was opened */ - input?: { - [k: string]: unknown | undefined; - }; + input?: JsonValue; } /** * Canvas open parameters. @@ -3605,9 +5316,7 @@ export interface CanvasOpenRequest { /** * Canvas open input */ - input?: { - [k: string]: unknown | undefined; - }; + input?: JsonValue; } /** * Canvas close parameters sent to the provider. @@ -3680,9 +5389,7 @@ export interface CanvasProviderInvokeActionRequest { /** * Action input */ - input?: { - [k: string]: unknown | undefined; - }; + input?: JsonValue; host?: CanvasHostContext; session?: CanvasSessionContext; } @@ -3713,9 +5420,7 @@ export interface CanvasProviderOpenRequest { /** * Canvas open input */ - input?: { - [k: string]: unknown | undefined; - }; + input?: JsonValue; host?: CanvasHostContext; session?: CanvasSessionContext; } @@ -3740,6 +5445,40 @@ export interface CanvasProviderOpenResult { */ status?: string; } +/** + * Internal canvas provider registration parameters. + * + * This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema + * via the `definition` "CanvasProviderRegisterRequest". + */ +/** @experimental */ +export interface CanvasProviderRegisterRequest { + /** + * Connection identifier for callback routing + */ + connectionId: string; + /** + * Provider metadata supplied by the host + */ + info: JsonValue; + /** + * Canvas contributions supplied by the provider + */ + canvases: JsonValue[]; +} +/** + * Internal canvas provider unregistration parameters. + * + * This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema + * via the `definition` "CanvasProviderUnregisterRequest". + */ +/** @experimental */ +export interface CanvasProviderUnregisterRequest { + /** + * Connection identifier to unregister + */ + connectionId: string; +} /** * Options scoped to the built-in CAPI (Copilot API) provider. * @@ -3754,5034 +5493,8151 @@ export interface CapiSessionOptions { enableWebSocketResponses?: boolean; } /** - * Slash commands available in the session, after applying any include/exclude filters. + * Semantic digest of a strictly parsed and schema-validated JSON MCP card. Both URL-backed and embedded cards are canonicalised with RFC 8785 JSON Canonicalization Scheme, encoded as UTF-8, and hashed with SHA-256. * * This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema - * via the `definition` "CommandList". + * via the `definition` "CardDigest". */ /** @experimental */ -export interface CommandList { - /** - * Commands available in this session - */ - commands: SlashCommandInfo[]; +export interface CardDigest { + algorithm: CardDigestAlgorithm; + value: CardDigestValue; } /** - * Slash-command metadata with name, aliases, description, kind, input hint, execution allowance, and schedulability. + * An inert AI skill catalog result. AI skills are discovery-only and cannot be represented as installable through this surface. * * This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema - * via the `definition` "SlashCommandInfo". + * via the `definition` "CatalogAiSkillCandidate". */ /** @experimental */ -export interface SlashCommandInfo { +export interface CatalogAiSkillCandidate { /** - * Canonical command name without a leading slash + * Opaque, runtime-instance scoped, TTL-bound, single-use handle for this candidate. Carries no readable information and is rejected when stale, replayed, or presented to a different runtime instance. Never logged. */ - name: string; + handle: string; /** - * Canonical aliases without leading slashes + * ISO 8601 timestamp after which the handle is stale and will be rejected. */ - aliases?: string[]; + handleExpiresAt: string; /** - * Human-readable command description + * Discriminator: this candidate describes an AI skill */ - description: string; - kind: SlashCommandKind; - input?: SlashCommandInput; + kind: "ai-skill"; /** - * Whether the command may run while an agent turn is active + * Media type of the underlying AI skill card */ - allowDuringAgentExecution: boolean; + mediaType: "application/ai-skill"; /** - * Whether the command is experimental + * AI skills are discovery-only and cannot be installed through this surface */ - experimental?: boolean; + installability: "not-installable-kind"; /** - * 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. + * Display name taken verbatim from the card. Inert untrusted text. */ - schedulable?: boolean; + displayName: string; + /** + * Description taken verbatim from the card. Inert untrusted text. + */ + description?: string; + /** + * Publisher taken verbatim from the card. Inert untrusted text. + */ + publisher?: string; + source: CatalogCandidateSource; + provenance: CatalogAiSkillCandidateProvenance; } /** - * Optional unstructured input hint + * Candidate whose card is retrieved from a URL through the runtime's hardened fetch boundary. * * This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema - * via the `definition` "SlashCommandInput". + * via the `definition` "CatalogCandidateSourceUrl". */ /** @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[]; +export interface CatalogCandidateSourceUrl { /** - * When true, the command requires non-empty input; clients should render the input hint as required + * Discriminator: the card is URL-backed, and carries no embedded data */ - required?: boolean; - completion?: SlashCommandInputCompletion; + kind: "url"; /** - * When true, clients should pass the full text after the command name as a single argument rather than splitting on whitespace + * Card URL as advertised. Inert untrusted data: the runtime retrieves it only through its own hardened boundary, and it is never logged. */ - preserveMultilineInput?: boolean; + url: string; } /** - * A literal choice the command input accepts, with a human-facing description + * Candidate whose card reference arrived inline. The document and its content-derived properties stay behind the runtime boundary. * * This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema - * via the `definition` "SlashCommandInputChoice". + * via the `definition` "CatalogCandidateSourceEmbedded". */ /** @experimental */ -export interface SlashCommandInputChoice { - /** - * The literal choice value (e.g. 'on', 'off', 'show') - */ - name: string; +export interface CatalogCandidateSourceEmbedded { /** - * Human-readable description shown alongside the choice + * Discriminator: the card is embedded, and carries no URL */ - description: string; + kind: "embedded"; } /** - * Pending command request ID and an optional error if the client handler failed. + * Where and when an AI skill catalog reference was observed. Discovery provenance deliberately carries no content digest because search does not establish the exact validated content a later plan will bind. * * This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema - * via the `definition` "CommandsHandlePendingCommandRequest". + * via the `definition` "CatalogAiSkillCandidateProvenance". */ /** @experimental */ -export interface CommandsHandlePendingCommandRequest { +export interface CatalogAiSkillCandidateProvenance { /** - * Request ID from the command invocation event + * Host of the catalog authority that advertised the reference, without path, query, or credentials. Inert untrusted data. */ - requestId: string; + authority: string; /** - * Error message if the command handler failed + * ISO 8601 timestamp at which the runtime observed the catalog reference. This is not a retrieval or validation timestamp. */ - error?: string; + observedAt: string; + /** + * Media type advertised for the referenced AI skill card + */ + mediaType: "application/ai-skill"; } /** - * Indicates whether the pending client-handled command was completed successfully. + * An optional catalog authentication exchange did not establish the caller's identity. Anonymous search remains supported; this refusal is reserved for an operation that cannot continue after the attempted exchange. It is distinct from `policy-rejected` and from a network failure, and the reason identifies the recovery action. * * This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema - * via the `definition` "CommandsHandlePendingCommandResult". + * via the `definition` "CatalogAuthenticationRequiredError". */ /** @experimental */ -export interface CommandsHandlePendingCommandResult { +export interface CatalogAuthenticationRequiredError { /** - * Whether the command was handled successfully + * Discriminator: the caller is not authenticated */ - success: boolean; + kind: "authentication-required"; + reason: CatalogAuthenticationRequiredReason; + /** + * Human-readable explanation, safe to surface. Never contains a credential or token, nor a query, URL, handle, or secret. + */ + message: string; } /** - * Slash command name and optional raw input string to invoke. + * An inert MCP server catalog result. Every free-text field is untrusted external data and must never be treated as an instruction, and the handle is the only way to refer to the candidate in a later operation. * * This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema - * via the `definition` "CommandsInvokeRequest". + * via the `definition` "CatalogMcpServerCandidate". */ /** @experimental */ -export interface CommandsInvokeRequest { +export interface CatalogMcpServerCandidate { /** - * Command name. Leading slashes are stripped and the name is matched case-insensitively. + * Opaque, runtime-instance scoped, TTL-bound, single-use handle for this candidate. Carries no readable information and is rejected when stale, replayed, or presented to a different runtime instance. Never logged. */ - name: string; + handle: string; /** - * Raw input after the command name + * ISO 8601 timestamp after which the handle is stale and will be rejected. */ - input?: string; + handleExpiresAt: string; + /** + * Discriminator: this candidate describes an MCP server + */ + kind: "mcp-server"; + mediaType: McpServerCardMediaType; + installability: CatalogMcpServerInstallability; + /** + * Display name taken verbatim from the card. Inert untrusted text. + */ + displayName: string; + /** + * Description taken verbatim from the card. Inert untrusted text. + */ + description?: string; + /** + * Publisher taken verbatim from the card. Inert untrusted text. + */ + publisher?: string; + source: CatalogCandidateSource; + provenance: CatalogMcpServerCandidateProvenance; } /** - * Optional filters controlling which command sources to include in the listing. + * Where and when an MCP server catalog reference was observed. Discovery provenance deliberately carries no content digest because search does not establish the exact validated content a later plan will bind. * * This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema - * via the `definition` "CommandsListRequest". + * via the `definition` "CatalogMcpServerCandidateProvenance". */ /** @experimental */ -export interface CommandsListRequest { - /** - * Include runtime built-in commands - */ - includeBuiltins?: boolean; +export interface CatalogMcpServerCandidateProvenance { /** - * Include enabled user-invocable skills and commands + * Host of the catalog authority that advertised the reference, without path, query, or credentials. Inert untrusted data. */ - includeSkills?: boolean; + authority: string; /** - * Include commands registered by protocol clients, including SDK clients and extensions + * ISO 8601 timestamp at which the runtime observed the catalog reference. This is not a retrieval or validation timestamp. */ - includeClientCommands?: boolean; + observedAt: string; + mediaType: McpServerCardMediaType; } /** - * Queued-command request ID and the result indicating whether the host executed it (and whether to stop processing further queued commands). + * The protocol version and capability set a caller requires, supplied on every catalog request so negotiation cannot be skipped by omission. * * This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema - * via the `definition` "CommandsRespondToQueuedCommandRequest". + * via the `definition` "CatalogClientContract". */ /** @experimental */ -export interface CommandsRespondToQueuedCommandRequest { +export interface CatalogClientContract { /** - * Request ID from the `command.queued` event the host is responding to. + * SDK protocol version the caller was generated against. A caller below the runtime's minimum supported version is refused rather than served a partial result. */ - requestId: string; - result: QueuedCommandResult; + protocolVersion: number; + /** + * Wire features the caller requires the runtime to understand. Identifiers are bounded but extensible so a newer caller can negotiate with an older runtime. Requiring an unknown feature yields a typed refusal listing what is understood, never a partial grant. A grant does not promise that a deployment has enabled the operation; typed unavailable results report that separately. + * + * @maxItems 32 + */ + requiredCapabilities: CatalogCapabilityId[]; } /** - * Queued-command response indicating the host executed the command, with an optional flag to stop queue processing. + * An upstream catalog response broke the wire contract. Most importantly, every result must carry exactly one of a URL or embedded data: a result carrying both, or neither, is refused here rather than being guessed at. * * This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema - * via the `definition` "QueuedCommandHandled". + * via the `definition` "CatalogContractViolationError". */ /** @experimental */ -export interface QueuedCommandHandled { +export interface CatalogContractViolationError { /** - * The host actually executed the queued command. + * Discriminator: the upstream response broke the contract */ - handled: true; + kind: "contract-violation"; + reason: CatalogContractViolationReason; /** - * When true, the runtime will not process subsequent queued commands until a new request comes in. + * Human-readable explanation, safe to surface. Never echoes response content, nor a query, URL, handle, or secret. */ - stopProcessingQueue?: boolean; + message: string; } /** - * Queued-command response indicating the host did not execute the command and the queue may continue. + * A presented handle was not accepted. Handles are runtime-instance scoped, TTL-bound, and single-use, so each way of failing is reported distinctly. * * This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema - * via the `definition` "QueuedCommandNotHandled". + * via the `definition` "CatalogHandleRejectedError". */ /** @experimental */ -export interface QueuedCommandNotHandled { +export interface CatalogHandleRejectedError { /** - * 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). + * Discriminator: a handle was rejected */ - handled: false; + kind: "handle-rejected"; + handleType: CatalogHandleType; + reason: CatalogHandleRejectionReason; + /** + * Human-readable explanation, safe to surface. Never contains the handle itself, nor a query, URL, or secret. + */ + message: string; } /** - * Indicates whether the queued-command response was matched to a pending request. + * The request was rejected before any work was done, because a bounded field fell outside its permitted range or a required field was unusable. * * This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema - * via the `definition` "CommandsRespondToQueuedCommandResult". + * via the `definition` "CatalogInvalidRequestError". */ /** @experimental */ -export interface CommandsRespondToQueuedCommandResult { +export interface CatalogInvalidRequestError { /** - * Whether a pending queued command with the given request ID was found and resolved. False when the request was already resolved, cancelled, or unknown. + * Discriminator: the request itself was invalid */ - success: boolean; + kind: "invalid-request"; + field: CatalogInvalidRequestField; + /** + * Human-readable explanation, safe to surface. Never echoes the offending value, nor a query, URL, handle, or secret. + */ + message: string; } /** - * 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`). + * A card could not be parsed or did not satisfy its declared media type's schema. * * This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema - * via the `definition` "CompletionsGetTriggerCharactersResult". + * via the `definition` "CatalogMalformedCardError". */ /** @experimental */ -export interface CompletionsGetTriggerCharactersResult { +export interface CatalogMalformedCardError { /** - * Trigger characters advertised by the host (e.g. `["@", "#"]`). Empty disables host-driven completions for the session. + * Discriminator: the card was malformed */ - triggerCharacters: string[]; + kind: "malformed-card"; + reason: CatalogMalformedCardReason; + mediaType?: CatalogMediaType; + /** + * Human-readable explanation, safe to surface. Never echoes card content, nor a query, URL, handle, or secret. + */ + message: string; } /** - * Request host-driven completions for the current composer input. + * The protocol version and capability set the runtime actually honoured for a successful catalog operation. * * This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema - * via the `definition` "CompletionsRequestRequest". + * via the `definition` "CatalogNegotiatedContract". */ /** @experimental */ -export interface CompletionsRequestRequest { +export interface CatalogNegotiatedContract { /** - * The full composed composer input. + * Protocol version of the runtime that served the request. */ - text: string; + runtimeProtocolVersion: number; /** - * Cursor offset within `text`, in UTF-16 code units. + * Wire features the runtime understood for this operation. Always a superset of the caller's required features, because any shortfall is a refusal instead. Operation availability remains a separate typed result. */ - offset: number; + grantedCapabilities: CatalogCapability[]; } /** - * Host-driven completion items for the current composer input. Empty when the host returns no items or does not support completions. + * The caller's protocol version or required capabilities cannot be honoured. Returned instead of a partial or ambiguous success. * * This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema - * via the `definition` "CompletionsRequestResult". + * via the `definition` "CatalogNegotiationRefusedError". */ /** @experimental */ -export interface CompletionsRequestResult { +export interface CatalogNegotiationRefusedError { /** - * Completion items in host-ranked order. + * Discriminator: capability or protocol-version negotiation failed */ - 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 { + kind: "negotiation-refused"; + reason: CatalogNegotiationRefusedReason; /** - * Text spliced into the composer when the item is accepted. + * Protocol version of the runtime that refused the request. */ - insertText: string; + runtimeProtocolVersion: number; /** - * Start of the replacement range in `text`, in UTF-16 code units. + * Lowest caller protocol version this runtime will serve. */ - rangeStart?: number; + minimumSupportedProtocolVersion: number; /** - * End (exclusive) of the replacement range in `text`, in UTF-16 code units. + * Every wire feature this runtime understands, so the caller can retry within that contract. This list does not imply that every deployment has enabled every operation. */ - rangeEnd?: number; + supportedCapabilities: CatalogCapability[]; /** - * Primary display label for the picker row. Falls back to `insertText` when absent. + * The subset of the caller's bounded extensible capability identifiers this runtime cannot honour. + * + * @maxItems 32 */ - label?: string; + unsupportedCapabilities: CatalogCapabilityId[]; /** - * Render-kind hint for the picker row (e.g. `"document"`, `"directory"`), derived from the host's display kind. + * Human-readable explanation, safe to surface. Never contains a query, URL, handle, or secret. */ - kind?: string; + message: string; } /** - * Params to attach or detach an in-process ExtensionController delegate. + * The runtime could not reach the catalog authority or retrieve a card. Covers being offline as well as transport-level failure. * * This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema - * via the `definition` "ConfigureSessionExtensionsParams". + * via the `definition` "CatalogNetworkFailureError". */ /** @experimental */ -/** @internal */ -export interface ConfigureSessionExtensionsParams { +export interface CatalogNetworkFailureError { /** - * Session to attach the extension controller delegate to. + * Discriminator: the network operation failed */ - sessionId: string; + kind: "network-failure"; + reason: CatalogNetworkFailureReason; /** - * 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 + * HTTP status code, when the failure was a rejected response. */ - controller?: { - [k: string]: unknown | undefined; - }; + statusCode?: number; + /** + * Human-readable explanation, safe to surface. Never contains a query, URL, handle, or secret. + */ + message: string; } /** - * Metadata for a connected remote session. + * The candidate is discoverable but cannot be installed. `application/ai-skill` resolves here, because it stays searchable while remaining typed non-installable. * * This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema - * via the `definition` "ConnectedRemoteSessionMetadata". + * via the `definition` "CatalogNotInstallableError". */ /** @experimental */ -export interface ConnectedRemoteSessionMetadata { - /** - * SDK session ID for the connected remote session. - */ - sessionId: string; - /** - * Optional friendly session name. - */ - name?: string; +export interface CatalogNotInstallableError { /** - * Optional session summary. + * Discriminator: the candidate cannot be installed */ - summary?: string; + kind: "not-installable"; + reason: CatalogNotInstallableReason; /** - * Session start time as an ISO 8601 string. + * Human-readable explanation, safe to surface. Never contains a query, URL, handle, or secret. */ - startTime: string; + message: string; +} +/** + * Registry or enterprise policy refused the operation. + * + * This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema + * via the `definition` "CatalogPolicyRejectedError". + */ +/** @experimental */ +export interface CatalogPolicyRejectedError { /** - * Last session update time as an ISO 8601 string. + * Discriminator: policy refused the operation */ - modifiedTime: string; - repository: ConnectedRemoteSessionMetadataRepository; + kind: "policy-rejected"; + source: McpPlanPolicySource; /** - * Pull request number associated with the session. + * Human-readable explanation, safe to surface. Never contains a query, URL, handle, or secret. */ - pullRequestNumber?: number; + message: string; +} +/** + * A bounded catalog search. Both the query length and the result count are capped by the schema so a caller cannot request an unbounded scan. + * + * This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema + * via the `definition` "CatalogSearchRequest". + */ +/** @experimental */ +export interface CatalogSearchRequest { + contract: CatalogClientContract; /** - * Original remote resource identifier. + * Free-text search query. Never written to logs or telemetry. */ - resourceId?: string; - kind: ConnectedRemoteSessionMetadataKind; + query: string; /** - * Remote session staleness deadline as an ISO 8601 string. + * Maximum number of candidates to return. Defaults to 10 when omitted. */ - staleAt?: string; + limit?: number; /** - * Remote session state returned by the backing service. + * Restrict results to these candidate kinds. When omitted, every kind the runtime supports is searched. + * + * @minItems 1 + * @maxItems 2 */ - state?: string; + kinds?: [CatalogCandidateKind] | [CatalogCandidateKind, CatalogCandidateKind]; } /** - * Repository associated with the connected remote session. + * A completed catalog search: inert candidate summaries, each carrying a single-use handle. * * This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema - * via the `definition` "ConnectedRemoteSessionMetadataRepository". + * via the `definition` "CatalogSearchSucceeded". */ /** @experimental */ -export interface ConnectedRemoteSessionMetadataRepository { +export interface CatalogSearchSucceeded { /** - * Repository owner or organization login. + * Discriminator: the search completed */ - owner: string; + kind: "succeeded"; /** - * Repository name. + * Pseudonymous identifier for this search, issued by the runtime or by the catalog authority it queried and never by the caller, so it cannot be forged or replayed to attribute an install to a search that never happened. Always present on a success, so a result set can be tied to the installs it leads to. It identifies a search rather than a person: it is derived from no user, account, device, or query data, and must never be joined with user identity to re-identify anyone. */ - name: string; + searchId: string; /** - * Branch associated with the remote session. + * Matching candidates, never more than the requested limit. All text is inert untrusted data. + * + * @maxItems 50 */ - branch: string; + candidates: CatalogCandidate[]; + /** + * Whether further matches existed beyond the requested limit. + */ + truncated: boolean; + negotiated: CatalogNegotiatedContract; } /** - * Remote session connection parameters. + * The request asked for a candidate kind this runtime does not serve. * * This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema - * via the `definition` "ConnectRemoteSessionParams". + * via the `definition` "CatalogUnsupportedKindError". */ /** @experimental */ -export interface ConnectRemoteSessionParams { +export interface CatalogUnsupportedKindError { /** - * Session ID to connect to. + * Discriminator: an unsupported candidate kind was requested */ - sessionId: string; + kind: "unsupported-kind"; + /** + * The kinds from the request that are not supported. + */ + requestedKinds: CatalogCandidateKind[]; + /** + * Every candidate kind this runtime can serve. + */ + supportedKinds: CatalogCandidateKind[]; + /** + * Human-readable explanation, safe to surface. Never contains a query, URL, handle, or secret. + */ + message: string; } /** - * Parameters for the `server.connect` handshake: an optional connection token and optional connection-level opt-ins (e.g. GitHub telemetry forwarding). + * Retrieval was refused by the runtime's hardened fetch boundary before any request left the process, or before a redirect was followed. * * This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema - * via the `definition` "ConnectRequest". + * via the `definition` "CatalogUnsafeRetrievalError". */ /** @experimental */ -/** @internal */ -export interface ConnectRequest { +export interface CatalogUnsafeRetrievalError { /** - * Connection token; required when the server was started with COPILOT_CONNECTION_TOKEN + * Discriminator: retrieval was refused as unsafe */ - token?: string; + kind: "unsafe-retrieval"; + reason: CatalogUnsafeRetrievalReason; /** - * 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, in addition to the runtime's normal GitHub/CTS emission (dual-write). 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. + * Human-readable explanation, safe to surface. Never contains the refused URL, nor a query, handle, or secret. */ - enableGitHubTelemetryForwarding?: boolean; + message: string; } /** - * Handshake result reporting the server's protocol version and package version on success. + * The operation is not available on this runtime. Distinct from a network failure: nothing was attempted. * * This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema - * via the `definition` "ConnectResult". + * via the `definition` "CatalogUnavailableError". */ /** @experimental */ -/** @internal */ -export interface ConnectResult { - /** - * Always true on success - */ - ok: true; +export interface CatalogUnavailableError { /** - * Server protocol version number + * Discriminator: the operation is not available */ - protocolVersion: number; + kind: "unavailable"; + reason: CatalogUnavailableReason; /** - * Server package version + * Human-readable explanation, safe to surface. Never contains a query, URL, handle, or secret. */ - version: string; + message: string; } /** - * A single large message currently in context. + * No transport this runtime can use is available for the requested server. * * This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema - * via the `definition` "ContextHeaviestMessage". + * via the `definition` "CatalogUnavailableTransportError". */ /** @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; +export interface CatalogUnavailableTransportError { /** - * Role of the chat message (`user`, `assistant`, or `tool`). + * Discriminator: no usable transport is available */ - role: string; + kind: "unavailable-transport"; + reason: CatalogUnavailableTransportReason; /** - * Token count currently in context for this individual message. + * Human-readable explanation, safe to surface. Never contains a query, URL, handle, or secret. */ - tokens: number; + message: string; } /** - * 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. + * Slash commands available in the session, after applying any include/exclude filters. * * This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema - * via the `definition` "CurrentModel". + * via the `definition` "CommandList". */ /** @experimental */ -export interface CurrentModel { - /** - * Currently active model identifier - */ - modelId?: string; +export interface CommandList { /** - * 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. + * Commands available in this session */ - reasoningEffort?: string; - contextTier?: ContextTier; + commands: SlashCommandInfo[]; } /** - * Lightweight metadata for a currently initialized session tool + * 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` "CurrentToolMetadata". + * via the `definition` "SlashCommandInfo". */ /** @experimental */ -export interface CurrentToolMetadata { +export interface SlashCommandInfo { /** - * Model-facing tool name + * Canonical command name without a leading slash */ name: string; /** - * Optional MCP/config namespaced tool name - */ - namespacedName?: string; - /** - * MCP server name for MCP-backed tools + * Canonical aliases without leading slashes */ - mcpServerName?: string; + aliases?: string[]; /** - * Raw MCP tool name for MCP-backed tools + * Human-readable command description */ - mcpToolName?: string; + description: string; + kind: SlashCommandKind; + input?: SlashCommandInput; /** - * Tool description + * Whether the command may run while an agent turn is active */ - description: string; + allowDuringAgentExecution: boolean; /** - * JSON Schema for tool input + * Whether the command is experimental */ - input_schema?: { - [k: string]: unknown | undefined; - }; + experimental?: boolean; /** - * Whether the tool is loaded on demand via tool search + * 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. */ - deferLoading?: boolean; + schedulable?: boolean; } /** - * A file included in the redacted debug bundle. + * Optional unstructured input hint * * This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema - * via the `definition` "DebugCollectLogsCollectedEntry". + * via the `definition` "SlashCommandInput". */ /** @experimental */ -export interface DebugCollectLogsCollectedEntry { +export interface SlashCommandInput { /** - * Relative path of the file in the staged bundle/archive. + * Hint to display when command input has not been provided */ - bundlePath: string; - source: DebugCollectLogsSource; + hint: string; /** - * Redacted output size in bytes. + * Optional literal choices the input accepts, each with a human-facing description; clients may render these as selectable options */ - sizeBytes: number; + 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 caller-provided server-local file or directory to include in the debug bundle. + * A literal choice the command input accepts, with a human-facing description * * This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema - * via the `definition` "DebugCollectLogsEntry". + * via the `definition` "SlashCommandInputChoice". */ /** @experimental */ -export interface DebugCollectLogsEntry { - kind: DebugCollectLogsEntryKind; - /** - * Server-local source path to read. - */ - path: string; +export interface SlashCommandInputChoice { /** - * Relative path to use inside the staged bundle/archive. + * The literal choice value (e.g. 'on', 'off', 'show') */ - bundlePath: string; - redaction?: DebugCollectLogsRedaction; + name: string; /** - * When true, collection fails if this entry cannot be read. Defaults to false, which records the entry in `skippedEntries`. + * Human-readable description shown alongside the choice */ - required?: boolean; + description: string; } /** - * Built-in session diagnostics to include in the bundle. Omitted fields default to true. + * The pending slash-command invocation effect to finalize, plus whether the host applied or cancelled it. * * This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema - * via the `definition` "DebugCollectLogsInclude". + * via the `definition` "CommandsFinalizeInvocationEffectRequest". */ /** @experimental */ -export interface DebugCollectLogsInclude { +export interface CommandsFinalizeInvocationEffectRequest { /** - * Include the session event log (`events.jsonl`). Defaults to true. + * The slash-command result object that produced the pending effect, echoed back unchanged. */ - events?: boolean; + effect: {}; + outcome: CommandsInvocationEffectOutcome; +} +/** + * Whether finalizing the invocation effect succeeded, and the failure reason when it did not. + * + * This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema + * via the `definition` "CommandsFinalizeInvocationEffectResult". + */ +/** @experimental */ +export interface CommandsFinalizeInvocationEffectResult { /** - * Include process logs for the session. Defaults to true. + * Whether the pending invocation effect was finalized successfully. */ - processLogs?: boolean; + success: boolean; /** - * Include interactive shell logs written under the session's `shell-logs` directory. Defaults to true. + * Failure reason when the invocation effect could not be finalized. */ - 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; + error?: 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 { /** - * Server-local process log directory to search when `currentProcessLogPath` is unavailable, useful for collecting logs for inactive sessions. + * Request ID from the command invocation event */ - processLogDirectory?: string; + requestId: string; /** - * Maximum number of previous process logs to include. Defaults to 5. + * Error message if the command handler failed */ - previousProcessLogLimit?: number; + error?: string; } /** - * Options for collecting a redacted session debug bundle. + * Indicates whether the pending client-handled command was completed successfully. * * This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema - * via the `definition` "DebugCollectLogsRequest". + * via the `definition` "CommandsHandlePendingCommandResult". */ /** @experimental */ -export interface DebugCollectLogsRequest { - destination: DebugCollectLogsDestination; - include?: DebugCollectLogsInclude; +export interface CommandsHandlePendingCommandResult { /** - * 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. + * Whether the command was handled successfully */ - additionalEntries?: DebugCollectLogsEntry[]; + success: boolean; } /** - * Result of collecting a redacted debug bundle. + * Slash command name and optional raw input string to invoke. * * This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema - * via the `definition` "DebugCollectLogsResult". + * via the `definition` "CommandsInvokeRequest". */ /** @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; +export interface CommandsInvokeRequest { /** - * Files included in the redacted bundle. + * Command name. Leading slashes are stripped and the name is matched case-insensitively. */ - entries: DebugCollectLogsCollectedEntry[]; + name: string; /** - * Optional files or directories that could not be included. + * Raw input after the command name */ - skippedEntries?: DebugCollectLogsSkippedEntry[]; + input?: string; + origin?: CommandsInvocationOrigin; } /** - * An optional debug bundle entry that could not be included. + * 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` "DebugCollectLogsSkippedEntry". + * via the `definition` "CommandsRespondToQueuedCommandRequest". */ /** @experimental */ -export interface DebugCollectLogsSkippedEntry { - /** - * Relative path requested for this bundle entry. - */ - bundlePath: string; - /** - * Server-local source path that could not be read. - */ - path?: string; +export interface CommandsRespondToQueuedCommandRequest { /** - * Reason the entry was skipped. + * Request ID from the `command.queued` event the host is responding to. */ - reason: string; + requestId: string; + result: QueuedCommandResult; } /** - * MCP server discovered by `mcp.discover`, with config source, optional plugin source, transport type, and enabled state. + * 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` "DiscoveredMcpServer". + * via the `definition` "QueuedCommandHandled". */ /** @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; +export interface QueuedCommandHandled { /** - * Plugin version that provided this server, when source is plugin. + * The host actually executed the queued command. */ - sourcePluginVersion?: string; + handled: true; /** - * Whether the server is enabled (not in the disabled list) + * When true, the runtime will not process subsequent queued commands until a new request comes in. */ - enabled: boolean; + stopProcessingQueue?: boolean; } /** - * Slash-prefixed command string to enqueue for FIFO processing. + * 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` "EnqueueCommandParams". + * via the `definition` "QueuedCommandNotHandled". */ /** @experimental */ -export interface EnqueueCommandParams { +export interface QueuedCommandNotHandled { /** - * 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. + * 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). */ - command: string; + handled: false; } /** - * Indicates whether the command was accepted into the local execution queue. + * Indicates whether the queued-command response was matched to a pending request. * * This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema - * via the `definition` "EnqueueCommandResult". + * via the `definition` "CommandsRespondToQueuedCommandResult". */ /** @experimental */ -export interface EnqueueCommandResult { +export interface CommandsRespondToQueuedCommandResult { /** - * 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). + * Whether a pending queued command with the given request ID was found and resolved. False when the request was already resolved, cancelled, or unknown. */ - queued: boolean; + success: boolean; } /** - * Cursor, batch size, and optional long-poll/filter parameters for reading session events. + * 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` "EventLogReadRequest". + * via the `definition` "CompletionsGetTriggerCharactersResult". */ /** @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; +export interface CompletionsGetTriggerCharactersResult { /** - * 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). + * Trigger characters advertised by the host (e.g. `["@", "#"]`). Empty disables host-driven completions for the session. */ - waitMs?: number; - types?: EventLogTypes; - agentScope?: EventsAgentScope; + triggerCharacters: string[]; } /** - * Indicates whether the operation succeeded. + * Request host-driven completions for the current composer input. * * This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema - * via the `definition` "EventLogReleaseInterestResult". + * via the `definition` "CompletionsRequestRequest". */ /** @experimental */ -export interface EventLogReleaseInterestResult { +export interface CompletionsRequestRequest { /** - * Whether the operation succeeded + * The full composed composer input. */ - success: boolean; + text: string; + /** + * Cursor offset within `text`, in UTF-16 code units. + */ + offset: number; } /** - * 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). + * 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` "EventLogTailResult". + * via the `definition` "CompletionsRequestResult". */ /** @experimental */ -export interface EventLogTailResult { +export interface CompletionsRequestResult { /** - * 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). + * Completion items in host-ranked order. */ - cursor: string; + items: SessionCompletionItem[]; } /** - * Batch of session events returned by a read, with cursor and continuation metadata. + * 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` "EventsReadResult". + * via the `definition` "SessionCompletionItem". */ /** @experimental */ -export interface EventsReadResult { +export interface SessionCompletionItem { /** - * 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. + * Text spliced into the composer when the item is accepted. */ - events: SessionEvent[]; + insertText: string; /** - * 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. + * Start of the replacement range in `text`, in UTF-16 code units. */ - cursor: string; + rangeStart?: number; /** - * 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. + * End (exclusive) of the replacement range in `text`, in UTF-16 code units. */ - 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 { + rangeEnd?: number; /** - * Name of the slash command to invoke (without the leading '/'). + * Primary display label for the picker row. Falls back to `insertText` when absent. */ - commandName: string; + label?: string; /** - * Argument string to pass to the command (empty string if none). + * Render-kind hint for the picker row (e.g. `"document"`, `"directory"`), derived from the host's display kind. */ - args: string; + kind?: string; } /** - * Error message produced while executing the command, if any. + * Params to attach or detach an in-process ExtensionController delegate. * * This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema - * via the `definition` "ExecuteCommandResult". + * via the `definition` "ConfigureSessionExtensionsParams". */ /** @experimental */ -export interface ExecuteCommandResult { +/** @internal */ +export interface ConfigureSessionExtensionsParams { /** - * Error message produced while executing the command, if any. Omitted when the handler succeeded. + * Session to attach the extension controller delegate to. */ - error?: string; + 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; } /** - * Discovered extension metadata, including source-qualified ID, name, discovery source, status, and optional process ID. + * Identity of the integrating host, declared once on the `server.connect` handshake so telemetry from this connection is attributed to a single, consistent surface. All fields are optional; omit them to keep the default attribution. * * This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema - * via the `definition` "Extension". + * via the `definition` "ConnectClientInfo". */ /** @experimental */ -export interface Extension { +/** @internal */ +export interface ConnectClientInfo { /** - * Source-qualified ID (e.g., 'project:my-ext', 'user:auth-helper', 'plugin:my-plugin:my-ext') + * Name of the host editor, e.g. `"vscode"`. */ - id: string; + editorName?: string; /** - * Extension name (directory name) + * Version of the host editor, e.g. `"1.124.2"`. Ignored unless it looks like a version string. */ - name: string; - source: ExtensionSource; - status: ExtensionStatus; + editorVersion?: string; /** - * Process ID if the extension is running + * Name of the Copilot extension within the host, e.g. `"copilot-chat"`. */ - pid?: number; + extensionName?: string; + /** + * Version of the Copilot extension within the host, e.g. `"0.54.0"`. Ignored unless it looks like a version string. + */ + extensionVersion?: string; } /** - * Slim input shape for extension_context attachments; identity fields are runtime-derived. + * Metadata for a connected remote session. * * This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema - * via the `definition` "ExtensionContextPushInput". + * via the `definition` "ConnectedRemoteSessionMetadata". */ /** @experimental */ -export interface ExtensionContextPushInput { +export interface ConnectedRemoteSessionMetadata { /** - * Attachment type discriminator + * SDK session ID for the connected remote session. */ - type: "extension_context"; + sessionId: string; /** - * Human-readable composer pill label + * Optional friendly session name. */ - title: string; + name?: string; /** - * Caller-supplied JSON payload (required, may be null but not undefined) + * Optional session summary. */ - payload: { - [k: string]: unknown | undefined; - }; -} -/** - * 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 { + summary?: string; /** - * Discovered extensions and their current status + * Session start time as an ISO 8601 string. */ - extensions: Extension[]; + 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; } /** - * Source-qualified extension identifier to disable for the session. + * Repository associated with the connected remote session. * * This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema - * via the `definition` "ExtensionsDisableRequest". + * via the `definition` "ConnectedRemoteSessionMetadataRepository". */ /** @experimental */ -export interface ExtensionsDisableRequest { +export interface ConnectedRemoteSessionMetadataRepository { /** - * Source-qualified extension ID to disable + * Repository owner or organization login. */ - id: string; + owner: string; + /** + * Repository name. + */ + name: string; + /** + * Branch associated with the remote session. + */ + branch: string; } /** - * Source-qualified extension identifier to enable for the session. + * Remote session connection parameters. * * This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema - * via the `definition` "ExtensionsEnableRequest". + * via the `definition` "ConnectRemoteSessionParams". */ /** @experimental */ -export interface ExtensionsEnableRequest { +export interface ConnectRemoteSessionParams { /** - * Source-qualified extension ID to enable + * Session ID to connect to. */ - id: string; + sessionId: string; } /** - * Expanded external tool result payload + * Connection-level opt-ins for the `server.connect` handshake. Transport authentication is consumed by the native protocol boundary before dispatch. * * This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema - * via the `definition` "ExternalToolTextResultForLlm". + * via the `definition` "ConnectRequest". */ /** @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; - }; - /** - * Base64-encoded binary results returned to the model - */ - binaryResultsForLlm?: ExternalToolTextResultForLlmBinaryResultsForLlm[]; +/** @internal */ +export interface ConnectRequest { /** - * Structured content blocks from the tool + * 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. */ - contents?: ExternalToolTextResultForLlmContent[]; + enableGitHubTelemetryForwarding?: boolean; + clientInfo?: ConnectClientInfo; /** - * 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. + * Connection token; required when the server was started with COPILOT_CONNECTION_TOKEN */ - toolReferences?: string[]; + token?: string; } /** - * Binary result returned by a tool for the model + * 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` "ExternalToolTextResultForLlmBinaryResultsForLlm". + * via the `definition` "ConnectResult". */ /** @experimental */ -export interface ExternalToolTextResultForLlmBinaryResultsForLlm { - type: ExternalToolTextResultForLlmBinaryResultsForLlmType; - /** - * Base64-encoded binary data - */ - data: string; +/** @internal */ +export interface ConnectResult { /** - * MIME type of the binary data + * Always true on success */ - mimeType: string; + ok: true; /** - * Human-readable description of the binary data + * Server protocol version number */ - description?: string; + protocolVersion: number; /** - * Optional metadata from the producing tool. + * Server package version */ - metadata?: { - [k: string]: unknown | undefined; - }; + version: string; } /** - * Plain text content block + * 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` "ExternalToolTextResultForLlmContentText". + * via the `definition` "ContentExclusionCheckPathsRequest". */ /** @experimental */ -export interface ExternalToolTextResultForLlmContentText { - /** - * Content block type discriminator - */ - type: "text"; +export interface ContentExclusionCheckPathsRequest { /** - * The text content + * Local file system absolute paths within the session working directory to check. Results are returned in the same order, including duplicates. */ - text: string; + paths: string[]; } /** - * Terminal/shell output content block with optional exit code and working directory + * 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` "ExternalToolTextResultForLlmContentTerminal". + * via the `definition` "ContentExclusionCheckPathsResult". */ /** @experimental */ -export interface ExternalToolTextResultForLlmContentTerminal { - /** - * Content block type discriminator - */ - type: "terminal"; +export interface ContentExclusionCheckPathsResult { /** - * Terminal/shell output text - */ - text: string; - /** - * Process exit code, if the command has completed + * 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. */ - exitCode?: number; + available: boolean; /** - * Working directory where the command was executed + * Per-path decisions in request order. Empty when available is false. */ - cwd?: string; + checks: ContentExclusionPathCheck[]; } /** - * Shell command exit metadata with optional output preview + * Content-exclusion decision for one requested path. * * This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema - * via the `definition` "ExternalToolTextResultForLlmContentShellExit". + * via the `definition` "ContentExclusionPathCheck". */ /** @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; +export interface ContentExclusionPathCheck { /** - * Output associated with this shell command, if available. May be partial, truncated, or a preview; not guaranteed to be full output. + * The path supplied by the caller. */ - outputPreview?: string; + path: string; /** - * Whether outputPreview is known to be incomplete or truncated + * Whether the session's complete content-exclusion policy excludes the path. */ - outputTruncated?: boolean; + excluded: boolean; } /** - * Image content block with base64-encoded data + * A single large message currently in context. * * This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema - * via the `definition` "ExternalToolTextResultForLlmContentImage". + * via the `definition` "ContextHeaviestMessage". */ /** @experimental */ -export interface ExternalToolTextResultForLlmContentImage { +export interface ContextHeaviestMessage { /** - * Content block type discriminator + * Stable identifier for this message within the snapshot. */ - type: "image"; + id: string; /** - * Base64-encoded image data + * Human-readable source label, e.g. `tool: bash` or `skill: tmux`. Presentation-only. */ - data: string; + label: string; /** - * MIME type of the image (e.g., image/png, image/jpeg) + * Role of the chat message (`user`, `assistant`, or `tool`). */ - mimeType: string; + role: string; + /** + * Token count currently in context for this individual message. + */ + tokens: number; } /** - * Audio content block with base64-encoded data + * 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` "ExternalToolTextResultForLlmContentAudio". + * via the `definition` "CurrentModel". */ /** @experimental */ -export interface ExternalToolTextResultForLlmContentAudio { - /** - * Content block type discriminator - */ - type: "audio"; +export interface CurrentModel { /** - * Base64-encoded audio data + * Currently active model identifier */ - data: string; + modelId?: string; /** - * MIME type of the audio (e.g., audio/wav, audio/mpeg) + * 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. */ - mimeType: string; + reasoningEffort?: string; + contextTier?: ContextTier; } /** - * Resource link content block referencing an external resource + * Lightweight metadata for a currently initialized session tool * * This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema - * via the `definition` "ExternalToolTextResultForLlmContentResourceLink". + * via the `definition` "CurrentToolMetadata". */ /** @experimental */ -export interface ExternalToolTextResultForLlmContentResourceLink { - /** - * Icons associated with this resource - */ - icons?: ExternalToolTextResultForLlmContentResourceLinkIcon[]; +export interface CurrentToolMetadata { /** - * Resource name identifier + * Model-facing tool name */ name: string; /** - * Human-readable display title for the resource + * Optional MCP/config namespaced tool name */ - title?: string; + namespacedName?: string; /** - * URI identifying the resource + * MCP server name for MCP-backed tools */ - uri: string; + mcpServerName?: string; /** - * Human-readable description of the resource + * Raw MCP tool name for MCP-backed tools */ - description?: string; + mcpToolName?: string; /** - * MIME type of the resource content + * Tool description */ - mimeType?: string; + description: string; /** - * Size of the resource in bytes + * JSON Schema for tool input */ - size?: number; + input_schema?: { + [k: string]: JsonValue | undefined; + }; /** - * Content block type discriminator + * Whether the tool is loaded on demand via tool search */ - type: "resource_link"; + deferLoading?: boolean; } /** - * Icon image for a resource + * A file included in the redacted debug bundle. * * This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema - * via the `definition` "ExternalToolTextResultForLlmContentResourceLinkIcon". + * via the `definition` "DebugCollectLogsCollectedEntry". */ /** @experimental */ -export interface ExternalToolTextResultForLlmContentResourceLinkIcon { +export interface DebugCollectLogsCollectedEntry { /** - * URL or path to the icon image + * Relative path of the file in the staged bundle/archive. */ - src: string; - /** - * MIME type of the icon image - */ - mimeType?: string; + bundlePath: string; + source: DebugCollectLogsSource; /** - * Available icon sizes (e.g., ['16x16', '32x32']) + * Redacted output size in bytes. */ - sizes?: string[]; - theme?: ExternalToolTextResultForLlmContentResourceLinkIconTheme; + sizeBytes: number; } /** - * Embedded resource content block with inline text or binary data + * 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` "ExternalToolTextResultForLlmContentResource". + * via the `definition` "DebugCollectLogsEntry". */ /** @experimental */ -export interface ExternalToolTextResultForLlmContentResource { +export interface DebugCollectLogsEntry { + kind: DebugCollectLogsEntryKind; /** - * Content block type discriminator + * Server-local source path to read. */ - 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 { + path: string; /** - * Target session identifier + * Relative path to use inside the staged bundle/archive. */ - sessionId: string; + bundlePath: string; + redaction?: DebugCollectLogsRedaction; /** - * Factory run identifier. + * When true, collection fails if this entry cannot be read. Defaults to false, which records the entry in `skippedEntries`. */ - runId: string; + required?: boolean; } /** - * 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. + * 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` "FactoryAgentOptions". + * via the `definition` "DebugCollectLogsInclude". */ /** @experimental */ -export interface FactoryAgentOptions { +export interface DebugCollectLogsInclude { /** - * Optional label distinguishing otherwise identical memoized agent calls. + * Include the session event log (`events.jsonl`). Defaults to true. */ - label?: string; + events?: boolean; /** - * Optional JSON Schema for structured agent output. + * Include process logs for the session. Defaults to true. */ - schema?: { - [k: string]: unknown | undefined; - }; + processLogs?: boolean; /** - * Optional model identifier for the subagent. + * Include interactive shell logs written under the session's `shell-logs` directory. Defaults to true. */ - model?: string; + 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; } /** - * Parameters for one factory-scoped subagent call. + * Options for collecting a redacted session debug bundle. * * This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema - * via the `definition` "FactoryAgentRequest". + * via the `definition` "DebugCollectLogsRequest". */ /** @experimental */ -export interface FactoryAgentRequest { - /** - * Factory run identifier that owns the subagent. - */ - factoryRunId: string; +export interface DebugCollectLogsRequest { + destination: DebugCollectLogsDestination; + include?: DebugCollectLogsInclude; /** - * Prompt to send to the subagent. + * 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. */ - prompt: string; - opts: FactoryAgentOptions; + additionalEntries?: DebugCollectLogsEntry[]; } /** - * Result of one factory-scoped subagent call. + * Result of collecting a redacted debug bundle. * * This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema - * via the `definition` "FactoryAgentResult". + * via the `definition` "DebugCollectLogsResult". */ /** @experimental */ -export interface FactoryAgentResult { +export interface DebugCollectLogsResult { + kind: DebugCollectLogsResultKind; /** - * Agent result, omitted when the agent produced no result. + * 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. */ - result?: { - [k: string]: unknown | undefined; - }; + path: string; + /** + * Files included in the redacted bundle. + */ + entries: DebugCollectLogsCollectedEntry[]; + /** + * Optional files or directories that could not be included. + */ + skippedEntries?: DebugCollectLogsSkippedEntry[]; } /** - * Parameters for cancelling a factory run. + * An optional debug bundle entry that could not be included. * * This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema - * via the `definition` "FactoryCancelRequest". + * via the `definition` "DebugCollectLogsSkippedEntry". */ /** @experimental */ -export interface FactoryCancelRequest { +export interface DebugCollectLogsSkippedEntry { /** - * Factory run identifier. + * Relative path requested for this bundle entry. */ - runId: string; + bundlePath: string; + /** + * Server-local source path that could not be read. + */ + path?: string; + /** + * Reason the entry was skipped. + */ + reason: string; } /** - * Parameters sent to the owning extension to execute a factory closure. + * Discovered extension metadata and persistent enablement state. * * This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema - * via the `definition` "FactoryExecuteRequest". + * via the `definition` "DiscoveredExtension". */ /** @experimental */ -export interface FactoryExecuteRequest { +export interface DiscoveredExtension { /** - * Target session identifier + * Source-qualified ID accepted by both server and session extension enablement methods */ - sessionId: string; + id: string; /** - * Registered factory name. + * Human-readable extension name */ name: string; /** - * Factory run identifier. + * Absolute path to the extension entry module, suitable for revealing it in a file manager */ - runId: string; + path: string; + source: DiscoveredExtensionSource; /** - * Factory input value. + * Whether this extension's persistent per-ID preference is enabled */ - args: { - [k: string]: unknown | undefined; - }; + enabled: boolean; + plugin?: DiscoveredExtensionPlugin; } /** - * Result returned by an extension factory closure. + * Installed plugin that contributes a discovered extension. * * This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema - * via the `definition` "FactoryExecuteResult". + * via the `definition` "DiscoveredExtensionPlugin". */ /** @experimental */ -export interface FactoryExecuteResult { +export interface DiscoveredExtensionPlugin { /** - * Factory result value. + * Installed plugin name */ - result: { - [k: string]: unknown | undefined; - }; + name: string; } /** - * Parameters for retrieving a factory run. + * 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` "FactoryGetRunRequest". + * via the `definition` "DiscoveredExtensions". */ /** @experimental */ -export interface FactoryGetRunRequest { +export interface DiscoveredExtensions { /** - * Factory run identifier. + * Discovered user and enabled installed-plugin extensions from persisted Copilot home state */ - runId: string; + extensions: DiscoveredExtension[]; + mode: DiscoveredExtensionMode; } /** - * Parameters for reading a factory journal entry. + * Source-qualified extension identifiers to persistently disable for future sessions. * * This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema - * via the `definition` "FactoryJournalGetRequest". + * via the `definition` "DiscoveredExtensionsDisableRequest". */ /** @experimental */ -export interface FactoryJournalGetRequest { - /** - * Factory run identifier. - */ - runId: string; +export interface DiscoveredExtensionsDisableRequest { /** - * Namespaced journal key. + * Source-qualified user or plugin extension IDs to disable */ - key: string; + ids: string[]; } /** - * Result of reading a factory journal entry. + * Source-qualified extension identifiers to persistently enable for future sessions. * * This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema - * via the `definition` "FactoryJournalGetResult". + * via the `definition` "DiscoveredExtensionsEnableRequest". */ /** @experimental */ -export interface FactoryJournalGetResult { +export interface DiscoveredExtensionsEnableRequest { /** - * Whether the journal contained the requested key. - */ - hit: boolean; - /** - * Cached JSON result. The hit field distinguishes a cached JSON null from a miss. + * Source-qualified user or plugin extension IDs to enable */ - resultJson?: { - [k: string]: unknown | undefined; - }; + ids: string[]; } /** - * Parameters for storing a factory journal entry. + * 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` "FactoryJournalPutRequest". + * via the `definition` "DiscoveredMcpServer". */ /** @experimental */ -export interface FactoryJournalPutRequest { +export interface DiscoveredMcpServer { /** - * Factory run identifier. + * Server name (config key) */ - runId: string; + name: string; + type?: DiscoveredMcpServerType; + source: McpServerSource; /** - * Namespaced journal key. + * Plugin name that provided this server, when source is plugin. */ - key: string; + sourcePlugin?: string; /** - * JSON result to memoize. + * Plugin version that provided this server, when source is plugin. */ - resultJson: { - [k: string]: unknown | undefined; - }; + sourcePluginVersion?: string; + /** + * Whether the server is enabled (not in the disabled list) + */ + enabled: boolean; } /** - * One ordered factory progress line. + * Slash-prefixed command string to enqueue for FIFO processing. * * This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema - * via the `definition` "FactoryLogLine". + * via the `definition` "EnqueueCommandParams". */ /** @experimental */ -export interface FactoryLogLine { - /** - * Monotonic sequence number within the factory run. - */ - seq: number; - kind: FactoryLogLineKind; +export interface EnqueueCommandParams { /** - * Progress text. + * 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. */ - text: string; + command: string; } /** - * Parameters for recording factory progress. + * Indicates whether the command was accepted into the local execution queue. * * This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema - * via the `definition` "FactoryLogRequest". + * via the `definition` "EnqueueCommandResult". */ /** @experimental */ -export interface FactoryLogRequest { - /** - * Factory run identifier. - */ - runId: string; +export interface EnqueueCommandResult { /** - * Ordered progress lines to append. + * 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). */ - lines: FactoryLogLine[]; + queued: boolean; } /** - * Wire-only per-invocation factory resource ceiling overrides. + * 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` "FactoryRunLimits". + * via the `definition` "EventLogReadRequest". */ /** @experimental */ -export interface FactoryRunLimits { +export interface EventLogReadRequest { /** - * Maximum number of factory subagents that may run concurrently. + * Opaque cursor returned by a previous read. Omit on the first call to start from the beginning of the session's persisted history. */ - maxConcurrentSubagents?: number; + cursor?: string; /** - * Maximum total number of factory subagents that may be admitted. + * Maximum number of events to return in this batch (1–1000, default 200). */ - maxTotalSubagents?: number; + max?: number; /** - * Factory active-run timeout in milliseconds. + * 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. */ - timeout?: number; -} -/** - * Parameters for invoking a registered factory. - * - * This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema - * via the `definition` "FactoryRunRequest". - */ -/** @experimental */ -export interface FactoryRunRequest { + waitMs?: number; + types?: EventLogTypes; + agentScope?: EventsAgentScope; /** - * Registered factory name. + * 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 */ - name: string; + agentIds?: [string, ...string[]]; + direction?: EventsReadDirection; /** - * Factory input value. + * 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. */ - args: { - [k: string]: unknown | undefined; - }; - options?: RunOptions; + includeEphemeral?: boolean; } /** - * Options controlling factory invocation. + * Indicates whether the operation succeeded. * * This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema - * via the `definition` "RunOptions". + * via the `definition` "EventLogReleaseInterestResult". */ /** @experimental */ -export interface RunOptions { - limits?: FactoryRunLimits; +export interface EventLogReleaseInterestResult { /** - * Run identifier whose journal and progress should seed this resumed run. + * Whether the operation succeeded */ - resumeFromRunId?: string; + success: boolean; } /** - * Complete current or terminal factory run envelope. + * 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` "FactoryRunResult". + * via the `definition` "EventLogTailResult". */ /** @experimental */ -export interface FactoryRunResult { - /** - * Factory run identifier. - */ - runId: string; - status: FactoryRunStatus; - /** - * Completed factory result. - */ - result?: { - [k: string]: unknown | undefined; - }; - /** - * Error message for an errored run. - */ - error?: string; - failure?: FactoryRunFailure; - /** - * Reason for a halted or cancelled run. - */ - reason?: string; +export interface EventLogTailResult { /** - * Partial journal and progress snapshot for a halted, cancelled, or errored run. + * 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). */ - snapshot?: { - [k: string]: unknown | undefined; - }; + cursor: string; } /** - * Optional user prompt to combine with the fleet orchestration instructions. + * 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` "FleetStartRequest". + * via the `definition` "EventsReadResult". */ /** @experimental */ -export interface FleetStartRequest { +export interface EventsReadResult { /** - * Optional user prompt to combine with fleet instructions + * 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. */ - 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 { + events: SessionEvent[]; /** - * Whether fleet mode was successfully activated + * 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). */ - 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 { + cursor: string; /** - * Folder path to mark as trusted + * 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. */ - path: string; + hasMore: boolean; + cursorStatus: EventsCursorStatus; } /** - * Folder path to check for trust. + * Slash command name and argument string to execute synchronously. * * This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema - * via the `definition` "FolderTrustCheckParams". + * via the `definition` "ExecuteCommandParams". */ /** @experimental */ -export interface FolderTrustCheckParams { +export interface ExecuteCommandParams { /** - * Folder path to check + * Name of the slash command to invoke (without the leading '/'). */ - path: string; + commandName: string; + /** + * Argument string to pass to the command (empty string if none). + */ + args: string; } /** - * Folder trust check result. + * Error message produced while executing the command, if any. * * This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema - * via the `definition` "FolderTrustCheckResult". + * via the `definition` "ExecuteCommandResult". */ /** @experimental */ -export interface FolderTrustCheckResult { +export interface ExecuteCommandResult { /** - * Whether the folder is trusted + * Error message produced while executing the command, if any. Omitted when the handler succeeded. */ - trusted: boolean; + error?: string; } /** - * Client environment metadata describing the process that produced a telemetry event. + * 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` "GitHubTelemetryClientInfo". + * via the `definition` "Extension". */ /** @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; +export interface Extension { /** - * Name of the client application. + * Source-qualified ID (e.g., 'project:my-ext', 'user:auth-helper', 'plugin:my-plugin:my-ext') */ - client_name?: string; + id: string; /** - * Whether the user is a GitHub/Microsoft staff member. + * Extension name (directory name) */ - is_staff?: boolean; + name: string; + source: ExtensionSource; + status: ExtensionStatus; /** - * Stable machine identifier for the device. + * Process ID if the extension is running */ - dev_device_id?: string; + pid?: number; } /** - * 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. + * Slim input shape for extension_context attachments; identity fields are runtime-derived. * * This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema - * via the `definition` "GitHubTelemetryEvent". + * via the `definition` "ExtensionContextPushInput". */ /** @experimental */ -export interface GitHubTelemetryEvent { - /** - * Event type/kind (e.g. get_completion_with_tools_turn, tool_call_executed). - */ - kind: string; +export interface ExtensionContextPushInput { /** - * Timestamp when the event was created (ISO 8601 format). + * Attachment type discriminator */ - created_at?: string; + type: "extension_context"; /** - * Reference to the model call that produced this event. + * Human-readable composer pill label */ - model_call_id?: string; + title: string; /** - * String-valued properties as a map from key to value. + * Caller-supplied JSON payload (required, may be null but not undefined) */ - properties: { - [k: string]: string | 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 { /** - * Numeric metrics as a map from key to value. + * Executable used to launch the extension entrypoint. */ - metrics: { - [k: string]: number | undefined; - }; + executable: string; /** - * Experiment assignment context. + * Opaque integrator-defined arguments passed to the executable. The runtime does not append the extension entrypoint. */ - exp_assignment_context?: string; + args: string[]; /** - * Feature flags enabled for this session, as a map from flag to value. + * Opaque integrator-defined environment variables. Runtime-owned COPILOT_SDK_PATH, SESSION_ID, and COPILOT_EXTENSION_PARENT_PID values take precedence. */ - features?: { + env: { [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. + * 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` "GitHubTelemetryNotification". + * via the `definition` "ExtensionLaunchProviderResolveRequest". */ /** @experimental */ -export interface GitHubTelemetryNotification { +export interface ExtensionLaunchProviderResolveRequest { /** - * 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. + * Source-qualified extension identifier. */ - sessionId?: string; + id: string; /** - * Whether this is a restricted telemetry event (cli.restricted_telemetry). Hosts must route restricted events to first-party Microsoft stores only. + * Human-readable extension name. */ - restricted: boolean; - event: GitHubTelemetryEvent; + name: string; + /** + * Absolute path to the discovered extension entrypoint. + */ + modulePath: string; + source: ExtensionSource; } /** - * Pending external tool call request ID, with the tool result or an error describing why it failed. + * 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` "HandlePendingToolCallRequest". + * via the `definition` "ExtensionLaunchProviderResolveResult". */ /** @experimental */ -export interface HandlePendingToolCallRequest { - /** - * Request ID of the pending tool call - */ - requestId: string; - result?: ExternalToolResult; - /** - * Error message if the tool call failed - */ - error?: string; +export interface ExtensionLaunchProviderResolveResult { + launch?: ExtensionLaunchProfile; } /** - * Indicates whether the external tool call result was handled successfully. + * Extensions discovered for the session, with their current status. * * This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema - * via the `definition` "HandlePendingToolCallResult". + * via the `definition` "ExtensionList". */ /** @experimental */ -export interface HandlePendingToolCallResult { +export interface ExtensionList { /** - * Whether the tool call result was handled successfully + * Discovered extensions and their current status */ - success: boolean; + extensions: Extension[]; } /** - * Indicates whether an in-progress manual compaction was aborted. + * Source-qualified extension identifier to disable for the session. * * This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema - * via the `definition` "HistoryAbortManualCompactionResult". + * via the `definition` "ExtensionsDisableRequest". */ /** @experimental */ -export interface HistoryAbortManualCompactionResult { +export interface ExtensionsDisableRequest { /** - * 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. + * Source-qualified extension ID to disable */ - aborted: boolean; + id: string; } /** - * Indicates whether an in-progress background compaction was cancelled. + * Source-qualified extension identifier to enable for the session. * * This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema - * via the `definition` "HistoryCancelBackgroundCompactionResult". + * via the `definition` "ExtensionsEnableRequest". */ /** @experimental */ -export interface HistoryCancelBackgroundCompactionResult { +export interface ExtensionsEnableRequest { /** - * 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. + * Source-qualified extension ID to enable */ - cancelled: boolean; + id: string; } /** - * Post-compaction context window usage breakdown + * Expanded external tool result payload * * This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema - * via the `definition` "HistoryCompactContextWindow". + * via the `definition` "ExternalToolTextResultForLlm". */ /** @experimental */ -export interface HistoryCompactContextWindow { +export interface ExternalToolTextResultForLlm { /** - * Maximum token count for the model's context window + * Text result returned to the model */ - tokenLimit: number; + textResultForLlm: string; /** - * Current total tokens in the context window (system + conversation + tool definitions) + * Execution outcome classification. Optional for back-compat; normalized to 'success' (or 'failure' when error is present) when missing or unrecognized. */ - currentTokens: number; + resultType?: string; /** - * Current number of messages in the conversation + * Optional error message for failed executions */ - messagesLength: number; + error?: string; /** - * Token count from system message(s) + * Detailed log content for timeline display */ - systemTokens?: number; + sessionLog?: string; /** - * Token count from non-system messages (user, assistant, tool) + * Optional tool-specific telemetry */ - conversationTokens?: number; + toolTelemetry?: { + [k: string]: JsonValue | undefined; + }; /** - * Token count from tool definitions + * Base64-encoded binary results returned to the model */ - toolDefinitionsTokens?: number; -} -/** - * Optional compaction parameters. - * - * This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema - * via the `definition` "HistoryCompactRequest". - */ -/** @experimental */ -export interface HistoryCompactRequest { + binaryResultsForLlm?: ExternalToolTextResultForLlmBinaryResultsForLlm[]; /** - * Optional user-provided instructions to focus the compaction summary + * Structured content blocks from the tool */ - customInstructions?: string; + 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[]; } /** - * Compaction outcome with the number of tokens and messages removed, summary text, and the resulting context window breakdown. + * Binary result returned by a tool for the model * * This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema - * via the `definition` "HistoryCompactResult". + * via the `definition` "ExternalToolTextResultForLlmBinaryResultsForLlm". */ /** @experimental */ -export interface HistoryCompactResult { +export interface ExternalToolTextResultForLlmBinaryResultsForLlm { + type: ExternalToolTextResultForLlmBinaryResultsForLlmType; /** - * Whether compaction completed successfully + * Base64-encoded binary data */ - success: boolean; + data: string; /** - * Number of tokens freed by compaction + * MIME type of the binary data */ - tokensRemoved: number; + mimeType: string; /** - * Number of messages removed during compaction + * Human-readable description of the binary data */ - messagesRemoved: number; + description?: string; /** - * Summary text produced by compaction. Omitted when compaction did not produce a summary (e.g. failure path). + * Optional metadata from the producing tool. */ - summaryContent?: string; - contextWindow?: HistoryCompactContextWindow; + metadata?: { + [k: string]: JsonValue | undefined; + }; } /** - * Markdown summary of the conversation context (empty when not available). + * Plain text content block * * This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema - * via the `definition` "HistorySummarizeForHandoffResult". + * via the `definition` "ExternalToolTextResultForLlmContentText". */ /** @experimental */ -export interface HistorySummarizeForHandoffResult { +export interface ExternalToolTextResultForLlmContentText { /** - * 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. + * Content block type discriminator */ - 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 { + type: "text"; /** - * Event ID to truncate to. This event and all events after it are removed from the session. + * The text content */ - eventId: string; + text: string; } /** - * Number of events that were removed by the truncation. + * Terminal/shell output content block with optional exit code and working directory * * This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema - * via the `definition` "HistoryTruncateResult". + * via the `definition` "ExternalToolTextResultForLlmContentTerminal". */ /** @experimental */ -export interface HistoryTruncateResult { +export interface ExternalToolTextResultForLlmContentTerminal { /** - * Number of events that were removed + * Content block type discriminator */ - eventsRemoved: number; -} -/** - * 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: unknown; -} -/** - * 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?: unknown; + 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; } /** - * Installed plugin record from global state, with marketplace, version, install time, enabled state, cache path, and source. + * Shell command exit metadata with optional output preview * * This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema - * via the `definition` "InstalledPlugin". + * via the `definition` "ExternalToolTextResultForLlmContentShellExit". */ /** @experimental */ -export interface InstalledPlugin { +export interface ExternalToolTextResultForLlmContentShellExit { /** - * Plugin name + * Content block type discriminator */ - name: string; + type: "shell_exit"; /** - * Marketplace the plugin came from (empty string for direct repo installs) + * Shell id, as assigned by Copilot runtime */ - marketplace: string; + shellId: string; /** - * Version installed (if available) + * Exit code from the completed shell command */ - version?: string; + exitCode: number; /** - * Installation timestamp + * Working directory where the shell command was executed */ - installed_at: string; + cwd?: string; /** - * Whether the plugin is currently enabled + * Output associated with this shell command, if available. May be partial, truncated, or a preview; not guaranteed to be full output. */ - enabled: boolean; + outputPreview?: string; /** - * Path where the plugin is cached locally + * Whether outputPreview is known to be incomplete or truncated */ - cache_path?: string; - source?: InstalledPluginSource; -} -/** - * Source descriptor for a direct GitHub plugin install, with `owner/repo`, optional ref, and optional subpath. - * - * This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema - * via the `definition` "InstalledPluginSourceGitHub". - */ -/** @experimental */ -export interface InstalledPluginSourceGitHub { + outputTruncated?: boolean; /** - * Constant value. Always "github". + * Path reported in the shell session's filesystem namespace when shell output exceeded the configured large-output threshold. */ - source: "github"; - repo: string; - ref?: string; - path?: string; + outputFilePath?: string; } /** - * Source descriptor for a direct URL plugin install, with URL, optional ref, and optional subpath. + * Image content block with base64-encoded data * * This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema - * via the `definition` "InstalledPluginSourceUrl". + * via the `definition` "ExternalToolTextResultForLlmContentImage". */ /** @experimental */ -export interface InstalledPluginSourceUrl { +export interface ExternalToolTextResultForLlmContentImage { /** - * Constant value. Always "url". + * Content block type discriminator */ - source: "url"; - url: string; - ref?: string; - path?: string; + type: "image"; + /** + * Base64-encoded image data + */ + data: string; + /** + * MIME type of the image (e.g., image/png, image/jpeg) + */ + mimeType: string; } /** - * Source descriptor for a direct local plugin install, with a local filesystem path. + * Audio content block with base64-encoded data * * This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema - * via the `definition` "InstalledPluginSourceLocal". + * via the `definition` "ExternalToolTextResultForLlmContentAudio". */ /** @experimental */ -export interface InstalledPluginSourceLocal { +export interface ExternalToolTextResultForLlmContentAudio { /** - * Constant value. Always "local". + * Content block type discriminator */ - source: "local"; - path: string; + type: "audio"; + /** + * Base64-encoded audio data + */ + data: string; + /** + * MIME type of the audio (e.g., audio/wav, audio/mpeg) + */ + mimeType: string; } /** - * Information about an installed plugin tracked in global state. + * Resource link content block referencing an external resource * * This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema - * via the `definition` "InstalledPluginInfo". + * via the `definition` "ExternalToolTextResultForLlmContentResourceLink". */ /** @experimental */ -export interface InstalledPluginInfo { +export interface ExternalToolTextResultForLlmContentResourceLink { /** - * Plugin name + * Icons associated with this resource + */ + icons?: ExternalToolTextResultForLlmContentResourceLinkIcon[]; + /** + * Resource name identifier */ name: string; /** - * Marketplace the plugin came from. Empty string ("") for direct repo / URL / local installs. + * Human-readable display title for the resource */ - marketplace: string; + title?: 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. + * URI identifying the resource */ - directSourceId?: string; + uri: string; /** - * Installed version (when reported by the plugin manifest) + * Human-readable description of the resource */ - version?: string; + description?: string; /** - * Whether the plugin is currently enabled for new sessions + * MIME type of the resource content */ - 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; + mimeType?: string; /** - * Whether this is the canonical target to create new instructions in its tier. At most one entry per tier is preferred. + * Size of the resource in bytes */ - preferredForCreation: boolean; + size?: number; /** - * The input project path this target was derived from (only for repository targets) + * Content block type discriminator */ - projectPath?: string; + type: "resource_link"; } /** - * Canonical files and directories where custom instructions can be created so the runtime will recognize them. + * Icon image for a resource * * This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema - * via the `definition` "InstructionDiscoveryPathList". + * via the `definition` "ExternalToolTextResultForLlmContentResourceLinkIcon". */ /** @experimental */ -export interface InstructionDiscoveryPathList { +export interface ExternalToolTextResultForLlmContentResourceLinkIcon { /** - * Canonical instruction create/discovery files and directories, in priority order + * URL or path to the icon image */ - paths: InstructionDiscoveryPath[]; + src: string; + /** + * MIME type of the icon image + */ + mimeType?: string; + /** + * Available icon sizes (e.g., ['16x16', '32x32']) + */ + sizes?: string[]; + theme?: ExternalToolTextResultForLlmContentResourceLinkIconTheme; } /** - * Optional project paths to include in instruction discovery. + * Embedded resource content block with inline text or binary data * * This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema - * via the `definition` "InstructionsDiscoverRequest". + * via the `definition` "ExternalToolTextResultForLlmContentResource". */ /** @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[]; +export interface ExternalToolTextResultForLlmContentResource { /** - * 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. + * Content block type discriminator */ - excludeHostInstructions?: boolean; + type: "resource"; + resource: ExternalToolTextResultForLlmContentResourceDetails; } /** - * Optional project paths to include when enumerating instruction discovery targets. + * Parameters for cooperatively aborting a factory body. * * This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema - * via the `definition` "InstructionsGetDiscoveryPathsRequest". + * via the `definition` "FactoryAbortRequest". */ /** @experimental */ -export interface InstructionsGetDiscoveryPathsRequest { +export interface FactoryAbortRequest { /** - * Optional list of project directory paths. When omitted or empty, only the user-level targets are returned. + * Target session identifier */ - projectPaths?: string[]; + sessionId: string; /** - * When true, omit the host's user-level instruction targets, leaving only repository targets. For multitenant deployments (mirrors `discover`'s `excludeHostInstructions`). + * Factory run identifier. */ - excludeHostInstructions?: boolean; + runId: string; } /** - * Instruction sources loaded for the session, in merge order. + * Acknowledgement that a factory request was accepted. * * This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema - * via the `definition` "InstructionsGetSourcesResult". + * via the `definition` "FactoryAckResult". */ /** @experimental */ -export interface InstructionsGetSourcesResult { - /** - * Instruction sources for the session - */ - sources: InstructionSource[]; -} +export interface FactoryAckResult {} /** - * Loaded instruction source for a session, including path, content, category, location, applicability, and optional description. + * Options for one factory-scoped subagent call. * * This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema - * via the `definition` "InstructionSource". + * via the `definition` "FactoryAgentOptions". */ /** @experimental */ -export interface InstructionSource { +export interface FactoryAgentOptions { /** - * Unique identifier for this source (used for toggling) + * Optional label distinguishing otherwise identical memoized agent calls. */ - id: string; + label?: string; /** - * Human-readable label + * Optional JSON Schema for structured agent output. */ - label: string; + schema?: JsonValue; /** - * File path relative to repo or absolute for home + * Optional model identifier for the subagent. */ - sourcePath: string; + model?: string; /** - * Raw content of the instruction file + * Optional reasoning effort for the subagent. This field is accepted but not yet honored. */ - content: string; - type: InstructionSourceType; - location: InstructionSourceLocation; + reasoningEffort?: string; + contextTier?: ContextTier; /** - * Glob pattern(s) from frontmatter β€” when set, this instruction applies only to matching files + * Optional custom agent name for the subagent. This field is accepted but not yet honored. */ - applyTo?: string[]; + 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 { /** - * Short description (body after frontmatter) for use in instruction tables + * Factory run identifier that owns the subagent. */ - description?: string; + factoryRunId: string; /** - * When true, this source starts disabled and must be toggled on by the user + * Opaque token identifying the current factory execution attempt. */ - defaultDisabled?: boolean; + executionToken: string; /** - * The project path this source was discovered from. Only set by sessionless discovery for repository/working-directory sources, where it disambiguates same-named files (e.g. .github/copilot-instructions.md) across multiple workspace roots. The session-scoped getSources leaves it unset. + * Prompt to send to the subagent. */ - projectPath?: string; + prompt: string; + opts: FactoryAgentOptions; } /** - * HTTP headers as a map from lowercased header name to a list of values. Multi-valued headers (e.g. Set-Cookie) preserve all values. + * Result of one factory-scoped subagent call. * * This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema - * via the `definition` "LlmInferenceHeaders". + * via the `definition` "FactoryAgentResult". */ /** @experimental */ -export interface LlmInferenceHeaders { - [k: string]: string[] | undefined; +export interface FactoryAgentResult { + /** + * Agent result, omitted when the agent produced no result. + */ + result?: JsonValue; } /** - * A request body chunk or cancellation signal. + * Prompt-safe durable identity and live status for a direct factory agent. * * This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema - * via the `definition` "LlmInferenceHttpRequestChunkRequest". + * via the `definition` "FactoryAgentSummary". */ /** @experimental */ -export interface LlmInferenceHttpRequestChunkRequest { - /** - * Matches the requestId from the originating httpRequestStart frame. - */ - requestId: string; +export interface FactoryAgentSummary { /** - * Body byte range. UTF-8 text when `binary` is absent or false; base64-encoded bytes when `binary` is true. May be empty. + * Stable direct-agent identifier. */ - data: string; + agentId: string; /** - * When true, `data` is base64-encoded bytes. When absent or false, `data` is UTF-8 text. + * Tool-call identifier that launched the agent. */ - binary?: boolean; + toolCallId: 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. + * Owning factory run identifier. */ - end?: boolean; + runId: string; /** - * When true, the runtime is cancelling the in-flight request (e.g. upstream consumer aborted). `data` is ignored. Implies end-of-request. + * Phase identifier active when the agent was launched, or null. */ - cancel?: boolean; + phaseId: string | null; /** - * Optional human-readable reason for the cancellation, propagated for logging. + * Friendly, non-unique name intended for display */ - cancelReason?: string; + label: 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. + * Friendly, non-unique name intended for display */ - 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 { + displayName?: string; /** - * 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. + * Registered agent type. */ - requestId: string; + agentType: 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. + * Current durable or live agent status. */ - sessionId?: string; + status: string; /** - * HTTP method, e.g. GET, POST. + * Model requested when the agent was launched. */ - method: string; + requestedModel?: string; /** - * Absolute request URL. + * Concrete model resolved for the agent. */ - url: string; - headers: LlmInferenceHeaders; - transport?: LlmInferenceHttpRequestStartTransport; + resolvedModel?: string; /** - * 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. + * Epoch milliseconds when the agent started. */ - agentId?: string; + startedAt?: number; /** - * 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. + * Epoch milliseconds when the agent completed. */ - parentAgentId?: string; + completedAt?: number; /** - * 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. + * Accumulated active agent time in milliseconds. */ - agentInvocationId?: string; + activeMs: number; /** - * 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. + * Prompt-safe live activity text. */ - interactionType?: string; + activity?: string; } /** - * Acknowledgement. Returning successfully simply means the SDK accepted the start frame; it does not imply the request will succeed. + * Parameters for cancelling a factory run. * * This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema - * via the `definition` "LlmInferenceHttpRequestStartResult". + * via the `definition` "FactoryCancelRequest". */ /** @experimental */ -export interface LlmInferenceHttpRequestStartResult {} +export interface FactoryCancelRequest { + /** + * Factory run identifier. + */ + runId: string; +} /** - * Set to terminate the response with a transport-level failure. Implies end-of-stream; any further chunks for this requestId are ignored. + * Current factory phase identity. * * This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema - * via the `definition` "LlmInferenceHttpResponseChunkError". + * via the `definition` "FactoryCurrentPhase". */ /** @experimental */ -export interface LlmInferenceHttpResponseChunkError { +export interface FactoryCurrentPhase { /** - * Human-readable failure description. + * Current phase identifier. */ - message: string; + id: string; /** - * Optional machine-readable error code. + * Zero-based declared phase ordinal, or null for an undeclared phase. */ - code?: string; + ordinal: number | null; } /** - * A response body chunk or terminal error. + * Declared or approved factory resource ceilings. * * This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema - * via the `definition` "LlmInferenceHttpResponseChunkRequest". + * via the `definition` "FactoryDeclaredLimits". */ /** @experimental */ -export interface LlmInferenceHttpResponseChunkRequest { +export interface FactoryDeclaredLimits { /** - * Matches the requestId from the originating httpRequestStart frame. + * Maximum concurrently active subagents. */ - requestId: string; + maxConcurrentSubagents?: number; /** - * 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). + * Maximum total subagents spawned by the run. */ - data: string; + maxTotalSubagents?: number; /** - * When true, `data` is base64-encoded bytes. When absent or false, `data` is UTF-8 text. + * Maximum accumulated active execution time in seconds. */ - binary?: boolean; + timeoutSeconds?: number; /** - * 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. + * Maximum AI credits consumed by subagents and descendants. */ - end?: boolean; - error?: LlmInferenceHttpResponseChunkError; + maxAiCredits?: number; } /** - * Whether the chunk was accepted. + * Parameters sent to the owning extension to execute a factory closure. * * This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema - * via the `definition` "LlmInferenceHttpResponseChunkResult". + * via the `definition` "FactoryExecuteRequest". */ /** @experimental */ -export interface LlmInferenceHttpResponseChunkResult { +export interface FactoryExecuteRequest { /** - * True when the chunk was matched to a pending request; false when unknown. + * Target session identifier */ - accepted: boolean; -} -/** - * Response head. - * - * This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema - * via the `definition` "LlmInferenceHttpResponseStartRequest". - */ -/** @experimental */ -export interface LlmInferenceHttpResponseStartRequest { + sessionId: string; /** - * Matches the requestId from the originating httpRequestStart frame. + * Registered factory name. */ - requestId: string; + name: string; /** - * HTTP status code. + * Factory run identifier. */ - status: number; + runId: string; /** - * Optional HTTP status reason phrase. + * Opaque token identifying this factory execution attempt. */ - 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 { + executionToken: string; /** - * True when the response start was matched to a pending request; false when unknown. + * Factory input value. */ - accepted: boolean; + args: JsonValue; } /** - * Indicates whether the calling client was registered as the LLM inference provider. + * Result returned by an extension factory closure. * * This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema - * via the `definition` "LlmInferenceSetProviderResult". + * via the `definition` "FactoryExecuteResult". */ /** @experimental */ -export interface LlmInferenceSetProviderResult { +export interface FactoryExecuteResult { /** - * Whether the provider was set successfully + * Factory result value. */ - success: boolean; + result?: JsonValue; } /** - * Persisted local session metadata, including identifiers, timestamps, summary/name, client, context, detached state, and task ID. + * Parameters for paging factory progress. * * This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema - * via the `definition` "LocalSessionMetadataValue". + * via the `definition` "FactoryGetRunProgressRequest". */ /** @experimental */ -export interface LocalSessionMetadataValue { +export interface FactoryGetRunProgressRequest { /** - * Stable session identifier + * Factory run identifier. */ - sessionId: string; + runId: string; /** - * Session creation time as an ISO 8601 timestamp + * Optional phase identifier used to scope records and cursors. */ - startTime: string; + phaseId?: string; /** - * Last-modified time of the session's persisted state, as ISO 8601 + * Exclusive forward cursor. */ - modifiedTime: string; + afterSeq?: number; /** - * Short summary of the session, when one has been derived + * Exclusive backward cursor. */ - summary?: string; + beforeSeq?: number; /** - * Optional human-friendly name set via /rename + * Maximum records to return. Defaults to 200 and is capped at 500. */ - name?: string; + 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 { /** - * Runtime client name that created/last resumed this session + * Factory run identifier. */ - clientName?: string; + 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 { /** - * Always false for local sessions. + * Factory run identifier. */ - isRemote: false; + runId: string; /** - * True for detached maintenance sessions that should be hidden from normal resume lists. + * Opaque token identifying the current factory execution attempt. */ - isDetached?: boolean; - context?: SessionContext; + executionToken: string; /** - * GitHub task ID, when this local session is bound to one. Only present for local sessions exported to remote control. + * Namespaced journal key. */ - mcTaskId?: string; + key: string; } /** - * Pre-resolved working-directory context for session startup. + * Result of reading a factory journal entry. * * This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema - * via the `definition` "SessionContext". + * via the `definition` "FactoryJournalGetResult". */ /** @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; +export interface FactoryJournalGetResult { /** - * Repository slug in `owner/name` form, when known + * Whether the journal contained the requested key. */ - repository?: string; - hostType?: SessionContextHostType; + hit: boolean; /** - * Active git branch + * Cached JSON result. The hit field distinguishes a cached JSON null from a miss. */ - branch?: string; + resultJson?: JsonValue; } /** - * Message text, optional severity level, persistence flag, optional follow-up URL, and optional tip. + * Parameters for storing a factory journal entry. * * This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema - * via the `definition` "LogRequest". + * via the `definition` "FactoryJournalPutRequest". */ /** @experimental */ -export interface LogRequest { - /** - * Human-readable message - */ - message: string; - level?: SessionLogLevel; +export interface FactoryJournalPutRequest { /** - * Domain category for this log entry (e.g., "mcp", "subscription", "policy", "model"). Maps to `infoType`/`warningType`/`errorType` on the emitted event. Defaults to "notification". + * Factory run identifier. */ - type?: string; + runId: string; /** - * When true, the message is transient and not persisted to the session event log on disk + * Opaque token identifying the current factory execution attempt. */ - ephemeral?: boolean; + executionToken: string; /** - * Optional URL the user can open in their browser for more details + * Namespaced journal key. */ - url?: string; + key: string; /** - * Optional actionable tip displayed alongside the message. Only honored on `level: "info"`. + * JSON result to memoize. */ - tip?: string; + resultJson: JsonValue; } /** - * Identifier of the session event that was emitted for the log message. + * Parameters for paging factory runs. * * This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema - * via the `definition` "LogResult". + * via the `definition` "FactoryListRunsRequest". */ /** @experimental */ -export interface LogResult { +export interface FactoryListRunsRequest { /** - * The unique identifier of the emitted session event + * Exclusive forward cursor. */ - eventId: string; + afterSeq?: number; + /** + * Exclusive backward cursor. + */ + beforeSeq?: number; + /** + * Maximum terminal runs to return. Defaults to 200 and is capped at 500. + */ + limit?: number; } /** - * Parameters for (re)loading the merged LSP configuration set. + * A page of factory runs in durable creation order. * * This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema - * via the `definition` "LspInitializeRequest". + * via the `definition` "FactoryListRunsResult". */ /** @experimental */ -export interface LspInitializeRequest { +export interface FactoryListRunsResult { /** - * Working directory used to load project-level LSP configs. Defaults to the session working directory when omitted. + * Factory run summaries in durable creation order. */ - workingDirectory?: string; + runs: FactoryRunSummary[]; /** - * Git root used as the boundary when traversing for project-level LSP configs (supports monorepos). + * Oldest terminal-run cursor in this page, or null when the terminal window is empty. */ - gitRoot?: string; + oldestSeq?: number | null; /** - * Force re-initialization even when LSP configs were already loaded for the working directory. + * Newest terminal-run cursor in this page, or null when the terminal window is empty. */ - force?: boolean; -} -/** - * Result of registering a new marketplace. - * - * This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema - * via the `definition` "MarketplaceAddResult". - */ -/** @experimental */ -export interface MarketplaceAddResult { + newestSeq?: number | null; /** - * Final name of the marketplace as resolved from its manifest + * Whether terminal runs newer than this page exist. */ - name: string; + hasMoreNewer?: boolean; + /** + * Number of terminal runs older than this page. + */ + omittedOlder?: number; } /** - * Plugins advertised by the marketplace. + * Durable factory run summary with read-time live overlays. * * This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema - * via the `definition` "MarketplaceBrowseResult". + * via the `definition` "FactoryRunSummary". */ /** @experimental */ -export interface MarketplaceBrowseResult { +export interface FactoryRunSummary { /** - * Plugins advertised by the marketplace + * Factory run identifier. */ - plugins: MarketplacePluginInfo[]; + runId: string; + /** + * Registered factory name. + */ + factoryName: string; + /** + * Human-readable factory description. + */ + description: string; + status: FactoryRunStatus; + /** + * Monotonic durable run revision. + */ + revision: number; + /** + * Epoch milliseconds when the run was created. + */ + createdAt: number; + /** + * Epoch milliseconds when execution first started, or null before start. + */ + startedAt: number | null; + /** + * Epoch milliseconds when the durable run was last updated. + */ + updatedAt: number; + /** + * Epoch milliseconds when the run completed, or null while nonterminal. + */ + completedAt: number | null; + /** + * Current phase identity, or null before any phase is entered. + */ + currentPhase: FactoryCurrentPhase | null; + /** + * Number of phases declared by the factory. + */ + declaredPhaseCount: number; + /** + * Number of direct factory agents currently live. + */ + liveAgentCount: number; + /** + * Total direct factory agents spawned across all attempts. + */ + totalSpawnedAgentCount: number; + consumed: FactoryRunConsumed; + declaredLimits: FactoryDeclaredLimits; + /** + * Approved effective resource ceilings, or null until approved. + */ + approved: FactoryDeclaredLimits | null; + /** + * Epoch milliseconds when this live-overlay snapshot was observed. + */ + observedAt: number; + /** + * Epoch milliseconds when the current active segment started, or null while inactive. + */ + activeSegmentStartedAt: number | null; + /** + * Terminal run outcome, or null while nonterminal. + */ + terminal: FactoryRunTerminal | null; } /** - * Plugin entry advertised by a marketplace. + * Durable factory resource consumption. * * This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema - * via the `definition` "MarketplacePluginInfo". + * via the `definition` "FactoryRunConsumed". */ /** @experimental */ -export interface MarketplacePluginInfo { +export interface FactoryRunConsumed { /** - * Plugin name as listed in the marketplace catalog + * Accumulated active execution time in milliseconds. */ - name: string; + activeMs: number; /** - * Short description from the marketplace catalog, when present + * Total subagents spawned by the run. */ - description?: string; + subagents: number; + /** + * AI usage consumed by the run in nano-AIU. + */ + nanoAiu: number; } /** - * Registered marketplace summary. + * Prompt-safe terminal factory outcome. * * This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema - * via the `definition` "MarketplaceInfo". + * via the `definition` "FactoryRunTerminal". */ /** @experimental */ -export interface MarketplaceInfo { +export interface FactoryRunTerminal { /** - * Marketplace name (matches the @marketplace suffix in plugin specs) + * Human-readable terminal reason. */ - name: string; + reason?: string; + failure?: FactoryRunFailure; /** - * Human-readable description of where the marketplace data is fetched from (e.g. "GitHub: owner/repo"). + * Human-readable terminal error. */ - source: string; + error?: string; /** - * True when this is a default marketplace shipped with the runtime. Defaults are not removable. + * Prompt-safe preview of the completed result. */ - isDefault?: boolean; + resultPreview?: string; } /** - * All registered marketplaces, including built-in defaults. + * One ordered factory progress line. * * This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema - * via the `definition` "MarketplaceListResult". + * via the `definition` "FactoryLogLine". */ /** @experimental */ -export interface MarketplaceListResult { +export interface FactoryLogLine { /** - * Registered marketplaces + * Monotonic sequence number within the factory run. */ - marketplaces: MarketplaceInfo[]; + seq: number; + kind: FactoryLogLineKind; + /** + * Progress text. + */ + text: string; } /** - * Per-marketplace refresh result, including marketplace name, success flag, and optional failure error. + * Parameters for recording factory progress. * * This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema - * via the `definition` "MarketplaceRefreshEntry". + * via the `definition` "FactoryLogRequest". */ /** @experimental */ -export interface MarketplaceRefreshEntry { +export interface FactoryLogRequest { /** - * Marketplace name that was refreshed + * Factory run identifier. */ - name: string; + runId: string; /** - * Whether the refresh succeeded + * Opaque token identifying the current factory execution attempt. */ - success: boolean; + executionToken: string; /** - * Error message (failure only) + * Ordered progress lines to append. */ - error?: string; + lines: FactoryLogLine[]; } /** - * Result of refreshing one or more marketplace catalogs. + * Durable lifecycle and timing for one factory phase. * * This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema - * via the `definition` "MarketplaceRefreshResult". + * via the `definition` "FactoryPhaseObservation". */ /** @experimental */ -export interface MarketplaceRefreshResult { +export interface FactoryPhaseObservation { /** - * Per-marketplace refresh results in deterministic order. + * Phase identifier. */ - 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 { + id: string; /** - * True when the marketplace was actually removed. False when removal was skipped because the marketplace has dependent plugins and `force` was not set. + * Zero-based declared phase ordinal, or null for an undeclared phase. */ - removed: boolean; + ordinal: number | null; /** - * Names of installed plugins that prevented removal. Populated only when `removed=false`. + * Human-readable phase title. */ - dependentPlugins?: string[]; + title: string; + /** + * Optional human-readable phase detail. + */ + detail?: string; + status: FactoryPhaseStatus; + /** + * Most recent run attempt that entered this phase, or `0` if the phase has never been entered. + */ + lastEnteredRunAttempt: number; + /** + * Number of times execution entered this phase. + */ + entryCount: number; + /** + * Epoch milliseconds when this phase first started; for a skipped phase, the synthetic skip timestamp (equal to `completedAt`). + */ + startedAt?: number; + /** + * Epoch milliseconds when this phase completed; for a skipped phase, the synthetic skip timestamp (equal to `startedAt`). + */ + completedAt?: number; + /** + * Completed active time accumulated by this phase in milliseconds. + */ + accumulatedActiveMs: number; + /** + * Current live active time for this phase in milliseconds. + */ + currentActiveMs: number; + /** + * Total direct agents associated with this phase. + */ + totalAgentCount: number; + /** + * Direct agents in this phase that are currently live. + */ + liveAgentCount: number; } /** - * MCP server allowed by policy, with server name and optional PII-free explanatory note. + * One durable factory progress record. * * This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema - * via the `definition` "McpAllowedServer". + * via the `definition` "FactoryProgressLine". */ /** @experimental */ -export interface McpAllowedServer { +export interface FactoryProgressLine { /** - * Allowed server name + * Global monotonic sequence number within the run. */ - name: string; + seq: number; /** - * PII-free note explaining why the server was allowed + * Resume attempt that emitted this record. */ - redactedNote?: string; + 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; } /** - * MCP server, tool name, and arguments to invoke from an MCP App view. + * A bidirectional page of factory progress. * * This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema - * via the `definition` "McpAppsCallToolRequest". + * via the `definition` "FactoryProgressPage". */ /** @experimental */ -export interface McpAppsCallToolRequest { +export interface FactoryProgressPage { /** - * MCP server hosting the tool + * Progress records in sequence order. */ - serverName: string; + records: FactoryProgressLine[]; /** - * MCP tool name + * Oldest sequence number in this page, or null when empty. */ - toolName: string; + oldestSeq: number | null; /** - * Tool arguments + * Newest sequence number in this page, or null when empty. */ - arguments?: { - [k: string]: unknown | undefined; - }; + newestSeq: number | null; /** - * **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 progress records older than this page exist. */ - originServerName: string; + hasMoreOlder: boolean; + /** + * Whether progress records newer than this page exist. + */ + hasMoreNewer: boolean; + /** + * Run revision reflected by this page. + */ + revision: number; } /** - * Capability negotiation snapshot + * Parameters for resuming a factory run from its persisted identity. * * This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema - * via the `definition` "McpAppsDiagnoseCapability". + * via the `definition` "FactoryResumeRequest". */ /** @experimental */ -export interface McpAppsDiagnoseCapability { +export interface FactoryResumeRequest { /** - * Whether the session has the `mcp-apps` capability + * Factory run identifier. */ - sessionHasMcpApps: boolean; + runId: string; + limits?: FactoryRunLimits; /** - * Whether the MCP_APPS feature flag (or COPILOT_MCP_APPS env override) is on + * Whether to notify the originating session when the factory completes. */ - featureFlagEnabled: boolean; + notifyOnComplete?: boolean; /** - * Whether the runtime advertises `extensions.io.modelcontextprotocol/ui` to MCP servers + * Whether to emit factory phase names to the session transcript. */ - advertised: boolean; + logPhaseNames?: boolean; } /** - * MCP server to diagnose MCP Apps wiring for. + * Wire-only per-invocation factory resource ceiling overrides. * * This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema - * via the `definition` "McpAppsDiagnoseRequest". + * via the `definition` "FactoryRunLimits". */ /** @experimental */ -export interface McpAppsDiagnoseRequest { +export interface FactoryRunLimits { /** - * MCP server to probe + * Maximum number of factory subagents that may run concurrently. */ - serverName: string; + 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; } /** - * Diagnostic snapshot of MCP Apps wiring for the named server. + * Resolved persisted factory identity and resumed run envelope. * * This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema - * via the `definition` "McpAppsDiagnoseResult". + * via the `definition` "FactoryResumeResult". */ /** @experimental */ -export interface McpAppsDiagnoseResult { - capability: McpAppsDiagnoseCapability; - server: McpAppsDiagnoseServer; +export interface FactoryResumeResult { + /** + * Persisted factory name resolved for the resumed run. + */ + factoryName: string; + run: FactoryRunResult; } /** - * What the server returned for this session + * Complete current or terminal factory run envelope. * * This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema - * via the `definition` "McpAppsDiagnoseServer". + * via the `definition` "FactoryRunResult". */ /** @experimental */ -export interface McpAppsDiagnoseServer { +export interface FactoryRunResult { /** - * Whether the named server is currently connected + * Factory run identifier. */ - connected: boolean; + runId: string; + status: FactoryRunStatus; /** - * Total tools returned by the server's tools/list + * Completed factory result. */ - toolCount: number; + result?: JsonValue; /** - * Tools whose `_meta.ui` is populated (resourceUri and/or visibility set) + * Error message for an errored run. */ - toolsWithUiMeta: number; + error?: string; + failure?: FactoryRunFailure; /** - * Up to 5 tool names with `_meta.ui` for quick inspection + * Reason for a halted or cancelled run. */ - 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; + reason?: string; + /** + * Partial journal and progress snapshot for a halted, cancelled, or errored run. + */ + snapshot?: JsonValue; } /** - * Current host context + * Full factory run observability detail. * * This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema - * via the `definition` "McpAppsHostContextDetails". + * via the `definition` "FactoryRunDetail". */ /** @experimental */ -export interface McpAppsHostContextDetails { - theme?: McpAppsHostContextDetailsTheme; +export interface FactoryRunDetail { /** - * BCP-47 locale, e.g. 'en-US' + * Factory run identifier. */ - locale?: string; + runId: string; /** - * IANA timezone, e.g. 'America/New_York' + * Registered factory name. */ - timeZone?: string; - displayMode?: McpAppsHostContextDetailsDisplayMode; + factoryName: string; /** - * Display modes the host supports + * Human-readable factory description. */ - availableDisplayModes?: McpAppsHostContextDetailsAvailableDisplayMode[]; - platform?: McpAppsHostContextDetailsPlatform; + description: string; + status: FactoryRunStatus; /** - * Host application identifier + * Monotonic durable run revision. */ - userAgent?: string; - [k: string]: unknown | undefined; + revision: number; + /** + * Epoch milliseconds when the run was created. + */ + createdAt: number; + /** + * Epoch milliseconds when execution first started, or null before start. + */ + startedAt: number | null; + /** + * Epoch milliseconds when the durable run was last updated. + */ + updatedAt: number; + /** + * Epoch milliseconds when the run completed, or null while nonterminal. + */ + completedAt: number | null; + /** + * Current phase identity, or null before any phase is entered. + */ + currentPhase: FactoryCurrentPhase | null; + /** + * Number of phases declared by the factory. + */ + declaredPhaseCount: number; + /** + * Number of direct factory agents currently live. + */ + liveAgentCount: number; + /** + * Total direct factory agents spawned across all attempts. + */ + totalSpawnedAgentCount: number; + consumed: FactoryRunConsumed; + declaredLimits: FactoryDeclaredLimits; + /** + * Approved effective resource ceilings, or null until approved. + */ + approved: FactoryDeclaredLimits | null; + /** + * Epoch milliseconds when this live-overlay snapshot was observed. + */ + observedAt: number; + /** + * Epoch milliseconds when the current active segment started, or null while inactive. + */ + activeSegmentStartedAt: number | null; + /** + * Terminal run outcome, or null while nonterminal. + */ + terminal: FactoryRunTerminal | null; + /** + * Lifecycle and timing observations for each factory phase. + */ + phases: FactoryPhaseObservation[]; + /** + * Durable identities and live statuses for direct factory agents. + */ + agents: FactoryAgentSummary[]; + progress: FactoryProgressPage; } /** - * MCP server to list app-callable tools for. + * Parameters for invoking a registered factory. * * This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema - * via the `definition` "McpAppsListToolsRequest". + * via the `definition` "FactoryRunRequest". */ /** @experimental */ -export interface McpAppsListToolsRequest { +export interface FactoryRunRequest { /** - * MCP server hosting the app + * Registered factory name. */ - serverName: string; + name: 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. + * Factory input value. */ - originServerName: string; + args: JsonValue; + options?: RunOptions; } /** - * App-callable tools from the named MCP server. + * Options controlling factory invocation. * * This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema - * via the `definition` "McpAppsListToolsResult". + * via the `definition` "RunOptions". */ /** @experimental */ -export interface McpAppsListToolsResult { +export interface RunOptions { + limits?: FactoryRunLimits; /** - * App-callable tools from the server + * Whether to notify the originating session when the factory completes. */ - tools: { - [k: string]: unknown | undefined; - }[]; + notifyOnComplete?: boolean; + /** + * Whether to emit factory phase names to the session transcript. + */ + logPhaseNames?: boolean; + /** + * Run identifier whose journal and progress should seed this resumed run. + */ + resumeFromRunId?: string; } /** - * MCP server and resource URI to fetch. + * Internal parameters for resuming a factory run from a tool. * * This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema - * via the `definition` "McpAppsReadResourceRequest". + * via the `definition` "FactoryToolResumeRequest". */ /** @experimental */ -export interface McpAppsReadResourceRequest { +/** @internal */ +export interface FactoryToolResumeRequest { /** - * Name of the MCP server hosting the resource + * Factory run identifier. */ - serverName: string; + runId: string; + limits?: FactoryRunLimits; /** - * Resource URI (typically ui://...) + * Opaque identifier of the originating tool call. */ - uri: string; + toolCallId?: string; } /** - * Resource contents returned by the MCP server. + * Options for an internal tool-originated factory invocation. * * This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema - * via the `definition` "McpAppsReadResourceResult". + * via the `definition` "FactoryToolRunOptions". */ /** @experimental */ -export interface McpAppsReadResourceResult { +/** @internal */ +export interface FactoryToolRunOptions { + limits?: FactoryRunLimits; /** - * Resource contents returned by the server + * Run identifier whose journal and progress should seed this resumed run. */ - contents: McpAppsResourceContent[]; + resumeFromRunId?: string; } /** - * MCP Apps resource content with URI, optional MIME type, text or base64 blob, and resource metadata. + * Internal parameters for invoking a registered factory from a tool. * * This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema - * via the `definition` "McpAppsResourceContent". + * via the `definition` "FactoryToolRunRequest". */ /** @experimental */ -export interface McpAppsResourceContent { +/** @internal */ +export interface FactoryToolRunRequest { /** - * The resource URI (typically ui://...) + * Registered factory name. */ - uri: string; + name: string; /** - * MIME type of the content + * Factory input value. */ - mimeType?: string; + args: JsonValue; + options?: FactoryToolRunOptions; /** - * Text content (e.g. HTML) + * Opaque identifier of the originating tool call. */ - text?: string; + toolCallId?: 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 { /** - * Base64-encoded binary content - */ - blob?: string; - /** - * Resource-level metadata (CSP, permissions, etc.) + * Optional user prompt to combine with fleet instructions */ - _meta?: { - [k: string]: unknown | undefined; - }; + prompt?: string; } /** - * Host context advertised to MCP App guests + * Indicates whether fleet mode was successfully activated. * * This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema - * via the `definition` "McpAppsSetHostContextDetails". + * via the `definition` "FleetStartResult". */ /** @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; +export interface FleetStartResult { /** - * Host application identifier + * Whether fleet mode was successfully activated */ - 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; + started: boolean; } /** - * The requestId previously passed to executeSampling that should be cancelled. + * Folder path to add to trusted folders. * * This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema - * via the `definition` "McpCancelSamplingExecutionParams". + * via the `definition` "FolderTrustAddParams". */ /** @experimental */ -export interface McpCancelSamplingExecutionParams { +export interface FolderTrustAddParams { /** - * The requestId previously passed to executeSampling that should be cancelled + * Folder path to mark as trusted */ - requestId: string; + path: string; } /** - * Indicates whether an in-flight sampling execution with the given requestId was found and cancelled. + * Folder path to check for trust. * * This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema - * via the `definition` "McpCancelSamplingExecutionResult". + * via the `definition` "FolderTrustCheckParams". */ /** @experimental */ -export interface McpCancelSamplingExecutionResult { +export interface FolderTrustCheckParams { /** - * 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). + * Folder path to check */ - cancelled: boolean; + path: string; } /** - * MCP server name and configuration to add to user configuration. + * Folder trust check result. * * This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema - * via the `definition` "McpConfigAddRequest". + * via the `definition` "FolderTrustCheckResult". */ /** @experimental */ -export interface McpConfigAddRequest { +export interface FolderTrustCheckResult { /** - * Unique name for the MCP server + * Whether the folder is trusted */ - name: string; - config: McpServerConfig; + trusted: boolean; } /** - * Stdio MCP server configuration launched as a child process. + * Client environment metadata describing the process that produced a telemetry event. * * This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema - * via the `definition` "McpServerConfigStdio". + * via the `definition` "GitHubTelemetryClientInfo". */ /** @experimental */ -export interface McpServerConfigStdio { +export interface GitHubTelemetryClientInfo { /** - * Tools to include. Defaults to all tools if not specified. + * Copilot CLI version string. */ - tools?: string[]; + cli_version: string; /** - * Whether this server is a built-in fallback used when the user has not configured their own server. + * Operating system platform (e.g. darwin, linux, win32). */ - isDefaultServer?: boolean; - filterMapping?: FilterMapping; + os_platform: string; /** - * Timeout in milliseconds for tool calls to this server. + * Operating system version string. */ - timeout?: number; - oidc?: McpServerAuthConfig; - auth?: McpServerAuthConfig; - deferTools?: McpServerConfigDeferTools; + os_version: string; /** - * Executable command used to start the Stdio MCP server process. + * Operating system architecture (e.g. arm64, x64). */ - command: string; + os_arch: string; /** - * Command-line arguments passed to the Stdio MCP server process. + * Node.js runtime version string. */ - args?: string[]; + node_version: string; /** - * Working directory for the Stdio MCP server process. + * Copilot subscription plan, when known. */ - cwd?: string; + copilot_plan?: string; /** - * Environment variables to pass to the Stdio MCP server process. + * Type of client. */ - 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 { + client_type?: string; /** - * Fixed port for the OAuth redirect callback server. + * Name of the client application. */ - redirectPort?: number; + 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; + /** + * Distinct CPU model names for the host, comma-separated. + */ + cpu_model?: string; + /** + * Number of logical CPU cores on the host. + */ + cpu_count?: number; } /** - * Remote MCP server configuration accessed over HTTP or SSE. + * 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` "McpServerConfigHttp". + * via the `definition` "GitHubTelemetryEvent". */ /** @experimental */ -export interface McpServerConfigHttp { +export interface GitHubTelemetryEvent { /** - * Tools to include. Defaults to all tools if not specified. + * Event type/kind (e.g. get_completion_with_tools_turn, tool_call_executed). */ - tools?: string[]; - type?: McpServerConfigHttpType; + kind: string; /** - * Whether this server is a built-in fallback used when the user has not configured their own server. + * Timestamp when the event was created (ISO 8601 format). */ - isDefaultServer?: boolean; - filterMapping?: FilterMapping; + created_at?: string; /** - * Timeout in milliseconds for tool calls to this server. + * Reference to the model call that produced this event. */ - timeout?: number; - oidc?: McpServerAuthConfig; - auth?: McpServerAuthConfig; - deferTools?: McpServerConfigDeferTools; + model_call_id?: string; /** - * URL of the remote MCP server endpoint. + * String-valued properties as a map from key to value. */ - url: string; + properties: { + [k: string]: string | undefined; + }; /** - * HTTP headers to include in requests to the remote MCP server. + * Numeric metrics as a map from key to value. */ - headers?: { + 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; }; /** - * OAuth client ID for a pre-registered remote MCP OAuth client. + * Session identifier the event belongs to. */ - oauthClientId?: string; + session_id?: string; /** - * Whether the configured OAuth client is public and does not require a client secret. + * Copilot tracking ID for user-level attribution. */ - oauthPublicClient?: boolean; - oauthGrantType?: McpServerConfigHttpOauthGrantType; + copilot_tracking_id?: string; + client?: GitHubTelemetryClientInfo; } /** - * MCP server names to disable for new sessions. + * 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` "McpConfigDisableRequest". + * via the `definition` "GitHubTelemetryNotification". */ /** @experimental */ -export interface McpConfigDisableRequest { +export interface GitHubTelemetryNotification { /** - * 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. + * 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. */ - names: string[]; + 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; } /** - * MCP server names to enable for new sessions. + * Asks the SDK client to acquire a GitHub access token from an opaque callback registration. * * This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema - * via the `definition` "McpConfigEnableRequest". + * via the `definition` "GitHubTokenAcquireRequest". */ /** @experimental */ -export interface McpConfigEnableRequest { +export interface GitHubTokenAcquireRequest { /** - * 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. + * Opaque identifier generated by the SDK for this callback registration. */ - names: string[]; + registrationId: string; + /** + * Effective GitHub host for which the callback must return a token. + */ + host: string; + /** + * Session receiving the token. Absent only before a cloud session has been assigned its id. + */ + sessionId?: string; + reason: GitHubTokenAcquireReason; } /** - * User-configured MCP servers, keyed by server name. + * 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` "McpConfigList". + * via the `definition` "HandlePendingToolCallRequest". */ /** @experimental */ -export interface McpConfigList { +export interface HandlePendingToolCallRequest { /** - * All MCP servers from user config, keyed by name + * Request ID of the pending tool call */ - servers: { - [k: string]: McpServerConfig; - }; + requestId: string; + result?: ExternalToolResult; + /** + * Error message if the tool call failed + */ + error?: string; } /** - * MCP server name to remove from user configuration. + * Indicates whether the external tool call result was handled successfully. * * This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema - * via the `definition` "McpConfigRemoveRequest". + * via the `definition` "HandlePendingToolCallResult". */ /** @experimental */ -export interface McpConfigRemoveRequest { +export interface HandlePendingToolCallResult { /** - * Name of the MCP server to remove + * Whether the tool call result was handled successfully */ - name: string; + success: boolean; } /** - * MCP server name and replacement configuration to write to user configuration. + * Indicates whether an in-progress manual compaction was aborted. * * This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema - * via the `definition` "McpConfigUpdateRequest". + * via the `definition` "HistoryAbortManualCompactionResult". */ /** @experimental */ -export interface McpConfigUpdateRequest { +export interface HistoryAbortManualCompactionResult { /** - * Name of the MCP server to update + * 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. */ - name: string; - config: McpServerConfig; + aborted: boolean; } /** - * Opaque auth info used to configure GitHub MCP. + * Indicates whether an in-progress background compaction was cancelled. * * This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema - * via the `definition` "McpConfigureGitHubRequest". + * via the `definition` "HistoryCancelBackgroundCompactionResult". */ /** @experimental */ -/** @internal */ -export interface McpConfigureGitHubRequest { +export interface HistoryCancelBackgroundCompactionResult { /** - * Opaque runtime auth info for GitHub MCP configuration. Marked internal: an in-process runtime shape (configureGitHubMcp is a no-op over the wire). - * - * @internal + * 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. */ - authInfo: { - [k: string]: unknown | undefined; - }; + cancelled: boolean; } /** - * Result of configuring GitHub MCP. + * Parameters for clearing the conversation and seeding the window that replaces it. * * This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema - * via the `definition` "McpConfigureGitHubResult". + * via the `definition` "HistoryClearContextRequest". */ /** @experimental */ -export interface McpConfigureGitHubResult { +export interface HistoryClearContextRequest { /** - * Whether GitHub MCP configuration changed. + * 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. */ - changed: boolean; + prompt: string; } /** - * Name of the MCP server to disable for the session. + * 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` "McpDisableRequest". + * via the `definition` "HistoryClearContextResult". */ /** @experimental */ -export interface McpDisableRequest { +export interface HistoryClearContextResult { /** - * Name of the MCP server to disable + * Number of non-system, non-developer messages that were removed from the conversation. Zero only when the window already held no conversation. */ - serverName: string; + messagesCleared: number; } /** - * Optional working directory used as context for MCP server discovery. + * Post-compaction context window usage breakdown * * This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema - * via the `definition` "McpDiscoverRequest". + * via the `definition` "HistoryCompactContextWindow". */ /** @experimental */ -export interface McpDiscoverRequest { +export interface HistoryCompactContextWindow { /** - * Working directory used as context for discovery (e.g., plugin resolution) + * Maximum token count for the model's context window */ - workingDirectory?: string; + 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; } /** - * MCP servers discovered from user, workspace, plugin, and built-in sources. + * 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` "McpDiscoverResult". + * via the `definition` "HistoryCompactResult". */ /** @experimental */ -export interface McpDiscoverResult { +export interface HistoryCompactResult { /** - * MCP servers discovered from all sources + * Whether compaction completed successfully */ - servers: DiscoveredMcpServer[]; + 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; } /** - * Name of the MCP server to enable for the session. + * Rewind points and file-change-tracking availability for the session. * * This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema - * via the `definition` "McpEnableRequest". + * via the `definition` "HistoryListRewindPointsResult". */ /** @experimental */ -export interface McpEnableRequest { +export interface HistoryListRewindPointsResult { /** - * Name of the MCP server to enable + * Whether this session captured file changes from its first turn. */ - serverName: string; + fileChangeTrackingEnabled: boolean; + unavailableReason?: HistoryRewindUnavailableReason; + /** + * Root user turns in chronological order. Empty when `unavailableReason` is set. + */ + points: HistoryRewindPoint[]; } /** - * Identifiers and raw MCP CreateMessageRequest params used to run a sampling inference. + * A root user turn that the session can rewind to. * * This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema - * via the `definition` "McpExecuteSamplingParams". + * via the `definition` "HistoryRewindPoint". */ /** @experimental */ -export interface McpExecuteSamplingParams { +export interface HistoryRewindPoint { /** - * 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. + * ID of the user.message event that begins the discarded suffix. */ - requestId: string; + eventId: string; /** - * Name of the MCP server that initiated the sampling request + * User-visible message text for the turn. */ - serverName: string; + userMessage: 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). + * ISO timestamp of the user turn. */ - mcpRequestId: { - [k: string]: unknown | undefined; - }; - 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; + 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; } /** - * 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. + * Event boundary to preview for conversation-and-files rewind. * * This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema - * via the `definition` "McpExecuteSamplingResult". + * via the `definition` "HistoryPreviewRewindRequest". */ /** @experimental */ -export interface McpExecuteSamplingResult { - [k: string]: unknown | undefined; +export interface HistoryPreviewRewindRequest { + /** + * ID of the user.message event that begins the discarded suffix. + */ + eventId: string; } /** - * MCP server filtered by policy, with name, reason, optional redacted reason, and enterprise login. + * Files and aggregate changes for a prospective rewind. * * This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema - * via the `definition` "McpFilteredServer". + * via the `definition` "HistoryPreviewRewindResult". */ /** @experimental */ -export interface McpFilteredServer { +export interface HistoryPreviewRewindResult { /** - * Filtered server name - */ - name: string; - /** - * Human-readable filter reason + * Whether file restore is available for this session. This is authoritative: switch on it and read `reason` only when it is false. */ - reason: string; + available: boolean; + reason?: HistoryRewindUnavailableReason; /** - * PII-free filter reason + * Number of unique files in the preview. */ - redactedReason?: string; + fileCount: number; /** - * Enterprise login associated with an allowlist policy + * Files ordered by path. */ - enterpriseName?: string; + files: HistoryRewindFilePreview[]; } /** - * MCP headers refresh request id and the host response. + * A file that a conversation-and-files rewind would restore. * * This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema - * via the `definition` "McpHeadersHandlePendingHeadersRefreshRequestRequest". + * via the `definition` "HistoryRewindFilePreview". */ /** @experimental */ -export interface McpHeadersHandlePendingHeadersRefreshRequestRequest { +export interface HistoryRewindFilePreview { /** - * Headers refresh request identifier from mcp.headers_refresh_required + * Absolute path of the captured file. */ - requestId: string; - result: McpHeadersHandlePendingHeadersRefreshRequest; + path: string; + changeType: HistoryRewindChangeType; + /** + * Lines added across the discarded turns. + */ + linesAdded: number; + /** + * Lines removed across the discarded turns. + */ + linesRemoved: number; } /** - * Indicates whether the pending MCP headers refresh response was accepted. + * Boundary and mode for rewinding session history. * * This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema - * via the `definition` "McpHeadersHandlePendingHeadersRefreshRequestResult". + * via the `definition` "HistoryRewindRequest". */ /** @experimental */ -export interface McpHeadersHandlePendingHeadersRefreshRequestResult { +export interface HistoryRewindRequest { /** - * Whether the response was accepted. False if the request was unknown, timed out, or already resolved. + * ID of the user.message event that begins the discarded suffix. */ - success: boolean; + eventId: string; + mode: HistoryRewindMode; } /** - * Host-level state, omitted when no MCP host is initialized. + * Structured outcome of a rewind request. * * This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema - * via the `definition` "McpHostState". + * via the `definition` "HistoryRewindResult". */ /** @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 enterprise allowlist policy. - */ - filteredServers: string[]; +export interface HistoryRewindResult { + outcome: HistoryRewindOutcome; /** - * Names of currently-connected MCP clients. + * 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`. */ - clients: string[]; + eventsRemoved?: number; /** - * Names of servers with in-flight connection attempts. + * 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. */ - pendingConnections: string[]; + restoredFiles: string[]; /** - * Map of server name to recorded connection failure. + * 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. */ - failedServers: { - [k: string]: McpServerFailureInfo | undefined; - }; + skippedFiles: HistorySkippedFileRestore[]; /** - * Map of server name to recorded pending-auth state. + * 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`). */ - needsAuthServers: { - [k: string]: McpServerNeedsAuthInfo | undefined; - }; + error?: string; } /** - * Recorded MCP server connection failure. + * A captured file that rewind intentionally left unchanged. * * This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema - * via the `definition` "McpServerFailureInfo". + * via the `definition` "HistorySkippedFileRestore". */ /** @experimental */ -export interface McpServerFailureInfo { - /** - * Failure message produced when the MCP server connection failed. - */ - message: string; +export interface HistorySkippedFileRestore { /** - * epoch-ms timestamp at which the failure was recorded. + * Absolute path of the skipped file. */ - timestamp: number; + path: string; + reason: HistoryFileRestoreSkipReason; } /** - * Recorded MCP server pending-auth state. + * Markdown summary of the conversation context (empty when not available). * * This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema - * via the `definition` "McpServerNeedsAuthInfo". + * via the `definition` "HistorySummarizeForHandoffResult". */ /** @experimental */ -export interface McpServerNeedsAuthInfo { +export interface HistorySummarizeForHandoffResult { /** - * epoch-ms timestamp at which the server signalled it needs authentication. + * 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. */ - timestamp: number; + summary: string; } /** - * Server name to check running status for. + * 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` "McpIsServerRunningRequest". + * via the `definition` "HistoryTruncateRequest". */ /** @experimental */ -export interface McpIsServerRunningRequest { +export interface HistoryTruncateRequest { /** - * Name of the MCP server to check + * Event ID to truncate to. This event and all events after it are removed from the session. */ - serverName: string; + eventId: string; } /** - * Whether the named MCP server is running. + * Number of events that were removed by the truncation. * * This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema - * via the `definition` "McpIsServerRunningResult". + * via the `definition` "HistoryTruncateResult". */ /** @experimental */ -export interface McpIsServerRunningResult { +export interface HistoryTruncateResult { /** - * True if the server has an active client and transport. + * Number of events that were removed */ - running: boolean; + 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; } /** - * Server name whose tool list should be returned. + * Runtime-owned wire payload for a server-to-client hook callback invocation. * * This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema - * via the `definition` "McpListToolsRequest". + * via the `definition` "HookInvokeRequest". */ /** @experimental */ -export interface McpListToolsRequest { - /** - * Name of the connected MCP server whose tools to list. - */ - serverName: string; +/** @internal */ +export interface HookInvokeRequest { + sessionId: string; + hookType: HookType; + input: JsonValue; } /** - * Tools exposed by the connected MCP server. Throws when the server is not connected. + * Optional output returned by an SDK callback hook. * * This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema - * via the `definition` "McpListToolsResult". + * via the `definition` "HookInvokeResponse". */ /** @experimental */ -export interface McpListToolsResult { - /** - * Tools exposed by the server. - */ - tools: McpTools[]; +/** @internal */ +export interface HookInvokeResponse { + output?: JsonValue; } /** - * MCP tool metadata with tool name, optional description, and normalized MCP Apps discovery metadata. + * 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` "McpTools". + * via the `definition` "InstalledPlugin". */ /** @experimental */ -export interface McpTools { +export interface InstalledPlugin { /** - * Tool name. + * Plugin name */ name: string; /** - * Tool description, when provided. + * Marketplace the plugin came from (empty string for direct repo installs) */ - description?: string; - ui?: McpToolUi; + 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; + /** + * Absolute path of the marketplace directory a live plugin was resolved from. Present only on live, never-persisted records β€” those synthesized at session start for a directory/local marketplace, whose cache_path points at the real plugin directory on disk rather than a copy under the installed-plugins cache. Its presence is what marks a record as live, and no record carrying it is ever written to the persisted installedPlugins key. + */ + installed_from?: string; } /** - * Normalized MCP Apps discovery metadata from a tool's `_meta.ui` block. + * 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` "McpToolUi". + * via the `definition` "InstalledPluginSourceGitHub". */ /** @experimental */ -export interface McpToolUi { +export interface InstalledPluginSourceGitHub { /** - * 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. + * Constant value. Always "github". */ - resourceUri?: string; + source: "github"; /** - * Tool visibility advertised by the server. When absent, MCP Apps defaults apply. + * GitHub repository in `owner/repo` form. */ - visibility?: McpToolUiVisibility[]; + repo: string; + /** + * Optional Git ref to resolve. + */ + ref?: string; + /** + * Optional full 40-character hexadecimal commit SHA. + */ + sha?: string; + /** + * Optional repository-relative path to the plugin. + */ + path?: string; } /** - * Pending MCP OAuth request ID and host-provided token or cancellation response. + * 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` "McpOauthHandlePendingRequest". + * via the `definition` "InstalledPluginSourceUrl". */ /** @experimental */ -export interface McpOauthHandlePendingRequest { +export interface InstalledPluginSourceUrl { /** - * OAuth request identifier from the mcp.oauth_required event + * Constant value. Always "url". */ - requestId: string; - result: McpOauthPendingRequestResponse; + source: "url"; + /** + * URL of the plugin source. + */ + url: string; + /** + * Optional Git ref to resolve. + */ + ref?: string; + /** + * Optional full 40-character hexadecimal commit SHA. + */ + sha?: string; + /** + * Optional source-relative path to the plugin. + */ + path?: string; } /** - * Indicates whether the pending MCP OAuth response was accepted. + * 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` "McpOauthHandlePendingResult". + * via the `definition` "InstalledPluginSourceLocal". */ /** @experimental */ -export interface McpOauthHandlePendingResult { +export interface InstalledPluginSourceLocal { /** - * Whether the response was accepted. False if the request was unknown, timed out, or already resolved. + * Constant value. Always "local". */ - success: boolean; + source: "local"; + /** + * Local filesystem path to the plugin. + */ + path: string; } /** - * Remote MCP server name and optional overrides controlling reauthentication, OAuth client display name, callback success-page copy, and static OAuth client selection. + * Information about an installed plugin tracked in global state. * * This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema - * via the `definition` "McpOauthLoginRequest". + * via the `definition` "InstalledPluginInfo". */ /** @experimental */ -export interface McpOauthLoginRequest { - /** - * Name of the remote MCP server to authenticate - */ - serverName: string; +export interface InstalledPluginInfo { /** - * 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. + * Plugin name */ - forceReauth?: boolean; + name: 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. + * Marketplace the plugin came from. Empty string ("") for direct repo / URL / local installs. */ - clientName?: string; + marketplace: 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. + * 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. */ - callbackSuccessMessage?: string; + directSourceId?: string; /** - * Optional OAuth client ID override for this login. When set, the runtime uses this pre-registered static client instead of dynamic client registration. + * Installed version (when reported by the plugin manifest) */ - clientId?: string; + version?: 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. + * Whether the plugin is currently enabled for new sessions */ - clientSecret?: string; + enabled: boolean; /** - * 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. + * Absolute path of the marketplace directory a live plugin was resolved from. Present only on live, never-persisted records β€” a plugin belonging to a directory/local marketplace, which is loaded from its real directory on every pass instead of a copy under the installed-plugins cache. Its presence is what marks a listed plugin as live: such a plugin is always present on disk, so `enabled` is its only meaningful state and it is never "not installed". */ - publicClient?: boolean; - grantType?: McpOauthLoginGrantType; + installedFrom?: string; } /** - * OAuth authorization URL the caller should open, or empty when cached tokens already authenticated the server. + * 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` "McpOauthLoginResult". + * via the `definition` "InstructionDiscoveryPath". */ /** @experimental */ -export interface McpOauthLoginResult { +export interface InstructionDiscoveryPath { /** - * 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. + * Absolute path of the file or directory (may not exist on disk yet) */ - authorizationUrl?: string; + 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; } /** - * Registration parameters for an external MCP client. + * 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` "McpRegisterExternalClientRequest". + * via the `definition` "InstructionDiscoveryPathList". */ /** @experimental */ -/** @internal */ -export interface McpRegisterExternalClientRequest { - /** - * Logical server name for the external client - */ - serverName: string; +export interface InstructionDiscoveryPathList { /** - * In-process MCP Client instance. Marked internal: cannot be serialized across the JSON-RPC boundary. - * - * @internal + * Canonical instruction create/discovery files and directories, in priority order */ - client: { - [k: string]: unknown | undefined; - }; + 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 { /** - * In-process MCP Transport instance. Marked internal: cannot be serialized across the JSON-RPC boundary. - * - * @internal + * 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). */ - transport: { - [k: string]: unknown | undefined; - }; + projectPaths?: string[]; /** - * In-process server config (MCPServerConfig) paired with the in-process client/transport. Marked internal alongside its companions. - * - * @internal + * 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. */ - config: { - [k: string]: unknown | undefined; - }; + excludeHostInstructions?: boolean; } /** - * Opaque MCP reload configuration. + * Optional project paths to include when enumerating instruction discovery targets. * * This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema - * via the `definition` "McpReloadWithConfigRequest". + * via the `definition` "InstructionsGetDiscoveryPathsRequest". */ /** @experimental */ -/** @internal */ -export interface McpReloadWithConfigRequest { +export interface InstructionsGetDiscoveryPathsRequest { /** - * Opaque runtime MCP reload configuration. Marked internal: an in-process runtime shape (reloadMcpServers throws over the wire). - * - * @internal + * Optional list of project directory paths. When omitted or empty, only the user-level targets are returned. */ - config: { - [k: string]: unknown | undefined; - }; + 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; } /** - * Indicates whether the auto-managed `github` MCP server was removed (false when nothing to remove). + * Instruction sources loaded for the session, in merge order. * * This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema - * via the `definition` "McpRemoveGitHubResult". + * via the `definition` "InstructionsGetSourcesResult". */ /** @experimental */ -export interface McpRemoveGitHubResult { +export interface InstructionsGetSourcesResult { /** - * 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). + * Instruction sources for the session */ - removed: boolean; + sources: InstructionSource[]; } /** - * 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`. + * 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` "McpResource". + * via the `definition` "InstructionSource". */ /** @experimental */ -export interface McpResource { - /** - * The resource URI (e.g. ui://... or file:///...) - */ - uri: string; +export interface InstructionSource { /** - * The programmatic name of the resource + * Unique identifier for this source (used for toggling) */ - name: string; + id: string; /** - * Optional human-readable display title + * Human-readable label */ - title?: string; + label: string; /** - * Optional description of what this resource represents + * File path relative to repo or absolute for home */ - description?: string; + sourcePath: string; /** - * MIME type of the resource, if known + * Raw content of the instruction file */ - mimeType?: string; + content: string; + type: InstructionSourceType; + location: InstructionSourceLocation; /** - * Resource size in bytes, when known + * Glob pattern(s) from frontmatter β€” when set, this instruction applies only to matching files */ - size?: number; + applyTo?: string[]; /** - * Icons associated with this resource + * Short description (body after frontmatter) for use in instruction tables */ - icons?: McpResourceIcon[]; - annotations?: McpResourceAnnotations; + description?: string; /** - * Resource-level metadata + * When true, this source starts disabled and must be toggled on by the user */ - _meta?: { - [k: string]: unknown | undefined; - }; + defaultDisabled?: boolean; /** - * Server-provided non-standard descriptor fields preserved from the MCP response + * 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. */ - additionalProperties?: { - [k: string]: unknown | undefined; - }; + projectPath?: string; } /** - * A resource icon descriptor plus preserved non-standard icon fields. + * Parameters for interrupting the main agent turn. * * This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema - * via the `definition` "McpResourceIcon". + * via the `definition` "InterruptMainTurnRequest". */ /** @experimental */ -export interface McpResourceIcon { +export interface InterruptMainTurnRequest { /** - * Icon URI + * 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: McpSerializableServerConfig; +} +/** + * 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 { + /** + * Optional human-readable server name. + */ + displayName?: string; + safeForTelemetry?: McpSafeForTelemetry; + /** + * 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 discovery and tool calls. + */ + 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; + /** + * Whether secret masking is disabled for calls to this server. + */ + disableSecretMasking?: boolean; + /** + * Tool names excluded after the include filter is applied. + */ + excludeTools?: string[]; + /** + * Event types this server receives as Copilot notifications. + */ + events?: string[]; + /** + * Copilot notification types this server may send to the host. + */ + notifications?: string[]; + source?: McpServerSource; + /** + * Plugin that provided this server. + */ + sourcePlugin?: string; + /** + * Version of the plugin that provided this server. + */ + sourcePluginVersion?: string; + /** + * Whether the providing plugin uses the Open Plugin Spec. + */ + sourcePluginSpec?: boolean; + /** + * Source file path recorded while loading the config. + */ + sourcePath?: string; + /** + * Configuration warnings recorded while loading the server. + */ + configWarnings?: string[]; + /** + * 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; + }; + type?: McpServerConfigStdioType; +} +/** + * Per-field MCP telemetry-obfuscation policy. + * + * This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema + * via the `definition` "McpSafeForTelemetryFields". + */ +/** @experimental */ +export interface McpSafeForTelemetryFields { + /** + * Whether the MCP tool name may be included in telemetry without obfuscation. + */ + name: boolean; + /** + * Whether MCP tool input names may be included in telemetry without obfuscation. + */ + inputsNames: boolean; +} +/** + * 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 { + /** + * Optional human-readable server name. + */ + displayName?: string; + safeForTelemetry?: McpSafeForTelemetry; + /** + * 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 discovery and tool calls. + */ + 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; + /** + * Whether secret masking is disabled for calls to this server. + */ + disableSecretMasking?: boolean; + /** + * Tool names excluded after the include filter is applied. + */ + excludeTools?: string[]; + /** + * Event types this server receives as Copilot notifications. + */ + events?: string[]; + /** + * Copilot notification types this server may send to the host. + */ + notifications?: string[]; + source?: McpServerSource; + /** + * Plugin that provided this server. + */ + sourcePlugin?: string; + /** + * Version of the plugin that provided this server. + */ + sourcePluginVersion?: string; + /** + * Whether the providing plugin uses the Open Plugin Spec. + */ + sourcePluginSpec?: boolean; + /** + * Source file path recorded while loading the config. + */ + sourcePath?: string; + /** + * Configuration warnings recorded while loading the server. + */ + configWarnings?: string[]; + /** + * 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; + }; + /** + * Dynamic-header refresh cache lifetime in milliseconds. + */ + headersRefreshTtlMs?: number; + /** + * 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]: McpSerializableServerConfig; + }; +} +/** + * 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: McpSerializableServerConfig; +} +/** + * Credential-free authentication identity 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 whose connection attempt failed. + * + * This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema + * via the `definition` "McpFailedServer". + */ +/** @experimental */ +export interface McpFailedServer { + /** + * The config key of the server that failed to connect. + */ + name: string; + /** + * The captured connection failure detail. + */ + error?: string; +} +/** + * 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; +} +/** + * A normalised, inert description of what installing an MCP server would involve. Carries no raw card, no install specification, and no secret value. + * + * This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema + * via the `definition` "McpInstallPlan". + */ +/** @experimental */ +export interface McpInstallPlan { + /** + * Opaque, runtime-instance scoped, TTL-bound, single-use handle for this plan. Rejected when stale, replayed, or presented to a different runtime instance. Never logged. + */ + planHandle: string; + /** + * ISO 8601 timestamp after which the plan handle is stale and will be rejected. Abandoning a plan needs no call: an unused handle simply expires, so cancellation before commit is side-effect free. + */ + planHandleExpiresAt: string; + identity: McpPlanResourceIdentity; + provenance: McpPlanProvenance; + /** + * Every eligible transport, so a host can present an explicit choice. A completed plan always has at least one; when none is eligible, planning returns `CatalogUnavailableTransportError` instead. + * + * @minItems 1 + * @maxItems 50 + */ + transportChoices: [McpPlanTransportChoice, ...McpPlanTransportChoice[]]; + /** + * Identifier of the choice the runtime would pick by default. Omitted when there is no eligible transport, or when the runtime expresses no preference. + */ + recommendedTransportChoiceId?: string; + target: McpPlanTarget; + policy: McpPlanPolicyResult; + /** + * The configuration changes installing would make, described rather than serialised, so the mutable configuration payload stays behind the runtime boundary. + */ + configurationChanges: McpPlanConfigurationChange[]; + /** + * Whether applying this plan would require an MCP reload to take effect. Planning itself never reloads. + */ + reloadRequired: boolean; + /** + * Whether the plan cannot be applied without further input, because a required value has no default or a secret must be supplied. + */ + requiresInteractiveConfiguration: boolean; +} +/** + * Normalised identity of the MCP server a plan targets, independent of how the card spelled it. + * + * This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema + * via the `definition` "McpPlanResourceIdentity". + */ +/** @experimental */ +export interface McpPlanResourceIdentity { + /** + * Canonical, normalised name of the server, for example `io.github.owner/server`. + */ + canonicalName: string; + /** + * Local configuration key the server would be recorded under. + */ + serverName: string; + /** + * Version advertised by the card, when it declares one. + */ + version?: string; + /** + * Registry identifier of the server, when it came from a registry. + */ + registryId?: string; +} +/** + * Provenance of the exact validated JSON MCP card content bound privately to a completed plan and its opaque handle. + * + * This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema + * via the `definition` "McpPlanProvenance". + */ +/** @experimental */ +export interface McpPlanProvenance { + /** + * Authority associated with the validated card, without path, query, or credentials. Inert untrusted data. + */ + authority: string; + /** + * ISO 8601 timestamp at which the runtime completed strict parsing and schema validation of the card content. + */ + validatedAt: string; + cardDigest: CardDigest; + mediaType: McpServerCardMediaType; +} +/** + * An eligible local-package transport choice. Package identity is required and a remote endpoint cannot be represented. + * + * This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema + * via the `definition` "McpPlanTransportChoicePackage". + */ +/** @experimental */ +export interface McpPlanTransportChoicePackage { + /** + * Stable identifier for this choice within the plan, used to select it when the plan is applied. + */ + choiceId: string; + transport: McpPlanPackageTransport; + installMethod: McpPlanPackageInstallMethod; + /** + * Packaging ecosystem, for example `oci` or `npm`. + */ + packageType: string; + /** + * Package identifier. Inert untrusted data. + */ + packageIdentifier: string; + /** + * Typed values this choice requires, excluding secrets. + */ + requiredValues: McpPlanRequiredValue[]; + /** + * Secrets this choice requires, referenced by placeholder only. + */ + secretPlaceholders: McpPlanSecretPlaceholder[]; +} +/** + * One non-secret scalar value a transport choice needs before it can be applied. + * + * This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema + * via the `definition` "McpPlanRequiredValueScalar". + */ +/** @experimental */ +export interface McpPlanRequiredValueScalar { + kind: McpPlanRequiredValueScalarKind; + /** + * Key the value is supplied under. Inert untrusted data. + */ + key: string; + category: McpPlanValueCategory; + valueType: McpPlanScalarValueType; + /** + * Whether the value must be present for the plan to be applicable. + */ + required: boolean; + /** + * Default supplied by the card, when the value can be resolved without input. Presence is the authoritative indication that a default exists. Inert untrusted data. + */ + defaultValue?: string; + /** + * Human-readable label from the card. Inert untrusted text. + */ + title?: string; + /** + * Human-readable explanation from the card. Inert untrusted text. + */ + description?: string; + /** + * Whether the value may be supplied more than once. + */ + isRepeated: boolean; +} +/** + * One enumerated non-secret value a transport choice needs before it can be applied. The permitted values are structurally required. + * + * This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema + * via the `definition` "McpPlanRequiredValueEnum". + */ +/** @experimental */ +export interface McpPlanRequiredValueEnum { + kind: McpPlanRequiredValueEnumKind; + /** + * Key the value is supplied under. Inert untrusted data. + */ + key: string; + category: McpPlanValueCategory; + valueType: McpPlanEnumValueType; + /** + * Whether the value must be present for the plan to be applicable. + */ + required: boolean; + /** + * Default supplied by the card, when the value can be resolved without input. Presence is the authoritative indication that a default exists. Inert untrusted data. + */ + defaultValue?: string; + /** + * Human-readable label from the card. Inert untrusted text. + */ + title?: string; + /** + * Human-readable explanation from the card. Inert untrusted text. + */ + description?: string; + /** + * Non-empty permitted value set. Inert untrusted data. + * + * @minItems 1 + */ + enumValues: [string, ...string[]]; + /** + * Whether the value may be supplied more than once. + */ + isRepeated: boolean; +} +/** + * A secret a transport choice needs, referenced by placeholder. No secret value ever appears in a plan, and the placeholder resolves against the keychain only when a plan is applied. + * + * This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema + * via the `definition` "McpPlanSecretPlaceholder". + */ +/** @experimental */ +export interface McpPlanSecretPlaceholder { + /** + * Key the secret is supplied under. Inert untrusted data. + */ + key: string; + placeholder: McpPlanSecretReference; + /** + * Human-readable label from the card. Inert untrusted text. + */ + title?: string; +} +/** + * An eligible remote-endpoint transport choice. The endpoint is required and package identity cannot be represented. + * + * This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema + * via the `definition` "McpPlanTransportChoiceRemote". + */ +/** @experimental */ +export interface McpPlanTransportChoiceRemote { + /** + * Stable identifier for this choice within the plan, used to select it when the plan is applied. + */ + choiceId: string; + transport: McpPlanRemoteTransport; + installMethod: McpPlanRemoteInstallMethod; + /** + * Endpoint URL. Inert untrusted data. + */ + endpoint: string; + /** + * Typed values this choice requires, excluding secrets. + */ + requiredValues: McpPlanRequiredValue[]; + /** + * Secrets this choice requires, referenced by placeholder only. + */ + secretPlaceholders: McpPlanSecretPlaceholder[]; +} +/** + * Where a plan would be written. + * + * This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema + * via the `definition` "McpPlanTarget". + */ +/** @experimental */ +export interface McpPlanTarget { + scope: McpPlanScope; + /** + * Configuration key the server would be recorded under within that scope. + */ + configKey: string; +} +/** + * Outcome of evaluating the planned server against registry and enterprise policy. Evaluation is read-only. + * + * This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema + * via the `definition` "McpPlanPolicyResult". + */ +/** @experimental */ +export interface McpPlanPolicyResult { + decision: McpPlanPolicyDecision; + source: McpPlanPolicySource; + /** + * Human-readable explanation, safe to surface. Never contains a query, URL, handle, or secret. + */ + reason?: string; +} +/** + * One change applying the plan would make, described rather than serialised so the configuration payload stays behind the runtime boundary. + * + * This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema + * via the `definition` "McpPlanConfigurationChange". + */ +/** @experimental */ +export interface McpPlanConfigurationChange { + operation: McpPlanConfigurationOperation; + scope: McpPlanScope; + /** + * Configuration key the change applies to. + */ + configKey: string; + /** + * Names of the configuration fields the change would set, without their values. + */ + changedFields: string[]; + /** + * Secret placeholders the written configuration would reference. The constrained placeholder type cannot carry a literal secret value. + */ + secretReferences: McpPlanSecretReference[]; +} +/** + * 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; +} +/** + * Remote MCP server name for a passive OAuth status probe. + * + * This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema + * via the `definition` "McpOauthProbeRequest". + */ +/** @experimental */ +export interface McpOauthProbeRequest { + /** + * Name of the configured remote MCP server to probe. + */ + serverName: 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; +} +/** + * A computed MCP install plan. Nothing has been applied: the plan describes what installing would change, and the plan handle is what a later apply operation would consume. + * + * This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema + * via the `definition` "McpPlanInstallPlanned". + */ +/** @experimental */ +export interface McpPlanInstallPlanned { + /** + * Discriminator: a plan was computed and nothing was changed + */ + kind: "planned"; + plan: McpInstallPlan; + negotiated: CatalogNegotiatedContract; +} +/** + * A side-effect-free request for an MCP install plan. Computing a plan never writes configuration, stores a secret, or reloads MCP servers. + * + * This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema + * via the `definition` "McpPlanInstallRequest". + */ +/** @experimental */ +export interface McpPlanInstallRequest { + contract: CatalogClientContract; + source: McpPlanInstallSource; + scope?: McpPlanScope; +} +/** + * Plan from a candidate returned by a previous catalog search. + * + * This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema + * via the `definition` "McpPlanInstallSourceCandidate". + */ +/** @experimental */ +export interface McpPlanInstallSourceCandidate { + kind: McpPlanInstallSourceCandidateKind; + /** + * Single-use candidate handle. Consumed by this call, so a replay of the same handle is rejected. + */ + candidateHandle: string; + /** + * The runtime- or authority-minted `searchId` returned with the search that produced this candidate. A search implementation binds it to private candidate-handle context; a planning implementation must verify that context before returning a plan. The unavailable planning implementation in this contract layer validates presence but does not claim the verification has occurred. It identifies a search rather than a person and must never be joined with user identity to re-identify anyone. + */ + searchId: string; +} +/** + * Plan from a card supplied directly by the caller, without a preceding search. + * + * This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema + * via the `definition` "McpPlanInstallSourceCard". + */ +/** @experimental */ +export interface McpPlanInstallSourceCard { + kind: McpPlanInstallSourceCardKind; + card: McpServerCardReference; +} +/** + * An MCP server card to be retrieved from a URL through the runtime's hardened fetch boundary. + * + * This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema + * via the `definition` "McpServerCardUrl". + */ +/** @experimental */ +export interface McpServerCardUrl { + kind: McpServerCardUrlKind; + mediaType: McpServerCardMediaType; + /** + * Card URL. Retrieved only through the runtime's hardened boundary, with scheme, credential, address-range, redirect, timeout, and response-size controls applied. Never logged. + */ + url: string; +} +/** + * An MCP server card supplied inline as an inert document. + * + * This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema + * via the `definition` "McpServerCardEmbedded". + */ +/** @experimental */ +export interface McpServerCardEmbedded { + kind: McpServerCardEmbeddedKind; + mediaType: McpServerCardMediaType; + /** + * The card document verbatim, treated as inert untrusted bytes. The runtime parses and validates it; the host is not expected to interpret it. Never logged. + */ + data: string; +} +/** + * 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; +} +/** + * In-process MCP reload configuration. + * + * This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema + * via the `definition` "McpReloadConfig". + */ +/** @experimental */ +/** @internal */ +export interface McpReloadConfig { + mcpServers: { + [k: string]: McpServerConfig | undefined; + }; + disabledServers?: string[]; + enabledServers?: string[]; + /** + * Server names the CLI enabled for this session via `--enable-mcp-server`. + */ + cliEnabledServers?: string[]; + mcp3pEnabled?: boolean; + includeWorkspaceSources?: boolean; + configFilter?: OpaqueInProcessValue; + githubMcpToolOptions?: OpaqueInProcessValue; + githubMcpUserOverride?: boolean; + secretStore?: OpaqueInProcessValue; + activeGitHubToken?: string; + useCachedToolSnapshots?: boolean; + forceRestart?: boolean; +} +/** + * Opaque MCP reload configuration. + * + * This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema + * via the `definition` "McpReloadWithConfigRequest". + */ +/** @experimental */ +/** @internal */ +export interface McpReloadWithConfigRequest { + config: unknown; +} +/** + * 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 + * 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?: McpSerializableServerConfig; +} +/** + * 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; +} +/** + * In-process MCP server configuration used by embedded SDK clients. + * + * This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema + * via the `definition` "McpServerConfigMemory". + */ +/** @experimental */ +/** @internal */ +export interface McpServerConfigMemory { + type: McpServerConfigMemoryType; + /** + * In-process MCP server instance. This value cannot cross a JSON-RPC boundary. + * + * @internal + */ + serverInstance: OpaqueInProcessValue; + /** + * Tools to include. Defaults to all tools if not specified. + */ + tools?: string[]; + /** + * Optional human-readable server name. + */ + displayName?: string; + /** + * Whether this server is a built-in fallback. + */ + isDefaultServer?: boolean; + filterMapping?: FilterMapping; + safeForTelemetry?: McpSafeForTelemetry; + /** + * Timeout in milliseconds for tool discovery and tool calls. + */ + timeout?: number; + oidc?: McpServerAuthConfig; + deferTools?: McpServerConfigDeferTools; + /** + * Whether persisted tool snapshots are disabled. + */ + disableToolCache?: boolean; + /** + * Whether secret masking is disabled for calls to this server. + */ + disableSecretMasking?: boolean; + /** + * Tool names excluded after the include filter is applied. + */ + excludeTools?: string[]; + /** + * Event types this server receives as Copilot notifications. + */ + events?: string[]; + /** + * Copilot notification types this server may send to the host. + */ + notifications?: string[]; + source?: McpServerSource; + /** + * Plugin that provided this server. + */ + sourcePlugin?: string; + /** + * Version of the plugin that provided this server. + */ + sourcePluginVersion?: string; + /** + * Whether the providing plugin uses the Open Plugin Spec. + */ + sourcePluginSpec?: boolean; + /** + * Source file path recorded while loading the config. + */ + sourcePath?: string; + /** + * Configuration warnings recorded while loading the server. + */ + configWarnings?: 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?: McpSerializableServerConfig; +} +/** + * 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[]; + /** + * Servers whose connection attempt failed. + */ + failedServers?: McpFailedServer[]; +} +/** + * 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; +} +/** + * Metadata controlling an MCP task's lifetime. + * + * This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema + * via the `definition` "McpTaskMetadata". + */ +/** @experimental */ +export interface McpTaskMetadata { + /** + * Task time-to-live. + */ + ttl?: number; +} +/** + * Server name identifying the external client to remove. + * + * This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema + * via the `definition` "McpUnregisterExternalClientRequest". + */ +/** @experimental */ +/** @internal */ +export interface McpUnregisterExternalClientRequest { + /** + * Server name of the external client to unregister + */ + serverName: string; +} +/** + * Memory configuration for this session. + * + * This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema + * via the `definition` "MemoryConfiguration". + */ +/** @experimental */ +export interface MemoryConfiguration { + /** + * Whether memory is enabled for the session. + */ + 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 { + /** + * Per-source context-window attribution, or null if the session has not yet been initialized (no system prompt or tool metadata cached). + */ + 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 { + /** + * Maximum number of messages to return, most-expensive first. Omit for the server default. + */ + 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 { + /** + * Total token count of the current context window, so callers can compute each message's share without a second call. + */ + totalTokens: number; + /** + * Heaviest messages, most-expensive first. + */ + 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 { + /** + * 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. */ - mimeType?: string; + outputTokenLimit: number; /** - * Icon sizes hint + * Model identifier used for tokenization. Omit to use the session default. Used both for token counting and to compute display values. */ - sizes?: string; + 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 { /** - * Theme hint for this icon + * Token breakdown for the current context window, or null if the session has not yet been initialized (no system prompt or tool metadata cached). */ - theme?: string; + contextInfo?: SessionContextInfo | null; +} +/** + * 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` "MetadataIsProcessingResult". + */ +/** @experimental */ +export interface MetadataIsProcessingResult { /** - * Server-provided non-standard icon fields preserved from the MCP response + * 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. */ - additionalProperties?: { - [k: string]: unknown | undefined; - }; + processing: boolean; } /** - * Standard MCP resource annotations plus preserved non-standard annotation fields. + * Model identifier to use when re-tokenizing the session's existing messages. * * This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema - * via the `definition` "McpResourceAnnotations". + * via the `definition` "MetadataRecomputeContextTokensRequest". */ /** @experimental */ -export interface McpResourceAnnotations { +export interface MetadataRecomputeContextTokensRequest { /** - * Intended audience roles for this resource + * Model identifier used for tokenization. The runtime token-counts both chat-context and system-context messages against this model. */ - audience?: string[]; + 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 { /** - * Priority hint for model/client use + * Sum of tokens across chat-context and system-context messages currently held by the session. */ - priority?: number; + totalTokens: number; /** - * Last-modified timestamp hint + * Tokens contributed by user/assistant/tool messages (excludes system/developer prompts). */ - lastModified?: string; + messagesTokenCount: number; /** - * Server-provided non-standard annotation fields preserved from the MCP response + * Tokens contributed by system/developer prompt snapshots. */ - additionalProperties?: { - [k: string]: unknown | undefined; - }; + 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 { + /** + * Current working directory path + */ + cwd: string; + /** + * Root directory of the git repository, resolved via git rev-parse + */ + gitRoot?: string; + /** + * Repository identifier derived from the git remote URL ("owner/name" for GitHub, "org/project/repo" for Azure DevOps) + */ + repository?: string; + hostType?: SessionWorkingDirectoryContextHostType; + /** + * Raw host string from the git remote URL (e.g. "github.com", "dev.azure.com") + */ + repositoryHost?: string; + /** + * Current git branch name + */ + branch?: string; + /** + * Head commit of the current git branch + */ + headCommit?: string; + /** + * Merge-base commit SHA (fork point from the remote default branch) + */ + baseCommit?: 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). 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` "MetadataRecordContextChangeResult". + */ +/** @experimental */ +export interface MetadataRecordContextChangeResult {} +/** + * 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` "MetadataSetWorkingDirectoryRequest". + */ +/** @experimental */ +export interface 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. + */ + 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 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` "MetadataSetWorkingDirectoryResult". + */ +/** @experimental */ +export interface MetadataSetWorkingDirectoryResult { + /** + * Working directory after the update + */ + workingDirectory: string; +} +/** + * 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` "MetadataSnapshotRemoteMetadata". + */ +/** @experimental */ +export interface MetadataSnapshotRemoteMetadata { + /** + * The original resource identifier (task ID or PR node ID), preserved across event-replay reconstructions. Falls back to `sessionId` when absent. + */ + resourceId?: string; + repository: MetadataSnapshotRemoteMetadataRepository; + /** + * The pull request number the remote session is associated with, if any. + */ + pullRequestNumber?: number; + taskType?: MetadataSnapshotRemoteMetadataTaskType; +} +/** + * The repository the remote session targets. + * + * This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema + * via the `definition` "MetadataSnapshotRemoteMetadataRepository". + */ +/** @experimental */ +export interface MetadataSnapshotRemoteMetadataRepository { + /** + * The GitHub owner (user or organization) of the target repository. + */ + owner: string; + /** + * The GitHub repository name (without owner). + */ + name: string; + /** + * The branch the remote session is operating on. + */ + branch: string; +} +/** + * 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` "Model". + */ +/** @experimental */ +export interface Model { + /** + * Model identifier (e.g., "claude-sonnet-4.5") + */ + id: string; + /** + * Display name + */ + name: string; + capabilities: ModelCapabilities; + policy?: ModelPolicy; + billing?: ModelBilling; + /** + * Supported reasoning effort levels (only present if model supports reasoning effort) + */ + supportedReasoningEfforts?: string[]; + /** + * Default reasoning effort level (only present if model supports reasoning effort) + */ + defaultReasoningEffort?: string; + /** + * Context-window tiers this model offers, when the provider advertises them independently of tiered token pricing. Copilot models carry their tiers in `billing.tokenPrices`; a provider that has no pricing to publish (an agent host reached over AHP, for example) declares them here instead, so the model picker can still offer the tier toggle. + */ + supportedContextTiers?: string[]; + modelPickerCategory?: ModelPickerCategory; + modelPickerPriceCategory?: ModelPickerPriceCategory; + warningText?: ModelWarningText; + /** + * Informational notices the service published for this model, such as an upcoming change or a recommended alternative. Present only when the service published at least one notice. Hosts should surface these without implying anything is wrong with the model. + */ + infoMessages?: ModelMessage[]; + /** + * Warnings the service published for this model, such as a deprecated client version. Present only when the service published at least one warning. The model remains usable; hosts should surface these as advisory rather than blocking. + */ + warningMessages?: ModelMessage[]; +} +/** + * Model capabilities and limits + * + * This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema + * via the `definition` "ModelCapabilities". + */ +/** @experimental */ +export interface ModelCapabilities { + supports?: ModelCapabilitiesSupports; + limits?: ModelCapabilitiesLimits; +} +/** + * Feature flags indicating what the model supports + * + * This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema + * via the `definition` "ModelCapabilitiesSupports". + */ +/** @experimental */ +export interface ModelCapabilitiesSupports { + /** + * Whether this model supports vision/image input + */ + vision?: boolean; + /** + * Whether this model supports reasoning effort configuration + */ + reasoningEffort?: boolean; + adaptive_thinking?: AdaptiveThinkingSupport; } /** - * MCP resource content with URI, optional MIME type, text or base64 blob, and resource metadata. + * Token limits for prompts, outputs, and context window * * This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema - * via the `definition` "McpResourceContent". + * via the `definition` "ModelCapabilitiesLimits". */ /** @experimental */ -export interface McpResourceContent { - /** - * The resource URI - */ - uri: string; - /** - * MIME type of the content - */ - mimeType?: string; +export interface ModelCapabilitiesLimits { /** - * Text content (e.g. HTML) + * Maximum number of prompt/input tokens */ - text?: string; + max_prompt_tokens?: number; /** - * Base64-encoded binary content + * Maximum number of output/completion tokens */ - blob?: string; + max_output_tokens?: number; /** - * Resource-level metadata (CSP, permissions, etc.) + * Maximum total context window size in tokens */ - _meta?: { - [k: string]: unknown | undefined; - }; + max_context_window_tokens?: number; + vision?: ModelCapabilitiesLimitsVision; } /** - * MCP server whose resources to enumerate. + * Vision-specific limits * * This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema - * via the `definition` "McpResourcesListRequest". + * via the `definition` "ModelCapabilitiesLimitsVision". */ /** @experimental */ -export interface McpResourcesListRequest { +export interface ModelCapabilitiesLimitsVision { /** - * Name of the MCP server whose resources to enumerate + * MIME types the model accepts */ - serverName: string; + supported_media_types: string[]; /** - * Opaque MCP pagination cursor from a prior `nextCursor` value + * Maximum number of images per prompt */ - cursor?: string; + max_prompt_images: number; + /** + * Maximum image size in bytes + */ + max_prompt_image_size: number; } /** - * One page of resources advertised by the named MCP server. + * Policy state (if applicable) * * This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema - * via the `definition` "McpResourcesListResult". + * via the `definition` "ModelPolicy". */ /** @experimental */ -export interface McpResourcesListResult { - /** - * Resources advertised by the server (proxied MCP `resources/list`) - */ - resources: McpResource[]; +export interface ModelPolicy { + state: ModelPolicyState; /** - * Opaque cursor for the next page, if the server has more resources + * Usage terms or conditions for this model */ - nextCursor?: string; + terms?: string; } /** - * MCP server whose resource templates to enumerate. + * Billing information * * This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema - * via the `definition` "McpResourcesListTemplatesRequest". + * via the `definition` "ModelBilling". */ /** @experimental */ -export interface McpResourcesListTemplatesRequest { +export interface ModelBilling { /** - * Name of the MCP server whose resource templates to enumerate + * Billing cost multiplier relative to the base rate */ - serverName: string; + multiplier?: number; + tokenPrices?: ModelBillingTokenPrices; /** - * Opaque MCP pagination cursor from a prior `nextCursor` value + * 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. */ - cursor?: string; + discountPercent?: number; + promo?: ModelBillingPromo; } /** - * One page of resource templates advertised by the named MCP server. + * Token-level pricing information for this model * * This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema - * via the `definition` "McpResourcesListTemplatesResult". + * via the `definition` "ModelBillingTokenPrices". */ /** @experimental */ -export interface McpResourcesListTemplatesResult { +export interface ModelBillingTokenPrices { /** - * Resource templates advertised by the server (proxied MCP `resources/templates/list`) + * AI Credits cost per billing batch of input tokens */ - resourceTemplates: McpResourceTemplate[]; + inputPrice?: number; /** - * Opaque cursor for the next page, if the server has more resource templates + * AI Credits cost per billing batch of output tokens */ - nextCursor?: string; + 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; + /** + * AI Credits cost per billing batch of 1-hour cache-write (cache creation) tokens. + */ + cacheWrite1hPrice?: 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; } /** - * 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`. + * Long context tier pricing (available for models with extended context windows) * * This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema - * via the `definition` "McpResourceTemplate". + * via the `definition` "ModelBillingTokenPricesLongContext". */ /** @experimental */ -export interface McpResourceTemplate { +export interface ModelBillingTokenPricesLongContext { /** - * An RFC 6570 URI template for constructing resource URIs + * AI Credits cost per billing batch of input tokens */ - uriTemplate: string; + inputPrice?: number; /** - * The programmatic name of the resource template + * AI Credits cost per billing batch of output tokens */ - name: string; + outputPrice?: number; /** - * Optional human-readable display title + * @deprecated + * Use cacheReadPrice instead. AI Credits cost per billing batch of cached tokens */ - title?: string; + cachePrice?: number; /** - * Optional description of what this template is for + * AI Credits cost per billing batch of cached (read) tokens */ - description?: string; + cacheReadPrice?: number; /** - * MIME type for resources matching this template, if uniform + * AI Credits cost per billing batch of cache-write (cache creation) tokens. */ - mimeType?: string; + cacheWritePrice?: number; /** - * Icons associated with resources matching this template + * AI Credits cost per billing batch of 1-hour cache-write (cache creation) tokens. */ - icons?: McpResourceIcon[]; - annotations?: McpResourceAnnotations; + cacheWrite1hPrice?: number; /** - * Resource-template-level metadata + * @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. */ - _meta?: { - [k: string]: unknown | undefined; - }; + contextMax?: number; /** - * Server-provided non-standard descriptor fields preserved from the MCP response + * Prompt token budget for the long context tier. The total context window is this value plus the model's max_output_tokens. */ - additionalProperties?: { - [k: string]: unknown | undefined; - }; + maxPromptTokens?: number; } /** - * MCP server and resource URI to fetch. + * 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` "McpResourcesReadRequest". + * via the `definition` "ModelBillingPromo". */ /** @experimental */ -export interface McpResourcesReadRequest { +export interface ModelBillingPromo { /** - * Name of the MCP server hosting the resource + * Stable identifier for the promotion campaign. */ - serverName: string; + id?: string; /** - * Resource URI + * Percentage discount (0-100) applied while the promotion is active. May be fractional. */ - 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 { + discountPercent?: number; /** - * Resource contents returned by the server + * 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. */ - contents: McpResourceContent[]; + endsAt?: string; + /** + * Human-readable promotion message. Does not include the expiry timestamp; consumers may format endsAt and append it when present. + */ + message?: string; } /** - * 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. + * Service-published warning text that hosts should display when presenting a model. * * This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema - * via the `definition` "McpRestartServerRequest". + * via the `definition` "ModelWarningText". */ /** @experimental */ -export interface McpRestartServerRequest { +export interface ModelWarningText { /** - * Name of the MCP server to restart + * Data-retention warning for the model. The text may contain Markdown links and should be rendered as Markdown when supported. */ - serverName: string; - config?: McpServerConfig; + dataRetention?: string; } /** - * Outcome of an MCP sampling execution: success result, failure error, or cancellation. + * A service-published message about a model, carrying a stable machine-readable code alongside human-readable text. * * This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema - * via the `definition` "McpSamplingExecutionResult". + * via the `definition` "ModelMessage". */ /** @experimental */ -export interface McpSamplingExecutionResult { - action: McpSamplingExecutionAction; - result?: McpExecuteSamplingResult; +export interface ModelMessage { /** - * Error description, present when action='failure'. + * Stable machine-readable identifier for the message, such as `client_version_deprecated`. Hosts can key custom presentation off this; unrecognized codes should fall back to displaying `message`. */ - error?: string; + code: string; + /** + * Human-readable message text intended for display to the user. + */ + message: string; } /** - * MCP server status entry, including config source/plugin source and any connection error. + * Managed, repository, and CLI model overrides to overlay onto the session at startup. * * This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema - * via the `definition` "McpServer". + * via the `definition` "ModelApplyStartupOverlayRequest". */ /** @experimental */ -export interface McpServer { +export interface ModelApplyStartupOverlayRequest { /** - * Server name (config key) + * Model required by device-managed policy, when configured. */ - name: string; - status: McpServerStatus; - source?: McpServerSource; + deviceManagedModel?: string; /** - * Plugin name that provided this server, when source is plugin. + * Model required by server-managed policy, when configured. */ - sourcePlugin?: string; + serverManagedModel?: string; /** - * Plugin version that provided this server, when source is plugin. + * Model selected by repository settings, when configured. */ - sourcePluginVersion?: string; + repoModel?: string; /** - * Error message if the server failed to connect + * Reasoning effort selected by repository settings, when configured. */ - 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 { + repoReasoningEffort?: string; /** - * Configured MCP servers + * Context tier selected by repository settings, when configured. */ - 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; + repoContextTier?: string; + /** + * Model explicitly selected by the CLI, when provided. + */ + cliModel?: string; + /** + * Whether the overlay is being applied while resuming a deferred session. + */ + deferredResume?: boolean; } /** - * Env-value mode recorded on the session after the update. + * Optional capability overrides (vision, tool_calls, reasoning, etc.). * * This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema - * via the `definition` "McpSetEnvValueModeResult". + * via the `definition` "ModelCapabilitiesOverride". */ /** @experimental */ -export interface McpSetEnvValueModeResult { - mode: McpSetEnvValueModeDetails; +export interface ModelCapabilitiesOverride { + supports?: ModelCapabilitiesOverrideSupports; + limits?: ModelCapabilitiesOverrideLimits; } /** - * Server name and configuration for an individual MCP server start. + * Feature flags indicating what the model supports * * This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema - * via the `definition` "McpStartServerRequest". + * via the `definition` "ModelCapabilitiesOverrideSupports". */ /** @experimental */ -export interface McpStartServerRequest { +export interface ModelCapabilitiesOverrideSupports { /** - * Name of the MCP server to start + * Whether this model supports vision/image input */ - serverName: string; - config: McpServerConfig; + vision?: boolean; + /** + * Whether this model supports reasoning effort configuration + */ + reasoningEffort?: boolean; + adaptive_thinking?: AdaptiveThinkingSupport; } /** - * MCP server startup filtering result. + * Token limits for prompts, outputs, and context window * * This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema - * via the `definition` "McpStartServersResult". + * via the `definition` "ModelCapabilitiesOverrideLimits". */ /** @experimental */ -export interface McpStartServersResult { +export interface ModelCapabilitiesOverrideLimits { /** - * Servers filtered out before startup + * Maximum number of prompt/input tokens */ - filteredServers: McpFilteredServer[]; + max_prompt_tokens?: number; /** - * Non-default servers allowed by policy + * Maximum number of output/completion tokens */ - allowedServers?: McpAllowedServer[]; + max_output_tokens?: number; + /** + * Maximum total context window size in tokens + */ + max_context_window_tokens?: number; + vision?: ModelCapabilitiesOverrideLimitsVision; } /** - * Server name for an individual MCP server stop. + * Vision-specific limits * * This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema - * via the `definition` "McpStopServerRequest". + * via the `definition` "ModelCapabilitiesOverrideLimitsVision". */ /** @experimental */ -export interface McpStopServerRequest { +export interface ModelCapabilitiesOverrideLimitsVision { /** - * Name of the MCP server to stop + * MIME types the model accepts */ - serverName: string; + supported_media_types?: string[]; + /** + * Maximum number of images per prompt + */ + max_prompt_images?: number; + /** + * Maximum image size in bytes + */ + max_prompt_image_size?: number; } /** - * Server name identifying the external client to remove. + * 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` "McpUnregisterExternalClientRequest". + * via the `definition` "ModelList". */ /** @experimental */ -/** @internal */ -export interface McpUnregisterExternalClientRequest { +export interface ModelList { /** - * Server name of the external client to unregister + * List of available models with full metadata */ - serverName: string; + models: Model[]; } -/** - * Memory configuration for this session. - * - * This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema - * via the `definition` "MemoryConfiguration". - */ + /** @experimental */ -export interface MemoryConfiguration { +export interface ModelPickerPersistenceRequest { + settingsContext: ModelPickerSettingsContext; /** - * Whether memory is enabled for the session. + * Whether reasoning effort was explicitly selected and should be persisted. */ - enabled: boolean; + reasoningEffortExplicit?: boolean; + /** + * Whether context tier was explicitly selected and should be persisted. + */ + contextTierExplicit?: boolean; } /** - * Per-source attribution breakdown for the session's current context window, or null if uninitialized. + * Filesystem and environment context used to resolve model-picker settings. * * This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema - * via the `definition` "MetadataContextAttributionResult". + * via the `definition` "ModelPickerSettingsContext". */ /** @experimental */ -export interface MetadataContextAttributionResult { +export interface ModelPickerSettingsContext { /** - * Per-source context-window attribution, or null if the session has not yet been initialized (no system prompt or tool metadata cached). + * Optional Copilot configuration directory containing persisted settings. */ - contextAttribution?: SessionContextAttribution | null; + configDir?: string; + /** + * User home directory used when resolving persisted settings. + */ + homeDirectory: string; + /** + * Environment variables consulted while resolving model-picker settings. + */ + environment: {}; } /** - * Parameters for the heaviest-messages query. + * Reasoning effort level to apply to the currently selected model. * * This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema - * via the `definition` "MetadataContextHeaviestMessagesRequest". + * via the `definition` "ModelSetReasoningEffortRequest". */ /** @experimental */ -export interface MetadataContextHeaviestMessagesRequest { +export interface ModelSetReasoningEffortRequest { /** - * Maximum number of messages to return, most-expensive first. Omit for the server default. + * 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. */ - limit?: number; + reasoningEffort: string; } /** - * The heaviest individual messages in the session's context window, most-expensive first. + * 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` "MetadataContextHeaviestMessagesResult". + * via the `definition` "ModelSetReasoningEffortResult". */ /** @experimental */ -export interface MetadataContextHeaviestMessagesResult { +export interface ModelSetReasoningEffortResult { /** - * Total token count of the current context window, so callers can compute each message's share without a second call. + * Reasoning effort level recorded on the session after the update */ - totalTokens: number; + reasoningEffort: string; +} + +/** @experimental */ +export interface ModelsListRequest { /** - * Heaviest messages, most-expensive first. + * Opaque account identifier returned by `account.getAllUsers`. When omitted, the current account is used. */ - messages: ContextHeaviestMessage[]; + selectionId?: string; + /** + * GitHub token accepted for compatibility with existing SDK clients. When provided, resolves this token instead of using the current account. + */ + gitHubToken?: string; } -/** - * 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 { +export interface ModelSwitchConfirmation { /** - * Maximum prompt tokens allowed by the target model. Pass 0 to use the runtime default. + * Display name of the model that requires compaction confirmation. */ - promptTokenLimit: number; + targetModelDisplayName: string; /** - * Maximum output tokens allowed by the target model. Pass 0 if unknown. + * Current conversation token count before switching models. */ - outputTokenLimit: number; + currentTokens: number; /** - * Model identifier used for tokenization. Omit to use the session default. Used both for token counting and to compute display values. + * Target model token limit used by the compaction preflight. */ - selectedModel?: string; + targetLimit: number; } /** - * Token breakdown for the session's current context window, or null if uninitialized. + * 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` "MetadataContextInfoResult". + * via the `definition` "ModelSwitchToRequest". */ /** @experimental */ -export interface MetadataContextInfoResult { +export interface ModelSwitchToRequest { /** - * Token breakdown for the current context window, or null if the session has not yet been initialized (no system prompt or tool metadata cached). + * 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. */ - contextInfo?: SessionContextInfo | null; + modelId: 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. + */ + reasoningEffort?: string; + reasoningSummary?: ReasoningSummary; + verbosity?: Verbosity; + modelCapabilities?: ModelCapabilitiesOverride; + contextTier?: ContextTier; + source?: ModelChangeSource; + /** + * 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?: boolean; + /** + * Explicit response to a model-switch compaction preflight. Omit to request a confirmation projection when compaction is necessary. + */ + compactionDecision?: string; + /** + * When true, evaluate context-window compaction policy before applying the switch. + */ + runCompactionPreflight?: boolean; + /** + * Optional repository settings scope to persist after the switch commits. + */ + repoScope?: string; + /** + * Settings scope used when persisting the selected model. + */ + modelChangeScope?: string; + /** + * Require the target to be currently available and enabled before applying the switch. + */ + requireAvailable?: boolean; + pickerPersistence?: ModelPickerPersistenceRequest; } /** - * Indicates whether the local session is currently processing a turn or background continuation. + * The model identifier active on the session after the switch. * * This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema - * via the `definition` "MetadataIsProcessingResult". + * via the `definition` "ModelSwitchToResult". */ /** @experimental */ -export interface MetadataIsProcessingResult { +export interface ModelSwitchToResult { /** - * 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. + * Currently active model identifier after the switch */ - processing: boolean; + modelId?: string; + /** + * 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?: boolean; + /** + * Lifecycle result for the requested switch + */ + status?: string; + confirmation?: ModelSwitchConfirmation; + /** + * Persistence failure encountered after applying the model switch. + */ + persistenceError?: string; + /** + * User-facing outcome message for the model switch. + */ + message?: string; + /** + * User-facing warning produced while applying the model switch. + */ + warning?: string; + /** + * Deprecation warnings associated with the selected model or options. + */ + deprecationWarnings?: string[]; } /** - * Model identifier to use when re-tokenizing the session's existing messages. + * Agent interaction mode to apply to the session. * * This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema - * via the `definition` "MetadataRecomputeContextTokensRequest". + * via the `definition` "ModeSetRequest". */ /** @experimental */ -export interface MetadataRecomputeContextTokensRequest { +export interface ModeSetRequest { + mode: SessionMode; /** - * Model identifier used for tokenization. The runtime token-counts both chat-context and system-context messages against this model. + * Session whose plan-mode base state should be inherited. */ - modelId: string; + inheritPlanBaseFromSessionId?: string; + /** + * Whether a dedicated plan model is configured. + */ + planModelConfigured?: boolean; + /** + * Dedicated model to use in plan mode, when configured. + */ + planModel?: string; + /** + * Reasoning effort to use with the dedicated plan model. + */ + planReasoningEffort?: string; + /** + * Context tier to use with the dedicated plan model. + */ + planContextTier?: string; + /** + * Explicit response to a model-switch compaction preflight. + */ + compactionDecision?: string; + /** + * Whether leaving plan mode should restore the session's previous model. + */ + restorePlanModel?: boolean; + /** + * Whether the selected plan model should be persisted. + */ + persistPlanSelection?: boolean; + pickerSettingsContext?: ModelPickerSettingsContext; + /** + * Action to perform when leaving plan mode. + */ + planExitAction?: 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. + * Outcome of a session mode change, including any model switch it triggered and follow-up the host must perform. * * This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema - * via the `definition` "MetadataRecomputeContextTokensResult". + * via the `definition` "ModeSetResult". */ /** @experimental */ -export interface MetadataRecomputeContextTokensResult { +export interface ModeSetResult { /** - * Sum of tokens across chat-context and system-context messages currently held by the session. + * Lifecycle status of the requested mode change. */ - totalTokens: number; + status: string; /** - * Tokens contributed by user/assistant/tool messages (excludes system/developer prompts). + * Whether applying the mode changed the active model. */ - messagesTokenCount: number; + modelChanged: boolean; + confirmation?: ModelSwitchConfirmation; /** - * Tokens contributed by system/developer prompt snapshots. + * User-facing warning produced while applying the mode change. */ - systemTokenCount: number; + warning?: string; + /** + * User-facing outcome message for the model switch triggered by the mode change. + */ + message?: string; + /** + * Deprecation warnings associated with the model selected by the mode change. + */ + deprecationWarnings?: string[]; + /** + * Whether the host must defer implementing the requested mode change. + */ + deferImplementation?: boolean; + /** + * Whether the host should arm an interactive continuation after the mode change. + */ + armInteractiveContinuation?: boolean; } /** - * Updated working-directory/git context to record on the session. + * Result of moving in-flight MCP loading to the background. * * This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema - * via the `definition` "MetadataRecordContextChangeRequest". + * via the `definition` "MoveMcpLoadingToBackgroundResult". */ /** @experimental */ -export interface MetadataRecordContextChangeRequest { - context: SessionWorkingDirectoryContext; +export interface MoveMcpLoadingToBackgroundResult { + /** + * Whether an in-flight MCP load was moved to the background, releasing turns that were waiting on it. False when no MCP load was in flight or the waiting turns had already been released. + */ + movedToBackground: boolean; } /** - * Updated working directory and git context. Emitted as the new payload of `session.context_changed`. + * External SDK input for a named custom model provider. Ingested by the native protocol boundary before host dispatch. * * This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema - * via the `definition` "SessionWorkingDirectoryContext". + * via the `definition` "NamedProviderConfig". */ /** @experimental */ -export interface SessionWorkingDirectoryContext { - /** - * Current working directory path - */ - cwd: string; +export interface NamedProviderConfig { /** - * Root directory of the git repository, resolved via git rev-parse + * Unique provider name used to qualify model selection IDs. */ - gitRoot?: string; + name: string; + type?: ProviderConfigType; + wireApi?: ProviderConfigWireApi; + transport?: ProviderConfigTransport; /** - * Repository identifier derived from the git remote URL ("owner/name" for GitHub, "org/project/repo" for Azure DevOps) + * Base URL for provider API requests. */ - repository?: string; - hostType?: SessionWorkingDirectoryContextHostType; + baseUrl: string; /** - * Raw host string from the git remote URL (e.g. "github.com", "dev.azure.com") + * Static API key used to authenticate provider requests. */ - repositoryHost?: string; + apiKey?: string; /** - * Current git branch name + * Static bearer token used to authenticate provider requests. */ - branch?: string; + bearerToken?: string; + azure?: ProviderConfigAzure; /** - * Head commit of the current git branch + * Additional HTTP headers included with provider requests. */ - headCommit?: string; + headers?: { + [k: string]: string | undefined; + }; /** - * Merge-base commit SHA (fork point from the remote default branch) + * Whether the host supplies bearer tokens dynamically. */ - baseCommit?: string; + hasBearerTokenProvider?: boolean; } /** - * 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. + * Azure-specific provider options. * * This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema - * via the `definition` "MetadataRecordContextChangeResult". + * via the `definition` "ProviderConfigAzure". */ /** @experimental */ -export interface MetadataRecordContextChangeResult {} +export interface ProviderConfigAzure { + /** + * API version. When set, uses the versioned deployment route. When omitted, uses the GA versionless v1 route. + */ + apiVersion?: string; +} /** - * 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. + * The session's friendly name, or null when not yet set. * * This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema - * via the `definition` "MetadataSetWorkingDirectoryRequest". + * via the `definition` "NameGetResult". */ /** @experimental */ -export interface MetadataSetWorkingDirectoryRequest { +export interface NameGetResult { /** - * 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 session name (user-set or auto-generated), or null if not yet set */ - workingDirectory: string; + name: string | null; } /** - * 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. + * 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` "MetadataSetWorkingDirectoryResult". + * via the `definition` "NameSetAutoRequest". */ /** @experimental */ -export interface MetadataSetWorkingDirectoryResult { +export interface NameSetAutoRequest { /** - * Working directory after the update + * Auto-generated session summary. Empty/whitespace-only values are ignored; values are trimmed before persisting. */ - workingDirectory: string; + summary: string; } /** - * Remote-session-specific metadata. Populated only when `isRemote` is true. Fields are immutable for the lifetime of the session. + * 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` "MetadataSnapshotRemoteMetadata". + * via the `definition` "NameSetAutoResult". */ /** @experimental */ -export interface MetadataSnapshotRemoteMetadata { - /** - * The original resource identifier (task ID or PR node ID), preserved across event-replay reconstructions. Falls back to `sessionId` when absent. - */ - resourceId?: string; - repository: MetadataSnapshotRemoteMetadataRepository; +export interface NameSetAutoResult { /** - * The pull request number the remote session is associated with, if any. + * 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. */ - pullRequestNumber?: number; - taskType?: MetadataSnapshotRemoteMetadataTaskType; + applied: boolean; } /** - * The repository the remote session targets. + * New friendly name to apply to the session. * * This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema - * via the `definition` "MetadataSnapshotRemoteMetadataRepository". + * via the `definition` "NameSetRequest". */ /** @experimental */ -export interface MetadataSnapshotRemoteMetadataRepository { - /** - * The GitHub owner (user or organization) of the target repository. - */ - owner: string; +export interface NameSetRequest { /** - * The GitHub repository name (without owner). + * New session name (1–100 characters, trimmed of leading/trailing whitespace) */ name: string; - /** - * The branch the remote session is operating on. - */ - branch: string; } /** - * Copilot model metadata, including identifier, display name, capabilities, policy, billing, reasoning efforts, and picker categories. + * 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` "Model". + * via the `definition` "OptionsUpdateAdditionalContentExclusionPolicy". */ /** @experimental */ -export interface Model { - /** - * Model identifier (e.g., "claude-sonnet-4.5") - */ - id: string; - /** - * Display name - */ - name: string; - capabilities: ModelCapabilities; - policy?: ModelPolicy; - billing?: ModelBilling; +export interface OptionsUpdateAdditionalContentExclusionPolicy { /** - * Supported reasoning effort levels (only present if model supports reasoning effort) + * Content-exclusion rules to apply. */ - supportedReasoningEfforts?: string[]; + rules: OptionsUpdateAdditionalContentExclusionPolicyRule[]; /** - * Default reasoning effort level (only present if model supports reasoning effort) + * Opaque policy update timestamp supplied by the host. */ - defaultReasoningEffort?: string; - modelPickerCategory?: ModelPickerCategory; - modelPickerPriceCategory?: ModelPickerPriceCategory; -} -/** - * Model capabilities and limits - * - * This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema - * via the `definition` "ModelCapabilities". - */ -/** @experimental */ -export interface ModelCapabilities { - supports?: ModelCapabilitiesSupports; - limits?: ModelCapabilitiesLimits; + last_updated_at: JsonValue; + scope: OptionsUpdateAdditionalContentExclusionPolicyScope; } /** - * Feature flags indicating what the model supports + * 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` "ModelCapabilitiesSupports". + * via the `definition` "OptionsUpdateAdditionalContentExclusionPolicyRule". */ /** @experimental */ -export interface ModelCapabilitiesSupports { +export interface OptionsUpdateAdditionalContentExclusionPolicyRule { /** - * Whether this model supports vision/image input + * Path patterns covered by this rule. */ - vision?: boolean; + paths: string[]; /** - * Whether this model supports reasoning effort configuration + * Conditions of which at least one must match. */ - reasoningEffort?: boolean; - adaptive_thinking?: AdaptiveThinkingSupport; + ifAnyMatch?: string[]; + /** + * Conditions none of which may match. + */ + ifNoneMatch?: string[]; + source: OptionsUpdateAdditionalContentExclusionPolicyRuleSource; } /** - * Token limits for prompts, outputs, and context window + * 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` "ModelCapabilitiesLimits". + * via the `definition` "OptionsUpdateAdditionalContentExclusionPolicyRuleSource". */ /** @experimental */ -export interface ModelCapabilitiesLimits { - /** - * Maximum number of prompt/input tokens - */ - max_prompt_tokens?: number; +export interface OptionsUpdateAdditionalContentExclusionPolicyRuleSource { /** - * Maximum number of output/completion tokens + * Name of the policy source. */ - max_output_tokens?: number; + name: string; /** - * Maximum total context window size in tokens + * Type of the policy source. */ - max_context_window_tokens?: number; - vision?: ModelCapabilitiesLimitsVision; + type: string; } /** - * Vision-specific limits + * 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` "ModelCapabilitiesLimitsVision". + * via the `definition` "PendingPermissionRequest". */ /** @experimental */ -export interface ModelCapabilitiesLimitsVision { - /** - * MIME types the model accepts - */ - supported_media_types: string[]; - /** - * Maximum number of images per prompt - */ - max_prompt_images: number; +export interface PendingPermissionRequest { /** - * Maximum image size in bytes + * Unique identifier for the pending permission request */ - max_prompt_image_size: number; + requestId: string; + request: PermissionPromptRequest; } /** - * Policy state (if applicable) + * List of pending permission requests reconstructed from event history. * * This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema - * via the `definition` "ModelPolicy". + * via the `definition` "PendingPermissionRequestList". */ /** @experimental */ -export interface ModelPolicy { - state: ModelPolicyState; +export interface PendingPermissionRequestList { /** - * Usage terms or conditions for this model + * 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. */ - terms?: string; + items: PendingPermissionRequest[]; } /** - * Billing information + * Permission-decision request variant to approve only the current permission request. * * This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema - * via the `definition` "ModelBilling". + * via the `definition` "PermissionDecisionApproveOnce". */ /** @experimental */ -export interface ModelBilling { +export interface PermissionDecisionApproveOnce { /** - * Billing cost multiplier relative to the base rate + * Approve this single request only */ - multiplier?: number; - tokenPrices?: ModelBillingTokenPrices; + kind: "approve-once"; /** - * 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. + * True only when a host surfaced this request to a user who approved it. */ - discountPercent?: number; - promo?: ModelBillingPromo; + approvedInteractively?: boolean; } /** - * Token-level pricing information for this model + * 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` "ModelBillingTokenPrices". + * via the `definition` "PermissionDecisionApproveForSession". */ /** @experimental */ -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; +export interface PermissionDecisionApproveForSession { /** - * @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. + * Approve and remember for the rest of the session */ - contextMax?: number; + kind: "approve-for-session"; + approval?: PermissionDecisionApproveForSessionApproval; /** - * Prompt token budget for the default tier. The total context window is this value plus the model's max_output_tokens. + * URL domain to approve for the rest of the session (URL prompts only) */ - maxPromptTokens?: number; - longContext?: ModelBillingTokenPricesLongContext; + domain?: string; } /** - * Long context tier pricing (available for models with extended context windows) + * Session-scoped approval details for specific command identifiers. * * This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema - * via the `definition` "ModelBillingTokenPricesLongContext". + * via the `definition` "PermissionDecisionApproveForSessionApprovalCommands". */ /** @experimental */ -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; +export interface PermissionDecisionApproveForSessionApprovalCommands { /** - * AI Credits cost per billing batch of cache-write (cache creation) tokens. + * Approval scoped to specific command identifiers. */ - 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. + kind: "commands"; + /** + * Command identifiers covered by this approval. */ - contextMax?: number; + commandIdentifiers: string[]; +} +/** + * Session-scoped approval details for read-only filesystem operations. + * + * This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema + * via the `definition` "PermissionDecisionApproveForSessionApprovalRead". + */ +/** @experimental */ +export interface PermissionDecisionApproveForSessionApprovalRead { /** - * Prompt token budget for the long context tier. The total context window is this value plus the model's max_output_tokens. + * Approval covering read-only filesystem operations. */ - maxPromptTokens?: number; + kind: "read"; } /** - * Active server-driven promotion for a model, including its discount and expiry. + * Session-scoped approval details for filesystem write operations. * * This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema - * via the `definition` "ModelBillingPromo". + * via the `definition` "PermissionDecisionApproveForSessionApprovalWrite". */ /** @experimental */ -export interface ModelBillingPromo { +export interface PermissionDecisionApproveForSessionApprovalWrite { /** - * Stable identifier for the promotion campaign. + * Approval covering filesystem write operations. */ - id?: string; + kind: "write"; +} +/** + * 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` "PermissionDecisionApproveForSessionApprovalMcp". + */ +/** @experimental */ +export interface PermissionDecisionApproveForSessionApprovalMcp { /** - * Percentage discount (0-100) applied while the promotion is active. May be fractional. + * Approval covering an MCP tool. */ - discountPercent?: number; + kind: "mcp"; /** - * UTC ISO 8601 timestamp marking when the promotion ends. Always present: the API only surfaces a promo whose expiry parses and is in the future. Consumers should treat a past value as expired. + * MCP server name. */ - endsAt: string; + serverName: string; /** - * Human-readable promotion message. Does not include the expiry timestamp; consumers may format endsAt and append it. + * MCP tool name, or null to cover every tool on the server. */ - message?: string; + toolName: string | null; } /** - * Optional capability overrides (vision, tool_calls, reasoning, etc.). + * Session-scoped approval details for MCP sampling requests from a server. * * This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema - * via the `definition` "ModelCapabilitiesOverride". + * via the `definition` "PermissionDecisionApproveForSessionApprovalMcpSampling". */ /** @experimental */ -export interface ModelCapabilitiesOverride { - supports?: ModelCapabilitiesOverrideSupports; - limits?: ModelCapabilitiesOverrideLimits; +export interface PermissionDecisionApproveForSessionApprovalMcpSampling { + /** + * Approval covering MCP sampling requests for a server. + */ + kind: "mcp-sampling"; + /** + * MCP server name. + */ + serverName: string; } /** - * Feature flags indicating what the model supports + * Session-scoped approval details for writes to long-term memory. * * This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema - * via the `definition` "ModelCapabilitiesOverrideSupports". + * via the `definition` "PermissionDecisionApproveForSessionApprovalMemory". */ /** @experimental */ -export interface ModelCapabilitiesOverrideSupports { - /** - * Whether this model supports vision/image input - */ - vision?: boolean; +export interface PermissionDecisionApproveForSessionApprovalMemory { /** - * Whether this model supports reasoning effort configuration + * Approval covering writes to long-term memory. */ - reasoningEffort?: boolean; - adaptive_thinking?: AdaptiveThinkingSupport; + kind: "memory"; } /** - * Token limits for prompts, outputs, and context window + * Session-scoped approval details for a custom tool, keyed by tool name. * * This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema - * via the `definition` "ModelCapabilitiesOverrideLimits". + * via the `definition` "PermissionDecisionApproveForSessionApprovalCustomTool". */ /** @experimental */ -export interface ModelCapabilitiesOverrideLimits { - /** - * Maximum number of prompt/input tokens - */ - max_prompt_tokens?: number; +export interface PermissionDecisionApproveForSessionApprovalCustomTool { /** - * Maximum number of output/completion tokens + * Approval covering a custom tool. */ - max_output_tokens?: number; + kind: "custom-tool"; /** - * Maximum total context window size in tokens + * Custom tool name. */ - max_context_window_tokens?: number; - vision?: ModelCapabilitiesOverrideLimitsVision; + toolName: string; } /** - * Vision-specific limits + * Session-scoped approval details for extension-management operations, optionally narrowed by operation. * * This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema - * via the `definition` "ModelCapabilitiesOverrideLimitsVision". + * via the `definition` "PermissionDecisionApproveForSessionApprovalExtensionManagement". */ /** @experimental */ -export interface ModelCapabilitiesOverrideLimitsVision { - /** - * MIME types the model accepts - */ - supported_media_types?: string[]; +export interface PermissionDecisionApproveForSessionApprovalExtensionManagement { /** - * Maximum number of images per prompt + * Approval covering extension lifecycle operations such as enable, disable, or reload. */ - max_prompt_images?: number; + kind: "extension-management"; /** - * Maximum image size in bytes + * Optional operation identifier; when omitted, the approval covers all extension management operations. */ - max_prompt_image_size?: number; + operation?: string; } /** - * List of Copilot models available to the resolved user, including capabilities and billing metadata. + * Session-scoped factory approval, optionally narrowed by approval key. * * This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema - * via the `definition` "ModelList". + * via the `definition` "PermissionDecisionApproveForSessionApprovalFactory". */ /** @experimental */ -export interface ModelList { +export interface PermissionDecisionApproveForSessionApprovalFactory { /** - * List of available models with full metadata + * Approval covering factory operations. */ - models: Model[]; + kind: "factory"; + /** + * Optional factory operation name or canonical approval key; when omitted, the approval covers all factory operations. + */ + approvalKey?: string; } /** - * Optional listing options. + * 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` "ModelListRequest". + * via the `definition` "PermissionDecisionApproveForSessionApprovalExtensionPermissionAccess". */ /** @experimental */ -export interface ModelListRequest { +export interface PermissionDecisionApproveForSessionApprovalExtensionPermissionAccess { /** - * If true, bypasses the per-session model list cache and re-fetches from CAPI. + * Approval covering an extension's request to access a permission-gated capability. */ - skipCache?: boolean; + kind: "extension-permission-access"; + /** + * Extension name. + */ + extensionName: string; } /** - * Reasoning effort level to apply to the currently selected model. + * Session-scoped approval details for an extension's access to sensitive environment variables, keyed by extension name and the exact set of variable names. * * This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema - * via the `definition` "ModelSetReasoningEffortRequest". + * via the `definition` "PermissionDecisionApproveForSessionApprovalExtensionEnvAccess". */ /** @experimental */ -export interface ModelSetReasoningEffortRequest { +export interface PermissionDecisionApproveForSessionApprovalExtensionEnvAccess { /** - * 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. + * Approval covering an extension's request to read sensitive environment variables. */ - reasoningEffort: string; + kind: "extension-env-access"; + /** + * Extension name. + */ + extensionName: string; + /** + * Names of the sensitive environment variables this approval covers. Values are never persisted. + * + * @minItems 1 + */ + environmentVariables: [string, ...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. + * 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` "ModelSetReasoningEffortResult". + * via the `definition` "PermissionDecisionApproveForLocation". */ /** @experimental */ -export interface ModelSetReasoningEffortResult { +export interface PermissionDecisionApproveForLocation { /** - * Reasoning effort level recorded on the session after the update + * Approve and persist for this project location */ - reasoningEffort: string; -} - -/** @experimental */ -export interface ModelsListRequest { + kind: "approve-for-location"; + approval: PermissionDecisionApproveForLocationApproval; /** - * 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. + * Location key (git root or cwd) to persist the approval to */ - gitHubToken?: string; + locationKey: string; } /** - * Target model identifier and optional reasoning effort, summary, capability overrides, and context tier. + * Location-scoped approval details for specific command identifiers. * * This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema - * via the `definition` "ModelSwitchToRequest". + * via the `definition` "PermissionDecisionApproveForLocationApprovalCommands". */ /** @experimental */ -export interface ModelSwitchToRequest { +export interface PermissionDecisionApproveForLocationApprovalCommands { /** - * 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. + * Approval scoped to specific command identifiers. */ - modelId: string; + kind: "commands"; /** - * Reasoning effort level to use for the model. "none" disables reasoning. + * Command identifiers covered by this approval. */ - reasoningEffort?: string; - reasoningSummary?: ReasoningSummary; - verbosity?: Verbosity; - modelCapabilities?: ModelCapabilitiesOverride; - contextTier?: ContextTier; + commandIdentifiers: string[]; } /** - * The model identifier active on the session after the switch. + * Location-scoped approval details for read-only filesystem operations. * * This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema - * via the `definition` "ModelSwitchToResult". + * via the `definition` "PermissionDecisionApproveForLocationApprovalRead". */ /** @experimental */ -export interface ModelSwitchToResult { +export interface PermissionDecisionApproveForLocationApprovalRead { /** - * Currently active model identifier after the switch + * Approval covering read-only filesystem operations. */ - modelId?: string; + kind: "read"; } /** - * Agent interaction mode to apply to the session. + * Location-scoped approval details for filesystem write operations. * * This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema - * via the `definition` "ModeSetRequest". + * via the `definition` "PermissionDecisionApproveForLocationApprovalWrite". */ /** @experimental */ -export interface ModeSetRequest { - mode: SessionMode; +export interface PermissionDecisionApproveForLocationApprovalWrite { + /** + * Approval covering filesystem write operations. + */ + kind: "write"; } /** - * A named BYOK provider connection (transport + credentials). + * 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` "NamedProviderConfig". + * via the `definition` "PermissionDecisionApproveForLocationApprovalMcp". */ /** @experimental */ -export interface NamedProviderConfig { - /** - * Stable identifier referenced by BYOK model definitions. Must not contain '/'. - */ - name: string; - type?: ProviderConfigType; - wireApi?: ProviderConfigWireApi; - transport?: ProviderConfigTransport; +export interface PermissionDecisionApproveForLocationApprovalMcp { /** - * API endpoint URL. + * Approval covering an MCP tool. */ - baseUrl: string; + kind: "mcp"; /** - * API key. Optional for local providers like Ollama. + * MCP server name. */ - apiKey?: string; + serverName: string; /** - * Bearer token for authentication. Sets the Authorization header directly. Takes precedence over apiKey when both are set. + * MCP tool name, or null to cover every tool on the server. */ - bearerToken?: string; - azure?: ProviderConfigAzure; + toolName: string | null; +} +/** + * Location-scoped approval details for MCP sampling requests from a server. + * + * This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema + * via the `definition` "PermissionDecisionApproveForLocationApprovalMcpSampling". + */ +/** @experimental */ +export interface PermissionDecisionApproveForLocationApprovalMcpSampling { /** - * Custom HTTP headers to include in all outbound requests to the provider. + * Approval covering MCP sampling requests for a server. */ - headers?: { - [k: string]: string | undefined; - }; + kind: "mcp-sampling"; /** - * 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. + * MCP server name. */ - hasBearerTokenProvider?: boolean; + serverName: string; } /** - * Azure-specific provider options. + * Location-scoped approval details for writes to long-term memory. * * This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema - * via the `definition` "ProviderConfigAzure". + * via the `definition` "PermissionDecisionApproveForLocationApprovalMemory". */ /** @experimental */ -export interface ProviderConfigAzure { +export interface PermissionDecisionApproveForLocationApprovalMemory { /** - * API version. When set, uses the versioned deployment route. When omitted, uses the GA versionless v1 route. + * Approval covering writes to long-term memory. */ - apiVersion?: string; + kind: "memory"; } /** - * The session's friendly name, or null when not yet set. + * Location-scoped approval details for a custom tool, keyed by tool name. * * This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema - * via the `definition` "NameGetResult". + * via the `definition` "PermissionDecisionApproveForLocationApprovalCustomTool". */ /** @experimental */ -export interface NameGetResult { +export interface PermissionDecisionApproveForLocationApprovalCustomTool { /** - * The session name (user-set or auto-generated), or null if not yet set + * Approval covering a custom tool. */ - name: string | null; + kind: "custom-tool"; + /** + * Custom tool name. + */ + toolName: string; } /** - * Auto-generated session summary to apply as the session's name when no user-set name exists. + * Location-scoped approval details for extension-management operations, optionally narrowed by operation. * * This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema - * via the `definition` "NameSetAutoRequest". + * via the `definition` "PermissionDecisionApproveForLocationApprovalExtensionManagement". */ /** @experimental */ -export interface NameSetAutoRequest { +export interface PermissionDecisionApproveForLocationApprovalExtensionManagement { /** - * Auto-generated session summary. Empty/whitespace-only values are ignored; values are trimmed before persisting. + * Approval covering extension lifecycle operations such as enable, disable, or reload. */ - summary: string; + kind: "extension-management"; + /** + * Optional operation identifier; when omitted, the approval covers all extension management operations. + */ + operation?: string; } /** - * Indicates whether the auto-generated summary was applied as the session's name. + * Location-scoped factory approval, optionally narrowed by approval key. * * This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema - * via the `definition` "NameSetAutoResult". + * via the `definition` "PermissionDecisionApproveForLocationApprovalFactory". */ /** @experimental */ -export interface NameSetAutoResult { +export interface PermissionDecisionApproveForLocationApprovalFactory { /** - * 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. + * Approval covering factory operations. */ - applied: boolean; + kind: "factory"; + /** + * Optional factory operation name or canonical approval key; when omitted, the approval covers all factory operations. + */ + approvalKey?: string; } /** - * New friendly name to apply to the session. + * 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` "NameSetRequest". + * via the `definition` "PermissionDecisionApproveForLocationApprovalExtensionPermissionAccess". */ /** @experimental */ -export interface NameSetRequest { +export interface PermissionDecisionApproveForLocationApprovalExtensionPermissionAccess { /** - * New session name (1–100 characters, trimmed of leading/trailing whitespace) + * Approval covering an extension's request to access a permission-gated capability. */ - name: string; + kind: "extension-permission-access"; + /** + * Extension name. + */ + extensionName: string; } /** - * Content-exclusion policy supplied to `session.options.update`, with rules, last-updated data, and scope. + * Location-scoped approval details for an extension's access to sensitive environment variables, keyed by extension name and the exact set of variable names. * * This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema - * via the `definition` "OptionsUpdateAdditionalContentExclusionPolicy". + * via the `definition` "PermissionDecisionApproveForLocationApprovalExtensionEnvAccess". */ /** @experimental */ -export interface OptionsUpdateAdditionalContentExclusionPolicy { - rules: OptionsUpdateAdditionalContentExclusionPolicyRule[]; - last_updated_at: unknown; - scope: OptionsUpdateAdditionalContentExclusionPolicyScope; +export interface PermissionDecisionApproveForLocationApprovalExtensionEnvAccess { + /** + * Approval covering an extension's request to read sensitive environment variables. + */ + kind: "extension-env-access"; + /** + * Extension name. + */ + extensionName: string; + /** + * Names of the sensitive environment variables this approval covers. Values are never persisted. + * + * @minItems 1 + */ + environmentVariables: [string, ...string[]]; } /** - * Single content-exclusion rule supplied to `session.options.update`, with paths, match conditions, and source. + * Permission-decision request variant to permanently approve a URL domain across sessions. * * This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema - * via the `definition` "OptionsUpdateAdditionalContentExclusionPolicyRule". + * via the `definition` "PermissionDecisionApprovePermanently". */ /** @experimental */ -export interface OptionsUpdateAdditionalContentExclusionPolicyRule { - paths: string[]; - ifAnyMatch?: string[]; - ifNoneMatch?: string[]; - source: OptionsUpdateAdditionalContentExclusionPolicyRuleSource; +export interface PermissionDecisionApprovePermanently { + /** + * Approve and persist across sessions (URL prompts only) + */ + kind: "approve-permanently"; + /** + * URL domain to approve permanently + */ + domain: string; } /** - * Source descriptor for a `session.options.update` content-exclusion rule, with source name and type. + * 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` "OptionsUpdateAdditionalContentExclusionPolicyRuleSource". + * via the `definition` "PermissionDecisionReject". */ /** @experimental */ -export interface OptionsUpdateAdditionalContentExclusionPolicyRuleSource { - name: string; - type: string; +export interface PermissionDecisionReject { + /** + * Reject the request + */ + kind: "reject"; + /** + * Optional feedback explaining the rejection + */ + feedback?: string; } /** - * Pending permission prompt reconstructed from event history, with request ID and user-facing prompt details. + * Permission-decision variant indicating no user was available to confirm the request. * * This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema - * via the `definition` "PendingPermissionRequest". + * via the `definition` "PermissionDecisionUserNotAvailable". */ /** @experimental */ -export interface PendingPermissionRequest { +export interface PermissionDecisionUserNotAvailable { /** - * Unique identifier for the pending permission request + * No user is available to confirm the request */ - requestId: string; - request: PermissionPromptRequest; + kind: "user-not-available"; } /** - * List of pending permission requests reconstructed from event history. + * Permission-decision variant indicating the request was approved. * * This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema - * via the `definition` "PendingPermissionRequestList". + * via the `definition` "PermissionDecisionApproved". */ /** @experimental */ -export interface PendingPermissionRequestList { +export interface PermissionDecisionApproved { /** - * 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. + * The permission request was approved */ - items: PendingPermissionRequest[]; + kind: "approved"; } /** - * Permission-decision request variant to approve only the current permission request. + * 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` "PermissionDecisionApproveOnce". + * via the `definition` "PermissionDecisionApprovedForSession". */ /** @experimental */ -export interface PermissionDecisionApproveOnce { +export interface PermissionDecisionApprovedForSession { /** - * Approve this single request only + * Approved and remembered for the rest of the session */ - kind: "approve-once"; + kind: "approved-for-session"; + approval: UserToolSessionApproval; } /** - * Permission-decision request variant to approve for the rest of the session, with optional tool approval or URL domain. + * 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` "PermissionDecisionApproveForSession". + * via the `definition` "PermissionDecisionApprovedForLocation". */ /** @experimental */ -export interface PermissionDecisionApproveForSession { +export interface PermissionDecisionApprovedForLocation { /** - * Approve and remember for the rest of the session + * Approved and persisted for this project location */ - kind: "approve-for-session"; - approval?: PermissionDecisionApproveForSessionApproval; + kind: "approved-for-location"; + approval: UserToolSessionApproval; /** - * URL domain to approve for the rest of the session (URL prompts only) + * The location key (git root or cwd) to persist the approval to */ - domain?: string; + locationKey: string; } /** - * Session-scoped approval details for specific command identifiers. + * 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` "PermissionDecisionApproveForSessionApprovalCommands". + * via the `definition` "PermissionDecisionCancelled". */ /** @experimental */ -export interface PermissionDecisionApproveForSessionApprovalCommands { +export interface PermissionDecisionCancelled { /** - * Approval scoped to specific command identifiers. + * The permission request was cancelled before a response was used */ - kind: "commands"; + kind: "cancelled"; /** - * Command identifiers covered by this approval. + * Optional explanation of why the request was cancelled */ - commandIdentifiers: string[]; + reason?: string; } /** - * Session-scoped approval details for read-only filesystem operations. + * 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` "PermissionDecisionApproveForSessionApprovalRead". + * via the `definition` "PermissionDecisionDeniedByRules". */ /** @experimental */ -export interface PermissionDecisionApproveForSessionApprovalRead { +export interface PermissionDecisionDeniedByRules { /** - * Approval covering read-only filesystem operations. + * Denied because approval rules explicitly blocked it */ - kind: "read"; + kind: "denied-by-rules"; + /** + * Rules that denied the request + */ + rules: PermissionRule[]; } /** - * Session-scoped approval details for filesystem write operations. + * 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` "PermissionDecisionApproveForSessionApprovalWrite". + * via the `definition` "PermissionDecisionDeniedNoApprovalRuleAndCouldNotRequestFromUser". */ /** @experimental */ -export interface PermissionDecisionApproveForSessionApprovalWrite { +export interface PermissionDecisionDeniedNoApprovalRuleAndCouldNotRequestFromUser { /** - * Approval covering filesystem write operations. + * Denied because no approval rule matched and user confirmation was unavailable */ - kind: "write"; + kind: "denied-no-approval-rule-and-could-not-request-from-user"; } /** - * Session-scoped approval details for an MCP server tool, or all tools on the server when `toolName` is null. + * 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` "PermissionDecisionApproveForSessionApprovalMcp". + * via the `definition` "PermissionDecisionDeniedInteractivelyByUser". */ /** @experimental */ -export interface PermissionDecisionApproveForSessionApprovalMcp { +export interface PermissionDecisionDeniedInteractivelyByUser { /** - * Approval covering an MCP tool. + * Denied by the user during an interactive prompt */ - kind: "mcp"; + kind: "denied-interactively-by-user"; /** - * MCP server name. + * Optional feedback from the user explaining the denial */ - serverName: string; + feedback?: string; /** - * MCP tool name, or null to cover every tool on the server. + * Whether to force-reject the current agent turn */ - toolName: string | null; + forceReject?: boolean; } /** - * Session-scoped approval details for MCP sampling requests from a server. + * 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` "PermissionDecisionApproveForSessionApprovalMcpSampling". + * via the `definition` "PermissionDecisionDeniedByContentExclusionPolicy". */ /** @experimental */ -export interface PermissionDecisionApproveForSessionApprovalMcpSampling { +export interface PermissionDecisionDeniedByContentExclusionPolicy { /** - * Approval covering MCP sampling requests for a server. + * Denied by the organization's content exclusion policy */ - kind: "mcp-sampling"; + kind: "denied-by-content-exclusion-policy"; /** - * MCP server name. + * File path that triggered the exclusion */ - serverName: string; -} -/** - * Session-scoped approval details for writes to long-term memory. - * - * This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema - * via the `definition` "PermissionDecisionApproveForSessionApprovalMemory". - */ -/** @experimental */ -export interface PermissionDecisionApproveForSessionApprovalMemory { + path: string; /** - * Approval covering writes to long-term memory. + * Human-readable explanation of why the path was excluded */ - kind: "memory"; + message: string; } /** - * Session-scoped approval details for a custom tool, keyed by tool name. + * 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` "PermissionDecisionApproveForSessionApprovalCustomTool". + * via the `definition` "PermissionDecisionDeniedByPermissionRequestHook". */ /** @experimental */ -export interface PermissionDecisionApproveForSessionApprovalCustomTool { +export interface PermissionDecisionDeniedByPermissionRequestHook { /** - * Approval covering a custom tool. + * Denied by a permission request hook registered by an extension or plugin */ - kind: "custom-tool"; + kind: "denied-by-permission-request-hook"; /** - * Custom tool name. + * Optional message from the hook explaining the denial */ - toolName: string; + message?: string; + /** + * Whether to interrupt the current agent turn + */ + interrupt?: boolean; } /** - * Session-scoped approval details for extension-management operations, optionally narrowed by operation. + * 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` "PermissionDecisionApproveForSessionApprovalExtensionManagement". + * via the `definition` "PermissionDecisionContext". */ /** @experimental */ -export interface PermissionDecisionApproveForSessionApprovalExtensionManagement { - /** - * Approval covering extension lifecycle operations such as enable, disable, or reload. - */ - kind: "extension-management"; - /** - * Optional operation identifier; when omitted, the approval covers all extension management operations. - */ - operation?: string; +export interface PermissionDecisionContext { + outcome: PermissionDecisionOutcome; + source: PermissionDecisionSource; + surface: PermissionDecisionSurface; + responseCapability?: PermissionResponseCapability; } /** - * Session-scoped approval details for an extension's permission-gated capability access, keyed by extension name. + * 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` "PermissionDecisionApproveForSessionApprovalExtensionPermissionAccess". + * via the `definition` "PermissionDecisionRequest". */ /** @experimental */ -export interface PermissionDecisionApproveForSessionApprovalExtensionPermissionAccess { - /** - * Approval covering an extension's request to access a permission-gated capability. - */ - kind: "extension-permission-access"; +export interface PermissionDecisionRequest { /** - * Extension name. + * Request ID of the pending permission request */ - extensionName: string; + requestId: string; + result: PermissionDecision; + decisionContext?: PermissionDecisionContext; } /** - * Permission-decision request variant to approve and persist a permission for a project location, with approval details and location key. + * Location-scoped tool approval to persist. * * This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema - * via the `definition` "PermissionDecisionApproveForLocation". + * via the `definition` "PermissionLocationAddToolApprovalParams". */ /** @experimental */ -export interface PermissionDecisionApproveForLocation { - /** - * Approve and persist for this project location - */ - kind: "approve-for-location"; - approval: PermissionDecisionApproveForLocationApproval; +export interface PermissionLocationAddToolApprovalParams { /** * Location key (git root or cwd) to persist the approval to */ locationKey: string; + approval: PermissionsLocationsAddToolApprovalDetails; } /** - * Location-scoped approval details for specific command identifiers. + * Location-persisted tool approval details for specific command identifiers. * * This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema - * via the `definition` "PermissionDecisionApproveForLocationApprovalCommands". + * via the `definition` "PermissionsLocationsAddToolApprovalDetailsCommands". */ /** @experimental */ -export interface PermissionDecisionApproveForLocationApprovalCommands { +export interface PermissionsLocationsAddToolApprovalDetailsCommands { /** * Approval scoped to specific command identifiers. */ @@ -8792,39 +13648,39 @@ export interface PermissionDecisionApproveForLocationApprovalCommands { commandIdentifiers: string[]; } /** - * Location-scoped approval details for read-only filesystem operations. + * Location-persisted tool approval details for read-only filesystem operations. * * This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema - * via the `definition` "PermissionDecisionApproveForLocationApprovalRead". + * via the `definition` "PermissionsLocationsAddToolApprovalDetailsRead". */ /** @experimental */ -export interface PermissionDecisionApproveForLocationApprovalRead { +export interface PermissionsLocationsAddToolApprovalDetailsRead { /** * Approval covering read-only filesystem operations. */ kind: "read"; } /** - * Location-scoped approval details for filesystem write operations. + * Location-persisted tool approval details for filesystem write operations. * * This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema - * via the `definition` "PermissionDecisionApproveForLocationApprovalWrite". + * via the `definition` "PermissionsLocationsAddToolApprovalDetailsWrite". */ /** @experimental */ -export interface PermissionDecisionApproveForLocationApprovalWrite { +export interface PermissionsLocationsAddToolApprovalDetailsWrite { /** * Approval covering filesystem write operations. */ kind: "write"; } /** - * Location-scoped approval details for an MCP server tool, or all tools on the server when `toolName` is null. + * 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` "PermissionDecisionApproveForLocationApprovalMcp". + * via the `definition` "PermissionsLocationsAddToolApprovalDetailsMcp". */ /** @experimental */ -export interface PermissionDecisionApproveForLocationApprovalMcp { +export interface PermissionsLocationsAddToolApprovalDetailsMcp { /** * Approval covering an MCP tool. */ @@ -8839,13 +13695,13 @@ export interface PermissionDecisionApproveForLocationApprovalMcp { toolName: string | null; } /** - * Location-scoped approval details for MCP sampling requests from a server. + * Location-persisted tool approval details for MCP sampling requests from a server. * * This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema - * via the `definition` "PermissionDecisionApproveForLocationApprovalMcpSampling". + * via the `definition` "PermissionsLocationsAddToolApprovalDetailsMcpSampling". */ /** @experimental */ -export interface PermissionDecisionApproveForLocationApprovalMcpSampling { +export interface PermissionsLocationsAddToolApprovalDetailsMcpSampling { /** * Approval covering MCP sampling requests for a server. */ @@ -8856,26 +13712,26 @@ export interface PermissionDecisionApproveForLocationApprovalMcpSampling { serverName: string; } /** - * Location-scoped approval details for writes to long-term memory. + * Location-persisted tool approval details for writes to long-term memory. * * This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema - * via the `definition` "PermissionDecisionApproveForLocationApprovalMemory". + * via the `definition` "PermissionsLocationsAddToolApprovalDetailsMemory". */ /** @experimental */ -export interface PermissionDecisionApproveForLocationApprovalMemory { +export interface PermissionsLocationsAddToolApprovalDetailsMemory { /** * Approval covering writes to long-term memory. */ kind: "memory"; } /** - * Location-scoped approval details for a custom tool, keyed by tool name. + * 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` "PermissionDecisionApproveForLocationApprovalCustomTool". + * via the `definition` "PermissionsLocationsAddToolApprovalDetailsCustomTool". */ /** @experimental */ -export interface PermissionDecisionApproveForLocationApprovalCustomTool { +export interface PermissionsLocationsAddToolApprovalDetailsCustomTool { /** * Approval covering a custom tool. */ @@ -8886,13 +13742,13 @@ export interface PermissionDecisionApproveForLocationApprovalCustomTool { toolName: string; } /** - * Location-scoped approval details for extension-management operations, optionally narrowed by operation. + * 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` "PermissionDecisionApproveForLocationApprovalExtensionManagement". + * via the `definition` "PermissionsLocationsAddToolApprovalDetailsExtensionManagement". */ /** @experimental */ -export interface PermissionDecisionApproveForLocationApprovalExtensionManagement { +export interface PermissionsLocationsAddToolApprovalDetailsExtensionManagement { /** * Approval covering extension lifecycle operations such as enable, disable, or reload. */ @@ -8903,2128 +13759,2248 @@ export interface PermissionDecisionApproveForLocationApprovalExtensionManagement operation?: string; } /** - * Location-scoped approval details for an extension's permission-gated capability access, keyed by extension name. + * Location-persisted factory approval, optionally narrowed by approval key. * * This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema - * via the `definition` "PermissionDecisionApproveForLocationApprovalExtensionPermissionAccess". + * via the `definition` "PermissionsLocationsAddToolApprovalDetailsFactory". */ /** @experimental */ -export interface PermissionDecisionApproveForLocationApprovalExtensionPermissionAccess { +export interface PermissionsLocationsAddToolApprovalDetailsFactory { /** - * Approval covering an extension's request to access a permission-gated capability. + * Approval covering factory operations. */ - kind: "extension-permission-access"; + kind: "factory"; /** - * Extension name. + * Optional factory operation name or canonical approval key; when omitted, the approval covers all factory operations. */ - extensionName: string; + approvalKey?: string; } /** - * Permission-decision request variant to permanently approve a URL domain across sessions. + * 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` "PermissionDecisionApprovePermanently". + * via the `definition` "PermissionsLocationsAddToolApprovalDetailsExtensionPermissionAccess". */ /** @experimental */ -export interface PermissionDecisionApprovePermanently { +export interface PermissionsLocationsAddToolApprovalDetailsExtensionPermissionAccess { /** - * Approve and persist across sessions (URL prompts only) + * Approval covering an extension's request to access a permission-gated capability. */ - kind: "approve-permanently"; + kind: "extension-permission-access"; /** - * URL domain to approve permanently + * Extension name. */ - domain: string; + extensionName: string; } /** - * Permission-decision request variant to reject a pending permission request, with optional feedback. + * Location-persisted tool approval details for an extension's access to sensitive environment variables, keyed by extension name and the exact set of variable names. * * This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema - * via the `definition` "PermissionDecisionReject". + * via the `definition` "PermissionsLocationsAddToolApprovalDetailsExtensionEnvAccess". */ /** @experimental */ -export interface PermissionDecisionReject { - /** - * Reject the request - */ - kind: "reject"; +export interface PermissionsLocationsAddToolApprovalDetailsExtensionEnvAccess { /** - * Optional feedback explaining the rejection + * Approval covering an extension's request to read sensitive environment variables. */ - feedback?: string; -} -/** - * Permission-decision variant indicating no user was available to confirm the request. - * - * This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema - * via the `definition` "PermissionDecisionUserNotAvailable". - */ -/** @experimental */ -export interface PermissionDecisionUserNotAvailable { + kind: "extension-env-access"; /** - * No user is available to confirm the request + * Extension name. */ - kind: "user-not-available"; -} -/** - * Permission-decision variant indicating the request was approved. - * - * This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema - * via the `definition` "PermissionDecisionApproved". - */ -/** @experimental */ -export interface PermissionDecisionApproved { + extensionName: string; /** - * The permission request was approved + * Names of the sensitive environment variables this approval covers. Values are never persisted. + * + * @minItems 1 */ - kind: "approved"; + environmentVariables: [string, ...string[]]; } /** - * Permission-decision variant indicating approval was remembered for the session, with approval details. + * Working directory to load persisted location permissions for. * * This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema - * via the `definition` "PermissionDecisionApprovedForSession". + * via the `definition` "PermissionLocationApplyParams". */ /** @experimental */ -export interface PermissionDecisionApprovedForSession { +export interface PermissionLocationApplyParams { /** - * Approved and remembered for the rest of the session + * Working directory whose persisted location permissions should be applied */ - kind: "approved-for-session"; - approval: UserToolSessionApproval; + workingDirectory: string; } /** - * Permission-decision variant indicating approval was persisted for a project location, with approval details and location key. + * Summary of persisted location permissions applied to the session. * * This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema - * via the `definition` "PermissionDecisionApprovedForLocation". + * via the `definition` "PermissionLocationApplyResult". */ /** @experimental */ -export interface PermissionDecisionApprovedForLocation { - /** - * Approved and persisted for this project location - */ - kind: "approved-for-location"; - approval: UserToolSessionApproval; +export interface PermissionLocationApplyResult { /** - * The location key (git root or cwd) to persist the approval to + * Location key used in the location-permissions store */ locationKey: string; -} -/** - * 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` "PermissionDecisionCancelled". - */ -/** @experimental */ -export interface PermissionDecisionCancelled { + locationType: PermissionLocationType; /** - * The permission request was cancelled before a response was used + * Whether a different location was applied since the previous apply call */ - kind: "cancelled"; + changed: boolean; /** - * Optional explanation of why the request was cancelled + * Number of location-scoped rules added to the live permission service */ - reason?: string; -} -/** - * 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` "PermissionDecisionDeniedByRules". - */ -/** @experimental */ -export interface PermissionDecisionDeniedByRules { + appliedRuleCount: number; /** - * Denied because approval rules explicitly blocked it + * Number of persisted allowed directories added to the live path manager */ - kind: "denied-by-rules"; + appliedDirectoryCount: number; /** - * Rules that denied the request + * Location-scoped rules applied to the live permission service */ - rules: PermissionRule[]; + appliedRules: PermissionRule[]; } /** - * Permission-decision variant indicating no approval rule matched and user confirmation was unavailable. + * Working directory to resolve into a location-permissions key. * * This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema - * via the `definition` "PermissionDecisionDeniedNoApprovalRuleAndCouldNotRequestFromUser". + * via the `definition` "PermissionLocationResolveParams". */ /** @experimental */ -export interface PermissionDecisionDeniedNoApprovalRuleAndCouldNotRequestFromUser { +export interface PermissionLocationResolveParams { /** - * Denied because no approval rule matched and user confirmation was unavailable + * Working directory whose permission location should be resolved */ - kind: "denied-no-approval-rule-and-could-not-request-from-user"; + workingDirectory: string; } /** - * Permission-decision variant indicating the user denied an interactive prompt, with optional feedback and force-reject flag. + * Resolved location-permissions key and type. * * This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema - * via the `definition` "PermissionDecisionDeniedInteractivelyByUser". + * via the `definition` "PermissionLocationResolveResult". */ /** @experimental */ -export interface PermissionDecisionDeniedInteractivelyByUser { - /** - * Denied by the user during an interactive prompt - */ - kind: "denied-interactively-by-user"; - /** - * Optional feedback from the user explaining the denial - */ - feedback?: string; +export interface PermissionLocationResolveResult { /** - * Whether to force-reject the current agent turn + * Location key used in the location-permissions store */ - forceReject?: boolean; + locationKey: string; + locationType: PermissionLocationType; } /** - * Permission-decision variant indicating denial by content-exclusion policy, with path and message. + * Directory path to add to the session's allowed directories. * * This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema - * via the `definition` "PermissionDecisionDeniedByContentExclusionPolicy". + * via the `definition` "PermissionPathsAddParams". */ /** @experimental */ -export interface PermissionDecisionDeniedByContentExclusionPolicy { - /** - * Denied by the organization's content exclusion policy - */ - kind: "denied-by-content-exclusion-policy"; +export interface PermissionPathsAddParams { /** - * File path that triggered the exclusion + * Directory to add to the allow-list. The runtime resolves and validates the path before adding, then loads conventional `.github/skills/` and `.github/agents/` definitions under it when their subsystem gates are enabled. Adding the directory is therefore also a trust decision for configuration stored there. */ path: string; - /** - * Human-readable explanation of why the path was excluded - */ - message: string; } /** - * Permission-decision variant indicating denial by a permission request hook, with optional message and interrupt flag. + * Path to evaluate against the session's allowed directories. * * This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema - * via the `definition` "PermissionDecisionDeniedByPermissionRequestHook". + * via the `definition` "PermissionPathsAllowedCheckParams". */ /** @experimental */ -export interface PermissionDecisionDeniedByPermissionRequestHook { - /** - * Denied by a permission request hook registered by an extension or plugin - */ - kind: "denied-by-permission-request-hook"; - /** - * Optional message from the hook explaining the denial - */ - message?: string; +export interface PermissionPathsAllowedCheckParams { /** - * Whether to interrupt the current agent turn + * Path to check against the session's allowed directories */ - interrupt?: boolean; + path: string; } /** - * Pending permission request ID and the decision to apply (approve/reject and scope). + * Indicates whether the supplied path is within the session's allowed directories. * * This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema - * via the `definition` "PermissionDecisionRequest". + * via the `definition` "PermissionPathsAllowedCheckResult". */ /** @experimental */ -export interface PermissionDecisionRequest { +export interface PermissionPathsAllowedCheckResult { /** - * Request ID of the pending permission request + * Whether the path is within the session's allowed directories */ - requestId: string; - result: PermissionDecision; + allowed: boolean; } /** - * Location-scoped tool approval to persist. + * 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` "PermissionLocationAddToolApprovalParams". + * via the `definition` "PermissionPathsConfig". */ /** @experimental */ -export interface PermissionLocationAddToolApprovalParams { +export interface PermissionPathsConfig { /** - * Location key (git root or cwd) to persist the approval to + * If true, the runtime allows access to all paths without prompting. Equivalent to constructing an UnrestrictedPathManager. */ - locationKey: string; - approval: PermissionsLocationsAddToolApprovalDetails; + unrestricted?: boolean; + /** + * Additional directories to allow tool access to (in addition to the session's working directory). Conventional `.github/skills/` and `.github/agents/` definitions under them also join the session catalogs when their subsystem gates are enabled, so supplying a directory is a trust decision for configuration stored there. 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; + /** + * Workspace root path (special-cased to be allowed even before the directory exists). Ignored when `unrestricted` is true. + */ + workspacePath?: string; } /** - * Location-persisted tool approval details for specific command identifiers. + * Snapshot of the session's allow-listed directories and primary working directory. * * This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema - * via the `definition` "PermissionsLocationsAddToolApprovalDetailsCommands". + * via the `definition` "PermissionPathsList". */ /** @experimental */ -export interface PermissionsLocationsAddToolApprovalDetailsCommands { +export interface PermissionPathsList { /** - * Approval scoped to specific command identifiers. + * All directories currently allowed for tool access on this session. */ - kind: "commands"; + directories: string[]; /** - * Command identifiers covered by this approval. + * The primary working directory for this session. */ - commandIdentifiers: string[]; + primary: string; } /** - * Location-persisted tool approval details for read-only filesystem operations. + * Directory path to set as the session's new primary working directory. * * This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema - * via the `definition` "PermissionsLocationsAddToolApprovalDetailsRead". + * via the `definition` "PermissionPathsUpdatePrimaryParams". */ /** @experimental */ -export interface PermissionsLocationsAddToolApprovalDetailsRead { +export interface PermissionPathsUpdatePrimaryParams { /** - * Approval covering read-only filesystem operations. + * Directory to set as the new primary working directory for the session's permission policy. */ - kind: "read"; + path: string; } /** - * Location-persisted tool approval details for filesystem write operations. + * Path to evaluate against the session's workspace (primary) directory. * * This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema - * via the `definition` "PermissionsLocationsAddToolApprovalDetailsWrite". + * via the `definition` "PermissionPathsWorkspaceCheckParams". */ /** @experimental */ -export interface PermissionsLocationsAddToolApprovalDetailsWrite { +export interface PermissionPathsWorkspaceCheckParams { /** - * Approval covering filesystem write operations. + * Path to check against the session workspace directory */ - kind: "write"; + path: string; } /** - * Location-persisted tool approval details for an MCP server tool, or all tools when `toolName` is null. + * Indicates whether the supplied path is within the session's workspace directory. * * This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema - * via the `definition` "PermissionsLocationsAddToolApprovalDetailsMcp". + * via the `definition` "PermissionPathsWorkspaceCheckResult". */ /** @experimental */ -export interface PermissionsLocationsAddToolApprovalDetailsMcp { - /** - * Approval covering an MCP tool. - */ - kind: "mcp"; - /** - * MCP server name. - */ - serverName: string; +export interface PermissionPathsWorkspaceCheckResult { /** - * MCP tool name, or null to cover every tool on the server. + * Whether the path is within the session workspace directory */ - toolName: string | null; + allowed: boolean; } /** - * Location-persisted tool approval details for MCP sampling requests from a server. + * Notification payload describing the permission prompt that the client just rendered. * * This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema - * via the `definition` "PermissionsLocationsAddToolApprovalDetailsMcpSampling". + * via the `definition` "PermissionPromptShownNotification". */ /** @experimental */ -export interface PermissionsLocationsAddToolApprovalDetailsMcpSampling { - /** - * Approval covering MCP sampling requests for a server. - */ - kind: "mcp-sampling"; +export interface PermissionPromptShownNotification { /** - * MCP server name. + * 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). */ - serverName: string; + message: string; } /** - * Location-persisted tool approval details for writes to long-term memory. + * 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` "PermissionsLocationsAddToolApprovalDetailsMemory". + * via the `definition` "PermissionRequestResult". */ /** @experimental */ -export interface PermissionsLocationsAddToolApprovalDetailsMemory { +export interface PermissionRequestResult { /** - * Approval covering writes to long-term memory. + * Whether the permission request was handled successfully */ - kind: "memory"; + success: boolean; } /** - * Location-persisted tool approval details for a custom tool, keyed by tool name. + * 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` "PermissionsLocationsAddToolApprovalDetailsCustomTool". + * via the `definition` "PermissionRulesSet". */ /** @experimental */ -export interface PermissionsLocationsAddToolApprovalDetailsCustomTool { +export interface PermissionRulesSet { /** - * Approval covering a custom tool. + * Rules that auto-approve matching requests */ - kind: "custom-tool"; + approved: PermissionRule[]; /** - * Custom tool name. + * Rules that auto-deny matching requests */ - toolName: string; + denied: PermissionRule[]; } /** - * Location-persisted tool approval details for extension-management operations, optionally narrowed by operation. + * 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` "PermissionsLocationsAddToolApprovalDetailsExtensionManagement". + * via the `definition` "PermissionsConfigureAdditionalContentExclusionPolicy". */ /** @experimental */ -export interface PermissionsLocationsAddToolApprovalDetailsExtensionManagement { +export interface PermissionsConfigureAdditionalContentExclusionPolicy { /** - * Approval covering extension lifecycle operations such as enable, disable, or reload. + * Content-exclusion rules to apply. */ - kind: "extension-management"; + rules: PermissionsConfigureAdditionalContentExclusionPolicyRule[]; /** - * Optional operation identifier; when omitted, the approval covers all extension management operations. + * Opaque policy update timestamp supplied by the host. */ - operation?: string; + last_updated_at: JsonValue; + scope: PermissionsConfigureAdditionalContentExclusionPolicyScope; } /** - * Location-persisted tool approval details for an extension's permission-gated capability access, keyed by extension name. + * 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` "PermissionsLocationsAddToolApprovalDetailsExtensionPermissionAccess". + * via the `definition` "PermissionsConfigureAdditionalContentExclusionPolicyRule". */ /** @experimental */ -export interface PermissionsLocationsAddToolApprovalDetailsExtensionPermissionAccess { +export interface PermissionsConfigureAdditionalContentExclusionPolicyRule { /** - * Approval covering an extension's request to access a permission-gated capability. + * Path patterns covered by this rule. */ - kind: "extension-permission-access"; + paths: string[]; /** - * Extension name. + * Conditions of which at least one must match. */ - extensionName: string; + ifAnyMatch?: string[]; + /** + * Conditions none of which may match. + */ + ifNoneMatch?: string[]; + source: PermissionsConfigureAdditionalContentExclusionPolicyRuleSource; } /** - * Working directory to load persisted location permissions for. + * 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` "PermissionLocationApplyParams". + * via the `definition` "PermissionsConfigureAdditionalContentExclusionPolicyRuleSource". */ /** @experimental */ -export interface PermissionLocationApplyParams { +export interface PermissionsConfigureAdditionalContentExclusionPolicyRuleSource { /** - * Working directory whose persisted location permissions should be applied + * Name of the policy source. */ - workingDirectory: string; + name: string; + /** + * Type of the policy source. + */ + type: string; } /** - * Summary of persisted location permissions applied to the session. + * 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` "PermissionLocationApplyResult". + * via the `definition` "PermissionsConfigureParams". */ /** @experimental */ -export interface PermissionLocationApplyResult { +export interface PermissionsConfigureParams { /** - * Location key used in the location-permissions store + * If specified, sets whether tool permission requests are auto-approved without prompting. Omit to leave the current value unchanged. */ - locationKey: string; - locationType: PermissionLocationType; + approveAllToolPermissionRequests?: boolean; /** - * Whether a different location was applied since the previous apply call + * If specified, sets whether path/URL read permission requests are auto-approved. Omit to leave the current value unchanged. */ - changed: boolean; + approveAllReadPermissionRequests?: boolean; + rules?: PermissionRulesSet; + paths?: PermissionPathsConfig; + urls?: PermissionUrlsConfig; /** - * Number of location-scoped rules added to the live permission service + * 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. */ - appliedRuleCount: number; + additionalContentExclusionPolicies?: PermissionsConfigureAdditionalContentExclusionPolicy[]; +} +/** + * 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` "PermissionUrlsConfig". + */ +/** @experimental */ +export interface PermissionUrlsConfig { /** - * Number of persisted allowed directories added to the live path manager + * If true, the runtime allows access to all URLs without prompting. Initial allow-list is ignored when this is true. */ - appliedDirectoryCount: number; + unrestricted?: boolean; /** - * Location-scoped rules applied to the live permission service + * Initial list of allowed URL/domain patterns. Patterns may include path components. Ignored when `unrestricted` is true. */ - appliedRules: PermissionRule[]; + initialAllowed?: string[]; } /** - * Working directory to resolve into a location-permissions key. + * Indicates whether the operation succeeded. * * This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema - * via the `definition` "PermissionLocationResolveParams". + * via the `definition` "PermissionsConfigureResult". */ /** @experimental */ -export interface PermissionLocationResolveParams { +export interface PermissionsConfigureResult { /** - * Working directory whose permission location should be resolved + * Whether the operation succeeded */ - workingDirectory: string; + success: boolean; } /** - * Resolved location-permissions key and type. + * Indicates whether the operation succeeded. * * This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema - * via the `definition` "PermissionLocationResolveResult". + * via the `definition` "PermissionsFolderTrustAddTrustedResult". */ /** @experimental */ -export interface PermissionLocationResolveResult { +export interface PermissionsFolderTrustAddTrustedResult { /** - * Location key used in the location-permissions store + * Whether the operation succeeded */ - locationKey: string; - locationType: PermissionLocationType; + success: boolean; } /** - * Directory path to add to the session's allowed directories. + * No parameters. * * This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema - * via the `definition` "PermissionPathsAddParams". + * via the `definition` "PermissionsGetModeRequest". */ /** @experimental */ -export interface PermissionPathsAddParams { - /** - * Directory to add to the allow-list. The runtime resolves and validates the path before adding. - */ - path: string; -} +export interface PermissionsGetModeRequest {} /** - * Path to evaluate against the session's allowed directories. + * Current permission mode. * * This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema - * via the `definition` "PermissionPathsAllowedCheckParams". + * via the `definition` "PermissionsGetModeResult". */ /** @experimental */ -export interface PermissionPathsAllowedCheckParams { - /** - * Path to check against the session's allowed directories - */ - path: string; +export interface PermissionsGetModeResult { + mode: PermissionMode; } /** - * Indicates whether the supplied path is within the session's allowed directories. + * Indicates whether the operation succeeded. * * This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema - * via the `definition` "PermissionPathsAllowedCheckResult". + * via the `definition` "PermissionsLocationsAddToolApprovalResult". */ /** @experimental */ -export interface PermissionPathsAllowedCheckResult { +export interface PermissionsLocationsAddToolApprovalResult { /** - * Whether the path is within the session's allowed directories + * Whether the operation succeeded */ - allowed: boolean; + success: boolean; } /** - * 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. + * 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` "PermissionPathsConfig". + * via the `definition` "PermissionsModifyRulesParams". */ /** @experimental */ -export interface PermissionPathsConfig { - /** - * If true, the runtime allows access to all paths without prompting. Equivalent to constructing an UnrestrictedPathManager. - */ - unrestricted?: boolean; +export interface PermissionsModifyRulesParams { + scope: PermissionsModifyRulesScope; /** - * 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). + * Rules to add to the scope. Applied before `remove`/`removeAll`. */ - additionalDirectories?: string[]; + add?: PermissionRule[]; /** - * Whether to include the system temp directory in the allowed list (defaults to true). Ignored when `unrestricted` is true. + * Specific rules to remove from the scope. Ignored when `removeAll` is true. */ - includeTempDirectory?: boolean; + remove?: PermissionRule[]; /** - * Workspace root path (special-cased to be allowed even before the directory exists). Ignored when `unrestricted` is true. + * When true, removes every rule currently in the scope (after any `add` is applied). Useful for clearing the location scope wholesale. */ - workspacePath?: string; + removeAll?: boolean; } /** - * Snapshot of the session's allow-listed directories and primary working directory. + * Indicates whether the operation succeeded. * * This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema - * via the `definition` "PermissionPathsList". + * via the `definition` "PermissionsModifyRulesResult". */ /** @experimental */ -export interface PermissionPathsList { - /** - * All directories currently allowed for tool access on this session. - */ - directories: string[]; +export interface PermissionsModifyRulesResult { /** - * The primary working directory for this session. + * Whether the operation succeeded */ - primary: string; + success: boolean; } /** - * Directory path to set as the session's new primary working directory. + * Indicates whether the operation succeeded. * * This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema - * via the `definition` "PermissionPathsUpdatePrimaryParams". + * via the `definition` "PermissionsNotifyPromptShownResult". */ /** @experimental */ -export interface PermissionPathsUpdatePrimaryParams { +export interface PermissionsNotifyPromptShownResult { /** - * Directory to set as the new primary working directory for the session's permission policy. + * Whether the operation succeeded */ - path: string; + success: boolean; } /** - * Path to evaluate against the session's workspace (primary) directory. + * Indicates whether the operation succeeded. * * This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema - * via the `definition` "PermissionPathsWorkspaceCheckParams". + * via the `definition` "PermissionsPathsAddResult". */ /** @experimental */ -export interface PermissionPathsWorkspaceCheckParams { +export interface PermissionsPathsAddResult { /** - * Path to check against the session workspace directory + * Whether the operation succeeded */ - path: string; + success: boolean; } /** - * Indicates whether the supplied path is within the session's workspace directory. + * No parameters; returns the session's allow-listed directories. * * This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema - * via the `definition` "PermissionPathsWorkspaceCheckResult". + * via the `definition` "PermissionsPathsListRequest". */ /** @experimental */ -export interface PermissionPathsWorkspaceCheckResult { +export interface PermissionsPathsListRequest {} +/** + * Indicates whether the operation succeeded. + * + * This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema + * via the `definition` "PermissionsPathsUpdatePrimaryResult". + */ +/** @experimental */ +export interface PermissionsPathsUpdatePrimaryResult { /** - * Whether the path is within the session workspace directory + * Whether the operation succeeded */ - allowed: boolean; + success: boolean; } /** - * Notification payload describing the permission prompt that the client just rendered. + * No parameters; returns currently-pending permission requests for the session. * * This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema - * via the `definition` "PermissionPromptShownNotification". + * via the `definition` "PermissionsPendingRequestsRequest". */ /** @experimental */ -export interface PermissionPromptShownNotification { +export interface PermissionsPendingRequestsRequest {} +/** + * Clears session-scoped tool permission approvals, and optionally the location-scoped ones. + * + * This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema + * via the `definition` "PermissionsResetSessionApprovalsRequest". + */ +/** @experimental */ +export interface PermissionsResetSessionApprovalsRequest { /** - * 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). + * Whether location-scoped approvals are cleared too. Defaults to `true`. */ - message: string; + includeLocation?: boolean; } /** - * Indicates whether the permission decision was applied; false when the request was already resolved. + * Indicates whether the operation succeeded. * * This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema - * via the `definition` "PermissionRequestResult". + * via the `definition` "PermissionsResetSessionApprovalsResult". */ /** @experimental */ -export interface PermissionRequestResult { +export interface PermissionsResetSessionApprovalsResult { /** - * Whether the permission request was handled successfully + * Whether the operation succeeded */ success: boolean; } /** - * If specified, replaces the session's approved/denied permission rules. Omit to leave the current rules unchanged. + * Allow-all toggle for tool permission requests, with an optional telemetry source. * * This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema - * via the `definition` "PermissionRulesSet". + * via the `definition` "PermissionsSetApproveAllRequest". */ /** @experimental */ -export interface PermissionRulesSet { - /** - * Rules that auto-approve matching requests - */ - approved: PermissionRule[]; +export interface PermissionsSetApproveAllRequest { /** - * Rules that auto-deny matching requests + * Whether to auto-approve all tool permission requests */ - denied: PermissionRule[]; + enabled: boolean; + source?: PermissionsSetApproveAllSource; } /** - * Content-exclusion policy supplied to `session.permissions.configure`, with rules, last-updated data, and scope. + * Indicates whether the operation succeeded. * * This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema - * via the `definition` "PermissionsConfigureAdditionalContentExclusionPolicy". + * via the `definition` "PermissionsSetApproveAllResult". */ /** @experimental */ -export interface PermissionsConfigureAdditionalContentExclusionPolicy { - rules: PermissionsConfigureAdditionalContentExclusionPolicyRule[]; - last_updated_at: unknown; - scope: PermissionsConfigureAdditionalContentExclusionPolicyScope; +export interface PermissionsSetApproveAllResult { + /** + * Whether the operation succeeded + */ + success: boolean; } /** - * Single content-exclusion rule supplied to `session.permissions.configure`, with paths, match conditions, and source. + * Permission mode to apply for the session. * * This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema - * via the `definition` "PermissionsConfigureAdditionalContentExclusionPolicyRule". + * via the `definition` "PermissionsSetModeRequest". */ /** @experimental */ -export interface PermissionsConfigureAdditionalContentExclusionPolicyRule { - paths: string[]; - ifAnyMatch?: string[]; - ifNoneMatch?: string[]; - source: PermissionsConfigureAdditionalContentExclusionPolicyRuleSource; +export interface PermissionsSetModeRequest { + mode: PermissionMode; + /** + * Optional judge model id for assisted mode. When omitted, the session resolves the provider default: `gpt-5.5` for CAPI sessions and the active session model for BYOK sessions. + */ + assistedApprovalModel?: string; + source?: PermissionModeSource; } /** - * Source descriptor for a `session.permissions.configure` content-exclusion rule, with source name and type. + * Indicates whether the requested permission mode was applied and reports the authoritative post-mutation mode. * * This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema - * via the `definition` "PermissionsConfigureAdditionalContentExclusionPolicyRuleSource". + * via the `definition` "PermissionsSetModeResult". */ /** @experimental */ -export interface PermissionsConfigureAdditionalContentExclusionPolicyRuleSource { - name: string; - type: string; +export interface PermissionsSetModeResult { + /** + * Whether the operation succeeded + */ + success: boolean; + mode: PermissionMode; } /** - * Patch of permission policy fields to apply (omit a field to leave it unchanged). + * 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` "PermissionsConfigureParams". + * via the `definition` "PermissionsSetRequiredRequest". */ /** @experimental */ -export interface PermissionsConfigureParams { - /** - * If specified, sets whether tool permission requests are auto-approved without prompting. Omit to leave the current value unchanged. - */ - approveAllToolPermissionRequests?: boolean; - /** - * If specified, sets whether path/URL read permission requests are auto-approved. Omit to leave the current value unchanged. - */ - approveAllReadPermissionRequests?: boolean; - rules?: PermissionRulesSet; - paths?: PermissionPathsConfig; - urls?: PermissionUrlsConfig; +export interface PermissionsSetRequiredRequest { /** - * 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. + * 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`). */ - additionalContentExclusionPolicies?: PermissionsConfigureAdditionalContentExclusionPolicy[]; + required: boolean; } /** - * 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. + * Indicates whether the operation succeeded. * * This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema - * via the `definition` "PermissionUrlsConfig". + * via the `definition` "PermissionsSetRequiredResult". */ /** @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 PermissionsSetRequiredResult { /** - * Initial list of allowed URL/domain patterns. Patterns may include path components. Ignored when `unrestricted` is true. + * Whether the operation succeeded */ - initialAllowed?: string[]; + success: boolean; } /** * Indicates whether the operation succeeded. * * This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema - * via the `definition` "PermissionsConfigureResult". + * via the `definition` "PermissionsUrlsSetUnrestrictedModeResult". */ /** @experimental */ -export interface PermissionsConfigureResult { +export interface PermissionsUrlsSetUnrestrictedModeResult { /** * Whether the operation succeeded */ success: boolean; } /** - * Indicates whether the operation succeeded. + * Whether the URL-permission policy should run in unrestricted mode. * * This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema - * via the `definition` "PermissionsFolderTrustAddTrustedResult". + * via the `definition` "PermissionUrlsSetUnrestrictedModeParams". */ /** @experimental */ -export interface PermissionsFolderTrustAddTrustedResult { +export interface PermissionUrlsSetUnrestrictedModeParams { /** - * Whether the operation succeeded + * Whether to allow access to all URLs without prompting. Toggles the runtime's URL-permission policy in place. */ - success: boolean; + enabled: boolean; } /** - * No parameters. + * Optional message to echo back to the caller. * * This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema - * via the `definition` "PermissionsGetAllowAllRequest". + * via the `definition` "PingRequest". */ /** @experimental */ -export interface PermissionsGetAllowAllRequest {} +export interface PingRequest { + /** + * Optional message to echo back + */ + message?: string; +} /** - * Indicates whether the operation succeeded. + * 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` "PermissionsLocationsAddToolApprovalResult". + * via the `definition` "PingResult". */ /** @experimental */ -export interface PermissionsLocationsAddToolApprovalResult { +export interface PingResult { /** - * Whether the operation succeeded + * Echoed message (or default greeting) */ - success: boolean; + message: string; + /** + * ISO 8601 timestamp when the server handled the ping + */ + timestamp: string; + /** + * Server protocol version number + */ + protocolVersion: number; } /** - * Scope and add/remove instructions for modifying session- or location-scoped permission rules. + * Existence, contents, and resolved path of the session plan file. * * This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema - * via the `definition` "PermissionsModifyRulesParams". + * via the `definition` "PlanReadResult". */ /** @experimental */ -export interface PermissionsModifyRulesParams { - scope: PermissionsModifyRulesScope; +export interface PlanReadResult { /** - * Rules to add to the scope. Applied before `remove`/`removeAll`. + * Whether the plan file exists in the workspace */ - add?: PermissionRule[]; + exists: boolean; /** - * Specific rules to remove from the scope. Ignored when `removeAll` is true. + * The content of the plan file, or null if it does not exist */ - remove?: PermissionRule[]; + content: string | null; /** - * When true, removes every rule currently in the scope (after any `add` is applied). Useful for clearing the location scope wholesale. + * Absolute file path of the plan file, or null if workspace is not enabled */ - removeAll?: boolean; + path: string | null; } /** - * Indicates whether the operation succeeded. + * 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` "PermissionsModifyRulesResult". + * via the `definition` "PlanReadSqlTodosResult". */ /** @experimental */ -export interface PermissionsModifyRulesResult { +export interface PlanReadSqlTodosResult { /** - * Whether the operation succeeded + * Rows from the session SQL todos table, ordered by creation time with insertion order used to break ties when available and id used for WITHOUT ROWID tables. + */ + rows: 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. + * + * This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema + * via the `definition` "PlanSqlTodosRow". + */ +/** @experimental */ +export interface PlanSqlTodosRow { + /** + * Todo identifier. + */ + id?: string; + /** + * Todo title. + */ + title?: string; + /** + * Todo description. + */ + description?: string; + /** + * Todo status. + */ + status?: string; + /** + * Todo creation time, as stored by the session SQL schema's `datetime('now')` default: `YYYY-MM-DD HH:MM:SS` in UTC. Lets clients attribute todos to the work item that created them (e.g. scoping a goal's progress to the todos it produced) rather than to the whole session. */ - success: boolean; + createdAt?: string; } /** - * Indicates whether the operation succeeded. + * Todo rows + dependency edges read from the session SQL database. * * This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema - * via the `definition` "PermissionsNotifyPromptShownResult". + * via the `definition` "PlanReadSqlTodosWithDependenciesResult". */ /** @experimental */ -export interface PermissionsNotifyPromptShownResult { +export interface PlanReadSqlTodosWithDependenciesResult { /** - * Whether the operation succeeded + * Rows from the session SQL todos table, ordered by creation time with insertion order used to break ties when available and id used for WITHOUT ROWID tables. Empty when no database, no todos table, or the SELECT failed. */ - success: boolean; + 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 the operation succeeded. + * 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` "PermissionsPathsAddResult". + * via the `definition` "PlanSqlTodoDependency". */ /** @experimental */ -export interface PermissionsPathsAddResult { +export interface PlanSqlTodoDependency { /** - * Whether the operation succeeded + * ID of the todo that has the dependency. */ - success: boolean; + todoId: string; + /** + * ID of the todo it depends on. + */ + dependsOn: string; } /** - * No parameters; returns the session's allow-listed directories. - * - * This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema - * via the `definition` "PermissionsPathsListRequest". - */ -/** @experimental */ -export interface PermissionsPathsListRequest {} -/** - * Indicates whether the operation succeeded. + * Replacement contents to write to the session plan file. * * This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema - * via the `definition` "PermissionsPathsUpdatePrimaryResult". + * via the `definition` "PlanUpdateRequest". */ /** @experimental */ -export interface PermissionsPathsUpdatePrimaryResult { +export interface PlanUpdateRequest { /** - * Whether the operation succeeded + * The new content for the plan file */ - success: boolean; + content: string; } /** - * No parameters; returns currently-pending permission requests for the session. + * Session plugin metadata, with name, marketplace, optional version, and enabled state. * * This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema - * via the `definition` "PermissionsPendingRequestsRequest". + * via the `definition` "Plugin". */ /** @experimental */ -export interface PermissionsPendingRequestsRequest {} +export interface Plugin { + /** + * Plugin name + */ + name: string; + /** + * Marketplace the plugin came from + */ + marketplace: string; + /** + * Installed version + */ + version?: string; + /** + * Whether the plugin is currently enabled + */ + enabled: boolean; +} /** - * No parameters; clears all session-scoped tool permission approvals. + * Result of installing a plugin. * * This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema - * via the `definition` "PermissionsResetSessionApprovalsRequest". + * via the `definition` "PluginInstallResult". */ /** @experimental */ -export interface PermissionsResetSessionApprovalsRequest {} +export interface PluginInstallResult { + plugin: InstalledPluginInfo; + /** + * Number of skills discovered and installed from the plugin + */ + skillsInstalled: number; + /** + * Optional post-install message provided by the plugin (e.g. setup instructions) + */ + postInstallMessage?: string; + /** + * Set when the install path is deprecated (e.g. direct repo / URL / local installs). Callers should surface this to end users. + */ + deprecationWarning?: string; +} /** - * Indicates whether the operation succeeded. + * Plugins installed for the session, with their enabled state and version metadata. * * This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema - * via the `definition` "PermissionsResetSessionApprovalsResult". + * via the `definition` "PluginList". */ /** @experimental */ -export interface PermissionsResetSessionApprovalsResult { +export interface PluginList { /** - * Whether the operation succeeded + * Installed plugins */ - success: boolean; + plugins: Plugin[]; } /** - * Allow-all mode to apply for the session. + * Plugins installed in user/global state. * * This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema - * via the `definition` "PermissionsSetAllowAllRequest". + * via the `definition` "PluginListResult". */ /** @experimental */ -export interface PermissionsSetAllowAllRequest { - mode?: PermissionsAllowAllMode; - /** - * 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?: boolean; +export interface PluginListResult { /** - * Optional model id for the `auto` mode auto-approval LLM judging. Only meaningful when `mode` is `auto`; ignored otherwise. When omitted, the session's active model is used. + * Installed plugins */ - model?: string; - source?: PermissionsSetAllowAllSource; + plugins: InstalledPluginInfo[]; } /** - * Allow-all toggle for tool permission requests, with an optional telemetry source. + * Trusted built-in plugin directories to use for this runtime process. * * This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema - * via the `definition` "PermissionsSetApproveAllRequest". + * via the `definition` "PluginsBuiltinSetRequest". */ /** @experimental */ -export interface PermissionsSetApproveAllRequest { +export interface PluginsBuiltinSetRequest { /** - * Whether to auto-approve all tool permission requests + * Complete replacement set of trusted built-in plugin directories. Every entry must be an absolute local filesystem path no longer than 4096 characters. + * + * @maxItems 64 */ - enabled: boolean; - source?: PermissionsSetApproveAllSource; + paths: string[]; } /** - * Indicates whether the operation succeeded. + * Plugin names (or specs) to disable. * * This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema - * via the `definition` "PermissionsSetApproveAllResult". + * via the `definition` "PluginsDisableRequest". */ /** @experimental */ -export interface PermissionsSetApproveAllResult { +export interface PluginsDisableRequest { /** - * Whether the operation succeeded + * 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. */ - success: boolean; + names: string[]; } /** - * Toggles whether permission prompts should be bridged into session events for this client. + * Plugin names (or specs) to enable. * * This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema - * via the `definition` "PermissionsSetRequiredRequest". + * via the `definition` "PluginsEnableRequest". */ /** @experimental */ -export interface PermissionsSetRequiredRequest { +export interface PluginsEnableRequest { /** - * 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`). + * 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. */ - required: boolean; + names: string[]; } /** - * Indicates whether the operation succeeded. + * Plugin source and optional working directory for relative-path resolution. * * This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema - * via the `definition` "PermissionsSetRequiredResult". + * via the `definition` "PluginsInstallRequest". */ /** @experimental */ -export interface PermissionsSetRequiredResult { +export interface PluginsInstallRequest { /** - * Whether the operation succeeded + * 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. */ - success: boolean; + source: string; + /** + * Working directory used to resolve relative local paths in `source`. Defaults to the server's current working directory. + */ + workingDirectory?: string; } /** - * Indicates whether the operation succeeded. + * Marketplace source and optional working directory for relative-path resolution. * * This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema - * via the `definition` "PermissionsUrlsSetUnrestrictedModeResult". + * via the `definition` "PluginsMarketplacesAddRequest". */ /** @experimental */ -export interface PermissionsUrlsSetUnrestrictedModeResult { +export interface PluginsMarketplacesAddRequest { /** - * Whether the operation succeeded + * 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. */ - success: boolean; + source: string; + /** + * Working directory used to resolve relative local paths in `source`. Defaults to the server's current working directory. + */ + workingDirectory?: string; } /** - * Whether the URL-permission policy should run in unrestricted mode. + * Name of the marketplace whose plugin catalog to fetch. * * This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema - * via the `definition` "PermissionUrlsSetUnrestrictedModeParams". + * via the `definition` "PluginsMarketplacesBrowseRequest". */ /** @experimental */ -export interface PermissionUrlsSetUnrestrictedModeParams { +export interface PluginsMarketplacesBrowseRequest { /** - * Whether to allow access to all URLs without prompting. Toggles the runtime's URL-permission policy in place. + * Marketplace name to browse */ - enabled: boolean; + name: string; } -/** - * Optional message to echo back to the caller. - * - * This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema - * via the `definition` "PingRequest". - */ + /** @experimental */ -export interface PingRequest { +export interface PluginsMarketplacesRefreshRequest { /** - * Optional message to echo back + * Marketplace name to refresh. When omitted, every registered marketplace is refreshed. */ - message?: string; + name?: string; } /** - * Server liveness response, including the echoed message, current server timestamp, and protocol version. + * Name of the marketplace to remove and an optional force flag. * * This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema - * via the `definition` "PingResult". + * via the `definition` "PluginsMarketplacesRemoveRequest". */ /** @experimental */ -export interface PingResult { - /** - * Echoed message (or default greeting) - */ - message: string; +export interface PluginsMarketplacesRemoveRequest { /** - * ISO 8601 timestamp when the server handled the ping + * Marketplace name to remove */ - timestamp: string; + name: string; /** - * Server protocol version number + * 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. */ - protocolVersion: number; + force?: boolean; } /** - * Existence, contents, and resolved path of the session plan file. + * Name (or spec) of the plugin to uninstall. * * This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema - * via the `definition` "PlanReadResult". + * via the `definition` "PluginsUninstallRequest". */ /** @experimental */ -export interface PlanReadResult { - /** - * Whether the plan file exists in the workspace - */ - exists: boolean; +export interface PluginsUninstallRequest { /** - * The content of the plan file, or null if it does not exist + * Plugin name or "plugin@marketplace" spec to uninstall. When ambiguous, prefer the fully-qualified spec. */ - content: string | null; + name: string; /** - * Absolute file path of the plan file, or null if workspace is not enabled + * Stable source identity for a direct (non-marketplace) install. Disambiguates uninstall when multiple installed plugins share the same name. */ - path: string | null; + directSourceId?: string | null; } /** - * Todo rows read from the session SQL database. Empty when no session database is available. + * Name (or spec) of the plugin to update. * * This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema - * via the `definition` "PlanReadSqlTodosResult". + * via the `definition` "PluginsUpdateRequest". */ /** @experimental */ -export interface PlanReadSqlTodosResult { +export interface PluginsUpdateRequest { /** - * Rows from the session SQL todos table, ordered by creation time and id. + * Plugin name or "plugin@marketplace" spec to update. */ - rows: PlanSqlTodosRow[]; + name: string; } /** - * 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. + * 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` "PlanSqlTodosRow". + * via the `definition` "PluginUpdateAllEntry". */ /** @experimental */ -export interface PlanSqlTodosRow { +export interface PluginUpdateAllEntry { /** - * Todo identifier. + * Plugin name that was updated */ - id?: string; + name: string; /** - * Todo title. + * Marketplace the plugin came from. Empty string ("") for direct installs. */ - title?: string; + marketplace: string; /** - * Todo description. + * 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) */ - description?: string; + skillsInstalled?: number; /** - * Todo status. + * Error message (failure only) */ - status?: string; + error?: string; } /** - * Todo rows + dependency edges read from the session SQL database. + * Result of updating all installed plugins. * * This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema - * via the `definition` "PlanReadSqlTodosWithDependenciesResult". + * via the `definition` "PluginUpdateAllResult". */ /** @experimental */ -export interface PlanReadSqlTodosWithDependenciesResult { - /** - * 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[]; +export interface PluginUpdateAllResult { /** - * 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. + * Per-plugin update results in deterministic order. */ - dependencies: PlanSqlTodoDependency[]; + results: PluginUpdateAllEntry[]; } /** - * A single dependency edge read from the session SQL `todo_deps` table, indicating that one todo must complete before another. + * Result of updating a single plugin. * * This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema - * via the `definition` "PlanSqlTodoDependency". + * via the `definition` "PluginUpdateResult". */ /** @experimental */ -export interface PlanSqlTodoDependency { +export interface PluginUpdateResult { /** - * ID of the todo that has the dependency. + * Version that was previously installed, when available */ - todoId: string; + previousVersion?: string; /** - * ID of the todo it depends on. + * Version after the update, when reported by the plugin manifest */ - dependsOn: string; -} -/** - * Replacement contents to write to the session plan file. - * - * This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema - * via the `definition` "PlanUpdateRequest". - */ -/** @experimental */ -export interface PlanUpdateRequest { + newVersion?: string; /** - * The new content for the plan file + * Number of skills discovered and installed after the update */ - content: string; + skillsInstalled: number; } /** - * Session plugin metadata, with name, marketplace, optional version, and enabled state. + * Serializable definition of a caller-implemented tool whose execution is handled over the SDK connection. * * This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema - * via the `definition` "Plugin". + * via the `definition` "ProtocolExternalToolDefinition". */ /** @experimental */ -export interface Plugin { +export interface ProtocolExternalToolDefinition { /** - * Plugin name + * Unique model-visible tool name. */ name: string; /** - * Marketplace the plugin came from + * Model-visible explanation of what the tool does. */ - marketplace: string; + description: string; /** - * Installed version + * Optional human-readable display title. */ - version?: string; + title?: string; /** - * Whether the plugin is currently enabled + * JSON Schema describing the tool's input arguments. */ - 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; + parameters?: { + [k: string]: JsonValue | undefined; + }; /** - * Number of skills discovered and installed from the plugin + * Whether this definition replaces a built-in tool with the same name. */ - skillsInstalled: number; + overridesBuiltInTool?: boolean; /** - * Optional post-install message provided by the plugin (e.g. setup instructions) + * Whether execution bypasses the normal tool permission prompt. */ - postInstallMessage?: string; + skipPermission?: boolean; + defer?: ProtocolExternalToolDefer; /** - * Set when the install path is deprecated (e.g. direct repo / URL / local installs). Callers should surface this to end users. + * Whether the tool executes commands in a terminal. */ - deprecationWarning?: string; + isTerminal?: boolean; + /** + * Optional caller-defined metadata associated with the tool. + */ + metadata?: { + [k: string]: JsonValue | undefined; + }; } /** - * Plugins installed for the session, with their enabled state and version metadata. + * 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` "PluginList". + * via the `definition` "ProviderAddRequest". */ /** @experimental */ -export interface PluginList { +export interface ProviderAddRequest { /** - * Installed plugins + * 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 '/'. */ - plugins: Plugin[]; + 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[]; } /** - * Plugins installed in user/global state. + * A BYOK model definition referencing a named provider. * * This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema - * via the `definition` "PluginListResult". + * via the `definition` "ProviderModelConfig". */ /** @experimental */ -export interface PluginListResult { +export interface ProviderModelConfig { /** - * Installed plugins + * 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`. */ - plugins: InstalledPluginInfo[]; + id: string; + /** + * Name of the configured provider that serves this model. + */ + provider: string; + /** + * The model name sent to the provider API for inference. Defaults to `id`. + */ + wireModel?: string; + /** + * Well-known base model id used for behavior/capability/config lookup. Defaults to `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; + capabilities?: ModelCapabilitiesOverride; } /** - * Plugin names (or specs) to disable. + * The selectable model entries synthesized for the models added by this call. * * This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema - * via the `definition` "PluginsDisableRequest". + * via the `definition` "ProviderAddResult". */ /** @experimental */ -export interface PluginsDisableRequest { +export interface ProviderAddResult { /** - * 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. + * 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. */ - names: string[]; + models: JsonValue[]; } /** - * Plugin names (or specs) to enable. + * Custom model-provider configuration (BYOK). * * This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema - * via the `definition` "PluginsEnableRequest". + * via the `definition` "ProviderConfig". */ /** @experimental */ -export interface PluginsEnableRequest { +export interface ProviderConfig { + type?: ProviderConfigType; + wireApi?: ProviderConfigWireApi; + transport?: ProviderConfigTransport; /** - * 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. + * API endpoint URL. */ - names: string[]; + 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; + modelCapabilities?: ModelCapabilitiesOverride; + /** + * Provider name used for model and telemetry attribution. + */ + providerName?: 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; } /** - * Plugin source and optional working directory for relative-path resolution. + * 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` "PluginsInstallRequest". + * via the `definition` "ProviderEndpoint". */ /** @experimental */ -export interface PluginsInstallRequest { +export interface ProviderEndpoint { + type: ProviderEndpointType; + wireApi?: ProviderEndpointWireApi; + transport?: ProviderEndpointTransport; /** - * 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. + * Base URL to pass to the LLM client library. */ - source: string; + baseUrl: string; /** - * Working directory used to resolve relative local paths in `source`. Defaults to the server's current working directory. + * A credential the caller should use with this endpoint. Omitted only when the endpoint accepts unauthenticated requests. */ - workingDirectory?: string; + apiKey?: string; + /** + * HTTP headers the caller must include on every outbound request. + */ + headers: { + [k: string]: string | undefined; + }; + sessionToken?: ProviderSessionToken; } /** - * Marketplace source and optional working directory for relative-path resolution. + * 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` "PluginsMarketplacesAddRequest". + * via the `definition` "ProviderSessionToken". */ /** @experimental */ -export interface PluginsMarketplacesAddRequest { +export interface ProviderSessionToken { /** - * 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. + * The short-lived token value. */ - source: string; + token: string; /** - * Working directory used to resolve relative local paths in `source`. Defaults to the server's current working directory. + * HTTP header name the token must be sent under. */ - workingDirectory?: 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; } /** - * Name of the marketplace whose plugin catalog to fetch. + * 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` "PluginsMarketplacesBrowseRequest". + * via the `definition` "ProviderTokenAcquireRequest". */ /** @experimental */ -export interface PluginsMarketplacesBrowseRequest { +export interface ProviderTokenAcquireRequest { /** - * Marketplace name to browse + * Target session identifier */ - name: string; -} - -/** @experimental */ -export interface PluginsMarketplacesRefreshRequest { + sessionId: string; /** - * Marketplace name to refresh. When omitted, every registered marketplace is refreshed. + * 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 the configured provider name. */ - name?: string; + providerName: string; } /** - * Name of the marketplace to remove and an optional force flag. + * 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` "PluginsMarketplacesRemoveRequest". + * via the `definition` "ProviderTokenAcquireResult". */ /** @experimental */ -export interface PluginsMarketplacesRemoveRequest { - /** - * Marketplace name to remove - */ - name: string; +export interface ProviderTokenAcquireResult { /** - * 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 bearer token value (without the `Bearer ` prefix). */ - force?: boolean; + token: string; } /** - * Optional flags controlling which side effects the reload performs. + * File attachment * * This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema - * via the `definition` "PluginsReloadRequest". + * via the `definition` "PushAttachmentFile". */ /** @experimental */ -export interface PluginsReloadRequest { - /** - * 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; +export interface PushAttachmentFile { /** - * 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). + * Attachment type discriminator */ - reloadHooks?: boolean; + type: "file"; /** - * 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). + * Absolute file path */ - reloadExtensions?: boolean; + path: string; /** - * When true, skip repo-level hooks during the hook reload. Use before folder trust is confirmed; load them post-trust via `sessions.loadDeferredRepoHooks`. + * User-facing display name for the attachment */ - deferRepoHooks?: boolean; + displayName: string; + lineRange?: PushAttachmentFileLineRange; } /** - * Name (or spec) of the plugin to uninstall. + * 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` "PluginsUninstallRequest". + * via the `definition` "PushAttachmentFileLineRange". */ /** @experimental */ -export interface PluginsUninstallRequest { +export interface PushAttachmentFileLineRange { /** - * Plugin name or "plugin@marketplace" spec to uninstall. When ambiguous, prefer the fully-qualified spec. + * Start line number (1-based) */ - name: string; + start: number; /** - * Stable source identity for a direct (non-marketplace) install. Disambiguates uninstall when multiple installed plugins share the same name. + * End line number (1-based, inclusive) */ - directSourceId?: string | null; + end: number; } /** - * Name (or spec) of the plugin to update. + * Directory attachment * * This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema - * via the `definition` "PluginsUpdateRequest". + * via the `definition` "PushAttachmentDirectory". */ /** @experimental */ -export interface PluginsUpdateRequest { +export interface PushAttachmentDirectory { /** - * Plugin name or "plugin@marketplace" spec to update. + * Attachment type discriminator */ - name: string; + type: "directory"; + /** + * Absolute directory path + */ + path: string; + /** + * User-facing display name for the attachment + */ + displayName: string; } /** - * Per-plugin result from updating all plugins, with versions, skills installed, success flag, and optional error. + * Code selection attachment from an editor * * This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema - * via the `definition` "PluginUpdateAllEntry". + * via the `definition` "PushAttachmentSelection". */ /** @experimental */ -export interface PluginUpdateAllEntry { - /** - * Plugin name that was updated - */ - name: string; - /** - * Marketplace the plugin came from. Empty string ("") for direct installs. - */ - marketplace: string; - /** - * Whether the update succeeded for this plugin - */ - success: boolean; +export interface PushAttachmentSelection { /** - * Previously installed version, when available + * Attachment type discriminator */ - previousVersion?: string; + type: "selection"; /** - * Version after the update, when available + * Absolute path to the file containing the selection */ - newVersion?: string; + filePath: string; /** - * Number of skills installed after the update (success only) + * User-facing display name for the selection */ - skillsInstalled?: number; + displayName: string; /** - * Error message (failure only) + * The selected text content */ - error?: string; + text: string; + selection: PushAttachmentSelectionDetails; } /** - * Result of updating all installed plugins. + * Position range of the selection within the file * * This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema - * via the `definition` "PluginUpdateAllResult". + * via the `definition` "PushAttachmentSelectionDetails". */ /** @experimental */ -export interface PluginUpdateAllResult { - /** - * Per-plugin update results in deterministic order. - */ - results: PluginUpdateAllEntry[]; +export interface PushAttachmentSelectionDetails { + start: PushAttachmentSelectionDetailsStart; + end: PushAttachmentSelectionDetailsEnd; } /** - * Result of updating a single plugin. + * Start position of the selection * * This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema - * via the `definition` "PluginUpdateResult". + * via the `definition` "PushAttachmentSelectionDetailsStart". */ /** @experimental */ -export interface PluginUpdateResult { - /** - * Version that was previously installed, when available - */ - previousVersion?: string; +export interface PushAttachmentSelectionDetailsStart { /** - * Version after the update, when reported by the plugin manifest + * Start line number (0-based) */ - newVersion?: string; + line: number; /** - * Number of skills discovered and installed after the update + * Start character offset within the line (0-based) */ - skillsInstalled: number; + character: number; } /** - * BYOK providers and/or models to add to the session's registry at runtime. Both fields are optional; provide providers, models, or both. + * End position of the selection * * This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema - * via the `definition` "ProviderAddRequest". + * via the `definition` "PushAttachmentSelectionDetailsEnd". */ /** @experimental */ -export interface ProviderAddRequest { +export interface PushAttachmentSelectionDetailsEnd { /** - * 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 '/'. + * End line number (0-based) */ - providers?: NamedProviderConfig[]; + line: number; /** - * 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. + * End character offset within the line (0-based) */ - models?: ProviderModelConfig[]; + character: number; } /** - * A BYOK model definition referencing a named provider. + * GitHub issue, pull request, or discussion reference * * This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema - * via the `definition` "ProviderModelConfig". + * via the `definition` "PushAttachmentGitHubReference". */ /** @experimental */ -export interface ProviderModelConfig { +export interface PushAttachmentGitHubReference { /** - * 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`. + * Attachment type discriminator */ - id: string; + type: "github_reference"; /** - * Name of the NamedProviderConfig that serves this model. + * Issue, pull request, or discussion number */ - provider: string; + number: number; /** - * The model name sent to the provider API for inference. Defaults to `id`. + * Title of the referenced item */ - wireModel?: string; + title: string; + referenceType: PushAttachmentGitHubReferenceType; /** - * Well-known base model id used for behavior/capability/config lookup. Defaults to `id`. + * Current state of the referenced item (e.g., open, closed, merged) */ - modelId?: string; + state: string; /** - * Display name for model pickers. Defaults to the provider-qualified selection id (`provider/id`). + * URL to the referenced item on GitHub */ - name?: string; + url: string; +} +/** + * Pointer to a GitHub commit. + * + * This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema + * via the `definition` "PushAttachmentGitHubCommit". + */ +/** @experimental */ +export interface PushAttachmentGitHubCommit { /** - * Maximum prompt/input tokens for the model. + * Attachment type discriminator */ - maxPromptTokens?: number; + type: "github_commit"; + repo: PushGitHubRepoRef; /** - * Maximum context window tokens for the model. + * Full commit SHA */ - maxContextWindowTokens?: number; + oid: string; /** - * Maximum output tokens for the model. + * First line of the commit message */ - maxOutputTokens?: number; - capabilities?: ModelCapabilitiesOverride; + message: string; + /** + * URL to the commit on GitHub + */ + url: string; } /** - * The selectable model entries synthesized for the models added by this call. + * Pointer to a GitHub repository. * * This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema - * via the `definition` "ProviderAddResult". + * via the `definition` "PushGitHubRepoRef". */ /** @experimental */ -export interface ProviderAddResult { +export interface PushGitHubRepoRef { /** - * 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. + * Numeric GitHub repository id + */ + id?: number; + /** + * Repository name (without owner) + */ + name: string; + /** + * Repository owner login (user or organization) */ - models: unknown[]; + owner: string; } /** - * Custom model-provider configuration (BYOK). + * Pointer to a GitHub release. * * This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema - * via the `definition` "ProviderConfig". + * via the `definition` "PushAttachmentGitHubRelease". */ /** @experimental */ -export interface ProviderConfig { - type?: ProviderConfigType; - wireApi?: ProviderConfigWireApi; - transport?: ProviderConfigTransport; +export interface PushAttachmentGitHubRelease { /** - * API endpoint URL. + * Attachment type discriminator */ - baseUrl: string; + type: "github_release"; + repo: PushGitHubRepoRef; /** - * API key. Optional for local providers like Ollama. + * Git tag the release is anchored to */ - apiKey?: string; + tagName: string; /** - * Bearer token for authentication. Sets the Authorization header directly. Takes precedence over apiKey when both are set. + * Human-readable release name */ - bearerToken?: string; - azure?: ProviderConfigAzure; + name: string; /** - * Well-known model ID used for capability lookup. When set, agent behavior config and token limits are inferred from this model. + * URL to the release on GitHub */ - modelId?: string; + url: string; +} +/** + * Pointer to a GitHub Actions job. + * + * This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema + * via the `definition` "PushAttachmentGitHubActionsJob". + */ +/** @experimental */ +export interface PushAttachmentGitHubActionsJob { /** - * The model identifier sent to the provider API for inference (the "wire" model), as opposed to modelId which is the well-known base. + * Attachment type discriminator */ - wireModel?: string; + type: "github_actions_job"; + repo: PushGitHubRepoRef; /** - * Maximum prompt/input tokens for the model. + * Job id within the workflow run */ - maxPromptTokens?: number; + jobId: number; /** - * Maximum context window tokens for the model. + * Display name of the job */ - maxContextWindowTokens?: number; + jobName: string; /** - * Maximum output tokens for the model. + * Display name of the workflow the job ran in */ - maxOutputTokens?: number; + workflowName: string; /** - * Custom HTTP headers to include in all outbound requests to the provider. + * URL to the job on GitHub */ - headers?: { - [k: string]: string | undefined; - }; + url: string; /** - * 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. + * Terminal conclusion of the job when finished (e.g., success, failure, cancelled). Absent for in-progress jobs. */ - hasBearerTokenProvider?: boolean; + conclusion?: string; } /** - * A snapshot of the provider endpoint the session is currently configured to talk to. + * Pointer to a GitHub repository. * * This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema - * via the `definition` "ProviderEndpoint". + * via the `definition` "PushAttachmentGitHubRepository". */ /** @experimental */ -export interface ProviderEndpoint { - type: ProviderEndpointType; - wireApi?: ProviderEndpointWireApi; - transport?: ProviderEndpointTransport; +export interface PushAttachmentGitHubRepository { /** - * Base URL to pass to the LLM client library. + * Attachment type discriminator */ - baseUrl: string; + type: "github_repository"; + repo: PushGitHubRepoRef; /** - * A credential the caller should use with this endpoint. Omitted only when the endpoint accepts unauthenticated requests. + * URL to the repository on GitHub */ - apiKey?: string; + url: string; /** - * HTTP headers the caller must include on every outbound request. + * Short description of the repository */ - headers: { - [k: string]: string | undefined; - }; - sessionToken?: ProviderSessionToken; + description?: string; + /** + * Git ref this attachment is anchored at (branch, tag, or commit). When absent the default branch is implied. + */ + ref?: string; } /** - * 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. + * 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` "ProviderSessionToken". + * via the `definition` "PushAttachmentGitHubFileDiff". */ /** @experimental */ -export interface ProviderSessionToken { - /** - * The short-lived token value. - */ - token: string; - /** - * HTTP header name the token must be sent under. - */ - header: string; +export interface PushAttachmentGitHubFileDiff { /** - * The model the token is bound to, when applicable. When set, the token is only valid for requests against this model. + * Attachment type discriminator */ - model?: string; + type: "github_file_diff"; /** - * 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`. + * URL to the diff on GitHub (e.g., a commit, compare, or PR-file URL) */ - expiresAt?: string; + url: string; + head?: PushAttachmentGitHubFileDiffSide; + base?: PushAttachmentGitHubFileDiffSide; } /** - * Optional model identifier to scope the endpoint snapshot to. + * One side of a file diff (head or base) * * This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema - * via the `definition` "ProviderGetEndpointRequest". + * via the `definition` "PushAttachmentGitHubFileDiffSide". */ /** @experimental */ -export interface ProviderGetEndpointRequest { +export interface PushAttachmentGitHubFileDiffSide { + repo: PushGitHubRepoRef; /** - * 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. + * Git ref (branch, tag, or commit SHA) the file is read at */ - modelId?: string; + ref: string; + /** + * Repository-relative path to the file + */ + path: string; } /** - * 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. + * Pointer to a comparison between two git revisions. * * This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema - * via the `definition` "ProviderTokenAcquireRequest". + * via the `definition` "PushAttachmentGitHubTreeComparison". */ /** @experimental */ -export interface ProviderTokenAcquireRequest { +export interface PushAttachmentGitHubTreeComparison { /** - * Target session identifier + * Attachment type discriminator */ - sessionId: string; + type: "github_tree_comparison"; /** - * 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`. + * URL to the comparison on GitHub */ - providerName: string; + url: string; + base: PushAttachmentGitHubTreeComparisonSide; + head: PushAttachmentGitHubTreeComparisonSide; } /** - * 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. + * One side of a tree comparison (head or base) * * This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema - * via the `definition` "ProviderTokenAcquireResult". + * via the `definition` "PushAttachmentGitHubTreeComparisonSide". */ /** @experimental */ -export interface ProviderTokenAcquireResult { +export interface PushAttachmentGitHubTreeComparisonSide { + repo: PushGitHubRepoRef; /** - * The bearer token value (without the `Bearer ` prefix). + * Git revision (branch, tag, or commit SHA) */ - token: string; + revision: string; } /** - * File attachment + * Generic GitHub URL reference. * * This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema - * via the `definition` "PushAttachmentFile". + * via the `definition` "PushAttachmentGitHubUrl". */ /** @experimental */ -export interface PushAttachmentFile { +export interface PushAttachmentGitHubUrl { /** * Attachment type discriminator */ - type: "file"; - /** - * Absolute file path - */ - path: string; + type: "github_url"; /** - * User-facing display name for the attachment + * URL to the GitHub resource */ - displayName: string; - lineRange?: PushAttachmentFileLineRange; + url: string; } /** - * Optional line range to scope the attachment to a specific section of the file + * Pointer to a file in a GitHub repository at a specific ref. * * This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema - * via the `definition` "PushAttachmentFileLineRange". + * via the `definition` "PushAttachmentGitHubFile". */ /** @experimental */ -export interface PushAttachmentFileLineRange { +export interface PushAttachmentGitHubFile { /** - * Start line number (1-based) + * Attachment type discriminator */ - start: number; + type: "github_file"; + repo: PushGitHubRepoRef; /** - * End line number (1-based, inclusive) + * Git ref the file is read at (branch, tag, or commit SHA) */ - end: number; + ref: string; + /** + * Repository-relative path to the file + */ + path: string; + /** + * URL to the file on GitHub + */ + url: string; } /** - * Directory attachment + * Pointer to a line range inside a file in a GitHub repository. * * This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema - * via the `definition` "PushAttachmentDirectory". + * via the `definition` "PushAttachmentGitHubSnippet". */ /** @experimental */ -export interface PushAttachmentDirectory { +export interface PushAttachmentGitHubSnippet { /** * Attachment type discriminator */ - type: "directory"; + type: "github_snippet"; + repo: PushGitHubRepoRef; /** - * Absolute directory path + * Git ref the file is read at (branch, tag, or commit SHA) + */ + ref: string; + /** + * Repository-relative path to the file */ path: string; /** - * User-facing display name for the attachment + * URL to the snippet on GitHub (with line anchor) */ - displayName: string; + url: string; + lineRange: PushAttachmentFileLineRange; } /** - * Code selection attachment from an editor + * Blob attachment with inline base64-encoded data * * This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema - * via the `definition` "PushAttachmentSelection". + * via the `definition` "PushAttachmentBlob". */ /** @experimental */ -export interface PushAttachmentSelection { +export interface PushAttachmentBlob { /** * Attachment type discriminator */ - type: "selection"; + type: "blob"; /** - * Absolute path to the file containing the selection + * Base64-encoded content */ - filePath: string; + data: string; /** - * User-facing display name for the selection + * MIME type of the inline data */ - displayName: string; + mimeType: string; /** - * The selected text content + * User-facing display name for the attachment */ - text: string; - selection: PushAttachmentSelectionDetails; + displayName?: string; } /** - * Position range of the selection within the file + * Inputs for starting a deferred-idle drain. * * This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema - * via the `definition` "PushAttachmentSelectionDetails". + * via the `definition` "QueueBeginDeferredIdleDrainRequest". */ /** @experimental */ -export interface PushAttachmentSelectionDetails { - start: PushAttachmentSelectionDetailsStart; - end: PushAttachmentSelectionDetailsEnd; +export interface QueueBeginDeferredIdleDrainRequest { + /** + * Whether the host still has active background work. + */ + activeBackgroundWork: boolean; } /** - * Start position of the selection + * Whether a deferred-idle drain should run. * * This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema - * via the `definition` "PushAttachmentSelectionDetailsStart". + * via the `definition` "QueueBeginDeferredIdleDrainResult". */ /** @experimental */ -export interface PushAttachmentSelectionDetailsStart { +export interface QueueBeginDeferredIdleDrainResult { /** - * Start line number (0-based) - */ - line: number; - /** - * Start character offset within the line (0-based) + * True when the host should run finishDeferredIdleDrain asynchronously. */ - character: number; + shouldDrain: boolean; } /** - * End position of the selection + * Internal filter for consuming queued system notifications. * * This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema - * via the `definition` "PushAttachmentSelectionDetailsEnd". + * via the `definition` "QueueConsumeSystemNotificationsRequest". */ /** @experimental */ -export interface PushAttachmentSelectionDetailsEnd { - /** - * End line number (0-based) - */ - line: number; +export interface QueueConsumeSystemNotificationsRequest { /** - * End character offset within the line (0-based) + * Opaque runtime-owned filter object. */ - character: number; + filter: JsonValue; } /** - * GitHub issue, pull request, or discussion reference + * Inputs for marking session.idle deferred in native state. * * This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema - * via the `definition` "PushAttachmentGitHubReference". + * via the `definition` "QueueDeferSessionIdleRequest". */ /** @experimental */ -export interface PushAttachmentGitHubReference { - /** - * Attachment type discriminator - */ - type: "github_reference"; +export interface QueueDeferSessionIdleRequest { /** - * Issue, pull request, or discussion number + * Whether the deferred idle was caused by an aborted foreground turn. */ - number: number; + aborted: boolean; +} +/** + * Parameters for duplicating a queued item. + * + * This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema + * via the `definition` "QueueDuplicateAtRequest". + */ +/** @experimental */ +export interface QueueDuplicateAtRequest { /** - * Title of the referenced item + * Stable opaque ID of the queued item to duplicate. */ - title: string; - referenceType: PushAttachmentGitHubReferenceType; + id: string; +} +/** + * Result of duplicating a queued item. + * + * This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema + * via the `definition` "QueueDuplicateAtResult". + */ +/** @experimental */ +export interface QueueDuplicateAtResult { /** - * Current state of the referenced item (e.g., open, closed, merged) + * Fresh stable opaque id assigned to the duplicate. */ - state: string; + id: string; +} +/** + * Result of enqueueing the resume-pending wake item. + * + * This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema + * via the `definition` "QueueEnqueueResumePendingResult". + */ +/** @experimental */ +export interface QueueEnqueueResumePendingResult { /** - * URL to the referenced item on GitHub + * True when a wake item was newly queued. */ - url: string; + queued: boolean; } /** - * Pointer to a GitHub commit. + * Inputs for completing a deferred-idle drain. * * This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema - * via the `definition` "PushAttachmentGitHubCommit". + * via the `definition` "QueueFinishDeferredIdleDrainRequest". */ /** @experimental */ -export interface PushAttachmentGitHubCommit { +export interface QueueFinishDeferredIdleDrainRequest { /** - * Attachment type discriminator + * Whether the host still has active background work. */ - type: "github_commit"; - repo: PushGitHubRepoRef; + activeBackgroundWork: boolean; /** - * Full commit SHA + * Whether native queued work remains. */ - oid: string; + hasPending: boolean; +} +/** + * Action selected by the native deferred-idle drain. + * + * This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema + * via the `definition` "QueueFinishDeferredIdleDrainResult". + */ +/** @experimental */ +export interface QueueFinishDeferredIdleDrainResult { /** - * First line of the commit message + * One of none, processQueue, or emitSessionIdle. */ - message: string; + action: string; /** - * URL to the commit on GitHub + * Whether the deferred idle was caused by an aborted foreground turn. */ - url: string; + aborted: boolean; } /** - * Pointer to a GitHub repository. + * Whether the native queue has pending work. * * This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema - * via the `definition` "PushGitHubRepoRef". + * via the `definition` "QueueHasPendingResult". */ /** @experimental */ -export interface PushGitHubRepoRef { - /** - * Numeric GitHub repository id - */ - id?: number; +export interface QueueHasPendingResult { /** - * Repository name (without owner) + * True when queued or immediate native work is pending. */ - name: string; + hasPending: boolean; +} +/** + * Parameters for inserting a queued message at a public visible position. + * + * This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema + * via the `definition` "QueueInsertAtRequest". + */ +/** @experimental */ +export interface QueueInsertAtRequest { /** - * Repository owner login (user or organization) + * Zero-based position in the public visible queue. Values outside the queue clamp to an end. */ - owner: string; + position: number; + message: QueueInsertMessage; } /** - * Pointer to a GitHub release. + * Serializable message fields accepted by queue.insertAt. * * This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema - * via the `definition` "PushAttachmentGitHubRelease". + * via the `definition` "QueueInsertMessage". */ /** @experimental */ -export interface PushAttachmentGitHubRelease { +export interface QueueInsertMessage { /** - * Attachment type discriminator + * The user message text. */ - type: "github_release"; - repo: PushGitHubRepoRef; + prompt: string; /** - * Git tag the release is anchored to + * Optional user-facing display text. */ - tagName: string; + displayPrompt?: string; /** - * Human-readable release name + * Optional attachments for the message. */ - name: string; + attachments?: Attachment[]; + agentMode?: SendAgentMode; /** - * URL to the release on GitHub + * 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. */ - url: string; -} -/** - * Pointer to a GitHub Actions job. - * - * This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema - * via the `definition` "PushAttachmentGitHubActionsJob". - */ -/** @experimental */ -export interface PushAttachmentGitHubActionsJob { + source?: string; /** - * Attachment type discriminator + * Whether the message is billable. */ - type: "github_actions_job"; - repo: PushGitHubRepoRef; + billable?: boolean; /** - * Job id within the workflow run + * Required tool name for the turn, when any. */ - jobId: number; + requiredTool?: string; /** - * Display name of the job + * Per-turn request headers. */ - jobName: string; + requestHeaders?: { + [k: string]: string | undefined; + }; + mode?: SendMode; /** - * Display name of the workflow the job ran in + * Accepted for SendOptions compatibility but ignored; the requested public position controls placement. */ - workflowName: string; + prepend?: boolean; /** - * URL to the job on GitHub + * Accepted for SendOptions compatibility but ignored; insertion scheduling is controlled by the queue drain state. */ - url: string; + wait?: boolean; /** - * Terminal conclusion of the job when finished (e.g., success, failure, cancelled). Absent for in-progress jobs. + * Accepted for internal SendOptions compatibility but ignored; delivery is derived from current session activity. */ - conclusion?: string; + delivery?: string; } /** - * Pointer to a GitHub repository. + * Result of inserting a queued message. * * This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema - * via the `definition` "PushAttachmentGitHubRepository". + * via the `definition` "QueueInsertAtResult". */ /** @experimental */ -export interface PushAttachmentGitHubRepository { - /** - * Attachment type discriminator - */ - type: "github_repository"; - repo: PushGitHubRepoRef; +export interface QueueInsertAtResult { /** - * URL to the repository on GitHub + * Fresh stable opaque id assigned to the inserted item. */ - url: string; + id: string; +} +/** + * Parameters for moving a queued item by stable id. + * + * This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema + * via the `definition` "QueueMoveItemRequest". + */ +/** @experimental */ +export interface QueueMoveItemRequest { /** - * Short description of the repository + * Stable opaque queued-item id. */ - description?: string; + id: string; /** - * Git ref this attachment is anchored at (branch, tag, or commit). When absent the default branch is implied. + * Zero-based target position in the public visible queue. Values outside the queue clamp to an end. */ - ref?: string; + toPosition: number; } /** - * Pointer to a single-file diff. At least one of `head` and `base` must be present. + * Result of moving a queued item. * * This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema - * via the `definition` "PushAttachmentGitHubFileDiff". + * via the `definition` "QueueMoveItemResult". */ /** @experimental */ -export interface PushAttachmentGitHubFileDiff { - /** - * Attachment type discriminator - */ - type: "github_file_diff"; +export interface QueueMoveItemResult { /** - * URL to the diff on GitHub (e.g., a commit, compare, or PR-file URL) + * True when the item changed position; false when it was already at the requested position. */ - url: string; - head?: PushAttachmentGitHubFileDiffSide; - base?: PushAttachmentGitHubFileDiffSide; + changed: boolean; } /** - * One side of a file diff (head or base) + * 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` "PushAttachmentGitHubFileDiffSide". + * via the `definition` "QueuePendingItems". */ /** @experimental */ -export interface PushAttachmentGitHubFileDiffSide { - repo: PushGitHubRepoRef; +export interface QueuePendingItems { /** - * Git ref (branch, tag, or commit SHA) the file is read at + * Stable opaque id for the canonical queued item. Batch rows share one id. */ - ref: string; + id: string; + kind: QueuePendingItemsKind; /** - * Repository-relative path to the file + * Human-readable text to display for this queue entry in the UI */ - path: string; + displayText: string; + agentMode: SendAgentMode; } /** - * Pointer to a comparison between two git revisions. + * Snapshot of the session's pending queued items and immediate-steering messages. * * This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema - * via the `definition` "PushAttachmentGitHubTreeComparison". + * via the `definition` "QueuePendingItemsResult". */ /** @experimental */ -export interface PushAttachmentGitHubTreeComparison { +export interface QueuePendingItemsResult { /** - * Attachment type discriminator + * Pending queued items in submission order. Includes user messages, queued slash commands, and queued model changes; omits internal system items. */ - type: "github_tree_comparison"; + items: QueuePendingItems[]; /** - * URL to the comparison on GitHub + * Display text for messages currently in the immediate steering queue (interjections sent during a running turn). */ - url: string; - base: PushAttachmentGitHubTreeComparisonSide; - head: PushAttachmentGitHubTreeComparisonSide; + steeringMessages: string[]; + /** + * How many leading entries of `steeringMessages` have already been folded into the running turn (and so have an emitted `user.message`), as opposed to still waiting for one. Absent for hosts that do not distinguish the two. + */ + inFlightSteeringCount?: number; } /** - * One side of a tree comparison (head or base) + * Parameters for removing a queued item by stable id. * * This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema - * via the `definition` "PushAttachmentGitHubTreeComparisonSide". + * via the `definition` "QueueRemoveAtRequest". */ /** @experimental */ -export interface PushAttachmentGitHubTreeComparisonSide { - repo: PushGitHubRepoRef; +export interface QueueRemoveAtRequest { /** - * Git revision (branch, tag, or commit SHA) + * Stable opaque ID of the queued item to remove. */ - revision: string; + id: string; } /** - * Generic GitHub URL reference. + * Result of removing a queued item. * * This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema - * via the `definition` "PushAttachmentGitHubUrl". + * via the `definition` "QueueRemoveAtResult". */ /** @experimental */ -export interface PushAttachmentGitHubUrl { - /** - * Attachment type discriminator - */ - type: "github_url"; +export interface QueueRemoveAtResult { /** - * URL to the GitHub resource + * True when the addressed item was removed. */ - url: string; + removed: boolean; } /** - * Pointer to a file in a GitHub repository at a specific ref. + * Indicates whether a user-facing pending item was removed. * * This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema - * via the `definition` "PushAttachmentGitHubFile". + * via the `definition` "QueueRemoveMostRecentResult". */ /** @experimental */ -export interface PushAttachmentGitHubFile { - /** - * Attachment type discriminator - */ - type: "github_file"; - repo: PushGitHubRepoRef; - /** - * Git ref the file is read at (branch, tag, or commit SHA) - */ - ref: string; - /** - * Repository-relative path to the file - */ - path: string; +export interface QueueRemoveMostRecentResult { /** - * URL to the file on GitHub + * True if a user-facing pending item was removed (LIFO across both queues); false when no removable items remained. */ - url: string; + removed: boolean; } /** - * Pointer to a line range inside a file in a GitHub repository. + * Parameters for steering a queued message into a live turn. * * This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema - * via the `definition` "PushAttachmentGitHubSnippet". + * via the `definition` "QueueSendNowRequest". */ /** @experimental */ -export interface PushAttachmentGitHubSnippet { - /** - * Attachment type discriminator - */ - type: "github_snippet"; - repo: PushGitHubRepoRef; - /** - * Git ref the file is read at (branch, tag, or commit SHA) - */ - ref: string; - /** - * Repository-relative path to the file - */ - path: string; +export interface QueueSendNowRequest { /** - * URL to the snippet on GitHub (with line anchor) + * Stable opaque ID of the queued item to steer into the live turn. */ - url: string; - lineRange: PushAttachmentFileLineRange; + id: string; } /** - * Blob attachment with inline base64-encoded data + * Result of trying to steer a queued message into a live turn. * * This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema - * via the `definition` "PushAttachmentBlob". + * via the `definition` "QueueSendNowResult". */ /** @experimental */ -export interface PushAttachmentBlob { - /** - * Attachment type discriminator - */ - type: "blob"; - /** - * Base64-encoded content - */ - data: string; +export interface QueueSendNowResult { /** - * MIME type of the inline data + * True when the item was accepted into the steering lane; false when no main turn was live. */ - mimeType: string; + steered: boolean; +} +/** + * 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` "QueueSetDrainPausedRequest". + */ +/** @experimental */ +export interface QueueSetDrainPausedRequest { /** - * User-facing display name for the attachment + * Whether queued-lane draining should be paused. */ - displayName?: string; + paused: boolean; } /** - * User-facing pending queue entry, with kind and display text for a queued message, slash command, or model change. + * Internal snapshot of native queue state for local session orchestration. * * This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema - * via the `definition` "QueuePendingItems". + * via the `definition` "QueueSnapshotResult". */ /** @experimental */ -export interface QueuePendingItems { - kind: QueuePendingItemsKind; +export interface QueueSnapshotResult { + /** + * User-facing pending items in FIFO order. + */ + items: QueuePendingItems[]; + /** + * Immediate steering messages waiting for an active turn. + */ + steeringMessages: string[]; + /** + * Insertion orders for queued items, aligned with `items`. + */ + itemOrders?: number[]; /** - * Human-readable text to display for this queue entry in the UI + * Insertion orders for immediate steering messages, aligned with `steeringMessages`. */ - displayText: string; + steeringMessageOrders?: number[]; } /** - * Snapshot of the session's pending queued items and immediate-steering messages. + * Parameters for editing a single queued message. * * This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema - * via the `definition` "QueuePendingItemsResult". + * via the `definition` "QueueUpdateTextRequest". */ /** @experimental */ -export interface QueuePendingItemsResult { +export interface QueueUpdateTextRequest { /** - * Pending queued items in submission order. Includes user messages, queued slash commands, and queued model changes; omits internal system items. + * Stable opaque ID of the queued item to edit. */ - items: QueuePendingItems[]; + id: string; /** - * Display text for messages currently in the immediate steering queue (interjections sent during a running turn). + * Replacement prompt sent to the model. */ - steeringMessages: string[]; + prompt: string; + /** + * Optional replacement prompt displayed to the user. + */ + displayPrompt?: string; } /** - * Indicates whether a user-facing pending item was removed. + * Result of editing a queued message. * * This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema - * via the `definition` "QueueRemoveMostRecentResult". + * via the `definition` "QueueUpdateTextResult". */ /** @experimental */ -export interface QueueRemoveMostRecentResult { +export interface QueueUpdateTextResult { /** - * True if a user-facing pending item was removed (LIFO across both queues); false when no removable items remained. + * True when the stored text changed. */ - removed: boolean; + updated: boolean; } /** * Event type to register consumer interest for, used by runtime gating logic. @@ -11072,9 +16048,7 @@ export interface RegisterExtensionToolsParams { * * @internal */ - loader: { - [k: string]: unknown | undefined; - }; + loader: OpaqueInProcessValue; options?: SessionsRegisterExtensionToolsOnSessionOptions; } /** @@ -11090,9 +16064,7 @@ export interface SessionsRegisterExtensionToolsOnSessionOptions { * * @internal */ - enabled?: { - [k: string]: unknown | undefined; - }; + enabled?: OpaqueInProcessValue; } /** * Handle for releasing the extension tool registration. @@ -11110,9 +16082,7 @@ export interface RegisterExtensionToolsResult { * * @internal */ - unsubscribe: { - [k: string]: unknown | undefined; - }; + unsubscribe: OpaqueInProcessValue; } /** * Opaque handle previously returned by `registerInterest` to release. @@ -11229,13 +16199,11 @@ export interface RemoteControlStatusActive { */ 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. + * In-process prompt-manager handle (CLI-only optimization). Marked internal: this field is excluded from the public SDK surface. Retained as an optional compatibility field; native remote control does not populate or consume it. * * @internal */ - promptManager?: { - [k: string]: unknown | undefined; - }; + 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. * @@ -11440,6 +16408,11 @@ export interface RemoteSessionMetadataValue { * Server-side task state returned by GitHub. */ state?: string; + hostStatus?: RemoteSessionHostStatus; + /** + * Host-supplied human description of what the session is doing right now ("running tests", "waiting for approval"). Optional in the protocol and absent on hosts that do not publish it, so never rely on it -- it enriches `hostStatus`, it does not replace it. + */ + hostActivity?: string; } /** * Repository context for the remote session. @@ -11479,14 +16452,11 @@ export interface SandboxConfig { * Whether to auto-add the current working directory to readwritePaths. Default: true. */ addCurrentWorkingDirectory?: boolean; + auth?: SandboxConfigAuth; /** - * Whether to inject the Copilot GitHub token as an `http..extraheader` so authenticated HTTPS git works inside the sandbox without the shell-based credential helper the sandbox blocks. Default: false (opt-in). - */ - gitAuth?: boolean; - /** - * Whether to export `GH_TOKEN` so the `gh` CLI authenticates inside the sandbox without the OS keyring the sandbox blocks. Default: false (opt-in). + * Whether to auto-grant read access to tool directories discovered on PATH and in toolchain environment variables (GOROOT, JAVA_HOME, VIRTUAL_ENV, and similar), and to common developer-tool caches, config, and toolchains. Writable grants cover scratch caches, the Unix GitHub CLI cache, and Cargo's registry, git store, and lock/tracker files. A relocated CARGO_HOME gets the same narrow split: registry and git are read-write; bin is read-only; the home root, config.toml, and credentials.toml stay ungranted. Set to false to disable every grant listed above; user-installed toolchains and caches then need explicit userPolicy.filesystem readonlyPaths and readwritePaths entries. The working directory (see addCurrentWorkingDirectory), temporary storage, session log paths, and system locations follow their own rules and stay granted. Default: true (enabled by default; set to false to opt out). */ - ghAuth?: boolean; + allowDevToolAccess?: boolean; } /** * User-managed sandbox policy fragment merged into the auto-discovered base policy. @@ -11542,6 +16512,28 @@ export interface SandboxConfigUserPolicyNetwork { * Whether traffic to local/loopback addresses is allowed. */ allowLocalNetwork?: boolean; + proxy?: SandboxConfigUserPolicyNetworkProxy; +} +/** + * HTTP proxy configuration for sandboxed traffic. + * + * This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema + * via the `definition` "SandboxConfigUserPolicyNetworkProxy". + */ +/** @experimental */ +export interface 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. + */ + 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. + */ + username?: string; + /** + * 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; } /** * macOS seatbelt-specific options. @@ -11579,6 +16571,116 @@ export interface SandboxConfigUserPolicyExperimentalSeatbelt { */ keychainAccess?: boolean; } +/** + * Credential-injection capability flags applied while the sandbox is enabled. For the same capability independent of sandboxing, and matched to the credential's GitHub host, see `shell.credentials`; the two are additive. + * + * This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema + * via the `definition` "SandboxConfigAuth". + */ +/** @experimental */ +export interface 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). + */ + git?: boolean; + /** + * 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?: boolean; +} +/** + * Register an absolute-time scheduled prompt. + * + * This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema + * via the `definition` "ScheduleAddAtRequest". + */ +/** @experimental */ +export interface ScheduleAddAtRequest { + /** + * Epoch milliseconds when the prompt should fire. + */ + at: number; + /** + * Prompt text to enqueue when the schedule fires. + */ + prompt: string; + /** + * Whether the schedule should re-arm after each tick. Defaults to false. + */ + recurring?: boolean; + /** + * Optional display-only prompt label. + */ + displayPrompt?: string; +} +/** + * Register a cron scheduled prompt. + * + * This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema + * via the `definition` "ScheduleAddCronRequest". + */ +/** @experimental */ +export interface ScheduleAddCronRequest { + /** + * 5-field cron expression. + */ + 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; +} +/** + * Register a relative-interval scheduled prompt. + * + * This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema + * via the `definition` "ScheduleAddRequest". + */ +/** @experimental */ +export interface ScheduleAddRequest { + /** + * Human-readable interval such as `30s`, `5m`, or `2h`. + */ + interval: 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; +} +/** + * Result of registering or re-arming a scheduled prompt. + * + * This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema + * via the `definition` "ScheduleAddResult". + */ +/** @experimental */ +export interface ScheduleAddResult { + entry?: ScheduleEntry; + /** + * User-facing validation error, when registration failed. + */ + error?: string; +} /** * Scheduled prompt entry with ID, timing (`intervalMs`, `cron`, or `at`), prompt text, recurrence, and next run time. * @@ -11628,6 +16730,36 @@ export interface ScheduleEntry { */ nextRunAt: string; } +/** + * Register a self-paced scheduled prompt. + * + * This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema + * via the `definition` "ScheduleAddSelfPacedRequest". + */ +/** @experimental */ +export interface ScheduleAddSelfPacedRequest { + /** + * Prompt text to enqueue when the schedule fires. + */ + prompt: string; + /** + * Optional display-only prompt label. + */ + displayPrompt?: string; +} +/** + * Whether the session currently has an active self-paced schedule. + * + * This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema + * via the `definition` "ScheduleHasSelfPacedResult". + */ +/** @experimental */ +export interface ScheduleHasSelfPacedResult { + /** + * True when at least one active schedule is self-paced. + */ + hasSelfPaced: boolean; +} /** * Snapshot of the currently active recurring prompts for this session. * @@ -11641,6 +16773,23 @@ export interface ScheduleList { */ entries: ScheduleEntry[]; } +/** + * Re-arm a self-paced scheduled prompt. + * + * This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema + * via the `definition` "ScheduleRearmSelfPacedRequest". + */ +/** @experimental */ +export interface ScheduleRearmSelfPacedRequest { + /** + * Id of the self-paced scheduled prompt. + */ + id: number; + /** + * Epoch milliseconds when the prompt should next fire. + */ + at: number; +} /** * Identifier of the scheduled prompt to remove. * @@ -11738,7 +16887,7 @@ export interface SendMessageItem { */ requiredTool?: string; /** - * Optional provenance tag copied to the resulting user.message event. Must match one of three forms: the literal `system`, `command-` for messages originating from a command (e.g. slash command, Mission Control command), or `schedule-` for messages originating from a scheduled job. + * 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 */ @@ -11777,7 +16926,7 @@ export interface SendMessagesRequest { */ 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. + * 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; } @@ -11828,7 +16977,7 @@ export interface SendRequest { */ requiredTool?: string; /** - * Optional provenance tag copied to the resulting user.message event. Must match one of three forms: the literal `system`, `command-` for messages originating from a command (e.g. slash command, Mission Control command), or `schedule-` for messages originating from a scheduled job. + * 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 */ @@ -11849,7 +16998,7 @@ export interface SendRequest { */ 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. + * 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; } @@ -11866,6 +17015,27 @@ export interface SendResult { */ messageId: string; } +/** + * Internal request for sending a system notification. + * + * This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema + * via the `definition` "SendSystemNotificationRequest". + */ +/** @experimental */ +export interface SendSystemNotificationRequest { + /** + * Notification text to deliver to the model. + */ + message: string; + /** + * Optional structured notification kind. + */ + kind?: JsonValue; + /** + * Internal delivery options, including passive policy. + */ + options?: JsonValue; +} /** * Agents discovered across user, project, plugin, and remote sources. * @@ -11904,6 +17074,10 @@ export interface ServerSkill { * 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 */ @@ -11964,6 +17138,41 @@ export interface SessionActivity { */ hasActiveWork: boolean; } +/** + * Internal GitHub login parameters. + * + * This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema + * via the `definition` "SessionAuthLoginRequest". + */ +/** @experimental */ +export interface SessionAuthLoginRequest { + /** + * GitHub host URL + */ + host: string; + /** + * GitHub login + */ + login: string; + /** + * GitHub authentication token + */ + token: string; + /** + * Whether to persist the token after login + */ + persist?: boolean; +} +/** + * Parameters identifying a GitHub authentication to log out. + * + * This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema + * via the `definition` "SessionAuthLogoutUserRequest". + */ +/** @experimental */ +export interface SessionAuthLogoutUserRequest { + authInfo: AuthInfo; +} /** * Authentication status and account metadata for the session. * @@ -11994,6 +17203,20 @@ export interface SessionAuthStatus { */ copilotPlan?: string; } +/** + * Parameters for switching the session's active authentication. + * + * This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema + * via the `definition` "SessionAuthSwitchRequest". + */ +/** @experimental */ +export interface SessionAuthSwitchRequest { + authInfo: AuthInfo; + /** + * Optional token paired with the authentication information + */ + token?: string; +} /** * Map of sessionId -> bytes freed by removing the session's workspace directory. * @@ -12328,7 +17551,7 @@ export interface SessionFsSqliteExistsResult { exists: boolean; } /** - * 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. * * This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema * via the `definition` "SessionFsSqliteQueryRequest". @@ -12348,7 +17571,7 @@ export interface SessionFsSqliteQueryRequest { * Optional named bind parameters */ params?: { - [k: string]: unknown | undefined; + [k: string]: JsonValue | undefined; }; } /** @@ -12363,7 +17586,7 @@ export interface SessionFsSqliteQueryResult { * For SELECT: array of row objects. For others: empty array. */ rows: { - [k: string]: unknown | undefined; + [k: string]: JsonValue | undefined; }[]; /** * Column names from the result set @@ -12379,6 +17602,71 @@ export interface SessionFsSqliteQueryResult { lastInsertRowid?: number; error?: SessionFsError; } +/** + * Classified SQLite transaction failure. busyOrLocked guarantees rollback; postCommitAmbiguous must never be retried. + * + * This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema + * via the `definition` "SessionFsSqliteTransactionError". + */ +/** @experimental */ +export interface SessionFsSqliteTransactionError { + errorClass: SessionFsSqliteTransactionErrorClass; + /** + * Human-readable transaction failure message. + */ + message: string; +} +/** + * Statements to execute atomically. Providers apply busy handling for every call. + * + * This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema + * via the `definition` "SessionFsSqliteTransactionRequest". + */ +/** @experimental */ +export interface SessionFsSqliteTransactionRequest { + /** + * Target session identifier + */ + sessionId: string; + /** + * Ordered SQL statements to execute in one transaction. + */ + statements: SessionFsSqliteTransactionStatement[]; +} +/** + * One statement in an atomic SQLite transaction. + * + * This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema + * via the `definition` "SessionFsSqliteTransactionStatement". + */ +/** @experimental */ +export interface SessionFsSqliteTransactionStatement { + /** + * SQL statement to execute. + */ + query: string; + queryType: SessionFsSqliteQueryType; + /** + * Optional named bind parameters. + */ + params?: { + [k: string]: JsonValue | undefined; + }; +} +/** + * Per-statement results, or a classified transaction error. + * + * This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema + * via the `definition` "SessionFsSqliteTransactionResult". + */ +/** @experimental */ +export interface SessionFsSqliteTransactionResult { + /** + * Per-statement query results in input order. + */ + results: SessionFsSqliteQueryResult[]; + error?: SessionFsSqliteTransactionError; +} /** * Path whose metadata should be returned from the client-provided session filesystem. * @@ -12484,9 +17772,17 @@ export interface SessionInstalledPlugin { */ 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; + /** + * Absolute path of the marketplace directory a live plugin was resolved from. Present only on live, never-persisted records β€” those synthesized at session start for a directory/local marketplace, whose cache_path points at the real plugin directory on disk rather than a copy under the installed-plugins cache. Its presence is what marks a record as live, and no record carrying it is ever written to the persisted installedPlugins key. + */ + installed_from?: string; } /** - * Source descriptor for a direct GitHub plugin install, with `owner/repo`, optional ref, and optional subpath. + * 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` "SessionInstalledPluginSourceGitHub". @@ -12497,12 +17793,25 @@ export interface SessionInstalledPluginSourceGitHub { * Constant value. Always "github". */ source: "github"; + /** + * GitHub repository in `owner/repo` form. + */ repo: string; + /** + * Optional Git ref to resolve. + */ ref?: string; + /** + * Optional full 40-character hexadecimal commit SHA. + */ + sha?: string; + /** + * Optional repository-relative path to the plugin. + */ path?: string; } /** - * Source descriptor for a direct URL plugin install, with URL, optional ref, and optional subpath. + * 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` "SessionInstalledPluginSourceUrl". @@ -12513,8 +17822,21 @@ export interface SessionInstalledPluginSourceUrl { * Constant value. Always "url". */ source: "url"; + /** + * URL of the plugin source. + */ url: string; + /** + * Optional Git ref to resolve. + */ ref?: string; + /** + * Optional full 40-character hexadecimal commit SHA. + */ + sha?: string; + /** + * Optional source-relative path to the plugin. + */ path?: string; } /** @@ -12529,8 +17851,75 @@ export interface SessionInstalledPluginSourceLocal { * Constant value. Always "local". */ source: "local"; + /** + * Local filesystem path to the plugin. + */ 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 { + /** + * Start of the baseline data slice. + */ + windowStart: string; + /** + * End of the baseline data slice. + */ + windowEnd: string; +} +/** + * Explainable AI-credit session-limit prediction. + * + * This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema + * via the `definition` "SessionLimitPredictionDetails". + */ +/** @experimental */ +export interface SessionLimitPredictionDetails { + clientType: SessionLimitPredictionClientType; + /** + * Model identifier used for lookup. + */ + modelId: string; + source: SessionLimitPredictionSource; + /** + * Key matched at the source level, such as a model id, family id, or `global`. + */ + sourceKey: string; + /** + * Resolved model family when known. + */ + family?: string; + /** + * Ordered usage tiers and their AI-credit caps. + */ + tiers: SessionLimitPredictionTierOption[]; + baselineData: SessionLimitPredictionBaselineData; + recommendedTier: SessionLimitPredictionTier; + /** + * Recommended maximum AI credits for this session. + */ + recommendedCap: number; +} +/** + * Semantic usage tier and its AI-credit cap. + * + * This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema + * via the `definition` "SessionLimitPredictionTierOption". + */ +/** @experimental */ +export interface SessionLimitPredictionTierOption { + tier: SessionLimitPredictionTier; + /** + * AI-credit cap for this tier. + */ + cap: number; +} /** * Sessions matching the filter, ordered most-recently-modified first. * @@ -12586,6 +17975,41 @@ export interface SessionLoadDeferredRepoHooksResult { */ hookCount: number; } +/** + * Enterprise permission policy expressed with the runtime's managed permission-rule syntax. + * + * This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema + * via the `definition` "SessionManagedPermissions". + */ +/** @experimental */ +export interface SessionManagedPermissions { + /** + * When set to `disable`, prevents bypass/allow-all permission modes. `allow-auto-only` blocks full allow-all but permits advisory auto-approval. Any other value is accepted rather than failing the session, but is enforced as `disable`: the key is only present to restrict something, so a mode this runtime cannot interpret fails closed to the most restrictive one it knows. Omit the key entirely to impose no restriction. + */ + disableBypassPermissionsMode?: string; + /** + * Permission rules that block matching operations. Deny has highest precedence. + */ + deny?: string[]; + /** + * Permission rules that require explicit human approval. + */ + ask?: string[]; + /** + * Permission rules that allow matching operations unless another managed source, deny, or ask rule restricts them. + */ + allow?: string[]; +} +/** + * 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` "SessionManagedSettings". + */ +/** @experimental */ +export interface SessionManagedSettings { + permissions?: SessionManagedPermissions; +} /** * Point-in-time snapshot of slow-changing session identifier and state fields * @@ -12660,7 +18084,7 @@ export interface 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`). */ - list: unknown[]; + list: JsonValue[]; /** * 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. */ @@ -12669,7 +18093,7 @@ export interface SessionModelList { * Per-quota snapshots returned alongside the model list, keyed by quota type. */ quotaSnapshots?: { - [k: string]: unknown | undefined; + [k: string]: JsonValue | undefined; }; } /** @@ -12680,6 +18104,9 @@ export interface SessionModelList { */ /** @experimental */ export interface SessionModelPriceCategory { + /** + * CAPI model identifier. + */ id: string; priceCategory: ModelPickerPriceCategory; } @@ -12704,7 +18131,7 @@ export interface SessionOpenOptions { */ model?: string; /** - * Initial reasoning effort level. + * 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; reasoningSummary?: SessionOpenOptionsReasoningSummary; @@ -12730,13 +18157,16 @@ export interface SessionOpenOptions { * * @internal */ - expAssignments?: { - [k: string]: unknown | undefined; - }; + expAssignments?: JsonValue; /** * Opt-in: self-fetch and enforce enterprise managed settings at session bootstrap. */ enableManagedSettings?: boolean; + managedSettings?: SessionManagedSettings; + /** + * 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?: boolean; /** * Feature-flag values resolved by the host. */ @@ -12766,6 +18196,10 @@ export interface SessionOpenOptions { * Working directory to anchor the session. */ workingDirectory?: string; + /** + * 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). Conventional `.github/skills/` and `.github/agents/` definitions under each directory also join the session's project catalogs when their existing subsystem gates are enabled: added-root skills require both `enableConfigDiscovery` and effective `enableSkills`; added-root agents require `enableConfigDiscovery`. Supplying a directory therefore activates configuration from it and should be treated as a trust decision. 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 during session creation and cold resume and is not persisted, so a cold resume must re-supply the directories. + */ + additionalDirectories?: string[]; workingDirectoryContext?: SessionContext; /** * Whether this session supports remote steering. @@ -12807,20 +18241,32 @@ export interface SessionOpenOptions { * Whether shell-script safety heuristics are enabled. */ enableScriptSafety?: boolean; + shell?: ShellOptions; /** - * Shell init profile. + * @deprecated + * Use shell.initProfile instead. Shell init profile. */ shellInitProfile?: string; /** - * Per-shell process flags. + * PowerShell process flags applied to built-in and user-requested shell commands. */ shellProcessFlags?: string[]; sandboxConfig?: SandboxConfig; + /** + * Origin of the sandbox choice. The runtime uses this only for internal telemetry provenance; managed policy is derived independently. + * + * @internal + */ + sandboxConfigSource?: SandboxConfigSource; /** * Whether interactive shell sessions are logged. */ logInteractiveShells?: boolean; envValueMode?: SessionOpenOptionsEnvValueMode; + /** + * MCP server names disabled for this session. Disabled servers are not started or authenticated on create or cold resume. + */ + disabledMcpServers?: string[]; /** * Whether to include instructions from every MCP server in the system prompt instead of only allowlisted servers. */ @@ -12829,6 +18275,10 @@ export interface SessionOpenOptions { * Additional directories to search for skills. */ skillDirectories?: string[]; + /** + * Built-in skill names to include in this session. When specified, only these runtime-bundled skills are available. Skills from other sources with the same name remain available. + */ + includedBuiltinSkills?: string[]; /** * Skill IDs disabled for this session. */ @@ -12862,7 +18312,7 @@ export interface SessionOpenOptions { */ enableStreaming?: boolean; /** - * 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: enable native model citations for supported Anthropic and OpenAI models, normalized onto the `assistant.message` event. Off by default; may change or be removed while the citations surface is experimental. * * @experimental */ @@ -12901,6 +18351,10 @@ export interface SessionOpenOptions { * Override directory for session event logs. */ eventsLogDirectory?: string; + /** + * Whether subagent callback events should be forwarded into the session event log sink. + */ + eventsLogIncludesSubagents?: boolean; /** * Override Copilot configuration directory. */ @@ -12917,6 +18371,94 @@ export interface SessionOpenOptions { */ sessionCapabilities?: SessionCapability[]; } +/** + * Per-session settings for built-in shell tools. + * + * This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema + * via the `definition` "ShellOptions". + */ +/** @experimental */ +export interface ShellOptions { + initProfile?: ShellInitProfile; + /** + * 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[]; + /** + * 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[]; + credentials?: ShellCredentials; +} +/** + * 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` "ShellInitScript". + */ +/** @experimental */ +export interface ShellInitScript { + /** + * Path to the script to source. + */ + path: string; + shell: ShellInitScriptShell; +} +/** + * Command-scoped GitHub credential injection for the shell commands an agent runs. + * + * Each channel is opt-in and independent, and injection is scoped to the individual command + * spawn: the credential is resolved from the session's *current* authentication at every spawn + * and reaches only spawns whose script actually invokes `git` or `gh`. Because nothing is + * retained between spawns, replacing the session credential (`session.gitHubAuth.setCredentials`) + * changes what the next spawned command presents β€” which seeding a credential into the runtime + * process's own environment cannot do, since a child's environment is fixed at `exec`. + * + * The credential is matched to the host it authenticates to, so a github.com credential is never + * presented to a GitHub Enterprise host and vice versa. Where a channel cannot express that + * boundary it injects nothing rather than crossing it -- see `gh` below. + * + * This is independent of `sandboxConfig`: it is a decision about which identity the agent + * presents, not about what the agent may touch, and it works on every platform whether or not + * an OS sandboxing backend is available. `sandboxConfig.auth` remains the sandbox-scoped + * spelling and is additive with this one. + * + * This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema + * via the `definition` "ShellCredentials". + */ +/** @experimental */ +export interface ShellCredentials { + /** + * Whether to authenticate the agent's `git` commands as the session's GitHub credential, by + * injecting an `http..extraheader` (plus `insteadOf` rewrites so SSH-spelled remotes for + * that host use the authenticated HTTPS transport). Applied only to a spawn that runs a + * remote-contacting `git` subcommand. Default: false (opt-in). + */ + git?: boolean; + /** + * Whether to authenticate the agent's `gh` commands as the session's GitHub credential, by + * exporting `GH_TOKEN` to a spawn that runs `gh`. Any inherited `gh` credential is removed from + * spawns that do not, so the credential stays command-scoped. + * + * Applies to a github.com credential only. `gh` picks its credential variable from the host a + * command targets rather than the one the credential belongs to, and the command can choose that + * target, so `GH_ENTERPRISE_TOKEN` would offer a single-tenant enterprise credential to every + * other enterprise host. A session whose credential is enterprise-scoped therefore runs `gh` + * unauthenticated; its `git` commands are unaffected, because `http..extraheader` is scoped + * to one host by construction. Default: false (opt-in). + */ + gh?: boolean; +} /** * Content-exclusion policy supplied to `sessions.open` options, with rules, last-updated data, and scope. * @@ -12925,8 +18467,14 @@ export interface SessionOpenOptions { */ /** @experimental */ export interface SessionOpenOptionsAdditionalContentExclusionPolicy { + /** + * Content-exclusion rules to apply. + */ rules: SessionOpenOptionsAdditionalContentExclusionPolicyRule[]; - last_updated_at: unknown; + /** + * Opaque policy update timestamp supplied by the host. + */ + last_updated_at: JsonValue; scope: SessionOpenOptionsAdditionalContentExclusionPolicyScope; } /** @@ -12937,8 +18485,17 @@ export interface SessionOpenOptionsAdditionalContentExclusionPolicy { */ /** @experimental */ export interface SessionOpenOptionsAdditionalContentExclusionPolicyRule { + /** + * Path patterns covered by this rule. + */ paths: string[]; + /** + * Conditions of which at least one must match. + */ ifAnyMatch?: string[]; + /** + * Conditions none of which may match. + */ ifNoneMatch?: string[]; source: SessionOpenOptionsAdditionalContentExclusionPolicyRuleSource; } @@ -12950,7 +18507,13 @@ export interface SessionOpenOptionsAdditionalContentExclusionPolicyRule { */ /** @experimental */ export interface SessionOpenOptionsAdditionalContentExclusionPolicyRuleSource { + /** + * Name of the policy source. + */ name: string; + /** + * Type of the policy source. + */ type: string; } /** @@ -13075,9 +18638,7 @@ export interface SessionsOpenCloud { * * @internal */ - onTaskCreated?: { - [k: string]: unknown | undefined; - }; + onTaskCreated?: OpaqueInProcessValue; } /** * Parameters for fetching a remote session and handing it off to a new local session. @@ -13099,17 +18660,13 @@ export interface SessionsOpenHandoff { * * @internal */ - onProgress?: { - [k: string]: unknown | undefined; - }; + onProgress?: OpaqueInProcessValue; /** * 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?: { - [k: string]: unknown | undefined; - }; + onConfirm?: OpaqueInProcessValue; } /** * Result of opening a session. @@ -13131,9 +18688,7 @@ export interface SessionOpenResult { * * @internal */ - sessionApi?: { - [k: string]: unknown | undefined; - }; + sessionApi?: OpaqueInProcessValue; /** * Startup prompts queued by user-level hook configs at session creation. Only populated when status is `created`; resumed sessions return an empty array. */ @@ -13252,6 +18807,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. * @@ -13273,7 +18845,29 @@ export interface SessionsEnrichMetadataRequest { */ /** @experimental */ export interface SessionSetCredentialsParams { - credentials?: AuthInfo; + credentials?: SettableAuthInfo; +} +/** + * Token authentication accepted by session.gitHubAuth.setCredentials. + * + * This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema + * via the `definition` "SettableTokenAuthInfo". + */ +/** @experimental */ +export interface SettableTokenAuthInfo { + /** + * 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; } /** * Indicates whether the credential update succeeded. @@ -13300,7 +18894,13 @@ export interface SessionSetCredentialsResult { */ /** @experimental */ export interface SessionSettingsBuiltInToolAvailabilitySnapshot { + /** + * Whether the report-progress tool is available. + */ reportProgress?: boolean; + /** + * Whether the create-pull-request tool is available. + */ createPullRequest?: boolean; } /** @@ -13325,6 +18925,9 @@ export interface SessionSettingsEvaluatePredicateRequest { */ /** @experimental */ export interface SessionSettingsEvaluatePredicateResult { + /** + * Whether the named settings predicate evaluated to enabled. + */ enabled: boolean; } /** @@ -13335,7 +18938,13 @@ export interface SessionSettingsEvaluatePredicateResult { */ /** @experimental */ export interface SessionSettingsJobSnapshot { + /** + * GitHub Actions event type for the job. + */ eventType?: string; + /** + * Whether this is the workflow's trigger job. + */ isTriggerJob?: boolean; builtInToolAvailability?: SessionSettingsBuiltInToolAvailabilitySnapshot; } @@ -13347,9 +18956,21 @@ export interface SessionSettingsJobSnapshot { */ /** @experimental */ export interface SessionSettingsModelSnapshot { + /** + * Selected model identifier. + */ model?: string; + /** + * Default reasoning effort for the selected model. + */ defaultReasoningEffort?: string; + /** + * Agent job identifier for the session. + */ instanceId?: string; + /** + * Agent service callback URL for job and progress updates. + */ callbackUrl?: string; } /** @@ -13360,7 +18981,13 @@ export interface SessionSettingsModelSnapshot { */ /** @experimental */ export interface SessionSettingsOnlineEvaluationSnapshot { + /** + * Whether online evaluation is disabled. + */ disableOnlineEvaluation?: boolean; + /** + * Whether online-evaluation output-file generation is enabled. + */ enableOnlineEvaluationOutputFile?: boolean; } /** @@ -13371,17 +18998,53 @@ export interface SessionSettingsOnlineEvaluationSnapshot { */ /** @experimental */ export interface SessionSettingsRepoSnapshot { + /** + * Repository name. + */ name?: string; + /** + * GitHub repository database ID. + */ id?: number; + /** + * Checked-out repository branch. + */ branch?: string; + /** + * Checked-out commit SHA. + */ commit?: string; + /** + * Whether the repository is writable. + */ readWrite?: boolean; + /** + * Repository owner login. + */ ownerName?: string; + /** + * GitHub repository owner database ID. + */ ownerId?: number; + /** + * GitHub server base URL. + */ serverUrl?: string; + /** + * GitHub server host name. + */ host?: string; + /** + * Protocol used to access the GitHub host. + */ hostProtocol?: string; + /** + * GitHub secret-scanning service URL. + */ secretScanningUrl?: string; + /** + * Number of commits in the pull request. + */ prCommitCount?: number; } /** @@ -13392,9 +19055,21 @@ export interface SessionSettingsRepoSnapshot { */ /** @experimental */ export interface SessionSettingsSnapshot { + /** + * Agent runtime version selector copied from the session settings, such as `latest` or a runtime release identifier. + */ version?: string; + /** + * Name of the SDK client that created the session. + */ clientName?: string; + /** + * Session timeout in milliseconds. + */ timeoutMs?: number; + /** + * Session start time as Unix epoch milliseconds. + */ startTimeMs?: number; repo: SessionSettingsRepoSnapshot; model: SessionSettingsModelSnapshot; @@ -13410,14 +19085,41 @@ export interface SessionSettingsSnapshot { */ /** @experimental */ export interface SessionSettingsValidationSnapshot { + /** + * General validation timeout budget in seconds. + */ timeout?: number; + /** + * Dependabot validation timeout budget in seconds. + */ dependabotTimeout?: number; + /** + * Whether CodeQL validation is enabled. + */ codeqlEnabled?: boolean; + /** + * Whether code-review validation is enabled. + */ codeReviewEnabled?: boolean; + /** + * Model used for code-review validation. + */ codeReviewModel?: string; + /** + * Whether advisory validation is enabled. + */ advisoryEnabled?: boolean; + /** + * Whether secret-scanning validation is enabled. + */ secretScanningEnabled?: boolean; + /** + * Whether the memory-store tool is enabled. + */ memoryStoreEnabled?: boolean; + /** + * Whether the memory-vote tool is enabled. + */ memoryVoteEnabled?: boolean; } /** @@ -13576,14 +19278,37 @@ export interface SessionsGetLastForContextRequest { * Most-relevant session ID for the supplied context, or omitted when no sessions exist. * * This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema - * via the `definition` "SessionsGetLastForContextResult". + * via the `definition` "SessionsGetLastForContextResult". + */ +/** @experimental */ +export interface SessionsGetLastForContextResult { + /** + * Most-relevant session ID for the supplied context, or omitted when no sessions exist + */ + 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 SessionsGetLastForContextResult { +export interface SessionsGetMetadataRequest { /** - * Most-relevant session ID for the supplied context, or omitted when no sessions exist + * Session ID to inspect */ - sessionId?: string; + 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. @@ -13626,6 +19351,32 @@ export interface SessionSizes { [k: string]: number | undefined; }; } +/** + * 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. * @@ -13858,7 +19609,7 @@ export interface SessionUpdateOptionsParams { 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; @@ -13912,15 +19663,23 @@ export interface SessionUpdateOptionsParams { * 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[]; sandboxConfig?: SandboxConfig; + /** + * Origin of the sandbox choice. The runtime uses this only for internal telemetry provenance; managed policy is derived independently. + * + * @internal + */ + sandboxConfigSource?: SandboxConfigSource; /** * Whether interactive shell sessions are logged. */ @@ -13934,12 +19693,16 @@ export interface SessionUpdateOptionsParams { * Additional directories to search for skills. */ skillDirectories?: string[]; + /** + * Built-in skill names to include in this session. When specified, only these runtime-bundled skills are available. Skills from other sources with the same name remain available. Set to null to remove the allowlist restriction. + */ + includedBuiltinSkills?: string[] | null; /** * Skill IDs that should be excluded from this session. */ 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; /** @@ -14006,6 +19769,10 @@ export interface SessionUpdateOptionsParams { * Override directory for the session-events log. When unset, the runtime's default events log directory is used. */ eventsLogDirectory?: string; + /** + * 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. * @@ -14184,6 +19951,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 */ @@ -14271,6 +20042,23 @@ export interface SkillsConfigSetDisabledSkillsRequest { */ disabledSkills: string[]; } +/** + * Adds or removes a single skill from the global disabled list, leaving every other entry untouched. + * + * This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema + * via the `definition` "SkillsConfigSetSkillDisabledRequest". + */ +/** @experimental */ +export interface SkillsConfigSetSkillDisabledRequest { + /** + * Name of the skill to add to or remove from the disabled list + */ + name: string; + /** + * True to disable the skill, false to enable it + */ + disabled: boolean; +} /** * Name of the skill to disable for the session. * @@ -14394,6 +20182,39 @@ export interface SkillsLoadDiagnostics { */ errors: string[]; } + +/** @experimental */ +export interface SlashCommandAddTimelineEntryResult { + /** + * Discriminator for an add-timeline-entry result. + */ + kind: "add-timeline-entry"; + entry: SlashCommandTimelineEntry; + /** + * Optional text the host should prefill into the input editor. + */ + prefillInput?: string; + /** + * Whether command execution changed persisted runtime settings. + */ + runtimeSettingsChanged?: boolean; +} + +/** @experimental */ +export interface SlashCommandTimelineEntry { + /** + * Timeline entry presentation type. + */ + type: string; + /** + * Text displayed for the timeline entry. + */ + text: string; + /** + * Optional URL associated with the timeline entry. + */ + url?: string; +} /** * Slash-command invocation result that submits an agent prompt, with display prompt, optional mode, optional user-facing notice, and settings-change flag. * @@ -14524,6 +20345,95 @@ export interface SlashCommandSelectSubcommandOption { */ group?: string; } + +/** @experimental */ +export interface SlashCommandShowDialogResult { + /** + * Discriminator for a show-dialog result. + */ + kind: "show-dialog"; + dialog: SlashCommandModelPickerDialog; + /** + * Whether command execution changed persisted runtime settings. + */ + runtimeSettingsChanged?: boolean; +} + +/** @experimental */ +export interface SlashCommandModelPickerDialog { + /** + * Discriminator for a model-picker dialog. + */ + kind: "model-picker"; + /** + * Model that should be enabled before it can be selected. + */ + modelToEnable?: string; + /** + * Settings scope the picker should modify. + */ + scope?: string; + /** + * Model-selection target represented by the picker. + */ + target?: string; +} + +/** @experimental */ +export interface SlashCommandSetModelResult { + /** + * Discriminator for a set-model result. + */ + kind: "set-model"; + /** + * Model selected by the command. + */ + model: string; + /** + * Settings scope modified by the command. + */ + scope?: string; + /** + * User-facing warning produced while selecting the model. + */ + warning?: string; + /** + * Reasoning effort selected for the model. + */ + reasoningEffort?: string; + /** + * User-settings snapshot to restore if the host cancels the model switch. + */ + revertOnCancel?: {}; + /** + * Repository settings scope modified by the command. + */ + repoScope?: string; + /** + * Whether command execution changed persisted runtime settings. + */ + runtimeSettingsChanged?: boolean; +} + +/** @experimental */ +export interface SlashCommandSetPlanModelResult { + /** + * Discriminator for a set-plan-model result. + */ + kind: "set-plan-model"; + /** + * Dedicated model selected for plan mode. + */ + planModel?: string; + /** + * User-facing confirmation message for the plan-model selection. + */ + message: string; + /** + * Whether command execution changed persisted runtime settings. + */ + runtimeSettingsChanged?: boolean; +} /** * Subagent model, reasoning effort, and context tier settings * @@ -14562,6 +20472,10 @@ export interface TaskAgentInfo { * Tool call ID associated with this agent task */ toolCallId: string; + /** + * Friendly, non-unique name intended for display + */ + displayName?: string; /** * Short description of the task */ @@ -14659,6 +20573,35 @@ export interface TaskProgressLine { */ timestamp: string; } + +/** @experimental */ +export interface TaskCompletionDecision { + outcome: TaskCompletionOutcome; + /** + * Rationale for the completion decision, when one is available. + */ + reason?: string; + /** + * Whether the rationale was derived from completion-reviewer output. + */ + reviewerDerived?: boolean; + /** + * Information-flow metadata captured from the completion reviewer. + */ + reviewerResultMeta?: JsonValue; + /** + * Active autopilot objective evaluated by the completion reviewer. + */ + objectiveId?: number; + /** + * Whether completion was accepted after the reviewer-rejection budget was exhausted. + */ + completionRejectionBudgetExhausted?: boolean; + /** + * Objective eligibility token captured when the decision was evaluated. + */ + completionEligibilityToken?: number; +} /** * Tracked shell task metadata, including ID, command, status, timing, attachment/execution mode, log path, and PID. * @@ -14895,130 +20838,325 @@ export interface TasksSendMessageRequest { fromAgentId?: string; } /** - * Indicates whether the message was delivered, with an error message when delivery failed. + * Indicates whether the message was delivered, with an error message when delivery failed. + * + * This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema + * via the `definition` "TasksSendMessageResult". + */ +/** @experimental */ +export interface TasksSendMessageResult { + /** + * Whether the message was successfully delivered or steered + */ + sent: boolean; + /** + * Error message if delivery failed + */ + error?: string; +} +/** + * Agent type, prompt, name, and optional description and model override for the new task. + * + * This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema + * via the `definition` "TasksStartAgentRequest". + */ +/** @experimental */ +export interface TasksStartAgentRequest { + /** + * Type of agent to start (e.g., 'explore', 'task', 'general-purpose') + */ + agentType: string; + /** + * Task prompt for the agent + */ + prompt: string; + /** + * Friendly, non-unique name used when displaying the agent + */ + name: string; + /** + * Short description of the task + */ + description?: string; + /** + * Optional model override + */ + model?: string; +} +/** + * Identifier assigned to the newly started background agent task. + * + * This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema + * via the `definition` "TasksStartAgentResult". + */ +/** @experimental */ +export interface TasksStartAgentResult { + /** + * Generated agent ID for the background task + */ + agentId: 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). + * + * This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema + * via the `definition` "TasksWaitForPendingResult". + */ +/** @experimental */ +export interface TasksWaitForPendingResult {} +/** + * Feature override key/value pairs to attach to subsequent telemetry events from this session. + * + * This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema + * via the `definition` "TelemetrySetFeatureOverridesRequest". + */ +/** @experimental */ +export interface TelemetrySetFeatureOverridesRequest { + /** + * Override key/value pairs to attach to subsequent telemetry events from this session. Replaces any previously-set overrides. + */ + features: { + [k: string]: string | undefined; + }; +} +/** + * 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") + */ + name: string; + /** + * Optional namespaced name for declarative filtering (e.g., "playwright/navigate" for MCP tools) + */ + namespacedName?: string; + /** + * Description of what the tool does + */ + description: string; + /** + * JSON Schema for the tool's input parameters + */ + parameters?: { + [k: string]: JsonValue | undefined; + }; + /** + * Optional instructions for how to use this tool effectively + */ + instructions?: string; +} +/** + * Built-in tools available for the requested model, with their parameters and instructions. * * This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema - * via the `definition` "TasksSendMessageResult". + * via the `definition` "ToolList". */ /** @experimental */ -export interface TasksSendMessageResult { - /** - * Whether the message was successfully delivered or steered - */ - sent: boolean; +export interface ToolList { /** - * Error message if delivery failed + * List of available built-in tools with metadata */ - error?: string; + tools: Tool[]; } /** - * Agent type, prompt, name, and optional description and model override for the new task. + * Expanded canonical result returned by a session tool. * * This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema - * via the `definition` "TasksStartAgentRequest". + * via the `definition` "ToolResultExpanded". */ /** @experimental */ -export interface TasksStartAgentRequest { +export interface ToolResultExpanded { /** - * Type of agent to start (e.g., 'explore', 'task', 'general-purpose') + * Text result returned to the model. */ - agentType: string; + textResultForLlm: string; + resultType: ToolResultType; /** - * Task prompt for the agent + * Base64-encoded binary results returned to the model. */ - prompt: string; + binaryResultsForLlm?: ExternalToolTextResultForLlmBinaryResultsForLlm[]; /** - * Short name for the agent, used to generate a human-readable ID + * Detailed log content available for session display. */ - name: string; + sessionLog?: string; /** - * Short description of the task + * Error message for an unsuccessful execution. */ - description?: string; + error?: string; /** - * Optional model override + * Tool-specific telemetry payload. */ - model?: string; + toolTelemetry?: JsonValue; + /** + * Whether large-output post-processing should be skipped. + */ + skipLargeOutputProcessing?: boolean; + /** + * Messages to inject after the tool result. + */ + newMessages?: ToolResultNewMessage[]; + /** + * Structured content blocks returned to the model. + */ + contents?: ExternalToolTextResultForLlmContent[]; + /** + * Deferred tool names made available by this result. + */ + toolReferences?: string[]; + /** + * Sources returned by the tool that the model may cite. + */ + citableSources?: JsonValue[]; + /** + * Skill invocation metadata produced by the tool. + */ + skillInvocation?: JsonValue; + /** + * Whether post-tool-use failure hooks have already processed this result. + */ + postToolUseFailureHooksProcessed?: boolean; + /** + * Optional UI resource produced by the tool. + */ + uiResource?: JsonValue; + /** + * Metadata propagated with the tool result, including information-flow labels. + */ + mcpMeta?: { + [k: string]: JsonValue | undefined; + }; + /** + * Structured result content in addition to the model-facing text. + */ + structuredContent?: JsonValue; + taskCompletionDecision?: TaskCompletionDecision; } /** - * Identifier assigned to the newly started background agent task. + * A message injected by a tool result. * * This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema - * via the `definition` "TasksStartAgentResult". + * via the `definition` "ToolResultNewMessage". */ /** @experimental */ -export interface TasksStartAgentResult { +export interface ToolResultNewMessage { /** - * Generated agent ID for the background task + * Message content to inject after the tool result. */ - agentId: string; + content: string; + /** + * Source attributed to the injected message. + */ + source: 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). + * A tool name and arguments to execute through the session's native invocation pipeline. * * This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema - * via the `definition` "TasksWaitForPendingResult". + * via the `definition` "ToolsExecuteRequest". */ /** @experimental */ -export interface TasksWaitForPendingResult {} +export interface ToolsExecuteRequest { + /** + * Name of the currently offered tool to execute. + */ + name: string; + /** + * Arguments supplied to the tool. + */ + arguments: JsonValue; + /** + * Optional identifier used to correlate this invocation with its tool call. + */ + toolCallId?: string; +} /** - * Feature override key/value pairs to attach to subsequent telemetry events from this session. + * Options controlling how Rust-owned built-in tool descriptors are materialized. * * This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema - * via the `definition` "TelemetrySetFeatureOverridesRequest". + * via the `definition` "ToolsGetBuiltinDescriptorsRequest". */ /** @experimental */ -export interface TelemetrySetFeatureOverridesRequest { +export interface ToolsGetBuiltinDescriptorsRequest { /** - * Override key/value pairs to attach to subsequent telemetry events from this session. Replaces any previously-set overrides. + * Whether descriptors should favor fewer user-intervention prompts. */ - features: { - [k: string]: string | undefined; - }; + reduceUserIntervention?: boolean; + /** + * Whether tool descriptors should include authoring metadata. + */ + includeAuthor?: boolean; + /** + * Whether semantic skill lookup is available. + */ + skillEmbeddingEnabled?: boolean; + shellConfig?: ToolsShellDescriptorConfig; + /** + * Whether the configured shell supports PowerShell 7 syntax. + */ + shellSupportsPowerShell7Syntax?: boolean; + /** + * Default shell timeout in milliseconds. + */ + shellTimeoutMs?: number; + /** + * Whether background task completion notifications are enabled. + */ + backgroundTaskNotificationsEnabled?: boolean; } /** - * Built-in tool metadata with identifier, optional namespaced name, description, input-parameter schema, and usage instructions. + * Shell-specific names and description lines used to materialize built-in shell tool descriptors. * * This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema - * via the `definition` "Tool". + * via the `definition` "ToolsShellDescriptorConfig". */ /** @experimental */ -export interface Tool { +export interface ToolsShellDescriptorConfig { /** - * Tool identifier (e.g., "bash", "grep", "str_replace_editor") + * Stable shell type identifier. */ - name: string; + shellType: string; /** - * Optional namespaced name for declarative filtering (e.g., "playwright/navigate" for MCP tools) + * Human-readable shell name. */ - namespacedName?: string; + displayName: string; /** - * Description of what the tool does + * Tool name used to start shell commands. */ - description: string; + shellToolName: string; /** - * JSON Schema for the tool's input parameters + * Tool name used to read shell output. */ - parameters?: { - [k: string]: unknown | undefined; - }; + readShellToolName: string; /** - * Optional instructions for how to use this tool effectively + * Tool name used to stop shell commands. */ - instructions?: string; + stopShellToolName: string; + /** + * Tool name used to list active shells. + */ + listShellsToolName: string; + /** + * Additional model-facing shell description lines. + */ + descriptionLines: string[]; } /** - * Built-in tools available for the requested model, with their parameters and instructions. + * Rust-owned built-in tool descriptors for the session. * * This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema - * via the `definition` "ToolList". + * via the `definition` "ToolsGetBuiltinDescriptorsResult". */ /** @experimental */ -export interface ToolList { +export interface ToolsGetBuiltinDescriptorsResult { /** - * List of available built-in tools with metadata + * Built-in tool descriptors materialized for the session. */ - tools: Tool[]; + tools: BuiltinToolDescriptor[]; } /** * Current lightweight tool metadata snapshot for the session. @@ -15054,6 +21192,41 @@ export interface ToolsListRequest { */ model?: string; } +/** + * Complete externally implemented tool list for the calling connection. An empty list removes every tool previously supplied by that connection. + * + * This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema + * via the `definition` "ToolsSetRequest". + */ +/** @experimental */ +export interface ToolsSetRequest { + /** + * Complete replacement list for the calling connection. + */ + tools: ProtocolExternalToolDefinition[]; +} +/** + * Empty result after replacing the calling connection's externally implemented tools. + * + * This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema + * via the `definition` "ToolsSetResult". + */ +/** @experimental */ +export interface ToolsSetResult {} +/** + * Task-completion tool arguments and final result used to build a label-safe session event payload. + * + * This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema + * via the `definition` "ToolsTaskCompleteEventDataRequest". + */ +/** @experimental */ +export interface ToolsTaskCompleteEventDataRequest { + /** + * Arguments supplied to the completed task_complete tool call. + */ + toolArgs: JsonValue; + finalResult: ToolResultExpanded; +} /** * Empty result after applying subagent settings * @@ -15185,11 +21358,20 @@ export interface UIElicitationArrayEnumFieldItems { */ /** @experimental */ export interface UIElicitationRequest { + mode?: McpElicitationFormMode; /** * Message describing what information is needed from the user */ message: string; requestedSchema: UIElicitationSchema; + /** + * MCP request metadata. + */ + _meta?: { + [k: string]: unknown | undefined; + }; + task?: McpTaskMetadata; + [k: string]: unknown | undefined; } /** * JSON Schema describing the form fields to present to the user @@ -15392,6 +21574,13 @@ export interface UIElicitationSchemaPropertyNumber { export interface UIElicitationResponse { action: UIElicitationResponseAction; content?: UIElicitationResponseContent; + /** + * MCP response metadata. + */ + _meta?: { + [k: string]: unknown | undefined; + }; + [k: string]: unknown | undefined; } /** * The form values submitted by the user (present when action is 'accept') @@ -15433,20 +21622,16 @@ export interface UIEphemeralQueryRequest { * * @internal */ - onChunk?: { - [k: string]: unknown | undefined; - }; + 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?: { - [k: string]: unknown | undefined; - }; + abortSignal?: OpaqueInProcessValue; } /** - * Transient answer generated from current conversation context. + * Completed transient query. Ordered chunks and the terminal outcome are also delivered through `ui.ephemeral_query` session events while it runs. * * This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema * via the `definition` "UIEphemeralQueryResult". @@ -15454,7 +21639,7 @@ export interface UIEphemeralQueryRequest { /** @experimental */ export interface UIEphemeralQueryResult { /** - * Full assistant response text. + * Answer returned by the model */ answer: string; } @@ -15479,6 +21664,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. @@ -15715,6 +21904,12 @@ export interface UsageGetMetricsResult { modelMetrics: { [k: string]: UsageMetricsModelMetric | undefined; }; + /** + * Per-agent usage metrics, keyed by agent instance identifier. The main conversation uses the stable key `main`. + */ + agentMetrics?: { + [k: string]: UsageMetricsAgentMetric | undefined; + }; /** * Currently active model identifier */ @@ -15850,6 +22045,37 @@ export interface UsageMetricsModelMetricTokenDetail { */ tokenCount: number; } +/** + * Usage attributed to one agent instance, including its identity, API duration, AI units, and per-model breakdown. + * + * This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema + * via the `definition` "UsageMetricsAgentMetric". + */ +/** @experimental */ +export interface UsageMetricsAgentMetric { + /** + * Configured agent name, when this is a subagent + */ + agentName?: string; + /** + * Human-readable label for this subagent invocation, copied from the originating `subagent.started` event. For task-tool subagents this is the invocation's task description rather than the agent's configured display name, so group by `agentName` for stable per-agent labels. + */ + agentDisplayName?: string; + /** + * Time spent in model API calls by this agent, in milliseconds + */ + totalApiDurationMs: number; + /** + * Accumulated nano-AI units cost for this agent + */ + totalNanoAiu: number; + /** + * Per-model usage for this agent, keyed by model identifier + */ + modelMetrics: { + [k: string]: UsageMetricsModelMetric | undefined; + }; +} /** * Result of a user-requested shell command. * @@ -15890,15 +22116,11 @@ export interface UserSettingMetadata { /** * The effective value: the user's value if set, otherwise the default. */ - value: { - [k: string]: unknown | undefined; - }; + value: JsonValue; /** * The centrally-known default for this setting (null when no default is registered). */ - default: { - [k: string]: unknown | 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. */ @@ -15930,9 +22152,7 @@ export interface UserSettingsSetRequest { /** * Partial user settings to write, as a free-form object keyed by setting name */ - settings: { - [k: string]: unknown | undefined; - }; + settings: JsonValue; } /** * Outcome of writing user settings. @@ -16002,7 +22222,7 @@ export interface VisibilitySetResult { /** @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; /** @@ -16038,9 +22258,58 @@ 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 { + /** + * Metadata for the persisted summary. + */ + summary?: {}; + /** + * Refreshed metadata for the containing workspace. + */ + 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; } /** * Workspace checkpoint metadata with assigned number, human-readable title, and checkpoint filename. @@ -16080,6 +22349,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. * @@ -16094,6 +22376,19 @@ export interface WorkspacesDiffRequest { */ 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. * @@ -16106,22 +22401,70 @@ export interface WorkspacesGetWorkspaceResult { * Current workspace metadata, or null if not available */ workspace: { + /** + * Stable workspace identifier. + */ id: string; + /** + * Current working directory associated with the workspace. + */ cwd?: string; + /** + * Git repository root associated with the workspace. + */ git_root?: string; + /** + * Repository identifier associated with the workspace. + */ repository?: string; host_type?: WorkspacesWorkspaceDetailsHostType; + /** + * Current Git branch. + */ branch?: string; + /** + * Workspace display name. + */ name?: string; + /** + * Name of the client that created the workspace. + */ client_name?: string; + /** + * Whether the workspace name was explicitly chosen by the user. + */ user_named?: boolean; + /** + * Number of persisted summaries in the workspace. + */ summary_count?: number; + /** + * Timestamp when the workspace was created. + */ created_at?: string; + /** + * Timestamp when the workspace was last updated. + */ updated_at?: string; + /** + * Whether the workspace session can be steered remotely. + */ remote_steerable?: boolean; + /** + * Mission Control task identifier associated with the workspace. + */ mc_task_id?: string; + /** + * Mission Control session identifier associated with the workspace. + */ mc_session_id?: string; + /** + * Most recent Mission Control event identifier observed for the workspace. + */ mc_last_event_id?: string; + /** + * Whether the per-session Chronicle upgrade prompt was dismissed for the workspace. + */ chronicle_sync_dismissed?: boolean; } | null; /** @@ -16155,6 +22498,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. * @@ -16246,6 +22602,82 @@ export interface WorkspacesSaveLargePasteResult { 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 * @@ -16254,7 +22686,83 @@ export interface WorkspacesSaveLargePasteResult { */ /** @experimental */ export interface SessionMcpAppsCallToolResult { - [k: string]: unknown | undefined; + [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). + */ + 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; +} + +/** @experimental */ +export interface 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. + */ + modelId?: string; +} + +/** @experimental */ +export interface SessionCommandsListRequest { + /** + * 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; +} + +/** @experimental */ +export interface SessionHistoryCompactRequest { + /** + * 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; +} + +/** @experimental */ +export interface SessionLimitPredictionPredictRequest { + /** + * Optional model identifier override. If omitted, the session's current model is used. + */ + modelId?: string; + clientType?: SessionLimitPredictionClientType; } /** * Identifies the target session. @@ -16289,12 +22797,19 @@ export function createServerRpc(connection: MessageConnection) { /** * Lists Copilot models available to the authenticated user. * - * @param params Optional GitHub token used to list models for a specific user instead of the global auth context. + * @param params Optional opaque account selection or compatibility GitHub token used to list models. * * @returns List of Copilot models available to the resolved user, including capabilities and billing metadata. */ 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: { @@ -16311,9 +22826,9 @@ export function createServerRpc(connection: MessageConnection) { /** @experimental */ account: { /** - * Gets Copilot quota usage for the authenticated user or supplied GitHub token. + * Gets Copilot quota usage for the current or opaquely selected authenticated user. * - * @param params Optional GitHub token used to look up quota for a specific user instead of the global auth context. + * @param params Optional opaque account selection or compatibility GitHub token used to look up quota. * * @returns Quota usage snapshots for the resolved user, keyed by quota type. */ @@ -16334,9 +22849,9 @@ export function createServerRpc(connection: MessageConnection) { getAllUsers: async (): Promise => connection.sendRequest("account.getAllUsers", {}), /** - * Stores authentication credentials after successful login (e.g., device code flow). + * Validates and stores authentication credentials. When login is omitted, resolves the authenticated user from the token before persistence. * - * @param params Credentials to store after successful authentication + * @param params Credentials to validate and store. Omit login to resolve the authenticated user from the token. * * @returns Result of a successful login; throws on failure */ @@ -16425,6 +22940,58 @@ export function createServerRpc(connection: MessageConnection) { */ discover: async (params: McpDiscoverRequest): Promise => connection.sendRequest("mcp.discover", params), + /** + * Requests a side-effect-free MCP install plan from a catalog candidate handle or a caller-supplied card. This host-implemented server method is available through SDK/TUI hosts; standalone and C-ABI runtimes whose host does not implement server-method dispatch return JSON-RPC MethodNotFound. A runtime with planning available returns a normalised plan and opaque single-use plan handle; a runtime without it returns the typed planning-unavailable result. A completed plan reports resource identity, provenance, eligible transport choices, the user-scope target, required typed values and secret placeholders, the policy result, the configuration changes installing would make, and whether a reload would be needed. Planning never writes configuration, stores a secret, or reloads MCP servers, so abandoning a plan needs no call and leaves nothing behind. + * + * @param params A side-effect-free request for an MCP install plan. Computing a plan never writes configuration, stores a secret, or reloads MCP servers. + * + * @returns Outcome of an mcp.planInstall call: either a normalised plan, or one typed refusal. Nothing is written in either case. + */ + planInstall: async (params: McpPlanInstallRequest): Promise => + connection.sendRequest("mcp.planInstall", 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 */ + catalog: { + /** + * Requests a bounded catalog search. This host-implemented server method is available through SDK/TUI hosts; standalone and C-ABI runtimes whose host does not implement server-method dispatch return JSON-RPC MethodNotFound. A runtime with search available returns inert candidate summaries, each with an opaque single-use handle scoped to this runtime instance; a runtime without it returns the typed search-unavailable result. Public authorities may be searched anonymously, while an authority that requires credentials yields the typed authentication-required result. All returned text, URLs, and package metadata are untrusted external data and can never trigger instructions, tools, or installation. Read-only: nothing is installed, configured, or persisted. + * + * @param params A bounded catalog search. Both the query length and the result count are capped by the schema so a caller cannot request an unbounded scan. + * + * @returns Outcome of a catalog.search call: either bounded inert candidates, or one typed refusal. Never a partial success. + */ + search: async (params: CatalogSearchRequest): Promise => + connection.sendRequest("catalog.search", params), }, /** @experimental */ plugins: { @@ -16482,6 +23049,16 @@ export function createServerRpc(connection: MessageConnection) { disable: async (params: PluginsDisableRequest): Promise => connection.sendRequest("plugins.disable", params), /** @experimental */ + builtin: { + /** + * Replaces this server's trusted built-in plugin directories while no sessions are active. + * + * @param params Trusted built-in plugin directories to use for this runtime process. + */ + set: async (params: PluginsBuiltinSetRequest): Promise => + connection.sendRequest("plugins.builtin.set", params), + }, + /** @experimental */ marketplaces: { /** * Lists all registered marketplaces (defaults + user-added). @@ -16539,6 +23116,13 @@ export function createServerRpc(connection: MessageConnection) { */ setDisabledSkills: async (params: SkillsConfigSetDisabledSkillsRequest): Promise => connection.sendRequest("skills.config.setDisabledSkills", params), + /** + * Atomically adds or removes one skill from the disabled list. + * + * @param params Adds or removes a single skill from the global disabled list, leaving every other entry untouched. + */ + setSkillDisabled: async (params: SkillsConfigSetSkillDisabledRequest): Promise => + connection.sendRequest("skills.config.setSkillDisabled", params), }, /** * Discovers skills across global and project sources. @@ -16639,6 +23223,16 @@ export function createServerRpc(connection: MessageConnection) { }, }, /** @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. @@ -16917,7 +23511,7 @@ export function createInternalServerRpc(connection: MessageConnection) { /** * 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 Parameters for the `server.connect` handshake: an optional connection token and optional connection-level opt-ins (e.g. GitHub telemetry forwarding). + * @param params Connection-level opt-ins for the `server.connect` handshake. Transport authentication is consumed by the native protocol boundary before dispatch. * * @returns Handshake result reporting the server's protocol version and package version on success. * @@ -16927,6 +23521,24 @@ export function createInternalServerRpc(connection: MessageConnection) { 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. * @@ -16945,6 +23557,13 @@ export function createInternalServerRpc(connection: MessageConnection) { */ 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. * @@ -17017,6 +23636,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. * @@ -17113,6 +23752,15 @@ export function createSessionRpc(connection: MessageConnection, sessionId: strin */ 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. * @@ -17122,6 +23770,33 @@ export function createSessionRpc(connection: MessageConnection, sessionId: strin */ 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. * @@ -17205,7 +23880,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 */ @@ -17221,8 +23896,10 @@ export function createSessionRpc(connection: MessageConnection, sessionId: strin * Sets the current agent interaction mode. * * @param params Agent interaction mode to apply to the session. + * + * @returns Outcome of a session mode change, including any model switch it triggered and follow-up the host must perform. */ - set: async (params: ModeSetRequest): Promise => + set: async (params: ModeSetRequest): Promise => connection.sendRequest("session.mode.set", { sessionId, ...params }), }, /** @experimental */ @@ -17296,6 +23973,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. * @@ -17310,31 +24005,79 @@ export function createSessionRpc(connection: MessageConnection, sessionId: strin * * @returns Contents of the requested workspace file as a UTF-8 string. */ - readFile: async (params: WorkspacesReadFileRequest): Promise => - connection.sendRequest("session.workspaces.readFile", { sessionId, ...params }), + readFile: async (params: WorkspacesReadFileRequest): Promise => + connection.sendRequest("session.workspaces.readFile", { sessionId, ...params }), + /** + * Creates or overwrites a file in the session workspace files directory. + * + * @param params Relative path and UTF-8 content for the workspace file to create or overwrite. + */ + createFile: async (params: WorkspacesCreateFileRequest): Promise => + connection.sendRequest("session.workspaces.createFile", { sessionId, ...params }), + /** + * Lists workspace checkpoints in chronological order. + * + * @returns Workspace checkpoints in chronological order; empty when the workspace is not enabled. + */ + listCheckpoints: async (): Promise => + connection.sendRequest("session.workspaces.listCheckpoints", { sessionId }), + /** + * Reads the content of a workspace checkpoint by number. + * + * @param params Checkpoint number to read. + * + * @returns Checkpoint content as a UTF-8 string, or null when the checkpoint or workspace is missing. + */ + 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 }), /** - * Creates or overwrites a file in the session workspace files directory. + * Reads the autopilot objective state file from the local session workspace. * - * @param params Relative path and UTF-8 content for the workspace file to create or overwrite. + * @returns Autopilot objective file content, or null when missing. */ - createFile: async (params: WorkspacesCreateFileRequest): Promise => - connection.sendRequest("session.workspaces.createFile", { sessionId, ...params }), + readAutopilotObjective: async (): Promise => + connection.sendRequest("session.workspaces.readAutopilotObjective", { sessionId }), /** - * Lists workspace checkpoints in chronological order. + * Writes the autopilot objective state file in the local session workspace. * - * @returns Workspace checkpoints in chronological order; empty when the workspace is not enabled. + * @param params Autopilot objective file content to persist. + * + * @returns Result of writing the autopilot objective file. */ - listCheckpoints: async (): Promise => - connection.sendRequest("session.workspaces.listCheckpoints", { sessionId }), + writeAutopilotObjective: async (params: WorkspacesWriteAutopilotObjectiveRequest): Promise => + connection.sendRequest("session.workspaces.writeAutopilotObjective", { sessionId, ...params }), /** - * Reads the content of a workspace checkpoint by number. + * Deletes the autopilot objective state file from the local session workspace. * - * @param params Checkpoint number to read. + * @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 Checkpoint content as a UTF-8 string, or null when the checkpoint or workspace is missing. + * @returns Whether the autopilot objective file exists. */ - readCheckpoint: async (params: WorkspacesReadCheckpointRequest): Promise => - connection.sendRequest("session.workspaces.readCheckpoint", { sessionId, ...params }), + autopilotObjectiveExists: async (): Promise => + connection.sendRequest("session.workspaces.autopilotObjectiveExists", { sessionId }), /** * Saves pasted content as a UTF-8 file in the session workspace. * @@ -17345,7 +24088,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. * @@ -17398,12 +24141,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. * @@ -17605,6 +24357,13 @@ export function createSessionRpc(connection: MessageConnection, sessionId: strin */ reload: async (): Promise => connection.sendRequest("session.mcp.reload", { sessionId }), + /** + * Releases any turns waiting on an in-flight MCP load without cancelling the load, letting the agent proceed while MCP servers finish connecting in the background. No-op when no MCP load is in flight or waiting turns were already released. + * + * @returns Result of moving in-flight MCP loading to the background. + */ + moveLoadingToBackground: async (): Promise => + connection.sendRequest("session.mcp.moveLoadingToBackground", { sessionId }), /** * Runs an MCP sampling inference on behalf of an MCP server. * @@ -17640,9 +24399,9 @@ 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 from a caller-supplied config. 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. + * 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 configuration for an individual MCP server start. + * @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 }), @@ -17680,6 +24439,13 @@ export function createSessionRpc(connection: MessageConnection, sessionId: strin */ 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. * @@ -17689,6 +24455,24 @@ export function createSessionRpc(connection: MessageConnection, sessionId: strin */ login: async (params: McpOauthLoginRequest): Promise => connection.sendRequest("session.mcp.oauth.login", { sessionId, ...params }), + /** + * Passively probes a configured remote MCP server to classify whether OAuth is required or a cached/override token is accepted. Does not start OAuth, emit pending OAuth requests, or mutate MCP connection state. + * + * @param params Remote MCP server name for a passive OAuth status probe. + * + * @returns Passive MCP OAuth probe result. `authenticated` means the server accepted the probe request while an OAuth-origin access token was attached; it does not prove the server required or independently validated that token. The probe does not make a second unauthenticated request. Failed is an expected probe-domain outcome; JSON-RPC errors are reserved for API-call failures. + */ + probe: async (params: McpOauthProbeRequest): Promise => + connection.sendRequest("session.mcp.oauth.probe", { 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: { @@ -17800,7 +24584,7 @@ export function createSessionRpc(connection: MessageConnection, sessionId: strin * * @param params Optional flags controlling which side effects the reload performs. */ - reload: async (params?: PluginsReloadRequest): Promise => + reload: async (params?: SessionPluginsReloadRequest): Promise => connection.sendRequest("session.plugins.reload", { sessionId, ...params }), }, /** @experimental */ @@ -17812,7 +24596,7 @@ export function createSessionRpc(connection: MessageConnection, sessionId: strin * * @returns A snapshot of the provider endpoint the session is currently configured to talk to. */ - getEndpoint: async (params?: ProviderGetEndpointRequest): Promise => + 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. @@ -17884,6 +24668,33 @@ export function createSessionRpc(connection: MessageConnection, sessionId: strin }, /** @experimental */ tools: { + /** + * Executes one tool from the session's currently offered tool set through the native invocation pipeline. + * + * @param params A tool name and arguments to execute through the session's native invocation pipeline. + * + * @returns Canonical result returned by a session tool. + */ + execute: async (params: ToolsExecuteRequest): Promise => + connection.sendRequest("session.tools.execute", { sessionId, ...params }), + /** + * Returns the Rust-owned built-in tool descriptors used to construct the session's offered tool set. + * + * @param params Options controlling how Rust-owned built-in tool descriptors are materialized. + * + * @returns Rust-owned built-in tool descriptors for the session. + */ + getBuiltinDescriptors: async (params: ToolsGetBuiltinDescriptorsRequest): Promise => + connection.sendRequest("session.tools.getBuiltinDescriptors", { sessionId, ...params }), + /** + * Projects a completed task_complete tool call into its label-safe session event payload. + * + * @param params Task-completion tool arguments and final result used to build a label-safe session event payload. + * + * @returns Task completion notification with summary from the agent + */ + taskCompleteEventData: async (params: ToolsTaskCompleteEventDataRequest): Promise => + connection.sendRequest("session.tools.taskCompleteEventData", { sessionId, ...params }), /** * Provides the result for a pending external tool call. * @@ -17907,6 +24718,15 @@ export function createSessionRpc(connection: MessageConnection, sessionId: strin */ getCurrentMetadata: async (): Promise => connection.sendRequest("session.tools.getCurrentMetadata", { sessionId }), + /** + * Atomically replaces the complete externally implemented tool list supplied by the calling connection. Built-in, MCP/plugin, extension-discovered, subagent, and tools supplied by other connections remain unchanged. + * + * @param params Complete externally implemented tool list for the calling connection. An empty list removes every tool previously supplied by that connection. + * + * @returns Empty result after replacing the calling connection's externally implemented tools. + */ + set: async (params: ToolsSetRequest): Promise => + connection.sendRequest("session.tools.set", { sessionId, ...params }), /** * Updates the current session's live subagent settings after user settings change. The persisted user settings remain the source of truth for future sessions. * @@ -17926,7 +24746,7 @@ 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. @@ -17998,7 +24818,7 @@ export function createSessionRpc(connection: MessageConnection, sessionId: strin * * @param params Transient question to answer without adding it to conversation history. * - * @returns Transient answer generated from current conversation context. + * @returns Completed transient query. Ordered chunks and the terminal outcome are also delivered through `ui.ephemeral_query` session events while it runs. */ ephemeralQuery: async (params: UIEphemeralQueryRequest): Promise => connection.sendRequest("session.ui.ephemeralQuery", { sessionId, ...params }), @@ -18119,21 +24939,21 @@ export function createSessionRpc(connection: MessageConnection, sessionId: strin setApproveAll: async (params: PermissionsSetApproveAllRequest): Promise => connection.sendRequest("session.permissions.setApproveAll", { sessionId, ...params }), /** - * 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. + * Sets the permission mode for the session. `manual` follows the normal approval flow, `assisted` attaches LLM safety recommendations, and `allow-all` automatically approves permission requests. The result returns the authoritative post-mutation mode so callers can update local state without racing the `session.permissions_changed` notification. * - * @param params Allow-all mode to apply for the session. + * @param params Permission mode to apply for the session. * - * @returns Indicates whether the operation succeeded and reports the post-mutation state. + * @returns Indicates whether the requested permission mode was applied and reports the authoritative post-mutation mode. */ - setAllowAll: async (params: PermissionsSetAllowAllRequest): Promise => - connection.sendRequest("session.permissions.setAllowAll", { sessionId, ...params }), + setMode: async (params: PermissionsSetModeRequest): Promise => + connection.sendRequest("session.permissions.setMode", { sessionId, ...params }), /** - * Returns the current allow-all permission mode for the session. + * Returns the current permission mode for the session. * - * @returns Current allow-all permission mode. + * @returns Current permission mode. */ - getAllowAll: async (): Promise => - connection.sendRequest("session.permissions.getAllowAll", { sessionId }), + getMode: async (): Promise => + connection.sendRequest("session.permissions.getMode", { sessionId }), /** * Adds or removes session-scoped or location-scoped permission rules. * @@ -18155,10 +24975,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. * @@ -18178,7 +25000,7 @@ export function createSessionRpc(connection: MessageConnection, sessionId: strin list: async (): Promise => connection.sendRequest("session.permissions.paths.list", { sessionId }), /** - * Adds a directory to the session's allow-list. + * Adds a directory to the session's allow-list and activates conventional skill and agent definitions under it. * * @param params Directory path to add to the session's allowed directories. * @@ -18366,9 +25188,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. * @@ -18377,7 +25211,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. * @@ -18413,7 +25247,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. @@ -18424,6 +25258,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. * @@ -18445,6 +25304,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: { @@ -18455,6 +25323,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). * @@ -18471,7 +25400,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. * @@ -18516,6 +25445,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. @@ -18589,6 +25530,131 @@ export function createSessionRpc(connection: MessageConnection, sessionId: strin */ 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 */ + gitHubAuth: { + /** + * Gets the current authentication information for internal session hosts. + * + * @returns Current authentication information, or null when no authentication is active. + */ + getCurrentAuthInfo: async (): Promise => + connection.sendRequest("session.gitHubAuth.getCurrentAuthInfo", { sessionId }), + /** + * Gets all authentication accounts available to the internal session host. + * + * @returns Authentication accounts available to the internal session host. + */ + getAllAuthAvailable: async (): Promise => + connection.sendRequest("session.gitHubAuth.getAllAuthAvailable", { sessionId }), + /** + * Refreshes Copilot account metadata for the current authentication. + * + * @returns Current authentication information, or null when no authentication is active. + */ + refreshCopilotUser: async (): Promise => + connection.sendRequest("session.gitHubAuth.refreshCopilotUser", { sessionId }), + /** + * Logs in a GitHub user through the internal session host. + * + * @param params Internal GitHub login parameters. + * + * @returns Authentication credentials accepted only at native protocol ingress. Runtime outputs use credential-free `AuthIdentity` metadata. + */ + login: async (params: SessionAuthLoginRequest): Promise => + connection.sendRequest("session.gitHubAuth.login", { sessionId, ...params }), + /** + * Switches the session to another available authentication. + * + * @param params Parameters for switching the session's active authentication. + */ + switchToAuth: async (params: SessionAuthSwitchRequest): Promise => + connection.sendRequest("session.gitHubAuth.switchToAuth", { sessionId, ...params }), + /** + * Logs out the session's current GitHub authentication. + * + * @returns Whether the current authentication was logged out. + */ + logout: async (): Promise => + connection.sendRequest("session.gitHubAuth.logout", { sessionId }), + /** + * Logs out a specific GitHub authentication. + * + * @param params Parameters identifying a GitHub authentication to log out. + * + * @returns Whether the requested authentication was logged out. + */ + logoutUser: async (params: SessionAuthLogoutUserRequest): Promise => + connection.sendRequest("session.gitHubAuth.logoutUser", { sessionId, ...params }), + /** + * Gets validation errors from the most recent authentication attempt. + * + * @returns Validation errors from the most recent authentication attempt. + */ + lastAuthErrors: async (): Promise => + connection.sendRequest("session.gitHubAuth.lastAuthErrors", { sessionId }), + }, + /** @experimental */ + canvas: { + /** @experimental */ + provider: { + /** + * Registers an internal canvas provider connection and its contributions. + * + * @param params Internal canvas provider registration parameters. + */ + register: async (params: CanvasProviderRegisterRequest): Promise => + connection.sendRequest("session.canvas.provider.register", { sessionId, ...params }), + /** + * Unregisters an internal canvas provider connection. + * + * @param params Internal canvas provider unregistration parameters. + */ + unregister: async (params: CanvasProviderUnregisterRequest): Promise => + connection.sendRequest("session.canvas.provider.unregister", { sessionId, ...params }), + }, + }, + /** @experimental */ + factory: { + /** + * Internal tool-originated factory invocation. + * + * @param params Internal parameters for invoking a registered factory from a tool. + * + * @returns Complete current or terminal factory run envelope. + */ + runFromTool: async (params: FactoryToolRunRequest): Promise => + connection.sendRequest("session.factory.runFromTool", { sessionId, ...params }), + /** + * Internal tool-originated factory resume. + * + * @param params Internal parameters for resuming a factory run from a tool. + * + * @returns Resolved persisted factory identity and resumed run envelope. + */ + resumeFromTool: async (params: FactoryToolResumeRequest): Promise => + connection.sendRequest("session.factory.resumeFromTool", { sessionId, ...params }), + }, + /** @experimental */ + model: { + /** + * Resolves and applies organization-managed and repository model overlays. + * + * @param params Managed, repository, and CLI model overrides to overlay onto the session at startup. + * + * @returns The model identifier active on the session after the switch. + */ + applyStartupOverlay: async (params: ModelApplyStartupOverlayRequest): Promise => + connection.sendRequest("session.model.applyStartupOverlay", { sessionId, ...params }), + }, /** @experimental */ mcp: { /** @@ -18603,7 +25669,7 @@ export function createInternalSessionRpc(connection: MessageConnection, sessionI /** * Configures the built-in GitHub MCP server for the session's current auth context. * - * @param params Opaque auth info used to configure GitHub MCP. + * @param params Credential-free authentication identity used to configure GitHub MCP. * * @returns Result of configuring GitHub MCP. */ @@ -18625,6 +25691,18 @@ export function createInternalSessionRpc(connection: MessageConnection, sessionI connection.sendRequest("session.mcp.unregisterExternalClient", { sessionId, ...params }), }, /** @experimental */ + commands: { + /** + * Finalizes persistence associated with a client-applied slash-command effect. + * + * @param params The pending slash-command invocation effect to finalize, plus whether the host applied or cancelled it. + * + * @returns Whether finalizing the invocation effect succeeded, and the failure reason when it did not. + */ + finalizeInvocationEffect: async (params: CommandsFinalizeInvocationEffectRequest): Promise => + connection.sendRequest("session.commands.finalizeInvocationEffect", { 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. @@ -18643,6 +25721,129 @@ export function createInternalSessionRpc(connection: MessageConnection, sessionI 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 }), + }, }; } @@ -18764,13 +25965,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. * @@ -18896,6 +26105,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}`); @@ -18918,17 +26132,17 @@ export function registerClientSessionApiHandlers( }); } -/** Handler for `hooks` client global API methods. */ +/** Handler for `extensionLaunchProvider` client global API methods. */ /** @experimental */ -export interface HooksHandler { +export interface ExtensionLaunchProviderHandler { /** - * 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. + * 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 Runtime-owned wire payload for a server-to-client hook callback invocation. + * @param params A discovered extension entrypoint that the registered integrator may classify and resolve to an opaque launch profile. * - * @returns Optional output returned by an SDK callback hook. + * @returns The launch profile for a supported entrypoint. Omit launch when the provider does not support the entrypoint. */ - invoke(params: HookInvokeRequest): Promise; + resolve(params: ExtensionLaunchProviderResolveRequest): Promise; } /** Handler for `llmInference` client global API methods. */ @@ -18963,11 +26177,25 @@ export interface GitHubTelemetryHandler { event(params: GitHubTelemetryNotification): Promise; } +/** Handler for `gitHubToken` client global API methods. */ +/** @experimental */ +export interface GitHubTokenHandler { + /** + * Asks the SDK client to mint a GitHub access token for a session whose configuration supplied a GitHub token provider. The runtime acquires the initial token during bootstrap and refreshes it during expiry preflight when one hour or less remains. + * + * @param params Asks the SDK client to acquire a GitHub access token from an opaque callback registration. + * + * @returns SDK host response to a GitHub credential request. + */ + getToken(params: GitHubTokenAcquireRequest): Promise; +} + /** All client global API handler groups. */ export interface ClientGlobalApiHandlers { - hooks?: HooksHandler; + extensionLaunchProvider?: ExtensionLaunchProviderHandler; llmInference?: LlmInferenceHandler; gitHubTelemetry?: GitHubTelemetryHandler; + gitHubToken?: GitHubTokenHandler; } /** @@ -18981,10 +26209,10 @@ export function registerClientGlobalApiHandlers( connection: MessageConnection, handlers: ClientGlobalApiHandlers, ): void { - connection.onRequest("hooks.invoke", async (params: HookInvokeRequest) => { - const handler = handlers.hooks; - if (!handler) throw new Error("No hooks client-global handler registered"); - return handler.invoke(params); + 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; @@ -19001,4 +26229,9 @@ export function registerClientGlobalApiHandlers( if (!handler) return; await handler.event(params); }); + connection.onRequest("gitHubToken.getToken", async (params: GitHubTokenAcquireRequest) => { + const handler = handlers.gitHubToken; + if (!handler) throw new Error("No gitHubToken client-global handler registered"); + return handler.getToken(params); + }); } diff --git a/nodejs/src/generated/session-events.ts b/nodejs/src/generated/session-events.ts index b9c9612b8f..9075379982 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. */ @@ -33,14 +36,21 @@ export type SessionEvent = | UsageCheckpointEvent | ContextChangedEvent | UsageInfoEvent + | ContextClearedEvent | CompactionStartEvent | CompactionCompleteEvent | TaskCompleteEvent + | FusionRouteStartedEvent + | FusionRouteFailedEvent + | FusionResolvedEvent + | FusionCompletedEvent | UserMessageEvent | PendingMessagesModifiedEvent | AssistantTurnStartEvent - | AssistantTurnRetryEvent | AssistantIntentEvent + | AssistantFusionPhaseStartedEvent + | AssistantFusionPhaseCompletedEvent + | AssistantFusionPhaseFailedEvent | AssistantServerToolProgressEvent | AssistantReasoningEvent | AssistantReasoningDeltaEvent @@ -53,7 +63,7 @@ export type SessionEvent = | AssistantIdleEvent | AssistantUsageEvent | ModelCallFailureEvent - | ModelCallStartEvent + | ModelCallFinishedEvent | AbortEvent | ToolUserRequestedEvent | ToolExecutionStartEvent @@ -63,6 +73,7 @@ export type SessionEvent = | ToolSearchActivatedEvent | SkillInvokedEvent | SubagentStartedEvent + | SubagentConfiguredEvent | SubagentCompletedEvent | SubagentFailedEvent | SubagentSelectedEvent @@ -86,6 +97,7 @@ export type SessionEvent = | McpHeadersRefreshRequiredEvent | McpHeadersRefreshCompletedEvent | CustomNotificationEvent + | UIEphemeralQueryEvent | ExternalToolRequestedEvent | ExternalToolCompletedEvent | CommandQueuedEvent @@ -104,6 +116,9 @@ export type SessionEvent = | ExitPlanModeCompletedEvent | ToolsUpdatedEvent | BackgroundTasksChangedEvent + | FactoryRunUpdatedEvent + | FactoryRunStartedEvent + | FactoryRunSettledEvent | SkillsLoadedEvent | CustomAgentsUpdatedEvent | McpServersLoadedEvent @@ -156,6 +171,24 @@ export type Verbosity = | "medium" /** A more detailed response was requested. */ | "high"; +/** + * The session mode the agent is operating in + */ +export type SessionMode = + /** 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"; +/** + * 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 */ @@ -179,26 +212,42 @@ export type AutopilotObjectiveChangedStatus = /** Objective was completed by the agent. */ | "completed"; /** - * The session mode the agent is operating in - */ -export type SessionMode = - /** 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"; + * Origin of an effective session model change. + */ +export type ModelChangeSource = + /** The user selected a model directly with `/model `. */ + | "model_command" + /** The user selected the model with `/settings`. */ + | "settings_command" + /** The user selected the model with the `/config` alias. */ + | "config_command" + /** The user selected the model in the model picker, including the picker opened by bare `/model`. */ + | "model_picker" + /** Organization-managed settings selected the model. */ + | "managed_settings" + /** Repository settings selected the model. */ + | "repo_settings" + /** Startup model resolution selected the model. */ + | "startup" + /** Selecting an agent selected its configured model. */ + | "agent" + /** Entering, leaving, or reconfiguring plan mode selected the model. */ + | "plan_mode" + /** The runtime selected the model automatically, such as rate-limit recovery or refusal fallback. */ + | "automatic" + /** An SDK or RPC caller selected the model. */ + | "sdk"; /** - * Allow-all mode for the session. + * Permission mode for the session. */ /** @experimental */ -export type PermissionAllowAllMode = +export type PermissionMode = /** Permission requests follow the normal approval flow. */ - | "off" + | "manual" + /** Permission requests include an LLM safety recommendation; clients may automatically approve requests judged acceptable. */ + | "assisted" /** 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"; + | "allow-all"; /** * The type of operation performed on the plan file */ @@ -233,6 +282,59 @@ 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"; +/** + * Kind of turn for which HydraFusion routing is running. + */ +/** @experimental */ +export type FusionTurnKind = + /** A user-message turn. */ + | "user" + /** A conversation-compaction turn. */ + | "compaction"; +/** + * Server-recommended routing behavior for a later HydraFusion turn. + */ +/** @experimental */ +export type FusionFollowUpAction = + /** Reuse the durable primary model without routing. */ + | "reuse_primary" + /** Request a new routing decision. */ + | "reroute"; +/** + * Validated HydraFusion execution pattern. + */ +/** @experimental */ +export type FusionPattern = + /** Run one primary solver phase. */ + | "single" + /** Run a primary phase, a judge, and an optional repair. */ + | "cascade" + /** Run a primary draft, a read-only critique, and a revision. */ + | "critique"; /** * The agent mode that was active when this message was sent */ @@ -292,6 +394,57 @@ export type UserMessageDelivery = | "steering" /** Enqueued while the agent was busy; processed as its own run afterward. */ | "queued"; +/** + * Conversation scope in which a HydraFusion phase executes. + */ +/** @experimental */ +export type FusionConversationScope = + /** Canonical root conversation history. */ + | "root" + /** Isolated read-only review history that does not enter the root conversation. */ + | "review"; +/** + * HydraFusion phase kind. + */ +/** @experimental */ +export type FusionPhaseKind = + /** Primary solver phase. */ + | "primary" + /** Read-only cascade judge phase. */ + | "judge" + /** Cascade repair phase. */ + | "repair" + /** Initial critique-pattern draft phase. */ + | "draft" + /** Read-only critique phase. */ + | "critic" + /** Critique-pattern revision phase. */ + | "revision" + /** Follow-up phase continuing from the resolved model. */ + | "follow_up"; +/** + * How a durable phase checkpoint contributes its exact message to canonical root history. + */ +/** @experimental */ +/** @internal */ +export type FusionProjectionMode = + /** Append the exact root message immediately. */ + | "append" + /** Hold a terminal message outside canonical history until the final commit selects it. */ + | "staged" + /** Do not project the checkpoint into root history. */ + | "none"; +/** + * Durable outcome status of a HydraFusion phase. + */ +/** @experimental */ +export type FusionPhaseStatus = + /** The phase completed successfully. */ + | "succeeded" + /** The phase failed. */ + | "failed" + /** The phase was cancelled. */ + | "cancelled"; /** * Tool call type: "function" for standard tool calls, "custom" for grammar-based tool calls. Defaults to "function" when absent. */ @@ -328,6 +481,14 @@ export type AssistantUsageApiEndpoint = | "/responses" /** WebSocket Responses API endpoint. */ | "ws:/responses"; +/** + * Transport used for a successful model call + */ +export type AssistantUsageTransport = + /** HTTP transport, including SSE streams. */ + | "http" + /** WebSocket transport. */ + | "websocket"; /** * 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. */ @@ -362,6 +523,18 @@ export type ModelCallFailureTransport = | "http" /** WebSocket transport. */ | "websocket"; +/** + * Final outcome of one logical model dispatch after response acceptance processing + */ +export type ModelCallFinishedOutcome = + /** The provider response was accepted for continued agent processing. */ + | "success" + /** The dispatch ended with a provider or transport error. */ + | "error" + /** The dispatch was cancelled before an accepted response was produced. */ + | "cancelled" + /** The provider response was rejected during post-response acceptance processing. */ + | "rejected"; /** * Finite reason code describing why the current turn was aborted */ @@ -371,7 +544,9 @@ 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. */ @@ -475,7 +650,9 @@ export type SystemNotification = | SystemNotificationNewInboxMessage | SystemNotificationShellCompleted | SystemNotificationShellDetachedCompleted - | SystemNotificationInstructionDiscovered; + | SystemNotificationInstructionDiscovered + | SystemNotificationFactoryCompleted + | SystemNotificationUnclassified; /** * Whether the agent completed successfully or failed */ @@ -484,6 +661,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 */ @@ -497,7 +686,16 @@ export type PermissionRequest = | PermissionRequestCustomTool | PermissionRequestHook | PermissionRequestExtensionManagement - | PermissionRequestExtensionPermissionAccess; + | PermissionRequestFactory + | PermissionRequestExtensionPermissionAccess + | PermissionRequestExtensionEnvAccess; +/** + * Advisory recommendation the runtime attaches to a permission request whose origin it can vouch for by construction. Unlike the auto-approval judge this does not depend on auto mode and does not evaluate what the tool call does; its absence simply means the runtime has no opinion and the request follows the host's normal approval flow. + */ +/** @experimental */ +export type PermissionRecommendation = + /** The runtime vouches for the request's origin and recommends approving it without prompting. The host still owns the decision and may deny it; deny rules, managed policy, and the auto-approval safety judge all outrank this recommendation. */ + "approve"; /** * Whether this is a store or vote memory operation */ @@ -506,6 +704,34 @@ export type PermissionRequestMemoryAction = | "store" /** Vote on an existing memory. */ | "vote"; +/** + * Why the assisted-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 AssistedApprovalJudgeFailureReason = + /** 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 assisted-approval safety judge for a permission request. Present only in assisted mode; its absence means the judge did not evaluate the request. + */ +/** @experimental */ +export type AssistedApprovalRecommendation = + /** The judge evaluated the request and recommends automatically approving it. */ + | "approve" + /** The judge evaluated the request and does not recommend automatically approving it; explicit approval is required. Whether that means prompting, denying, or something else is the consumer's decision. */ + | "requireApproval" + /** Assisted mode is enabled, but this request category is never automatically 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"; /** * Vote direction (vote only) */ @@ -514,6 +740,22 @@ export type PermissionRequestMemoryDirection = | "upvote" /** Vote that the memory is incorrect or outdated. */ | "downvote"; +/** + * Scope of a stored memory. + */ +export type PermissionRequestMemoryScope = + /** Store the memory for the current repository. */ + | "repository" + /** Store the memory for the current user. */ + | "user"; +/** + * 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 */ @@ -528,20 +770,9 @@ export type PermissionPromptRequest = | PermissionPromptRequestPath | PermissionPromptRequestHook | PermissionPromptRequestExtensionManagement - | PermissionPromptRequestExtensionPermissionAccess; -/** - * 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"; + | PermissionPromptRequestFactory + | PermissionPromptRequestExtensionPermissionAccess + | PermissionPromptRequestExtensionEnvAccess; /** * Underlying permission kind that needs path approval */ @@ -576,7 +807,9 @@ export type UserToolSessionApproval = | UserToolSessionApprovalMemory | UserToolSessionApprovalCustomTool | UserToolSessionApprovalExtensionManagement - | UserToolSessionApprovalExtensionPermissionAccess; + | UserToolSessionApprovalFactory + | UserToolSessionApprovalExtensionPermissionAccess + | UserToolSessionApprovalExtensionEnvAccess; /** * Elicitation mode; "form" for structured input, "url" for browser-based. Defaults to "form" when absent. */ @@ -595,6 +828,10 @@ export type ElicitationCompletedAction = | "decline" /** The user dismissed the request. */ | "cancel"; +/** + * 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 */ @@ -635,6 +872,25 @@ export type McpHeadersRefreshCompletedOutcome = | "none" /** No response arrived within the bounded window. */ | "timeout"; +/** + * Source-defined JSON payload for the custom notification + */ +export type CustomNotificationPayload = JsonValue; +/** + * Lifecycle phase for a Rust-owned ephemeral query stream. + */ +/** @experimental */ +export type UIEphemeralQueryPhase = + /** The ephemeral query stream has begun. */ + | "started" + /** A partial result chunk was produced by the stream. */ + | "chunk" + /** The ephemeral query stream finished successfully. */ + | "completed" + /** The ephemeral query stream ended with an error. */ + | "failed" + /** The ephemeral query stream was cancelled before completing. */ + | "aborted"; /** * The user's auto-mode-switch choice */ @@ -668,14 +924,18 @@ export type AutoModeResolvedReasoningBucket = /** The request looks high-reasoning; a stronger model is appropriate. */ | "high"; /** - * Which channel supplied the effective enterprise managed settings (highest-authority present layer wins wholesale) + * Summary of which managed-settings channels contributed to the effective session policy. Use the per-channel booleans for exact provenance. */ export type ManagedSettingsResolvedSource = - /** Account/org policy self-fetched from the GitHub managed-settings endpoint (higher authority). */ + /** Only the server/account channel contributed. */ | "server" - /** Device-level MDM policy discovered from plist/registry/file (lower authority). */ + /** Only the device MDM/plist/registry/file channel contributed. */ | "device" - /** No managed policy is in force (no layer contributed). */ + /** 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) @@ -687,16 +947,18 @@ export type ManagedSettingsEnforcedAction = * 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. */ + /** Full allow-all permissions β€” automatically approving tools, paths, and URLs. */ | "allow_all" - /** Auto-approval of all tool permission requests. */ + /** Automatic 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" + /** Assisted mode β€” keeps normal prompt paths and adds an LLM recommendation, distinct from allow-all. */ + | "assisted_approval" /** Unrestricted filesystem access outside the session's allowed directories. */ | "unrestricted_paths" /** Unrestricted URL fetch access. */ - | "unrestricted_urls"; + | "unrestricted_urls" + /** A server-wide MCP "Always Allow" (or `--allow-tool `) blanket that would auto-approve every tool from an MCP server. Capped to per-tool approval; each tool still prompts. */ + | "server_wide_mcp_approval"; /** * Exit plan mode action */ @@ -709,6 +971,18 @@ export type ExitPlanModeAction = | "autopilot" /** Exit plan mode and continue with parallel autonomous workers. */ | "autopilot_fleet"; +/** + * Terminal status a factory run committed. A settled run is never `pending` or `running`, so those two members of the run-status domain are deliberately absent. + */ +export type FactoryRunSettledStatus = + /** The factory body resolved and its result was committed. */ + | "completed" + /** The run was stopped by a limit, an approval refusal or another policy decision. */ + | "halted" + /** The run was cancelled by its caller or by session disposal. */ + | "cancelled" + /** The run failed, with `failureType` carrying the class when it has one. */ + | "error"; /** * Source location type (e.g., project, personal-copilot, plugin, builtin) */ @@ -740,7 +1014,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. */ @@ -753,6 +1027,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"; /** @@ -843,6 +1119,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") */ @@ -900,6 +1177,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) */ @@ -909,6 +1190,27 @@ 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. */ @@ -962,7 +1264,7 @@ export interface ResumeData { */ 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; /** @@ -995,7 +1297,7 @@ export interface ResumeData { */ sessionLimits?: SessionLimitsConfig | null; /** - * 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. + * 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; @@ -1148,6 +1450,7 @@ export interface IdleData { * True when the preceding agentic loop was cancelled via abort signal */ aborted?: boolean; + mode?: SessionMode; } /** * Session event "session.title_changed". Session title change payload containing the new display title @@ -1242,6 +1545,7 @@ export interface ScheduleCreatedData { * Interval between ticks in milliseconds (relative-interval schedules) */ intervalMs?: number; + origin?: ScheduleOrigin; /** * Prompt text that gets enqueued on every tick */ @@ -1515,7 +1819,7 @@ 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; /** @@ -1541,6 +1845,7 @@ export interface ModelChangeData { */ reasoningEffort?: string | null; reasoningSummary?: ReasoningSummary; + source?: ModelChangeSource; verbosity?: Verbosity; } /** @@ -1620,8 +1925,9 @@ export interface SessionLimitsChangedData { sessionLimits: SessionLimitsConfig | null; } /** - * Session event "session.permissions_changed". Permissions change details carrying the aggregate allow-all transition. + * Session event "session.permissions_changed". Permission-mode transition details. */ +/** @experimental */ export interface PermissionsChangedEvent { /** * Sub-agent instance identifier. Absent for events from the root/main agent and session-level events. @@ -1650,29 +1956,28 @@ export interface PermissionsChangedEvent { type: "session.permissions_changed"; } /** - * Permissions change details carrying the aggregate allow-all transition. + * Permission-mode transition details. */ +/** @experimental */ export interface PermissionsChangedData { /** - * Allow-all mode after the change + * Explicit LLM judge model override used by assisted mode; omitted when the provider default applies * * @experimental */ - allowAllPermissionMode?: PermissionAllowAllMode; - /** - * Aggregate allow-all flag after the change - */ - allowAllPermissions: boolean; + assistedApprovalModel?: string; /** - * Allow-all mode before the change + * Permission mode after the change * * @experimental */ - previousAllowAllPermissionMode?: PermissionAllowAllMode; + mode: PermissionMode; /** - * Aggregate allow-all flag before the change + * Permission mode before the change + * + * @experimental */ - previousAllowAllPermissions: boolean; + previousMode: PermissionMode; } /** * Session event "session.plan_changed". Plan file operation details indicating what changed @@ -2002,6 +2307,12 @@ export interface ShutdownEvent { * Session termination metrics including usage statistics, code changes, and shutdown reason */ export interface ShutdownData { + /** + * Per-agent usage breakdown, keyed by agent instance identifier. The main conversation uses the stable key `main`. + */ + agentMetrics?: { + [k: string]: ShutdownAgentMetric | undefined; + }; codeChanges: ShutdownCodeChanges; /** * Non-system message token count at shutdown @@ -2066,21 +2377,31 @@ export interface ShutdownData { totalPremiumRequests?: number; } /** - * Aggregate code change metrics for the session + * Usage attributed to one agent instance at session shutdown. */ -export interface ShutdownCodeChanges { +export interface ShutdownAgentMetric { /** - * List of file paths that were modified during the session + * Human-readable label for this subagent invocation, copied from the originating `subagent.started` event. For task-tool subagents this is the invocation's task description rather than the agent's configured display name, so group by `agentName` for stable per-agent labels. */ - filesModified: string[]; + agentDisplayName?: string; /** - * Total number of lines added during the session + * Configured agent name, when this is a subagent */ - linesAdded: number; + agentName?: string; /** - * Total number of lines removed during the session + * Per-model usage for this agent, keyed by model identifier */ - linesRemoved: number; + modelMetrics: { + [k: string]: ShutdownModelMetric | undefined; + }; + /** + * Time spent in model API calls by this agent, in milliseconds + */ + totalApiDurationMs: number; + /** + * Accumulated nano-AI units cost for this agent + */ + totalNanoAiu: number; } /** * Per-model shutdown metrics with request counts, token usage, nano-AI units, and token details. @@ -2152,6 +2473,23 @@ export interface ShutdownModelMetricUsage { */ reasoningTokens?: number; } +/** + * Aggregate code change metrics for the session + */ +export interface ShutdownCodeChanges { + /** + * List of file paths that were modified during the session + */ + filesModified: string[]; + /** + * Total number of lines added during the session + */ + linesAdded: number; + /** + * Total number of lines removed during the session + */ + linesRemoved: number; +} /** * A session-wide shutdown token-type entry storing the accumulated token count. */ @@ -2201,6 +2539,12 @@ export interface UsageCheckpointData { * @internal */ modelCacheState?: UsageCheckpointModelCacheState[]; + /** + * Internal per-conversation prompt-cache-break detector baselines restored on resume + * + * @internal + */ + promptCacheBreakState?: JsonValue[]; /** * Session-wide accumulated nano-AI units cost at checkpoint time */ @@ -2325,6 +2669,49 @@ export interface UsageInfoData { */ toolDefinitionsTokens?: number; } +/** + * Session event "session.context_cleared". Context-cleared details emitted when the host clears the conversation (the session.history.clearContext RPC / Session.clearContextMessages) + */ +export interface ContextClearedEvent { + /** + * Sub-agent instance identifier. Absent for events from the root/main agent and session-level events. + */ + agentId?: string; + data: ContextClearedData; + /** + * 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.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 */ @@ -2363,6 +2750,10 @@ 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 */ @@ -2371,10 +2762,15 @@ export interface CompactionStartData { * 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 @@ -2410,6 +2806,10 @@ export interface CompactionCompleteEvent { * Conversation compaction results including success status, metrics, and optional error details */ export interface CompactionCompleteData { + /** + * Canonical model identifier used for model-specific behavior when replaying compaction + */ + behaviorModelId?: string; /** * Checkpoint snapshot number created for recovery */ @@ -2471,6 +2871,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 */ @@ -2479,6 +2883,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) @@ -2587,7 +2992,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; /** @@ -2596,18 +3010,19 @@ export interface TaskCompleteData { summary?: string; } /** - * Session event "user.message". Payload of `user.message` with displayed and model-transformed content, attachments, source/delivery metadata, mode, and telemetry IDs. + * Session event "session.fusion_route_started". Experimental transient signal that HydraFusion routing has started for an eligible turn. */ -export interface UserMessageEvent { +/** @experimental */ +export interface FusionRouteStartedEvent { /** * Sub-agent instance identifier. Absent for events from the root/main agent and session-level events. */ agentId?: string; - data: UserMessageData; + data: FusionRouteStartedData; /** - * 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 */ @@ -2621,52 +3036,414 @@ export interface UserMessageEvent { */ timestamp: string; /** - * Type discriminator. Always "user.message". + * Type discriminator. Always "session.fusion_route_started". */ - type: "user.message"; + type: "session.fusion_route_started"; } /** - * Payload of `user.message` with displayed and model-transformed content, attachments, source/delivery metadata, mode, and telemetry IDs. + * Experimental transient signal that HydraFusion routing has started for an eligible turn. */ -export interface UserMessageData { - agentMode?: UserMessageAgentMode; +/** @experimental */ +export interface FusionRouteStartedData { /** - * Files, selections, or GitHub references attached to the message + * Identifier for this routing attempt before a durable Fusion turn exists. */ - attachments?: Attachment[]; + attemptId: string; /** - * The user's message text as displayed in the timeline + * HydraFusion routing policy requested for the turn. */ - content: string; - delivery?: UserMessageDelivery; + policy?: string; /** - * CAPI interaction ID for correlating this user message with its turn + * Synthetic HydraFusion model selected for the session. */ - interactionId?: string; + syntheticModel?: string; + turnKind: FusionTurnKind; +} +/** + * Session event "session.fusion_route_failed". Experimental durable HydraFusion routing failure and the deterministic concrete fallback selected for the turn. + */ +/** @experimental */ +export interface FusionRouteFailedEvent { /** - * 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. + * Sub-agent instance identifier. Absent for events from the root/main agent and session-level events. */ - isAutopilotContinuation?: boolean; + agentId?: string; + data: FusionRouteFailedData; /** - * 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 + * When true, the event is transient and not persisted to the session event log on disk */ - nativeDocumentPathFallbackPaths?: string[]; + ephemeral?: boolean; /** - * Parent agent task ID for background telemetry correlated to this user turn + * Unique event identifier (UUID v4), generated when the event is emitted */ - parentAgentTaskId?: string; + id: string; /** - * Origin of this message, used for timeline filtering (e.g., "skill-pdf" for skill-injected messages that should be hidden from the user) + * ID of the chronologically preceding event in the session, forming a linked chain. Null for the first event. */ - source?: string; + parentId: string | null; /** - * Normalized document MIME types that were sent natively instead of through tagged_files XML + * ISO 8601 timestamp when the event was created + */ + timestamp: string; + /** + * Type discriminator. Always "session.fusion_route_failed". + */ + type: "session.fusion_route_failed"; +} +/** + * Experimental durable HydraFusion routing failure and the deterministic concrete fallback selected for the turn. + */ +/** @experimental */ +export interface FusionRouteFailedData { + /** + * Identifier of the routing attempt that failed. + */ + attemptId: string; + /** + * Provider or validation error detail, when available. + */ + errorMessage?: string; + /** + * Concrete model selected as the deterministic fallback. + */ + fallbackModel: string; + /** + * HydraFusion routing policy requested for the turn. + */ + policy: string; + /** + * Stable machine-readable reason for the routing failure. + */ + reason: string; + /** + * Elapsed routing time in milliseconds before the failure. + */ + routingLatencyMs?: number; + /** + * Synthetic HydraFusion model selected for the session. + */ + syntheticModel: string; +} +/** + * Session event "session.fusion_resolved". Experimental durable validated HydraFusion route and turn policy. + */ +/** @experimental */ +export interface FusionResolvedEvent { + /** + * Sub-agent instance identifier. Absent for events from the root/main agent and session-level events. + */ + agentId?: string; + data: FusionResolvedData; + /** + * 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.fusion_resolved". + */ + type: "session.fusion_resolved"; +} +/** + * Experimental durable validated HydraFusion route and turn policy. + */ +/** @experimental */ +export interface FusionResolvedData { + /** + * Version of the validated HydraFusion event contract. + */ + contractVersion: number; + /** + * Concrete model used when the planned primary model cannot execute. + */ + fallbackModel: string; + followUp?: FusionFollowUpRecommendation; + /** + * Concrete model recommended for eligible follow-up turns. + */ + followUpModel: string; + /** + * Stable identifier for the resolved HydraFusion turn. + */ + fusionId: string; + /** + * Version of the executable model universe used for selection. + */ + modelUniverseVersion?: string; + pattern: FusionPattern; + /** + * Version of the validated execution-plan format. + */ + planVersion?: string; + /** + * HydraFusion routing policy used to resolve the plan. + */ + policy: string; + /** + * Version of the local routing policy. + */ + policyVersion?: string; + /** + * Concrete model selected for the primary solver phase. + */ + primaryModel: string; + /** + * Router implementation that supplied the plan. + */ + routeSource?: string; + /** + * Elapsed time in milliseconds required to resolve and validate the route. + */ + routingLatencyMs?: number; + /** + * Identifier of the local policy rule that matched. + */ + ruleId?: string; + /** + * Zero-based index of the local policy rule that matched. + */ + ruleIndex?: number; + /** + * Human-readable name of the local policy rule that matched. + */ + ruleName?: string; + scores?: FusionScores; + /** + * Concrete model selected for the review or judge phase, when required. + */ + secondaryModel: string | null; + /** + * Synthetic HydraFusion model selected for the session. + */ + syntheticModel: string; + /** + * Identifier of the session turn associated with the route. + */ + turnId: string; +} +/** + * Durable server recommendation for subsequent HydraFusion turns. + */ +/** @experimental */ +export interface FusionFollowUpRecommendation { + compactionTurn: FusionFollowUpAction; + userTurn: FusionFollowUpAction; +} +/** + * Validated HydraFusion routing capability scores. + */ +/** @experimental */ +export interface FusionScores { + /** + * Code-generation capability score returned by the authenticated router. + */ + codeGen: number; + /** + * Debugging capability score returned by the authenticated router. + */ + debugging: number; + /** + * Reasoning capability score returned by the authenticated router. + */ + reasoning: number; + /** + * Tool-use capability score returned by the authenticated router. + */ + toolUse: number; +} +/** + * Session event "session.fusion_completed". Experimental durable aggregate outcome of a HydraFusion turn. + */ +/** @experimental */ +export interface FusionCompletedEvent { + /** + * Sub-agent instance identifier. Absent for events from the root/main agent and session-level events. + */ + agentId?: string; + data: FusionCompletedData; + /** + * 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.fusion_completed". + */ + type: "session.fusion_completed"; +} +/** + * Experimental durable aggregate outcome of a HydraFusion turn. + */ +/** @experimental */ +export interface FusionCompletedData { + /** + * Total cached input tokens reported across all phases. + */ + cachedTokens: number; + /** + * Total tokens written to prompt cache across all phases. + */ + cacheWriteTokens?: number; + /** + * Idempotency identifier for the authoritative final commit. + */ + commitId: string; + /** + * Reason the turn used a degraded route, when applicable. + */ + degradedReason: string | null; + /** + * Total elapsed execution time for the HydraFusion turn in milliseconds. + */ + durationMs: number; + /** + * Concrete model that supplied the authoritative final content. + */ + finalSourceModel: string | null; + /** + * Phase whose output supplied the authoritative final content. + */ + finalSourcePhaseId: string | null; + /** + * Concrete model recommended for eligible follow-up turns. + */ + followUpModel: string; + /** + * Stable identifier for the completed HydraFusion turn. + */ + fusionId: string; + /** + * Total input tokens consumed across all phases. + */ + inputTokens: number; + /** + * Stable aggregate outcome of the HydraFusion turn. + */ + outcome: string; + /** + * Total output tokens produced across all phases. + */ + outputTokens: number; + pattern: FusionPattern; + /** + * Number of concrete phases attempted by the turn. + */ + phaseCount: number; + /** + * Total concrete model requests made across all phases. + */ + requestCount: number; + /** + * Synthetic HydraFusion model selected for the session. + */ + syntheticModel: string; + /** + * Total normalized AI-unit cost reported across all phases, in nano-AIU. + */ + totalNanoAiu: number; + /** + * Identifier of the session turn associated with the completion. + */ + turnId: string; +} +/** + * 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 { + /** + * Sub-agent instance identifier. Absent for events from the root/main agent and session-level events. + */ + agentId?: string; + data: UserMessageData; + /** + * 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 "user.message". + */ + type: "user.message"; +} +/** + * 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?: 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 + */ + interactionId?: string; + /** + * 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?: boolean; + /** + * 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[]; + /** + * Parent agent task ID for background telemetry correlated to this user turn + */ + parentAgentTaskId?: string; + /** + * 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; + /** + * Normalized document MIME types that were sent natively instead of through tagged_files XML */ supportedNativeDocumentMimeTypes?: string[]; /** * Transformed version of the message sent to the model, with XML wrapping, timestamps, and other augmentations for prompt caching */ transformedContent?: string; + /** + * The agent-loop turn ID that consumed this message; absent when no agent-loop turn consumed it + */ + turnId?: string; } /** * File attachment @@ -3096,9 +3873,7 @@ export interface AttachmentExtensionContext { /** * Caller-supplied JSON payload */ - payload?: { - [k: string]: unknown | undefined; - }; + payload?: JsonValue; /** * Human-readable composer pill label */ @@ -3190,15 +3965,14 @@ export interface AssistantTurnStartData { turnId: string; } /** - * Session event "assistant.turn_retry". Metadata for an additional model inference attempt within an existing assistant turn + * Session event "assistant.intent". Agent intent description for current activity or plan */ -/** @internal */ -export interface AssistantTurnRetryEvent { +export interface AssistantIntentEvent { /** * Sub-agent instance identifier. Absent for events from the root/main agent and session-level events. */ agentId?: string; - data: AssistantTurnRetryData; + data: AssistantIntentData; /** * Always true for events that are transient and not persisted to the session event log on disk. */ @@ -3216,40 +3990,89 @@ export interface AssistantTurnRetryEvent { */ timestamp: string; /** - * Type discriminator. Always "assistant.turn_retry". + * Type discriminator. Always "assistant.intent". */ - type: "assistant.turn_retry"; + type: "assistant.intent"; } /** - * Metadata for an additional model inference attempt within an existing assistant turn + * Agent intent description for current activity or plan */ -export interface AssistantTurnRetryData { +export interface AssistantIntentData { /** - * Model identifier used for this retry, when known + * Short description of what the agent is currently doing or planning to do */ - model?: string; + intent: string; +} +/** + * Session event "assistant.fusion_phase_started". Experimental transient HydraFusion phase/model/role signal. + */ +/** @experimental */ +export interface AssistantFusionPhaseStartedEvent { /** - * Provider or runtime classification that caused the retry, when known + * Sub-agent instance identifier. Absent for events from the root/main agent and session-level events. */ - reason?: string; + agentId?: string; + data: FusionPhaseStartedData; /** - * Identifier of the turn whose model inference is being retried + * Always true for events that are transient and not persisted to the session event log on disk. */ - turnId: string; + 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.fusion_phase_started". + */ + type: "assistant.fusion_phase_started"; } /** - * Session event "assistant.intent". Agent intent description for current activity or plan + * Experimental transient HydraFusion phase/model/role signal. */ -export interface AssistantIntentEvent { +/** @experimental */ +export interface FusionPhaseStartedData { + conversationScope: FusionConversationScope; + /** + * Identifier of the HydraFusion turn containing the phase. + */ + fusionId: string; + /** + * Concrete model executing the phase. + */ + model: string; + pattern: FusionPattern; + /** + * Stable identifier for the concrete phase. + */ + phaseId: string; + phaseKind: FusionPhaseKind; + /** + * Semantic role assigned to the phase. + */ + role: string; +} +/** + * Session event "assistant.fusion_phase_completed". Experimental durable HydraFusion phase output and lossless replay checkpoint. + */ +/** @experimental */ +export interface AssistantFusionPhaseCompletedEvent { /** * Sub-agent instance identifier. Absent for events from the root/main agent and session-level events. */ agentId?: string; - data: AssistantIntentData; + data: FusionPhaseCompletedData; /** - * 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 */ @@ -3263,18 +4086,180 @@ export interface AssistantIntentEvent { */ timestamp: string; /** - * Type discriminator. Always "assistant.intent". + * Type discriminator. Always "assistant.fusion_phase_completed". */ - type: "assistant.intent"; + type: "assistant.fusion_phase_completed"; } /** - * Agent intent description for current activity or plan + * Experimental durable HydraFusion phase output and lossless replay checkpoint. */ -export interface AssistantIntentData { +/** @experimental */ +export interface FusionPhaseCompletedData { + /** + * Provider-normalized textual output produced by the phase. + */ + content: string; + conversationScope: FusionConversationScope; + /** + * Elapsed execution time for the phase in milliseconds. + */ + durationMs: number; + /** + * Identifier of the HydraFusion turn containing the phase. + */ + fusionId: string; + /** + * Concrete model that executed the phase. + */ + model: string; + /** + * Stable identifier for the completed phase. + */ + phaseId: string; + phaseKind: FusionPhaseKind; + /** + * Exact provider-normalized message used to reconstruct canonical model history. + * + * @internal + */ + projectionMessage?: JsonValue; + /** + * Projection action for the exact internal message. + * + * @internal + */ + projectionMode?: FusionProjectionMode; + /** + * Semantic role assigned to the completed phase. + */ + role: string; + /** + * Terminal request held outside canonical state until selected by the final commit. + * + * @internal + */ + stagedTerminal?: FusionStagedTerminal; + status: FusionPhaseStatus; + usage: FusionPhaseUsage; + /** + * Structured judge or critic verdict, when the phase produces one. + */ + verdict: string | null; +} +/** + * Internal durable terminal request staged by a HydraFusion phase until an idempotent final commit selects it. + */ +/** @experimental */ +/** @internal */ +export interface FusionStagedTerminal { + arguments: string; + assistantMessage: JsonValue; + phaseId: string; + toolCallId: string; + toolName: string; +} +/** + * Aggregate concrete-model usage for one HydraFusion phase. + */ +/** @experimental */ +export interface FusionPhaseUsage { + /** + * Total cached input tokens reported for the phase. + */ + cachedTokens: number; + /** + * Total tokens written to prompt cache during the phase. + */ + cacheWriteTokens?: number; + /** + * Total input tokens consumed by the phase. + */ + inputTokens: number; + /** + * Total output tokens produced by the phase. + */ + outputTokens: number; + /** + * Number of concrete model requests made by the phase. + */ + requestCount: number; + /** + * Total normalized AI-unit cost reported for the phase, in nano-AIU. + */ + totalNanoAiu: number; +} +/** + * Session event "assistant.fusion_phase_failed". Experimental durable typed HydraFusion phase failure and degradation transition. + */ +/** @experimental */ +export interface AssistantFusionPhaseFailedEvent { + /** + * Sub-agent instance identifier. Absent for events from the root/main agent and session-level events. + */ + agentId?: string; + data: FusionPhaseFailedData; + /** + * 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.fusion_phase_failed". + */ + type: "assistant.fusion_phase_failed"; +} +/** + * Experimental durable typed HydraFusion phase failure and degradation transition. + */ +/** @experimental */ +export interface FusionPhaseFailedData { + conversationScope: FusionConversationScope; + /** + * Identifier of the fallback phase used to continue the turn after degradation. + */ + degradedToPhaseId?: string; + /** + * Elapsed execution time before the phase failed, in milliseconds. + */ + durationMs: number; + /** + * Provider or execution error detail, when available. + */ + errorMessage?: string; + /** + * Identifier of the HydraFusion turn containing the phase. + */ + fusionId: string; + /** + * Concrete model that attempted the phase. + */ + model: string; /** - * Short description of what the agent is currently doing or planning to do + * Stable identifier for the failed phase. */ - intent: string; + phaseId: string; + phaseKind: FusionPhaseKind; + /** + * Stable machine-readable reason for the phase failure. + */ + reason: string; + /** + * Semantic role assigned to the failed phase. + */ + role: string; + status: FusionPhaseStatus; + usage: FusionPhaseUsage; } /** * 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 @@ -3365,6 +4350,10 @@ export interface AssistantReasoningData { * Unique identifier for this reasoning block */ reasoningId: string; + /** + * Per-request treatment/eligibility signal returned by the Copilot API in the `X-GitHub-Copilot-Request-TE` response header for the associated model call; `false` when the header was absent or unparseable. + */ + rte?: boolean; } /** * Session event "assistant.reasoning_delta". Streaming reasoning delta for incremental extended thinking updates @@ -3534,6 +4523,14 @@ export interface AssistantMessageData { * Provider's completion / response identifier; shared across all chunks of a single API call. Used to group multi-chunk assistant utterances. */ 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; /** * Provider-agnostic citations linking spans of this message's content to the sources that support them. Experimental; only populated when citation emission is enabled. * @@ -3552,6 +4549,12 @@ export interface AssistantMessageData { * Encrypted reasoning content from OpenAI models. Session-bound and stripped on resume. */ encryptedContent?: string; + /** + * Experimental HydraFusion source attribution for this ordinary authoritative assistant message. + * + * @experimental + */ + fusion?: FusionAttribution; /** * CAPI interaction ID for correlating this message with upstream telemetry */ @@ -3577,6 +4580,7 @@ export interface AssistantMessageData { * Generation phase for phased-output models (e.g., thinking vs. response phases) */ phase?: string; + reasoningBlocks?: AssistantMessageReasoningBlocks; /** * Opaque/encrypted extended thinking data from Anthropic models. Session-bound and stripped on resume. */ @@ -3593,6 +4597,10 @@ export interface AssistantMessageData { * GitHub request tracing ID (x-github-request-id header) for correlating with server-side logs */ requestId?: string; + /** + * Per-request treatment/eligibility signal returned by the Copilot API in the `X-GitHub-Copilot-Request-TE` response header for the associated model call; `false` when the header was absent or unparseable. + */ + rte?: boolean; serverTools?: AssistantMessageServerTools; /** * Copilot service request ID (x-copilot-service-request-id header) for CAPI log correlation @@ -3675,9 +4683,7 @@ export interface CitationReference { /** * Provider-native citation correlation data (e.g. Anthropic search_result_index / document_index), passed through opaquely for debugging and forward compatibility. */ - providerMetadata?: { - [k: string]: unknown | undefined; - }; + providerMetadata?: JsonValue; /** * Identifier of the CitationSource this reference points to (CitationSource.id). */ @@ -3737,18 +4743,97 @@ export interface CitationLocationBlock { */ type: "block"; } +/** + * Experimental attribution linking an ordinary event to the HydraFusion turn, phase, and concrete source that produced it. + */ +/** @experimental */ +export interface FusionAttribution { + /** + * Idempotency identifier for the authoritative commit, when the event belongs to the selected output. + */ + commitId?: string; + /** + * Conversation scope in which the concrete phase executed. + */ + conversationScope?: string; + /** + * Stable identifier for the HydraFusion turn that produced the event. + */ + fusionId: string; + /** + * HydraFusion orchestration pattern selected for the turn. + */ + pattern: string; + /** + * Identifier of the concrete phase that produced the event. + */ + phaseId?: string; + /** + * Kind of concrete phase that produced the event. + */ + phaseKind?: string; + /** + * HydraFusion routing policy used for the turn. + */ + policy: string; + /** + * Semantic role assigned to the concrete phase. + */ + role?: string; + /** + * Concrete model that produced the attributed event. + */ + sourceModel?: string; + /** + * Phase whose output supplied the authoritative content, when different from the executing phase. + */ + sourcePhaseId?: string; + /** + * Synthetic HydraFusion model selected for the session. + */ + syntheticModel: string; +} +/** + * Neutral provider-tagged reasoning content blocks preserved verbatim for round-tripping + */ +/** @experimental */ +export interface AssistantMessageReasoningBlocks { + /** + * Provider-native reasoning content blocks (e.g. Anthropic `thinking` / `redacted_thinking`) preserved verbatim, in order. A single response can carry several, each signed over the content preceding it, so dropping or reordering any of them invalidates the rest. + */ + blocks?: JsonValue[]; + /** + * Model provider that produced these reasoning blocks. + */ + provider: string; +} /** * Neutral provider-tagged server-side tool-use payload (tool search, advisor) for verbatim round-tripping */ /** @experimental */ export interface AssistantMessageServerTools { + /** + * Advisor model identifier associated with the server-tool payload. + */ advisorModel?: string; + /** + * Provider function-call namespaces keyed by function-call identifier. + */ functionCallNamespaces?: { [k: string]: string | undefined; }; - items?: unknown[]; + /** + * Provider-native server-tool call and output items preserved verbatim for replay. + */ + items?: JsonValue[]; + /** + * Model provider that produced this server-tool payload. + */ provider: string; - rawContentBlocks?: unknown[]; + /** + * Raw provider content blocks retained for verbatim round-tripping. + */ + rawContentBlocks?: JsonValue[]; } /** * A tool invocation request from the assistant @@ -3757,9 +4842,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 */ @@ -3993,11 +5076,27 @@ export interface AssistantUsageEvent { * LLM API call usage metrics including tokens, costs, quotas, and billing information */ export interface AssistantUsageData { + /** + * Number of accepted speculative prediction tokens + */ + acceptedPredictionTokens?: number; /** * Completion ID from the model provider (e.g., chatcmpl-abc123) */ apiCallId?: string; apiEndpoint?: AssistantUsageApiEndpoint; + /** + * Number of tools available to the model for this call + * + * @internal + */ + availableToolCount?: number; + /** + * Whether the provider reported prompt-cache usage details for this call + * + * @internal + */ + cacheDetailsReported?: boolean; /** * Updated prompt-cache expiration for this model call. Present only when the call establishes or refreshes known cache state. */ @@ -4006,6 +5105,12 @@ export interface AssistantUsageData { * Number of tokens read from prompt cache */ cacheReadTokens?: number; + /** + * Effective prompt-cache lifetime in seconds for this call + * + * @internal + */ + cacheTtlSeconds?: number; /** * Number of tokens written to prompt cache */ @@ -4029,6 +5134,18 @@ export interface AssistantUsageData { * 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; + /** + * How the prompt-cache frontier was determined for this call + * + * @internal + */ + frontierSource?: string; + /** + * Experimental HydraFusion attribution for this concrete model call's usage. + * + * @experimental + */ + fusion?: FusionAttribution; /** * What initiated this API call (e.g., "sub-agent", "mcp-sampling"); absent for user-initiated calls */ @@ -4037,18 +5154,48 @@ 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 */ interTokenLatencyMs?: number; + /** + * Whether Auto mode was selected for this model call + */ + isAuto?: boolean; + /** + * Whether this model call used a bring-your-own-key provider + */ + isByok?: boolean; + /** + * Requested maximum output tokens used for this model call + */ + maxOutputTokens?: number; + /** + * Effective maximum prompt-token limit used for this model call + */ + maxPromptTokens?: number; /** * 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 */ outputTokens?: number; + /** + * Time to first observable model output in milliseconds. Includes text, reasoning, and tool-call output; only available for streaming requests that produce observable output. + */ + outputTtftMs?: number; /** * @deprecated * Parent tool call ID when this usage originates from a sub-agent @@ -4070,10 +5217,19 @@ export interface AssistantUsageData { * Reasoning effort level used for model calls, if applicable (e.g. "none", "low", "medium", "high", "xhigh", "max") */ reasoningEffort?: string; + reasoningSummary?: ReasoningSummary; /** * Number of output tokens used for reasoning (e.g., chain-of-thought) */ reasoningTokens?: number; + /** + * Number of rejected speculative prediction tokens + */ + rejectedPredictionTokens?: number; + /** + * Per-request treatment/eligibility signal returned by the Copilot API in the `X-GitHub-Copilot-Request-TE` response header for the associated model call; `false` when the header was absent or unparseable. + */ + rte?: boolean; /** * Copilot service request ID (x-copilot-service-request-id header) for CAPI log correlation */ @@ -4082,6 +5238,21 @@ 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; + transport?: AssistantUsageTransport; } /** * Per-request cost and usage data from the CAPI copilot_usage response field @@ -4248,10 +5419,20 @@ export interface ModelCallFailureData { */ errorType?: string; failureKind?: ModelCallFailureKind; + /** + * Experimental HydraFusion attribution for this failed concrete model call. + * + * @experimental + */ + fusion?: FusionAttribution; /** * What initiated this API call (e.g., "sub-agent", "mcp-sampling"); absent for user-initiated calls */ initiator?: string; + /** + * Authoritative interaction classification for the failed call, matching `assistant.usage.interactionType` (for example `conversation-agent`, `conversation-subagent`, or `conversation-sampling`). Absent when the producer cannot classify the interaction. + */ + interactionType?: string; /** * Whether the session selected Auto mode for the failed call */ @@ -4289,6 +5470,10 @@ export interface ModelCallFailureData { */ reasoningEffort?: string; requestFingerprint?: ModelCallFailureRequestFingerprint; + /** + * Per-request treatment/eligibility signal returned by the Copilot API in the `X-GitHub-Copilot-Request-TE` response header for the associated model call; `false` when the header was absent or unparseable. + */ + rte?: boolean; /** * Copilot service request ID (x-copilot-service-request-id header) for CAPI log correlation */ @@ -4334,15 +5519,14 @@ export interface ModelCallFailureRequestFingerprint { toolResultMessageCount: number; } /** - * Session event "model.call_start". Model API dispatch metadata for internal telemetry + * Session event "model.call_finished". Final lifecycle outcome for one logical model dispatch. A logical dispatch may include internal reconnect or fallback work, so event count is not provider HTTP-request count. */ -/** @internal */ -export interface ModelCallStartEvent { +export interface ModelCallFinishedEvent { /** * Sub-agent instance identifier. Absent for events from the root/main agent and session-level events. */ agentId?: string; - data: ModelCallStartData; + data: ModelCallFinishedData; /** * Always true for events that are transient and not persisted to the session event log on disk. */ @@ -4360,20 +5544,33 @@ export interface ModelCallStartEvent { */ timestamp: string; /** - * Type discriminator. Always "model.call_start". + * Type discriminator. Always "model.call_finished". */ - type: "model.call_start"; + type: "model.call_finished"; } /** - * Model API dispatch metadata for internal telemetry + * Final lifecycle outcome for one logical model dispatch. A logical dispatch may include internal reconnect or fallback work, so event count is not provider HTTP-request count. */ -export interface ModelCallStartData { +export interface ModelCallFinishedData { /** - * Model identifier used for this API call, when known + * Whether an accepted successful response requested the exact name and command semantics of a built-in file edit tool, including an external tool explicitly replacing that built-in name. Absent when the logical dispatch did not produce an accepted response. */ - model?: string; + containsBuiltInFileEditRequest?: boolean; + /** + * Monotonic elapsed time spent in the logical model dispatch, including any internal transport reconnect or fallback and excluding orchestrator retry backoff, tool execution, confirmations, and post-response processing + */ + dispatchDurationMs: number; + /** + * Version of the built-in file-edit semantic classifier used for this event + */ + editClassifierVersion: number; + /** + * Identifier of the user interaction that owns the model dispatch, matching assistant.turn_start.interactionId when available + */ + interactionId?: string; + outcome: ModelCallFinishedOutcome; /** - * Identifier of the assistant turn that initiated the model call + * Agent-loop iteration within the interaction that initiated the model dispatch */ turnId: string; } @@ -4450,9 +5647,7 @@ export interface ToolUserRequestedData { /** * Arguments for the tool invocation */ - arguments?: { - [k: string]: unknown | undefined; - }; + arguments?: JsonValue; /** * Unique identifier for this tool call */ @@ -4499,13 +5694,17 @@ 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 */ displayVerbatim?: boolean; + /** + * Experimental HydraFusion attribution for this tool execution. + * + * @experimental + */ + fusion?: FusionAttribution; /** * Name of the MCP server hosting this tool, when the tool is an MCP tool */ @@ -4523,6 +5722,10 @@ export interface ToolExecutionStartData { * Tool call ID of the parent tool invocation when this event originates from a sub-agent */ parentToolCallId?: string; + /** + * Per-request treatment/eligibility signal returned by the Copilot API in the `X-GitHub-Copilot-Request-TE` response header for the associated model call; `false` when the header was absent or unparseable. + */ + rte?: boolean; shellToolInfo?: ToolExecutionStartShellToolInfo; /** * Unique identifier for this tool call @@ -4542,6 +5745,12 @@ export interface ToolExecutionStartData { * 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 >>). */ @@ -4705,6 +5914,12 @@ export interface ToolExecutionCompleteEvent { */ export interface ToolExecutionCompleteData { error?: ToolExecutionCompleteError; + /** + * Experimental HydraFusion attribution for this tool completion. + * + * @experimental + */ + fusion?: FusionAttribution; /** * CAPI interaction ID for correlating this tool execution with upstream telemetry */ @@ -4718,9 +5933,7 @@ export interface ToolExecutionCompleteData { * * @experimental */ - mcpMeta?: { - [k: string]: unknown | undefined; - }; + mcpMeta?: JsonValue; /** * Model identifier that generated this tool call */ @@ -4731,6 +5944,10 @@ export interface ToolExecutionCompleteData { */ parentToolCallId?: string; result?: ToolExecutionCompleteResult; + /** + * Per-request treatment/eligibility signal returned by the Copilot API in the `X-GitHub-Copilot-Request-TE` response header for the associated model call; `false` when the header was absent or unparseable. + */ + rte?: boolean; /** * Whether this tool execution ran inside a sandbox container */ @@ -4748,7 +5965,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 @@ -4801,15 +6018,11 @@ export interface ToolExecutionCompleteResult { * * @experimental */ - mcpMeta?: { - [k: string]: unknown | undefined; - }; + mcpMeta?: JsonValue; /** * Structured content (arbitrary JSON) returned verbatim by the MCP tool */ - structuredContent?: { - [k: string]: unknown | undefined; - }; + structuredContent?: JsonValue; uiResource?: ToolExecutionCompleteUIResource; } /** @@ -4828,7 +6041,7 @@ export interface PersistedBinaryImage { * Optional metadata from the producing tool. */ metadata?: { - [k: string]: unknown | undefined; + [k: string]: JsonValue | undefined; }; /** * MIME type of the binary data @@ -4853,7 +6066,7 @@ export interface OmittedBinaryResult { * Optional metadata from the producing tool. */ metadata?: { - [k: string]: unknown | undefined; + [k: string]: JsonValue | undefined; }; /** * MIME type of the omitted binary data @@ -4883,7 +6096,7 @@ export interface BinaryAssetReference { * Optional metadata from the producing tool. */ metadata?: { - [k: string]: unknown | undefined; + [k: string]: JsonValue | undefined; }; /** * MIME type of the referenced binary data @@ -4964,6 +6177,10 @@ export interface ToolExecutionCompleteContentShellExit { * Exit code from the completed shell command */ exitCode: number; + /** + * Path reported in the shell session's filesystem namespace when shell output exceeded the configured large-output threshold. + */ + outputFilePath?: string; /** * Output associated with this shell command, if available. May be partial, truncated, or a preview; not guaranteed to be full output. */ @@ -5147,17 +6364,35 @@ export interface ToolExecutionCompleteUIResourceMeta { */ export interface ToolExecutionCompleteUIResourceMetaUI { csp?: ToolExecutionCompleteUIResourceMetaUICsp; + /** + * Optional dedicated origin for the rendered MCP Apps UI resource. + */ domain?: string; permissions?: ToolExecutionCompleteUIResourceMetaUIPermissions; + /** + * Whether the host should render a border around the MCP Apps UI resource. + */ prefersBorder?: boolean; } /** * CSP domain allowlists for an MCP Apps UI resource, including connect, resource, frame, and base URI domains. */ export interface ToolExecutionCompleteUIResourceMetaUICsp { + /** + * Domains the UI resource may use as document base URIs. + */ baseUriDomains?: string[]; + /** + * Domains the UI resource may connect to. + */ connectDomains?: string[]; + /** + * Domains the UI resource may embed as nested frames. + */ frameDomains?: string[]; + /** + * Domains from which the UI resource may load scripts, styles, images, and other resources. + */ resourceDomains?: string[]; } /** @@ -5379,15 +6614,86 @@ export interface SubagentStartedData { * Internal name of the sub-agent */ agentName: string; + /** + * Type of the sub-agent selected at spawn time. + */ + agentType?: string; + /** + * Whether the sub-agent runs synchronously or in the background. + */ + executionMode?: string; + /** + * Root id of the factory run that spawned this sub-agent, when it was spawned by one. + */ + factoryRunId?: string; /** * Model the sub-agent will run with, when known at start. */ model?: string; + /** + * Task-registry ID of the spawning sub-agent. Absent when the root session spawned this child. + */ + parentId?: string; + /** + * Whether this sub-agent can be resumed. Currently always false. + */ + resumable?: boolean; /** * Tool call ID of the parent tool invocation that spawned this sub-agent */ toolCallId: string; } +/** + * Session event "subagent.configured". Resolved runtime configuration for a configured sub-agent + */ +export interface SubagentConfiguredEvent { + /** + * Sub-agent instance identifier. Absent for events from the root/main agent and session-level events. + */ + agentId?: string; + data: SubagentConfiguredData; + /** + * 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 "subagent.configured". + */ + type: "subagent.configured"; +} +/** + * Resolved runtime configuration for a configured sub-agent + */ +export interface SubagentConfiguredData { + /** + * Resolved context tier, when configured for the model + */ + contextTier?: string; + /** + * Resolved model the sub-agent will run with + */ + model: string; + /** + * Whether the sub-agent accepts follow-up turns + */ + multiTurn: boolean; + /** + * Resolved reasoning effort, when configured for the model + */ + reasoningEffort?: string; +} /** * Session event "subagent.completed". Sub-agent completion details for successful execution */ @@ -5430,10 +6736,34 @@ 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; + /** + * Whether the first model actually dispatched matched the user's configured preference + */ + configuredModelMatchesActual?: boolean; + /** + * Concrete model the user configured for this sub-agent via `/subagents`, when present + */ + configuredModelPreference?: string; /** * Wall-clock duration of the sub-agent execution in milliseconds */ durationMs?: number; + /** + * Whether the explicit task-call model matched the user's configured preference + */ + explicitModelMatchesPreference?: boolean; + /** + * Explicit model supplied by the parent agent on the task call, when present + */ + explicitModelOverride?: string; + /** + * First model for which the sub-agent started an inference request, when one was dispatched + */ + firstDispatchedModel?: string; /** * Model used by the sub-agent */ @@ -5493,6 +6823,14 @@ export interface SubagentFailedData { * Internal name of the sub-agent */ agentName: string; + /** + * Whether the first model actually dispatched matched the user's configured preference + */ + configuredModelMatchesActual?: boolean; + /** + * Concrete model the user configured for this sub-agent via `/subagents`, when present + */ + configuredModelPreference?: string; /** * Wall-clock duration of the sub-agent execution in milliseconds */ @@ -5501,6 +6839,18 @@ export interface SubagentFailedData { * Error message describing why the sub-agent failed */ error: string; + /** + * Whether the explicit task-call model matched the user's configured preference + */ + explicitModelMatchesPreference?: boolean; + /** + * Explicit model supplied by the parent agent on the task call, when present + */ + explicitModelOverride?: string; + /** + * First model for which the sub-agent started an inference request, when one was dispatched + */ + firstDispatchedModel?: string; /** * Model selected for the sub-agent, when known */ @@ -5644,9 +6994,11 @@ export interface HookStartData { /** * Input data passed to the hook */ - input?: { - [k: string]: unknown | undefined; - }; + input?: JsonValue; + /** + * Tool call ID of the parent tool invocation when this event originates from a sub-agent + */ + parentToolCallId?: string; } /** * Session event "hook.end". Hook invocation completion details including output, success status, and error information @@ -5694,9 +7046,11 @@ export interface HookEndData { /** * Output data produced by the hook */ - output?: { - [k: string]: unknown | undefined; - }; + output?: JsonValue; + /** + * Tool call ID of the parent tool invocation when this event originates from a sub-agent + */ + parentToolCallId?: string; /** * Whether the hook completed successfully */ @@ -5817,7 +7171,7 @@ export interface BinaryAssetData { * Optional metadata from the producing tool. */ metadata?: { - [k: string]: unknown | undefined; + [k: string]: JsonValue | undefined; }; /** * MIME type of the binary asset @@ -5863,6 +7217,10 @@ 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 @@ -5882,7 +7240,7 @@ export interface SystemMessageMetadata { * Template variables used when constructing the prompt */ variables?: { - [k: string]: unknown | undefined; + [k: string]: JsonValue | undefined; }; } /** @@ -5930,7 +7288,7 @@ export interface SystemNotificationData { */ export interface SystemNotificationAgentCompleted { /** - * Unique identifier of the background agent + * Unique task identifier */ agentId: string; /** @@ -5941,6 +7299,10 @@ export interface SystemNotificationAgentCompleted { * Human-readable description of the agent task */ description?: string; + /** + * Friendly, non-unique name intended for display + */ + displayName?: string; /** * The full prompt given to the background agent */ @@ -5956,7 +7318,7 @@ export interface SystemNotificationAgentCompleted { */ export interface SystemNotificationAgentIdle { /** - * Unique identifier of the background agent + * Unique task identifier */ agentId: string; /** @@ -5967,6 +7329,10 @@ export interface SystemNotificationAgentIdle { * Human-readable description of the agent task */ description?: string; + /** + * Friendly, non-unique name intended for display + */ + displayName?: string; /** * Type discriminator. Always "agent_idle". */ @@ -6060,6 +7426,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 */ @@ -6104,6 +7529,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 @@ -6117,6 +7546,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 */ @@ -6133,6 +7566,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 */ @@ -6171,6 +7608,19 @@ export interface PermissionRequestShellCommand { */ readOnly: boolean; } +/** + * 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. */ @@ -6204,6 +7654,10 @@ 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 */ @@ -6233,6 +7687,10 @@ 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 */ @@ -6257,13 +7715,17 @@ export interface PermissionRequestMcp { /** * Arguments to pass to the MCP tool */ - args?: { - [k: string]: unknown | undefined; - }; + args?: JsonValue; /** * Permission kind discriminator */ kind: "mcp"; + /** + * Advisory runtime permission recommendation. The SDK host remains responsible for deciding the request and may reject it. + * + * @experimental + */ + permissionRecommendation?: PermissionRecommendation; /** * Whether this MCP tool is read-only (no side effects) */ @@ -6297,6 +7759,14 @@ 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. */ @@ -6319,6 +7789,12 @@ export interface PermissionRequestUrl { */ export interface PermissionRequestMemory { action?: PermissionRequestMemoryAction; + /** + * Assisted-approval judge information for this request; present only in assisted mode. + * + * @experimental + */ + assistedApproval?: PermissionAssistedApproval; /** * Source references for the stored fact (store only) */ @@ -6336,6 +7812,11 @@ export interface PermissionRequestMemory { * Reason for the vote (vote only) */ reason?: string; + /** + * Repository name with owner associated with the stored memory (store only) + */ + repoNwo?: string; + scope?: PermissionRequestMemoryScope; /** * Topic or subject of the memory (store only) */ @@ -6345,6 +7826,22 @@ export interface PermissionRequestMemory { */ toolCallId?: string; } +/** + * Assisted-approval judge information attached to a permission request. Present only in assisted mode; its absence means the judge did not evaluate the request. The `recommendation` conveys the judge's disposition for this request. + */ +/** @experimental */ +export interface PermissionAssistedApproval { + failureReason?: AssistedApprovalJudgeFailureReason; + /** + * 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: AssistedApprovalRecommendation; +} /** * Custom tool invocation permission request */ @@ -6352,13 +7849,15 @@ export interface PermissionRequestCustomTool { /** * Arguments to pass to the custom tool */ - args?: { - [k: string]: unknown | undefined; - }; + args?: JsonValue; /** * Permission kind discriminator */ kind: "custom-tool"; + /** + * Whether the tool declared that permission may be skipped unless a deny rule matches + */ + skipPermission?: boolean; /** * Tool call ID that triggered this permission request */ @@ -6387,9 +7886,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 */ @@ -6420,6 +7917,85 @@ 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; + /** + * Factory-declared AI-credit limit before any run/resume caller override is applied. + */ + declaredMaxAiCredits?: number; + /** + * Factory-declared concurrent-subagent limit before any run/resume caller override is applied. + */ + declaredMaxConcurrentSubagents?: number; + /** + * Factory-declared total-subagent limit before any run/resume caller override is applied. + */ + declaredMaxTotalSubagents?: number; + /** + * Factory-declared active-time limit in seconds before any run/resume caller override is applied. + */ + 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 */ @@ -6441,16 +8017,39 @@ export interface PermissionRequestExtensionPermissionAccess { */ toolCallId?: string; } +/** + * Extension sensitive environment variable access request + */ +export interface PermissionRequestExtensionEnvAccess { + /** + * Names of the sensitive environment variables the extension is requesting. Values never appear here. + * + * @minItems 1 + */ + environmentVariables: [string, ...string[]]; + /** + * Name of the extension requesting environment variable access + */ + extensionName: string; + /** + * Permission kind discriminator + */ + kind: "extension-env-access"; + /** + * Tool call ID that triggered this permission request + */ + toolCallId?: string; +} /** * Shell command permission prompt */ export interface PermissionPromptRequestCommands { /** - * Auto-approval judge information for this request; present only when auto mode is enabled. + * Assisted-approval judge information for this request; present only in assisted mode. * * @experimental */ - autoApproval?: PermissionAutoApproval; + assistedApproval?: PermissionAssistedApproval; /** * Whether the UI can offer session-wide approval for this command pattern */ @@ -6471,6 +8070,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 */ @@ -6480,27 +8083,16 @@ 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 { - /** - * 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. + * Assisted-approval judge information for this request; present only in assisted mode. * * @experimental */ - autoApproval?: PermissionAutoApproval; + assistedApproval?: PermissionAssistedApproval; /** * Whether the UI can offer session-wide approval for file write operations */ @@ -6521,6 +8113,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 */ @@ -6535,11 +8131,11 @@ export interface PermissionPromptRequestWrite { */ export interface PermissionPromptRequestRead { /** - * Auto-approval judge information for this request; present only when auto mode is enabled. + * Assisted-approval judge information for this request; present only in assisted mode. * * @experimental */ - autoApproval?: PermissionAutoApproval; + assistedApproval?: PermissionAssistedApproval; /** * Human-readable description of why the file is being read */ @@ -6548,6 +8144,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 */ @@ -6564,19 +8164,27 @@ export interface PermissionPromptRequestMcp { /** * Arguments to pass to the MCP tool */ - args?: { - [k: string]: unknown | undefined; - }; + args?: JsonValue; /** - * Auto-approval judge information for this request; present only when auto mode is enabled. + * Assisted-approval judge information for this request; present only in assisted mode. * * @experimental */ - autoApproval?: PermissionAutoApproval; + assistedApproval?: PermissionAssistedApproval; + /** + * Whether the host may offer a server-wide "approve all tools from this server" blanket. Absent is treated as true; the runtime sends false when managed policy disables bypass-permissions mode, which forbids the server-wide escalation while still allowing per-tool approval. + */ + canOfferServerWideApproval?: boolean; /** * Prompt kind discriminator */ kind: "mcp"; + /** + * Advisory runtime permission recommendation. The host remains responsible for deciding the request and may reject it. + * + * @experimental + */ + permissionRecommendation?: PermissionRecommendation; /** * Name of the MCP server providing the tool */ @@ -6599,11 +8207,11 @@ export interface PermissionPromptRequestMcp { */ export interface PermissionPromptRequestUrl { /** - * Auto-approval judge information for this request; present only when auto mode is enabled. + * Assisted-approval judge information for this request; present only in assisted mode. * * @experimental */ - autoApproval?: PermissionAutoApproval; + assistedApproval?: PermissionAssistedApproval; /** * Human-readable description of why the URL is being accessed */ @@ -6612,6 +8220,14 @@ 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. */ @@ -6635,11 +8251,11 @@ export interface PermissionPromptRequestUrl { export interface PermissionPromptRequestMemory { action?: PermissionRequestMemoryAction; /** - * Auto-approval judge information for this request; present only when auto mode is enabled. + * Assisted-approval judge information for this request; present only in assisted mode. * * @experimental */ - autoApproval?: PermissionAutoApproval; + assistedApproval?: PermissionAssistedApproval; /** * Source references for the stored fact (store only) */ @@ -6673,15 +8289,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. + * Assisted-approval judge information for this request; present only in assisted mode. * * @experimental */ - autoApproval?: PermissionAutoApproval; + assistedApproval?: PermissionAssistedApproval; /** * Prompt kind discriminator */ @@ -6705,11 +8319,11 @@ export interface PermissionPromptRequestCustomTool { export interface PermissionPromptRequestPath { accessKind: PermissionPromptRequestPathAccessKind; /** - * Auto-approval judge information for this request; present only when auto mode is enabled. + * Assisted-approval judge information for this request; present only in assisted mode. * * @experimental */ - autoApproval?: PermissionAutoApproval; + assistedApproval?: PermissionAssistedApproval; /** * Prompt kind discriminator */ @@ -6728,83 +8342,186 @@ export interface PermissionPromptRequestPath { */ export interface PermissionPromptRequestHook { /** - * Auto-approval judge information for this request; present only when auto mode is enabled. + * Assisted-approval judge information for this request; present only in assisted mode. * * @experimental */ - autoApproval?: PermissionAutoApproval; + assistedApproval?: PermissionAssistedApproval; /** * Optional message from the hook explaining why confirmation is needed */ - hookMessage?: string; + hookMessage?: string; + /** + * Prompt kind discriminator + */ + kind: "hook"; + /** + * Arguments of the tool call being gated + */ + toolArgs?: JsonValue; + /** + * Tool call ID that triggered this permission request + */ + toolCallId?: string; + /** + * Name of the tool the hook is gating + */ + toolName: string; +} +/** + * Extension management permission prompt + */ +export interface PermissionPromptRequestExtensionManagement { + /** + * Assisted-approval judge information for this request; present only in assisted mode. + * + * @experimental + */ + assistedApproval?: PermissionAssistedApproval; + /** + * Name of the extension being managed + */ + extensionName?: string; + /** + * Prompt kind discriminator + */ + kind: "extension-management"; + /** + * The extension management operation (scaffold, reload) + */ + operation: string; + /** + * Tool call ID that triggered this permission request + */ + toolCallId?: string; +} +/** + * Factory run or authoring permission prompt + */ +export interface PermissionPromptRequestFactory { + /** + * Canonical key used for scoped factory approvals + */ + approvalKey: string; + /** + * Assisted-approval judge information for this request; present only in assisted mode. + * + * @experimental + */ + assistedApproval?: PermissionAssistedApproval; + /** + * Whether this factory is eligible for persistent approval + */ + canPersistApproval: boolean; + /** + * Factory-declared AI-credit limit before any run/resume caller override is applied. + */ + declaredMaxAiCredits?: number; + /** + * Factory-declared concurrent-subagent limit before any run/resume caller override is applied. + */ + declaredMaxConcurrentSubagents?: number; + /** + * Factory-declared total-subagent limit before any run/resume caller override is applied. + */ + declaredMaxTotalSubagents?: number; + /** + * Factory-declared active-time limit in seconds before any run/resume caller override is applied. + */ + declaredTimeoutSeconds?: number; + /** + * Factory description + */ + description: string; + /** + * Prompt kind discriminator + */ + kind: "factory"; + /** + * 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; /** - * Prompt kind discriminator + * Declared factory phases */ - kind: "hook"; + phases: FactoryPermissionPhase[]; /** - * Arguments of the tool call being gated + * Effective active-time limit in seconds; omitted means unlimited */ - toolArgs?: { - [k: string]: unknown | undefined; - }; + timeoutSeconds?: number; /** * Tool call ID that triggered this permission request */ toolCallId?: string; - /** - * Name of the tool the hook is gating - */ - toolName: string; } /** - * Extension management permission prompt + * Extension permission access prompt */ -export interface PermissionPromptRequestExtensionManagement { +export interface PermissionPromptRequestExtensionPermissionAccess { /** - * Auto-approval judge information for this request; present only when auto mode is enabled. + * Assisted-approval judge information for this request; present only in assisted mode. * * @experimental */ - autoApproval?: PermissionAutoApproval; + assistedApproval?: PermissionAssistedApproval; /** - * Name of the extension being managed + * Capabilities the extension is requesting */ - extensionName?: string; + capabilities: string[]; /** - * Prompt kind discriminator + * Name of the extension requesting permission access */ - kind: "extension-management"; + extensionName: string; /** - * The extension management operation (scaffold, reload) + * Prompt kind discriminator */ - operation: string; + kind: "extension-permission-access"; /** * Tool call ID that triggered this permission request */ toolCallId?: string; } /** - * Extension permission access prompt + * Extension sensitive environment variable access prompt */ -export interface PermissionPromptRequestExtensionPermissionAccess { +export interface PermissionPromptRequestExtensionEnvAccess { /** - * Auto-approval judge information for this request; present only when auto mode is enabled. + * Assisted-approval judge information for this request; present only in assisted mode. * * @experimental */ - autoApproval?: PermissionAutoApproval; + assistedApproval?: PermissionAssistedApproval; /** - * Capabilities the extension is requesting + * Names of the sensitive environment variables the extension is requesting. Values never appear here. + * + * @minItems 1 */ - capabilities: string[]; + environmentVariables: [string, ...string[]]; /** - * Name of the extension requesting permission access + * Name of the extension requesting environment variable access */ extensionName: string; /** * Prompt kind discriminator */ - kind: "extension-permission-access"; + kind: "extension-env-access"; /** * Tool call ID that triggered this permission request */ @@ -6862,6 +8579,10 @@ export interface PermissionApproved { * The permission request was approved */ kind: "approved"; + /** + * Whether a managed approval policy already handled this request + */ + managedApprovalHandled?: boolean; } /** * Permission response variant that approves a request and remembers the provided approval for the rest of the session. @@ -6872,6 +8593,10 @@ export interface PermissionApprovedForSession { * Approved and remembered for the rest of the session */ kind: "approved-for-session"; + /** + * Whether a managed approval policy already handled this request + */ + managedApprovalHandled?: boolean; } /** * Session-scoped tool-approval rule for specific shell command identifiers. @@ -6956,6 +8681,19 @@ export interface UserToolSessionApprovalExtensionManagement { */ operation?: string; } +/** + * 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. */ @@ -6969,6 +8707,25 @@ export interface UserToolSessionApprovalExtensionPermissionAccess { */ kind: "extension-permission-access"; } +/** + * Session-scoped tool-approval rule for an extension's access to sensitive environment variables, keyed by extension name and the exact set of variable names. + */ +export interface UserToolSessionApprovalExtensionEnvAccess { + /** + * Names of the sensitive environment variables this approval covers. Values are never persisted. + * + * @minItems 1 + */ + environmentVariables: [string, ...string[]]; + /** + * Extension name + */ + extensionName: string; + /** + * Extension environment access approval kind + */ + kind: "extension-env-access"; +} /** * Permission response variant that approves a request and persists the provided approval to a project location key. */ @@ -6982,6 +8739,10 @@ export interface PermissionApprovedForLocation { * The location key (git root or cwd) to persist the approval to */ locationKey: string; + /** + * Whether a managed approval policy already handled this request + */ + managedApprovalHandled?: boolean; } /** * Permission response variant indicating the request was cancelled before use, with an optional reason. @@ -7249,7 +9010,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 @@ -7306,12 +9067,6 @@ export interface ElicitationCompletedData { */ requestId: string; } -/** - * Opaque JSON value submitted for one field in accepted `elicitation.completed` form content. - */ -export interface ElicitationCompletedContent { - [k: string]: unknown | undefined; -} /** * Session event "sampling.requested". Sampling request from an MCP server; contains the server name and a requestId for correlation */ @@ -7349,9 +9104,7 @@ export interface SamplingRequestedData { /** * The JSON-RPC request ID from the MCP protocol */ - mcpRequestId: { - [k: string]: unknown | undefined; - }; + mcpRequestId: JsonValue; /** * Unique identifier for this sampling request; used to respond via session.respondToSampling() */ @@ -7700,18 +9453,66 @@ export interface CustomNotificationData { */ version?: number; } -/** - * Source-defined JSON payload for the custom notification - */ -export interface CustomNotificationPayload { - [k: string]: unknown | undefined; -} /** * Optional source-defined string identifiers describing the payload subject */ export interface CustomNotificationSubject { [k: string]: string | undefined; } +/** + * Session event "ui.ephemeral_query". Ordered output and terminal state for a transient query that does not modify conversation history. + */ +/** @experimental */ +export interface UIEphemeralQueryEvent { + /** + * Sub-agent instance identifier. Absent for events from the root/main agent and session-level events. + */ + agentId?: string; + data: UIEphemeralQueryData; + /** + * 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 "ui.ephemeral_query". + */ + type: "ui.ephemeral_query"; +} +/** + * Ordered output and terminal state for a transient query that does not modify conversation history. + */ +/** @experimental */ +export interface UIEphemeralQueryData { + /** + * Full response text, present for the `completed` phase. + */ + answer?: string; + /** + * Ordered text delta, present for the `chunk` phase. + */ + chunk?: string; + /** + * Model or transport failure message, present for the `failed` phase. + */ + error?: string; + phase: UIEphemeralQueryPhase; + /** + * Runtime-minted query identifier. + */ + requestId: string; +} /** * Session event "external_tool.requested". External tool invocation request for client-side tool execution */ @@ -7749,9 +9550,11 @@ export interface ExternalToolRequestedData { /** * Arguments to pass to the external tool */ - arguments?: { - [k: string]: unknown | undefined; - }; + arguments?: JsonValue; + /** + * Stable provider identity captured with an extension-owned tool definition; hosts use it to route the request to the same provider that was offered to the model + */ + providerId?: string | null; /** * Unique identifier for this request; used to respond via session.respondToExternalTool() */ @@ -8177,6 +9980,10 @@ export interface AutoModeResolvedEvent { */ /** @experimental */ export interface AutoModeResolvedData { + /** + * Models offered to the router for this resolution + */ + availableModels?: string[]; /** * Ordered candidate model list the router returned, when not a fallback */ @@ -8191,18 +9998,50 @@ export interface AutoModeResolvedData { * The concrete model the session will use after any intent refinement */ 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 "session.managed_settings_resolved". Enterprise managed-settings resolution: the effective managed settings the session applied and where they came from, so SDK clients can show users what is enterprise-managed and by which authority. 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; for a session-independent pull, use the SDK `getManagedSettings()` API, which returns the identical payload. Managed settings have a single authoritative source, so the highest-authority present layer (server > device) wins wholesale; `bypassPermissionsDisabled` is deny-wins across layers. Marked experimental while the managed-settings surface stabilizes. + * 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 */ export interface ManagedSettingsResolvedEvent { @@ -8233,7 +10072,7 @@ export interface ManagedSettingsResolvedEvent { type: "session.managed_settings_resolved"; } /** - * Enterprise managed-settings resolution: the effective managed settings the session applied and where they came from, so SDK clients can show users what is enterprise-managed and by which authority. 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; for a session-independent pull, use the SDK `getManagedSettings()` API, which returns the identical payload. Managed settings have a single authoritative source, so the highest-authority present layer (server > device) wins wholesale; `bypassPermissionsDisabled` is deny-wins across layers. Marked experimental while the managed-settings surface stabilizes. + * 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 */ export interface ManagedSettingsResolvedData { @@ -8242,7 +10081,11 @@ export interface ManagedSettingsResolvedData { */ bypassPermissionsDisabled: boolean; /** - * Whether the device (MDM/plist/registry/file) managed-settings layer was present + * Whether a session-local permissions layer injected by the SDK host was present + */ + clientManaged?: boolean; + /** + * Whether an actual device MDM/plist/registry/file managed-settings layer was present */ deviceManaged: boolean; /** @@ -8253,6 +10096,14 @@ export interface ManagedSettingsResolvedData { * 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 effective sandbox policy forces the sandbox on *only* because managed policy could not be determined, rather than because the policy requires it. Lets clients tell a user whose `--no-sandbox` was overridden that the sandbox stayed on as a fail-closed fallback, instead of attributing it to an administrator who set no such policy. + */ + sandboxEnabledByUndeterminedPolicy?: boolean; /** * Whether the server (account/org) managed-settings layer was present */ @@ -8260,9 +10111,7 @@ export interface ManagedSettingsResolvedData { /** * The effective (resolved) managed settings values, so clients can render exactly what is enforced. Absent when no managed policy is in force. */ - settings?: { - [k: string]: unknown | undefined; - }; + settings?: JsonValue; source: ManagedSettingsResolvedSource; } /** @@ -8459,6 +10308,10 @@ export interface ExitPlanModeRequestedData { * Available actions the user can take */ actions: ExitPlanModeAction[]; + /** + * Model the session had selected when the plan was authored, when one is known + */ + model?: string; /** * Full content of the plan file */ @@ -8598,6 +10451,158 @@ export interface BackgroundTasksChangedEvent { * Empty payload for `session.background_tasks_changed`, indicating background task state changed. */ export interface BackgroundTasksChangedData {} +/** + * 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; + /** + * Factory run identifier. + */ + runId: string; +} +/** + * Session event "factory.run_started". Ephemeral signal that a factory run attempt began executing. + */ +/** @experimental */ +export interface FactoryRunStartedEvent { + /** + * Sub-agent instance identifier. Absent for events from the root/main agent and session-level events. + */ + agentId?: string; + data: FactoryRunStartedData; + /** + * 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_started". + */ + type: "factory.run_started"; +} +/** + * Ephemeral signal that a factory run attempt began executing. + */ +/** @experimental */ +export interface FactoryRunStartedData { + /** + * Attempt number this start committed; a resumed run increments it. + */ + attempt: number; + /** + * Name of the factory this run executes. Low cardinality by construction. + */ + factoryName: string; + /** + * Identifier of the factory run that started. + */ + runId: string; +} +/** + * Session event "factory.run_settled". Ephemeral signal that a factory run reached a terminal status. + */ +/** @experimental */ +export interface FactoryRunSettledEvent { + /** + * Sub-agent instance identifier. Absent for events from the root/main agent and session-level events. + */ + agentId?: string; + data: FactoryRunSettledData; + /** + * 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_settled". + */ + type: "factory.run_settled"; +} +/** + * Ephemeral signal that a factory run reached a terminal status. + */ +/** @experimental */ +export interface FactoryRunSettledData { + /** + * AI credits this run consumed, in nano-AIU. + */ + consumedNanoAiu: number; + /** + * Subagents this run consumed against its limits. + */ + consumedSubagents: number; + /** + * Active milliseconds accumulated across every attempt of this run. + */ + elapsedMs: number; + /** + * Typed failure class recorded on the run, when it failed with one (e.g. `factory_limit_reached`). + */ + failureType?: string; + /** + * Identifier of the factory run that settled. + */ + runId: string; + status: FactoryRunSettledStatus; +} /** * Session event "session.skills_loaded". Payload of `session.skills_loaded` listing resolved skill metadata. */ @@ -8645,6 +10650,10 @@ 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 */ @@ -9066,9 +11075,7 @@ export interface CanvasOpenedData { /** * Input supplied when the instance was opened */ - input?: { - [k: string]: unknown | undefined; - }; + input?: JsonValue; /** * Stable caller-supplied canvas instance identifier */ @@ -9163,9 +11170,7 @@ export interface CanvasRegistryChangedCanvas { /** * JSON Schema for canvas open input */ - inputSchema?: { - [k: string]: unknown | undefined; - }; + inputSchema?: JsonValue; } /** * A single action within a canvas declaration, with its name, optional description, and optional input schema. @@ -9179,9 +11184,7 @@ export interface CanvasRegistryChangedCanvasAction { /** * JSON Schema for action input */ - inputSchema?: { - [k: string]: unknown | undefined; - }; + inputSchema?: JsonValue; /** * Action name */ @@ -9332,9 +11335,7 @@ export interface CanvasRecordedData { /** * Input supplied when the instance was opened */ - input?: { - [k: string]: unknown | undefined; - }; + input?: JsonValue; /** * Stable caller-supplied canvas instance identifier */ @@ -9470,7 +11471,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 @@ -9481,7 +11482,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 diff --git a/nodejs/src/index.ts b/nodejs/src/index.ts index 352afc6a94..9d55ab1d10 100644 --- a/nodejs/src/index.ts +++ b/nodejs/src/index.ts @@ -9,9 +9,10 @@ */ export { CopilotClient } from "./client.js"; -export { RuntimeConnection } from "./types.js"; +export { DisableBypassPermissionsModes, 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,12 +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 @@ -39,13 +42,15 @@ 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, @@ -60,6 +65,9 @@ export type { AgentStopHandler, AgentStopHookInput, AgentStopHookOutput, + UserPromptTransformedHandler, + UserPromptTransformedHookInput, + UserPromptTransformedHookOutput, CopilotClientMode, CopilotClientOptions, CopilotExpAssignmentResponse, @@ -85,19 +93,29 @@ export type { ForegroundSessionInfo, GetAuthStatusResponse, GetStatusResponse, + GitHubMcpToolConfig, GitHubTelemetryNotification, GitHubTelemetryEvent, GitHubTelemetryClientInfo, + GitHubTokenAcquireReason, + GitHubTokenAcquireResult, + GitHubTokenProvider, + GitHubTokenProviderArgs, + GitHubTokenProviderResult, InfiniteSessionConfig, LargeToolOutputConfig, MemoryConfiguration, UiInputOptions, + FactoryLimits, + FactoryMeta, MCPStdioServerConfig, MCPHTTPServerConfig, MCPServerConfig, DefaultAgentConfig, BearerTokenProvider, MessageOptions, + ManagedSettings, + ManagedSettingsPermissions, ModelBilling, ModelBillingTokenPrices, ModelBillingTokenPricesLongContext, @@ -109,7 +127,15 @@ export type { NamedProviderConfig, PermissionHandler, PermissionRequest, + PermissionRequestedData, + PermissionRequestedEvent, PermissionRequestResult, + AttributedPermissionResult, + PermissionDecisionContext, + PermissionDecisionOutcome, + PermissionDecisionSource, + PermissionDecisionSurface, + PermissionResponseCapability, ProviderConfig, ProviderModelConfig, ProviderTokenArgs, @@ -145,6 +171,8 @@ export type { SessionFsSqliteQueryResult, SessionFsSqliteQueryType, SessionFsSqliteProvider, + SessionFsSqliteStatement, + SessionFsSqliteTransactionErrorClass, CopilotRequestContext, SystemMessageAppendConfig, SystemMessageConfig, @@ -165,3 +193,26 @@ export type { 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 89403ade7b..65ff00921c 100644 --- a/nodejs/src/session.ts +++ b/nodejs/src/session.ts @@ -7,6 +7,7 @@ * @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"; @@ -15,10 +16,13 @@ import type { 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, @@ -38,6 +42,7 @@ import type { McpAuthRequest, PermissionHandler, PermissionRequest, + PermissionRequestResult, ContextTier, ReasoningEffort, ReasoningSummary, @@ -60,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. @@ -103,6 +157,227 @@ function isOpenCanvasInstance(value: unknown): value is OpenCanvasInstance { ); } +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; @@ -147,6 +422,8 @@ export class CopilotSession { 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; @@ -157,13 +434,176 @@ 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; + private onDisconnected?: () => void; /** @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. * @@ -178,10 +618,16 @@ export class CopilotSession { private connection: MessageConnection, private _workspacePath?: string, traceContextProvider?: TraceContextProvider, - options?: { mcpAuthHandler?: McpAuthHandler } + options?: { + mcpAuthHandler?: McpAuthHandler; + managedSettingsEnabled?: boolean; + onDisconnected?: () => void; + } ) { this.traceContextProvider = traceContextProvider; this.mcpAuthHandler = options?.mcpAuthHandler; + this.managedSettingsEnabled = options?.managedSettingsEnabled === true; + this.onDisconnected = options?.onDisconnected; } /** @@ -305,11 +751,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; @@ -319,12 +764,12 @@ export class CopilotSession { const unsubscribe = this.on((event) => { if (event.type === "assistant.message") { lastAssistantMessage = event; - } else if (event.type === "session.idle") { - resolveIdle(); + } else if (event.type === "session.idle" && event.data.mode !== "autopilot") { + 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 }); } }); @@ -343,7 +788,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 { @@ -356,7 +804,11 @@ export class CopilotSession { /** @internal */ _markDisconnected(): void { + if (this.disconnected) { + return; + } this.disconnected = true; + this._runOnDisconnected(); this.eventHandlers.clear(); this.typedEventHandlers.clear(); this.toolHandlers.clear(); @@ -367,9 +819,27 @@ export class CopilotSession { 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(); } + /** @internal */ + _runOnDisconnected(): void { + this.onDisconnected?.(); + this.onDisconnected = undefined; + } + + /** @internal */ + _setOnDisconnected(callback: () => void): void { + this.onDisconnected = callback; + } + /** * Subscribes to events from this session. * @@ -686,20 +1156,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; } if (this.disconnected) { return; } - await this.rpc.permissions.handlePendingPermissionRequest({ requestId, result }); - } catch (_error) { + 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, @@ -881,6 +1366,185 @@ 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. @@ -978,7 +1642,13 @@ export class CopilotSession { } try { const result = await this.elicitationHandler(context); - await this.rpc.ui.handlePendingElicitation({ requestId, result }); + await this.rpc.ui.handlePendingElicitation({ + requestId, + result: { + action: result.action, + ...(result.content ? { content: result.content } : {}), + }, + }); } catch { // Handler failed β€” attempt to cancel so the request doesn't hang try { @@ -1264,6 +1934,7 @@ 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, @@ -1460,3 +2131,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 0bc1987503..ecb18a5702 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. */ @@ -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 5f89ca3bed..616e15a467 100644 --- a/nodejs/src/types.ts +++ b/nodejs/src/types.ts @@ -11,12 +11,18 @@ 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 { FactoryJsonSchema, JsonValue } from "./factory.js"; import type { + GitHubTokenAcquireRequest, + GitHubTokenAcquireResult, GitHubTelemetryNotification, ModelBillingTokenPrices, OpenCanvasInstance, @@ -27,15 +33,45 @@ import type { ToolSet } from "./toolSet.js"; export type { RemoteSessionMode } from "./generated/rpc.js"; export type { CurrentToolMetadata } from "./generated/rpc.js"; export type { + GitHubTokenAcquireReason, + GitHubTokenAcquireResult, GitHubTelemetryNotification, GitHubTelemetryEvent, GitHubTelemetryClientInfo, } from "./generated/rpc.js"; + +/** + * Arguments passed to a session's {@link GitHubTokenProvider}. + * + * The callback registration identifier is intentionally kept inside the SDK. + */ +export type GitHubTokenProviderArgs = Pick< + GitHubTokenAcquireRequest, + "host" | "sessionId" | "reason" +>; + +/** Tagged token or cancellation returned by a {@link GitHubTokenProvider}. */ +export type GitHubTokenProviderResult = GitHubTokenAcquireResult; + +/** + * Acquires a GitHub token for one session. + * + * A token result must include `expiresIn`: the positive number of seconds of + * remaining lifetime when the callback completes. Production GitHub tokens + * typically last eight hours. Initial cancellation, callback errors, and + * invalid token responses reject session creation or resume instead of falling + * back to ambient authentication. + */ +export type GitHubTokenProvider = ( + args: GitHubTokenProviderArgs +) => GitHubTokenProviderResult | Promise; export type { ModelBillingTokenPrices, ModelBillingTokenPricesLongContext, } from "./generated/rpc.js"; -export type SessionEvent = GeneratedSessionEvent; +export type SessionEvent = + | Exclude + | PermissionRequestedEvent; export type { ReasoningSummary } from "./generated/session-events.js"; export type { SessionFsProvider } from "./sessionFsProvider.js"; export { createSessionFsAdapter } from "./sessionFsProvider.js"; @@ -43,7 +79,17 @@ 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, + PermissionResponseCapability, +} from "./generated/rpc.js"; export type { CopilotRequestContext } from "./copilotRequestHandler.js"; export { CopilotRequestHandler, @@ -295,6 +341,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"`). @@ -443,7 +496,7 @@ export type ToolBinaryResult = { description?: string; }; -export type ToolTelemetry = Record | undefined>; +export type ToolTelemetry = Record | undefined>; export type ToolResultObject = { textResultForLlm: string; @@ -648,6 +701,17 @@ export interface Tool { * 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; } /** @@ -664,6 +728,7 @@ export function defineTool( skipPermission?: boolean; defer?: "auto" | "never"; metadata?: Record; + isTerminal?: boolean; } ): Tool { return { name, ...config }; @@ -1092,16 +1157,33 @@ export type SystemMessageConfig = | SystemMessageReplaceConfig | SystemMessageCustomizeConfig; +import type { PermissionDecisionRequest, PermissionDecisionContext } from "./generated/rpc.js"; + /** * Permission request types from the server. This is the generated * discriminated union from the runtime schema β€” switch on `kind` to * access the variant-specific fields (e.g. shell `commands`, write * `fileName`/`diff`, mcp `toolName`/`args`). + * + * `managedApprovalRequired` indicates that managed policy requires an explicit + * user decision. Hosts should bypass automatic approval and present their + * normal confirmation UI. The runtime currently emits it for managed Shell, + * Read, Edit, and Domain selector asks. */ -export type { PermissionRequest } from "./generated/session-events.js"; -import type { PermissionRequest } from "./generated/session-events.js"; +export type PermissionRequest = GeneratedPermissionRequest & { + readonly managedApprovalRequired?: boolean; +}; -import type { PermissionDecisionRequest } from "./generated/rpc.js"; +export type PermissionRequestedData = Omit< + GeneratedPermissionRequestedData, + "permissionRequest" +> & { + permissionRequest: PermissionRequest; +}; + +export type PermissionRequestedEvent = Omit & { + data: PermissionRequestedData; +}; /** * Permission decision result returned from a {@link PermissionHandler}. @@ -1111,12 +1193,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 => ({ @@ -1398,6 +1535,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 */ @@ -1554,6 +1718,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 */ @@ -1784,7 +1953,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 @@ -1889,6 +2058,68 @@ export interface CanvasProviderIdentity { 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). * @@ -1953,6 +2184,67 @@ export interface CopilotExpAssignmentResponse { 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; +} + +/** Well-known managed bypass-permissions policies. */ +export const DisableBypassPermissionsModes = { + /** Turn off bypass-permissions mode entirely. */ + Disable: "disable", + /** Permit automatic bypass but block full allow-all. */ + AllowAutoOnly: "allow-auto-only", +} as const; + +/** + * 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 { + /** + * Restricts bypass-permissions mode for the session. See + * {@link DisableBypassPermissionsModes} for well-known values. Unknown + * values are forwarded so newer runtime policies fail closed. + */ + disableBypassPermissionsMode?: string; + /** 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 @@ -1983,6 +2275,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. @@ -2007,13 +2305,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 */ @@ -2132,6 +2425,13 @@ export interface SessionConfigBase { */ excludedBuiltinAgents?: string[]; + /** + * Built-in skill names to include in the session. In `mode: "empty"`, + * omitting this option excludes all runtime-bundled skills; specifying names + * opts those built-ins back in. Skills from other sources remain eligible. + */ + includedBuiltinSkills?: string[]; + /** * Custom provider configuration (BYOK - Bring Your Own Key). * When specified, uses the provided API endpoint instead of the Copilot API. @@ -2188,6 +2488,14 @@ export interface SessionConfigBase { */ 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. * @@ -2287,6 +2595,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. @@ -2311,6 +2627,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 @@ -2396,6 +2719,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. @@ -2420,6 +2750,16 @@ export interface SessionConfigBase { */ gitHubToken?: string; + /** + * Acquires short-lived GitHub credentials for this session on demand. + * + * Mutually exclusive with {@link SessionConfigBase.gitHubToken}. The + * callback receives the effective GitHub host, the session ID when known, + * and whether this is the initial acquisition or a refresh. Its opaque + * registration ID remains internal to the SDK. + */ + gitHubTokenProvider?: GitHubTokenProvider; + /** * Opt-in: when true, the runtime self-fetches enterprise managed settings * (bypass-permissions policy) at session bootstrap using the session's @@ -2428,6 +2768,31 @@ export interface SessionConfigBase { */ 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 bypass-mode + * restrictions are composed fail-closed. + * + * 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 @@ -2570,6 +2935,20 @@ export interface ResumeSessionConfig extends SessionConfigBase { openCanvases?: OpenCanvasInstance[]; } +/** + * Options that only an extension join may supply, kept off {@link ResumeSessionConfig} + * because the runtime ignores them for every other kind of connection. + * + * @internal + */ +export interface ExtensionJoinOptions { + /** + * Names of sensitive environment variables the extension asks the host to grant. + * Sent on the `session.resume` wire payload as `requestedEnvironmentVariables`. + */ + requestedEnvironmentVariables?: string[]; +} + /** * Arguments passed to a {@link BearerTokenProvider} callback when the runtime needs a * fresh bearer token for a BYOK provider. diff --git a/nodejs/test/client.test.ts b/nodejs/test/client.test.ts index 77149bc4b9..3ffda2fa71 100644 --- a/nodejs/test/client.test.ts +++ b/nodejs/test/client.test.ts @@ -1,13 +1,19 @@ /* 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, + DisableBypassPermissionsModes, RuntimeConnection, type GitHubTelemetryNotification, + type ManagedSettings, type ModelInfo, } from "../src/index.js"; import { CopilotSession } from "../src/session.js"; @@ -19,7 +25,86 @@ 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()); @@ -46,6 +131,91 @@ 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; @@ -102,6 +272,55 @@ describe("CopilotClient", () => { }); }); + 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( @@ -184,6 +403,42 @@ describe("CopilotClient", () => { ); }); + 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(); @@ -369,6 +624,99 @@ describe("CopilotClient", () => { expect(payload.openCanvasInstances).toBeUndefined(); }); + it("forwards an extension environment request and applies the grant to process.env", async () => { + const client = new CopilotClient(); + await client.start(); + onTestFinished(() => stopClient(client)); + onTestFinished(() => { + delete process.env.SDK_TEST_GRANTED_TOKEN; + }); + + const spy = vi + .spyOn((client as any).connection!, "sendRequest") + .mockImplementation(async (method: string, params: any) => { + if (method === "session.resume") { + return { + sessionId: params.sessionId, + grantedEnvironmentVariables: { SDK_TEST_GRANTED_TOKEN: "granted-value" }, + }; + } + throw new Error(`Unexpected method: ${method}`); + }); + + await client.resumeSessionForExtension( + "session-env", + { onPermissionRequest: defaultJoinSessionPermissionHandler }, + undefined, + { requestedEnvironmentVariables: ["SDK_TEST_GRANTED_TOKEN"] } + ); + + const payload = spy.mock.calls.find(([method]) => method === "session.resume")![1] as any; + expect(payload.requestedEnvironmentVariables).toEqual(["SDK_TEST_GRANTED_TOKEN"]); + expect(process.env.SDK_TEST_GRANTED_TOKEN).toBe("granted-value"); + }); + + it("ignores granted variables the extension never requested", async () => { + const client = new CopilotClient(); + await client.start(); + onTestFinished(() => stopClient(client)); + onTestFinished(() => { + delete process.env.SDK_TEST_GRANTED_TOKEN; + }); + + vi.spyOn((client as any).connection!, "sendRequest").mockImplementation( + async (method: string, params: any) => { + if (method === "session.resume") { + return { + sessionId: params.sessionId, + grantedEnvironmentVariables: { + SDK_TEST_GRANTED_TOKEN: "granted-value", + SDK_TEST_SMUGGLED: "not-approved", + }, + }; + } + throw new Error(`Unexpected method: ${method}`); + } + ); + + await client.resumeSessionForExtension( + "session-env-extra", + { onPermissionRequest: defaultJoinSessionPermissionHandler }, + undefined, + { requestedEnvironmentVariables: ["SDK_TEST_GRANTED_TOKEN"] } + ); + + expect(process.env.SDK_TEST_GRANTED_TOKEN).toBe("granted-value"); + // The user approved one name, so a host answering with a second one + // cannot widen the grant. + expect(process.env.SDK_TEST_SMUGGLED).toBeUndefined(); + }); + + it("omits the environment request when a resume does not ask for one", 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, + grantedEnvironmentVariables: { SDK_TEST_UNREQUESTED: "leaked" }, + }; + } + throw new Error(`Unexpected method: ${method}`); + }); + + await client.resumeSession("session-no-env", { onPermissionRequest: approveAll }); + + const payload = spy.mock.calls.find(([method]) => method === "session.resume")![1] as any; + expect(payload).not.toHaveProperty("requestedEnvironmentVariables"); + // A grant is only honored for a request this client actually made. + expect(process.env.SDK_TEST_UNREQUESTED).toBeUndefined(); + }); + it("forwards reasoningSummary in session.create and session.resume", async () => { const client = new CopilotClient(); await client.start(); @@ -401,6 +749,100 @@ describe("CopilotClient", () => { 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(); @@ -498,6 +940,68 @@ describe("CopilotClient", () => { 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(); @@ -514,12 +1018,14 @@ describe("CopilotClient", () => { 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 }, }); @@ -531,9 +1037,11 @@ describe("CopilotClient", () => { ([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 }); }); @@ -814,6 +1322,7 @@ describe("CopilotClient", () => { }); const pluginDirs = ["/tmp/plugins/a", "/tmp/plugins/b"]; + const disabledMcpServers = ["local-files", "remote-github"]; const largeOutput = { enabled: true, maxSizeBytes: 1024, @@ -828,11 +1337,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, }); @@ -843,8 +1354,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); }); @@ -1445,6 +1958,134 @@ describe("CopilotClient", () => { spy.mockRestore(); }); + it("sends includedBuiltinSkills=[] in the empty-mode post-create options patch", 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 patch = spy.mock.calls.find((c) => c[0] === "session.options.update")![1] as any; + expect(patch.includedBuiltinSkills).toEqual([]); + expect(patch.installedPlugins).toEqual([]); + }); + + it("sends includedBuiltinSkills=[] in the empty-mode post-resume options patch", 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: [] }); + spy.mockClear(); + await client.resumeSession("s1", { onPermissionRequest: approveAll, availableTools: [] }); + + const patch = spy.mock.calls.find((c) => c[0] === "session.options.update")![1] as any; + expect(patch.includedBuiltinSkills).toEqual([]); + }); + + it("preserves an explicit built-in skill allowlist after empty-mode resume", 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) => { + if (method === "session.resume") return { sessionId: "s1" }; + if (method === "session.options.update") return { success: true }; + throw new Error(`Unexpected method: ${method}`); + }); + await client.resumeSession("s1", { + onPermissionRequest: approveAll, + availableTools: [], + includedBuiltinSkills: ["code-review"], + }); + + const patch = spy.mock.calls.find((c) => c[0] === "session.options.update")![1] as any; + expect(patch.includedBuiltinSkills).toEqual(["code-review"]); + }); + + it("keeps includedBuiltinSkills=[] even when the caller opts into custom skills 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: [], + enableSkills: true, + skillDirectories: ["/tmp/custom-skills"], + }); + + const createPayload = spy.mock.calls.find((c) => c[0] === "session.create")![1] as any; + expect(createPayload.enableSkills).toBe(true); + expect(createPayload.skillDirectories).toEqual(["/tmp/custom-skills"]); + const patch = spy.mock.calls.find((c) => c[0] === "session.options.update")![1] as any; + expect(patch.includedBuiltinSkills).toEqual([]); + }); + + it("preserves an explicit built-in skill allowlist 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 }; + if (method === "session.options.update") return { success: true }; + throw new Error(`Unexpected method: ${method}`); + }); + await client.createSession({ + onPermissionRequest: approveAll, + availableTools: [], + includedBuiltinSkills: ["code-review"], + }); + + const patch = spy.mock.calls.find((c) => c[0] === "session.options.update")![1] as any; + expect(patch.includedBuiltinSkills).toEqual(["code-review"]); + }); + + it("does not send includedBuiltinSkills in copilot-cli mode", 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 patch = spy.mock.calls.find((c) => c[0] === "session.options.update"); + // copilot-cli mode sends no post-create options patch at all here. + if (patch) { + expect((patch[1] as any).includedBuiltinSkills).toBeUndefined(); + } + const createPayload = spy.mock.calls.find((c) => c[0] === "session.create")![1] as any; + expect(createPayload.includedBuiltinSkills).toBeUndefined(); + spy.mockRestore(); + }); + it("forwards continuePendingWork in session.resume request", async () => { const client = new CopilotClient(); await client.start(); @@ -2608,7 +3249,7 @@ describe("CopilotClient", () => { const payload = spy.mock.calls.find((c) => c[0] === "session.create")![1] as any; expect(payload.commands).toEqual([ { name: "deploy", description: "Deploy the app" }, - { name: "rollback", description: undefined }, + { name: "rollback", description: "" }, ]); }); @@ -3139,16 +3780,47 @@ 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: - // clientGlobalHandlers.hooks.invoke({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(() => stopClient(client)); @@ -3172,7 +3844,7 @@ describe("CopilotClient", () => { cwd: "/tmp", }; - const response = await (client as any).clientGlobalHandlers.hooks.invoke({ + const response = await (client as any).handleHooksInvoke({ sessionId: session.sessionId, hookType: "postToolUseFailure", input: failureInput, @@ -3249,7 +3921,7 @@ describe("CopilotClient", () => { }, }); - const response = await (client as any).clientGlobalHandlers.hooks.invoke({ + const response = await (client as any).handleHooksInvoke({ sessionId: session.sessionId, hookType: "agentStop", input: { @@ -3345,3 +4017,128 @@ describe("CopilotClient", () => { }); }); }); + +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 managedSettings = { + permissions: { + disableBypassPermissionsMode: DisableBypassPermissionsModes.AllowAutoOnly, + deny: ["Shell(git push)"], + ask: ["Domain(publish.example)"], + allow: ["Read(**)"], + }, + } satisfies ManagedSettings; + const params = await captureCreateParams({ + managedSettings, + }); + expect(params.managedSettings).toEqual({ + permissions: { + disableBypassPermissionsMode: "allow-auto-only", + deny: ["Shell(git push)"], + ask: ["Domain(publish.example)"], + allow: ["Read(**)"], + }, + }); + }); + + it("forwards the disable bypass-permissions mode", async () => { + const managedSettings = { + permissions: { + disableBypassPermissionsMode: DisableBypassPermissionsModes.Disable, + }, + } satisfies ManagedSettings; + const params = await captureCreateParams({ managedSettings }); + + expect(params.managedSettings).toEqual({ + permissions: { + disableBypassPermissionsMode: "disable", + }, + }); + }); + + it("forwards unknown bypass-permissions modes", async () => { + const managedSettings = { + permissions: { + disableBypassPermissionsMode: "future-fail-closed-mode", + }, + } satisfies ManagedSettings; + const params = await captureCreateParams({ managedSettings }); + + expect(params.managedSettings).toEqual(managedSettings); + }); + + 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/client.e2e.test.ts b/nodejs/test/e2e/client.e2e.test.ts index 89489f78e6..35e7440766 100644 --- a/nodejs/test/e2e/client.e2e.test.ts +++ b/nodejs/test/e2e/client.e2e.test.ts @@ -1,5 +1,5 @@ import { ChildProcess } from "child_process"; -import { describe, expect, it, onTestFinished } from "vitest"; +import { describe, expect, it, onTestFinished, vi } from "vitest"; import { approveAll, CopilotClient, RuntimeConnection } from "../../src/index.js"; import { isInProcessTransport } from "./harness/sdkTestContext.js"; @@ -95,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) { diff --git a/nodejs/test/e2e/client_options.e2e.test.ts b/nodejs/test/e2e/client_options.e2e.test.ts index e207f275ab..e3dc41343b 100644 --- a/nodejs/test/e2e/client_options.e2e.test.ts +++ b/nodejs/test/e2e/client_options.e2e.test.ts @@ -93,7 +93,7 @@ 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; @@ -329,6 +329,7 @@ describe("Client options", async () => { enableConfigDiscovery: true, enableOnDemandInstructionDiscovery: true, includeSubAgentStreamingEvents: false, + customAgentsLocalOnly: false, }); const updatedRaw = fs.readFileSync(capturePath, "utf8"); @@ -339,6 +340,7 @@ describe("Client options", async () => { enableConfigDiscovery?: boolean; enableOnDemandInstructionDiscovery?: boolean; includeSubAgentStreamingEvents?: boolean; + customAgentsLocalOnly?: boolean; }; }[]; }; @@ -347,8 +349,83 @@ 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 () => { 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 0000000000..611898f11d --- /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 so session initialization settles before assertions. + 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); + await waitForMcpStatus(enabledSession, "github-mcp-server", "connected"); + const requestsBeforeFirstMessage = await mcpRequestCount(); + expect(requestsBeforeFirstMessage).toBeGreaterThan(0); + expectSyntheticResponse( + await enabledSession.sendAndWait({ prompt: MCP_TRIGGER_PROMPT }) + ); + await waitForMcpRequestCount(requestsBeforeFirstMessage + 1); + } + ); + + 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/extension_env_access.e2e.test.ts b/nodejs/test/e2e/extension_env_access.e2e.test.ts new file mode 100644 index 0000000000..f034db9051 --- /dev/null +++ b/nodejs/test/e2e/extension_env_access.e2e.test.ts @@ -0,0 +1,239 @@ +/*--------------------------------------------------------------------------------------------- + * Copyright (c) Microsoft Corporation. All rights reserved. + *--------------------------------------------------------------------------------------------*/ + +import { execFileSync, spawn } from "node:child_process"; +import { existsSync, mkdtempSync, readFileSync } from "node:fs"; +import { copyFile, mkdir, rm } from "node:fs/promises"; +import { tmpdir } from "node:os"; +import { dirname, join, resolve } from "node:path"; +import { fileURLToPath, pathToFileURL } from "node:url"; +import { expect, it } from "vitest"; +import { + createMessageConnection, + StreamMessageReader, + StreamMessageWriter, +} from "vscode-jsonrpc/node.js"; +import { approveAll } from "../../src/index.js"; +import { getSdkProtocolVersion } from "../../src/sdkProtocolVersion.js"; +import { createSdkTestContext, isInProcessTransport } from "./harness/sdkTestContext.js"; +import { retry } from "./harness/sdkTestHelper.js"; + +const __dirname = dirname(fileURLToPath(import.meta.url)); +const FIXTURE = join(__dirname, "fixtures", "env-access-extension.mjs"); +const DIST_DIR = resolve(__dirname, "..", "..", "dist"); + +interface ExtensionRun { + resumeParams: Record; + /** Sample taken before the join, so an inherited value is distinguishable from a granted one. */ + prejoin: string; + postjoin: string; + result: string; +} + +/** + * Run the fixture extension as a real child process against a stub host that + * speaks the extension side of the wire. + * + * The extension connection is plain JSON-RPC over the extension process's own + * stdio, so a stub host observes exactly what the CLI observes. That is the only + * way to cover this feature end to end today: the released CLI predates the host + * half (github/copilot-agent-runtime#15144), so it ignores the request and grants + * nothing. Once the `@github/copilot` dependency carries the host half, the + * real-CLI case below can assert the grant instead. + */ +async function runExtensionAgainstStubHost(options: { + requested: string[]; + /** Pass an explicit empty list rather than omitting the option. */ + requestEmptyList?: boolean; + /** Names the extension samples but never asks for. */ + observe?: string[]; + /** Values the host resolves for an approved request, or undefined to deny it. */ + granted?: Record; +}): Promise { + if (!existsSync(join(DIST_DIR, "extension.js"))) { + throw new Error(`Built SDK not found at ${DIST_DIR}. Run \`npm run build\` first.`); + } + + const dir = mkdtempSync(join(tmpdir(), "copilot-env-access-")); + const prejoinFile = join(dir, "prejoin"); + const postjoinFile = join(dir, "postjoin"); + const resultFile = join(dir, "result"); + + const child = spawn(process.execPath, [FIXTURE], { + stdio: ["pipe", "pipe", "pipe"], + env: { + ...process.env, + SESSION_ID: "stub-host-session", + EXTENSION_SDK_MODULE: pathToFileURL(join(DIST_DIR, "extension.js")).href, + EXTENSION_ENV_REQUEST: options.requested.join(","), + EXTENSION_ENV_REQUEST_EMPTY: options.requestEmptyList ? "1" : "", + EXTENSION_OBSERVE_ENV_NAMES: (options.observe ?? []).join(","), + EXTENSION_PREJOIN_FILE: prejoinFile, + EXTENSION_POSTJOIN_FILE: postjoinFile, + EXTENSION_RESULT_FILE: resultFile, + }, + }); + + const stderr: string[] = []; + child.stderr!.on("data", (chunk) => stderr.push(String(chunk))); + + let capturedResumeParams: Record = {}; + const connection = createMessageConnection( + new StreamMessageReader(child.stdout!), + new StreamMessageWriter(child.stdin!) + ); + connection.onRequest("connect", () => ({ protocolVersion: getSdkProtocolVersion() })); + connection.onRequest("session.resume", (params: Record) => { + capturedResumeParams = params; + if (!options.granted) { + throw new Error( + 'Extension "env-access" was denied access to sensitive environment variables' + ); + } + return { sessionId: params.sessionId, grantedEnvironmentVariables: options.granted }; + }); + // Everything else the SDK issues while joining is irrelevant here, and an + // unanswered request would hang the join. + connection.onRequest(() => ({})); + connection.onNotification(() => {}); + connection.listen(); + + try { + await retry( + "wait for the fixture extension to report its join result", + async () => { + expect( + existsSync(resultFile), + `extension never reported; stderr: ${stderr.join("")}` + ).toBe(true); + }, + 300, + 100 + ); + + return { + resumeParams: capturedResumeParams, + prejoin: readFileSync(prejoinFile, "utf-8"), + postjoin: readFileSync(postjoinFile, "utf-8"), + result: readFileSync(resultFile, "utf-8"), + }; + } finally { + connection.dispose(); + child.kill(); + // Windows keeps the directory locked until the child is gone. + await new Promise((resolveExit) => { + if (child.exitCode !== null || child.signalCode !== null) { + resolveExit(); + return; + } + child.once("exit", () => resolveExit()); + }); + await rm(dir, { recursive: true, force: true, maxRetries: 20, retryDelay: 100 }); + } +} + +it("puts an extension's environment request on the wire and applies the grant", async () => { + const run = await runExtensionAgainstStubHost({ + requested: ["E2E_SDK_TOKEN", "E2E_SDK_OTHER"], + granted: { E2E_SDK_TOKEN: "granted-token", E2E_SDK_OTHER: "granted-other" }, + }); + + expect(run.resumeParams.requestedEnvironmentVariables).toEqual([ + "E2E_SDK_TOKEN", + "E2E_SDK_OTHER", + ]); + // The values crossed the process boundary rather than being inherited. + expect(run.prejoin).toBe("E2E_SDK_TOKEN=\nE2E_SDK_OTHER="); + expect(run.postjoin).toBe("E2E_SDK_TOKEN=granted-token\nE2E_SDK_OTHER=granted-other"); + expect(run.result).toBe("joined"); +}); + +it("grants nothing to an extension whose request the host denies", async () => { + const run = await runExtensionAgainstStubHost({ requested: ["E2E_SDK_TOKEN"] }); + + expect(run.resumeParams.requestedEnvironmentVariables).toEqual(["E2E_SDK_TOKEN"]); + expect(run.result).toContain("denied access to sensitive environment variables"); + expect(run.postjoin).toBe("E2E_SDK_TOKEN="); +}); + +it("leaves the wire payload alone when an extension asks for nothing", async () => { + const omitted = await runExtensionAgainstStubHost({ requested: [], granted: {} }); + const emptyList = await runExtensionAgainstStubHost({ + requested: [], + requestEmptyList: true, + granted: {}, + }); + + expect(omitted.resumeParams).not.toHaveProperty("requestedEnvironmentVariables"); + // An empty list is the other public way to ask for nothing. + expect(emptyList.resumeParams).not.toHaveProperty("requestedEnvironmentVariables"); + expect(omitted.result).toBe("joined"); + expect(emptyList.result).toBe("joined"); +}); + +it("ignores a granted variable the extension never requested", async () => { + const run = await runExtensionAgainstStubHost({ + requested: ["E2E_SDK_TOKEN"], + observe: ["E2E_SDK_SMUGGLED"], + granted: { E2E_SDK_TOKEN: "granted-token", E2E_SDK_SMUGGLED: "not-approved" }, + }); + + // The user approved one name, so a host answering with a second one cannot + // widen the grant. + expect(run.postjoin).toBe("E2E_SDK_TOKEN=granted-token\nE2E_SDK_SMUGGLED="); +}); + +const cliObservations = isInProcessTransport + ? "" + : mkdtempSync(join(tmpdir(), "copilot-env-access-cli-")); +const cliResultFile = join(cliObservations, "result"); +const cliContext = isInProcessTransport + ? undefined + : await createSdkTestContext({ + copilotClientOptions: { + env: { + COPILOT_CLI_ENABLED_FEATURE_FLAGS: "EXTENSIONS", + EXTENSION_ENV_REQUEST: "E2E_SDK_TOKEN", + EXTENSION_RESULT_FILE: cliResultFile, + EXTENSION_PREJOIN_FILE: join(cliObservations, "prejoin"), + EXTENSION_POSTJOIN_FILE: join(cliObservations, "postjoin"), + }, + }, + }); + +// The released CLI ignores `requestedEnvironmentVariables`, so this covers the +// half a real CLI can prove today: asking for variables does not break the join. +// It becomes the grant test once `@github/copilot` carries the host half. +it.skipIf(isInProcessTransport)( + "joins a real CLI that does not support environment requests", + async () => { + if (!cliContext) { + throw new Error("Extension E2E requires an out-of-process transport"); + } + const { workDir, copilotClient } = cliContext; + const extensionDir = join(workDir, ".github", "extensions", "env-access"); + await rm(join(workDir, ".github"), { recursive: true, force: true }); + await rm(cliResultFile, { force: true }); + await mkdir(extensionDir, { recursive: true }); + await copyFile(FIXTURE, join(extensionDir, "extension.mjs")); + execFileSync("git", ["init", "--quiet"], { cwd: workDir }); + + await using _session = await copilotClient.createSession({ + requestExtensions: true, + extensionSdkPath: DIST_DIR, + onPermissionRequest: approveAll, + }); + + await retry( + "wait for the env-access extension to join the session", + async () => { + expect(existsSync(cliResultFile)).toBe(true); + }, + 300, + 100 + ); + + expect(readFileSync(cliResultFile, "utf-8")).toBe("joined"); + } +); diff --git a/nodejs/test/e2e/factory.e2e.test.ts b/nodejs/test/e2e/factory.e2e.test.ts new file mode 100644 index 0000000000..cddd8e47b0 --- /dev/null +++ b/nodejs/test/e2e/factory.e2e.test.ts @@ -0,0 +1,311 @@ +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 }, + }); + } +); + +// TODO(cli-1.0.81-2): the subagent request is rejected downstream under CLI 1.0.81-2, so the +// fixture reports didThrow: true. Re-enable once the runtime fix ships. +// +// The timeout is generous because the factory abandons its subagent once the runtime has +// accepted the request, so the run settles only after the runtime drains that work. +it.skip("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 }, + }); +}, 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/env-access-extension.mjs b/nodejs/test/e2e/fixtures/env-access-extension.mjs new file mode 100644 index 0000000000..39cea3f1ba --- /dev/null +++ b/nodejs/test/e2e/fixtures/env-access-extension.mjs @@ -0,0 +1,82 @@ +/*--------------------------------------------------------------------------------------------- + * Copyright (c) Microsoft Corporation. All rights reserved. + *--------------------------------------------------------------------------------------------*/ + +// Extension that asks for named sensitive environment variables at join time. +// +// Every input is an environment variable so one fixture serves both the stub-host +// case (spawned directly, importing the built SDK through EXTENSION_SDK_MODULE) +// and the real-CLI case (forked by the CLI, which injects the SDK module). +// +// - EXTENSION_SDK_MODULE: import specifier for the SDK. Defaults to the module +// name the CLI resolves for a forked extension. +// - EXTENSION_ENV_REQUEST: comma-separated names to pass to joinSession as +// requestedEnvironmentVariables. +// - EXTENSION_PREJOIN_FILE: `NAME=` per requested name, sampled BEFORE the +// join. A test compares it with the post-join sample to tell a value the +// process already inherited from one the host granted. +// - EXTENSION_POSTJOIN_FILE: the same sample, written once the join settles. +// - EXTENSION_RESULT_FILE: `joined` or `rejected:`. A denied extension +// has no session to report through, so it reports here. +// - EXTENSION_ENV_REQUEST_EMPTY: set to `1` to pass an explicit empty list when +// EXTENSION_ENV_REQUEST names nothing, instead of omitting the option. +// - EXTENSION_OBSERVE_ENV_NAMES: comma-separated names that are sampled but +// deliberately NOT requested, so a test can prove a name outside the approved +// set never reached this process. + +import { writeFileSync } from "node:fs"; + +const sdkModule = process.env.EXTENSION_SDK_MODULE ?? "@github/copilot-sdk/extension"; +const { joinSession } = await import(sdkModule); + +const requested = (process.env.EXTENSION_ENV_REQUEST ?? "") + .split(",") + .map((name) => name.trim()) + .filter((name) => name.length > 0); +const observed = (process.env.EXTENSION_OBSERVE_ENV_NAMES ?? "") + .split(",") + .map((name) => name.trim()) + .filter((name) => name.length > 0); +const sampledNames = [...requested, ...observed]; +const sample = () => sampledNames.map((name) => `${name}=${process.env[name] ?? ""}`).join("\n"); + +const record = (file, contents) => { + if (file) { + writeFileSync(file, contents); + } +}; + +record(process.env.EXTENSION_PREJOIN_FILE, sample()); + +const config = { + tools: [ + { + name: "env_access_greeter", + description: "Greets someone. Always call this tool when asked to greet.", + parameters: { type: "object", properties: { name: { type: "string" } } }, + handler: async (args) => `Hello from env-access, ${args.name || "World"}!`, + }, + ], +}; +// An extension that wants nothing normally omits the option entirely. +// EXTENSION_ENV_REQUEST_EMPTY covers the other public way to ask for nothing: +// passing an empty list, which must reach the wire the same way. +if (requested.length > 0) { + config.requestedEnvironmentVariables = requested; +} else if (process.env.EXTENSION_ENV_REQUEST_EMPTY === "1") { + config.requestedEnvironmentVariables = []; +} + +try { + await joinSession(config); + record(process.env.EXTENSION_POSTJOIN_FILE, sample()); + record(process.env.EXTENSION_RESULT_FILE, "joined"); +} catch (error) { + // Sampled after the rejection too, so a test can prove a denied extension + // never saw the value rather than only that the join failed. + record(process.env.EXTENSION_POSTJOIN_FILE, sample()); + record( + process.env.EXTENSION_RESULT_FILE, + `rejected:${error instanceof Error ? error.message : String(error)}` + ); +} diff --git a/nodejs/test/e2e/fixtures/factory-extension.mjs b/nodejs/test/e2e/fixtures/factory-extension.mjs new file mode 100644 index 0000000000..45227a1bea --- /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/harness/CapiProxy.ts b/nodejs/test/e2e/harness/CapiProxy.ts index a6232587e2..c25d422f99 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/hooks_extended.e2e.test.ts b/nodejs/test/e2e/hooks_extended.e2e.test.ts index 5b997adb2c..3ac858650e 100644 --- a/nodejs/test/e2e/hooks_extended.e2e.test.ts +++ b/nodejs/test/e2e/hooks_extended.e2e.test.ts @@ -14,6 +14,7 @@ import type { SessionEndHookInput, SessionStartHookInput, UserPromptSubmittedHookInput, + UserPromptTransformedHookInput, } from "../../src/types.js"; import { createSdkTestContext } from "./harness/sdkTestContext.js"; @@ -169,6 +170,36 @@ describe("Extended session hooks", async () => { 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[] = []; diff --git a/nodejs/test/e2e/mcp_and_agents.e2e.test.ts b/nodejs/test/e2e/mcp_and_agents.e2e.test.ts index a593ff9882..414e760ea2 100644 --- a/nodejs/test/e2e/mcp_and_agents.e2e.test.ts +++ b/nodejs/test/e2e/mcp_and_agents.e2e.test.ts @@ -103,7 +103,6 @@ describe("MCP Servers and Custom Agents", async () => { // Create a session first const session1 = await client.createSession({ onPermissionRequest: approveAll }); const sessionId = session1.sessionId; - await session1.sendAndWait({ prompt: "What is 1+1?" }); // Resume with MCP servers const mcpServers = createTestMcpServers("test-server"); diff --git a/nodejs/test/e2e/permissions.e2e.test.ts b/nodejs/test/e2e/permissions.e2e.test.ts index e7c26a2930..d7600ed165 100644 --- a/nodejs/test/e2e/permissions.e2e.test.ts +++ b/nodejs/test/e2e/permissions.e2e.test.ts @@ -5,17 +5,20 @@ 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 { approveAll, defineTool, createAttributedPermissionResult } from "../../src/index.js"; import { createSdkTestContext, isInProcessTransport } from "./harness/sdkTestContext.js"; import { getFinalAssistantMessage, getNextEventOfType } from "./harness/sdkTestHelper.js"; +const isWindows = process.platform === "win32"; + describe("Permission callbacks", async () => { const { copilotClient: client, workDir } = await createSdkTestContext(); @@ -90,6 +93,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; @@ -574,67 +632,76 @@ describe("Permission callbacks", async () => { } }); - it("should invoke permission location and folder trust rpc apis", async () => { - const session = await client.createSession({ onPermissionRequest: approveAll }); - const locationDirectory = await createUniqueWorkDirectory(workDir, "permission-location"); - const trustedDirectory = await createUniqueWorkDirectory(workDir, "folder-trust"); - const commandIdentifier = `node-permission-location-${Date.now()}`; - try { - const resolved = await session.rpc.permissions.locations.resolve({ - workingDirectory: locationDirectory, - }); - expect(resolved.locationType).toBe("dir"); - expectPathEqual(resolved.locationKey, locationDirectory); - - expect( - ( - await session.rpc.permissions.locations.addToolApproval({ - locationKey: resolved.locationKey, - approval: { - kind: "commands", - commandIdentifiers: [commandIdentifier], - }, - }) - ).success - ).toBe(true); - - const applied = await session.rpc.permissions.locations.apply({ - workingDirectory: locationDirectory, - }); - expect(applied.locationType).toBe(resolved.locationType); - expectPathEqual(applied.locationKey, resolved.locationKey); - expect(applied.appliedRuleCount).toBeGreaterThanOrEqual(1); - expect( - applied.appliedRules.some( - (rule) => rule.kind === "shell" && rule.argument === commandIdentifier - ) - ).toBe(true); - - expect( - ( - await session.rpc.permissions.folderTrust.isTrusted({ - path: trustedDirectory, - }) - ).trusted - ).toBe(false); - expect( - ( - await session.rpc.permissions.folderTrust.addTrusted({ - path: trustedDirectory, - }) - ).success - ).toBe(true); - expect( - ( - await session.rpc.permissions.folderTrust.isTrusted({ - path: trustedDirectory, - }) - ).trusted - ).toBe(true); - } finally { - await session.disconnect(); + // TODO(cli-1.0.81-2): CLI 1.0.81-2 no longer matches the location key returned by + // permissions.locations.resolve when permissions.locations.apply re-resolves it on Windows, + // so appliedRuleCount comes back as 0. Still covered on Linux and macOS. + it.skipIf(isWindows)( + "should invoke permission location and folder trust rpc apis", + async () => { + const session = await client.createSession({ onPermissionRequest: approveAll }); + const locationDirectory = await createUniqueWorkDirectory( + workDir, + "permission-location" + ); + const trustedDirectory = await createUniqueWorkDirectory(workDir, "folder-trust"); + const commandIdentifier = `node-permission-location-${Date.now()}`; + try { + const resolved = await session.rpc.permissions.locations.resolve({ + workingDirectory: locationDirectory, + }); + expect(resolved.locationType).toBe("dir"); + expectPathEqual(resolved.locationKey, locationDirectory); + + expect( + ( + await session.rpc.permissions.locations.addToolApproval({ + locationKey: resolved.locationKey, + approval: { + kind: "commands", + commandIdentifiers: [commandIdentifier], + }, + }) + ).success + ).toBe(true); + + const applied = await session.rpc.permissions.locations.apply({ + workingDirectory: locationDirectory, + }); + expect(applied.locationType).toBe(resolved.locationType); + expectPathEqual(applied.locationKey, resolved.locationKey); + expect(applied.appliedRuleCount).toBeGreaterThanOrEqual(1); + expect( + applied.appliedRules.some( + (rule) => rule.kind === "shell" && rule.argument === commandIdentifier + ) + ).toBe(true); + + expect( + ( + await session.rpc.permissions.folderTrust.isTrusted({ + path: trustedDirectory, + }) + ).trusted + ).toBe(false); + expect( + ( + await session.rpc.permissions.folderTrust.addTrusted({ + path: trustedDirectory, + }) + ).success + ).toBe(true); + expect( + ( + await session.rpc.permissions.folderTrust.isTrusted({ + path: trustedDirectory, + }) + ).trusted + ).toBe(true); + } finally { + await session.disconnect(); + } } - }); + ); }); async function createUniqueWorkDirectory(baseDir: string, prefix: string): Promise { diff --git a/nodejs/test/e2e/rewind.e2e.test.ts b/nodejs/test/e2e/rewind.e2e.test.ts new file mode 100644 index 0000000000..49c2b3b8f0 --- /dev/null +++ b/nodejs/test/e2e/rewind.e2e.test.ts @@ -0,0 +1,89 @@ +/*--------------------------------------------------------------------------------------------- + * 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(); + + // TODO(cli-1.0.81): Re-enable when Windows file-change tracking records built-in create tool writes. + it.skipIf(process.platform === "win32")( + "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() + 30_000; + while ( + Date.now() < deadline && + (rewindPoints.unavailableReason !== undefined || + !rewindPoints.points[0]?.canRestoreFiles) + ) { + 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_session_state_extras.e2e.test.ts b/nodejs/test/e2e/rpc_session_state_extras.e2e.test.ts index 54f40fe12c..6111809914 100644 --- a/nodejs/test/e2e/rpc_session_state_extras.e2e.test.ts +++ b/nodejs/test/e2e/rpc_session_state_extras.e2e.test.ts @@ -203,21 +203,21 @@ describe("Session-scoped state extras RPC", async () => { 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 initial = await session.rpc.permissions.getMode(); + expect(initial.mode).toBe("manual"); - const enable = await session.rpc.permissions.setAllowAll({ enabled: true }); + const enable = await session.rpc.permissions.setMode({ mode: "allow-all" }); expect(enable.success).toBe(true); - expect(enable.enabled).toBe(true); - expect((await session.rpc.permissions.getAllowAll()).enabled).toBe(true); + expect(enable.mode).toBe("allow-all"); + expect((await session.rpc.permissions.getMode()).mode).toBe("allow-all"); - const disable = await session.rpc.permissions.setAllowAll({ enabled: false }); + const disable = await session.rpc.permissions.setMode({ mode: "manual" }); expect(disable.success).toBe(true); - expect(disable.enabled).toBe(false); - expect((await session.rpc.permissions.getAllowAll()).enabled).toBe(false); + expect(disable.mode).toBe("manual"); + expect((await session.rpc.permissions.getMode()).mode).toBe("manual"); } finally { try { - await session.rpc.permissions.setAllowAll({ enabled: false }); + await session.rpc.permissions.setMode({ mode: "manual" }); } catch { // Best-effort reset. } diff --git a/nodejs/test/e2e/rpc_ui_ephemeral_query.e2e.test.ts b/nodejs/test/e2e/rpc_ui_ephemeral_query.e2e.test.ts index 662294d70a..7fa1e90f5d 100644 --- a/nodejs/test/e2e/rpc_ui_ephemeral_query.e2e.test.ts +++ b/nodejs/test/e2e/rpc_ui_ephemeral_query.e2e.test.ts @@ -4,23 +4,29 @@ import { describe, expect, it } from "vitest"; import { approveAll } from "../../src/index.js"; -import { createSdkTestContext } from "./harness/sdkTestContext.js"; +import { createSdkTestContext, isInProcessTransport } 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?", - }); + // TODO(cli-1.0.81-2): CLI 1.0.81-6 still fails session.ui.ephemeralQuery against the + // recorded snapshot on macOS ("Failed to get response from the AI model"). + it.skipIf(isInProcessTransport || process.platform === "darwin")( + "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(); + expect(result).toBeDefined(); + expect(result.answer.trim()).toBeTruthy(); + expect(result.answer.toLowerCase()).toContain("blue"); + } finally { + await session.disconnect(); + } } - }); + ); }); diff --git a/nodejs/test/e2e/session.e2e.test.ts b/nodejs/test/e2e/session.e2e.test.ts index 88fdf4c29f..b89221998a 100644 --- a/nodejs/test/e2e/session.e2e.test.ts +++ b/nodejs/test/e2e/session.e2e.test.ts @@ -252,10 +252,13 @@ describe("Sessions", () => { // 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" } }, - ]); + expect(traffic[0].request.tools).toHaveLength(2); + expect(traffic[0].request.tools).toEqual( + expect.arrayContaining([ + expect.objectContaining({ function: expect.objectContaining({ name: "view" }) }), + expect.objectContaining({ function: expect.objectContaining({ name: "edit" }) }), + ]) + ); }); it("should create a session with excludedTools", async () => { @@ -964,15 +967,21 @@ describe("Send Blocking Behavior", async () => { expect(event.data.newModel).toBe("gpt-4.1"); }); - it("should set model with reasoningEffort", async () => { - await using 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 98b1a0bfaa..85137e0ff9 100644 --- a/nodejs/test/e2e/session_config.e2e.test.ts +++ b/nodejs/test/e2e/session_config.e2e.test.ts @@ -222,6 +222,23 @@ 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 @@ -848,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 11de9582e1..9727de06e1 100644 --- a/nodejs/test/e2e/session_fs.e2e.test.ts +++ b/nodejs/test/e2e/session_fs.e2e.test.ts @@ -145,9 +145,11 @@ describe("Session Fs", async () => { prompt: "Call the get_big_string tool and reply with the word DONE only.", }); - // The tool result should reference a temp file under the session state path + // The tool result should reference a temp file under the session state path. + // The CLI joins the temp path using the host separator, so normalize before + // matching to keep the assertion valid on Windows. const messages = await session.getEvents(); - const toolResult = findToolCallResult(messages, "get_big_string"); + const toolResult = findToolCallResult(messages, "get_big_string")?.replaceAll("\\", "/"); expect(toolResult).toContain(`${sessionStatePath}/temp/`); const filename = toolResult?.match( new RegExp(`(${escapeRegExp(sessionStatePath)}/temp/[^\\s]+)`) @@ -299,6 +301,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 +449,9 @@ describe("Session Fs Adapter", () => { query: async () => { throw enoent; }, + transaction: async () => { + throw enoent; + }, exists: async () => { throw enoent; }, @@ -589,6 +608,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 cea67c1453..5bc944240d 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/streaming_fidelity.e2e.test.ts b/nodejs/test/e2e/streaming_fidelity.e2e.test.ts index 17b5222616..98b8eb1884 100644 --- a/nodejs/test/e2e/streaming_fidelity.e2e.test.ts +++ b/nodejs/test/e2e/streaming_fidelity.e2e.test.ts @@ -145,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/telemetry.e2e.test.ts b/nodejs/test/e2e/telemetry.e2e.test.ts index c0f71ebfc6..66a0bb8cef 100644 --- a/nodejs/test/e2e/telemetry.e2e.test.ts +++ b/nodejs/test/e2e/telemetry.e2e.test.ts @@ -103,11 +103,6 @@ describe("Telemetry export", async () => { expect(span.instrumentationScope?.name).toBe(sourceName); } - // All spans for one SDK turn must share the same trace id and must not be in error state. - const traceIds = Array.from( - new Set(spans.map((span) => span.traceId).filter((id): id is string => Boolean(id))) - ); - expect(traceIds).toHaveLength(1); for (const span of spans) { expect(span.status?.code).not.toBe(2); } @@ -122,6 +117,8 @@ describe("Telemetry export", async () => { expect(isRootSpan(invokeAgentSpan!)).toBe(true); const invokeAgentSpanId = invokeAgentSpan!.spanId; expect(invokeAgentSpanId).toBeTruthy(); + const invokeAgentTraceId = invokeAgentSpan!.traceId; + expect(invokeAgentTraceId).toBeTruthy(); const chatSpans = spans.filter( (span) => getStringAttribute(span, "gen_ai.operation.name") === "chat" @@ -129,6 +126,7 @@ describe("Telemetry export", async () => { expect(chatSpans.length).toBeGreaterThan(0); for (const chat of chatSpans) { expect(chat.parentSpanId).toBe(invokeAgentSpanId); + expect(chat.traceId).toBe(invokeAgentTraceId); } expect( chatSpans.some((span) => @@ -148,6 +146,7 @@ describe("Telemetry export", async () => { ); expect(toolSpan).toBeDefined(); expect(toolSpan!.parentSpanId).toBe(invokeAgentSpanId); + expect(toolSpan!.traceId).toBe(invokeAgentTraceId); expect(getStringAttribute(toolSpan!, "gen_ai.tool.name")).toBe(toolName); expect(getStringAttribute(toolSpan!, "gen_ai.tool.call.id")).toBeTruthy(); expect(getStringAttribute(toolSpan!, "gen_ai.tool.call.arguments")).toBe( diff --git a/nodejs/test/e2e/tool_results.e2e.test.ts b/nodejs/test/e2e/tool_results.e2e.test.ts index 6e8729c429..eb6ecf6f79 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 c505f8aa86..16db1aca87 100644 --- a/nodejs/test/e2e/tools.e2e.test.ts +++ b/nodejs/test/e2e/tools.e2e.test.ts @@ -7,7 +7,7 @@ import { join } from "path"; import { assert, describe, expect, it } from "vitest"; import { z } from "zod"; import { defineTool, approveAll, ToolSet } from "../../src/index.js"; -import type { PermissionRequest } 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,50 @@ describe("Custom tools", async () => { expect(assistantMessage?.data.content).toContain("HELLO"); }); + // TODO(cli-1.0.81-2): CLI 1.0.81-2 stops servicing nested requests on the same stdio + // connection while awaiting a tool handler, so calling session.history.clearContext + // from inside a terminal tool deadlocks. Tracked as a runtime reentrancy regression; + // re-enable once the fixed CLI ships. + it.skip("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({ diff --git a/nodejs/test/extension.test.ts b/nodejs/test/extension.test.ts index 1baa83a3ab..bebe8db7f0 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,17 +36,50 @@ 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); }); + it("forwards the requested environment variables and keeps them off the resume config", async () => { + process.env.SESSION_ID = "session-123"; + const resumeForExtension = vi + .spyOn(CopilotClient.prototype, "resumeSessionForExtension") + .mockResolvedValue({} as any); + + await joinSession({ + requestedEnvironmentVariables: ["GITHUB_TOKEN", "MY_SECRET"], + tools: [], + }); + + const [, config, , extensionOptions] = resumeForExtension.mock.calls[0]!; + expect(extensionOptions).toEqual({ + requestedEnvironmentVariables: ["GITHUB_TOKEN", "MY_SECRET"], + }); + expect(config).not.toHaveProperty("requestedEnvironmentVariables"); + }); + + it("requests no environment variables when the option is omitted or empty", async () => { + process.env.SESSION_ID = "session-123"; + const resumeForExtension = vi + .spyOn(CopilotClient.prototype, "resumeSessionForExtension") + .mockResolvedValue({} as any); + + await joinSession({ tools: [] }); + await joinSession({ requestedEnvironmentVariables: [], tools: [] }); + + expect(resumeForExtension.mock.calls[0]![3]).toBeUndefined(); + // An empty list means the same as omitting the option, so it must not put + // an environment request on the wire either. + expect(resumeForExtension.mock.calls[1]![3]).toBeUndefined(); + }); + it("exports the canvas helper from the extension surface", () => { const canvas = createCanvas({ id: "counter", diff --git a/nodejs/test/factory.test.ts b/nodejs/test/factory.test.ts new file mode 100644 index 0000000000..dcf434616a --- /dev/null +++ b/nodejs/test/factory.test.ts @@ -0,0 +1,2425 @@ +/*--------------------------------------------------------------------------------------------- + * 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;"); + }); + + // A guessed ceiling does not make a run safer: it stops a healthy run partway + // with `factory_limit_reached`, after that run has already taken the user's + // approval and spent credits. Both documents are handed to the model verbatim + // by the `factories_manage` guide, so neither may read as an invitation to + // invent one. + it("documents limits as opt-in rather than inviting an invented ceiling", () => { + const guide = readFileSync(new URL("../docs/factories.md", import.meta.url), "utf8"); + const patterns = readFileSync( + new URL("../docs/factory-patterns.md", import.meta.url), + "utf8" + ); + + expect(guide).toContain( + "Set a ceiling only from real knowledge of what the factory costs, or because the user named one" + ); + expect(guide).toContain("no basis for estimating a number"); + + // The opening `defineFactory` sample is the shape an author copies. Filling + // all four ceilings in there taught the numbers as much as the syntax. + const openingSample = guide.slice(0, guide.indexOf("## Declaring an argument shape")); + expect(openingSample).not.toContain("limits: {"); + + // The Scaling section used to answer "there is no built-in concurrency cap" + // with "so declare one before fanning out widely". + expect(patterns).not.toContain("declare one before fanning out widely"); + expect(patterns).toContain("bound a wide fan-out with the factory's own counters"); + }); + + 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], + undefined + ); + }); + + 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/github-token-provider.test.ts b/nodejs/test/github-token-provider.test.ts new file mode 100644 index 0000000000..2202f466a1 --- /dev/null +++ b/nodejs/test/github-token-provider.test.ts @@ -0,0 +1,292 @@ +import { describe, expect, it, vi } from "vitest"; +import { CopilotClient, RuntimeConnection, type GitHubTokenProvider } from "../src/index.js"; + +function createMockClient( + request: (method: string, params: Record) => Promise +): CopilotClient { + const client = new CopilotClient({ + connection: RuntimeConnection.forUri("localhost:1234"), + }); + (client as unknown as { connection: unknown }).connection = { + sendRequest: request, + dispose: vi.fn(), + }; + return client; +} + +function getTokenHandler(client: CopilotClient) { + return ( + client as unknown as { + clientGlobalHandlers: { + gitHubToken: { + getToken(params: { + registrationId: string; + host: string; + sessionId?: string; + reason: "initial" | "refresh"; + }): Promise; + }; + }; + } + ).clientGlobalHandlers.gitHubToken.getToken; +} + +describe("session GitHub token providers", () => { + it("rejects a static token and provider together", async () => { + const client = new CopilotClient({ + connection: RuntimeConnection.forUri("localhost:1234"), + }); + + await expect( + client.createSession({ + gitHubToken: "static", + gitHubTokenProvider: async () => ({ + kind: "token", + accessToken: "dynamic", + expiresIn: 28_800, + }), + }) + ).rejects.toThrow("gitHubToken and gitHubTokenProvider are mutually exclusive"); + }); + + it("serializes only the opaque registration and maps token and cancellation results", async () => { + let createPayload: Record | undefined; + const request = vi.fn(async (method: string, params: Record) => { + if (method === "session.create") { + createPayload = params; + return { sessionId: params.sessionId }; + } + throw new Error(`Unexpected method: ${method}`); + }); + const observed: unknown[] = []; + const provider: GitHubTokenProvider = vi + .fn() + .mockImplementationOnce(async (args) => { + observed.push(args); + return { + kind: "token", + accessToken: "secret-token", + tokenType: "Bearer", + expiresIn: 28_800, + }; + }) + .mockImplementationOnce(async (args) => { + observed.push(args); + return { kind: "cancelled" }; + }); + const client = createMockClient(request); + const session = await client.createSession({ + sessionId: "session-one", + gitHubTokenProvider: provider, + }); + + const registrationId = createPayload?.gitHubTokenProviderRegistrationId; + expect(registrationId).toMatch( + /^[0-9a-f]{8}-[0-9a-f]{4}-4[0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$/ + ); + expect(createPayload).not.toHaveProperty("gitHubTokenProvider"); + expect(createPayload?.gitHubToken).toBeUndefined(); + + const handler = getTokenHandler(client); + await expect( + handler({ + registrationId: registrationId as string, + host: "github.example.com", + reason: "initial", + }) + ).resolves.toEqual({ + kind: "token", + accessToken: "secret-token", + tokenType: "Bearer", + expiresIn: 28_800, + }); + await expect( + handler({ + registrationId: registrationId as string, + host: "github.example.com", + sessionId: session.sessionId, + reason: "refresh", + }) + ).resolves.toEqual({ kind: "cancelled" }); + expect(observed).toEqual([ + { + host: "github.example.com", + sessionId: "session-one", + reason: "initial", + }, + { + host: "github.example.com", + sessionId: "session-one", + reason: "refresh", + }, + ]); + }); + + it("preserves callback errors and rejects unknown registrations", async () => { + const client = createMockClient(async (_method, params) => ({ + sessionId: params.sessionId, + })); + const failure = new Error("credential broker failed"); + await client.createSession({ + sessionId: "error-session", + gitHubTokenProvider: () => { + throw failure; + }, + }); + const registrationId = [ + ...( + client as unknown as { + githubTokenProviders: Map; + } + ).githubTokenProviders.keys(), + ][0]; + const handler = getTokenHandler(client); + + await expect( + handler({ + registrationId, + host: "github.com", + reason: "initial", + }) + ).rejects.toBe(failure); + await expect( + handler({ + registrationId: "unknown", + host: "github.com", + reason: "refresh", + }) + ).rejects.toThrow("No GitHub token provider registered"); + }); + + it("rolls back failed creation and cleans up on session and client close", async () => { + const failingClient = createMockClient(async () => { + throw new Error("create failed"); + }); + await expect( + failingClient.createSession({ + gitHubTokenProvider: async () => ({ kind: "cancelled" }), + }) + ).rejects.toThrow("create failed"); + expect( + ( + failingClient as unknown as { + githubTokenProviders: Map; + } + ).githubTokenProviders + ).toHaveLength(0); + + const client = createMockClient(async (method, params) => { + if (method === "session.create") return { sessionId: params.sessionId }; + if (method === "session.destroy") return {}; + if (method === "session.delete") return { success: true }; + throw new Error(`Unexpected method: ${method}`); + }); + const first = await client.createSession({ + sessionId: "first", + gitHubTokenProvider: async () => ({ kind: "cancelled" }), + }); + await client.createSession({ + sessionId: "second", + gitHubTokenProvider: async () => ({ kind: "cancelled" }), + }); + const registrations = ( + client as unknown as { + githubTokenProviders: Map; + } + ).githubTokenProviders; + expect(registrations).toHaveLength(2); + + await first.disconnect(); + expect(registrations).toHaveLength(1); + await client.deleteSession("second"); + expect(registrations).toHaveLength(0); + await client.forceStop(); + expect(registrations).toHaveLength(0); + }); + + it("rotates a resumed session only after resume succeeds", async () => { + const payloads: Record[] = []; + const client = createMockClient(async (method, params) => { + payloads.push(params); + if (method === "session.create" || method === "session.resume") { + return { sessionId: params.sessionId }; + } + throw new Error(`Unexpected method: ${method}`); + }); + const firstProvider = vi.fn(async () => ({ kind: "cancelled" as const })); + const secondProvider = vi.fn(async () => ({ kind: "cancelled" as const })); + await client.createSession({ + sessionId: "resumed", + gitHubTokenProvider: firstProvider, + }); + const firstRegistration = payloads[0].gitHubTokenProviderRegistrationId as string; + + await client.resumeSession("resumed", { + gitHubTokenProvider: secondProvider, + }); + const secondRegistration = payloads[1].gitHubTokenProviderRegistrationId as string; + const handler = getTokenHandler(client); + + await expect( + handler({ + registrationId: firstRegistration, + host: "github.com", + reason: "refresh", + }) + ).rejects.toThrow("No GitHub token provider registered"); + await expect( + handler({ + registrationId: secondRegistration, + host: "github.com", + reason: "refresh", + }) + ).resolves.toEqual({ kind: "cancelled" }); + expect(secondProvider).toHaveBeenCalledOnce(); + expect(firstProvider).not.toHaveBeenCalled(); + }); + + it("does not retire a concurrent pending registration", async () => { + const resumeResolvers: Array<(value: { sessionId: string }) => void> = []; + const payloads: Record[] = []; + const client = createMockClient(async (method, params) => { + payloads.push(params); + if (method === "session.create") { + return { sessionId: params.sessionId }; + } + if (method === "session.resume") { + return await new Promise<{ sessionId: string }>((resolve) => { + resumeResolvers.push(resolve); + }); + } + throw new Error(`Unexpected method: ${method}`); + }); + await client.createSession({ + sessionId: "concurrent", + gitHubTokenProvider: async () => ({ kind: "cancelled" }), + }); + + const firstResume = client.resumeSession("concurrent", { + gitHubTokenProvider: async () => ({ kind: "cancelled" }), + }); + const secondResume = client.resumeSession("concurrent", { + gitHubTokenProvider: async () => ({ kind: "cancelled" }), + }); + await vi.waitFor(() => expect(resumeResolvers).toHaveLength(2)); + + resumeResolvers[0]({ sessionId: "concurrent" }); + await firstResume; + const registrations = ( + client as unknown as { + githubTokenProviders: Map; + } + ).githubTokenProviders; + expect(registrations).toHaveLength(2); + + resumeResolvers[1]({ sessionId: "concurrent" }); + await secondResume; + expect(registrations).toHaveLength(1); + expect(registrations.has(payloads[2].gitHubTokenProviderRegistrationId as string)).toBe( + true + ); + }); +}); diff --git a/nodejs/test/session-event-codegen.test.ts b/nodejs/test/session-event-codegen.test.ts index 14340292be..c84d9bc082 100644 --- a/nodejs/test/session-event-codegen.test.ts +++ b/nodejs/test/session-event-codegen.test.ts @@ -84,6 +84,7 @@ describe("session event codegen", () => { expect(code).toContain("payload: str"); expect(code).toContain("encoded: str"); expect(code).toContain("count: int"); + expect(code).toContain("assert not isinstance(x, float) or x.is_integer()"); }); it("strips Ms suffixes from duration member names while preserving JSON names", () => { diff --git a/nodejs/test/session-event-types.test.ts b/nodejs/test/session-event-types.test.ts index 37b49f8a48..5c41f2216a 100644 --- a/nodejs/test/session-event-types.test.ts +++ b/nodejs/test/session-event-types.test.ts @@ -15,9 +15,19 @@ */ 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, + PermissionResponseCapability, + ManagedSettingsResolvedData, + ManagedSettingsResolvedEvent, + ManagedSettingsResolvedSource, // *Data payload types from the v0.3.0 generated session-event schema. AssistantMessageData, @@ -50,6 +60,11 @@ import type { UserMessageAgentMode, Attachment, WorkingDirectoryContextHostType, + FactoryContext, + FactoryDefinition, + FactoryAgentOptions, + FactoryRunResult, + JsonValue, } from "../src/index.js"; /** @@ -80,6 +95,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 +143,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 +321,9 @@ describe("Session event type exports (#1156)", () => { assertImportable(); assertImportable(); assertImportable(); + assertImportable(); + assertImportable(); + assertImportable(); assertImportable(); assertImportable(); @@ -169,6 +333,9 @@ 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 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 0000000000..4ee2e8eebc --- /dev/null +++ b/nodejs/test/session-send-and-wait.test.ts @@ -0,0 +1,158 @@ +/*--------------------------------------------------------------------------------------------- + * 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: { mode?: "interactive" | "plan" | "autopilot" } = {} +): 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("ignores autopilot continuation idle events", async () => { + const { session, sendStarted, resolveSend } = controlledSession(); + const pending = session.sendAndWait({ prompt: "hi" }); + await sendStarted; + + session._dispatchEvent(sessionEvent("session.idle", { mode: "autopilot" })); + resolveSend(); + + const stateAfterContinuation = await Promise.race([ + pending.then(() => "settled"), + new Promise<"pending">((resolve) => setTimeout(() => resolve("pending"), 0)), + ]); + expect(stateAfterContinuation).toBe("pending"); + + session._dispatchEvent(sessionEvent("session.idle", { mode: "interactive" })); + 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 fb62d99045..98749dffba 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/typescript-codegen.test.ts b/nodejs/test/typescript-codegen.test.ts index 248b60968b..0a63a5293a 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 03f6c779e9..4ac56bb45e 100644 --- a/nodejs/vitest.config.ts +++ b/nodejs/vitest.config.ts @@ -1,11 +1,62 @@ import { defineConfig } from "vitest/config"; +const integrationTestTimeout = process.platform === "win32" ? 60000 : 30000; + +const isInProcessTransport = + (process.env.COPILOT_SDK_DEFAULT_CONNECTION ?? "").toLowerCase() === "inprocess"; + +// TODO(cli-1.0.81-2): CLI 1.0.81-5 still stops completing model-driven turns when +// hosted in-process against CAPI. The shared runtime then poisons every later +// model-driven test. These suites still run over stdio on all three OSes, while +// pure-RPC in-process coverage remains enabled. +const inProcessBlockedE2E = [ + "**/test/e2e/abort.e2e.test.ts", + "**/test/e2e/agent_and_compact_rpc.e2e.test.ts", + "**/test/e2e/ask_user.e2e.test.ts", + "**/test/e2e/builtin_tools.e2e.test.ts", + "**/test/e2e/client_api.e2e.test.ts", + "**/test/e2e/client_lifecycle.e2e.test.ts", + "**/test/e2e/compaction.e2e.test.ts", + "**/test/e2e/copilot_request_cancel_error.e2e.test.ts", + "**/test/e2e/copilot_request_handler.e2e.test.ts", + "**/test/e2e/copilot_request_session_id.e2e.test.ts", + "**/test/e2e/disabled_mcp_servers.e2e.test.ts", + "**/test/e2e/event_fidelity.e2e.test.ts", + "**/test/e2e/hooks.e2e.test.ts", + "**/test/e2e/hooks_extended.e2e.test.ts", + "**/test/e2e/mcp_and_agents.e2e.test.ts", + "**/test/e2e/mode_empty.e2e.test.ts", + "**/test/e2e/multi_turn.e2e.test.ts", + "**/test/e2e/permissions.e2e.test.ts", + "**/test/e2e/pre_mcp_tool_call_hook.e2e.test.ts", + "**/test/e2e/provider_endpoint.e2e.test.ts", + "**/test/e2e/rewind.e2e.test.ts", + "**/test/e2e/rpc_event_side_effects.e2e.test.ts", + "**/test/e2e/rpc_session_state.e2e.test.ts", + "**/test/e2e/rpc_session_state_extras.e2e.test.ts", + "**/test/e2e/rpc_shell_and_fleet.e2e.test.ts", + "**/test/e2e/session.e2e.test.ts", + "**/test/e2e/session_config.e2e.test.ts", + "**/test/e2e/session_fs.e2e.test.ts", + "**/test/e2e/session_fs_sqlite.e2e.test.ts", + "**/test/e2e/session_lifecycle.e2e.test.ts", + "**/test/e2e/session_todos_changed.e2e.test.ts", + "**/test/e2e/skills.e2e.test.ts", + "**/test/e2e/streaming_fidelity.e2e.test.ts", + "**/test/e2e/subagent_hooks.e2e.test.ts", + "**/test/e2e/suspend.e2e.test.ts", + "**/test/e2e/system_message_sections.e2e.test.ts", + "**/test/e2e/system_message_transform.e2e.test.ts", + "**/test/e2e/tool_results.e2e.test.ts", + "**/test/e2e/tools.e2e.test.ts", +]; + 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 @@ -15,6 +66,7 @@ export default defineConfig({ "**/dist/**", "**/*.d.ts", "**/basic-test.ts", // Old manual test + ...(isInProcessTransport ? inProcessBlockedE2E : []), ], }, }); diff --git a/python/README.md b/python/README.md index f2b6ed6c99..61608c16a0 100644 --- a/python/README.md +++ b/python/README.md @@ -121,7 +121,7 @@ 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", @@ -272,17 +272,36 @@ finally: 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. +- `github_token_provider` (callable): Acquires rotating, session-scoped GitHub tokens. Token results require a positive `expiresIn` value in seconds remaining when the callback completes; production tokens typically last eight hours. Cannot be combined with `github_token`. +- `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. +```python +async def provide_github_token(args): + return { + "kind": "token", + "accessToken": await acquire_token_for_host(args["host"]), + "expiresIn": 8 * 60 * 60, + } + + +session = await client.create_session(github_token_provider=provide_github_token) +``` + +Initial acquisition runs during session creation or resume. Cancellation, provider errors, and invalid token responses reject that operation instead of falling back to ambient authentication. Idle sessions refresh only before their next credential-consuming operation; there is no background refresh timer. + +- `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:** ```python @@ -346,7 +365,7 @@ async with await client.create_session( > **Note:** When using `from __future__ import annotations`, define Pydantic models at module level (not inside functions). -**Low-level API (without Pydantic):** +#### Low-level API (without Pydantic) For users who prefer manual schema definition: @@ -707,9 +726,9 @@ async with await client.create_session( ... ``` -Available section IDs: `"identity"`, `"tone"`, `"tool_efficiency"`, `"environment_context"`, `"code_change_rules"`, `"guidelines"`, `"safety"`, `"tool_instructions"`, `"custom_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"`. `"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 four string 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 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): @@ -780,7 +799,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 @@ -792,12 +811,14 @@ 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 import PermissionNoResult, PermissionRequest, PermissionRequestResult from copilot.rpc import ( PermissionDecisionApproveOnce, PermissionDecisionReject, @@ -806,6 +827,9 @@ from copilot.session_events import PermissionRequestShell 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: @@ -828,6 +852,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() @@ -837,7 +864,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. @@ -847,7 +875,7 @@ 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``, @@ -1130,3 +1158,23 @@ When `on_elicitation_request` is provided, the SDK automatically: - Reports the `elicitation` capability on the session - Dispatches `elicitation.requested` events to your handler - Auto-cancels if your handler throws an error (so the server doesn't hang) + +## Development + +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 27c220ecf2..608dacf253 100644 --- a/python/copilot/__init__.py +++ b/python/copilot/__init__.py @@ -35,12 +35,20 @@ CloudSessionRepository, CopilotClient, CopilotExpAssignmentResponse, + DisableBypassPermissionsModes, ExpConfigEntry, ExpFlagValue, GetAuthStatusResponse, GetStatusResponse, + GitHubTokenCancelledResult, + GitHubTokenProvider, + GitHubTokenProviderArgs, + GitHubTokenProviderResult, + GitHubTokenResult, InProcessRuntimeConnection, LogLevel, + ManagedSettings, + ManagedSettingsPermissions, ModelBilling, ModelCapabilities, ModelInfo, @@ -83,8 +91,16 @@ GitHubTelemetryClientInfo, GitHubTelemetryEvent, GitHubTelemetryNotification, + GitHubTokenAcquireReason, + GitHubTokenAcquireResult, + GitHubTokenAcquireResultKind, ModelBillingTokenPrices, ModelBillingTokenPricesLongContext, + PermissionDecisionContext, + PermissionDecisionOutcome, + PermissionDecisionSource, + PermissionDecisionSurface, + PermissionResponseCapability, ) from .generated.session_events import ( PermissionRequest, @@ -95,6 +111,7 @@ AgentStopHandler, AgentStopHookInput, AgentStopHookOutput, + AttributedPermissionResult, AutoModeSwitchHandler, AutoModeSwitchRequest, AutoModeSwitchResponse, @@ -113,6 +130,7 @@ ExitPlanModeHandler, ExitPlanModeRequest, ExitPlanModeResult, + GitHubMcpToolConfig, InfiniteSessionConfig, InputOptions, LargeToolOutputConfig, @@ -172,12 +190,17 @@ 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 ( @@ -202,6 +225,7 @@ "AgentStopHandler", "AgentStopHookInput", "AgentStopHookOutput", + "AttributedPermissionResult", "AutoModeSwitchHandler", "AutoModeSwitchRequest", "AutoModeSwitchResponse", @@ -244,12 +268,22 @@ "ExitPlanModeResult", "ExtensionInfo", "CopilotWebSocketForwarder", + "DisableBypassPermissionsModes", "GetAuthStatusResponse", "BearerTokenProvider", "GetStatusResponse", + "GitHubMcpToolConfig", "GitHubTelemetryClientInfo", "GitHubTelemetryEvent", "GitHubTelemetryNotification", + "GitHubTokenAcquireReason", + "GitHubTokenAcquireResult", + "GitHubTokenAcquireResultKind", + "GitHubTokenProvider", + "GitHubTokenProviderArgs", + "GitHubTokenProviderResult", + "GitHubTokenResult", + "GitHubTokenCancelledResult", "InfiniteSessionConfig", "InProcessRuntimeConnection", "InputOptions", @@ -266,6 +300,8 @@ "McpAuthStaticClientConfig", "McpAuthToken", "McpAuthWwwAuthenticateParams", + "ManagedSettings", + "ManagedSettingsPermissions", "ModelBilling", "ModelBillingTokenPrices", "ModelBillingTokenPricesLongContext", @@ -285,6 +321,11 @@ "PermissionNoResult", "PermissionRequest", "PermissionRequestResult", + "PermissionDecisionContext", + "PermissionDecisionOutcome", + "PermissionDecisionSource", + "PermissionDecisionSurface", + "PermissionResponseCapability", "PingResponse", "PostToolUseHandler", "PostToolUseFailureHandler", @@ -324,6 +365,7 @@ "SessionFsProvider", "SessionFsSqliteProvider", "SessionFsSqliteQueryResult", + "SessionFsSqliteTransactionFailure", "SessionHooks", "SessionLimitsConfig", "SessionLifecycleEvent", @@ -358,7 +400,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/_jsonrpc.py b/python/copilot/_jsonrpc.py index ed70e4e8d0..6427a8007f 100644 --- a/python/copilot/_jsonrpc.py +++ b/python/copilot/_jsonrpc.py @@ -296,6 +296,9 @@ def _read_loop(self): def _fail_pending_requests(self): """Fail all pending requests when process exits""" + if self._stderr_thread and self._stderr_thread is not threading.current_thread(): + self._stderr_thread.join(timeout=1.0) + # Build error message with stderr output stderr_output = self.get_stderr_output() return_code = None diff --git a/python/copilot/_mode.py b/python/copilot/_mode.py index d8baf26633..5e7de02d02 100644 --- a/python/copilot/_mode.py +++ b/python/copilot/_mode.py @@ -251,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, @@ -282,11 +298,14 @@ def _post_create_options_patch( custom_agents_local_only: bool | None, coauthor_enabled: bool | None, manage_schedule_enabled: bool | None, + included_builtin_skills: list[str] | None = None, ) -> dict[str, Any] | None: """Build the patch sent via ``session.options.update`` after create/resume. In empty mode the four overridable flags default to safe values (caller-supplied values win); ``installedPlugins=[]`` is unconditional. + ``includedBuiltinSkills`` defaults to an empty list, but callers can + explicitly allow selected runtime-bundled skills. Returns ``None`` if no patch should be sent. """ if mode == "empty": @@ -294,14 +313,17 @@ 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": ( manage_schedule_enabled if manage_schedule_enabled is not None else False ), "installedPlugins": [], + "includedBuiltinSkills": ( + included_builtin_skills if included_builtin_skills is not None else [] + ), } return patch patch = {} @@ -313,6 +335,8 @@ def _post_create_options_patch( patch["coauthorEnabled"] = coauthor_enabled if manage_schedule_enabled is not None: patch["manageScheduleEnabled"] = manage_schedule_enabled + if included_builtin_skills is not None: + patch["includedBuiltinSkills"] = included_builtin_skills return patch or None diff --git a/python/copilot/client.py b/python/copilot/client.py index a7706dfe57..271fad626c 100644 --- a/python/copilot/client.py +++ b/python/copilot/client.py @@ -29,7 +29,7 @@ from dataclasses import dataclass, field from datetime import UTC, datetime from types import TracebackType -from typing import Any, ClassVar, Literal, TypedDict, cast, overload +from typing import Any, ClassVar, Literal, NotRequired, TypedDict, cast, overload from ._diagnostics import log_timing from ._ffi_runtime_host import FfiRuntimeHost @@ -37,7 +37,9 @@ 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, @@ -67,6 +69,9 @@ ClientGlobalApiHandlers, ClientSessionApiHandlers, GitHubTelemetryNotification, + GitHubTokenAcquireReason, + GitHubTokenAcquireRequest, + GitHubTokenAcquireResult, ModelBillingTokenPrices, ModelBillingTokenPricesLongContext, # noqa: F401 OpenCanvasInstance, @@ -94,6 +99,7 @@ DefaultAgentConfig, ElicitationHandler, ExitPlanModeHandler, + GitHubMcpToolConfig, InfiniteSessionConfig, LargeToolOutputConfig, McpAuthHandler, @@ -120,6 +126,50 @@ logger = logging.getLogger(__name__) + +class GitHubTokenProviderArgs(TypedDict): + """Arguments passed to a session-scoped :data:`GitHubTokenProvider`. + + The opaque callback registration identifier is intentionally not exposed. + """ + + host: str + session_id: str | None + reason: GitHubTokenAcquireReason + + +class GitHubTokenResult(TypedDict): + """A GitHub token returned by a session-scoped provider.""" + + kind: Literal["token"] + accessToken: str + expiresIn: int + tokenType: NotRequired[str] + + +class GitHubTokenCancelledResult(TypedDict): + """An explicit cancellation returned by a session-scoped provider.""" + + kind: Literal["cancelled"] + + +GitHubTokenProviderResult = GitHubTokenResult | GitHubTokenCancelledResult +"""Result returned by a session-scoped GitHub token provider.""" + + +GitHubTokenProvider = Callable[ + [GitHubTokenProviderArgs], + GitHubTokenProviderResult | Awaitable[GitHubTokenProviderResult], +] +"""Acquire a GitHub credential for one session. + +Token results require ``expiresIn`` to be the positive number of seconds of +remaining lifetime when the callback completes. Production GitHub tokens +typically last eight hours. Initial cancellation, callback errors, and invalid +token responses reject session creation or resume instead of falling back to +ambient authentication. +""" + # ============================================================================ # Connection Types # ============================================================================ @@ -244,6 +294,74 @@ def _capi_session_options_to_wire(options: CapiSessionOptions) -> dict[str, Any] return wire +class DisableBypassPermissionsModes: + """Well-known managed bypass-permissions policies.""" + + DISABLE: ClassVar[str] = "disable" + """Turn off bypass-permissions mode entirely.""" + + ALLOW_AUTO_ONLY: ClassVar[str] = "allow-auto-only" + """Permit automatic bypass but block full allow-all.""" + + +@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: str | None = None + """Restricts bypass-permissions mode for the session. See + :class:`DisableBypassPermissionsModes` for well-known values. Unknown values + are forwarded so newer runtime policies fail closed. 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" @@ -334,6 +452,22 @@ def _tool_search_to_wire(config: Mapping[str, Any]) -> dict[str, Any]: 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.""" @@ -546,6 +680,43 @@ async def event(self, params: GitHubTelemetryNotification) -> None: logger.warning("Error handling gitHubTelemetry.event notification", exc_info=True) +@dataclass +class _GitHubTokenProviderRegistration: + provider: GitHubTokenProvider + session_id: str | None = None + committed: bool = False + + +class _GitHubTokenProviderAdapter: + """Routes global GitHub token requests to opaque session registrations.""" + + def __init__(self, client: CopilotClient) -> None: + self._client = client + + async def get_token(self, params: GitHubTokenAcquireRequest) -> GitHubTokenAcquireResult: + with self._client._github_token_providers_lock: + registration = self._client._github_token_providers.get(params.registration_id) + if registration is None: + raise JsonRpcError( + -32603, + "No GitHub token provider registered for registration ID " + f"{params.registration_id!r}", + ) + + result = registration.provider( + GitHubTokenProviderArgs( + host=params.host, + session_id=params.session_id or registration.session_id, + reason=params.reason, + ) + ) + if inspect.isawaitable(result): + result = await result + # The generated global-handler wrapper forwards callback results directly, + # so the public tagged dictionary is already in the expected wire shape. + return cast(GitHubTokenAcquireResult, result) + + class _HooksAdapter: """Adapts session-scoped hook dispatch to the generated ``HooksHandler`` protocol. @@ -579,6 +750,7 @@ 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 @@ -1351,6 +1523,7 @@ 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, @@ -1386,6 +1559,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. @@ -1433,6 +1609,7 @@ 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, @@ -1449,6 +1626,11 @@ def __init__( 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, @@ -1524,6 +1706,9 @@ def __init__( self._state: _ConnectionState = "disconnected" self._sessions: dict[str, CopilotSession] = {} self._sessions_lock = threading.Lock() + self._github_token_providers: dict[str, _GitHubTokenProviderRegistration] = {} + self._github_token_providers_lock = threading.Lock() + self._github_token_provider_adapter = _GitHubTokenProviderAdapter(self) self._models_cache: list[ModelInfo] | None = None self._models_cache_lock = asyncio.Lock() self._lifecycle_handlers: list[SessionLifecycleHandler] = [] @@ -1731,6 +1916,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() @@ -1827,6 +2023,8 @@ async def stop(self) -> None: errors.append( StopError(message=f"Failed to disconnect session {session.session_id}: {e}") ) + with self._github_token_providers_lock: + self._github_token_providers.clear() if ( self._rpc is not None @@ -1943,6 +2141,8 @@ async def force_stop(self) -> None: # Clear sessions immediately without trying to destroy them with self._sessions_lock: self._sessions.clear() + with self._github_token_providers_lock: + self._github_token_providers.clear() # Close the transport first to signal the server immediately. # For external servers (TCP), this closes the socket. @@ -2001,6 +2201,7 @@ 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, @@ -2010,12 +2211,14 @@ async def create_session( 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, @@ -2040,10 +2243,12 @@ async def create_session( enable_host_git_operations: bool | None = None, enable_session_store: bool | None = None, enable_skills: bool | None = None, + included_builtin_skills: list[str] | None = None, skill_directories: list[str] | None = None, 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, @@ -2056,6 +2261,7 @@ async def create_session( on_auto_mode_switch_request: AutoModeSwitchHandler | None = None, create_session_fs_handler: CreateSessionFsHandler | None = None, github_token: str | None = None, + github_token_provider: GitHubTokenProvider | None = None, remote_session: RemoteSessionMode | None = None, cloud: CloudSessionOptions | None = None, canvases: list[CanvasDeclaration] | None = None, @@ -2067,6 +2273,8 @@ async def create_session( 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. @@ -2086,6 +2294,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. @@ -2126,6 +2337,8 @@ async def create_session( 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 @@ -2153,13 +2366,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 @@ -2172,6 +2381,10 @@ 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 @@ -2187,6 +2400,16 @@ 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 @@ -2205,6 +2428,20 @@ async def create_session( 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``. + github_token_provider: Callback that acquires a short-lived GitHub + credential for this session. Mutually exclusive with + ``github_token``. It receives the effective host, session ID + when assigned, and acquisition reason; the registration ID is + kept internal. Returns: A :class:`CopilotSession` instance for the new session. @@ -2226,6 +2463,8 @@ async def create_session( """ if on_permission_request is not None and not callable(on_permission_request): raise ValueError("on_permission_request must be callable when provided.") + if github_token is not None and github_token_provider is not None: + raise ValueError("github_token and github_token_provider are mutually exclusive") if not self._client: await self.start() @@ -2246,6 +2485,8 @@ async def create_session( 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 @@ -2271,6 +2512,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: @@ -2281,6 +2524,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: @@ -2312,13 +2557,15 @@ 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) # Serialize commands (name + description only) into payload if commands: payload["commands"] = [ - {"name": cmd.name, "description": cmd.description} for cmd in commands + {"name": cmd.name, "description": cmd.description or ""} for cmd in commands ] # Enable hooks callback if any hook handler provided @@ -2345,9 +2592,15 @@ async def create_session( 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: @@ -2383,6 +2636,8 @@ async def create_session( 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: @@ -2409,6 +2664,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: @@ -2455,6 +2712,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: @@ -2507,6 +2766,11 @@ async def create_session( ) if local_session_id is not None: payload["sessionId"] = local_session_id + github_token_provider_registration_id = self._register_github_token_provider( + github_token_provider, local_session_id + ) + if github_token_provider_registration_id is not None: + payload["gitHubTokenProviderRegistrationId"] = github_token_provider_registration_id # Propagate W3C Trace Context to CLI if OpenTelemetry is active trace_ctx = get_trace_context() @@ -2521,7 +2785,20 @@ 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, + on_disconnect=( + None + if github_token_provider_registration_id is None + else lambda: self._unregister_github_token_provider( + github_token_provider_registration_id + ) + ), + ) if self._session_fs_config: if create_session_fs_handler is None: raise ValueError( @@ -2582,8 +2859,12 @@ def _initialize_session(sid: str) -> CopilotSession: # processing (e.g. sessionFs.writeFile for workspace metadata) can be # routed to the correct handlers. if local_session_id is not None: - session = _initialize_session(local_session_id) - registered_session_id = local_session_id + try: + session = _initialize_session(local_session_id) + registered_session_id = local_session_id + except BaseException: + self._unregister_github_token_provider(github_token_provider_registration_id) + raise try: rpc_start = time.perf_counter() @@ -2623,6 +2904,9 @@ def _register_inline(raw_response: Any) -> None: f"session.create returned sessionId {response.get('sessionId')} " f"but the caller requested {local_session_id}" ) + self._assign_github_token_provider( + github_token_provider_registration_id, session.session_id + ) if on_mcp_auth_request is not None: await self._client.request( "session.eventLog.registerInterest", @@ -2635,6 +2919,7 @@ def _register_inline(raw_response: Any) -> None: if registered_session_id is not None: with self._sessions_lock: self._sessions.pop(registered_session_id, None) + self._unregister_github_token_provider(github_token_provider_registration_id) if not isinstance(exc, asyncio.CancelledError): log_timing( logger, @@ -2653,6 +2938,10 @@ def _register_inline(raw_response: Any) -> None: custom_agents_local_only, coauthor_enabled, manage_schedule_enabled, + included_builtin_skills, + ) + self._commit_github_token_provider( + session.session_id, github_token_provider_registration_id ) log_timing( @@ -2673,6 +2962,7 @@ 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, @@ -2682,12 +2972,14 @@ async def resume_session( 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, @@ -2712,10 +3004,12 @@ async def resume_session( enable_host_git_operations: bool | None = None, enable_session_store: bool | None = None, enable_skills: bool | None = None, + included_builtin_skills: list[str] | None = None, skill_directories: list[str] | None = None, 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, @@ -2728,6 +3022,7 @@ async def resume_session( on_auto_mode_switch_request: AutoModeSwitchHandler | None = None, create_session_fs_handler: CreateSessionFsHandler | None = None, github_token: str | None = None, + github_token_provider: GitHubTokenProvider | None = None, remote_session: RemoteSessionMode | None = None, continue_pending_work: bool | None = None, canvases: list[CanvasDeclaration] | None = None, @@ -2740,6 +3035,8 @@ async def resume_session( 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. @@ -2759,6 +3056,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. @@ -2799,6 +3099,9 @@ async def resume_session( 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 @@ -2826,13 +3129,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 @@ -2845,6 +3144,10 @@ 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. @@ -2857,6 +3160,16 @@ 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 @@ -2879,6 +3192,15 @@ async def resume_session( 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``. + github_token_provider: Callback that acquires a short-lived GitHub + credential for this resumed session. Mutually exclusive with + ``github_token``. The new registration replaces the prior + provider only after resume succeeds. Returns: A :class:`CopilotSession` instance for the resumed session. @@ -2902,6 +3224,8 @@ async def resume_session( """ if on_permission_request is not None and not callable(on_permission_request): raise ValueError("on_permission_request must be callable when provided.") + if github_token is not None and github_token_provider is not None: + raise ValueError("github_token and github_token_provider are mutually exclusive") if not self._client: await self.start() @@ -2922,6 +3246,8 @@ async def resume_session( 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 @@ -2944,6 +3270,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} @@ -2955,6 +3283,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: @@ -2983,6 +3313,8 @@ async def resume_session( 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: @@ -3014,13 +3346,15 @@ 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) # Serialize commands (name + description only) into payload if commands: payload["commands"] = [ - {"name": cmd.name, "description": cmd.description} for cmd in commands + {"name": cmd.name, "description": cmd.description or ""} for cmd in commands ] if hooks and any(hooks.values()): @@ -3042,8 +3376,14 @@ async def resume_session( 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: @@ -3082,6 +3422,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: @@ -3097,6 +3439,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] = {} @@ -3144,7 +3488,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( @@ -3197,6 +3547,16 @@ async def resume_session( commands_count=len(commands or []), has_hooks=hooks is not None, ) + github_token_provider_registration_id = self._register_github_token_provider( + github_token_provider, session_id + ) + if github_token_provider_registration_id is not None: + payload["gitHubTokenProviderRegistrationId"] = github_token_provider_registration_id + session._set_disconnect_callback( + lambda: self._unregister_github_token_provider( + github_token_provider_registration_id + ) + ) try: rpc_start = time.perf_counter() @@ -3224,6 +3584,7 @@ async def resume_session( except BaseException as exc: with self._sessions_lock: self._sessions.pop(session_id, None) + self._unregister_github_token_provider(github_token_provider_registration_id) if not isinstance(exc, asyncio.CancelledError): log_timing( logger, @@ -3242,7 +3603,9 @@ async def resume_session( custom_agents_local_only, coauthor_enabled, manage_schedule_enabled, + included_builtin_skills, ) + self._commit_github_token_provider(session_id, github_token_provider_registration_id) log_timing( logger, @@ -3462,8 +3825,9 @@ async def delete_session(self, session_id: str) -> None: # Remove from local sessions map if present with self._sessions_lock: - if session_id in self._sessions: - del self._sessions[session_id] + session = self._sessions.pop(session_id, None) + if session is not None: + session._run_disconnect_callback() async def get_last_session_id(self) -> str | None: """ @@ -4132,7 +4496,7 @@ async def _connect_via_stdio(self) -> None: # Create JSON-RPC client with the process self._client = JsonRpcClient(self._process) - self._client.on_close = lambda: setattr(self, "_state", "disconnected") + self._client.on_close = self._handle_connection_close self._rpc = ServerRpc(self._client) # Set up notification handler for session events @@ -4251,9 +4615,9 @@ def kill(self): def wait(self, timeout=None): pass - self._process = SocketWrapper(sock_file, sock) # type: ignore + self._process = SocketWrapper(sock_file, sock) self._client = JsonRpcClient(self._process) - self._client.on_close = lambda: setattr(self, "_state", "disconnected") + self._client.on_close = self._handle_connection_close self._rpc = ServerRpc(self._client) # Set up notification handler for session events @@ -4297,6 +4661,7 @@ async def _apply_post_create_options_patch( custom_agents_local_only: bool | None, coauthor_enabled: bool | None, manage_schedule_enabled: bool | None, + included_builtin_skills: list[str] | None = None, ) -> None: """Apply empty-mode safe defaults (or caller-supplied overrides in copilot-cli mode) via ``session.options.update`` after create/resume. @@ -4312,6 +4677,7 @@ async def _apply_post_create_options_patch( custom_agents_local_only, coauthor_enabled, manage_schedule_enabled, + included_builtin_skills, ) if patch is None: return @@ -4330,6 +4696,9 @@ async def _apply_post_create_options_patch( SessionInstalledPlugin.from_dict(p) if isinstance(p, dict) else p for p in patch["installedPlugins"] ] + if "includedBuiltinSkills" in patch: + skills = patch["includedBuiltinSkills"] + params.included_builtin_skills = list(skills) if skills is not None else None try: await session.rpc.options.update(params) @@ -4374,9 +4743,56 @@ def _register_client_global_handlers(self) -> None: hooks=_HooksAdapter(self._get_session), llm_inference=llm_inference_adapter, git_hub_telemetry=github_telemetry_adapter, + git_hub_token=self._github_token_provider_adapter, ), ) + def _register_github_token_provider( + self, provider: GitHubTokenProvider | None, session_id: str | None + ) -> str | None: + if provider is None: + return None + registration_id = str(uuid.uuid4()) + with self._github_token_providers_lock: + self._github_token_providers[registration_id] = _GitHubTokenProviderRegistration( + provider, session_id + ) + return registration_id + + def _handle_connection_close(self) -> None: + self._state = "disconnected" + with self._github_token_providers_lock: + self._github_token_providers.clear() + + def _assign_github_token_provider(self, registration_id: str | None, session_id: str) -> None: + if registration_id is None: + return + with self._github_token_providers_lock: + registration = self._github_token_providers.get(registration_id) + if registration is not None: + registration.session_id = session_id + + def _unregister_github_token_provider(self, registration_id: str | None) -> None: + if registration_id is None: + return + with self._github_token_providers_lock: + self._github_token_providers.pop(registration_id, None) + + def _commit_github_token_provider(self, session_id: str, registration_id: str | None) -> None: + with self._github_token_providers_lock: + stale = [ + candidate_id + for candidate_id, registration in self._github_token_providers.items() + if registration.session_id == session_id and registration.committed + ] + for candidate_id in stale: + self._github_token_providers.pop(candidate_id, None) + if registration_id is not None: + registration = self._github_token_providers.get(registration_id) + if registration is not None: + registration.session_id = session_id + registration.committed = True + def _get_session(self, session_id: str) -> CopilotSession | None: with self._sessions_lock: return self._sessions.get(session_id) diff --git a/python/copilot/copilot_request_handler.py b/python/copilot/copilot_request_handler.py index e6465b7bbc..893309ca76 100644 --- a/python/copilot/copilot_request_handler.py +++ b/python/copilot/copilot_request_handler.py @@ -458,8 +458,12 @@ async def write_response(self, data: str | bytes) -> None: 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) + if isinstance(data, bytes): + payload = base64.b64encode(data).decode("ascii") + is_binary = True + else: + payload = data + is_binary = False await self._require_rpc().http_response_chunk( LlmInferenceHTTPResponseChunkRequest( data=payload, diff --git a/python/copilot/generated/rpc.py b/python/copilot/generated/rpc.py index 713e78cca0..1d59a55f4a 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, Attachment, ContextTier, EmbeddedBlobResourceContents, EmbeddedTextResourceContents, McpServerSource, McpServerStatus, PermissionPromptRequest, PermissionRule, ReasoningSummary, SessionEvent, SessionLimitsConfig, SessionMode, ShutdownType, SkillSource, UserToolSessionApproval, Verbosity +from .session_events import AbortReason, Attachment, ContextTier, EmbeddedBlobResourceContents, EmbeddedTextResourceContents, McpOauthHttpResponse, McpOauthWWWAuthenticateParams, McpServerSource, McpServerStatus, ModelChangeSource, PermissionMode, PermissionPromptRequest, PermissionRule, ReasoningSummary, SessionEvent, SessionLimitsConfig, SessionMode, ShutdownType, SkillSource, TaskCompletionOutcome, UserToolSessionApproval, Verbosity if TYPE_CHECKING: from .._jsonrpc import JsonRpcClient @@ -69,8 +69,9 @@ def to_enum(c: type[EnumT], x: Any) -> EnumT: return x.value def from_int(x: Any) -> int: - assert isinstance(x, int) and not isinstance(x, bool) - return x + assert isinstance(x, (int, float)) and not isinstance(x, bool) + assert not isinstance(x, float) or x.is_integer() + return int(x) def from_datetime(x: Any) -> datetime: return dateutil.parser.parse(x) @@ -126,23 +127,36 @@ class CopilotUserResponseEndpoints: """Endpoint URLs from the raw Copilot `/copilot_internal/v2/token` user-response passthrough.""" api: str | None = None + """Copilot API endpoint URL.""" + + exp: str | None = None + """Experimental-service endpoint URL.""" + origin_tracker: str | None = None + """Origin-tracker endpoint URL.""" + proxy: str | None = None + """Copilot proxy endpoint URL.""" + telemetry: str | None = None + """Copilot telemetry endpoint URL.""" @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, origin_tracker, proxy, 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: @@ -257,19 +271,22 @@ class AuthInfoType(Enum): GH_CLI = "gh-cli" HMAC = "hmac" TOKEN = "token" + TOKEN_PROVIDER = "token-provider" 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. + """Authenticated account entry returned by `account.getAllUsers`. List of all authenticated users """ auth_info: AuthInfo """Authentication information for this user""" + selection_id: str | None = None + """Opaque identifier accepted by account and model selection APIs""" + token: str | None = None """Associated token, if available""" @@ -277,12 +294,15 @@ class AccountAllUsers: def from_dict(obj: Any) -> 'AccountAllUsers': assert isinstance(obj, dict) auth_info = _load_AuthInfo(obj.get("authInfo")) + selection_id = from_union([from_str, from_none], obj.get("selectionId")) token = from_union([from_str, from_none], obj.get("token")) - return AccountAllUsers(auth_info, token) + return AccountAllUsers(auth_info, selection_id, token) def to_dict(self) -> dict: result: dict = {} result["authInfo"] = (self.auth_info).to_dict() + if self.selection_id is not None: + result["selectionId"] = from_union([from_str, from_none], self.selection_id) if self.token is not None: result["token"] = from_union([from_str, from_none], self.token) return result @@ -317,20 +337,27 @@ def to_dict(self) -> dict: @dataclass class AccountGetQuotaRequest: git_hub_token: str | None = None - """GitHub token for per-user quota lookup. When provided, resolves this token to determine - the user's quota instead of using the global auth. + """GitHub token accepted for compatibility with existing SDK clients. When provided, + resolves this token instead of using the current account. + """ + selection_id: str | None = None + """Opaque account identifier returned by `account.getAllUsers`. When omitted, the current + account is used. """ @staticmethod def from_dict(obj: Any) -> 'AccountGetQuotaRequest': assert isinstance(obj, dict) git_hub_token = from_union([from_str, from_none], obj.get("gitHubToken")) - return AccountGetQuotaRequest(git_hub_token) + selection_id = from_union([from_str, from_none], obj.get("selectionId")) + return AccountGetQuotaRequest(git_hub_token, selection_id) 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) + if self.selection_id is not None: + result["selectionId"] = from_union([from_str, from_none], self.selection_id) return result # Experimental: this type is part of an experimental API and may change or be removed. @@ -392,30 +419,34 @@ def to_dict(self) -> dict: # Experimental: this type is part of an experimental API and may change or be removed. @dataclass class AccountLoginRequest: - """Credentials to store after successful authentication""" - + """Credentials to validate and store. Omit login to resolve the authenticated user from the + token. + """ host: str """GitHub host URL""" - login: str - """User login/username""" - token: str """GitHub authentication token""" + login: str | None = None + """User login/username. When omitted, the runtime validates the token and resolves the login + from GitHub. + """ + @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) + login = from_union([from_str, from_none], obj.get("login")) + return AccountLoginRequest(host, token, login) 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) + 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. @@ -445,18 +476,25 @@ def to_dict(self) -> dict: class AccountLogoutRequest: """User to log out""" - auth_info: AuthInfo + auth_info: AuthInfo | None = None """Authentication information for the user to log out""" + selection_id: str | None = None + """Opaque account identifier returned by `account.getAllUsers`""" + @staticmethod def from_dict(obj: Any) -> 'AccountLogoutRequest': assert isinstance(obj, dict) - auth_info = _load_AuthInfo(obj.get("authInfo")) - return AccountLogoutRequest(auth_info) + auth_info = from_union([_load_AuthInfo, from_none], obj.get("authInfo")) + selection_id = from_union([from_str, from_none], obj.get("selectionId")) + return AccountLogoutRequest(auth_info, selection_id) def to_dict(self) -> dict: result: dict = {} - result["authInfo"] = (self.auth_info).to_dict() + if self.auth_info is not None: + result["authInfo"] = from_union([lambda x: (x).to_dict(), from_none], self.auth_info) + if self.selection_id is not None: + result["selectionId"] = from_union([from_str, from_none], self.selection_id) return result # Experimental: this type is part of an experimental API and may change or be removed. @@ -675,23 +713,101 @@ def to_dict(self) -> dict: result["projectPaths"] = from_union([lambda x: from_list(from_str, x), from_none], self.project_paths) return result +class APIKeyAuthInfoType(Enum): + API_KEY = "api-key" + # Experimental: this type is part of an experimental API and may change or be removed. -class PermissionsAllowAllMode(Enum): - """Authoritative allow-all mode after the mutation +@dataclass +class AuthValidationError: + """Validation error from an authentication attempt. - Current or requested allow-all mode. + Validation errors from the most recent authentication attempt. + """ + message: str + """Authentication validation error message""" - Current allow-all mode + github_message: str | None = None + """Optional message returned by GitHub""" - Allow-all mode to apply. `on` enables full allow-all; `auto` enables advisory LLM - auto-approval; `off` disables both. + @staticmethod + def from_dict(obj: Any) -> 'AuthValidationError': + assert isinstance(obj, dict) + message = from_str(obj.get("message")) + github_message = from_union([from_str, from_none], obj.get("githubMessage")) + return AuthValidationError(message, github_message) + + def to_dict(self) -> dict: + result: dict = {} + result["message"] = from_str(self.message) + if self.github_message is not None: + result["githubMessage"] = from_union([from_str, from_none], self.github_message) + 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 provider or provider-model metadata. This is not + necessarily the provider-facing deployment or model name and does not indicate CAPI + entitlement or provider availability. """ - AUTO = "auto" - OFF = "off" - ON = "on" -class APIKeyAuthInfoType(Enum): - API_KEY = "api-key" + @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. +class BuiltinToolFormatType(Enum): + """Custom input-format discriminator. + + Custom input-format kind. + """ + GRAMMAR = "grammar" + +# Experimental: this type is part of an experimental API and may change or be removed. +class BuiltinToolInputSchemaType(Enum): + """Root type of the tool input schema. + + Root JSON Schema type for a built-in tool input. + """ + OBJECT = "object" + +# Experimental: this type is part of an experimental API and may change or be removed. +@dataclass +class BuiltinToolSafeTelemetryFields: + """Per-field telemetry safety + + Per-field telemetry-safety policy for a built-in tool. + """ + inputs_names: bool | None = None + """Whether tool input names may be included in telemetry without obfuscation.""" + + name: bool | None = None + """Whether the tool name may be included in telemetry without obfuscation.""" + + @staticmethod + def from_dict(obj: Any) -> 'BuiltinToolSafeTelemetryFields': + assert isinstance(obj, dict) + inputs_names = from_union([from_bool, from_none], obj.get("inputsNames")) + name = from_union([from_bool, from_none], obj.get("name")) + return BuiltinToolSafeTelemetryFields(inputs_names, name) + + def to_dict(self) -> dict: + result: dict = {} + if self.inputs_names is not None: + result["inputsNames"] = from_union([from_bool, from_none], self.inputs_names) + if self.name is not None: + result["name"] = from_union([from_bool, from_none], self.name) + return result # Experimental: this type is part of an experimental API and may change or be removed. @dataclass @@ -882,6 +998,54 @@ 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 CanvasProviderRegisterRequest: + """Internal canvas provider registration parameters.""" + + canvases: list[Any] + """Canvas contributions supplied by the provider""" + + connection_id: str + """Connection identifier for callback routing""" + + info: Any + """Provider metadata supplied by the host""" + + @staticmethod + def from_dict(obj: Any) -> 'CanvasProviderRegisterRequest': + assert isinstance(obj, dict) + canvases = from_list(lambda x: x, obj.get("canvases")) + connection_id = from_str(obj.get("connectionId")) + info = obj.get("info") + return CanvasProviderRegisterRequest(canvases, connection_id, info) + + def to_dict(self) -> dict: + result: dict = {} + result["canvases"] = from_list(lambda x: x, self.canvases) + result["connectionId"] = from_str(self.connection_id) + result["info"] = self.info + return result + +# Experimental: this type is part of an experimental API and may change or be removed. +@dataclass +class CanvasProviderUnregisterRequest: + """Internal canvas provider unregistration parameters.""" + + connection_id: str + """Connection identifier to unregister""" + + @staticmethod + def from_dict(obj: Any) -> 'CanvasProviderUnregisterRequest': + assert isinstance(obj, dict) + connection_id = from_str(obj.get("connectionId")) + return CanvasProviderUnregisterRequest(connection_id) + + def to_dict(self) -> dict: + result: dict = {} + result["connectionId"] = from_str(self.connection_id) + return result + # Experimental: this type is part of an experimental API and may change or be removed. @dataclass class CapiSessionOptions: @@ -907,6 +1071,418 @@ def to_dict(self) -> dict: 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. +class CardDigestAlgorithm(Enum): + """Canonical digest algorithm for a validated MCP card""" + + SHA256_RFC8785 = "sha256-rfc8785" + +class Installability(Enum): + NOT_INSTALLABLE_KIND = "not-installable-kind" + +class CatalogAISkillCandidateKind(Enum): + AI_SKILL = "ai-skill" + +class MediaType(Enum): + APPLICATION_AI_SKILL = "application/ai-skill" + +class CatalogCandidateSourceKind(Enum): + """Discriminator for a URL-backed MCP server card + + Discriminator for an embedded MCP server card + """ + EMBEDDED = "embedded" + URL = "url" + +class CatalogAuthenticationRequiredErrorKind(Enum): + AUTHENTICATION_REQUIRED = "authentication-required" + +# Experimental: this type is part of an experimental API and may change or be removed. +class CatalogAuthenticationRequiredReason(Enum): + """Why authentication failed. Only an expired credential justifies attempting a silent + refresh; an absent or rejected credential requires sign-in. + + Why the catalog authority did not accept the caller's identity + """ + CREDENTIAL_EXPIRED = "credential-expired" + CREDENTIAL_REJECTED = "credential-rejected" + NO_CREDENTIAL = "no-credential" + +class CatalogCandidateInstallability(Enum): + """Whether this MCP server can be planned for installation, and if policy prevents it. + + Whether an MCP server candidate can be planned for installation + """ + INSTALLABLE = "installable" + NOT_INSTALLABLE_KIND = "not-installable-kind" + NOT_INSTALLABLE_POLICY = "not-installable-policy" + +# Experimental: this type is part of an experimental API and may change or be removed. +class CatalogCandidateKind(Enum): + """What kind of resource a catalog candidate describes""" + + AI_SKILL = "ai-skill" + MCP_SERVER = "mcp-server" + +# Experimental: this type is part of an experimental API and may change or be removed. +class CatalogMediaType(Enum): + """JSON MCP media type of the underlying card. + + JSON MCP card media type accepted for install planning + + JSON MCP media type advertised for the referenced card. + + JSON MCP media type the validated card was interpreted as. + + Media type the card is expected to conform to. + + Media type the card was interpreted as, when it declared one this runtime recognises. + + Media type a catalog card is interpreted as + """ + APPLICATION_AI_SKILL = "application/ai-skill" + APPLICATION_MCP_SERVER_CARD_JSON = "application/mcp-server-card+json" + APPLICATION_MCP_SERVER_JSON = "application/mcp-server+json" + +# Experimental: this type is part of an experimental API and may change or be removed. +class MCPServerCardEmbeddedKind(Enum): + """Discriminator for an embedded MCP server card""" + + EMBEDDED = "embedded" + +# Experimental: this type is part of an experimental API and may change or be removed. +class MCPServerCardURLKind(Enum): + """Discriminator for a URL-backed MCP server card""" + + URL = "url" + +# Experimental: this type is part of an experimental API and may change or be removed. +class CatalogCapability(Enum): + """A wire feature a caller can require of the catalog surface, negotiated per request. A + grant means the runtime understands the feature's contract, not that the deployment has + enabled the operation; typed unavailable results report availability separately. + """ + AI_SKILL_DISCOVERY = "ai-skill-discovery" + LEGACY_MCP_SERVER_CARD = "legacy-mcp-server-card" + MCP_INSTALL_PLANNING = "mcp-install-planning" + MCP_SERVER_CARD = "mcp-server-card" + MULTIPLE_TRANSPORT_CHOICE = "multiple-transport-choice" + +# Experimental: this type is part of an experimental API and may change or be removed. +@dataclass +class CatalogClientContract: + """The protocol version and capability set a caller requires, supplied on every catalog + request so negotiation cannot be skipped by omission. + + Protocol version and capabilities the caller requires. + """ + protocol_version: int + """SDK protocol version the caller was generated against. A caller below the runtime's + minimum supported version is refused rather than served a partial result. + """ + required_capabilities: list[str] + """Wire features the caller requires the runtime to understand. Identifiers are bounded but + extensible so a newer caller can negotiate with an older runtime. Requiring an unknown + feature yields a typed refusal listing what is understood, never a partial grant. A grant + does not promise that a deployment has enabled the operation; typed unavailable results + report that separately. + """ + + @staticmethod + def from_dict(obj: Any) -> 'CatalogClientContract': + assert isinstance(obj, dict) + protocol_version = from_int(obj.get("protocolVersion")) + required_capabilities = from_list(from_str, obj.get("requiredCapabilities")) + return CatalogClientContract(protocol_version, required_capabilities) + + def to_dict(self) -> dict: + result: dict = {} + result["protocolVersion"] = from_int(self.protocol_version) + result["requiredCapabilities"] = from_list(from_str, self.required_capabilities) + return result + +class CatalogContractViolationErrorKind(Enum): + CONTRACT_VIOLATION = "contract-violation" + +# Experimental: this type is part of an experimental API and may change or be removed. +class CatalogContractViolationReason(Enum): + """Which rule the response broke. + + Which wire-contract rule an upstream response broke + """ + BOTH_URL_AND_DATA = "both-url-and-data" + DUPLICATE_IDENTITY = "duplicate-identity" + NEITHER_URL_NOR_DATA = "neither-url-nor-data" + UNKNOWN_MEDIA_TYPE = "unknown-media-type" + +# Experimental: this type is part of an experimental API and may change or be removed. +class CatalogHandleType(Enum): + """Which kind of handle was presented. + + Which kind of opaque handle was presented + """ + CANDIDATE = "candidate" + PLAN = "plan" + +class CatalogHandleRejectedErrorKind(Enum): + HANDLE_REJECTED = "handle-rejected" + +# Experimental: this type is part of an experimental API and may change or be removed. +class CatalogHandleRejectionReason(Enum): + """Why the handle was rejected. + + Why a presented handle was rejected + """ + FOREIGN = "foreign" + INVALID = "invalid" + REPLAYED = "replayed" + STALE = "stale" + +# Experimental: this type is part of an experimental API and may change or be removed. +class CatalogInvalidRequestField(Enum): + """Which request field was rejected. + + Which request field was rejected before any work was done + """ + CARD = "card" + CONTRACT = "contract" + KINDS = "kinds" + LIMIT = "limit" + QUERY = "query" + SCOPE = "scope" + SOURCE = "source" + +class CatalogInvalidRequestErrorKind(Enum): + INVALID_REQUEST = "invalid-request" + +class CatalogMalformedCardErrorKind(Enum): + MALFORMED_CARD = "malformed-card" + +# Experimental: this type is part of an experimental API and may change or be removed. +class CatalogMalformedCardReason(Enum): + """How the card failed validation. + + How a card failed validation + """ + INVALID_JSON = "invalid-json" + MISSING_REQUIRED_FIELD = "missing-required-field" + SCHEMA_VIOLATION = "schema-violation" + SIZE_LIMIT_EXCEEDED = "size-limit-exceeded" + UNSUPPORTED_MEDIA_TYPE = "unsupported-media-type" + +# Experimental: this type is part of an experimental API and may change or be removed. +class CatalogMCPServerInstallabilityEnum(Enum): + """Whether this MCP server can be planned for installation, and if policy prevents it. + + Whether an MCP server candidate can be planned for installation + """ + INSTALLABLE = "installable" + NOT_INSTALLABLE_POLICY = "not-installable-policy" + +class CatalogMCPServerCandidateKind(Enum): + MCP_SERVER = "mcp-server" + +# Experimental: this type is part of an experimental API and may change or be removed. +class MCPServerCardMediaType(Enum): + """JSON MCP media type of the underlying card. + + JSON MCP card media type accepted for install planning + + JSON MCP media type advertised for the referenced card. + + JSON MCP media type the validated card was interpreted as. + + Media type the card is expected to conform to. + """ + APPLICATION_MCP_SERVER_CARD_JSON = "application/mcp-server-card+json" + APPLICATION_MCP_SERVER_JSON = "application/mcp-server+json" + +class CatalogNegotiationRefusedErrorKind(Enum): + NEGOTIATION_REFUSED = "negotiation-refused" + +# Experimental: this type is part of an experimental API and may change or be removed. +class CatalogNegotiationRefusedReason(Enum): + """Whether the version or the capability set was the problem. + + Why capability and protocol-version negotiation refused a caller + """ + UNSUPPORTED_CAPABILITY = "unsupported-capability" + UNSUPPORTED_PROTOCOL_VERSION = "unsupported-protocol-version" + +class CatalogNetworkFailureErrorKind(Enum): + NETWORK_FAILURE = "network-failure" + +# Experimental: this type is part of an experimental API and may change or be removed. +class CatalogNetworkFailureReason(Enum): + """Categorised failure, low cardinality so it can be aggregated without carrying a URL. + + Categorised network failure, low cardinality so it can be aggregated without carrying a + URL + """ + CONNECTION_REFUSED = "connection-refused" + DNS = "dns" + HTTP_STATUS = "http-status" + OFFLINE = "offline" + REDIRECT_REJECTED = "redirect-rejected" + RESPONSE_TOO_LARGE = "response-too-large" + TIMEOUT = "timeout" + TLS = "tls" + +class CatalogNotInstallableErrorKind(Enum): + NOT_INSTALLABLE = "not-installable" + +# Experimental: this type is part of an experimental API and may change or be removed. +class CatalogNotInstallableReason(Enum): + """Why the candidate cannot be installed. + + Why a discoverable candidate cannot be installed + """ + AI_SKILL_NOT_INSTALLABLE = "ai-skill-not-installable" + KIND_NOT_INSTALLABLE = "kind-not-installable" + POLICY_FORBIDS = "policy-forbids" + +class CatalogPolicyRejectedErrorKind(Enum): + POLICY_REJECTED = "policy-rejected" + +# Experimental: this type is part of an experimental API and may change or be removed. +class MCPPlanPolicySource(Enum): + """Which authority produced the decision. + + Which authority produced a policy decision + """ + ENTERPRISE_ALLOWLIST = "enterprise-allowlist" + LOCAL_TRUST = "local-trust" + NONE = "none" + REGISTRY_POLICY = "registry-policy" + +class CatalogSearchResultKind(Enum): + AUTHENTICATION_REQUIRED = "authentication-required" + CONTRACT_VIOLATION = "contract-violation" + INVALID_REQUEST = "invalid-request" + MALFORMED_CARD = "malformed-card" + NEGOTIATION_REFUSED = "negotiation-refused" + NETWORK_FAILURE = "network-failure" + POLICY_REJECTED = "policy-rejected" + SUCCEEDED = "succeeded" + UNAVAILABLE = "unavailable" + UNSAFE_RETRIEVAL = "unsafe-retrieval" + UNSUPPORTED_KIND = "unsupported-kind" + +class CatalogSearchResultReason(Enum): + """Whether the version or the capability set was the problem. + + Why capability and protocol-version negotiation refused a caller + + Why authentication failed. Only an expired credential justifies attempting a silent + refresh; an absent or rejected credential requires sign-in. + + Why the catalog authority did not accept the caller's identity + + Categorised failure, low cardinality so it can be aggregated without carrying a URL. + + Categorised network failure, low cardinality so it can be aggregated without carrying a + URL + + Which control refused the retrieval, low cardinality so it can be aggregated without + carrying a URL. + + Which hardened-fetch control refused a retrieval + + How the card failed validation. + + How a card failed validation + + Which rule the response broke. + + Which wire-contract rule an upstream response broke + + Why the operation is unavailable. + + Why a catalog operation is not available on this runtime + """ + AUTHORITY_NOT_CONFIGURED = "authority-not-configured" + BLOCKED_ADDRESS = "blocked-address" + BLOCKED_SCHEME = "blocked-scheme" + BOTH_URL_AND_DATA = "both-url-and-data" + CONNECTION_REFUSED = "connection-refused" + CREDENTIALS_IN_URL = "credentials-in-url" + CREDENTIAL_EXPIRED = "credential-expired" + CREDENTIAL_REJECTED = "credential-rejected" + DISABLED_BY_POLICY = "disabled-by-policy" + DNS = "dns" + DUPLICATE_IDENTITY = "duplicate-identity" + HOST_NOT_PERMITTED = "host-not-permitted" + HTTP_STATUS = "http-status" + INVALID_JSON = "invalid-json" + MISSING_REQUIRED_FIELD = "missing-required-field" + NEITHER_URL_NOR_DATA = "neither-url-nor-data" + NO_CREDENTIAL = "no-credential" + OFFLINE = "offline" + PLANNING_UNAVAILABLE = "planning-unavailable" + PROXY_REJECTED = "proxy-rejected" + REDIRECT_REJECTED = "redirect-rejected" + REDIRECT_TO_BLOCKED_ADDRESS = "redirect-to-blocked-address" + RESPONSE_TOO_LARGE = "response-too-large" + SCHEMA_VIOLATION = "schema-violation" + SEARCH_UNAVAILABLE = "search-unavailable" + SIZE_LIMIT_EXCEEDED = "size-limit-exceeded" + TIMEOUT = "timeout" + TLS = "tls" + UNKNOWN_MEDIA_TYPE = "unknown-media-type" + UNSUPPORTED_CAPABILITY = "unsupported-capability" + UNSUPPORTED_MEDIA_TYPE = "unsupported-media-type" + UNSUPPORTED_PROTOCOL_VERSION = "unsupported-protocol-version" + +class CatalogSearchSucceededKind(Enum): + SUCCEEDED = "succeeded" + +class CatalogUnavailableErrorKind(Enum): + UNAVAILABLE = "unavailable" + +# Experimental: this type is part of an experimental API and may change or be removed. +class CatalogUnavailableReason(Enum): + """Why the operation is unavailable. + + Why a catalog operation is not available on this runtime + """ + AUTHORITY_NOT_CONFIGURED = "authority-not-configured" + DISABLED_BY_POLICY = "disabled-by-policy" + PLANNING_UNAVAILABLE = "planning-unavailable" + SEARCH_UNAVAILABLE = "search-unavailable" + +class CatalogUnavailableTransportErrorKind(Enum): + UNAVAILABLE_TRANSPORT = "unavailable-transport" + +# Experimental: this type is part of an experimental API and may change or be removed. +class CatalogUnavailableTransportReason(Enum): + """Why no transport could be offered. + + Why no usable transport could be offered + """ + NO_ELIGIBLE_TRANSPORT = "no-eligible-transport" + REMOTE_ENUMERATION_UNAVAILABLE = "remote-enumeration-unavailable" + TRANSPORT_NOT_SUPPORTED = "transport-not-supported" + +class CatalogUnsafeRetrievalErrorKind(Enum): + UNSAFE_RETRIEVAL = "unsafe-retrieval" + +# Experimental: this type is part of an experimental API and may change or be removed. +class CatalogUnsafeRetrievalReason(Enum): + """Which control refused the retrieval, low cardinality so it can be aggregated without + carrying a URL. + + Which hardened-fetch control refused a retrieval + """ + BLOCKED_ADDRESS = "blocked-address" + BLOCKED_SCHEME = "blocked-scheme" + CREDENTIALS_IN_URL = "credentials-in-url" + HOST_NOT_PERMITTED = "host-not-permitted" + PROXY_REJECTED = "proxy-rejected" + REDIRECT_TO_BLOCKED_ADDRESS = "redirect-to-blocked-address" + +class CatalogUnsupportedKindErrorKind(Enum): + UNSUPPORTED_KIND = "unsupported-kind" + # Experimental: this type is part of an experimental API and may change or be removed. @dataclass class SlashCommandInputChoice: @@ -946,6 +1522,41 @@ class SlashCommandKind(Enum): CLIENT = "client" SKILL = "skill" +# Experimental: this type is part of an experimental API and may change or be removed. +class CommandsInvocationEffectOutcome(Enum): + """Whether the host applied or cancelled the pending invocation effect. + + Whether a pending slash-command invocation effect was applied or cancelled by the host. + """ + APPLIED = "applied" + CANCELLED = "cancelled" + +# Experimental: this type is part of an experimental API and may change or be removed. +@dataclass +class CommandsFinalizeInvocationEffectResult: + """Whether finalizing the invocation effect succeeded, and the failure reason when it did + not. + """ + success: bool + """Whether the pending invocation effect was finalized successfully.""" + + error: str | None = None + """Failure reason when the invocation effect could not be finalized.""" + + @staticmethod + def from_dict(obj: Any) -> 'CommandsFinalizeInvocationEffectResult': + assert isinstance(obj, dict) + success = from_bool(obj.get("success")) + error = from_union([from_str, from_none], obj.get("error")) + return CommandsFinalizeInvocationEffectResult(success, error) + + def to_dict(self) -> dict: + result: dict = {} + 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 CommandsHandlePendingCommandRequest: @@ -991,61 +1602,10 @@ def to_dict(self) -> dict: return result # Experimental: this type is part of an experimental API and may change or be removed. -@dataclass -class CommandsInvokeRequest: - """Slash command name and optional raw input string to invoke.""" - - name: str - """Command name. Leading slashes are stripped and the name is matched case-insensitively.""" - - input: str | None = None - """Raw input after the command name""" +class CommandsInvocationOrigin(Enum): + """Optional client surface that initiated the invocation""" - @staticmethod - def from_dict(obj: Any) -> 'CommandsInvokeRequest': - assert isinstance(obj, dict) - name = from_str(obj.get("name")) - input = from_union([from_str, from_none], obj.get("input")) - return CommandsInvokeRequest(name, input) - - def to_dict(self) -> dict: - result: dict = {} - result["name"] = from_str(self.name) - if self.input is not None: - 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 + SETTINGS = "settings" # Experimental: this type is part of an experimental API and may change or be removed. @dataclass @@ -1093,29 +1653,6 @@ 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 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 CompletionsRequestRequest: @@ -1216,56 +1753,68 @@ 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 ConnectRemoteSessionParams: - """Remote session connection parameters.""" +class _ConnectClientInfo: + """Identity of the integrating host, declared once on the `server.connect` handshake so + telemetry from this connection is attributed to a single, consistent surface. All fields + are optional; omit them to keep the default attribution. - session_id: str - """Session ID to connect to.""" + Identity of the integrating host. Optional; omit it to keep the default attribution. + """ + editor_name: str | None = None + """Name of the host editor, e.g. `"vscode"`.""" + + editor_version: str | None = None + """Version of the host editor, e.g. `"1.124.2"`. Ignored unless it looks like a version + string. + """ + extension_name: str | None = None + """Name of the Copilot extension within the host, e.g. `"copilot-chat"`.""" + + extension_version: str | None = None + """Version of the Copilot extension within the host, e.g. `"0.54.0"`. Ignored unless it + looks like a version string. + """ @staticmethod - def from_dict(obj: Any) -> 'ConnectRemoteSessionParams': + def from_dict(obj: Any) -> '_ConnectClientInfo': assert isinstance(obj, dict) - session_id = from_str(obj.get("sessionId")) - return ConnectRemoteSessionParams(session_id) + editor_name = from_union([from_str, from_none], obj.get("editorName")) + editor_version = from_union([from_str, from_none], obj.get("editorVersion")) + extension_name = from_union([from_str, from_none], obj.get("extensionName")) + extension_version = from_union([from_str, from_none], obj.get("extensionVersion")) + return _ConnectClientInfo(editor_name, editor_version, extension_name, extension_version) def to_dict(self) -> dict: result: dict = {} - result["sessionId"] = from_str(self.session_id) + if self.editor_name is not None: + result["editorName"] = from_union([from_str, from_none], self.editor_name) + if self.editor_version is not None: + result["editorVersion"] = from_union([from_str, from_none], self.editor_version) + if self.extension_name is not None: + result["extensionName"] = from_union([from_str, from_none], self.extension_name) + if self.extension_version is not None: + result["extensionVersion"] = from_union([from_str, from_none], self.extension_version) 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: - """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, in - addition to the runtime's normal GitHub/CTS emission (dual-write). 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. - """ - token: str | None = None - """Connection token; required when the server was started with COPILOT_CONNECTION_TOKEN""" +class ConnectRemoteSessionParams: + """Remote session connection parameters.""" + + session_id: str + """Session ID to connect to.""" @staticmethod - def from_dict(obj: Any) -> '_ConnectRequest': + def from_dict(obj: Any) -> 'ConnectRemoteSessionParams': 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(enable_git_hub_telemetry_forwarding, token) + session_id = from_str(obj.get("sessionId")) + return ConnectRemoteSessionParams(session_id) 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) + result["sessionId"] = from_str(self.session_id) return result # Experimental: this type is part of an experimental API and may change or be removed. @@ -1334,6 +1883,52 @@ 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 @@ -1811,6 +2406,84 @@ def to_dict(self) -> dict: 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 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""" @@ -1875,6 +2548,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 = "*" @@ -1928,7 +2623,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" @@ -1983,6 +2693,8 @@ def to_dict(self) -> dict: class ExtensionSource(Enum): """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" @@ -2001,6 +2713,39 @@ class ExtensionStatus(Enum): 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: @@ -2130,29 +2875,47 @@ class FactoryAgentOptions: 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) -> 'FactoryAgentOptions': assert isinstance(obj, dict) + 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(label, model, schema) + return FactoryAgentOptions(agent, context_tier, label, model, reasoning_effort, schema) def to_dict(self) -> dict: result: dict = {} + 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 @@ -2196,6 +2959,88 @@ def to_dict(self) -> dict: 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 FactoryCurrentPhase: + """Current factory phase identity.""" + + id: str + """Current phase identifier.""" + + ordinal: int | None = None + """Zero-based declared phase ordinal, or null for an undeclared phase.""" + + @staticmethod + def from_dict(obj: Any) -> 'FactoryCurrentPhase': + assert isinstance(obj, dict) + 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["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 FactoryDeclaredLimits: + """Declared or approved factory resource ceilings. + + Resource ceilings declared by the factory. + """ + max_ai_credits: float | None = None + """Maximum AI credits consumed by subagents and descendants.""" + + max_concurrent_subagents: int | None = None + """Maximum concurrently active subagents.""" + + max_total_subagents: int | None = None + """Maximum total subagents spawned by the run.""" + + timeout_seconds: float | None = None + """Maximum accumulated active execution time in seconds.""" + + @staticmethod + def from_dict(obj: Any) -> 'FactoryDeclaredLimits': + assert isinstance(obj, dict) + 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 = {} + 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. +class FactoryDurableOperation(Enum): + """Execution-critical factory storage operation. + + 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" + REFRESH_LEASE = "refreshLease" + RELEASE_AGENT = "releaseAgent" + RESERVE_AGENT = "reserveAgent" + # Experimental: this type is part of an experimental API and may change or be removed. @dataclass class FactoryExecuteRequest: @@ -2204,6 +3049,9 @@ class FactoryExecuteRequest: args: Any """Factory input value.""" + execution_token: str + """Opaque token identifying this factory execution attempt.""" + name: str """Registered factory name.""" @@ -2217,14 +3065,16 @@ class FactoryExecuteRequest: def from_dict(obj: Any) -> 'FactoryExecuteRequest': assert isinstance(obj, dict) 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, name, run_id, session_id) + return FactoryExecuteRequest(args, execution_token, name, run_id, session_id) def to_dict(self) -> dict: result: dict = {} 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) @@ -2235,7 +3085,7 @@ def to_dict(self) -> dict: class FactoryExecuteResult: """Result returned by an extension factory closure.""" - result: Any + result: Any = None """Factory result value.""" @staticmethod @@ -2246,7 +3096,51 @@ def from_dict(obj: Any) -> 'FactoryExecuteResult': def to_dict(self) -> dict: result: dict = {} - result["result"] = self.result + 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 FactoryGetRunProgressRequest: + """Parameters for paging factory progress.""" + + 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) -> 'FactoryGetRunProgressRequest': + assert isinstance(obj, dict) + 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["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. @@ -2273,6 +3167,9 @@ def to_dict(self) -> dict: class FactoryJournalGetRequest: """Parameters for reading a factory journal entry.""" + execution_token: str + """Opaque token identifying the current factory execution attempt.""" + key: str """Namespaced journal key.""" @@ -2282,12 +3179,14 @@ class FactoryJournalGetRequest: @staticmethod def from_dict(obj: Any) -> 'FactoryJournalGetRequest': assert isinstance(obj, dict) + execution_token = from_str(obj.get("executionToken")) key = from_str(obj.get("key")) run_id = from_str(obj.get("runId")) - return FactoryJournalGetRequest(key, run_id) + return FactoryJournalGetRequest(execution_token, key, run_id) def to_dict(self) -> dict: result: dict = {} + result["executionToken"] = from_str(self.execution_token) result["key"] = from_str(self.key) result["runId"] = from_str(self.run_id) return result @@ -2322,6 +3221,9 @@ def to_dict(self) -> dict: class FactoryJournalPutRequest: """Parameters for storing a factory journal entry.""" + execution_token: str + """Opaque token identifying the current factory execution attempt.""" + key: str """Namespaced journal key.""" @@ -2334,26 +3236,97 @@ class FactoryJournalPutRequest: @staticmethod def from_dict(obj: Any) -> 'FactoryJournalPutRequest': assert isinstance(obj, dict) + 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(key, result_json, run_id) + return FactoryJournalPutRequest(execution_token, key, result_json, run_id) def to_dict(self) -> dict: result: dict = {} + 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. -class FactoryLogLineKind(Enum): - """Progress line kind. +@dataclass +class FactoryListRunsRequest: + """Parameters for paging factory runs.""" - Kind of factory progress line. + after_seq: int | None = None + """Exclusive forward cursor.""" + + before_seq: int | None = None + """Exclusive backward cursor.""" + + limit: int | None = None + """Maximum terminal runs to return. Defaults to 200 and is capped at 500.""" + + @staticmethod + def from_dict(obj: Any) -> 'FactoryListRunsRequest': + assert isinstance(obj, dict) + 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 = {} + 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 FactoryRunConsumed: + """Durable resource consumption. + + Durable factory resource consumption. """ - LOG = "log" - PHASE = "phase" + active_ms: int + """Accumulated active execution time in milliseconds.""" + + nano_aiu: int + """AI usage consumed by the run in nano-AIU.""" + + subagents: int + """Total subagents spawned by the run.""" + + @staticmethod + def from_dict(obj: Any) -> 'FactoryRunConsumed': + assert isinstance(obj, dict) + 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["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. +class FactoryRunStatus(Enum): + """Current factory run status. + + Current or terminal state of a factory run. + + Current or terminal factory run status. + """ + CANCELLED = "cancelled" + COMPLETED = "completed" + ERROR = "error" + HALTED = "halted" + PENDING = "pending" + RUNNING = "running" # Experimental: this type is part of an experimental API and may change or be removed. class FactoryRunFailureKind(Enum): @@ -2361,60 +3334,84 @@ class FactoryRunFailureKind(Enum): Cumulative resource ceiling that stopped a factory run. """ + MAX_AI_CREDITS = "maxAiCredits" MAX_TOTAL_SUBAGENTS = "maxTotalSubagents" - TIMEOUT = "timeout" + TIMEOUT_SECONDS = "timeoutSeconds" 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 FactoryLogLineKind(Enum): + """Progress line kind. + + Kind of factory progress line. + + Progress record kind. + """ + LOG = "log" + PHASE = "phase" + +# Experimental: this type is part of an experimental API and may change or be removed. +class FactoryPhaseStatus(Enum): + """Derived lifecycle state of the phase. + + Derived lifecycle state of a factory phase. + """ + 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 FactoryRunLimits: - """Wire-only per-invocation factory resource ceiling overrides. + """Optional per-invocation resource ceiling overrides. + + 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: float | None = None - """Factory active-run timeout in milliseconds.""" + 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. + """ @staticmethod def from_dict(obj: Any) -> 'FactoryRunLimits': assert isinstance(obj, dict) + 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 = from_union([from_float, from_none], obj.get("timeout")) - return FactoryRunLimits(max_concurrent_subagents, max_total_subagents, timeout) + 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 = {} + 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 is not None: - result["timeout"] = from_union([to_float, from_none], self.timeout) + 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. -class FactoryRunStatus(Enum): - """Current or terminal factory run status. - - Current or terminal state of a factory run. - """ - CANCELLED = "cancelled" - COMPLETED = "completed" - ERROR = "error" - HALTED = "halted" - PENDING = "pending" - RUNNING = "running" - # Experimental: this type is part of an experimental API and may change or be removed. @dataclass class FleetStartRequest: @@ -2545,6 +3542,12 @@ class GitHubTelemetryClientInfo: copilot_plan: str | None = None """Copilot subscription plan, when known.""" + cpu_count: int | None = None + """Number of logical CPU cores on the host.""" + + cpu_model: str | None = None + """Distinct CPU model names for the host, comma-separated.""" + dev_device_id: str | None = None """Stable machine identifier for the device.""" @@ -2562,9 +3565,11 @@ def from_dict(obj: Any) -> 'GitHubTelemetryClientInfo': 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")) + cpu_count = from_union([from_int, from_none], obj.get("cpu_count")) + cpu_model = from_union([from_str, from_none], obj.get("cpu_model")) 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) + return GitHubTelemetryClientInfo(cli_version, node_version, os_arch, os_platform, os_version, client_name, client_type, copilot_plan, cpu_count, cpu_model, dev_device_id, is_staff) def to_dict(self) -> dict: result: dict = {} @@ -2579,12 +3584,26 @@ def to_dict(self) -> dict: 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.cpu_count is not None: + result["cpu_count"] = from_union([from_int, from_none], self.cpu_count) + if self.cpu_model is not None: + result["cpu_model"] = from_union([from_str, from_none], self.cpu_model) 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 +class GitHubTokenAcquireReason(Enum): + """Why the runtime is requesting a GitHub credential.""" + + INITIAL = "initial" + REFRESH = "refresh" + +class GitHubTokenAcquireResultKind(Enum): + CANCELLED = "cancelled" + TOKEN = "token" + # Experimental: this type is part of an experimental API and may change or be removed. @dataclass class HandlePendingToolCallResult: @@ -2646,6 +3665,51 @@ def to_dict(self) -> 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 HistoryClearContextRequest: + """Parameters for clearing the conversation and seeding the window that replaces it.""" + + 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) -> 'HistoryClearContextRequest': + assert isinstance(obj, dict) + prompt = from_str(obj.get("prompt")) + return HistoryClearContextRequest(prompt) + + def to_dict(self) -> dict: + result: dict = {} + 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 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) -> 'HistoryClearContextResult': + assert isinstance(obj, dict) + messages_cleared = from_int(obj.get("messagesCleared")) + return HistoryClearContextResult(messages_cleared) + + def to_dict(self) -> dict: + result: dict = {} + 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 HistoryCompactContextWindow: @@ -2693,26 +3757,161 @@ def to_dict(self) -> dict: 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 HistoryFileRestoreSkipReason(Enum): + """Reason a captured file was not restored. + + Reason the file was not restored. + """ + 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 HistoryCompactRequest: - """Optional compaction parameters.""" +class HistoryRewindPoint: + """A root user turn that the session can rewind to.""" - custom_instructions: str | None = None - """Optional user-provided instructions to focus the compaction summary""" + can_restore_files: bool + """Whether at least one file in this turn or a later turn can be restored.""" + + event_id: str + """ID of the user.message event that begins the discarded suffix.""" + + file_count: int + """Number of unique files in this turn and all later turns that have captured changes.""" + + 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) -> 'HistoryCompactRequest': + def from_dict(obj: Any) -> 'HistoryRewindPoint': assert isinstance(obj, dict) - custom_instructions = from_union([from_str, from_none], obj.get("customInstructions")) - return HistoryCompactRequest(custom_instructions) + 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 = {} - if self.custom_instructions is not None: - result["customInstructions"] = from_union([from_str, from_none], self.custom_instructions) + 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 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`. + + Reason a rewind read (rewind points, file-restore preview, or session diff) could not be + answered from the session's file-change captures. + + 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. + """ + 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 HistoryPreviewRewindRequest: + """Event boundary to preview for conversation-and-files rewind.""" + + event_id: str + """ID of the user.message event that begins the discarded suffix.""" + + @staticmethod + def from_dict(obj: Any) -> 'HistoryPreviewRewindRequest': + assert isinstance(obj, dict) + event_id = from_str(obj.get("eventId")) + return HistoryPreviewRewindRequest(event_id) + + 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. + """ + 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. + """ + CONVERSATION = "conversation" + CONVERSATION_AND_FILES = "conversation-and-files" + +# Experimental: this type is part of an experimental API and may change or be removed. +class HistoryRewindOutcome(Enum): + """Outcome of a rewind request. + + 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" + # Experimental: this type is part of an experimental API and may change or be removed. @dataclass class HistorySummarizeForHandoffResult: @@ -2761,15 +3960,30 @@ class HistoryTruncateResult: events_removed: int """Number of events that were removed""" + 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) -> 'HistoryTruncateResult': assert isinstance(obj, dict) events_removed = from_int(obj.get("eventsRemoved")) - return HistoryTruncateResult(events_removed) + 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["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 class HMACAuthInfoType(Enum): @@ -2816,20 +4030,17 @@ def to_dict(self) -> dict: result["output"] = self.output return result -class PurpleSource(Enum): +class InstalledPluginSourceURLSource(Enum): GITHUB = "github" LOCAL = "local" URL = "url" -class FluffySource(Enum): +class PurpleSource(Enum): GITHUB = "github" -class TentacledSource(Enum): +class FluffySource(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 @@ -2912,6 +4123,50 @@ def to_dict(self) -> dict: 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 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. + """ + + @staticmethod + def from_dict(obj: Any) -> 'InterruptMainTurnRequest': + assert isinstance(obj, dict) + flush_queued = from_union([from_bool, from_none], obj.get("flushQueued")) + return InterruptMainTurnRequest(flush_queued) + + def to_dict(self) -> dict: + result: dict = {} + 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. +@dataclass +class InterruptMainTurnResult: + """Result of interrupting the main agent turn.""" + + 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 + @dataclass class LlmInferenceHTTPRequestChunkRequest: """A request body chunk or cancellation signal.""" @@ -3065,6 +4320,8 @@ class LlmInferenceHTTPResponseStartRequest: """Response head.""" headers: dict[str, list[str]] + """HTTP response headers, preserving multiple values per name.""" + request_id: str """Matches the requestId from the originating httpRequestStart frame.""" @@ -3207,6 +4464,34 @@ def to_dict(self) -> dict: 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 ManagedSettingsReadResult: + """Validated device-managed settings discovered before a session exists.""" + + 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) -> 'ManagedSettingsReadResult': + assert isinstance(obj, dict) + 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 = {} + 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 MarketplaceAddResult: @@ -3618,14 +4903,6 @@ def to_dict(self) -> dict: 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. @@ -3639,11 +4916,40 @@ class MCPGrantType(Enum): 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.""" +@dataclass +class MCPSafeForTelemetryFields: + """Per-field MCP telemetry-obfuscation policy.""" + + inputs_names: bool + """Whether MCP tool input names may be included in telemetry without obfuscation.""" + + name: bool + """Whether the MCP tool name may be included in telemetry without obfuscation.""" + + @staticmethod + def from_dict(obj: Any) -> 'MCPSafeForTelemetryFields': + assert isinstance(obj, dict) + inputs_names = from_bool(obj.get("inputsNames")) + name = from_bool(obj.get("name")) + return MCPSafeForTelemetryFields(inputs_names, name) + + def to_dict(self) -> dict: + result: dict = {} + result["inputsNames"] = from_bool(self.inputs_names) + result["name"] = from_bool(self.name) + return result + +class MCPSerializableServerConfigType(Enum): + """Local transport type. Defaults to stdio when omitted. + Local MCP transport type. + + Remote transport type. Defaults to "http" when omitted. + """ HTTP = "http" + LOCAL = "local" SSE = "sse" + STDIO = "stdio" # Experimental: this type is part of an experimental API and may change or be removed. @dataclass @@ -3711,7 +5017,7 @@ def to_dict(self) -> dict: # Internal: this type is an internal SDK API and is not part of the public surface. @dataclass class MCPConfigureGitHubRequest: - """Opaque auth info used to configure GitHub MCP.""" + """Credential-free authentication identity used to configure GitHub MCP.""" auth_info: Any = None """Opaque runtime auth info for GitHub MCP configuration. Marked internal: an in-process @@ -3787,6 +5093,14 @@ def to_dict(self) -> dict: 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 MCPElicitationFormMode(Enum): + """Structured MCP elicitation mode. + + Elicitation mode. Omitted and form are equivalent for structured elicitation. + """ + FORM = "form" + # Experimental: this type is part of an experimental API and may change or be removed. @dataclass class MCPEnableRequest: @@ -3806,12 +5120,36 @@ def to_dict(self) -> dict: 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 MCPFailedServer: + """MCP server whose connection attempt failed.""" + + name: str + """The config key of the server that failed to connect.""" + + error: str | None = None + """The captured connection failure detail.""" + + @staticmethod + def from_dict(obj: Any) -> 'MCPFailedServer': + assert isinstance(obj, dict) + name = from_str(obj.get("name")) + error = from_union([from_str, from_none], obj.get("error")) + return MCPFailedServer(name, error) + + def to_dict(self) -> dict: + result: dict = {} + result["name"] = from_str(self.name) + 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 MCPFilteredServer: - """MCP server filtered by policy, with name, reason, optional redacted reason, and - enterprise login. - """ + """MCP server filtered by policy, with name, reason, and optional redacted reason.""" + name: str """Filtered server name""" @@ -3819,7 +5157,7 @@ class MCPFilteredServer: """Human-readable filter reason""" enterprise_name: str | None = None - """Enterprise login associated with an allowlist policy""" + """Deprecated. This field is no longer populated.""" redacted_reason: str | None = None """PII-free filter reason""" @@ -3911,6 +5249,164 @@ def to_dict(self) -> dict: result["timestamp"] = from_int(self.timestamp) return result +# Experimental: this type is part of an experimental API and may change or be removed. +class MCPPlanConfigurationOperation(Enum): + """Whether the change would create a new entry or modify an existing one. + + Whether a planned configuration change would create or modify an entry + """ + ADD = "add" + UPDATE = "update" + +# Experimental: this type is part of an experimental API and may change or be removed. +class MCPPlanScope(Enum): + """Scope the change would be written to. + + Configuration scope an MCP install plan targets + + Configuration scope the plan targets. + + Configuration scope the plan targets. Defaults to user scope when omitted. + """ + USER = "user" + +# Experimental: this type is part of an experimental API and may change or be removed. +@dataclass +class MCPPlanResourceIdentity: + """Normalised identity of the server the plan would install. + + Normalised identity of the MCP server a plan targets, independent of how the card spelled + it. + """ + canonical_name: str + """Canonical, normalised name of the server, for example `io.github.owner/server`.""" + + server_name: str + """Local configuration key the server would be recorded under.""" + + registry_id: str | None = None + """Registry identifier of the server, when it came from a registry.""" + + version: str | None = None + """Version advertised by the card, when it declares one.""" + + @staticmethod + def from_dict(obj: Any) -> 'MCPPlanResourceIdentity': + assert isinstance(obj, dict) + canonical_name = from_str(obj.get("canonicalName")) + server_name = from_str(obj.get("serverName")) + registry_id = from_union([from_str, from_none], obj.get("registryId")) + version = from_union([from_str, from_none], obj.get("version")) + return MCPPlanResourceIdentity(canonical_name, server_name, registry_id, version) + + def to_dict(self) -> dict: + result: dict = {} + result["canonicalName"] = from_str(self.canonical_name) + result["serverName"] = from_str(self.server_name) + if self.registry_id is not None: + result["registryId"] = from_union([from_str, from_none], self.registry_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. +class MCPPlanPolicyDecision(Enum): + """What policy decided for this server. + + What policy decided for a planned server + """ + ALLOWED = "allowed" + BLOCKED = "blocked" + REQUIRES_APPROVAL = "requires-approval" + +class InstallMethod(Enum): + """Discriminator for a package-backed transport choice + + Discriminator for a remote-endpoint transport choice + """ + PACKAGE = "package" + REMOTE = "remote" + +# Experimental: this type is part of an experimental API and may change or be removed. +class MCPPlanValueCategory(Enum): + """Where the value is applied when the server is launched. + + Where a required value is applied when the planned server is launched + """ + ENVIRONMENT_VARIABLE = "environment-variable" + HEADER = "header" + PACKAGE_ARGUMENT = "package-argument" + RUNTIME_ARGUMENT = "runtime-argument" + URL_VARIABLE = "url-variable" + +class MCPPlanRequiredValueKind(Enum): + """Discriminator for a scalar required value + + Discriminator for an enumerated required value + """ + ENUM = "enum" + SCALAR = "scalar" + +class MCPPlanRequiredValueValueType(Enum): + """Scalar type the value must conform to. + + Scalar type a required value must conform to + + Discriminator for an enumerated required value + """ + BOOLEAN = "boolean" + ENUM = "enum" + NUMBER = "number" + PATH = "path" + STRING = "string" + +# Experimental: this type is part of an experimental API and may change or be removed. +@dataclass +class MCPPlanSecretPlaceholder: + """A secret a transport choice needs, referenced by placeholder. No secret value ever + appears in a plan, and the placeholder resolves against the keychain only when a plan is + applied. + """ + key: str + """Key the secret is supplied under. Inert untrusted data.""" + + placeholder: str + """The runtime-assigned `${secret:}` placeholder written into configuration in place of + the value. + """ + title: str | None = None + """Human-readable label from the card. Inert untrusted text.""" + + @staticmethod + def from_dict(obj: Any) -> 'MCPPlanSecretPlaceholder': + assert isinstance(obj, dict) + key = from_str(obj.get("key")) + placeholder = from_str(obj.get("placeholder")) + title = from_union([from_str, from_none], obj.get("title")) + return MCPPlanSecretPlaceholder(key, placeholder, title) + + def to_dict(self) -> dict: + result: dict = {} + result["key"] = from_str(self.key) + result["placeholder"] = from_str(self.placeholder) + if self.title is not None: + result["title"] = from_union([from_str, from_none], self.title) + return result + +class MCPPlanETransport(Enum): + """Local process transport this package choice would use. + + Transport exposed by a locally launched package + + Endpoint transport this remote choice would use. + + Transport exposed by a remote endpoint + """ + HTTP = "http" + SSE = "sse" + STDIO = "stdio" + STREAMABLE_HTTP = "streamable-http" + # Experimental: this type is part of an experimental API and may change or be removed. @dataclass class MCPIsServerRunningRequest: @@ -3975,9 +5471,34 @@ class MCPToolUIVisibility(Enum): APP = "app" MODEL = "model" -class MCPOauthPendingRequestResponseKind(Enum): - CANCELLED = "cancelled" - TOKEN = "token" +# Experimental: this type is part of an experimental API and may change or be removed. +@dataclass +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) -> 'MCPOauthAuthenticationStateChangedRequest': + assert isinstance(obj, dict) + 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 # Experimental: this type is part of an experimental API and may change or be removed. @dataclass @@ -4026,6 +5547,296 @@ def to_dict(self) -> dict: 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. +class MCPOauthProbeNeedsAuthReason(Enum): + """Why a passive MCP OAuth probe determined authentication is needed. + + Why authentication is needed. + """ + INITIAL = "initial" + REFRESH = "refresh" + UPSCOPE = "upscope" + +# Experimental: this type is part of an experimental API and may change or be removed. +@dataclass +class MCPOauthProbeRequest: + """Remote MCP server name for a passive OAuth status probe.""" + + server_name: str + """Name of the configured remote MCP server to probe.""" + + @staticmethod + def from_dict(obj: Any) -> 'MCPOauthProbeRequest': + assert isinstance(obj, dict) + server_name = from_str(obj.get("serverName")) + return MCPOauthProbeRequest(server_name) + + def to_dict(self) -> dict: + result: dict = {} + result["serverName"] = from_str(self.server_name) + return result + +@dataclass +class ExternalRefMCPOauthHTTPResponse: + """HTTP response returned by the server. + + HTTP 401 or 403 response returned by the server. + + HTTP response returned by the server, when the probe reached the server and captured the + complete response. + """ + external_ref_marker_external_ref_mcp_oauth_http_response: str + + @staticmethod + def from_dict(obj: Any) -> 'ExternalRefMCPOauthHTTPResponse': + assert isinstance(obj, dict) + external_ref_marker_external_ref_mcp_oauth_http_response = from_str(obj.get("__externalRefMarker___ExternalRef_McpOauthHttpResponse")) + return ExternalRefMCPOauthHTTPResponse(external_ref_marker_external_ref_mcp_oauth_http_response) + + def to_dict(self) -> dict: + result: dict = {} + result["__externalRefMarker___ExternalRef_McpOauthHttpResponse"] = from_str(self.external_ref_marker_external_ref_mcp_oauth_http_response) + return result + +class Status(Enum): + AUTHENTICATED = "authenticated" + FAILED = "failed" + NEEDS_AUTH = "needs-auth" + NO_AUTH_REQUIRED = "no-auth-required" + +# Experimental: this type is part of an experimental API and may change or be removed. +@dataclass +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) -> 'MCPOauthRespondRequest': + assert isinstance(obj, dict) + 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 MCPOauthRespondResult: + """Indicates whether the pending MCP OAuth response was accepted.""" + + success: bool + """Whether the response was accepted. False if the request was unknown, timed out, or + already resolved. + """ + + @staticmethod + def from_dict(obj: Any) -> 'MCPOauthRespondResult': + assert isinstance(obj, dict) + success = from_bool(obj.get("success")) + return MCPOauthRespondResult(success) + + 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. +class MCPPlan(Enum): + """Discriminator for an enumerated required value""" + + ENUM = "enum" + +class MCPPlanInstallPlannedKind(Enum): + PLANNED = "planned" + +class MCPPlanInstallSourceKind(Enum): + """Discriminator for a candidate-backed install-plan source + + Discriminator for a caller-supplied-card install-plan source + """ + CANDIDATE = "candidate" + CARD = "card" + +class MCPPlanInstallResultKind(Enum): + AUTHENTICATION_REQUIRED = "authentication-required" + CONTRACT_VIOLATION = "contract-violation" + HANDLE_REJECTED = "handle-rejected" + INVALID_REQUEST = "invalid-request" + MALFORMED_CARD = "malformed-card" + NEGOTIATION_REFUSED = "negotiation-refused" + NETWORK_FAILURE = "network-failure" + NOT_INSTALLABLE = "not-installable" + PLANNED = "planned" + POLICY_REJECTED = "policy-rejected" + UNAVAILABLE = "unavailable" + UNAVAILABLE_TRANSPORT = "unavailable-transport" + UNSAFE_RETRIEVAL = "unsafe-retrieval" + +class MCPPlanInstallResultReason(Enum): + """Whether the version or the capability set was the problem. + + Why capability and protocol-version negotiation refused a caller + + Why the handle was rejected. + + Why a presented handle was rejected + + Why authentication failed. Only an expired credential justifies attempting a silent + refresh; an absent or rejected credential requires sign-in. + + Why the catalog authority did not accept the caller's identity + + Categorised failure, low cardinality so it can be aggregated without carrying a URL. + + Categorised network failure, low cardinality so it can be aggregated without carrying a + URL + + Which control refused the retrieval, low cardinality so it can be aggregated without + carrying a URL. + + Which hardened-fetch control refused a retrieval + + How the card failed validation. + + How a card failed validation + + Which rule the response broke. + + Which wire-contract rule an upstream response broke + + Why no transport could be offered. + + Why no usable transport could be offered + + Why the candidate cannot be installed. + + Why a discoverable candidate cannot be installed + + Why the operation is unavailable. + + Why a catalog operation is not available on this runtime + """ + AI_SKILL_NOT_INSTALLABLE = "ai-skill-not-installable" + AUTHORITY_NOT_CONFIGURED = "authority-not-configured" + BLOCKED_ADDRESS = "blocked-address" + BLOCKED_SCHEME = "blocked-scheme" + BOTH_URL_AND_DATA = "both-url-and-data" + CONNECTION_REFUSED = "connection-refused" + CREDENTIALS_IN_URL = "credentials-in-url" + CREDENTIAL_EXPIRED = "credential-expired" + CREDENTIAL_REJECTED = "credential-rejected" + DISABLED_BY_POLICY = "disabled-by-policy" + DNS = "dns" + DUPLICATE_IDENTITY = "duplicate-identity" + FOREIGN = "foreign" + HOST_NOT_PERMITTED = "host-not-permitted" + HTTP_STATUS = "http-status" + INVALID = "invalid" + INVALID_JSON = "invalid-json" + KIND_NOT_INSTALLABLE = "kind-not-installable" + MISSING_REQUIRED_FIELD = "missing-required-field" + NEITHER_URL_NOR_DATA = "neither-url-nor-data" + NO_CREDENTIAL = "no-credential" + NO_ELIGIBLE_TRANSPORT = "no-eligible-transport" + OFFLINE = "offline" + PLANNING_UNAVAILABLE = "planning-unavailable" + POLICY_FORBIDS = "policy-forbids" + PROXY_REJECTED = "proxy-rejected" + REDIRECT_REJECTED = "redirect-rejected" + REDIRECT_TO_BLOCKED_ADDRESS = "redirect-to-blocked-address" + REMOTE_ENUMERATION_UNAVAILABLE = "remote-enumeration-unavailable" + REPLAYED = "replayed" + RESPONSE_TOO_LARGE = "response-too-large" + SCHEMA_VIOLATION = "schema-violation" + SEARCH_UNAVAILABLE = "search-unavailable" + SIZE_LIMIT_EXCEEDED = "size-limit-exceeded" + STALE = "stale" + TIMEOUT = "timeout" + TLS = "tls" + TRANSPORT_NOT_SUPPORTED = "transport-not-supported" + UNKNOWN_MEDIA_TYPE = "unknown-media-type" + UNSUPPORTED_CAPABILITY = "unsupported-capability" + UNSUPPORTED_MEDIA_TYPE = "unsupported-media-type" + UNSUPPORTED_PROTOCOL_VERSION = "unsupported-protocol-version" + +# Experimental: this type is part of an experimental API and may change or be removed. +class MCPPlanInstallSourceCandidateKind(Enum): + """Discriminator for a candidate-backed install-plan source""" + + CANDIDATE = "candidate" + +# Experimental: this type is part of an experimental API and may change or be removed. +class MCPPlanInstallSourceCardKind(Enum): + """Discriminator for a caller-supplied-card install-plan source""" + + CARD = "card" + +# Experimental: this type is part of an experimental API and may change or be removed. +class MCPPlanPackageInstallMethod(Enum): + """Discriminator for a package-backed transport choice""" + + PACKAGE = "package" + +# Experimental: this type is part of an experimental API and may change or be removed. +class MCPPlanPackageTransport(Enum): + """Local process transport this package choice would use. + + Transport exposed by a locally launched package + """ + STDIO = "stdio" + +# Experimental: this type is part of an experimental API and may change or be removed. +class MCPPlanRemoteInstallMethod(Enum): + """Discriminator for a remote-endpoint transport choice""" + + REMOTE = "remote" + +# Experimental: this type is part of an experimental API and may change or be removed. +class MCPPlanRemoteTransport(Enum): + """Endpoint transport this remote choice would use. + + Transport exposed by a remote endpoint + """ + HTTP = "http" + SSE = "sse" + STREAMABLE_HTTP = "streamable-http" + +# Experimental: this type is part of an experimental API and may change or be removed. +class MCPPlanRequiredValueScalarKind(Enum): + """Discriminator for a scalar required value""" + + SCALAR = "scalar" + +# Experimental: this type is part of an experimental API and may change or be removed. +class MCPPlanScalarValueTypeEnum(Enum): + """Scalar type the value must conform to. + + Scalar type a required value must conform to + """ + BOOLEAN = "boolean" + NUMBER = "number" + PATH = "path" + STRING = "string" + +class MCPServerConfigType(Enum): + """Local transport type. Defaults to stdio when omitted. + + Local MCP transport type. + + Remote transport type. Defaults to "http" when omitted. + + In-process MCP transport type. + """ + HTTP = "http" + LOCAL = "local" + MEMORY = "memory" + SSE = "sse" + STDIO = "stdio" + # 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 @@ -4199,6 +6010,29 @@ class MCPSamplingExecutionAction(Enum): FAILURE = "failure" SUCCESS = "success" +# 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. +# Internal: this type is an internal SDK API and is not part of the public surface. +class MCPServerConfigMemoryType(Enum): + """In-process MCP transport type.""" + + MEMORY = "memory" + +# Experimental: this type is part of an experimental API and may change or be removed. +class MCPServerConfigStdioType(Enum): + """Local transport type. Defaults to stdio when omitted. + + Local MCP transport type. + """ + LOCAL = "local" + STDIO = "stdio" + # 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 @@ -4236,6 +6070,28 @@ def to_dict(self) -> dict: 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 MCPTaskMetadata: + """Metadata controlling an MCP task's lifetime. + + MCP task metadata. + """ + ttl: int | None = None + """Task time-to-live.""" + + @staticmethod + def from_dict(obj: Any) -> 'MCPTaskMetadata': + assert isinstance(obj, dict) + ttl = from_union([from_int, from_none], obj.get("ttl")) + return MCPTaskMetadata(ttl) + + def to_dict(self) -> dict: + result: dict = {} + if self.ttl is not None: + result["ttl"] = from_union([from_int, from_none], self.ttl) + 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 @@ -4275,6 +6131,57 @@ def to_dict(self) -> dict: result["enabled"] = from_bool(self.enabled) return result +@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.""" + + custom_instructions: int + """Custom-instructions tokens (0 when none are configured).""" + + free_space: int + """Remaining unused window capacity (clamped at 0).""" + + 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) -> 'Categories': + assert isinstance(obj, dict) + 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["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 + @dataclass class Compactions: """Successful compaction history for the session.""" @@ -4612,61 +6519,108 @@ class TaskType(Enum): # 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.""" +class ModelPickerSettingsContext: + """Filesystem and environment context used to resolve settings persistence. - mode: SessionMode - """The session mode the agent is operating in""" + Filesystem and environment context used to resolve model-picker settings. + + Settings context used when persisting the selected plan model. + """ + environment: dict[str, Any] + """Environment variables consulted while resolving model-picker settings.""" + + home_directory: str + """User home directory used when resolving persisted settings.""" + + config_dir: str | None = None + """Optional Copilot configuration directory containing persisted settings.""" @staticmethod - def from_dict(obj: Any) -> 'ModeSetRequest': + def from_dict(obj: Any) -> 'ModelPickerSettingsContext': assert isinstance(obj, dict) - mode = SessionMode(obj.get("mode")) - return ModeSetRequest(mode) + environment = from_dict(lambda x: x, obj.get("environment")) + home_directory = from_str(obj.get("homeDirectory")) + config_dir = from_union([from_str, from_none], obj.get("configDir")) + return ModelPickerSettingsContext(environment, home_directory, config_dir) def to_dict(self) -> dict: result: dict = {} - result["mode"] = to_enum(SessionMode, self.mode) + result["environment"] = from_dict(lambda x: x, self.environment) + result["homeDirectory"] = from_str(self.home_directory) + if self.config_dir is not None: + result["configDir"] = from_union([from_str, from_none], self.config_dir) + return result + +# Experimental: this type is part of an experimental API and may change or be removed. +@dataclass +class ModelSwitchConfirmation: + """Compaction confirmation projection when status is confirmation_required + + Compaction confirmation required before the mode change can complete. + """ + current_tokens: float + """Current conversation token count before switching models.""" + + target_limit: float + """Target model token limit used by the compaction preflight.""" + + target_model_display_name: str + """Display name of the model that requires compaction confirmation.""" + + @staticmethod + def from_dict(obj: Any) -> 'ModelSwitchConfirmation': + assert isinstance(obj, dict) + current_tokens = from_float(obj.get("currentTokens")) + target_limit = from_float(obj.get("targetLimit")) + target_model_display_name = from_str(obj.get("targetModelDisplayName")) + return ModelSwitchConfirmation(current_tokens, target_limit, target_model_display_name) + + def to_dict(self) -> dict: + result: dict = {} + result["currentTokens"] = to_float(self.current_tokens) + result["targetLimit"] = to_float(self.target_limit) + result["targetModelDisplayName"] = from_str(self.target_model_display_name) return result # Experimental: this type is part of an experimental API and may change or be removed. @dataclass class ModelBillingPromo: """Active server-driven promotion for this model, if any. Present when the model is being - promoted with a time-boxed discount. + promoted with a discount, which may be time-boxed or open-ended. - Active server-driven promotion for a model, including its discount and expiry. - """ - ends_at: str - """UTC ISO 8601 timestamp marking when the promotion ends. Always present: the API only - surfaces a promo whose expiry parses and is in the future. Consumers should treat a past - value as expired. + 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. + format endsAt and append it when present. """ @staticmethod def from_dict(obj: Any) -> 'ModelBillingPromo': assert isinstance(obj, dict) - ends_at = from_str(obj.get("endsAt")) 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(ends_at, discount_percent, id, message) + return ModelBillingPromo(discount_percent, ends_at, id, message) def to_dict(self) -> dict: result: dict = {} - result["endsAt"] = from_str(self.ends_at) 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: @@ -4684,6 +6638,9 @@ class ModelBillingTokenPricesLongContext: cache_read_price: float | None = None """AI Credits cost per billing batch of cached (read) tokens""" + cache_write1_h_price: float | None = None + """AI Credits cost per billing batch of 1-hour cache-write (cache creation) tokens.""" + cache_write_price: float | None = None """AI Credits cost per billing batch of cache-write (cache creation) tokens.""" @@ -4706,12 +6663,13 @@ def from_dict(obj: Any) -> 'ModelBillingTokenPricesLongContext': assert isinstance(obj, dict) cache_price = from_union([from_float, from_none], obj.get("cachePrice")) cache_read_price = from_union([from_float, from_none], obj.get("cacheReadPrice")) + cache_write1_h_price = from_union([from_float, from_none], obj.get("cacheWrite1hPrice")) 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) + return ModelBillingTokenPricesLongContext(cache_price, cache_read_price, cache_write1_h_price, cache_write_price, context_max, input_price, max_prompt_tokens, output_price) def to_dict(self) -> dict: result: dict = {} @@ -4719,6 +6677,8 @@ def to_dict(self) -> dict: 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_write1_h_price is not None: + result["cacheWrite1hPrice"] = from_union([to_float, from_none], self.cache_write1_h_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: @@ -4760,10 +6720,39 @@ def to_dict(self) -> dict: 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 ModelMessage: + """A service-published message about a model, carrying a stable machine-readable code + alongside human-readable text. + """ + code: str + """Stable machine-readable identifier for the message, such as `client_version_deprecated`. + Hosts can key custom presentation off this; unrecognized codes should fall back to + displaying `message`. + """ + message: str + """Human-readable message text intended for display to the user.""" + + @staticmethod + def from_dict(obj: Any) -> 'ModelMessage': + assert isinstance(obj, dict) + code = from_str(obj.get("code")) + message = from_str(obj.get("message")) + return ModelMessage(code, message) + + def to_dict(self) -> dict: + result: dict = {} + result["code"] = from_str(self.code) + result["message"] = from_str(self.message) + return result + # Experimental: this type is part of an experimental API and may change or be removed. class ModelPickerPriceCategory(Enum): - """Relative cost tier for token-based billing users""" + """Relative cost tier for token-based billing users + Cost category assigned to the model. + """ HIGH = "high" LOW = "low" MEDIUM = "medium" @@ -4777,6 +6766,31 @@ class ModelPolicyState(Enum): ENABLED = "enabled" UNCONFIGURED = "unconfigured" +# Experimental: this type is part of an experimental API and may change or be removed. +@dataclass +class ModelWarningText: + """Warning text the service requires hosts to surface for this model. Present only when the + service published at least one warning. + + Service-published warning text that hosts should display when presenting a model. + """ + data_retention: str | None = None + """Data-retention warning for the model. The text may contain Markdown links and should be + rendered as Markdown when supported. + """ + + @staticmethod + def from_dict(obj: Any) -> 'ModelWarningText': + assert isinstance(obj, dict) + data_retention = from_union([from_str, from_none], obj.get("dataRetention")) + return ModelWarningText(data_retention) + + def to_dict(self) -> dict: + result: dict = {} + if self.data_retention is not None: + result["dataRetention"] = from_union([from_str, from_none], self.data_retention) + return result + # Experimental: this type is part of an experimental API and may change or be removed. @dataclass class ModelCapabilitiesOverrideLimitsVision: @@ -4809,26 +6823,6 @@ def to_dict(self) -> dict: 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 ModelListRequest: - """Optional listing options.""" - - 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) -> 'ModelListRequest': - assert isinstance(obj, dict) - skip_cache = from_union([from_bool, from_none], obj.get("skipCache")) - return ModelListRequest(skip_cache) - - 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) - return result - # Experimental: this type is part of an experimental API and may change or be removed. @dataclass class ModelSetReasoningEffortRequest: @@ -4873,42 +6867,51 @@ def to_dict(self) -> dict: # 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.""" - - model_id: str | None = None - """Currently active model identifier after the switch""" +class ModelsListRequest: + git_hub_token: str | None = None + """GitHub token accepted for compatibility with existing SDK clients. When provided, + resolves this token instead of using the current account. + """ + selection_id: str | None = None + """Opaque account identifier returned by `account.getAllUsers`. When omitted, the current + account is used. + """ @staticmethod - def from_dict(obj: Any) -> 'ModelSwitchToResult': + def from_dict(obj: Any) -> 'ModelsListRequest': assert isinstance(obj, dict) - model_id = from_union([from_str, from_none], obj.get("modelId")) - return ModelSwitchToResult(model_id) + git_hub_token = from_union([from_str, from_none], obj.get("gitHubToken")) + selection_id = from_union([from_str, from_none], obj.get("selectionId")) + return ModelsListRequest(git_hub_token, selection_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) + if self.git_hub_token is not None: + result["gitHubToken"] = from_union([from_str, from_none], self.git_hub_token) + if self.selection_id is not None: + result["selectionId"] = from_union([from_str, from_none], self.selection_id) 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 MoveMCPLoadingToBackgroundResult: + """Result of moving in-flight MCP loading to the background.""" + + moved_to_background: bool + """Whether an in-flight MCP load was moved to the background, releasing turns that were + waiting on it. False when no MCP load was in flight or the waiting turns had already been + released. """ @staticmethod - def from_dict(obj: Any) -> 'ModelsListRequest': + def from_dict(obj: Any) -> 'MoveMCPLoadingToBackgroundResult': assert isinstance(obj, dict) - git_hub_token = from_union([from_str, from_none], obj.get("gitHubToken")) - return ModelsListRequest(git_hub_token) + moved_to_background = from_bool(obj.get("movedToBackground")) + return MoveMCPLoadingToBackgroundResult(moved_to_background) 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["movedToBackground"] = from_bool(self.moved_to_background) return result # Experimental: this type is part of an experimental API and may change or be removed. @@ -4995,8 +6998,10 @@ def to_dict(self) -> dict: # Experimental: this type is part of an experimental API and may change or be removed. @dataclass class ProviderConfigAzure: - """Azure-specific provider options.""" + """Azure authentication configuration for the provider. + Azure-specific provider options. + """ api_version: str | None = None """API version. When set, uses the versioned deployment route. When omitted, uses the GA versionless v1 route. @@ -5016,7 +7021,9 @@ def to_dict(self) -> dict: # Experimental: this type is part of an experimental API and may change or be removed. class ProviderTransport(Enum): - """Provider transport. Defaults to "http". + """Transport used to communicate with the provider. + + Provider transport. Defaults to "http". Transport to be used for provider requests. """ @@ -5025,7 +7032,9 @@ class ProviderTransport(Enum): # 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. + """Provider protocol family. + + Provider type. Defaults to "openai" for generic OpenAI-compatible APIs. Provider family. Matches the `type` field of a BYOK provider config. """ @@ -5035,7 +7044,9 @@ class ProviderType(Enum): # Experimental: this type is part of an experimental API and may change or be removed. class ProviderWireAPI(Enum): - """Wire API format (openai/azure only). Defaults to "completions". + """Wire API used to communicate with the provider. + + Wire API format (openai/azure only). Defaults to "completions". Wire API to be used, when required for the provider type. """ @@ -5049,7 +7060,10 @@ class OptionsUpdateAdditionalContentExclusionPolicyRuleSource: and type. """ name: str + """Name of the policy source.""" + type: str + """Type of the policy source.""" @staticmethod def from_dict(obj: Any) -> 'OptionsUpdateAdditionalContentExclusionPolicyRuleSource': @@ -5123,8 +7137,10 @@ def to_dict(self) -> dict: class ApprovalKind(Enum): COMMANDS = "commands" CUSTOM_TOOL = "custom-tool" + EXTENSION_ENV_ACCESS = "extension-env-access" EXTENSION_MANAGEMENT = "extension-management" EXTENSION_PERMISSION_ACCESS = "extension-permission-access" + FACTORY = "factory" MCP = "mcp" MCP_SAMPLING = "mcp-sampling" MEMORY = "memory" @@ -5157,21 +7173,24 @@ class PermissionDecisionApproveForLocationApprovalCommandsKind(Enum): class PermissionDecisionApproveForLocationApprovalCustomToolKind(Enum): CUSTOM_TOOL = "custom-tool" +class PermissionDecisionApproveForLocationApprovalExtensionEnvAccessKind(Enum): + EXTENSION_ENV_ACCESS = "extension-env-access" + class PermissionDecisionApproveForLocationApprovalExtensionManagementKind(Enum): EXTENSION_MANAGEMENT = "extension-management" class PermissionDecisionApproveForLocationApprovalExtensionPermissionAccessKind(Enum): EXTENSION_PERMISSION_ACCESS = "extension-permission-access" +class PermissionDecisionApproveForLocationApprovalFactoryKind(Enum): + FACTORY = "factory" + class PermissionDecisionApproveForLocationApprovalMCPKind(Enum): MCP = "mcp" class PermissionDecisionApproveForLocationApprovalMCPSamplingKind(Enum): MCP_SAMPLING = "mcp-sampling" -class PermissionDecisionApproveForLocationApprovalMemoryKind(Enum): - MEMORY = "memory" - class PermissionDecisionApproveForLocationApprovalReadKind(Enum): READ = "read" @@ -5199,6 +7218,50 @@ class PermissionDecisionApprovedForSessionKind(Enum): 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 PermissionResponseCapability(Enum): + """Whether the responding client could ask a user interactively, was running headlessly, or + had no response path. Omit when the client cannot determine this authoritatively. + + Response capability available to the client when it settled a permission request. + """ + HEADLESS = "headless" + INTERACTIVE = "interactive" + NONE = "none" + +# 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. + """ + ASSISTED_APPROVAL = "assisted_approval" + HOST_POLICY = "host_policy" + HUMAN_RESPONSE = "human_response" + 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. + """ + ACP = "acp" + 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" @@ -5217,30 +7280,6 @@ class PermissionDecisionDeniedNoApprovalRuleAndCouldNotRequestFromUserKind(Enum) class PermissionDecisionRejectKind(Enum): REJECT = "reject" -# 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""" - - @staticmethod - def from_dict(obj: Any) -> 'PermissionDecisionRequest': - assert isinstance(obj, dict) - request_id = from_str(obj.get("requestId")) - result = _load_PermissionDecision(obj.get("result")) - return PermissionDecisionRequest(request_id, result) - - def to_dict(self) -> dict: - result: dict = {} - result["requestId"] = from_str(self.request_id) - result["result"] = (self.result).to_dict() - return result - class PermissionDecisionUserNotAvailableKind(Enum): USER_NOT_AVAILABLE = "user-not-available" @@ -5296,7 +7335,9 @@ class PermissionPathsAddParams: path: str """Directory to add to the allow-list. The runtime resolves and validates the path before - adding. + adding, then loads conventional `.github/skills/` and `.github/agents/` definitions under + it when their subsystem gates are enabled. Adding the directory is therefore also a trust + decision for configuration stored there. """ @staticmethod @@ -5555,7 +7596,10 @@ class PermissionsConfigureAdditionalContentExclusionPolicyRuleSource: source name and type. """ name: str + """Name of the policy source.""" + type: str + """Type of the policy source.""" @staticmethod def from_dict(obj: Any) -> 'PermissionsConfigureAdditionalContentExclusionPolicyRuleSource': @@ -5610,15 +7654,34 @@ def to_dict(self) -> dict: # Experimental: this type is part of an experimental API and may change or be removed. @dataclass -class PermissionsGetAllowAllRequest: +class PermissionsGetModeRequest: """No parameters.""" @staticmethod - def from_dict(obj: Any) -> 'PermissionsGetAllowAllRequest': + def from_dict(obj: Any) -> 'PermissionsGetModeRequest': + assert isinstance(obj, dict) + return PermissionsGetModeRequest() + + def to_dict(self) -> dict: + result: dict = {} + return result + +# Experimental: this type is part of an experimental API and may change or be removed. +@dataclass +class PermissionsGetModeResult: + """Current permission mode.""" + + mode: PermissionMode + """Current permission mode""" + + @staticmethod + def from_dict(obj: Any) -> 'PermissionsGetModeResult': assert isinstance(obj, dict) - return PermissionsGetAllowAllRequest() + mode = PermissionMode(obj.get("mode")) + return PermissionsGetModeResult(mode) def to_dict(self) -> dict: result: dict = {} + result["mode"] = to_enum(PermissionMode, self.mode) return result # Experimental: this type is part of an experimental API and may change or be removed. @@ -5753,14 +7816,21 @@ def to_dict(self) -> dict: # 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.""" + """Clears session-scoped tool permission approvals, and optionally the location-scoped ones.""" + + include_location: bool | None = None + """Whether location-scoped approvals are cleared too. Defaults to `true`.""" + @staticmethod def from_dict(obj: Any) -> 'PermissionsResetSessionApprovalsRequest': assert isinstance(obj, dict) - return PermissionsResetSessionApprovalsRequest() + include_location = from_union([from_bool, from_none], obj.get("includeLocation")) + return PermissionsResetSessionApprovalsRequest(include_location) def to_dict(self) -> dict: result: dict = {} + 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. @@ -5801,6 +7871,31 @@ 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 PermissionsSetModeResult: + """Indicates whether the requested permission mode was applied and reports the authoritative + post-mutation mode. + """ + mode: PermissionMode + """Authoritative permission mode after the mutation""" + + success: bool + """Whether the operation succeeded""" + + @staticmethod + def from_dict(obj: Any) -> 'PermissionsSetModeResult': + assert isinstance(obj, dict) + mode = PermissionMode(obj.get("mode")) + success = from_bool(obj.get("success")) + return PermissionsSetModeResult(mode, success) + + def to_dict(self) -> dict: + result: dict = {} + result["mode"] = to_enum(PermissionMode, self.mode) + 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 PermissionsSetRequiredRequest: @@ -5946,6 +8041,12 @@ 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. """ + created_at: str | None = None + """Todo creation time, as stored by the session SQL schema's `datetime('now')` default: + `YYYY-MM-DD HH:MM:SS` in UTC. Lets clients attribute todos to the work item that created + them (e.g. scoping a goal's progress to the todos it produced) rather than to the whole + session. + """ description: str | None = None """Todo description.""" @@ -5961,14 +8062,17 @@ class PlanSQLTodosRow: @staticmethod def from_dict(obj: Any) -> 'PlanSQLTodosRow': assert isinstance(obj, dict) + created_at = from_union([from_str, from_none], obj.get("createdAt")) 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) + return PlanSQLTodosRow(created_at, description, id, status, title) def to_dict(self) -> dict: result: dict = {} + if self.created_at is not None: + result["createdAt"] = from_union([from_str, from_none], self.created_at) if self.description is not None: result["description"] = from_union([from_str, from_none], self.description) if self.id is not None: @@ -6089,6 +8193,27 @@ def to_dict(self) -> dict: 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 PluginsBuiltinSetRequest: + """Trusted built-in plugin directories to use for this runtime process.""" + + paths: list[str] + """Complete replacement set of trusted built-in plugin directories. Every entry must be an + absolute local filesystem path no longer than 4096 characters. + """ + + @staticmethod + def from_dict(obj: Any) -> 'PluginsBuiltinSetRequest': + assert isinstance(obj, dict) + paths = from_list(from_str, obj.get("paths")) + return PluginsBuiltinSetRequest(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 PluginsMarketplacesAddRequest: @@ -6184,54 +8309,6 @@ def to_dict(self) -> dict: 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 PluginsReloadRequest: - """Optional flags controlling which side effects the reload performs.""" - - 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`. - """ - reload_custom_agents: bool | None = None - """Re-run custom-agent discovery after refreshing plugins. Defaults to true.""" - - 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) -> 'PluginsReloadRequest': - assert isinstance(obj, dict) - 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 PluginsReloadRequest(defer_repo_hooks, reload_custom_agents, reload_extensions, reload_hooks, reload_mcp) - - def to_dict(self) -> dict: - result: dict = {} - 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 ProviderAddResult: @@ -6293,6 +8370,33 @@ def to_dict(self) -> dict: 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 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 the configured provider 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 ProviderTokenAcquireResult: @@ -6494,6 +8598,304 @@ class PushAttachmentGitHubURLType(Enum): class PushAttachmentSelectionType(Enum): SELECTION = "selection" +# Experimental: this type is part of an experimental API and may change or be removed. +@dataclass +class QueueBeginDeferredIdleDrainRequest: + """Inputs for starting a deferred-idle drain.""" + + active_background_work: bool + """Whether the host still has active background work.""" + + @staticmethod + def from_dict(obj: Any) -> 'QueueBeginDeferredIdleDrainRequest': + assert isinstance(obj, dict) + active_background_work = from_bool(obj.get("activeBackgroundWork")) + return QueueBeginDeferredIdleDrainRequest(active_background_work) + + def to_dict(self) -> dict: + result: dict = {} + 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. +@dataclass +class QueueBeginDeferredIdleDrainResult: + """Whether a deferred-idle drain should run.""" + + should_drain: bool + """True when the host should run finishDeferredIdleDrain asynchronously.""" + + @staticmethod + def from_dict(obj: Any) -> 'QueueBeginDeferredIdleDrainResult': + assert isinstance(obj, dict) + should_drain = from_bool(obj.get("shouldDrain")) + return QueueBeginDeferredIdleDrainResult(should_drain) + + def to_dict(self) -> dict: + result: dict = {} + result["shouldDrain"] = from_bool(self.should_drain) + return result + +# Experimental: this type is part of an experimental API and may change or be removed. +@dataclass +class QueueConsumeSystemNotificationsRequest: + """Internal filter for consuming queued system notifications.""" + + filter: Any + """Opaque runtime-owned filter object.""" + + @staticmethod + def from_dict(obj: Any) -> 'QueueConsumeSystemNotificationsRequest': + assert isinstance(obj, dict) + filter = obj.get("filter") + return QueueConsumeSystemNotificationsRequest(filter) + + def to_dict(self) -> dict: + result: dict = {} + result["filter"] = self.filter + return result + +# Experimental: this type is part of an experimental API and may change or be removed. +@dataclass +class QueueDeferSessionIdleRequest: + """Inputs for marking session.idle deferred in native state.""" + + aborted: bool + """Whether the deferred idle was caused by an aborted foreground turn.""" + + @staticmethod + def from_dict(obj: Any) -> 'QueueDeferSessionIdleRequest': + assert isinstance(obj, dict) + aborted = from_bool(obj.get("aborted")) + return QueueDeferSessionIdleRequest(aborted) + + def to_dict(self) -> dict: + result: dict = {} + 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 QueueDuplicateAtRequest: + """Parameters for duplicating a queued item.""" + + id: str + """Stable opaque ID of the queued item to duplicate.""" + + @staticmethod + def from_dict(obj: Any) -> 'QueueDuplicateAtRequest': + assert isinstance(obj, dict) + id = from_str(obj.get("id")) + return QueueDuplicateAtRequest(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 QueueDuplicateAtResult: + """Result of duplicating a queued item.""" + + id: str + """Fresh stable opaque id assigned to the duplicate.""" + + @staticmethod + def from_dict(obj: Any) -> 'QueueDuplicateAtResult': + assert isinstance(obj, dict) + id = from_str(obj.get("id")) + return QueueDuplicateAtResult(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 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) -> 'QueueEnqueueResumePendingResult': + assert isinstance(obj, dict) + queued = from_bool(obj.get("queued")) + return QueueEnqueueResumePendingResult(queued) + + def to_dict(self) -> dict: + result: dict = {} + 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 QueueFinishDeferredIdleDrainRequest: + """Inputs for completing a deferred-idle drain.""" + + 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) -> 'QueueFinishDeferredIdleDrainRequest': + assert isinstance(obj, dict) + 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["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 QueueFinishDeferredIdleDrainResult: + """Action selected by the native deferred-idle drain.""" + + 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) -> 'QueueFinishDeferredIdleDrainResult': + assert isinstance(obj, dict) + aborted = from_bool(obj.get("aborted")) + action = from_str(obj.get("action")) + return QueueFinishDeferredIdleDrainResult(aborted, action) + + def to_dict(self) -> dict: + result: dict = {} + 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 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) -> 'QueueHasPendingResult': + assert isinstance(obj, dict) + 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. +class SendAgentMode(Enum): + """Optional explicit agent mode. When omitted, the session's current mode is assigned. + + The UI mode the agent was in when this message was sent. Defaults to the session's + current mode. + + 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. + + 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. +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) -> 'QueueInsertAtResult': + assert isinstance(obj, dict) + id = from_str(obj.get("id")) + return QueueInsertAtResult(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 QueueMoveItemRequest: + """Parameters for moving a queued item by stable id.""" + + id: str + """Stable opaque queued-item id.""" + + 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) -> 'QueueMoveItemRequest': + assert isinstance(obj, dict) + id = from_str(obj.get("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["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 QueueMoveItemResult: + """Result of moving a queued item.""" + + changed: bool + """True when the item changed position; false when it was already at the requested position.""" + + @staticmethod + def from_dict(obj: Any) -> 'QueueMoveItemResult': + assert isinstance(obj, dict) + changed = from_bool(obj.get("changed")) + return QueueMoveItemResult(changed) + + def to_dict(self) -> dict: + result: dict = {} + result["changed"] = from_bool(self.changed) + 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""" @@ -6501,6 +8903,44 @@ class QueuePendingItemsKind(Enum): COMMAND = "command" MESSAGE = "message" +# 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.""" + + id: str + """Stable opaque ID of the queued item to remove.""" + + @staticmethod + def from_dict(obj: Any) -> 'QueueRemoveAtRequest': + assert isinstance(obj, dict) + id = from_str(obj.get("id")) + return QueueRemoveAtRequest(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 QueueRemoveAtResult: + """Result of removing a queued item.""" + + removed: bool + """True when the addressed item was removed.""" + + @staticmethod + def from_dict(obj: Any) -> 'QueueRemoveAtResult': + assert isinstance(obj, dict) + removed = from_bool(obj.get("removed")) + return QueueRemoveAtResult(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 QueueRemoveMostRecentResult: @@ -6522,13 +8962,124 @@ def to_dict(self) -> 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 QueueSendNowRequest: + """Parameters for steering a queued message into a live turn.""" + + id: str + """Stable opaque ID of the queued item to steer into the live turn.""" + + @staticmethod + def from_dict(obj: Any) -> 'QueueSendNowRequest': + assert isinstance(obj, dict) + id = from_str(obj.get("id")) + return QueueSendNowRequest(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 QueueSendNowResult: + """Result of trying to steer a queued message into a live turn.""" + + 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) -> 'QueueSendNowResult': + assert isinstance(obj, dict) + steered = from_bool(obj.get("steered")) + return QueueSendNowResult(steered) + + def to_dict(self) -> dict: + result: dict = {} + 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 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 + """Whether queued-lane draining should be paused.""" + + @staticmethod + def from_dict(obj: Any) -> 'QueueSetDrainPausedRequest': + assert isinstance(obj, dict) + 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 QueueUpdateTextRequest: + """Parameters for editing a single queued message.""" + + id: str + """Stable opaque ID of the queued item to edit.""" + + prompt: str + """Replacement prompt sent to the model.""" + + display_prompt: str | None = None + """Optional replacement prompt displayed to the user.""" + + @staticmethod + def from_dict(obj: Any) -> 'QueueUpdateTextRequest': + assert isinstance(obj, dict) + 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 = {} + 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. +@dataclass +class QueueUpdateTextResult: + """Result of editing a queued message.""" + + updated: bool + """True when the stored text changed.""" + + @staticmethod + def from_dict(obj: Any) -> 'QueueUpdateTextResult': + assert isinstance(obj, dict) + updated = from_bool(obj.get("updated")) + return QueueUpdateTextResult(updated) + + def to_dict(self) -> dict: + result: dict = {} + result["updated"] = from_bool(self.updated) + return result + # Experimental: this type is part of an experimental API and may change or be removed. @dataclass class QueuedCommandHandled: """Queued-command response indicating the host executed the command, with an optional flag to stop queue processing. """ - handled: ClassVar[str] = "true" + handled: ClassVar[bool] = True """The host actually executed the queued command.""" stop_processing_queue: bool | None = None @@ -6555,7 +9106,7 @@ class QueuedCommandNotHandled: """Queued-command response indicating the host did not execute the command and the queue may continue. """ - handled: ClassVar[str] = "false" + 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). """ @@ -6853,6 +9404,23 @@ def to_dict(self) -> dict: result: dict = {} return result +# Experimental: this type is part of an experimental API and may change or be removed. +class RemoteSessionHostStatus(Enum): + """What a remote host says one of its sessions is doing right now. Deliberately coarse: this + is what a host can report for EVERY session in a catalogue listing, without a client + subscribing to each one. AHP's `SessionSummary.status` is the source today; + `input-needed` covers both a permission prompt and an `ask_user` question, since the + summary does not say which. + + Live status as the owning host reports it in its session listing, so a row for a session + running elsewhere can show that it is running. Absent for hosts that publish no such + status (the cloud task managers), which read as idle. + """ + ERROR = "error" + IDLE = "idle" + INPUT_NEEDED = "input-needed" + WORKING = "working" + # Experimental: this type is part of an experimental API and may change or be removed. @dataclass class RemoteSessionMetadataRepository: @@ -6914,6 +9482,42 @@ def to_dict(self) -> dict: 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 SandboxConfigAuth: + """Credential-injection capability flags. + + Credential-injection capability flags applied while the sandbox is enabled. For the same + capability independent of sandboxing, and matched to the credential's GitHub host, see + `shell.credentials`; the two are additive. + """ + 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) -> 'SandboxConfigAuth': + assert isinstance(obj, dict) + 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 = {} + 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 SandboxConfigUserPolicyExperimentalSeatbelt: @@ -6974,28 +9578,52 @@ def to_dict(self) -> dict: # 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.""" +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. - 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.""" + 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) -> 'SandboxConfigUserPolicyNetwork': + def from_dict(obj: Any) -> 'SandboxConfigUserPolicyNetworkProxy': 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")) - return SandboxConfigUserPolicyNetwork(allow_local_network, allow_outbound) + 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 = {} - 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) + 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. @@ -7020,10 +9648,142 @@ def to_dict(self) -> dict: 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. +# Internal: this type is an internal SDK API and is not part of the public surface. +class _SandboxConfigSource(Enum): + """Origin of the sandbox choice supplied by an internal client. + + Origin of the sandbox choice. The runtime uses this only for internal telemetry + provenance; managed policy is derived independently. + """ + NEVER_CONFIGURED = "never_configured" + REPOSITORY_POLICY = "repository_policy" + SESSION_DISABLED = "session_disabled" + SESSION_FLAG = "session_flag" + UNSUPPORTED_HOST = "unsupported_host" + USER_DISABLED = "user_disabled" + USER_ENABLED = "user_enabled" + +# Experimental: this type is part of an experimental API and may change or be removed. +@dataclass +class ScheduleAddAtRequest: + """Register an absolute-time scheduled prompt.""" + + at: int + """Epoch milliseconds when the prompt should fire.""" + + 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) -> 'ScheduleAddAtRequest': + assert isinstance(obj, dict) + 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["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 ScheduleAddCronRequest: + """Register a cron scheduled prompt.""" + + 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) -> 'ScheduleAddCronRequest': + assert isinstance(obj, dict) + 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["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 ScheduleAddRequest: + """Register a relative-interval scheduled prompt.""" + + interval: str + """Human-readable interval such as `30s`, `5m`, or `2h`.""" + + 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.""" + + @staticmethod + def from_dict(obj: Any) -> 'ScheduleAddRequest': + assert isinstance(obj, dict) + 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["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 ScheduleEntry: - """Scheduled prompt entry with ID, timing (`intervalMs`, `cron`, or `at`), prompt text, + """The registered or updated schedule entry. + + Scheduled prompt entry with ID, timing (`intervalMs`, `cron`, or `at`), prompt text, recurrence, and next run time. The removed entry, or omitted if no entry matched. @@ -7096,6 +9856,74 @@ def to_dict(self) -> dict: 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 ScheduleAddSelfPacedRequest: + """Register a self-paced scheduled prompt.""" + + prompt: str + """Prompt text to enqueue when the schedule fires.""" + + display_prompt: str | None = None + """Optional display-only prompt label.""" + + @staticmethod + def from_dict(obj: Any) -> 'ScheduleAddSelfPacedRequest': + assert isinstance(obj, dict) + 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["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 ScheduleHasSelfPacedResult: + """Whether the session currently has an active self-paced schedule.""" + + has_self_paced: bool + """True when at least one active schedule is self-paced.""" + + @staticmethod + def from_dict(obj: Any) -> 'ScheduleHasSelfPacedResult': + assert isinstance(obj, dict) + has_self_paced = from_bool(obj.get("hasSelfPaced")) + return ScheduleHasSelfPacedResult(has_self_paced) + + def to_dict(self) -> dict: + result: dict = {} + result["hasSelfPaced"] = from_bool(self.has_self_paced) + return result + +# 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.""" + + at: int + """Epoch milliseconds when the prompt should next fire.""" + + id: int + """Id of the self-paced scheduled prompt.""" + + @staticmethod + def from_dict(obj: Any) -> 'ScheduleRearmSelfPacedRequest': + assert isinstance(obj, dict) + at = from_int(obj.get("at")) + id = from_int(obj.get("id")) + return ScheduleRearmSelfPacedRequest(at, id) + + def to_dict(self) -> dict: + result: dict = {} + 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 ScheduleStopRequest: @@ -7153,19 +9981,6 @@ def to_dict(self) -> dict: result["ok"] = from_bool(self.ok) 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. - - 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 SendAttachmentsToMessageParams: @@ -7222,10 +10037,9 @@ class SendMessageItem: """ # 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 match one of - three forms: the literal `system`, `command-` for messages originating from a - command (e.g. slash command, Mission Control command), or `schedule-` for - messages originating from a scheduled job. + """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 @@ -7254,17 +10068,6 @@ def to_dict(self) -> dict: 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. -class SendMode(Enum): - """How to deliver the messages. `enqueue` (default) appends to the message queue. - `immediate` interjects during an in-progress turn. - - How to deliver the message. `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 SendMessagesResult: @@ -7307,12 +10110,43 @@ def to_dict(self) -> dict: # 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""" +class SendSystemNotificationRequest: + """Internal request for sending a system notification.""" + + message: str + """Notification text to deliver to the model.""" + + kind: Any = None + """Optional structured notification kind.""" + + options: Any = None + """Internal delivery options, including passive policy.""" + + @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) + + 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 + +# 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""" enabled: bool """Whether the skill is currently enabled (based on global config)""" @@ -7330,6 +10164,9 @@ class ServerSkill: """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""" @@ -7345,9 +10182,10 @@ def from_dict(obj: Any) -> 'ServerSkill': 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, path, project_path) + return ServerSkill(description, enabled, name, source, user_invocable, argument_hint, command_name, path, project_path) def to_dict(self) -> dict: result: dict = {} @@ -7358,6 +10196,8 @@ def to_dict(self) -> dict: 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: @@ -7388,6 +10228,85 @@ def to_dict(self) -> dict: 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 SessionAuthLoginRequest: + """Internal GitHub login parameters.""" + + host: str + """GitHub host URL""" + + login: str + """GitHub login""" + + token: str + """GitHub authentication token""" + + persist: bool | None = None + """Whether to persist the token after login""" + + @staticmethod + def from_dict(obj: Any) -> 'SessionAuthLoginRequest': + assert isinstance(obj, dict) + host = from_str(obj.get("host")) + login = from_str(obj.get("login")) + token = from_str(obj.get("token")) + persist = from_union([from_bool, from_none], obj.get("persist")) + return SessionAuthLoginRequest(host, login, token, persist) + + 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) + if self.persist is not None: + result["persist"] = from_union([from_bool, from_none], self.persist) + return result + +# Experimental: this type is part of an experimental API and may change or be removed. +@dataclass +class SessionAuthLogoutUserRequest: + """Parameters identifying a GitHub authentication to log out.""" + + auth_info: AuthInfo + """Authentication information to log out""" + + @staticmethod + def from_dict(obj: Any) -> 'SessionAuthLogoutUserRequest': + assert isinstance(obj, dict) + auth_info = _load_AuthInfo(obj.get("authInfo")) + return SessionAuthLogoutUserRequest(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 SessionAuthSwitchRequest: + """Parameters for switching the session's active authentication.""" + + auth_info: AuthInfo + """Authentication information to activate""" + + token: str | None = None + """Optional token paired with the authentication information""" + + @staticmethod + def from_dict(obj: Any) -> 'SessionAuthSwitchRequest': + assert isinstance(obj, dict) + auth_info = _load_AuthInfo(obj.get("authInfo")) + token = from_union([from_str, from_none], obj.get("token")) + return SessionAuthSwitchRequest(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 SessionBulkDeleteResult: @@ -7428,6 +10347,36 @@ class SessionCapability(Enum): SYSTEM_NOTIFICATIONS = "system-notifications" TUI_HINTS = "tui-hints" +# 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) -> 'SessionCommandsListRequest': + 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 SessionCommandsListRequest(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 SessionFSAppendFileRequest: @@ -7779,11 +10728,23 @@ def to_dict(self) -> dict: 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): + """Machine-readable classification of the transaction failure. + + 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: @@ -7843,6 +10804,85 @@ def to_dict(self) -> dict: 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 SessionLimitPredictionBaselineData: + """Baseline data provenance for a prediction. + + Baseline data provenance. + """ + window_end: str + """End of the baseline data slice.""" + + window_start: str + """Start of the baseline data slice.""" + + @staticmethod + def from_dict(obj: Any) -> 'SessionLimitPredictionBaselineData': + assert isinstance(obj, dict) + 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["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. +class SessionLimitPredictionClientType(Enum): + """Client population used for the prediction baseline. + + Client population used for the prediction. + + 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. + + Semantic usage tier. + """ + 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: @@ -7927,13 +10967,81 @@ def to_dict(self) -> dict: 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 SessionManagedPermissions: + """Enterprise permission policy expressed with the runtime's managed permission-rule + syntax. + + Managed permission policy injected by the SDK host. + """ + allow: list[str] | None = None + """Permission rules that allow matching operations unless another managed source, deny, or + ask rule restricts them. + """ + ask: list[str] | None = None + """Permission rules that require explicit human approval.""" + + deny: list[str] | None = None + """Permission rules that block matching operations. Deny has highest precedence.""" + + disable_bypass_permissions_mode: str | None = None + """When set to `disable`, prevents bypass/allow-all permission modes. `allow-auto-only` + blocks full allow-all but permits advisory auto-approval. Any other value is accepted + rather than failing the session, but is enforced as `disable`: the key is only present to + restrict something, so a mode this runtime cannot interpret fails closed to the most + restrictive one it knows. Omit the key entirely to impose no restriction. + """ + + @staticmethod + def from_dict(obj: Any) -> 'SessionManagedPermissions': + assert isinstance(obj, dict) + 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([from_str, from_none], obj.get("disableBypassPermissionsMode")) + return SessionManagedPermissions(allow, ask, deny, disable_bypass_permissions_mode) + + def to_dict(self) -> dict: + result: dict = {} + 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([from_str, 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 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) -> 'SessionModelListRequest': + assert isinstance(obj, dict) + skip_cache = from_union([from_bool, from_none], obj.get("skipCache")) + return SessionModelListRequest(skip_cache) + + 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) + return result + # Experimental: this type is part of an experimental API and may change or be removed. @dataclass class SessionOpenOptionsAdditionalContentExclusionPolicyRuleSource: """Source descriptor for a `sessions.open` content-exclusion rule, with source name and type.""" name: str + """Name of the policy source.""" + type: str + """Type of the policy source.""" @staticmethod def from_dict(obj: Any) -> 'SessionOpenOptionsAdditionalContentExclusionPolicyRuleSource': @@ -7948,6 +11056,92 @@ def to_dict(self) -> dict: 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 ShellCredentials: + """Command-scoped GitHub credential injection for shell commands. + + Command-scoped GitHub credential injection for the shell commands an agent runs. + + Each channel is opt-in and independent, and injection is scoped to the individual command + spawn: the credential is resolved from the session's *current* authentication at every + spawn + and reaches only spawns whose script actually invokes `git` or `gh`. Because nothing is + retained between spawns, replacing the session credential + (`session.gitHubAuth.setCredentials`) + changes what the next spawned command presents β€” which seeding a credential into the + runtime + process's own environment cannot do, since a child's environment is fixed at `exec`. + + The credential is matched to the host it authenticates to, so a github.com credential is + never + presented to a GitHub Enterprise host and vice versa. Where a channel cannot express that + boundary it injects nothing rather than crossing it -- see `gh` below. + + This is independent of `sandboxConfig`: it is a decision about which identity the agent + presents, not about what the agent may touch, and it works on every platform whether or + not + an OS sandboxing backend is available. `sandboxConfig.auth` remains the sandbox-scoped + spelling and is additive with this one. + """ + gh: bool | None = None + """Whether to authenticate the agent's `gh` commands as the session's GitHub credential, by + exporting `GH_TOKEN` to a spawn that runs `gh`. Any inherited `gh` credential is removed + from + spawns that do not, so the credential stays command-scoped. + + Applies to a github.com credential only. `gh` picks its credential variable from the host + a + command targets rather than the one the credential belongs to, and the command can choose + that + target, so `GH_ENTERPRISE_TOKEN` would offer a single-tenant enterprise credential to + every + other enterprise host. A session whose credential is enterprise-scoped therefore runs + `gh` + unauthenticated; its `git` commands are unaffected, because `http..extraheader` is + scoped + to one host by construction. Default: false (opt-in). + """ + git: bool | None = None + """Whether to authenticate the agent's `git` commands as the session's GitHub credential, by + injecting an `http..extraheader` (plus `insteadOf` rewrites so SSH-spelled remotes + for + that host use the authenticated HTTPS transport). Applied only to a spawn that runs a + remote-contacting `git` subcommand. Default: false (opt-in). + """ + + @staticmethod + def from_dict(obj: Any) -> 'ShellCredentials': + assert isinstance(obj, dict) + gh = from_union([from_bool, from_none], obj.get("gh")) + git = from_union([from_bool, from_none], obj.get("git")) + return ShellCredentials(gh, git) + + def to_dict(self) -> dict: + result: dict = {} + 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. +class ShellInitProfile(Enum): + """Controls automatic non-interactive profile loading where supported. Explicit initScripts + are unaffected. + """ + NONE = "none" + NON_INTERACTIVE = "non-interactive" + +# 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. + + Supported built-in shells for initialization scripts. + """ + BASH = "bash" + POWERSHELL = "powershell" + class SessionOpenParamsKind(Enum): ATTACH = "attach" CLOUD = "cloud" @@ -7985,6 +11179,52 @@ class SessionsOpenStatus(Enum): 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`. + """ + reload_custom_agents: bool | None = None + """Re-run custom-agent discovery after refreshing plugins. Defaults to true.""" + + 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) -> 'SessionPluginsReloadRequest': + assert isinstance(obj, dict) + 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 = {} + 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 SessionPruneResult: @@ -8025,12 +11265,21 @@ def to_dict(self) -> dict: result["skipped"] = from_list(from_str, self.skipped) return result +class SettableAuthInfoType(Enum): + 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 SessionSetCredentialsParams: """New auth credentials to install on the session. Omit to leave credentials unchanged.""" - credentials: AuthInfo | None = None + credentials: SettableAuthInfo | 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 @@ -8045,7 +11294,7 @@ class SessionSetCredentialsParams: @staticmethod def from_dict(obj: Any) -> 'SessionSetCredentialsParams': assert isinstance(obj, dict) - credentials = from_union([_load_AuthInfo, from_none], obj.get("credentials")) + credentials = from_union([_load_SettableAuthInfo, from_none], obj.get("credentials")) return SessionSetCredentialsParams(credentials) def to_dict(self) -> dict: @@ -8090,10 +11339,15 @@ def to_dict(self) -> dict: # 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.""" + """Availability of built-in job tools surfaced to boundary consumers. + Availability of job-specific built-in tools. + """ create_pull_request: bool | None = None + """Whether the create-pull-request tool is available.""" + report_progress: bool | None = None + """Whether the report-progress tool is available.""" @staticmethod def from_dict(obj: Any) -> 'SessionSettingsBuiltInToolAvailabilitySnapshot': @@ -8143,6 +11397,7 @@ class SessionSettingsEvaluatePredicateResult: """Result of evaluating a Rust-owned settings predicate.""" enabled: bool + """Whether the named settings predicate evaluated to enabled.""" @staticmethod def from_dict(obj: Any) -> 'SessionSettingsEvaluatePredicateResult': @@ -8158,12 +11413,21 @@ def to_dict(self) -> dict: # 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.""" + """Redacted model routing settings for a session. + Redacted model routing settings. + """ callback_url: str | None = None + """Agent service callback URL for job and progress updates.""" + default_reasoning_effort: str | None = None + """Default reasoning effort for the selected model.""" + instance_id: str | None = None + """Agent job identifier for the session.""" + model: str | None = None + """Selected model identifier.""" @staticmethod def from_dict(obj: Any) -> 'SessionSettingsModelSnapshot': @@ -8189,10 +11453,15 @@ def to_dict(self) -> dict: # Experimental: this type is part of an experimental API and may change or be removed. @dataclass class SessionSettingsOnlineEvaluationSnapshot: - """Online-evaluation settings safe to expose across the SDK boundary.""" + """Online-evaluation settings safe to expose across the SDK boundary. + Online-evaluation settings safe for SDK consumers. + """ disable_online_evaluation: bool | None = None + """Whether online evaluation is disabled.""" + enable_online_evaluation_output_file: bool | None = None + """Whether online-evaluation output-file generation is enabled.""" @staticmethod def from_dict(obj: Any) -> 'SessionSettingsOnlineEvaluationSnapshot': @@ -8212,20 +11481,45 @@ def to_dict(self) -> dict: # Experimental: this type is part of an experimental API and may change or be removed. @dataclass class SessionSettingsRepoSnapshot: - """Redacted repository and GitHub host settings for a session.""" + """Redacted repository and GitHub host settings for a session. + Redacted repository and host settings. + """ branch: str | None = None + """Checked-out repository branch.""" + commit: str | None = None + """Checked-out commit SHA.""" + host: str | None = None + """GitHub server host name.""" + host_protocol: str | None = None + """Protocol used to access the GitHub host.""" + id: float | None = None + """GitHub repository database ID.""" + name: str | None = None + """Repository name.""" + owner_id: float | None = None + """GitHub repository owner database ID.""" + owner_name: str | None = None + """Repository owner login.""" + pr_commit_count: float | None = None + """Number of commits in the pull request.""" + read_write: bool | None = None + """Whether the repository is writable.""" + secret_scanning_url: str | None = None + """GitHub secret-scanning service URL.""" + server_url: str | None = None + """GitHub server base URL.""" @staticmethod def from_dict(obj: Any) -> 'SessionSettingsRepoSnapshot': @@ -8272,57 +11566,6 @@ def to_dict(self) -> dict: 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 - # Experimental: this type is part of an experimental API and may change or be removed. @dataclass class SessionSizes: @@ -8507,6 +11750,31 @@ def to_dict(self) -> dict: result: dict = {} return result +# Experimental: this type is part of an experimental API and may change or be removed. +@dataclass +class SessionsDeleteRequest: + """Session ID to delete from disk.""" + + 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) -> 'SessionsDeleteRequest': + assert isinstance(obj, dict) + 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["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 SessionsFindByPrefixRequest: @@ -8743,6 +12011,25 @@ def to_dict(self) -> dict: 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 SessionsGetMetadataRequest: + """Session ID whose persisted metadata should be read.""" + + session_id: str + """Session ID to inspect""" + + @staticmethod + def from_dict(obj: Any) -> 'SessionsGetMetadataRequest': + assert isinstance(obj, dict) + session_id = from_str(obj.get("sessionId")) + return SessionsGetMetadataRequest(session_id) + + 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 SessionsGetPersistedRemoteSteerableRequest: @@ -8785,6 +12072,45 @@ def to_dict(self) -> dict: 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 SessionsListNonEmptySessionIDSRequest: + """Limit for non-empty local session IDs.""" + + limit: int | None = None + """Maximum number of session IDs to return.""" + + @staticmethod + def from_dict(obj: Any) -> 'SessionsListNonEmptySessionIDSRequest': + assert isinstance(obj, dict) + limit = from_union([from_int, from_none], obj.get("limit")) + return SessionsListNonEmptySessionIDSRequest(limit) + + def to_dict(self) -> dict: + result: dict = {} + 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 SessionsListNonEmptySessionIDSResult: + """Recent local session IDs that contain user-visible history.""" + + session_ids: list[str] + """Session IDs ordered newest-first.""" + + @staticmethod + def from_dict(obj: Any) -> 'SessionsListNonEmptySessionIDSResult': + assert isinstance(obj, dict) + session_ids = from_list(from_str, obj.get("sessionIds")) + return SessionsListNonEmptySessionIDSResult(session_ids) + + def to_dict(self) -> dict: + result: dict = {} + 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 SessionsLoadDeferredRepoHooksRequest: @@ -8816,9 +12142,6 @@ class SessionsOpenCreateKind(Enum): class SessionsOpenHandoffKind(Enum): HANDOFF = "handoff" -class SessionsOpenRemoteKind(Enum): - REMOTE = "remote" - class SessionsOpenResumeKind(Enum): RESUME = "resume" @@ -9065,6 +12388,9 @@ def to_dict(self) -> dict: result["expectedFromSessionId"] = from_union([from_str, from_none], self.expected_from_session_id) return result +class SettableTokenAuthInfoType(Enum): + TOKEN = "token" + # Experimental: this type is part of an experimental API and may change or be removed. @dataclass class ShellCancelUserRequestedRequest: @@ -9239,6 +12565,9 @@ class Skill: """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""" @@ -9254,9 +12583,10 @@ def from_dict(obj: Any) -> 'Skill': 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, path, plugin_name) + return Skill(description, enabled, name, source, user_invocable, argument_hint, command_name, path, plugin_name) def to_dict(self) -> dict: result: dict = {} @@ -9267,6 +12597,8 @@ def to_dict(self) -> dict: 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: @@ -9282,6 +12614,31 @@ class SkillDiscoveryScope(Enum): PERSONAL_COPILOT = "personal-copilot" PROJECT = "project" +# Experimental: this type is part of an experimental API and may change or be removed. +@dataclass +class SkillsConfigSetSkillDisabledRequest: + """Adds or removes a single skill from the global disabled list, leaving every other entry + untouched. + """ + disabled: bool + """True to disable the skill, false to enable it""" + + name: str + """Name of the skill to add to or remove from the disabled list""" + + @staticmethod + def from_dict(obj: Any) -> 'SkillsConfigSetSkillDisabledRequest': + assert isinstance(obj, dict) + disabled = from_bool(obj.get("disabled")) + name = from_str(obj.get("name")) + return SkillsConfigSetSkillDisabledRequest(disabled, name) + + def to_dict(self) -> dict: + result: dict = {} + result["disabled"] = from_bool(self.disabled) + 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 SkillsDisableRequest: @@ -9406,16 +12763,56 @@ def to_dict(self) -> dict: result["warnings"] = from_list(from_str, self.warnings) return result +# Experimental: this type is part of an experimental API and may change or be removed. +@dataclass +class SlashCommandTimelineEntry: + """Timeline entry the host should append.""" + + text: str + """Text displayed for the timeline entry.""" + + type: str + """Timeline entry presentation type.""" + + url: str | None = None + """Optional URL associated with the timeline entry.""" + + @staticmethod + def from_dict(obj: Any) -> 'SlashCommandTimelineEntry': + assert isinstance(obj, dict) + text = from_str(obj.get("text")) + type = from_str(obj.get("type")) + url = from_union([from_str, from_none], obj.get("url")) + return SlashCommandTimelineEntry(text, type, url) + + def to_dict(self) -> dict: + result: dict = {} + result["text"] = from_str(self.text) + result["type"] = from_str(self.type) + if self.url is not None: + result["url"] = from_union([from_str, from_none], self.url) + return result + +class SlashCommandAddTimelineEntryResultKind(Enum): + ADD_TIMELINE_ENTRY = "add-timeline-entry" + class SlashCommandAgentPromptResultKind(Enum): AGENT_PROMPT = "agent-prompt" class SlashCommandCompletedResultKind(Enum): COMPLETED = "completed" +class SlashCommandModelPickerDialogKind(Enum): + MODEL_PICKER = "model-picker" + class SlashCommandInvocationResultKind(Enum): + ADD_TIMELINE_ENTRY = "add-timeline-entry" AGENT_PROMPT = "agent-prompt" COMPLETED = "completed" SELECT_SUBCOMMAND = "select-subcommand" + SET_MODEL = "set-model" + SET_PLAN_MODEL = "set-plan-model" + SHOW_DIALOG = "show-dialog" TEXT = "text" # Experimental: this type is part of an experimental API and may change or be removed. @@ -9452,6 +12849,15 @@ def to_dict(self) -> dict: class SlashCommandSelectSubcommandResultKind(Enum): SELECT_SUBCOMMAND = "select-subcommand" +class SlashCommandSetModelResultKind(Enum): + SET_MODEL = "set-model" + +class SlashCommandSetPlanModelResultKind(Enum): + SET_PLAN_MODEL = "set-plan-model" + +class SlashCommandShowDialogResultKind(Enum): + SHOW_DIALOG = "show-dialog" + # Experimental: this type is part of an experimental API and may change or be removed. class SubagentSettingsEntryContextTier(Enum): """Context tier override for matching subagents""" @@ -9504,6 +12910,109 @@ def to_dict(self) -> dict: result["timestamp"] = self.timestamp.isoformat() return result +# Experimental: this type is part of an experimental API and may change or be removed. +@dataclass +class TaskCompleteData: + """Task completion notification with summary from the agent""" + + objective_id: int | None = None + """Active autopilot objective ID evaluated by the completion reviewer""" + + outcome: TaskCompletionOutcome | None = None + """Semantic completion decision. Absent on legacy events and invalid tool calls""" + + reason: str | None = None + """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 + """ + success: bool | None = None + """Whether the task was accepted as complete. False when validation failed or completion was + rejected or blocked by the reviewer + """ + summary: str | None = None + """Summary of the completed task, provided by the agent""" + + @staticmethod + def from_dict(obj: Any) -> 'TaskCompleteData': + assert isinstance(obj, dict) + objective_id = from_union([from_int, from_none], obj.get("objectiveId")) + outcome = from_union([TaskCompletionOutcome, from_none], obj.get("outcome")) + reason = from_union([from_str, from_none], obj.get("reason")) + success = from_union([from_bool, from_none], obj.get("success")) + summary = from_union([from_str, from_none], obj.get("summary")) + return TaskCompleteData(objective_id, outcome, reason, success, summary) + + def to_dict(self) -> dict: + result: dict = {} + if self.objective_id is not None: + result["objectiveId"] = from_union([from_int, from_none], self.objective_id) + if self.outcome is not None: + result["outcome"] = from_union([lambda x: to_enum(TaskCompletionOutcome, x), from_none], self.outcome) + if self.reason is not None: + result["reason"] = from_union([from_str, from_none], self.reason) + if self.success is not None: + result["success"] = from_union([from_bool, from_none], self.success) + 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 TaskCompletionDecision: + """Completion-review decision produced by the task-completion tool.""" + + outcome: TaskCompletionOutcome + """Semantic result of evaluating the task completion request.""" + + completion_eligibility_token: int | None = None + """Objective eligibility token captured when the decision was evaluated.""" + + completion_rejection_budget_exhausted: bool | None = None + """Whether completion was accepted after the reviewer-rejection budget was exhausted.""" + + objective_id: int | None = None + """Active autopilot objective evaluated by the completion reviewer.""" + + reason: str | None = None + """Rationale for the completion decision, when one is available.""" + + reviewer_derived: bool | None = None + """Whether the rationale was derived from completion-reviewer output.""" + + reviewer_result_meta: Any = None + """Information-flow metadata captured from the completion reviewer.""" + + @staticmethod + def from_dict(obj: Any) -> 'TaskCompletionDecision': + assert isinstance(obj, dict) + outcome = TaskCompletionOutcome(obj.get("outcome")) + completion_eligibility_token = from_union([from_int, from_none], obj.get("completionEligibilityToken")) + completion_rejection_budget_exhausted = from_union([from_bool, from_none], obj.get("completionRejectionBudgetExhausted")) + objective_id = from_union([from_int, from_none], obj.get("objectiveId")) + reason = from_union([from_str, from_none], obj.get("reason")) + reviewer_derived = from_union([from_bool, from_none], obj.get("reviewerDerived")) + reviewer_result_meta = obj.get("reviewerResultMeta") + return TaskCompletionDecision(outcome, completion_eligibility_token, completion_rejection_budget_exhausted, objective_id, reason, reviewer_derived, reviewer_result_meta) + + def to_dict(self) -> dict: + result: dict = {} + result["outcome"] = to_enum(TaskCompletionOutcome, self.outcome) + if self.completion_eligibility_token is not None: + result["completionEligibilityToken"] = from_union([from_int, from_none], self.completion_eligibility_token) + if self.completion_rejection_budget_exhausted is not None: + result["completionRejectionBudgetExhausted"] = from_union([from_bool, from_none], self.completion_rejection_budget_exhausted) + if self.objective_id is not None: + result["objectiveId"] = from_union([from_int, from_none], self.objective_id) + if self.reason is not None: + result["reason"] = from_union([from_str, from_none], self.reason) + if self.reviewer_derived is not None: + result["reviewerDerived"] = from_union([from_bool, from_none], self.reviewer_derived) + if self.reviewer_result_meta is not None: + result["reviewerResultMeta"] = self.reviewer_result_meta + 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 @@ -9800,7 +13309,7 @@ class TasksStartAgentRequest: """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""" + """Friendly, non-unique name used when displaying the agent""" prompt: str """Task prompt for the agent""" @@ -9890,8 +13399,8 @@ def to_dict(self) -> dict: result["features"] = from_dict(from_str, self.features) return result -class TokenAuthInfoType(Enum): - TOKEN = "token" +class TokenProviderAuthInfoType(Enum): + TOKEN_PROVIDER = "token-provider" # Experimental: this type is part of an experimental API and may change or be removed. @dataclass @@ -9937,6 +13446,70 @@ def to_dict(self) -> dict: 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 ToolResultNewMessage: + """A message injected by a tool result.""" + + content: str + """Message content to inject after the tool result.""" + + source: str + """Source attributed to the injected message.""" + + @staticmethod + def from_dict(obj: Any) -> 'ToolResultNewMessage': + assert isinstance(obj, dict) + content = from_str(obj.get("content")) + source = from_str(obj.get("source")) + return ToolResultNewMessage(content, source) + + def to_dict(self) -> dict: + result: dict = {} + result["content"] = from_str(self.content) + result["source"] = from_str(self.source) + return result + +# Experimental: this type is part of an experimental API and may change or be removed. +class ToolResultType(Enum): + """Execution outcome classification.""" + + DENIED = "denied" + FAILURE = "failure" + REJECTED = "rejected" + SUCCESS = "success" + TIMEOUT = "timeout" + +# Experimental: this type is part of an experimental API and may change or be removed. +@dataclass +class ToolsExecuteRequest: + """A tool name and arguments to execute through the session's native invocation pipeline.""" + + arguments: Any + """Arguments supplied to the tool.""" + + name: str + """Name of the currently offered tool to execute.""" + + tool_call_id: str | None = None + """Optional identifier used to correlate this invocation with its tool call.""" + + @staticmethod + def from_dict(obj: Any) -> 'ToolsExecuteRequest': + assert isinstance(obj, dict) + arguments = obj.get("arguments") + name = from_str(obj.get("name")) + tool_call_id = from_union([from_str, from_none], obj.get("toolCallId")) + return ToolsExecuteRequest(arguments, name, tool_call_id) + + def to_dict(self) -> dict: + result: dict = {} + result["arguments"] = self.arguments + result["name"] = from_str(self.name) + if self.tool_call_id is not None: + result["toolCallId"] = from_union([from_str, from_none], self.tool_call_id) + return result + # Experimental: this type is part of an experimental API and may change or be removed. @dataclass class ToolsInitializeAndValidateResult: @@ -9975,6 +13548,19 @@ def to_dict(self) -> dict: 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 ToolsSetResult: + """Empty result after replacing the calling connection's externally implemented tools.""" + @staticmethod + def from_dict(obj: Any) -> 'ToolsSetResult': + assert isinstance(obj, dict) + return ToolsSetResult() + + def to_dict(self) -> dict: + result: dict = {} + return result + # Experimental: this type is part of an experimental API and may change or be removed. @dataclass class ToolsUpdateSubagentSettingsResult: @@ -10071,9 +13657,6 @@ class UIElicitationSchemaPropertyType(Enum): 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)""" @@ -10117,10 +13700,11 @@ class UIElicitationSchemaPropertyNumberType(Enum): # 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.""" - + """Completed transient query. Ordered chunks and the terminal outcome are also delivered + through `ui.ephemeral_query` session events while it runs. + """ answer: str - """Full assistant response text.""" + """Answer returned by the model""" @staticmethod def from_dict(obj: Any) -> 'UIEphemeralQueryResult': @@ -10297,40 +13881,6 @@ def to_dict(self) -> dict: 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 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""" - - lines_added: int - """Total lines of code added""" - - lines_removed: int - """Total lines of code removed""" - - @staticmethod - def from_dict(obj: Any) -> 'UsageMetricsCodeChanges': - 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) - - 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) - return result - # Experimental: this type is part of an experimental API and may change or be removed. @dataclass class UsageMetricsModelMetricRequests: @@ -10414,6 +13964,40 @@ def to_dict(self) -> dict: 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 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""" + + lines_added: int + """Total lines of code added""" + + lines_removed: int + """Total lines of code removed""" + + @staticmethod + def from_dict(obj: Any) -> 'UsageMetricsCodeChanges': + 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) + + 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) + return result + # Experimental: this type is part of an experimental API and may change or be removed. @dataclass class UsageMetricsTokenDetail: @@ -10433,9 +14017,6 @@ def to_dict(self) -> dict: result["tokenCount"] = from_int(self.token_count) return result -class UserAuthInfoType(Enum): - USER = "user" - # Experimental: this type is part of an experimental API and may change or be removed. @dataclass class UserSettingMetadata: @@ -10530,6 +14111,75 @@ class WorkspaceDiffMode(Enum): SESSION = "session" UNSTAGED = "unstaged" +# Experimental: this type is part of an experimental API and may change or be removed. +@dataclass +class WorkspacesAddSummaryRequest: + """Compaction summary checkpoint to persist.""" + + content: str + """Markdown summary content to persist.""" + + title: str + """Summary title shown in checkpoint listings.""" + + @staticmethod + def from_dict(obj: Any) -> 'WorkspacesAddSummaryRequest': + assert isinstance(obj, dict) + content = from_str(obj.get("content")) + title = from_str(obj.get("title")) + return WorkspacesAddSummaryRequest(content, title) + + def to_dict(self) -> dict: + result: dict = {} + 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 WorkspacesAddSummaryResult: + """Persisted summary metadata and refreshed workspace metadata.""" + + summary: dict[str, Any] | None = None + """Metadata for the persisted summary.""" + + workspace: dict[str, Any] | None = None + """Refreshed metadata for the containing workspace.""" + + @staticmethod + def from_dict(obj: Any) -> 'WorkspacesAddSummaryResult': + assert isinstance(obj, dict) + 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 = {} + 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 WorkspacesAutopilotObjectiveExistsResult: + """Whether the autopilot objective file exists.""" + + exists: bool + """True when the objective file exists.""" + + @staticmethod + def from_dict(obj: Any) -> 'WorkspacesAutopilotObjectiveExistsResult': + assert isinstance(obj, dict) + exists = from_bool(obj.get("exists")) + return WorkspacesAutopilotObjectiveExistsResult(exists) + + def to_dict(self) -> dict: + result: dict = {} + 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 WorkspacesCreateFileRequest: @@ -10554,6 +14204,45 @@ def to_dict(self) -> dict: 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 WorkspacesDeleteAutopilotObjectiveResult: + """Result of deleting the autopilot objective file.""" + + deleted: bool + """True when a file was deleted.""" + + @staticmethod + def from_dict(obj: Any) -> 'WorkspacesDeleteAutopilotObjectiveResult': + assert isinstance(obj, dict) + deleted = from_bool(obj.get("deleted")) + return WorkspacesDeleteAutopilotObjectiveResult(deleted) + + def to_dict(self) -> dict: + result: dict = {} + 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 WorkspacesEnsureRequest: + """Optional session context used when creating a local workspace.""" + + context: Any = None + """Opaque workspace context supplied by the session host.""" + + @staticmethod + def from_dict(obj: Any) -> 'WorkspacesEnsureRequest': + assert isinstance(obj, dict) + context = obj.get("context") + return WorkspacesEnsureRequest(context) + + def to_dict(self) -> dict: + result: dict = {} + 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 WorkspacesListFilesResult: @@ -10573,6 +14262,25 @@ def to_dict(self) -> dict: 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 WorkspacesReadAutopilotObjectiveResult: + """Autopilot objective file content, or null when missing.""" + + content: str | None = None + """Autopilot objective file content, or null when missing.""" + + @staticmethod + def from_dict(obj: Any) -> 'WorkspacesReadAutopilotObjectiveResult': + assert isinstance(obj, dict) + content = from_union([from_none, from_str], obj.get("content")) + return WorkspacesReadAutopilotObjectiveResult(content) + + def to_dict(self) -> dict: + result: dict = {} + 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 WorkspacesReadCheckpointRequest: @@ -10694,11 +14402,70 @@ def to_dict(self) -> dict: 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 WorkspacesTruncateSummariesRequest: + """Rollback point for local workspace summaries.""" + + keep_count: int + """Number of newest summaries to keep.""" + + @staticmethod + def from_dict(obj: Any) -> 'WorkspacesTruncateSummariesRequest': + assert isinstance(obj, dict) + keep_count = from_int(obj.get("keepCount")) + return WorkspacesTruncateSummariesRequest(keep_count) + + def to_dict(self) -> dict: + result: dict = {} + 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 WorkspacesWriteAutopilotObjectiveRequest: + """Autopilot objective file content to persist.""" + + content: str + """Autopilot objective file content.""" + + @staticmethod + def from_dict(obj: Any) -> 'WorkspacesWriteAutopilotObjectiveRequest': + assert isinstance(obj, dict) + content = from_str(obj.get("content")) + return WorkspacesWriteAutopilotObjectiveRequest(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 WorkspacesWriteAutopilotObjectiveResult: + """Result of writing the autopilot objective file.""" + + operation: str + """Filesystem operation performed.""" + + @staticmethod + def from_dict(obj: Any) -> 'WorkspacesWriteAutopilotObjectiveResult': + assert isinstance(obj, dict) + operation = from_str(obj.get("operation")) + return WorkspacesWriteAutopilotObjectiveResult(operation) + + def to_dict(self) -> dict: + result: dict = {} + 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 SessionAuthStatus: - """Authentication status and account metadata for the session.""" + """Authentication status and account metadata for the session. + Authentication accounts available to the internal session host. + """ is_authenticated: bool """Whether the session has resolved authentication""" @@ -10970,332 +14737,1198 @@ 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.""" +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.""" - enabled: bool - """Authoritative full allow-all state after the mutation""" + @staticmethod + def from_dict(obj: Any) -> 'BuiltInModelCatalog': + assert isinstance(obj, dict) + models = from_list(BuiltInModelCatalogEntry.from_dict, obj.get("models")) + return BuiltInModelCatalog(models) - success: bool - """Whether the operation succeeded""" + 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 BuiltinToolFormat: + """Custom grammar input format accepted by a built-in tool.""" + + definition: str + """Grammar definition accepted by the tool.""" - mode: PermissionsAllowAllMode | None = None - """Authoritative allow-all mode after the mutation""" + syntax: str + """Grammar syntax used by the format definition.""" + + type: BuiltinToolFormatType + """Custom input-format discriminator.""" @staticmethod - def from_dict(obj: Any) -> 'AllowAllPermissionSetResult': + def from_dict(obj: Any) -> 'BuiltinToolFormat': assert isinstance(obj, dict) - 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) + definition = from_str(obj.get("definition")) + syntax = from_str(obj.get("syntax")) + type = BuiltinToolFormatType(obj.get("type")) + return BuiltinToolFormat(definition, syntax, type) def to_dict(self) -> dict: result: dict = {} - 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) + result["definition"] = from_str(self.definition) + result["syntax"] = from_str(self.syntax) + result["type"] = to_enum(BuiltinToolFormatType, self.type) return result # Experimental: this type is part of an experimental API and may change or be removed. @dataclass -class AllowAllPermissionState: - """Current allow-all permission mode.""" - - enabled: bool - """Whether full allow-all permissions are currently active""" +class BuiltinToolInputSchema: + """JSON Schema object accepted by a built-in tool.""" - mode: PermissionsAllowAllMode | None = None - """Current allow-all mode""" + type: BuiltinToolInputSchemaType + """Root type of the tool input schema.""" @staticmethod - def from_dict(obj: Any) -> 'AllowAllPermissionState': + def from_dict(obj: Any) -> 'BuiltinToolInputSchema': assert isinstance(obj, dict) - enabled = from_bool(obj.get("enabled")) - mode = from_union([PermissionsAllowAllMode, from_none], obj.get("mode")) - return AllowAllPermissionState(enabled, mode) + type = BuiltinToolInputSchemaType(obj.get("type")) + return BuiltinToolInputSchema(type) def to_dict(self) -> dict: result: dict = {} - 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) + result["type"] = to_enum(BuiltinToolInputSchemaType, self.type) return result # Experimental: this type is part of an experimental API and may change or be removed. @dataclass -class SlashCommandInput: - """Optional unstructured input hint""" +class CardDigest: + """Semantic digest of a strictly parsed and schema-validated JSON MCP card. Both URL-backed + and embedded cards are canonicalised with RFC 8785 JSON Canonicalization Scheme, encoded + as UTF-8, and hashed with SHA-256. - hint: str - """Hint to display when command input has not been provided""" + Semantic digest of the exact validated JSON content bound to the plan handle. + """ + algorithm: CardDigestAlgorithm + """Digest algorithm and canonical representation""" - choices: list[SlashCommandInputChoice] | None = None - """Optional literal choices the input accepts, each with a human-facing description; clients - may render these as selectable options + value: str + """SHA-256 digest of the RFC 8785 canonical UTF-8 bytes, encoded as exactly 64 lowercase + hexadecimal characters. """ - completion: SlashCommandInputCompletion | None = None - """Optional completion hint for the input (e.g. 'directory' for filesystem path completion)""" - 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 + @staticmethod + def from_dict(obj: Any) -> 'CardDigest': + assert isinstance(obj, dict) + algorithm = CardDigestAlgorithm(obj.get("algorithm")) + value = from_str(obj.get("value")) + return CardDigest(algorithm, value) + + def to_dict(self) -> dict: + result: dict = {} + result["algorithm"] = to_enum(CardDigestAlgorithm, self.algorithm) + result["value"] = from_str(self.value) + return result + +# Experimental: this type is part of an experimental API and may change or be removed. +@dataclass +class CatalogAuthenticationRequiredError: + """An optional catalog authentication exchange did not establish the caller's identity. + Anonymous search remains supported; this refusal is reserved for an operation that cannot + continue after the attempted exchange. It is distinct from `policy-rejected` and from a + network failure, and the reason identifies the recovery action. """ - required: bool | None = None - """When true, the command requires non-empty input; clients should render the input hint as - required + kind: ClassVar[str] = "authentication-required" + """Discriminator: the caller is not authenticated""" + + message: str + """Human-readable explanation, safe to surface. Never contains a credential or token, nor a + query, URL, handle, or secret. + """ + reason: CatalogAuthenticationRequiredReason + """Why authentication failed. Only an expired credential justifies attempting a silent + refresh; an absent or rejected credential requires sign-in. """ @staticmethod - def from_dict(obj: Any) -> 'SlashCommandInput': + def from_dict(obj: Any) -> 'CatalogAuthenticationRequiredError': assert isinstance(obj, dict) - 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) + message = from_str(obj.get("message")) + reason = CatalogAuthenticationRequiredReason(obj.get("reason")) + return CatalogAuthenticationRequiredError(message, reason) def to_dict(self) -> dict: result: dict = {} - 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) + result["kind"] = self.kind + result["message"] = from_str(self.message) + result["reason"] = to_enum(CatalogAuthenticationRequiredReason, self.reason) return result # Experimental: this type is part of an experimental API and may change or be removed. @dataclass -class PushAttachmentDirectory: - """Directory attachment""" +class CatalogCandidateSourceEmbedded: + """Candidate whose card reference arrived inline. The document and its content-derived + properties stay behind the runtime boundary. + """ + kind: ClassVar[str] = "embedded" + """Discriminator: the card is embedded, and carries no URL""" - display_name: str - """User-facing display name for the attachment""" + @staticmethod + def from_dict(obj: Any) -> 'CatalogCandidateSourceEmbedded': + assert isinstance(obj, dict) + return CatalogCandidateSourceEmbedded() - path: str - """Absolute directory path""" + def to_dict(self) -> dict: + result: dict = {} + result["kind"] = self.kind + return result - type: ClassVar[str] = "directory" - """Attachment type discriminator""" +# Experimental: this type is part of an experimental API and may change or be removed. +@dataclass +class CatalogCandidateSourceURL: + """Candidate whose card is retrieved from a URL through the runtime's hardened fetch + boundary. + """ + kind: ClassVar[str] = "url" + """Discriminator: the card is URL-backed, and carries no embedded data""" + + url: str + """Card URL as advertised. Inert untrusted data: the runtime retrieves it only through its + own hardened boundary, and it is never logged. + """ @staticmethod - def from_dict(obj: Any) -> 'PushAttachmentDirectory': + def from_dict(obj: Any) -> 'CatalogCandidateSourceURL': assert isinstance(obj, dict) - display_name = from_str(obj.get("displayName")) - path = from_str(obj.get("path")) - return PushAttachmentDirectory(display_name, path) + url = from_str(obj.get("url")) + return CatalogCandidateSourceURL(url) 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["kind"] = self.kind + 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 ConnectedRemoteSessionMetadata: - """Metadata for a connected remote session.""" +class InstalledPluginSourceURL: + """Source descriptor for a direct URL plugin install, with URL, optional ref or full commit + SHA, and optional subpath. + """ + source: MCPServerCardURLKind + """Constant value. Always "url".""" - kind: ConnectedRemoteSessionMetadataKind - """Neutral SDK discriminator for the connected remote session kind.""" + url: str + """URL of the plugin source.""" - modified_time: datetime - """Last session update time as an ISO 8601 string.""" + path: str | None = None + """Optional source-relative path to the plugin.""" - repository: ConnectedRemoteSessionMetadataRepository - """Repository associated with the connected remote session.""" + ref: str | None = None + """Optional Git ref to resolve.""" - session_id: str - """SDK session ID for the connected remote session.""" + sha: str | None = None + """Optional full 40-character hexadecimal commit SHA.""" - start_time: datetime - """Session start time as an ISO 8601 string.""" + @staticmethod + def from_dict(obj: Any) -> 'InstalledPluginSourceURL': + assert isinstance(obj, dict) + source = MCPServerCardURLKind(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) - name: str | None = None - """Optional friendly session name.""" + def to_dict(self) -> dict: + result: dict = {} + result["source"] = to_enum(MCPServerCardURLKind, 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 - pull_request_number: int | None = None - """Pull request number associated with the session.""" +# Experimental: this type is part of an experimental API and may change or be removed. +@dataclass +class SessionInstalledPluginSourceURL: + """Source descriptor for a direct URL plugin install, with URL, optional ref or full commit + SHA, and optional subpath. + """ + source: MCPServerCardURLKind + """Constant value. Always "url".""" - resource_id: str | None = None - """Original remote resource identifier.""" + url: str + """URL of the plugin source.""" - stale_at: datetime | None = None - """Remote session staleness deadline as an ISO 8601 string.""" + path: str | None = None + """Optional source-relative path to the plugin.""" - state: str | None = None - """Remote session state returned by the backing service.""" + ref: str | None = None + """Optional Git ref to resolve.""" - summary: str | None = None - """Optional session summary.""" + sha: str | None = None + """Optional full 40-character hexadecimal commit SHA.""" @staticmethod - def from_dict(obj: Any) -> 'ConnectedRemoteSessionMetadata': + def from_dict(obj: Any) -> 'SessionInstalledPluginSourceURL': 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) + source = MCPServerCardURLKind(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["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["source"] = to_enum(MCPServerCardURLKind, 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 MetadataContextHeaviestMessagesResult: - """The heaviest individual messages in the session's context window, most-expensive first.""" - - messages: list[ContextHeaviestMessage] - """Heaviest messages, most-expensive first.""" +class CatalogNegotiatedContract: + """The protocol version and capability set the runtime actually honoured for a successful + catalog operation. - total_tokens: int - """Total token count of the current context window, so callers can compute each message's - share without a second call. + Protocol version and capabilities the runtime honoured. + """ + granted_capabilities: list[CatalogCapability] + """Wire features the runtime understood for this operation. Always a superset of the + caller's required features, because any shortfall is a refusal instead. Operation + availability remains a separate typed result. """ + runtime_protocol_version: int + """Protocol version of the runtime that served the request.""" @staticmethod - def from_dict(obj: Any) -> 'MetadataContextHeaviestMessagesResult': + def from_dict(obj: Any) -> 'CatalogNegotiatedContract': assert isinstance(obj, dict) - messages = from_list(ContextHeaviestMessage.from_dict, obj.get("messages")) - total_tokens = from_int(obj.get("totalTokens")) - return MetadataContextHeaviestMessagesResult(messages, total_tokens) + granted_capabilities = from_list(CatalogCapability, obj.get("grantedCapabilities")) + runtime_protocol_version = from_int(obj.get("runtimeProtocolVersion")) + return CatalogNegotiatedContract(granted_capabilities, runtime_protocol_version) def to_dict(self) -> dict: result: dict = {} - result["messages"] = from_list(lambda x: to_class(ContextHeaviestMessage, x), self.messages) - result["totalTokens"] = from_int(self.total_tokens) + result["grantedCapabilities"] = from_list(lambda x: to_enum(CatalogCapability, x), self.granted_capabilities) + result["runtimeProtocolVersion"] = from_int(self.runtime_protocol_version) return result # Experimental: this type is part of an experimental API and may change or be removed. @dataclass -class CanvasHostContextCapabilities: - """Host capabilities""" +class CatalogSearchRequest: + """A bounded catalog search. Both the query length and the result count are capped by the + schema so a caller cannot request an unbounded scan. + """ + contract: CatalogClientContract + """Protocol version and capabilities the caller requires.""" - canvases: bool | None = None - """Whether canvas rendering is supported""" + query: str + """Free-text search query. Never written to logs or telemetry.""" + + kinds: list[CatalogCandidateKind] | None = None + """Restrict results to these candidate kinds. When omitted, every kind the runtime supports + is searched. + """ + limit: int | None = None + """Maximum number of candidates to return. Defaults to 10 when omitted.""" @staticmethod - def from_dict(obj: Any) -> 'CanvasHostContextCapabilities': + def from_dict(obj: Any) -> 'CatalogSearchRequest': assert isinstance(obj, dict) - canvases = from_union([from_bool, from_none], obj.get("canvases")) - return CanvasHostContextCapabilities(canvases) + contract = CatalogClientContract.from_dict(obj.get("contract")) + query = from_str(obj.get("query")) + kinds = from_union([lambda x: from_list(CatalogCandidateKind, x), from_none], obj.get("kinds")) + limit = from_union([from_int, from_none], obj.get("limit")) + return CatalogSearchRequest(contract, query, kinds, limit) def to_dict(self) -> dict: result: dict = {} - if self.canvases is not None: - result["canvases"] = from_union([from_bool, from_none], self.canvases) + result["contract"] = to_class(CatalogClientContract, self.contract) + result["query"] = from_str(self.query) + if self.kinds is not None: + result["kinds"] = from_union([lambda x: from_list(lambda x: to_enum(CatalogCandidateKind, x), x), from_none], self.kinds) + 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 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 CatalogContractViolationError: + """An upstream catalog response broke the wire contract. Most importantly, every result must + carry exactly one of a URL or embedded data: a result carrying both, or neither, is + refused here rather than being guessed at. + """ + kind: ClassVar[str] = "contract-violation" + """Discriminator: the upstream response broke the contract""" - display_name: str - """Human-readable canvas name""" + message: str + """Human-readable explanation, safe to surface. Never echoes response content, nor a query, + URL, handle, or secret. + """ + reason: CatalogContractViolationReason + """Which rule the response broke.""" - extension_id: str - """Owning provider identifier""" + @staticmethod + def from_dict(obj: Any) -> 'CatalogContractViolationError': + assert isinstance(obj, dict) + message = from_str(obj.get("message")) + reason = CatalogContractViolationReason(obj.get("reason")) + return CatalogContractViolationError(message, reason) - actions: list[CanvasAction] | None = None - """Actions the agent or host may invoke on an open instance""" + def to_dict(self) -> dict: + result: dict = {} + result["kind"] = self.kind + result["message"] = from_str(self.message) + result["reason"] = to_enum(CatalogContractViolationReason, self.reason) + 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 CatalogHandleRejectedError: + """A presented handle was not accepted. Handles are runtime-instance scoped, TTL-bound, and + single-use, so each way of failing is reported distinctly. + """ + handle_type: CatalogHandleType + """Which kind of handle was presented.""" - icon: str | None = None - """Host-local PNG path for the canvas icon, when supplied""" + kind: ClassVar[str] = "handle-rejected" + """Discriminator: a handle was rejected""" - input_schema: Any = None - """JSON Schema for canvas open input""" + message: str + """Human-readable explanation, safe to surface. Never contains the handle itself, nor a + query, URL, or secret. + """ + reason: CatalogHandleRejectionReason + """Why the handle was rejected.""" @staticmethod - def from_dict(obj: Any) -> 'DiscoveredCanvas': + def from_dict(obj: Any) -> 'CatalogHandleRejectedError': 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")) - 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) + handle_type = CatalogHandleType(obj.get("handleType")) + message = from_str(obj.get("message")) + reason = CatalogHandleRejectionReason(obj.get("reason")) + return CatalogHandleRejectedError(handle_type, message, reason) 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.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 + result["handleType"] = to_enum(CatalogHandleType, self.handle_type) + result["kind"] = self.kind + result["message"] = from_str(self.message) + result["reason"] = to_enum(CatalogHandleRejectionReason, self.reason) return result # Experimental: this type is part of an experimental API and may change or be removed. @dataclass -class OpenCanvasInstance: - """Open canvas instance snapshot.""" - - canvas_id: str - """Provider-local canvas identifier""" - - extension_id: str - """Owning provider identifier""" +class CatalogInvalidRequestError: + """The request was rejected before any work was done, because a bounded field fell outside + its permitted range or a required field was unusable. + """ + field: CatalogInvalidRequestField + """Which request field was rejected.""" - instance_id: str - """Stable caller-supplied canvas instance identifier""" + kind: ClassVar[str] = "invalid-request" + """Discriminator: the request itself was invalid""" - extension_name: str | None = None - """Owning extension display name, when available""" + message: str + """Human-readable explanation, safe to surface. Never echoes the offending value, nor a + query, URL, handle, or secret. + """ - icon: str | None = None - """Host-local PNG path for the canvas icon, when supplied""" + @staticmethod + def from_dict(obj: Any) -> 'CatalogInvalidRequestError': + assert isinstance(obj, dict) + field = CatalogInvalidRequestField(obj.get("field")) + message = from_str(obj.get("message")) + return CatalogInvalidRequestError(field, message) + + def to_dict(self) -> dict: + result: dict = {} + result["field"] = to_enum(CatalogInvalidRequestField, self.field) + result["kind"] = self.kind + 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 CatalogMalformedCardError: + """A card could not be parsed or did not satisfy its declared media type's schema.""" + + kind: ClassVar[str] = "malformed-card" + """Discriminator: the card was malformed""" + + message: str + """Human-readable explanation, safe to surface. Never echoes card content, nor a query, URL, + handle, or secret. + """ + reason: CatalogMalformedCardReason + """How the card failed validation.""" + + media_type: CatalogMediaType | None = None + """Media type the card was interpreted as, when it declared one this runtime recognises.""" + + @staticmethod + def from_dict(obj: Any) -> 'CatalogMalformedCardError': + assert isinstance(obj, dict) + message = from_str(obj.get("message")) + reason = CatalogMalformedCardReason(obj.get("reason")) + media_type = from_union([CatalogMediaType, from_none], obj.get("mediaType")) + return CatalogMalformedCardError(message, reason, media_type) + + def to_dict(self) -> dict: + result: dict = {} + result["kind"] = self.kind + result["message"] = from_str(self.message) + result["reason"] = to_enum(CatalogMalformedCardReason, self.reason) + if self.media_type is not None: + result["mediaType"] = from_union([lambda x: to_enum(CatalogMediaType, x), from_none], self.media_type) + return result + +# Experimental: this type is part of an experimental API and may change or be removed. +@dataclass +class MCPServerCardEmbedded: + """An MCP server card supplied inline as an inert document.""" + + data: str + """The card document verbatim, treated as inert untrusted bytes. The runtime parses and + validates it; the host is not expected to interpret it. Never logged. + """ + kind: ClassVar[str] = "embedded" + """Discriminator: the card is embedded, and carries no URL""" + + media_type: MCPServerCardMediaType + """Media type the card is expected to conform to.""" + + @staticmethod + def from_dict(obj: Any) -> 'MCPServerCardEmbedded': + assert isinstance(obj, dict) + data = from_str(obj.get("data")) + media_type = MCPServerCardMediaType(obj.get("mediaType")) + return MCPServerCardEmbedded(data, media_type) + + def to_dict(self) -> dict: + result: dict = {} + result["data"] = from_str(self.data) + result["kind"] = self.kind + result["mediaType"] = to_enum(MCPServerCardMediaType, self.media_type) + return result + +# Experimental: this type is part of an experimental API and may change or be removed. +@dataclass +class MCPServerCardURL: + """An MCP server card to be retrieved from a URL through the runtime's hardened fetch + boundary. + """ + kind: ClassVar[str] = "url" + """Discriminator: the card is URL-backed, and carries no embedded data""" + + media_type: MCPServerCardMediaType + """Media type the card is expected to conform to.""" + + url: str + """Card URL. Retrieved only through the runtime's hardened boundary, with scheme, + credential, address-range, redirect, timeout, and response-size controls applied. Never + logged. + """ + + @staticmethod + def from_dict(obj: Any) -> 'MCPServerCardURL': + assert isinstance(obj, dict) + media_type = MCPServerCardMediaType(obj.get("mediaType")) + url = from_str(obj.get("url")) + return MCPServerCardURL(media_type, url) + + def to_dict(self) -> dict: + result: dict = {} + result["kind"] = self.kind + result["mediaType"] = to_enum(MCPServerCardMediaType, self.media_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 CatalogNegotiationRefusedError: + """The caller's protocol version or required capabilities cannot be honoured. Returned + instead of a partial or ambiguous success. + """ + kind: ClassVar[str] = "negotiation-refused" + """Discriminator: capability or protocol-version negotiation failed""" + + message: str + """Human-readable explanation, safe to surface. Never contains a query, URL, handle, or + secret. + """ + minimum_supported_protocol_version: int + """Lowest caller protocol version this runtime will serve.""" + + reason: CatalogNegotiationRefusedReason + """Whether the version or the capability set was the problem.""" + + runtime_protocol_version: int + """Protocol version of the runtime that refused the request.""" + + supported_capabilities: list[CatalogCapability] + """Every wire feature this runtime understands, so the caller can retry within that + contract. This list does not imply that every deployment has enabled every operation. + """ + unsupported_capabilities: list[str] + """The subset of the caller's bounded extensible capability identifiers this runtime cannot + honour. + """ + + @staticmethod + def from_dict(obj: Any) -> 'CatalogNegotiationRefusedError': + assert isinstance(obj, dict) + message = from_str(obj.get("message")) + minimum_supported_protocol_version = from_int(obj.get("minimumSupportedProtocolVersion")) + reason = CatalogNegotiationRefusedReason(obj.get("reason")) + runtime_protocol_version = from_int(obj.get("runtimeProtocolVersion")) + supported_capabilities = from_list(CatalogCapability, obj.get("supportedCapabilities")) + unsupported_capabilities = from_list(from_str, obj.get("unsupportedCapabilities")) + return CatalogNegotiationRefusedError(message, minimum_supported_protocol_version, reason, runtime_protocol_version, supported_capabilities, unsupported_capabilities) + + def to_dict(self) -> dict: + result: dict = {} + result["kind"] = self.kind + result["message"] = from_str(self.message) + result["minimumSupportedProtocolVersion"] = from_int(self.minimum_supported_protocol_version) + result["reason"] = to_enum(CatalogNegotiationRefusedReason, self.reason) + result["runtimeProtocolVersion"] = from_int(self.runtime_protocol_version) + result["supportedCapabilities"] = from_list(lambda x: to_enum(CatalogCapability, x), self.supported_capabilities) + result["unsupportedCapabilities"] = from_list(from_str, self.unsupported_capabilities) + return result + +# Experimental: this type is part of an experimental API and may change or be removed. +@dataclass +class CatalogNetworkFailureError: + """The runtime could not reach the catalog authority or retrieve a card. Covers being + offline as well as transport-level failure. + """ + kind: ClassVar[str] = "network-failure" + """Discriminator: the network operation failed""" + + message: str + """Human-readable explanation, safe to surface. Never contains a query, URL, handle, or + secret. + """ + reason: CatalogNetworkFailureReason + """Categorised failure, low cardinality so it can be aggregated without carrying a URL.""" + + status_code: int | None = None + """HTTP status code, when the failure was a rejected response.""" + + @staticmethod + def from_dict(obj: Any) -> 'CatalogNetworkFailureError': + assert isinstance(obj, dict) + message = from_str(obj.get("message")) + reason = CatalogNetworkFailureReason(obj.get("reason")) + status_code = from_union([from_int, from_none], obj.get("statusCode")) + return CatalogNetworkFailureError(message, reason, status_code) + + def to_dict(self) -> dict: + result: dict = {} + result["kind"] = self.kind + result["message"] = from_str(self.message) + result["reason"] = to_enum(CatalogNetworkFailureReason, self.reason) + if self.status_code is not None: + result["statusCode"] = from_union([from_int, from_none], self.status_code) + return result + +# Experimental: this type is part of an experimental API and may change or be removed. +@dataclass +class CatalogNotInstallableError: + """The candidate is discoverable but cannot be installed. `application/ai-skill` resolves + here, because it stays searchable while remaining typed non-installable. + """ + kind: ClassVar[str] = "not-installable" + """Discriminator: the candidate cannot be installed""" + + message: str + """Human-readable explanation, safe to surface. Never contains a query, URL, handle, or + secret. + """ + reason: CatalogNotInstallableReason + """Why the candidate cannot be installed.""" + + @staticmethod + def from_dict(obj: Any) -> 'CatalogNotInstallableError': + assert isinstance(obj, dict) + message = from_str(obj.get("message")) + reason = CatalogNotInstallableReason(obj.get("reason")) + return CatalogNotInstallableError(message, reason) + + def to_dict(self) -> dict: + result: dict = {} + result["kind"] = self.kind + result["message"] = from_str(self.message) + result["reason"] = to_enum(CatalogNotInstallableReason, self.reason) + return result + +# Experimental: this type is part of an experimental API and may change or be removed. +@dataclass +class CatalogPolicyRejectedError: + """Registry or enterprise policy refused the operation.""" + + kind: ClassVar[str] = "policy-rejected" + """Discriminator: policy refused the operation""" + + message: str + """Human-readable explanation, safe to surface. Never contains a query, URL, handle, or + secret. + """ + source: MCPPlanPolicySource + """Which authority produced the decision.""" + + @staticmethod + def from_dict(obj: Any) -> 'CatalogPolicyRejectedError': + assert isinstance(obj, dict) + message = from_str(obj.get("message")) + source = MCPPlanPolicySource(obj.get("source")) + return CatalogPolicyRejectedError(message, source) + + def to_dict(self) -> dict: + result: dict = {} + result["kind"] = self.kind + result["message"] = from_str(self.message) + result["source"] = to_enum(MCPPlanPolicySource, self.source) + return result + +# Experimental: this type is part of an experimental API and may change or be removed. +@dataclass +class CatalogUnavailableError: + """The operation is not available on this runtime. Distinct from a network failure: nothing + was attempted. + """ + kind: ClassVar[str] = "unavailable" + """Discriminator: the operation is not available""" + + message: str + """Human-readable explanation, safe to surface. Never contains a query, URL, handle, or + secret. + """ + reason: CatalogUnavailableReason + """Why the operation is unavailable.""" + + @staticmethod + def from_dict(obj: Any) -> 'CatalogUnavailableError': + assert isinstance(obj, dict) + message = from_str(obj.get("message")) + reason = CatalogUnavailableReason(obj.get("reason")) + return CatalogUnavailableError(message, reason) + + def to_dict(self) -> dict: + result: dict = {} + result["kind"] = self.kind + result["message"] = from_str(self.message) + result["reason"] = to_enum(CatalogUnavailableReason, self.reason) + return result + +# Experimental: this type is part of an experimental API and may change or be removed. +@dataclass +class CatalogUnavailableTransportError: + """No transport this runtime can use is available for the requested server.""" + + kind: ClassVar[str] = "unavailable-transport" + """Discriminator: no usable transport is available""" + + message: str + """Human-readable explanation, safe to surface. Never contains a query, URL, handle, or + secret. + """ + reason: CatalogUnavailableTransportReason + """Why no transport could be offered.""" + + @staticmethod + def from_dict(obj: Any) -> 'CatalogUnavailableTransportError': + assert isinstance(obj, dict) + message = from_str(obj.get("message")) + reason = CatalogUnavailableTransportReason(obj.get("reason")) + return CatalogUnavailableTransportError(message, reason) + + def to_dict(self) -> dict: + result: dict = {} + result["kind"] = self.kind + result["message"] = from_str(self.message) + result["reason"] = to_enum(CatalogUnavailableTransportReason, self.reason) + return result + +# Experimental: this type is part of an experimental API and may change or be removed. +@dataclass +class CatalogUnsafeRetrievalError: + """Retrieval was refused by the runtime's hardened fetch boundary before any request left + the process, or before a redirect was followed. + """ + kind: ClassVar[str] = "unsafe-retrieval" + """Discriminator: retrieval was refused as unsafe""" + + message: str + """Human-readable explanation, safe to surface. Never contains the refused URL, nor a query, + handle, or secret. + """ + reason: CatalogUnsafeRetrievalReason + """Which control refused the retrieval, low cardinality so it can be aggregated without + carrying a URL. + """ + + @staticmethod + def from_dict(obj: Any) -> 'CatalogUnsafeRetrievalError': + assert isinstance(obj, dict) + message = from_str(obj.get("message")) + reason = CatalogUnsafeRetrievalReason(obj.get("reason")) + return CatalogUnsafeRetrievalError(message, reason) + + def to_dict(self) -> dict: + result: dict = {} + result["kind"] = self.kind + result["message"] = from_str(self.message) + result["reason"] = to_enum(CatalogUnsafeRetrievalReason, self.reason) + return result + +# Experimental: this type is part of an experimental API and may change or be removed. +@dataclass +class CatalogUnsupportedKindError: + """The request asked for a candidate kind this runtime does not serve.""" + + kind: ClassVar[str] = "unsupported-kind" + """Discriminator: an unsupported candidate kind was requested""" + + message: str + """Human-readable explanation, safe to surface. Never contains a query, URL, handle, or + secret. + """ + requested_kinds: list[CatalogCandidateKind] + """The kinds from the request that are not supported.""" + + supported_kinds: list[CatalogCandidateKind] + """Every candidate kind this runtime can serve.""" + + @staticmethod + def from_dict(obj: Any) -> 'CatalogUnsupportedKindError': + assert isinstance(obj, dict) + message = from_str(obj.get("message")) + requested_kinds = from_list(CatalogCandidateKind, obj.get("requestedKinds")) + supported_kinds = from_list(CatalogCandidateKind, obj.get("supportedKinds")) + return CatalogUnsupportedKindError(message, requested_kinds, supported_kinds) + + def to_dict(self) -> dict: + result: dict = {} + result["kind"] = self.kind + result["message"] = from_str(self.message) + result["requestedKinds"] = from_list(lambda x: to_enum(CatalogCandidateKind, x), self.requested_kinds) + result["supportedKinds"] = from_list(lambda x: to_enum(CatalogCandidateKind, x), self.supported_kinds) + 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""" + + choices: list[SlashCommandInputChoice] | None = None + """Optional literal choices the input accepts, each with a human-facing description; clients + may render these as selectable options + """ + completion: SlashCommandInputCompletion | None = None + """Optional completion hint for the input (e.g. 'directory' for filesystem path completion)""" + + 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) -> 'SlashCommandInput': + assert isinstance(obj, dict) + 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["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 PushAttachmentDirectory: + """Directory attachment""" + + display_name: str + """User-facing display name for the attachment""" + + path: str + """Absolute directory path""" + + type: ClassVar[str] = "directory" + """Attachment type discriminator""" + + @staticmethod + def from_dict(obj: Any) -> 'PushAttachmentDirectory': + assert isinstance(obj, dict) + 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["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 CommandsFinalizeInvocationEffectRequest: + """The pending slash-command invocation effect to finalize, plus whether the host applied or + cancelled it. + """ + effect: dict[str, Any] + """The slash-command result object that produced the pending effect, echoed back unchanged.""" + + outcome: CommandsInvocationEffectOutcome + """Whether the host applied or cancelled the pending invocation effect.""" + + @staticmethod + def from_dict(obj: Any) -> 'CommandsFinalizeInvocationEffectRequest': + assert isinstance(obj, dict) + effect = from_dict(lambda x: x, obj.get("effect")) + outcome = CommandsInvocationEffectOutcome(obj.get("outcome")) + return CommandsFinalizeInvocationEffectRequest(effect, outcome) + + def to_dict(self) -> dict: + result: dict = {} + result["effect"] = from_dict(lambda x: x, self.effect) + result["outcome"] = to_enum(CommandsInvocationEffectOutcome, self.outcome) + return result + +# Experimental: this type is part of an experimental API and may change or be removed. +@dataclass +class CommandsInvokeRequest: + """Slash command name and optional raw input string to invoke.""" + + name: str + """Command name. Leading slashes are stripped and the name is matched case-insensitively.""" + + input: str | None = None + """Raw input after the command name""" + + origin: CommandsInvocationOrigin | None = None + """Optional client surface that initiated the invocation""" + + @staticmethod + def from_dict(obj: Any) -> 'CommandsInvokeRequest': + assert isinstance(obj, dict) + name = from_str(obj.get("name")) + input = from_union([from_str, from_none], obj.get("input")) + origin = from_union([CommandsInvocationOrigin, from_none], obj.get("origin")) + return CommandsInvokeRequest(name, input, origin) + + def to_dict(self) -> dict: + result: dict = {} + result["name"] = from_str(self.name) + if self.input is not None: + result["input"] = from_union([from_str, from_none], self.input) + if self.origin is not None: + result["origin"] = from_union([lambda x: to_enum(CommandsInvocationOrigin, x), from_none], self.origin) + 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: + """Connection-level opt-ins for the `server.connect` handshake. Transport authentication is + consumed by the native protocol boundary before dispatch. + """ + client_info: _ConnectClientInfo | None = None + """Identity of the integrating host. Optional; omit it to keep the default attribution.""" + + 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) + client_info = from_union([_ConnectClientInfo.from_dict, from_none], obj.get("clientInfo")) + 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(client_info, enable_git_hub_telemetry_forwarding, token) + + def to_dict(self) -> dict: + result: dict = {} + if self.client_info is not None: + result["clientInfo"] = from_union([lambda x: to_class(_ConnectClientInfo, x), from_none], self.client_info) + 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. +@dataclass +class ConnectedRemoteSessionMetadata: + """Metadata for a connected remote session.""" + + kind: ConnectedRemoteSessionMetadataKind + """Neutral SDK discriminator for the connected remote session kind.""" + + modified_time: datetime + """Last session update time as an ISO 8601 string.""" + + repository: ConnectedRemoteSessionMetadataRepository + """Repository associated with the connected remote session.""" + + session_id: str + """SDK session ID for the connected remote session.""" + + start_time: datetime + """Session start time as an ISO 8601 string.""" + + 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) -> 'ConnectedRemoteSessionMetadata': + 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) + + 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) + return result + +# Experimental: this type is part of an experimental API and may change or be removed. +@dataclass +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) -> 'ContentExclusionCheckPathsResult': + assert isinstance(obj, dict) + 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["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 MetadataContextHeaviestMessagesResult: + """The heaviest individual messages in the session's context window, most-expensive first.""" + + 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) -> 'MetadataContextHeaviestMessagesResult': + assert isinstance(obj, dict) + 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["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 CanvasHostContextCapabilities: + """Host capabilities""" + + canvases: bool | None = None + """Whether canvas rendering is supported""" + + @staticmethod + def from_dict(obj: Any) -> 'CanvasHostContextCapabilities': + assert isinstance(obj, dict) + canvases = from_union([from_bool, from_none], obj.get("canvases")) + return CanvasHostContextCapabilities(canvases) + + def to_dict(self) -> dict: + result: dict = {} + 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 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.""" + + display_name: str + """Human-readable canvas name""" + + extension_id: str + """Owning provider identifier""" + + actions: list[CanvasAction] | None = None + """Actions the agent or host may invoke on an open instance""" + + 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) -> 'DiscoveredCanvas': + 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")) + 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["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 OpenCanvasInstance: + """Open canvas instance snapshot.""" + + canvas_id: str + """Provider-local canvas identifier""" + + extension_id: str + """Owning provider identifier""" + + instance_id: str + """Stable caller-supplied canvas instance identifier""" + + 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: Any = None """Input supplied when the instance was opened""" @@ -11342,6 +15975,119 @@ 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 CatalogAISkillCandidateProvenance: + """Where the catalog reference was observed, without the card itself or any content digest. + + Where and when an AI skill catalog reference was observed. Discovery provenance + deliberately carries no content digest because search does not establish the exact + validated content a later plan will bind. + """ + authority: str + """Host of the catalog authority that advertised the reference, without path, query, or + credentials. Inert untrusted data. + """ + media_type: MediaType + """Media type advertised for the referenced AI skill card""" + + observed_at: str + """ISO 8601 timestamp at which the runtime observed the catalog reference. This is not a + retrieval or validation timestamp. + """ + + @staticmethod + def from_dict(obj: Any) -> 'CatalogAISkillCandidateProvenance': + assert isinstance(obj, dict) + authority = from_str(obj.get("authority")) + media_type = MediaType(obj.get("mediaType")) + observed_at = from_str(obj.get("observedAt")) + return CatalogAISkillCandidateProvenance(authority, media_type, observed_at) + + def to_dict(self) -> dict: + result: dict = {} + result["authority"] = from_str(self.authority) + result["mediaType"] = to_enum(MediaType, self.media_type) + result["observedAt"] = from_str(self.observed_at) + return result + +@dataclass +class CatalogCandidateProvenance: + """Where the catalog reference was observed, without the card itself or any content digest. + + Where and when an MCP server catalog reference was observed. Discovery provenance + deliberately carries no content digest because search does not establish the exact + validated content a later plan will bind. + + Where and when an AI skill catalog reference was observed. Discovery provenance + deliberately carries no content digest because search does not establish the exact + validated content a later plan will bind. + """ + authority: str + """Host of the catalog authority that advertised the reference, without path, query, or + credentials. Inert untrusted data. + """ + media_type: CatalogMediaType + """JSON MCP media type advertised for the referenced card. + + Media type advertised for the referenced AI skill card + """ + observed_at: str + """ISO 8601 timestamp at which the runtime observed the catalog reference. This is not a + retrieval or validation timestamp. + """ + + @staticmethod + def from_dict(obj: Any) -> 'CatalogCandidateProvenance': + assert isinstance(obj, dict) + authority = from_str(obj.get("authority")) + media_type = CatalogMediaType(obj.get("mediaType")) + observed_at = from_str(obj.get("observedAt")) + return CatalogCandidateProvenance(authority, media_type, observed_at) + + def to_dict(self) -> dict: + result: dict = {} + result["authority"] = from_str(self.authority) + result["mediaType"] = to_enum(CatalogMediaType, self.media_type) + result["observedAt"] = from_str(self.observed_at) + return result + +# Experimental: this type is part of an experimental API and may change or be removed. +@dataclass +class CatalogMCPServerCandidateProvenance: + """Where the catalog reference was observed, without the card itself or any content digest. + + Where and when an MCP server catalog reference was observed. Discovery provenance + deliberately carries no content digest because search does not establish the exact + validated content a later plan will bind. + """ + authority: str + """Host of the catalog authority that advertised the reference, without path, query, or + credentials. Inert untrusted data. + """ + media_type: MCPServerCardMediaType + """JSON MCP media type advertised for the referenced card.""" + + observed_at: str + """ISO 8601 timestamp at which the runtime observed the catalog reference. This is not a + retrieval or validation timestamp. + """ + + @staticmethod + def from_dict(obj: Any) -> 'CatalogMCPServerCandidateProvenance': + assert isinstance(obj, dict) + authority = from_str(obj.get("authority")) + media_type = MCPServerCardMediaType(obj.get("mediaType")) + observed_at = from_str(obj.get("observedAt")) + return CatalogMCPServerCandidateProvenance(authority, media_type, observed_at) + + def to_dict(self) -> dict: + result: dict = {} + result["authority"] = from_str(self.authority) + result["mediaType"] = to_enum(MCPServerCardMediaType, self.media_type) + result["observedAt"] = from_str(self.observed_at) + return result + # Experimental: this type is part of an experimental API and may change or be removed. @dataclass class CompletionsRequestResult: @@ -11400,6 +16146,8 @@ class DebugCollectLogsDestination: `directory` to stage redacted files for caller-managed upload/post-processing. """ kind: DebugCollectLogsResultKind + """Destination variant discriminator.""" + 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. @@ -11430,11 +16178,62 @@ def to_dict(self) -> dict: 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 DiscoveredExtension: + """Discovered extension metadata and persistent enablement state.""" + + 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) -> 'DiscoveredExtension': + assert isinstance(obj, dict) + 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["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 EventLogReadRequest: """Cursor, batch size, and optional long-poll/filter parameters for reading session events.""" + 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 @@ -11445,6 +16244,26 @@ class EventLogReadRequest: """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).""" @@ -11456,25 +16275,37 @@ class EventLogReadRequest: (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. """ @staticmethod def from_dict(obj: Any) -> 'EventLogReadRequest': assert isinstance(obj, dict) + 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_scope, cursor, max, types, wait_ms) + return EventLogReadRequest(agent_ids, agent_scope, cursor, direction, include_ephemeral, max, types, wait_ms) def to_dict(self) -> dict: result: dict = {} + 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: @@ -11490,23 +16321,34 @@ class EventsReadResult: 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. + 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 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. """ 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. + """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 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. """ @staticmethod @@ -11526,6 +16368,41 @@ def to_dict(self) -> dict: 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 ExtensionLaunchProviderResolveRequest: + """A discovered extension entrypoint that the registered integrator may classify and resolve + to an opaque launch profile. + """ + id: str + """Source-qualified extension identifier.""" + + module_path: str + """Absolute path to the discovered extension entrypoint.""" + + name: str + """Human-readable extension name.""" + + source: ExtensionSource + """Discovery source for the extension entrypoint.""" + + @staticmethod + def from_dict(obj: Any) -> 'ExtensionLaunchProviderResolveRequest': + assert isinstance(obj, dict) + id = from_str(obj.get("id")) + module_path = from_str(obj.get("modulePath")) + name = from_str(obj.get("name")) + source = ExtensionSource(obj.get("source")) + return ExtensionLaunchProviderResolveRequest(id, module_path, name, source) + + def to_dict(self) -> dict: + result: dict = {} + 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 Extension: @@ -11597,6 +16474,27 @@ def to_dict(self) -> dict: result["type"] = self.type return result +# Experimental: this type is part of an experimental API and may change or be removed. +@dataclass +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) -> 'ExtensionLaunchProviderResolveResult': + assert isinstance(obj, dict) + launch = from_union([ExtensionLaunchProfile.from_dict, from_none], obj.get("launch")) + return ExtensionLaunchProviderResolveResult(launch) + + def to_dict(self) -> dict: + result: dict = {} + 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 ExternalToolTextResultForLlmBinaryResultsForLlm: @@ -11817,6 +16715,10 @@ class ExternalToolTextResultForLlmContentShellExit: cwd: str | None = None """Working directory where the shell command was executed""" + output_file_path: str | None = None + """Path reported in the shell session's filesystem namespace when shell output exceeded the + configured large-output threshold. + """ 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. @@ -11830,9 +16732,10 @@ def from_dict(obj: Any) -> 'ExternalToolTextResultForLlmContentShellExit': 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_file_path = from_union([from_str, from_none], obj.get("outputFilePath")) 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) + return ExternalToolTextResultForLlmContentShellExit(exit_code, shell_id, cwd, output_file_path, output_preview, output_truncated) def to_dict(self) -> dict: result: dict = {} @@ -11841,6 +16744,8 @@ def to_dict(self) -> dict: result["type"] = self.type if self.cwd is not None: result["cwd"] = from_union([from_str, from_none], self.cwd) + if self.output_file_path is not None: + result["outputFilePath"] = from_union([from_str, from_none], self.output_file_path) 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: @@ -11953,6 +16858,9 @@ def to_dict(self) -> dict: class FactoryAgentRequest: """Parameters for one factory-scoped subagent call.""" + execution_token: str + """Opaque token identifying the current factory execution attempt.""" + factory_run_id: str """Factory run identifier that owns the subagent.""" @@ -11965,18 +16873,88 @@ class FactoryAgentRequest: @staticmethod def from_dict(obj: Any) -> 'FactoryAgentRequest': assert isinstance(obj, dict) + 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(factory_run_id, opts, prompt) + return FactoryAgentRequest(execution_token, factory_run_id, opts, prompt) def to_dict(self) -> dict: result: dict = {} + 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 FactoryRunFailure: + """Machine-readable terminal failure. + + Machine-readable factory run failure. + + Machine-readable failure details for an errored run. + + 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 + """Factory failure variant discriminator.""" + + 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) -> 'FactoryRunFailure': + assert isinstance(obj, dict) + 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["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 FactoryLogLine: @@ -12008,118 +16986,516 @@ def to_dict(self) -> dict: # Experimental: this type is part of an experimental API and may change or be removed. @dataclass -class FactoryRunFailure: - """Machine-readable factory run failure. +class FactoryProgressLine: + """One durable factory progress record.""" - Machine-readable failure details for an errored run. + attempt: int + """Resume attempt that emitted this record.""" + + kind: FactoryLogLineKind + """Progress record kind.""" + + recorded_at: int + """Epoch milliseconds when the record was persisted.""" + + 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) -> 'FactoryProgressLine': + assert isinstance(obj, dict) + 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["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 FactoryPhaseObservation: + """Durable lifecycle and timing for one factory phase.""" + + accumulated_active_ms: int + """Completed active time accumulated by this phase in milliseconds.""" + + current_active_ms: int + """Current live active time for this phase in milliseconds.""" + + entry_count: int + """Number of times execution entered this phase.""" + + id: str + """Phase identifier.""" + + last_entered_run_attempt: int + """Most recent run attempt that entered this phase, or `0` if the phase has never been + entered. + """ + live_agent_count: int + """Direct agents in this phase that are currently live.""" + + status: FactoryPhaseStatus + """Derived lifecycle state of the phase.""" + + title: str + """Human-readable phase title.""" + + total_agent_count: int + """Total direct agents associated with this phase.""" + + completed_at: int | None = None + """Epoch milliseconds when this phase completed; for a skipped phase, the synthetic skip + timestamp (equal to `startedAt`). """ + detail: str | None = None + """Optional human-readable phase detail.""" + + ordinal: int | None = None + """Zero-based declared phase ordinal, or null for an undeclared phase.""" + + started_at: int | None = None + """Epoch milliseconds when this phase first started; for a skipped phase, the synthetic skip + timestamp (equal to `completedAt`). + """ + + @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) + + 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 + +# 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.""" + run_id: str - """Factory run identifier. + """Factory run identifier.""" - Factory run identifier whose changed limits were declined. + limits: FactoryRunLimits | None = None + """Optional per-invocation resource ceiling overrides.""" + + log_phase_names: bool | None = None + """Whether to emit factory phase names to the session transcript.""" + + notify_on_complete: bool | None = None + """Whether to notify the originating session when the factory completes.""" + + @staticmethod + def from_dict(obj: Any) -> 'FactoryResumeRequest': + assert isinstance(obj, dict) + run_id = from_str(obj.get("runId")) + limits = from_union([FactoryRunLimits.from_dict, from_none], obj.get("limits")) + log_phase_names = from_union([from_bool, from_none], obj.get("logPhaseNames")) + notify_on_complete = from_union([from_bool, from_none], obj.get("notifyOnComplete")) + return FactoryResumeRequest(run_id, limits, log_phase_names, notify_on_complete) + + def to_dict(self) -> dict: + result: dict = {} + 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) + if self.log_phase_names is not None: + result["logPhaseNames"] = from_union([from_bool, from_none], self.log_phase_names) + if self.notify_on_complete is not None: + result["notifyOnComplete"] = from_union([from_bool, from_none], self.notify_on_complete) + return result + +# Experimental: this type is part of an experimental API and may change or be removed. +@dataclass +class RunOptions: + """Factory invocation options. + + Options controlling factory invocation. """ - type: FactoryRunFailureType - kind: FactoryRunFailureKind | None = None - """Resource ceiling that stopped the run.""" + limits: FactoryRunLimits | None = None + """Per-invocation resource ceiling overrides.""" - value: float | None = None - """Approved effective ceiling that was reached.""" + log_phase_names: bool | None = None + """Whether to emit factory phase names to the session transcript.""" - reason: str | None = None - """Human-readable reason the resume did not proceed.""" + notify_on_complete: bool | None = None + """Whether to notify the originating session when the factory completes.""" + + resume_from_run_id: str | None = None + """Run identifier whose journal and progress should seed this resumed run.""" @staticmethod - def from_dict(obj: Any) -> 'FactoryRunFailure': + def from_dict(obj: Any) -> 'RunOptions': + assert isinstance(obj, dict) + limits = from_union([FactoryRunLimits.from_dict, from_none], obj.get("limits")) + log_phase_names = from_union([from_bool, from_none], obj.get("logPhaseNames")) + notify_on_complete = from_union([from_bool, from_none], obj.get("notifyOnComplete")) + resume_from_run_id = from_union([from_str, from_none], obj.get("resumeFromRunId")) + return RunOptions(limits, log_phase_names, notify_on_complete, resume_from_run_id) + + def to_dict(self) -> dict: + result: dict = {} + if self.limits is not None: + result["limits"] = from_union([lambda x: to_class(FactoryRunLimits, x), from_none], self.limits) + if self.log_phase_names is not None: + result["logPhaseNames"] = from_union([from_bool, from_none], self.log_phase_names) + if self.notify_on_complete is not None: + result["notifyOnComplete"] = from_union([from_bool, from_none], self.notify_on_complete) + 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. +# Internal: this type is an internal SDK API and is not part of the public surface. +@dataclass +class _FactoryToolResumeRequest: + """Internal parameters for resuming a factory run from a tool.""" + + run_id: str + """Factory run identifier.""" + + limits: FactoryRunLimits | None = None + """Optional per-invocation resource ceiling overrides.""" + + tool_call_id: str | None = None + """Opaque identifier of the originating tool call.""" + + @staticmethod + def from_dict(obj: Any) -> '_FactoryToolResumeRequest': assert isinstance(obj, dict) 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")) - return FactoryRunFailure(run_id, type, kind, value, reason) + limits = from_union([FactoryRunLimits.from_dict, from_none], obj.get("limits")) + tool_call_id = from_union([from_str, from_none], obj.get("toolCallId")) + return _FactoryToolResumeRequest(run_id, limits, tool_call_id) def to_dict(self) -> dict: result: dict = {} 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.limits is not None: + result["limits"] = from_union([lambda x: to_class(FactoryRunLimits, x), from_none], self.limits) + if self.tool_call_id is not None: + result["toolCallId"] = from_union([from_str, from_none], self.tool_call_id) + return result + +# Experimental: this type is part of an experimental API and may change or be removed. +@dataclass +class GitHubTokenAcquireRequest: + """Asks the SDK client to acquire a GitHub access token from an opaque callback registration.""" + + host: str + """Effective GitHub host for which the callback must return a token.""" + + reason: GitHubTokenAcquireReason + """Why the runtime is requesting a GitHub credential.""" + + registration_id: str + """Opaque identifier generated by the SDK for this callback registration.""" + + session_id: str | None = None + """Session receiving the token. Absent only before a cloud session has been assigned its id.""" + + @staticmethod + def from_dict(obj: Any) -> 'GitHubTokenAcquireRequest': + assert isinstance(obj, dict) + host = from_str(obj.get("host")) + reason = GitHubTokenAcquireReason(obj.get("reason")) + registration_id = from_str(obj.get("registrationId")) + session_id = from_union([from_str, from_none], obj.get("sessionId")) + return GitHubTokenAcquireRequest(host, reason, registration_id, session_id) + + def to_dict(self) -> dict: + result: dict = {} + result["host"] = from_str(self.host) + result["reason"] = to_enum(GitHubTokenAcquireReason, self.reason) + result["registrationId"] = from_str(self.registration_id) + 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 GitHubTokenAcquireResult: + """SDK host response to a GitHub credential request.""" + + kind: GitHubTokenAcquireResultKind + """GitHub credential response variant discriminator.""" + + access_token: str | None = None + """GitHub access token acquired by the SDK host.""" + + expires_in: int | None = None + """Remaining token lifetime in seconds when callback execution completes. It must exceed the + one-hour preflight refresh threshold. + """ + token_type: str | None = None + """OAuth token type. Defaults to bearer when omitted.""" + + @staticmethod + def from_dict(obj: Any) -> 'GitHubTokenAcquireResult': + assert isinstance(obj, dict) + kind = GitHubTokenAcquireResultKind(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 GitHubTokenAcquireResult(kind, access_token, expires_in, token_type) + + def to_dict(self) -> dict: + result: dict = {} + result["kind"] = to_enum(GitHubTokenAcquireResultKind, 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 + +# Experimental: this type is part of an experimental API and may change or be removed. +@dataclass +class MCPOauthPendingRequestResponse: + """Host response to the pending OAuth request.""" + + kind: GitHubTokenAcquireResultKind + """OAuth response variant discriminator.""" + + access_token: str | None = None + """Access token acquired by the SDK host""" + + expires_in: int | None = None + """Token lifetime in seconds, if known.""" + + token_type: str | None = None + """OAuth token type. Defaults to bearer when omitted.""" + + @staticmethod + def from_dict(obj: Any) -> 'MCPOauthPendingRequestResponse': + assert isinstance(obj, dict) + kind = GitHubTokenAcquireResultKind(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) + + def to_dict(self) -> dict: + result: dict = {} + result["kind"] = to_enum(GitHubTokenAcquireResultKind, 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 + +# 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""" + + 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) -> 'HistoryCompactResult': + 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) + + 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) + return result + +# Experimental: this type is part of an experimental API and may change or be removed. +@dataclass +class HistorySkippedFileRestore: + """A captured file that rewind intentionally left unchanged.""" + + path: str + """Absolute path of the skipped file.""" + + reason: HistoryFileRestoreSkipReason + """Reason the file was not restored.""" + + @staticmethod + def from_dict(obj: Any) -> 'HistorySkippedFileRestore': + assert isinstance(obj, dict) + path = from_str(obj.get("path")) + reason = HistoryFileRestoreSkipReason(obj.get("reason")) + return HistorySkippedFileRestore(path, reason) + + def to_dict(self) -> dict: + result: dict = {} + 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 HistoryListRewindPointsResult: + """Rewind points and file-change-tracking availability for the session.""" + + 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) -> 'HistoryListRewindPointsResult': + assert isinstance(obj, dict) + 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["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 RunOptions: - """Factory invocation options. +class HistoryRewindFilePreview: + """A file that a conversation-and-files rewind would restore.""" - Options controlling factory invocation. - """ - limits: FactoryRunLimits | None = None - """Per-invocation resource ceiling overrides.""" + change_type: HistoryRewindChangeType + """Aggregate change made across the discarded turns.""" - resume_from_run_id: str | None = None - """Run identifier whose journal and progress should seed this resumed run.""" + 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) -> 'RunOptions': + def from_dict(obj: Any) -> 'HistoryRewindFilePreview': assert isinstance(obj, dict) - 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) + 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 = {} - 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) + 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 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""" - - success: bool - """Whether compaction completed successfully""" +class HistoryRewindRequest: + """Boundary and mode for rewinding session history.""" - tokens_removed: int - """Number of tokens freed by compaction""" - - context_window: HistoryCompactContextWindow | None = None - """Post-compaction context window usage breakdown""" + event_id: str + """ID of the user.message event that begins the discarded suffix.""" - summary_content: str | None = None - """Summary text produced by compaction. Omitted when compaction did not produce a summary - (e.g. failure path). - """ + mode: HistoryRewindMode + """Whether to rewind only conversation history or also restore captured files.""" @staticmethod - def from_dict(obj: Any) -> 'HistoryCompactResult': + def from_dict(obj: Any) -> 'HistoryRewindRequest': 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) + event_id = from_str(obj.get("eventId")) + mode = HistoryRewindMode(obj.get("mode")) + return HistoryRewindRequest(event_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["eventId"] = from_str(self.event_id) + result["mode"] = to_enum(HistoryRewindMode, self.mode) return result # Internal: this type is an internal SDK API and is not part of the public surface. @@ -12149,15 +17525,15 @@ def to_dict(self) -> dict: # Experimental: this type is part of an experimental API and may change or be removed. @dataclass class InstalledPluginSource: - """Source descriptor for a direct GitHub plugin install, with `owner/repo`, optional ref, - and optional subpath. + """Source descriptor for a direct GitHub plugin install, with `owner/repo`, optional ref or + full commit SHA, and optional subpath. - Source descriptor for a direct URL plugin install, with URL, optional ref, and optional - subpath. + Source descriptor for a direct URL plugin install, with URL, optional ref or full commit + SHA, and optional subpath. Source descriptor for a direct local plugin install, with a local filesystem path. """ - source: PurpleSource + source: InstalledPluginSourceURLSource """Constant value. Always "github". Constant value. Always "url". @@ -12165,29 +17541,46 @@ class InstalledPluginSource: Constant value. Always "local". """ path: str | None = None + """Optional repository-relative path to the plugin. + + Optional source-relative path to the plugin. + + Local filesystem path to the plugin. + """ ref: str | None = None + """Optional Git ref to resolve.""" + repo: str | None = None + """GitHub repository in `owner/repo` form.""" + + sha: str | None = None + """Optional full 40-character hexadecimal commit SHA.""" + url: str | None = None + """URL of the plugin source.""" @staticmethod def from_dict(obj: Any) -> 'InstalledPluginSource': assert isinstance(obj, dict) - source = PurpleSource(obj.get("source")) + source = InstalledPluginSourceURLSource(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, url) + return InstalledPluginSource(source, path, ref, repo, sha, url) def to_dict(self) -> dict: result: dict = {} - result["source"] = to_enum(PurpleSource, self.source) + result["source"] = to_enum(InstalledPluginSourceURLSource, 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 @@ -12195,15 +17588,15 @@ def to_dict(self) -> dict: # Experimental: this type is part of an experimental API and may change or be removed. @dataclass class SessionInstalledPluginSource: - """Source descriptor for a direct GitHub plugin install, with `owner/repo`, optional ref, - and optional subpath. + """Source descriptor for a direct GitHub plugin install, with `owner/repo`, optional ref or + full commit SHA, and optional subpath. - Source descriptor for a direct URL plugin install, with URL, optional ref, and optional - subpath. + Source descriptor for a direct URL plugin install, with URL, optional ref or full commit + SHA, and optional subpath. Source descriptor for a direct local plugin install, with a local filesystem path. """ - source: PurpleSource + source: InstalledPluginSourceURLSource """Constant value. Always "github". Constant value. Always "url". @@ -12211,29 +17604,46 @@ class SessionInstalledPluginSource: Constant value. Always "local". """ path: str | None = None + """Optional repository-relative path to the plugin. + + Optional source-relative path to the plugin. + + Local filesystem path to the plugin. + """ ref: str | None = None + """Optional Git ref to resolve.""" + repo: str | None = None + """GitHub repository in `owner/repo` form.""" + + sha: str | None = None + """Optional full 40-character hexadecimal commit SHA.""" + url: str | None = None + """URL of the plugin source.""" @staticmethod def from_dict(obj: Any) -> 'SessionInstalledPluginSource': assert isinstance(obj, dict) - source = PurpleSource(obj.get("source")) + source = InstalledPluginSourceURLSource(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, url) + return SessionInstalledPluginSource(source, path, ref, repo, sha, url) def to_dict(self) -> dict: result: dict = {} - result["source"] = to_enum(PurpleSource, self.source) + result["source"] = to_enum(InstalledPluginSourceURLSource, 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 @@ -12241,65 +17651,87 @@ def to_dict(self) -> dict: # Experimental: this type is part of an experimental API and may change or be removed. @dataclass class InstalledPluginSourceGitHub: - """Source descriptor for a direct GitHub plugin install, with `owner/repo`, optional ref, - and optional subpath. + """Source descriptor for a direct GitHub plugin install, with `owner/repo`, optional ref or + full commit SHA, and optional subpath. """ repo: str - source: FluffySource + """GitHub repository in `owner/repo` form.""" + + source: PurpleSource """Constant value. Always "github".""" path: str | None = None + """Optional repository-relative path to the plugin.""" + ref: str | None = None + """Optional Git ref to resolve.""" + + sha: str | None = None + """Optional full 40-character hexadecimal commit SHA.""" @staticmethod def from_dict(obj: Any) -> 'InstalledPluginSourceGitHub': assert isinstance(obj, dict) repo = from_str(obj.get("repo")) - source = FluffySource(obj.get("source")) + 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")) - return InstalledPluginSourceGitHub(repo, source, path, ref) + sha = from_union([from_str, from_none], obj.get("sha")) + return InstalledPluginSourceGitHub(repo, source, path, ref, sha) def to_dict(self) -> dict: result: dict = {} result["repo"] = from_str(self.repo) - result["source"] = to_enum(FluffySource, self.source) + 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.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 SessionInstalledPluginSourceGitHub: - """Source descriptor for a direct GitHub plugin install, with `owner/repo`, optional ref, - and optional subpath. + """Source descriptor for a direct GitHub plugin install, with `owner/repo`, optional ref or + full commit SHA, and optional subpath. """ repo: str - source: FluffySource + """GitHub repository in `owner/repo` form.""" + + source: PurpleSource """Constant value. Always "github".""" path: str | None = None + """Optional repository-relative path to the plugin.""" + ref: str | None = None + """Optional Git ref to resolve.""" + + sha: str | None = None + """Optional full 40-character hexadecimal commit SHA.""" @staticmethod def from_dict(obj: Any) -> 'SessionInstalledPluginSourceGitHub': assert isinstance(obj, dict) repo = from_str(obj.get("repo")) - source = FluffySource(obj.get("source")) + 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")) - return SessionInstalledPluginSourceGitHub(repo, source, path, ref) + sha = from_union([from_str, from_none], obj.get("sha")) + return SessionInstalledPluginSourceGitHub(repo, source, path, ref, sha) def to_dict(self) -> dict: result: dict = {} result["repo"] = from_str(self.repo) - result["source"] = to_enum(FluffySource, self.source) + 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.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. @@ -12308,20 +17740,22 @@ class InstalledPluginSourceLocal: """Source descriptor for a direct local plugin install, with a local filesystem path.""" path: str - source: TentacledSource + """Local filesystem path to the plugin.""" + + source: FluffySource """Constant value. Always "local".""" @staticmethod def from_dict(obj: Any) -> 'InstalledPluginSourceLocal': assert isinstance(obj, dict) path = from_str(obj.get("path")) - source = TentacledSource(obj.get("source")) + source = FluffySource(obj.get("source")) return InstalledPluginSourceLocal(path, source) def to_dict(self) -> dict: result: dict = {} result["path"] = from_str(self.path) - result["source"] = to_enum(TentacledSource, self.source) + result["source"] = to_enum(FluffySource, self.source) return result # Experimental: this type is part of an experimental API and may change or be removed. @@ -12330,84 +17764,22 @@ class SessionInstalledPluginSourceLocal: """Source descriptor for a direct local plugin install, with a local filesystem path.""" path: str - source: TentacledSource + """Local filesystem path to the plugin.""" + + source: FluffySource """Constant value. Always "local".""" @staticmethod def from_dict(obj: Any) -> 'SessionInstalledPluginSourceLocal': assert isinstance(obj, dict) path = from_str(obj.get("path")) - source = TentacledSource(obj.get("source")) + source = FluffySource(obj.get("source")) return SessionInstalledPluginSourceLocal(path, source) def to_dict(self) -> dict: result: dict = {} 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 InstalledPluginSourceURL: - """Source descriptor for a direct URL plugin install, with URL, optional ref, and optional - subpath. - """ - source: StickySource - """Constant value. Always "url".""" - - url: str - path: str | None = None - ref: str | None = None - - @staticmethod - def from_dict(obj: Any) -> 'InstalledPluginSourceURL': - 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) - - 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) - return result - -# Experimental: this type is part of an experimental API and may change or be removed. -@dataclass -class SessionInstalledPluginSourceURL: - """Source descriptor for a direct URL plugin install, with URL, optional ref, and optional - subpath. - """ - source: StickySource - """Constant value. Always "url".""" - - url: str - path: str | None = None - ref: str | None = None - - @staticmethod - def from_dict(obj: Any) -> 'SessionInstalledPluginSourceURL': - 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) - - 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["source"] = to_enum(FluffySource, self.source) return result # Experimental: this type is part of an experimental API and may change or be removed. @@ -12446,9 +17818,8 @@ class InstructionSource: project_path: str | None = None """The project path this source was discovered from. Only set by sessionless discovery for - repository/working-directory sources, where it disambiguates same-named files (e.g. - .github/copilot-instructions.md) across multiple workspace roots. The session-scoped - getSources leaves it unset. + repository, working-directory, and project-scoped plugin sources, where it disambiguates + sources across multiple workspace roots. The session-scoped getSources leaves it unset. """ @staticmethod @@ -12489,6 +17860,8 @@ class LlmInferenceHTTPRequestStartRequest: """The head of an outbound model-layer HTTP request.""" headers: dict[str, list[str]] + """HTTP request headers, preserving multiple values per name.""" + method: str """HTTP method, e.g. GET, POST.""" @@ -12741,24 +18114,55 @@ def to_dict(self) -> dict: @dataclass class Workspace: id: str + """Stable workspace identifier.""" + branch: str | None = None + """Current Git branch.""" + chronicle_sync_dismissed: bool | None = None + """Whether the per-session Chronicle upgrade prompt was dismissed for the workspace.""" + client_name: str | None = None + """Name of the client that created the workspace.""" + created_at: datetime | None = None + """Timestamp when the workspace was created.""" + cwd: str | None = None + """Current working directory associated with the workspace.""" + git_root: str | None = None + """Git repository root associated with the workspace.""" + host_type: HostType | None = None """Allowed values for the `WorkspacesWorkspaceDetailsHostType` enumeration.""" mc_last_event_id: str | None = None + """Most recent Mission Control event identifier observed for the workspace.""" + mc_session_id: str | None = None + """Mission Control session identifier associated with the workspace.""" + mc_task_id: str | None = None + """Mission Control task identifier associated with the workspace.""" + name: str | None = None + """Workspace display name.""" + remote_steerable: bool | None = None + """Whether the workspace session can be steered remotely.""" + repository: str | None = None + """Repository identifier associated with the workspace.""" + summary_count: int | None = None + """Number of persisted summaries in the workspace.""" + updated_at: datetime | None = None + """Timestamp when the workspace was last updated.""" + user_named: bool | None = None + """Whether the workspace name was explicitly chosen by the user.""" @staticmethod def from_dict(obj: Any) -> 'Workspace': @@ -13039,408 +18443,106 @@ def to_dict(self) -> dict: 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 MCPAppsReadResourceResult: - """Resource contents returned by the MCP server.""" - - contents: list[MCPAppsResourceContent] - """Resource contents returned by the server""" - - @staticmethod - def from_dict(obj: Any) -> 'MCPAppsReadResourceResult': - assert isinstance(obj, dict) - contents = from_list(MCPAppsResourceContent.from_dict, obj.get("contents")) - return MCPAppsReadResourceResult(contents) - - def to_dict(self) -> dict: - result: dict = {} - 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 MCPServerConfigStdio: - """Stdio MCP server configuration launched as a child process.""" - - command: str - """Executable command used to start the Stdio MCP server process.""" - - args: list[str] | None = None - """Command-line arguments passed to the Stdio MCP server process.""" - - auth: bool | MCPServerAuthConfigRedirectPort | None = None - """Set to `true` to use defaults, or provide an object with additional auth or OIDC settings.""" - - 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) - """ - 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) -> 'MCPServerConfigStdio': - 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")) - defer_tools = from_union([MCPServerConfigDeferTools, from_none], obj.get("deferTools")) - 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, env, filter_mapping, is_default_server, oidc, timeout, tools) - - 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.defer_tools is not None: - result["deferTools"] = from_union([lambda x: to_enum(MCPServerConfigDeferTools, x), from_none], self.defer_tools) - 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 MCPOauthLoginRequest: - """Remote MCP server name and optional overrides controlling reauthentication, OAuth client - display name, callback success-page copy, and static OAuth client selection. - """ - 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) -> '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_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["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 MCPServerConfig: - """MCP server configuration (stdio process or remote HTTP/SSE) - - 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). - - Stdio MCP server configuration launched as a child process. - - Remote MCP server configuration accessed over HTTP or SSE. - """ - args: list[str] | None = None - """Command-line arguments passed to the Stdio MCP server process.""" - - auth: bool | MCPServerAuthConfigRedirectPort | None = None - """Set to `true` to use defaults, or provide an object with additional auth or OIDC settings.""" - - command: str | None = None - """Executable command used to start the Stdio MCP server process.""" - - 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) - """ - 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.""" - - headers: dict[str, str] | None = None - """HTTP headers to include in requests to the remote MCP server.""" - - oauth_client_id: str | None = None - """OAuth client ID for a pre-registered remote MCP OAuth client.""" - - oauth_grant_type: MCPGrantType | 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.""" - - type: MCPServerConfigHTTPType | None = None - """Remote transport type. Defaults to "http" when omitted.""" - - url: str | None = None - """URL of the remote MCP server endpoint.""" - - @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")) - 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, env, filter_mapping, is_default_server, oidc, timeout, tools, headers, oauth_client_id, oauth_grant_type, oauth_public_client, type, url) - - 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.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 - -# 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.""" - - 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.""" - - 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) - """ - 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. - """ - oauth_client_id: str | None = None - """OAuth client ID for a pre-registered remote MCP OAuth client.""" + 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 - oauth_grant_type: MCPGrantType | None = None - """OAuth grant type to use when authenticating to the remote MCP server.""" +# 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.""" - oauth_public_client: bool | None = None - """Whether the configured OAuth client is public and does not require a client secret.""" + contents: list[MCPAppsResourceContent] + """Resource contents returned by the 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) -> 'MCPAppsReadResourceResult': + assert isinstance(obj, dict) + contents = from_list(MCPAppsResourceContent.from_dict, obj.get("contents")) + return MCPAppsReadResourceResult(contents) - timeout: int | None = None - """Timeout in milliseconds for tool calls to this server.""" + def to_dict(self) -> dict: + result: dict = {} + result["contents"] = from_list(lambda x: to_class(MCPAppsResourceContent, x), self.contents) + 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 MCPOauthLoginRequest: + """Remote MCP server name and optional overrides controlling reauthentication, OAuth client + display name, callback success-page copy, and static OAuth client selection. + """ + server_name: str + """Name of the remote MCP server to authenticate""" - type: MCPServerConfigHTTPType | None = None - """Remote transport type. Defaults to "http" when omitted.""" + 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) -> 'MCPServerConfigHTTP': + def from_dict(obj: Any) -> 'MCPOauthLoginRequest': assert isinstance(obj, dict) - 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")) - 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, filter_mapping, headers, is_default_server, oauth_client_id, oauth_grant_type, oauth_public_client, oidc, timeout, tools, type) + 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["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.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) + 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. @@ -13454,18 +18556,24 @@ class MCPStartServersResult: allowed_servers: list[MCPAllowedServer] | None = None """Non-default servers allowed by policy""" + failed_servers: list[MCPFailedServer] | None = None + """Servers whose connection attempt failed.""" + @staticmethod def from_dict(obj: Any) -> 'MCPStartServersResult': assert isinstance(obj, dict) 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) + failed_servers = from_union([lambda x: from_list(MCPFailedServer.from_dict, x), from_none], obj.get("failedServers")) + return MCPStartServersResult(filtered_servers, allowed_servers, failed_servers) def to_dict(self) -> dict: result: dict = {} 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) + if self.failed_servers is not None: + result["failedServers"] = from_union([lambda x: from_list(lambda x: to_class(MCPFailedServer, x), x), from_none], self.failed_servers) return result # Experimental: this type is part of an experimental API and may change or be removed. @@ -13474,6 +18582,8 @@ class MCPHeadersHandlePendingHeadersRefreshRequest: """Host response: supply dynamic headers or decline this refresh.""" kind: MCPHeadersHandlePendingHeadersRefreshRequestKind + """Headers-refresh response variant discriminator.""" + 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. @@ -13508,7 +18618,7 @@ class MCPHostState: """Map of server name to recorded connection failure.""" filtered_servers: list[str] - """Configured servers filtered out by enterprise allowlist policy.""" + """Configured servers filtered out by MCP server policy.""" mcp3_p_enabled: bool """Whether third-party MCP servers are policy-enabled for this session.""" @@ -13544,37 +18654,422 @@ def to_dict(self) -> dict: # Experimental: this type is part of an experimental API and may change or be removed. @dataclass -class MCPOauthPendingRequestResponse: - """Host response to the pending OAuth request.""" +class MCPPlanConfigurationChange: + """One change applying the plan would make, described rather than serialised so the + configuration payload stays behind the runtime boundary. + """ + changed_fields: list[str] + """Names of the configuration fields the change would set, without their values.""" - kind: MCPOauthPendingRequestResponseKind - access_token: str | None = None - """Access token acquired by the SDK host""" + config_key: str + """Configuration key the change applies to.""" - expires_in: int | None = None - """Token lifetime in seconds, if known.""" + operation: MCPPlanConfigurationOperation + """Whether the change would create a new entry or modify an existing one.""" - token_type: str | None = None - """OAuth token type. Defaults to Bearer when omitted.""" + scope: MCPPlanScope + """Scope the change would be written to.""" + + secret_references: list[str] + """Secret placeholders the written configuration would reference. The constrained + placeholder type cannot carry a literal secret value. + """ @staticmethod - def from_dict(obj: Any) -> 'MCPOauthPendingRequestResponse': + def from_dict(obj: Any) -> 'MCPPlanConfigurationChange': 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) + changed_fields = from_list(from_str, obj.get("changedFields")) + config_key = from_str(obj.get("configKey")) + operation = MCPPlanConfigurationOperation(obj.get("operation")) + scope = MCPPlanScope(obj.get("scope")) + secret_references = from_list(from_str, obj.get("secretReferences")) + return MCPPlanConfigurationChange(changed_fields, config_key, operation, scope, secret_references) 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) + result["changedFields"] = from_list(from_str, self.changed_fields) + result["configKey"] = from_str(self.config_key) + result["operation"] = to_enum(MCPPlanConfigurationOperation, self.operation) + result["scope"] = to_enum(MCPPlanScope, self.scope) + result["secretReferences"] = from_list(from_str, self.secret_references) + return result + +# Experimental: this type is part of an experimental API and may change or be removed. +@dataclass +class MCPPlanTarget: + """Configuration scope and key the plan would write to. + + Where a plan would be written. + """ + config_key: str + """Configuration key the server would be recorded under within that scope.""" + + scope: MCPPlanScope + """Configuration scope the plan targets.""" + + @staticmethod + def from_dict(obj: Any) -> 'MCPPlanTarget': + assert isinstance(obj, dict) + config_key = from_str(obj.get("configKey")) + scope = MCPPlanScope(obj.get("scope")) + return MCPPlanTarget(config_key, scope) + + def to_dict(self) -> dict: + result: dict = {} + result["configKey"] = from_str(self.config_key) + result["scope"] = to_enum(MCPPlanScope, self.scope) + return result + +# Experimental: this type is part of an experimental API and may change or be removed. +@dataclass +class MCPPlanInstallRequest: + """A side-effect-free request for an MCP install plan. Computing a plan never writes + configuration, stores a secret, or reloads MCP servers. + """ + contract: CatalogClientContract + """Protocol version and capabilities the caller requires.""" + + source: MCPPlanInstallSource + """What to plan: either a candidate handle from a previous search, or a card supplied + directly. + """ + scope: MCPPlanScope | None = None + """Configuration scope the plan targets. Defaults to user scope when omitted.""" + + @staticmethod + def from_dict(obj: Any) -> 'MCPPlanInstallRequest': + assert isinstance(obj, dict) + contract = CatalogClientContract.from_dict(obj.get("contract")) + source = _load_MCPPlanInstallSource(obj.get("source")) + scope = from_union([MCPPlanScope, from_none], obj.get("scope")) + return MCPPlanInstallRequest(contract, source, scope) + + def to_dict(self) -> dict: + result: dict = {} + result["contract"] = to_class(CatalogClientContract, self.contract) + result["source"] = (self.source).to_dict() + if self.scope is not None: + result["scope"] = from_union([lambda x: to_enum(MCPPlanScope, x), from_none], self.scope) + return result + +# Experimental: this type is part of an experimental API and may change or be removed. +@dataclass +class MCPPlanPolicyResult: + """Outcome of evaluating the server against registry and enterprise policy. + + Outcome of evaluating the planned server against registry and enterprise policy. + Evaluation is read-only. + """ + decision: MCPPlanPolicyDecision + """What policy decided for this server.""" + + source: MCPPlanPolicySource + """Which authority produced the decision.""" + + reason: str | None = None + """Human-readable explanation, safe to surface. Never contains a query, URL, handle, or + secret. + """ + + @staticmethod + def from_dict(obj: Any) -> 'MCPPlanPolicyResult': + assert isinstance(obj, dict) + decision = MCPPlanPolicyDecision(obj.get("decision")) + source = MCPPlanPolicySource(obj.get("source")) + reason = from_union([from_str, from_none], obj.get("reason")) + return MCPPlanPolicyResult(decision, source, reason) + + def to_dict(self) -> dict: + result: dict = {} + result["decision"] = to_enum(MCPPlanPolicyDecision, self.decision) + result["source"] = to_enum(MCPPlanPolicySource, self.source) + 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 MCPPlanRequiredValueEnum: + """One enumerated non-secret value a transport choice needs before it can be applied. The + permitted values are structurally required. + """ + category: MCPPlanValueCategory + """Where the value is applied when the server is launched.""" + + enum_values: list[str] + """Non-empty permitted value set. Inert untrusted data.""" + + is_repeated: bool + """Whether the value may be supplied more than once.""" + + key: str + """Key the value is supplied under. Inert untrusted data.""" + + kind: ClassVar[str] = "enum" + """Discriminator: this required value uses a fixed enumeration.""" + + required: bool + """Whether the value must be present for the plan to be applicable.""" + + value_type: MCPPlan + """Discriminator: the value must be one of `enumValues`.""" + + default_value: str | None = None + """Default supplied by the card, when the value can be resolved without input. Presence is + the authoritative indication that a default exists. Inert untrusted data. + """ + description: str | None = None + """Human-readable explanation from the card. Inert untrusted text.""" + + title: str | None = None + """Human-readable label from the card. Inert untrusted text.""" + + @staticmethod + def from_dict(obj: Any) -> 'MCPPlanRequiredValueEnum': + assert isinstance(obj, dict) + category = MCPPlanValueCategory(obj.get("category")) + enum_values = from_list(from_str, obj.get("enumValues")) + is_repeated = from_bool(obj.get("isRepeated")) + key = from_str(obj.get("key")) + required = from_bool(obj.get("required")) + value_type = MCPPlan(obj.get("valueType")) + default_value = from_union([from_str, from_none], obj.get("defaultValue")) + description = from_union([from_str, from_none], obj.get("description")) + title = from_union([from_str, from_none], obj.get("title")) + return MCPPlanRequiredValueEnum(category, enum_values, is_repeated, key, required, value_type, default_value, description, title) + + def to_dict(self) -> dict: + result: dict = {} + result["category"] = to_enum(MCPPlanValueCategory, self.category) + result["enumValues"] = from_list(from_str, self.enum_values) + result["isRepeated"] = from_bool(self.is_repeated) + result["key"] = from_str(self.key) + result["kind"] = self.kind + result["required"] = from_bool(self.required) + result["valueType"] = to_enum(MCPPlan, self.value_type) + if self.default_value is not None: + result["defaultValue"] = from_union([from_str, from_none], self.default_value) + 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 MCPPlanInstallSourceCandidate: + """Plan from a candidate returned by a previous catalog search.""" + + candidate_handle: str + """Single-use candidate handle. Consumed by this call, so a replay of the same handle is + rejected. + """ + kind: ClassVar[str] = "candidate" + """Discriminator: plan from a previously returned candidate""" + + search_id: str + """The runtime- or authority-minted `searchId` returned with the search that produced this + candidate. A search implementation binds it to private candidate-handle context; a + planning implementation must verify that context before returning a plan. The unavailable + planning implementation in this contract layer validates presence but does not claim the + verification has occurred. It identifies a search rather than a person and must never be + joined with user identity to re-identify anyone. + """ + + @staticmethod + def from_dict(obj: Any) -> 'MCPPlanInstallSourceCandidate': + assert isinstance(obj, dict) + candidate_handle = from_str(obj.get("candidateHandle")) + search_id = from_str(obj.get("searchId")) + return MCPPlanInstallSourceCandidate(candidate_handle, search_id) + + def to_dict(self) -> dict: + result: dict = {} + result["candidateHandle"] = from_str(self.candidate_handle) + result["kind"] = self.kind + result["searchId"] = from_str(self.search_id) + return result + +# Experimental: this type is part of an experimental API and may change or be removed. +@dataclass +class MCPPlanInstallSourceCard: + """Plan from a card supplied directly by the caller, without a preceding search.""" + + card: MCPServerCardReference + """The card to plan from: exactly one of a URL or embedded data.""" + + kind: ClassVar[str] = "card" + """Discriminator: plan from a caller-supplied card""" + + @staticmethod + def from_dict(obj: Any) -> 'MCPPlanInstallSourceCard': + assert isinstance(obj, dict) + card = _load_MCPServerCardReference(obj.get("card")) + return MCPPlanInstallSourceCard(card) + + def to_dict(self) -> dict: + result: dict = {} + result["card"] = (self.card).to_dict() + result["kind"] = self.kind + return result + +# Experimental: this type is part of an experimental API and may change or be removed. +@dataclass +class MCPPlanTransportChoicePackage: + """An eligible local-package transport choice. Package identity is required and a remote + endpoint cannot be represented. + """ + choice_id: str + """Stable identifier for this choice within the plan, used to select it when the plan is + applied. + """ + install_method: MCPPlanPackageInstallMethod + """Discriminator: this choice runs a local package""" + + package_identifier: str + """Package identifier. Inert untrusted data.""" + + package_type: str + """Packaging ecosystem, for example `oci` or `npm`.""" + + required_values: list[MCPPlanRequiredValue] + """Typed values this choice requires, excluding secrets.""" + + secret_placeholders: list[MCPPlanSecretPlaceholder] + """Secrets this choice requires, referenced by placeholder only.""" + + transport: MCPPlanPackageTransport + """Local process transport this package choice would use.""" + + @staticmethod + def from_dict(obj: Any) -> 'MCPPlanTransportChoicePackage': + assert isinstance(obj, dict) + choice_id = from_str(obj.get("choiceId")) + install_method = MCPPlanPackageInstallMethod(obj.get("installMethod")) + package_identifier = from_str(obj.get("packageIdentifier")) + package_type = from_str(obj.get("packageType")) + required_values = from_list(_load_MCPPlanRequiredValue, obj.get("requiredValues")) + secret_placeholders = from_list(MCPPlanSecretPlaceholder.from_dict, obj.get("secretPlaceholders")) + transport = MCPPlanPackageTransport(obj.get("transport")) + return MCPPlanTransportChoicePackage(choice_id, install_method, package_identifier, package_type, required_values, secret_placeholders, transport) + + def to_dict(self) -> dict: + result: dict = {} + result["choiceId"] = from_str(self.choice_id) + result["installMethod"] = to_enum(MCPPlanPackageInstallMethod, self.install_method) + result["packageIdentifier"] = from_str(self.package_identifier) + result["packageType"] = from_str(self.package_type) + result["requiredValues"] = from_list(lambda x: (x).to_dict(), self.required_values) + result["secretPlaceholders"] = from_list(lambda x: to_class(MCPPlanSecretPlaceholder, x), self.secret_placeholders) + result["transport"] = to_enum(MCPPlanPackageTransport, self.transport) + return result + +# Experimental: this type is part of an experimental API and may change or be removed. +@dataclass +class MCPPlanTransportChoiceRemote: + """An eligible remote-endpoint transport choice. The endpoint is required and package + identity cannot be represented. + """ + choice_id: str + """Stable identifier for this choice within the plan, used to select it when the plan is + applied. + """ + endpoint: str + """Endpoint URL. Inert untrusted data.""" + + install_method: MCPPlanRemoteInstallMethod + """Discriminator: this choice connects to a remote endpoint""" + + required_values: list[MCPPlanRequiredValue] + """Typed values this choice requires, excluding secrets.""" + + secret_placeholders: list[MCPPlanSecretPlaceholder] + """Secrets this choice requires, referenced by placeholder only.""" + + transport: MCPPlanRemoteTransport + """Endpoint transport this remote choice would use.""" + + @staticmethod + def from_dict(obj: Any) -> 'MCPPlanTransportChoiceRemote': + assert isinstance(obj, dict) + choice_id = from_str(obj.get("choiceId")) + endpoint = from_str(obj.get("endpoint")) + install_method = MCPPlanRemoteInstallMethod(obj.get("installMethod")) + required_values = from_list(_load_MCPPlanRequiredValue, obj.get("requiredValues")) + secret_placeholders = from_list(MCPPlanSecretPlaceholder.from_dict, obj.get("secretPlaceholders")) + transport = MCPPlanRemoteTransport(obj.get("transport")) + return MCPPlanTransportChoiceRemote(choice_id, endpoint, install_method, required_values, secret_placeholders, transport) + + def to_dict(self) -> dict: + result: dict = {} + result["choiceId"] = from_str(self.choice_id) + result["endpoint"] = from_str(self.endpoint) + result["installMethod"] = to_enum(MCPPlanRemoteInstallMethod, self.install_method) + result["requiredValues"] = from_list(lambda x: (x).to_dict(), self.required_values) + result["secretPlaceholders"] = from_list(lambda x: to_class(MCPPlanSecretPlaceholder, x), self.secret_placeholders) + result["transport"] = to_enum(MCPPlanRemoteTransport, self.transport) + return result + +# Experimental: this type is part of an experimental API and may change or be removed. +@dataclass +class MCPPlanRequiredValueScalar: + """One non-secret scalar value a transport choice needs before it can be applied.""" + + category: MCPPlanValueCategory + """Where the value is applied when the server is launched.""" + + is_repeated: bool + """Whether the value may be supplied more than once.""" + + key: str + """Key the value is supplied under. Inert untrusted data.""" + + kind: ClassVar[str] = "scalar" + """Discriminator: this required value uses a scalar type.""" + + required: bool + """Whether the value must be present for the plan to be applicable.""" + + value_type: MCPPlanScalarValueTypeEnum + """Scalar type the value must conform to.""" + + default_value: str | None = None + """Default supplied by the card, when the value can be resolved without input. Presence is + the authoritative indication that a default exists. Inert untrusted data. + """ + description: str | None = None + """Human-readable explanation from the card. Inert untrusted text.""" + + title: str | None = None + """Human-readable label from the card. Inert untrusted text.""" + + @staticmethod + def from_dict(obj: Any) -> 'MCPPlanRequiredValueScalar': + assert isinstance(obj, dict) + category = MCPPlanValueCategory(obj.get("category")) + is_repeated = from_bool(obj.get("isRepeated")) + key = from_str(obj.get("key")) + required = from_bool(obj.get("required")) + value_type = MCPPlanScalarValueTypeEnum(obj.get("valueType")) + default_value = from_union([from_str, from_none], obj.get("defaultValue")) + description = from_union([from_str, from_none], obj.get("description")) + title = from_union([from_str, from_none], obj.get("title")) + return MCPPlanRequiredValueScalar(category, is_repeated, key, required, value_type, default_value, description, title) + + def to_dict(self) -> dict: + result: dict = {} + result["category"] = to_enum(MCPPlanValueCategory, self.category) + result["isRepeated"] = from_bool(self.is_repeated) + result["key"] = from_str(self.key) + result["kind"] = self.kind + result["required"] = from_bool(self.required) + result["valueType"] = to_enum(MCPPlanScalarValueTypeEnum, self.value_type) + if self.default_value is not None: + result["defaultValue"] = from_union([from_str, from_none], self.default_value) + 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. @@ -13632,6 +19127,60 @@ def to_dict(self) -> dict: 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 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 MCPSetEnvValueModeParams: @@ -13694,13 +19243,47 @@ class SessionContextAttribution: """Per-source token attribution snapshot for the current context window. The heaviest individual messages are available separately via `metadata.getContextHeaviestMessages`. """ + buffer_tokens: int + """Output reserve plus the tokens past the buffer-exhaustion blocking threshold. Mirrors + `SessionContextInfo.bufferTokens`. + """ + 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.""" + compaction_threshold: int + """Token count at which background compaction starts. Mirrors + `SessionContextInfo.compactionThreshold`. + """ 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`. """ + 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`. + """ + 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. + """ + 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 @@ -13710,15 +19293,29 @@ class SessionContextAttribution: @staticmethod def from_dict(obj: Any) -> 'SessionContextAttribution': assert isinstance(obj, dict) + 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(compactions, entries, total_tokens) + 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["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 @@ -13785,6 +19382,242 @@ def to_dict(self) -> dict: 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 ModeSetRequest: + """Agent interaction mode to apply to the session.""" + + mode: SessionMode + """The session mode the agent is operating in""" + + compaction_decision: str | None = None + """Explicit response to a model-switch compaction preflight.""" + + inherit_plan_base_from_session_id: str | None = None + """Session whose plan-mode base state should be inherited.""" + + persist_plan_selection: bool | None = None + """Whether the selected plan model should be persisted.""" + + picker_settings_context: ModelPickerSettingsContext | None = None + """Settings context used when persisting the selected plan model.""" + + plan_context_tier: str | None = None + """Context tier to use with the dedicated plan model.""" + + plan_exit_action: str | None = None + """Action to perform when leaving plan mode.""" + + plan_model: str | None = None + """Dedicated model to use in plan mode, when configured.""" + + plan_model_configured: bool | None = None + """Whether a dedicated plan model is configured.""" + + plan_reasoning_effort: str | None = None + """Reasoning effort to use with the dedicated plan model.""" + + restore_plan_model: bool | None = None + """Whether leaving plan mode should restore the session's previous model.""" + + @staticmethod + def from_dict(obj: Any) -> 'ModeSetRequest': + assert isinstance(obj, dict) + mode = SessionMode(obj.get("mode")) + compaction_decision = from_union([from_str, from_none], obj.get("compactionDecision")) + inherit_plan_base_from_session_id = from_union([from_str, from_none], obj.get("inheritPlanBaseFromSessionId")) + persist_plan_selection = from_union([from_bool, from_none], obj.get("persistPlanSelection")) + picker_settings_context = from_union([ModelPickerSettingsContext.from_dict, from_none], obj.get("pickerSettingsContext")) + plan_context_tier = from_union([from_str, from_none], obj.get("planContextTier")) + plan_exit_action = from_union([from_str, from_none], obj.get("planExitAction")) + plan_model = from_union([from_str, from_none], obj.get("planModel")) + plan_model_configured = from_union([from_bool, from_none], obj.get("planModelConfigured")) + plan_reasoning_effort = from_union([from_str, from_none], obj.get("planReasoningEffort")) + restore_plan_model = from_union([from_bool, from_none], obj.get("restorePlanModel")) + return ModeSetRequest(mode, compaction_decision, inherit_plan_base_from_session_id, persist_plan_selection, picker_settings_context, plan_context_tier, plan_exit_action, plan_model, plan_model_configured, plan_reasoning_effort, restore_plan_model) + + def to_dict(self) -> dict: + result: dict = {} + result["mode"] = to_enum(SessionMode, self.mode) + if self.compaction_decision is not None: + result["compactionDecision"] = from_union([from_str, from_none], self.compaction_decision) + if self.inherit_plan_base_from_session_id is not None: + result["inheritPlanBaseFromSessionId"] = from_union([from_str, from_none], self.inherit_plan_base_from_session_id) + if self.persist_plan_selection is not None: + result["persistPlanSelection"] = from_union([from_bool, from_none], self.persist_plan_selection) + if self.picker_settings_context is not None: + result["pickerSettingsContext"] = from_union([lambda x: to_class(ModelPickerSettingsContext, x), from_none], self.picker_settings_context) + if self.plan_context_tier is not None: + result["planContextTier"] = from_union([from_str, from_none], self.plan_context_tier) + if self.plan_exit_action is not None: + result["planExitAction"] = from_union([from_str, from_none], self.plan_exit_action) + if self.plan_model is not None: + result["planModel"] = from_union([from_str, from_none], self.plan_model) + if self.plan_model_configured is not None: + result["planModelConfigured"] = from_union([from_bool, from_none], self.plan_model_configured) + if self.plan_reasoning_effort is not None: + result["planReasoningEffort"] = from_union([from_str, from_none], self.plan_reasoning_effort) + if self.restore_plan_model is not None: + result["restorePlanModel"] = from_union([from_bool, from_none], self.restore_plan_model) + return result + +# Experimental: this type is part of an experimental API and may change or be removed. +@dataclass +class ModelPickerPersistenceRequest: + """Optional settings context and explicit-override flags used to persist a picker selection.""" + + settings_context: ModelPickerSettingsContext + """Filesystem and environment context used to resolve settings persistence.""" + + context_tier_explicit: bool | None = None + """Whether context tier was explicitly selected and should be persisted.""" + + reasoning_effort_explicit: bool | None = None + """Whether reasoning effort was explicitly selected and should be persisted.""" + + @staticmethod + def from_dict(obj: Any) -> 'ModelPickerPersistenceRequest': + assert isinstance(obj, dict) + settings_context = ModelPickerSettingsContext.from_dict(obj.get("settingsContext")) + context_tier_explicit = from_union([from_bool, from_none], obj.get("contextTierExplicit")) + reasoning_effort_explicit = from_union([from_bool, from_none], obj.get("reasoningEffortExplicit")) + return ModelPickerPersistenceRequest(settings_context, context_tier_explicit, reasoning_effort_explicit) + + def to_dict(self) -> dict: + result: dict = {} + result["settingsContext"] = to_class(ModelPickerSettingsContext, self.settings_context) + if self.context_tier_explicit is not None: + result["contextTierExplicit"] = from_union([from_bool, from_none], self.context_tier_explicit) + if self.reasoning_effort_explicit is not None: + result["reasoningEffortExplicit"] = from_union([from_bool, from_none], self.reasoning_effort_explicit) + return result + +# Experimental: this type is part of an experimental API and may change or be removed. +@dataclass +class ModeSetResult: + """Outcome of a session mode change, including any model switch it triggered and follow-up + the host must perform. + """ + model_changed: bool + """Whether applying the mode changed the active model.""" + + status: str + """Lifecycle status of the requested mode change.""" + + arm_interactive_continuation: bool | None = None + """Whether the host should arm an interactive continuation after the mode change.""" + + confirmation: ModelSwitchConfirmation | None = None + """Compaction confirmation required before the mode change can complete.""" + + defer_implementation: bool | None = None + """Whether the host must defer implementing the requested mode change.""" + + deprecation_warnings: list[str] | None = None + """Deprecation warnings associated with the model selected by the mode change.""" + + message: str | None = None + """User-facing outcome message for the model switch triggered by the mode change.""" + + warning: str | None = None + """User-facing warning produced while applying the mode change.""" + + @staticmethod + def from_dict(obj: Any) -> 'ModeSetResult': + assert isinstance(obj, dict) + model_changed = from_bool(obj.get("modelChanged")) + status = from_str(obj.get("status")) + arm_interactive_continuation = from_union([from_bool, from_none], obj.get("armInteractiveContinuation")) + confirmation = from_union([ModelSwitchConfirmation.from_dict, from_none], obj.get("confirmation")) + defer_implementation = from_union([from_bool, from_none], obj.get("deferImplementation")) + deprecation_warnings = from_union([lambda x: from_list(from_str, x), from_none], obj.get("deprecationWarnings")) + message = from_union([from_str, from_none], obj.get("message")) + warning = from_union([from_str, from_none], obj.get("warning")) + return ModeSetResult(model_changed, status, arm_interactive_continuation, confirmation, defer_implementation, deprecation_warnings, message, warning) + + def to_dict(self) -> dict: + result: dict = {} + result["modelChanged"] = from_bool(self.model_changed) + result["status"] = from_str(self.status) + if self.arm_interactive_continuation is not None: + result["armInteractiveContinuation"] = from_union([from_bool, from_none], self.arm_interactive_continuation) + if self.confirmation is not None: + result["confirmation"] = from_union([lambda x: to_class(ModelSwitchConfirmation, x), from_none], self.confirmation) + if self.defer_implementation is not None: + result["deferImplementation"] = from_union([from_bool, from_none], self.defer_implementation) + if self.deprecation_warnings is not None: + result["deprecationWarnings"] = from_union([lambda x: from_list(from_str, x), from_none], self.deprecation_warnings) + if self.message is not None: + result["message"] = from_union([from_str, from_none], self.message) + if self.warning is not None: + result["warning"] = from_union([from_str, from_none], self.warning) + 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.""" + + confirmation: ModelSwitchConfirmation | None = None + """Compaction confirmation projection when status is confirmation_required""" + + 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. + """ + deprecation_warnings: list[str] | None = None + """Deprecation warnings associated with the selected model or options.""" + + message: str | None = None + """User-facing outcome message for the model switch.""" + + model_id: str | None = None + """Currently active model identifier after the switch""" + + persistence_error: str | None = None + """Persistence failure encountered after applying the model switch.""" + + status: str | None = None + """Lifecycle result for the requested switch""" + + warning: str | None = None + """User-facing warning produced while applying the model switch.""" + + @staticmethod + def from_dict(obj: Any) -> 'ModelSwitchToResult': + assert isinstance(obj, dict) + confirmation = from_union([ModelSwitchConfirmation.from_dict, from_none], obj.get("confirmation")) + deferred = from_union([from_bool, from_none], obj.get("deferred")) + deprecation_warnings = from_union([lambda x: from_list(from_str, x), from_none], obj.get("deprecationWarnings")) + message = from_union([from_str, from_none], obj.get("message")) + model_id = from_union([from_str, from_none], obj.get("modelId")) + persistence_error = from_union([from_str, from_none], obj.get("persistenceError")) + status = from_union([from_str, from_none], obj.get("status")) + warning = from_union([from_str, from_none], obj.get("warning")) + return ModelSwitchToResult(confirmation, deferred, deprecation_warnings, message, model_id, persistence_error, status, warning) + + def to_dict(self) -> dict: + result: dict = {} + if self.confirmation is not None: + result["confirmation"] = from_union([lambda x: to_class(ModelSwitchConfirmation, x), from_none], self.confirmation) + if self.deferred is not None: + result["deferred"] = from_union([from_bool, from_none], self.deferred) + if self.deprecation_warnings is not None: + result["deprecationWarnings"] = from_union([lambda x: from_list(from_str, x), from_none], self.deprecation_warnings) + if self.message is not None: + result["message"] = from_union([from_str, from_none], self.message) + if self.model_id is not None: + result["modelId"] = from_union([from_str, from_none], self.model_id) + if self.persistence_error is not None: + result["persistenceError"] = from_union([from_str, from_none], self.persistence_error) + if self.status is not None: + result["status"] = from_union([from_str, from_none], self.status) + if self.warning is not None: + result["warning"] = from_union([from_str, from_none], self.warning) + return result + # Experimental: this type is part of an experimental API and may change or be removed. @dataclass class ModelBillingTokenPrices: @@ -13799,6 +19632,9 @@ class ModelBillingTokenPrices: cache_read_price: float | None = None """AI Credits cost per billing batch of cached (read) tokens""" + cache_write1_h_price: float | None = None + """AI Credits cost per billing batch of 1-hour cache-write (cache creation) tokens.""" + cache_write_price: float | None = None """AI Credits cost per billing batch of cache-write (cache creation) tokens.""" @@ -13825,13 +19661,14 @@ def from_dict(obj: Any) -> 'ModelBillingTokenPrices': 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_write1_h_price = from_union([from_float, from_none], obj.get("cacheWrite1hPrice")) 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) + return ModelBillingTokenPrices(batch_size, cache_price, cache_read_price, cache_write1_h_price, cache_write_price, context_max, input_price, long_context, max_prompt_tokens, output_price) def to_dict(self) -> dict: result: dict = {} @@ -13841,6 +19678,8 @@ def to_dict(self) -> dict: 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_write1_h_price is not None: + result["cacheWrite1hPrice"] = from_union([to_float, from_none], self.cache_write1_h_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: @@ -13899,7 +19738,10 @@ class SessionModelPriceCategory: """Cost-category metadata for a CAPI model.""" id: str + """CAPI model identifier.""" + price_category: ModelPickerPriceCategory + """Cost category assigned to the model.""" @staticmethod def from_dict(obj: Any) -> 'SessionModelPriceCategory': @@ -13980,47 +19822,38 @@ def to_dict(self) -> dict: # 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).""" - + """External SDK input for a named custom model provider. Ingested by the native protocol + boundary before host dispatch. + """ base_url: str - """API endpoint URL.""" + """Base URL for provider API requests.""" name: str - """Stable identifier referenced by BYOK model definitions. Must not contain '/'.""" + """Unique provider name used to qualify model selection IDs.""" api_key: str | None = None - """API key. Optional for local providers like Ollama.""" + """Static API key used to authenticate provider requests.""" azure: ProviderConfigAzure | None = None - """Azure-specific provider options.""" + """Azure authentication configuration for the provider.""" bearer_token: str | None = None - """Bearer token for authentication. Sets the Authorization header directly. Takes precedence - over apiKey when both are set. - """ + """Static bearer token used to authenticate provider requests.""" + 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. - """ + """Whether the host supplies bearer tokens dynamically.""" + headers: dict[str, str] | None = None - """Custom HTTP headers to include in all outbound requests to the provider.""" + """Additional HTTP headers included with provider requests.""" transport: ProviderTransport | None = None - """Provider transport. Defaults to "http".""" + """Transport used to communicate with the provider.""" type: ProviderType | None = None - """Provider type. Defaults to "openai" for generic OpenAI-compatible APIs.""" + """Provider protocol family.""" wire_api: ProviderWireAPI | None = None - """Wire API format (openai/azure only). Defaults to "completions".""" + """Wire API used to communicate with the provider.""" @staticmethod def from_dict(obj: Any) -> 'NamedProviderConfig': @@ -14059,116 +19892,6 @@ def to_dict(self) -> dict: 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: @@ -14176,12 +19899,17 @@ class OptionsUpdateAdditionalContentExclusionPolicyRule: conditions, and source. """ paths: list[str] + """Path patterns covered by this rule.""" + source: OptionsUpdateAdditionalContentExclusionPolicyRuleSource """Source descriptor for a `session.options.update` content-exclusion rule, with source name and type. """ if_any_match: list[str] | None = None + """Conditions of which at least one must match.""" + if_none_match: list[str] | None = None + """Conditions none of which may match.""" @staticmethod def from_dict(obj: Any) -> 'OptionsUpdateAdditionalContentExclusionPolicyRule': @@ -14473,6 +20201,84 @@ def to_dict(self) -> dict: 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: @@ -14629,60 +20435,6 @@ def to_dict(self) -> dict: 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: @@ -14830,14 +20582,20 @@ class PermissionDecisionApproveOnce: 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) - return PermissionDecisionApproveOnce() + 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. @@ -14959,6 +20717,47 @@ def to_dict(self) -> dict: 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.""" + + response_capability: PermissionResponseCapability | None = None + """Whether the responding client could ask a user interactively, was running headlessly, or + had no response path. Omit when the client cannot determine this authoritatively. + """ + + @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")) + response_capability = from_union([PermissionResponseCapability, from_none], obj.get("responseCapability")) + return PermissionDecisionContext(outcome, source, surface, response_capability) + + 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) + if self.response_capability is not None: + result["responseCapability"] = from_union([lambda x: to_enum(PermissionResponseCapability, x), from_none], self.response_capability) + return result + # Experimental: this type is part of an experimental API and may change or be removed. @dataclass class PermissionDecisionDeniedByContentExclusionPolicy: @@ -15211,12 +21010,17 @@ class PermissionsConfigureAdditionalContentExclusionPolicyRule: match conditions, and source. """ paths: list[str] + """Path patterns covered by this rule.""" + source: PermissionsConfigureAdditionalContentExclusionPolicyRuleSource """Source descriptor for a `session.permissions.configure` content-exclusion rule, with source name and type. """ if_any_match: list[str] | None = None + """Conditions of which at least one must match.""" + if_none_match: list[str] | None = None + """Conditions none of which may match.""" @staticmethod def from_dict(obj: Any) -> 'PermissionsConfigureAdditionalContentExclusionPolicyRule': @@ -15284,7 +21088,9 @@ 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.""" + """Rows from the session SQL todos table, ordered by creation time with insertion order used + to break ties when available and id used for WITHOUT ROWID tables. + """ @staticmethod def from_dict(obj: Any) -> 'PlanReadSQLTodosResult': @@ -15308,7 +21114,8 @@ class PlanReadSQLTodosWithDependenciesResult: 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 + """Rows from the session SQL todos table, ordered by creation time with insertion order used + to break ties when available and id used for WITHOUT ROWID tables. Empty when no database, no todos table, or the SELECT failed. """ @@ -15325,6 +21132,30 @@ def to_dict(self) -> 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 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: @@ -15395,6 +21226,14 @@ class InstalledPluginInfo: for direct repo / URL / local installs; absent for marketplace plugins. Same source yields the same id; distinct sources never collide. """ + installed_from: str | None = None + """Absolute path of the marketplace directory a live plugin was resolved from. Present only + on live, never-persisted records β€” a plugin belonging to a directory/local marketplace, + which is loaded from its real directory on every pass instead of a copy under the + installed-plugins cache. Its presence is what marks a listed plugin as live: such a + plugin is always present on disk, so `enabled` is its only meaningful state and it is + never "not installed". + """ version: str | None = None """Installed version (when reported by the plugin manifest)""" @@ -15405,8 +21244,9 @@ def from_dict(obj: Any) -> 'InstalledPluginInfo': marketplace = from_str(obj.get("marketplace")) name = from_str(obj.get("name")) direct_source_id = from_union([from_str, from_none], obj.get("directSourceId")) + installed_from = from_union([from_str, from_none], obj.get("installedFrom")) version = from_union([from_str, from_none], obj.get("version")) - return InstalledPluginInfo(enabled, marketplace, name, direct_source_id, version) + return InstalledPluginInfo(enabled, marketplace, name, direct_source_id, installed_from, version) def to_dict(self) -> dict: result: dict = {} @@ -15415,6 +21255,8 @@ def to_dict(self) -> dict: 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.installed_from is not None: + result["installedFrom"] = from_union([from_str, from_none], self.installed_from) if self.version is not None: result["version"] = from_union([from_str, from_none], self.version) return result @@ -15453,8 +21295,9 @@ class MCPServer: """Server name (config key)""" status: McpServerStatus - """Connection status: connected, failed, needs-auth, pending, disabled, or not_configured""" - + """Connection status: connected, failed, needs-auth, pending, disabled, stopped, or + not_configured + """ error: str | None = None """Error message if the server failed to connect""" @@ -15741,54 +21584,6 @@ def to_dict(self) -> dict: result["wireApi"] = from_union([lambda x: to_enum(ProviderWireAPI, x), from_none], self.wire_api) return result -@dataclass -class PushAttachmentGitHubSide: - """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. - - Base side of the comparison - - One side of a tree comparison (head or base) - - Head side of the comparison - """ - repo: PushGitHubRepoRef - """Repository the file lives in - - Repository the revision belongs to - """ - path: str | None = None - """Repository-relative path to the file""" - - ref: str | None = None - """Git ref (branch, tag, or commit SHA) the file is read at""" - - revision: str | None = None - """Git revision (branch, tag, or commit SHA)""" - - @staticmethod - def from_dict(obj: Any) -> 'PushAttachmentGitHubSide': - assert isinstance(obj, dict) - repo = PushGitHubRepoRef.from_dict(obj.get("repo")) - path = from_union([from_str, from_none], obj.get("path")) - ref = from_union([from_str, from_none], obj.get("ref")) - revision = from_union([from_str, from_none], obj.get("revision")) - return PushAttachmentGitHubSide(repo, path, ref, revision) - - def to_dict(self) -> dict: - result: dict = {} - result["repo"] = to_class(PushGitHubRepoRef, self.repo) - 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.revision is not None: - result["revision"] = from_union([from_str, from_none], self.revision) - return result - # Experimental: this type is part of an experimental API and may change or be removed. @dataclass class PushAttachmentGitHubFileDiffSide: @@ -16258,28 +22053,245 @@ def to_dict(self) -> dict: 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: + """Queued message contents and delivery metadata. + + 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(display_text, 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 @@ -16390,9 +22402,8 @@ class RemoteControlStatusActive: # 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. + excluded from the public SDK surface. Retained as an optional compatibility field; native + remote control does not populate or consume it. """ @staticmethod @@ -16534,6 +22545,69 @@ def to_dict(self) -> dict: 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: @@ -16610,6 +22684,12 @@ class SendMessagesRequest: """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 @@ -16644,111 +22724,6 @@ def to_dict(self) -> dict: 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 match one of - three forms: the literal `system`, `command-` for messages originating from a - command (e.g. slash command, Mission Control command), or `schedule-` for - messages originating from a scheduled job. - """ - 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. - """ - - @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 ServerSkillList: @@ -16841,7 +22816,7 @@ def to_dict(self) -> dict: @dataclass class SessionFSSqliteQueryRequest: """SQL query, query type, and optional bind parameters for executing a SQLite query against - the per-session database. + the per-session database. The provider applies its SQLite busy timeout for every call. """ query: str """SQL query to execute""" @@ -16874,6 +22849,197 @@ def to_dict(self) -> dict: 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. + + Classified transaction failure, when execution did not succeed. + """ + error_class: SessionFSSqliteTransactionErrorClass + """Machine-readable classification of the transaction failure.""" + + message: str + """Human-readable transaction failure message.""" + + @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 + """Semantic usage tier.""" + + @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 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 + """Managed permission policy injected by the SDK host.""" + + @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 SessionOpenOptionsAdditionalContentExclusionPolicyRule: @@ -16881,11 +23047,16 @@ class SessionOpenOptionsAdditionalContentExclusionPolicyRule: conditions, and source. """ paths: list[str] + """Path patterns covered by this rule.""" + source: SessionOpenOptionsAdditionalContentExclusionPolicyRuleSource """Source descriptor for a `sessions.open` content-exclusion rule, with source name and type.""" if_any_match: list[str] | None = None + """Conditions of which at least one must match.""" + if_none_match: list[str] | None = None + """Conditions none of which may match.""" @staticmethod def from_dict(obj: Any) -> 'SessionOpenOptionsAdditionalContentExclusionPolicyRule': @@ -16906,6 +23077,31 @@ def to_dict(self) -> dict: 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: @@ -16939,11 +23135,18 @@ def to_dict(self) -> dict: # 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.""" + """Redacted job settings for a session. The job nonce is excluded. + Redacted job settings. + """ built_in_tool_availability: SessionSettingsBuiltInToolAvailabilitySnapshot | None = None + """Availability of job-specific built-in tools.""" + event_type: str | None = None + """GitHub Actions event type for the job.""" + is_trigger_job: bool | None = None + """Whether this is the workflow's trigger job.""" @staticmethod def from_dict(obj: Any) -> 'SessionSettingsJobSnapshot': @@ -17161,7 +23364,7 @@ def to_dict(self) -> dict: # Experimental: this type is part of an experimental API and may change or be removed. @dataclass class AgentInfo: - """Custom agent metadata, including identifiers, display details, source, tools, model, MCP + """Agent metadata, including identifiers, display details, source, tools, model, MCP servers, skills, and file path. The newly selected custom agent @@ -17178,19 +23381,24 @@ class AgentInfo: distinct id was assigned. """ name: str - """Unique identifier of the custom agent""" + """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 - """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. + """ 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.""" @@ -17215,11 +23423,12 @@ def from_dict(obj: Any) -> 'AgentInfo': 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, skills, source, tools, user_invocable) + return AgentInfo(description, display_name, id, name, mcp_servers, model, path, prompt, skills, source, tools, user_invocable) def to_dict(self) -> dict: result: dict = {} @@ -17233,6 +23442,8 @@ def to_dict(self) -> dict: 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: @@ -17359,6 +23570,39 @@ def to_dict(self) -> dict: 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 SlashCommandAddTimelineEntryResult: + entry: SlashCommandTimelineEntry + """Timeline entry the host should append.""" + + kind: ClassVar[str] = "add-timeline-entry" + """Discriminator for an add-timeline-entry result.""" + + prefill_input: str | None = None + """Optional text the host should prefill into the input editor.""" + + runtime_settings_changed: bool | None = None + """Whether command execution changed persisted runtime settings.""" + + @staticmethod + def from_dict(obj: Any) -> 'SlashCommandAddTimelineEntryResult': + assert isinstance(obj, dict) + entry = SlashCommandTimelineEntry.from_dict(obj.get("entry")) + prefill_input = from_union([from_str, from_none], obj.get("prefillInput")) + runtime_settings_changed = from_union([from_bool, from_none], obj.get("runtimeSettingsChanged")) + return SlashCommandAddTimelineEntryResult(entry, prefill_input, runtime_settings_changed) + + def to_dict(self) -> dict: + result: dict = {} + result["entry"] = to_class(SlashCommandTimelineEntry, self.entry) + result["kind"] = self.kind + if self.prefill_input is not None: + result["prefillInput"] = from_union([from_str, from_none], self.prefill_input) + 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 SlashCommandAgentPromptResult: @@ -17483,6 +23727,39 @@ def to_dict(self) -> dict: 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 SlashCommandSetPlanModelResult: + kind: ClassVar[str] = "set-plan-model" + """Discriminator for a set-plan-model result.""" + + message: str + """User-facing confirmation message for the plan-model selection.""" + + plan_model: str | None = None + """Dedicated model selected for plan mode.""" + + runtime_settings_changed: bool | None = None + """Whether command execution changed persisted runtime settings.""" + + @staticmethod + def from_dict(obj: Any) -> 'SlashCommandSetPlanModelResult': + assert isinstance(obj, dict) + message = from_str(obj.get("message")) + plan_model = from_union([from_str, from_none], obj.get("planModel")) + runtime_settings_changed = from_union([from_bool, from_none], obj.get("runtimeSettingsChanged")) + return SlashCommandSetPlanModelResult(message, plan_model, runtime_settings_changed) + + def to_dict(self) -> dict: + result: dict = {} + result["kind"] = self.kind + result["message"] = from_str(self.message) + if self.plan_model is not None: + result["planModel"] = from_union([from_str, from_none], self.plan_model) + 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: @@ -17672,6 +23949,35 @@ def to_dict(self) -> dict: 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. +# Internal: this type is an internal SDK API and is not part of the public surface. +@dataclass +class _FactoryToolRunOptions: + """Options for an internal tool-originated factory invocation. + + Tool-originated factory invocation options. + """ + limits: FactoryRunLimits | None = None + """Per-invocation resource ceiling overrides.""" + + resume_from_run_id: str | None = None + """Run identifier whose journal and progress should seed this resumed run.""" + + @staticmethod + def from_dict(obj: Any) -> '_FactoryToolRunOptions': + assert isinstance(obj, dict) + 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 _FactoryToolRunOptions(limits, resume_from_run_id) + + def to_dict(self) -> dict: + result: dict = {} + 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 MCPAppsCallToolRequest: @@ -17709,6 +24015,20 @@ def to_dict(self) -> dict: 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. +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) + + Controls whether tools can be loaded on demand. + + Controls whether the runtime may defer loading an external tool definition. + + Tool-loading deferral policy. + """ + AUTO = "auto" + NEVER = "never" + # Experimental: this type is part of an experimental API and may change or be removed. @dataclass class MCPToolUI: @@ -17833,6 +24153,9 @@ class TaskAgentInfo: completed_at: datetime | None = None """ISO 8601 timestamp when the task finished""" + display_name: str | None = None + """Friendly, non-unique name intended for display""" + error: str | None = None """Error message when the task failed""" @@ -17868,6 +24191,7 @@ def from_dict(obj: Any) -> 'TaskAgentInfo': 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")) + display_name = from_union([from_str, from_none], obj.get("displayName")) 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")) @@ -17875,7 +24199,7 @@ def from_dict(obj: Any) -> 'TaskAgentInfo': 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) + 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, display_name, error, execution_mode, idle_since, latest_response, model, resolved_model, result) def to_dict(self) -> dict: result: dict = {} @@ -17895,6 +24219,8 @@ def to_dict(self) -> dict: 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.display_name is not None: + result["displayName"] = from_union([from_str, from_none], self.display_name) if self.error is not None: result["error"] = from_union([from_str, from_none], self.error) if self.execution_mode is not None: @@ -17930,6 +24256,58 @@ def to_dict(self) -> 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 ToolsShellDescriptorConfig: + """Shell-specific names and description lines for shell tools. + + Shell-specific names and description lines used to materialize built-in shell tool + descriptors. + """ + description_lines: list[str] + """Additional model-facing shell description lines.""" + + display_name: str + """Human-readable shell name.""" + + list_shells_tool_name: str + """Tool name used to list active shells.""" + + read_shell_tool_name: str + """Tool name used to read shell output.""" + + shell_tool_name: str + """Tool name used to start shell commands.""" + + shell_type: str + """Stable shell type identifier.""" + + stop_shell_tool_name: str + """Tool name used to stop shell commands.""" + + @staticmethod + def from_dict(obj: Any) -> 'ToolsShellDescriptorConfig': + assert isinstance(obj, dict) + description_lines = from_list(from_str, obj.get("descriptionLines")) + display_name = from_str(obj.get("displayName")) + list_shells_tool_name = from_str(obj.get("listShellsToolName")) + read_shell_tool_name = from_str(obj.get("readShellToolName")) + shell_tool_name = from_str(obj.get("shellToolName")) + shell_type = from_str(obj.get("shellType")) + stop_shell_tool_name = from_str(obj.get("stopShellToolName")) + return ToolsShellDescriptorConfig(description_lines, display_name, list_shells_tool_name, read_shell_tool_name, shell_tool_name, shell_type, stop_shell_tool_name) + + def to_dict(self) -> dict: + result: dict = {} + result["descriptionLines"] = from_list(from_str, self.description_lines) + result["displayName"] = from_str(self.display_name) + result["listShellsToolName"] = from_str(self.list_shells_tool_name) + result["readShellToolName"] = from_str(self.read_shell_tool_name) + result["shellToolName"] = from_str(self.shell_tool_name) + result["shellType"] = from_str(self.shell_type) + result["stopShellToolName"] = from_str(self.stop_shell_tool_name) + return result + # Experimental: this type is part of an experimental API and may change or be removed. @dataclass class UserRequestedShellCommandResult: @@ -18224,6 +24602,9 @@ class UIElicitationResponse: action: UIElicitationResponseAction """The user's response: accept (submitted), decline (rejected), or cancel (dismissed)""" + meta: dict[str, Any] | None = None + """MCP response metadata.""" + content: dict[str, float | bool | list[str] | str] | None = None """The form values submitted by the user (present when action is 'accept')""" @@ -18231,12 +24612,15 @@ class UIElicitationResponse: def from_dict(obj: Any) -> 'UIElicitationResponse': assert isinstance(obj, dict) action = UIElicitationResponseAction(obj.get("action")) + meta = from_union([lambda x: from_dict(lambda x: x, x), from_none], obj.get("_meta")) 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) + return UIElicitationResponse(action, meta, content) def to_dict(self) -> dict: result: dict = {} result["action"] = to_enum(UIElicitationResponseAction, self.action) + if self.meta is not None: + result["_meta"] = from_union([lambda x: from_dict(lambda x: x, x), from_none], self.meta) 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 @@ -18339,6 +24723,12 @@ class UIExitPlanModeResponse: 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.""" @@ -18352,15 +24742,18 @@ 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, feedback, selected_action) + 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: @@ -18505,8 +24898,10 @@ class WorkspaceDiffFileChange: """Unified diff content for the file. Empty when the diff was truncated.""" path: str - """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). + """ is_truncated: bool | None = None """Whether the diff content was omitted because it exceeded the per-file size limit.""" @@ -18629,6 +25024,47 @@ def to_dict(self) -> dict: 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 MCPPlanProvenance: + """Origin and semantic digest of the exact validated JSON MCP card content bound to this + plan. + + Provenance of the exact validated JSON MCP card content bound privately to a completed + plan and its opaque handle. + """ + authority: str + """Authority associated with the validated card, without path, query, or credentials. Inert + untrusted data. + """ + card_digest: CardDigest + """Semantic digest of the exact validated JSON content bound to the plan handle.""" + + media_type: MCPServerCardMediaType + """JSON MCP media type the validated card was interpreted as.""" + + validated_at: str + """ISO 8601 timestamp at which the runtime completed strict parsing and schema validation of + the card content. + """ + + @staticmethod + def from_dict(obj: Any) -> 'MCPPlanProvenance': + assert isinstance(obj, dict) + authority = from_str(obj.get("authority")) + card_digest = CardDigest.from_dict(obj.get("cardDigest")) + media_type = MCPServerCardMediaType(obj.get("mediaType")) + validated_at = from_str(obj.get("validatedAt")) + return MCPPlanProvenance(authority, card_digest, media_type, validated_at) + + def to_dict(self) -> dict: + result: dict = {} + result["authority"] = from_str(self.authority) + result["cardDigest"] = to_class(CardDigest, self.card_digest) + result["mediaType"] = to_enum(MCPServerCardMediaType, self.media_type) + result["validatedAt"] = from_str(self.validated_at) + return result + # Experimental: this type is part of an experimental API and may change or be removed. @dataclass class SlashCommandInfo: @@ -18774,6 +25210,230 @@ def to_dict(self) -> 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 CatalogAISkillCandidate: + """An inert AI skill catalog result. AI skills are discovery-only and cannot be represented + as installable through this surface. + """ + display_name: str + """Display name taken verbatim from the card. Inert untrusted text.""" + + handle: str + """Opaque, runtime-instance scoped, TTL-bound, single-use handle for this candidate. Carries + no readable information and is rejected when stale, replayed, or presented to a different + runtime instance. Never logged. + """ + handle_expires_at: str + """ISO 8601 timestamp after which the handle is stale and will be rejected.""" + + installability: Installability + """AI skills are discovery-only and cannot be installed through this surface""" + + kind: CatalogAISkillCandidateKind + """Discriminator: this candidate describes an AI skill""" + + media_type: MediaType + """Media type of the underlying AI skill card""" + + provenance: CatalogAISkillCandidateProvenance + """Where the catalog reference was observed, without the card itself or any content digest.""" + + source: CatalogCandidateSource + """Where the card came from: exactly one of a URL or embedded data, encoded as a tagged + union so neither both nor neither can be represented. + """ + description: str | None = None + """Description taken verbatim from the card. Inert untrusted text.""" + + publisher: str | None = None + """Publisher taken verbatim from the card. Inert untrusted text.""" + + @staticmethod + def from_dict(obj: Any) -> 'CatalogAISkillCandidate': + assert isinstance(obj, dict) + display_name = from_str(obj.get("displayName")) + handle = from_str(obj.get("handle")) + handle_expires_at = from_str(obj.get("handleExpiresAt")) + installability = Installability(obj.get("installability")) + kind = CatalogAISkillCandidateKind(obj.get("kind")) + media_type = MediaType(obj.get("mediaType")) + provenance = CatalogAISkillCandidateProvenance.from_dict(obj.get("provenance")) + source = _load_CatalogCandidateSource(obj.get("source")) + description = from_union([from_str, from_none], obj.get("description")) + publisher = from_union([from_str, from_none], obj.get("publisher")) + return CatalogAISkillCandidate(display_name, handle, handle_expires_at, installability, kind, media_type, provenance, source, description, publisher) + + def to_dict(self) -> dict: + result: dict = {} + result["displayName"] = from_str(self.display_name) + result["handle"] = from_str(self.handle) + result["handleExpiresAt"] = from_str(self.handle_expires_at) + result["installability"] = to_enum(Installability, self.installability) + result["kind"] = to_enum(CatalogAISkillCandidateKind, self.kind) + result["mediaType"] = to_enum(MediaType, self.media_type) + result["provenance"] = to_class(CatalogAISkillCandidateProvenance, self.provenance) + result["source"] = (self.source).to_dict() + if self.description is not None: + result["description"] = from_union([from_str, from_none], self.description) + if self.publisher is not None: + result["publisher"] = from_union([from_str, from_none], self.publisher) + return result + +# Experimental: this type is part of an experimental API and may change or be removed. +@dataclass +class CatalogCandidate: + """One inert catalog result, represented as an MCP server or discovery-only AI skill variant + so kind, media type, provenance, and installability cannot contradict each other. + + An inert MCP server catalog result. Every free-text field is untrusted external data and + must never be treated as an instruction, and the handle is the only way to refer to the + candidate in a later operation. + + An inert AI skill catalog result. AI skills are discovery-only and cannot be represented + as installable through this surface. + """ + display_name: str + """Display name taken verbatim from the card. Inert untrusted text.""" + + handle: str + """Opaque, runtime-instance scoped, TTL-bound, single-use handle for this candidate. Carries + no readable information and is rejected when stale, replayed, or presented to a different + runtime instance. Never logged. + """ + handle_expires_at: str + """ISO 8601 timestamp after which the handle is stale and will be rejected.""" + + installability: CatalogCandidateInstallability + """Whether this MCP server can be planned for installation, and if policy prevents it. + + AI skills are discovery-only and cannot be installed through this surface + """ + kind: CatalogCandidateKind + """Discriminator: this candidate describes an MCP server + + Discriminator: this candidate describes an AI skill + """ + media_type: CatalogMediaType + """JSON MCP media type of the underlying card. + + Media type of the underlying AI skill card + """ + provenance: CatalogCandidateProvenance + """Where the catalog reference was observed, without the card itself or any content digest.""" + + source: CatalogCandidateSource + """Where the card came from: exactly one of a URL or embedded data, encoded as a tagged + union so neither both nor neither can be represented. + """ + description: str | None = None + """Description taken verbatim from the card. Inert untrusted text.""" + + publisher: str | None = None + """Publisher taken verbatim from the card. Inert untrusted text.""" + + @staticmethod + def from_dict(obj: Any) -> 'CatalogCandidate': + assert isinstance(obj, dict) + display_name = from_str(obj.get("displayName")) + handle = from_str(obj.get("handle")) + handle_expires_at = from_str(obj.get("handleExpiresAt")) + installability = CatalogCandidateInstallability(obj.get("installability")) + kind = CatalogCandidateKind(obj.get("kind")) + media_type = CatalogMediaType(obj.get("mediaType")) + provenance = CatalogCandidateProvenance.from_dict(obj.get("provenance")) + source = _load_CatalogCandidateSource(obj.get("source")) + description = from_union([from_str, from_none], obj.get("description")) + publisher = from_union([from_str, from_none], obj.get("publisher")) + return CatalogCandidate(display_name, handle, handle_expires_at, installability, kind, media_type, provenance, source, description, publisher) + + def to_dict(self) -> dict: + result: dict = {} + result["displayName"] = from_str(self.display_name) + result["handle"] = from_str(self.handle) + result["handleExpiresAt"] = from_str(self.handle_expires_at) + result["installability"] = to_enum(CatalogCandidateInstallability, self.installability) + result["kind"] = to_enum(CatalogCandidateKind, self.kind) + result["mediaType"] = to_enum(CatalogMediaType, self.media_type) + result["provenance"] = to_class(CatalogCandidateProvenance, self.provenance) + result["source"] = (self.source).to_dict() + if self.description is not None: + result["description"] = from_union([from_str, from_none], self.description) + if self.publisher is not None: + result["publisher"] = from_union([from_str, from_none], self.publisher) + return result + +# Experimental: this type is part of an experimental API and may change or be removed. +@dataclass +class CatalogMCPServerCandidate: + """An inert MCP server catalog result. Every free-text field is untrusted external data and + must never be treated as an instruction, and the handle is the only way to refer to the + candidate in a later operation. + """ + display_name: str + """Display name taken verbatim from the card. Inert untrusted text.""" + + handle: str + """Opaque, runtime-instance scoped, TTL-bound, single-use handle for this candidate. Carries + no readable information and is rejected when stale, replayed, or presented to a different + runtime instance. Never logged. + """ + handle_expires_at: str + """ISO 8601 timestamp after which the handle is stale and will be rejected.""" + + installability: CatalogMCPServerInstallabilityEnum + """Whether this MCP server can be planned for installation, and if policy prevents it.""" + + kind: CatalogMCPServerCandidateKind + """Discriminator: this candidate describes an MCP server""" + + media_type: MCPServerCardMediaType + """JSON MCP media type of the underlying card.""" + + provenance: CatalogMCPServerCandidateProvenance + """Where the catalog reference was observed, without the card itself or any content digest.""" + + source: CatalogCandidateSource + """Where the card came from: exactly one of a URL or embedded data, encoded as a tagged + union so neither both nor neither can be represented. + """ + description: str | None = None + """Description taken verbatim from the card. Inert untrusted text.""" + + publisher: str | None = None + """Publisher taken verbatim from the card. Inert untrusted text.""" + + @staticmethod + def from_dict(obj: Any) -> 'CatalogMCPServerCandidate': + assert isinstance(obj, dict) + display_name = from_str(obj.get("displayName")) + handle = from_str(obj.get("handle")) + handle_expires_at = from_str(obj.get("handleExpiresAt")) + installability = CatalogMCPServerInstallabilityEnum(obj.get("installability")) + kind = CatalogMCPServerCandidateKind(obj.get("kind")) + media_type = MCPServerCardMediaType(obj.get("mediaType")) + provenance = CatalogMCPServerCandidateProvenance.from_dict(obj.get("provenance")) + source = _load_CatalogCandidateSource(obj.get("source")) + description = from_union([from_str, from_none], obj.get("description")) + publisher = from_union([from_str, from_none], obj.get("publisher")) + return CatalogMCPServerCandidate(display_name, handle, handle_expires_at, installability, kind, media_type, provenance, source, description, publisher) + + def to_dict(self) -> dict: + result: dict = {} + result["displayName"] = from_str(self.display_name) + result["handle"] = from_str(self.handle) + result["handleExpiresAt"] = from_str(self.handle_expires_at) + result["installability"] = to_enum(CatalogMCPServerInstallabilityEnum, self.installability) + result["kind"] = to_enum(CatalogMCPServerCandidateKind, self.kind) + result["mediaType"] = to_enum(MCPServerCardMediaType, self.media_type) + result["provenance"] = to_class(CatalogMCPServerCandidateProvenance, self.provenance) + result["source"] = (self.source).to_dict() + if self.description is not None: + result["description"] = from_union([from_str, from_none], self.description) + if self.publisher is not None: + result["publisher"] = from_union([from_str, from_none], self.publisher) + return result + # Experimental: this type is part of an experimental API and may change or be removed. @dataclass class DebugCollectLogsResult: @@ -18810,6 +25470,31 @@ def to_dict(self) -> dict: 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 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: @@ -18829,125 +25514,34 @@ def to_dict(self) -> 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 PermissionDecisionApproveForIonApproval: - """Session-scoped approval to remember (tool prompts only; omitted for path/url prompts) - - Session-scoped approval details for specific command identifiers. - - Session-scoped approval details for read-only filesystem operations. - - Session-scoped approval details for filesystem write operations. - - Session-scoped approval details for an MCP server tool, or all tools on the server when - `toolName` is null. - - Session-scoped approval details for MCP sampling requests from a server. - - Session-scoped approval details for writes to long-term memory. - - Session-scoped approval details for a custom tool, keyed by tool name. - - Session-scoped approval details for extension-management operations, optionally narrowed - by operation. - - Session-scoped approval details for an extension's permission-gated capability access, - keyed by extension name. - - Approval to persist for this location - - Location-scoped approval details for specific command identifiers. - - Location-scoped approval details for read-only filesystem operations. - - Location-scoped approval details for filesystem write operations. - - Location-scoped approval details for an MCP server tool, or all tools on the server when - `toolName` is null. - - Location-scoped approval details for MCP sampling requests from a server. - - Location-scoped approval details for writes to long-term memory. - - Location-scoped approval details for a custom tool, keyed by tool name. - - Location-scoped approval details for extension-management operations, optionally narrowed - by operation. - - Location-scoped approval details for an extension's permission-gated capability access, - keyed by extension name. - - The approval to add as a session-scoped rule - - The approval to persist for this location - """ - command_identifiers: list[str] | None = None - """Command identifiers covered by this approval.""" - - kind: ApprovalKind | None = None - """Approval scoped to specific command identifiers. - - Approval covering read-only filesystem operations. - - Approval covering filesystem write operations. - - Approval covering an MCP tool. - - Approval covering MCP sampling requests for a server. - - Approval covering writes to long-term memory. - - Approval covering a custom tool. - - Approval covering extension lifecycle operations such as enable, disable, or reload. - - Approval covering an extension's request to access a permission-gated capability. - """ - server_name: str | None = None - """MCP server name.""" - - tool_name: str | None = None - """MCP tool name, or null to cover every tool on the server. - - Custom tool name. +class PermissionDecisionApproveForLocationApprovalExtensionEnvAccess: + """Location-scoped approval details for an extension's access to sensitive environment + variables, keyed by extension name and the exact set of variable names. """ - operation: str | None = None - """Optional operation identifier; when omitted, the approval covers all extension management - operations. + environment_variables: list[str] + """Names of the sensitive environment variables this approval covers. Values are never + persisted. """ - extension_name: str | None = None + extension_name: str """Extension name.""" - external_ref_marker_external_ref_user_tool_session_approval: str | None = None + kind: ClassVar[str] = "extension-env-access" + """Approval covering an extension's request to read sensitive environment variables.""" @staticmethod - def from_dict(obj: Any) -> 'PermissionDecisionApproveForIonApproval': + def from_dict(obj: Any) -> 'PermissionDecisionApproveForLocationApprovalExtensionEnvAccess': 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) + environment_variables = from_list(from_str, obj.get("environmentVariables")) + extension_name = from_str(obj.get("extensionName")) + return PermissionDecisionApproveForLocationApprovalExtensionEnvAccess(environment_variables, extension_name) 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["environmentVariables"] = from_list(from_str, self.environment_variables) + 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. @@ -18974,6 +25568,36 @@ def to_dict(self) -> dict: result["kind"] = self.kind return result +# Experimental: this type is part of an experimental API and may change or be removed. +@dataclass +class PermissionDecisionApproveForSessionApprovalExtensionEnvAccess: + """Session-scoped approval details for an extension's access to sensitive environment + variables, keyed by extension name and the exact set of variable names. + """ + environment_variables: list[str] + """Names of the sensitive environment variables this approval covers. Values are never + persisted. + """ + extension_name: str + """Extension name.""" + + kind: ClassVar[str] = "extension-env-access" + """Approval covering an extension's request to read sensitive environment variables.""" + + @staticmethod + def from_dict(obj: Any) -> 'PermissionDecisionApproveForSessionApprovalExtensionEnvAccess': + assert isinstance(obj, dict) + environment_variables = from_list(from_str, obj.get("environmentVariables")) + extension_name = from_str(obj.get("extensionName")) + return PermissionDecisionApproveForSessionApprovalExtensionEnvAccess(environment_variables, extension_name) + + def to_dict(self) -> dict: + result: dict = {} + result["environmentVariables"] = from_list(from_str, self.environment_variables) + 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: @@ -18998,6 +25622,36 @@ def to_dict(self) -> dict: result["kind"] = self.kind return result +# Experimental: this type is part of an experimental API and may change or be removed. +@dataclass +class PermissionsLocationsAddToolApprovalDetailsExtensionEnvAccess: + """Location-persisted tool approval details for an extension's access to sensitive + environment variables, keyed by extension name and the exact set of variable names. + """ + environment_variables: list[str] + """Names of the sensitive environment variables this approval covers. Values are never + persisted. + """ + extension_name: str + """Extension name.""" + + kind: ClassVar[str] = "extension-env-access" + """Approval covering an extension's request to read sensitive environment variables.""" + + @staticmethod + def from_dict(obj: Any) -> 'PermissionsLocationsAddToolApprovalDetailsExtensionEnvAccess': + assert isinstance(obj, dict) + environment_variables = from_list(from_str, obj.get("environmentVariables")) + extension_name = from_str(obj.get("extensionName")) + return PermissionsLocationsAddToolApprovalDetailsExtensionEnvAccess(environment_variables, extension_name) + + def to_dict(self) -> dict: + result: dict = {} + result["environmentVariables"] = from_list(from_str, self.environment_variables) + 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: @@ -19086,6 +25740,124 @@ def to_dict(self) -> dict: 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 ToolResultExpanded: + """Expanded canonical tool result + + Expanded canonical result returned by a session tool. + + Final expanded result returned by the task_complete tool. + """ + result_type: ToolResultType + """Execution outcome classification.""" + + 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.""" + + citable_sources: list[Any] | None = None + """Sources returned by the tool that the model may cite.""" + + contents: list[ExternalToolTextResultForLlmContent] | None = None + """Structured content blocks returned to the model.""" + + error: str | None = None + """Error message for an unsuccessful execution.""" + + mcp_meta: dict[str, Any] | None = None + """Metadata propagated with the tool result, including information-flow labels.""" + + new_messages: list[ToolResultNewMessage] | None = None + """Messages to inject after the tool result.""" + + post_tool_use_failure_hooks_processed: bool | None = None + """Whether post-tool-use failure hooks have already processed this result.""" + + session_log: str | None = None + """Detailed log content available for session display.""" + + skill_invocation: Any = None + """Skill invocation metadata produced by the tool.""" + + skip_large_output_processing: bool | None = None + """Whether large-output post-processing should be skipped.""" + + structured_content: Any = None + """Structured result content in addition to the model-facing text.""" + + task_completion_decision: TaskCompletionDecision | None = None + """Completion-review decision produced by the task-completion tool.""" + + tool_references: list[str] | None = None + """Deferred tool names made available by this result.""" + + tool_telemetry: Any = None + """Tool-specific telemetry payload.""" + + ui_resource: Any = None + """Optional UI resource produced by the tool.""" + + @staticmethod + def from_dict(obj: Any) -> 'ToolResultExpanded': + assert isinstance(obj, dict) + result_type = ToolResultType(obj.get("resultType")) + 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")) + citable_sources = from_union([lambda x: from_list(lambda x: x, x), from_none], obj.get("citableSources")) + 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")) + mcp_meta = from_union([lambda x: from_dict(lambda x: x, x), from_none], obj.get("mcpMeta")) + new_messages = from_union([lambda x: from_list(ToolResultNewMessage.from_dict, x), from_none], obj.get("newMessages")) + post_tool_use_failure_hooks_processed = from_union([from_bool, from_none], obj.get("postToolUseFailureHooksProcessed")) + session_log = from_union([from_str, from_none], obj.get("sessionLog")) + skill_invocation = obj.get("skillInvocation") + skip_large_output_processing = from_union([from_bool, from_none], obj.get("skipLargeOutputProcessing")) + structured_content = obj.get("structuredContent") + task_completion_decision = from_union([TaskCompletionDecision.from_dict, from_none], obj.get("taskCompletionDecision")) + tool_references = from_union([lambda x: from_list(from_str, x), from_none], obj.get("toolReferences")) + tool_telemetry = obj.get("toolTelemetry") + ui_resource = obj.get("uiResource") + return ToolResultExpanded(result_type, text_result_for_llm, binary_results_for_llm, citable_sources, contents, error, mcp_meta, new_messages, post_tool_use_failure_hooks_processed, session_log, skill_invocation, skip_large_output_processing, structured_content, task_completion_decision, tool_references, tool_telemetry, ui_resource) + + def to_dict(self) -> dict: + result: dict = {} + result["resultType"] = to_enum(ToolResultType, self.result_type) + 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.citable_sources is not None: + result["citableSources"] = from_union([lambda x: from_list(lambda x: x, x), from_none], self.citable_sources) + 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.mcp_meta is not None: + result["mcpMeta"] = from_union([lambda x: from_dict(lambda x: x, x), from_none], self.mcp_meta) + if self.new_messages is not None: + result["newMessages"] = from_union([lambda x: from_list(lambda x: to_class(ToolResultNewMessage, x), x), from_none], self.new_messages) + if self.post_tool_use_failure_hooks_processed is not None: + result["postToolUseFailureHooksProcessed"] = from_union([from_bool, from_none], self.post_tool_use_failure_hooks_processed) + if self.session_log is not None: + result["sessionLog"] = from_union([from_str, from_none], self.session_log) + if self.skill_invocation is not None: + result["skillInvocation"] = self.skill_invocation + if self.skip_large_output_processing is not None: + result["skipLargeOutputProcessing"] = from_union([from_bool, from_none], self.skip_large_output_processing) + if self.structured_content is not None: + result["structuredContent"] = self.structured_content + if self.task_completion_decision is not None: + result["taskCompletionDecision"] = from_union([lambda x: to_class(TaskCompletionDecision, x), from_none], self.task_completion_decision) + 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"] = self.tool_telemetry + if self.ui_resource is not None: + result["uiResource"] = self.ui_resource + return result + # Experimental: this type is part of an experimental API and may change or be removed. @dataclass class ExternalToolTextResultForLlmContentResourceLink: @@ -19146,33 +25918,49 @@ def to_dict(self) -> dict: # Experimental: this type is part of an experimental API and may change or be removed. @dataclass -class FactoryLogRequest: - """Parameters for recording factory progress.""" +class FactoryRunTerminal: + """Prompt-safe terminal factory outcome.""" - lines: list[FactoryLogLine] - """Ordered progress lines to append.""" + error: str | None = None + """Human-readable terminal error.""" - run_id: str - """Factory run identifier.""" + failure: FactoryRunFailure | None = None + """Machine-readable terminal failure.""" + + reason: str | None = None + """Human-readable terminal reason.""" + + result_preview: str | None = None + """Prompt-safe preview of the completed result.""" @staticmethod - def from_dict(obj: Any) -> 'FactoryLogRequest': + def from_dict(obj: Any) -> 'FactoryRunTerminal': assert isinstance(obj, dict) - lines = from_list(FactoryLogLine.from_dict, obj.get("lines")) - run_id = from_str(obj.get("runId")) - return FactoryLogRequest(lines, run_id) + 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 = {} - result["lines"] = from_list(lambda x: to_class(FactoryLogLine, x), self.lines) - result["runId"] = from_str(self.run_id) + 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: - """Complete current or terminal factory run envelope.""" + """Terminal resumed run envelope. + Complete current or terminal factory run envelope. + """ run_id: str """Factory run identifier.""" @@ -19222,6 +26010,81 @@ def to_dict(self) -> dict: 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. + + Bidirectional page of durable factory progress. + """ + has_more_newer: bool + """Whether progress records newer than this page exist.""" + + has_more_older: bool + """Whether progress records older than this page exist.""" + + records: list[FactoryProgressLine] + """Progress records in sequence order.""" + + revision: int + """Run revision reflected by this page.""" + + newest_seq: int | None = None + """Newest sequence number in this page, or null when empty.""" + + oldest_seq: int | None = None + """Oldest sequence number in this page, or null when empty.""" + + @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: @@ -19252,6 +26115,127 @@ def to_dict(self) -> dict: 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 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 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: @@ -19273,9 +26257,23 @@ class InstalledPlugin: cache_path: str | None = None """Path where the plugin is cached locally""" + installed_from: str | None = None + """Absolute path of the marketplace directory a live plugin was resolved from. Present only + on live, never-persisted records β€” those synthesized at session start for a + directory/local marketplace, whose cache_path points at the real plugin directory on disk + rather than a copy under the installed-plugins cache. Its presence is what marks a record + as live, and no record carrying it is ever written to the persisted installedPlugins key. + """ 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)""" @@ -19287,9 +26285,11 @@ def from_dict(obj: Any) -> 'InstalledPlugin': marketplace = from_str(obj.get("marketplace")) name = from_str(obj.get("name")) cache_path = from_union([from_str, from_none], obj.get("cache_path")) + installed_from = from_union([from_str, from_none], obj.get("installed_from")) 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, version) + return InstalledPlugin(enabled, installed_at, marketplace, name, cache_path, installed_from, source, source_sha, version) def to_dict(self) -> dict: result: dict = {} @@ -19299,8 +26299,12 @@ def to_dict(self) -> dict: 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.installed_from is not None: + result["installed_from"] = from_union([from_str, from_none], self.installed_from) 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 @@ -19326,9 +26330,23 @@ class SessionInstalledPlugin: cache_path: str | None = None """Path where the plugin is cached locally""" + installed_from: str | None = None + """Absolute path of the marketplace directory a live plugin was resolved from. Present only + on live, never-persisted records β€” those synthesized at session start for a + directory/local marketplace, whose cache_path points at the real plugin directory on disk + rather than a copy under the installed-plugins cache. Its presence is what marks a record + as live, and no record carrying it is ever written to the persisted installedPlugins key. + """ 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""" @@ -19340,9 +26358,11 @@ def from_dict(obj: Any) -> 'SessionInstalledPlugin': marketplace = from_str(obj.get("marketplace")) name = from_str(obj.get("name")) cache_path = from_union([from_str, from_none], obj.get("cache_path")) + installed_from = from_union([from_str, from_none], obj.get("installed_from")) 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, version) + return SessionInstalledPlugin(enabled, installed_at, marketplace, name, cache_path, installed_from, source, source_sha, version) def to_dict(self) -> dict: result: dict = {} @@ -19352,8 +26372,12 @@ def to_dict(self) -> dict: 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.installed_from is not None: + result["installed_from"] = from_union([from_str, from_none], self.installed_from) 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 @@ -19401,6 +26425,8 @@ def to_dict(self) -> dict: 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.""" @@ -19499,6 +26525,16 @@ class RemoteSessionMetadataValue: context: SessionContext | None = None """Most recent working directory context.""" + host_activity: str | None = None + """Host-supplied human description of what the session is doing right now ("running tests", + "waiting for approval"). Optional in the protocol and absent on hosts that do not publish + it, so never rely on it -- it enriches `hostStatus`, it does not replace it. + """ + host_status: RemoteSessionHostStatus | None = None + """Live status as the owning host reports it in its session listing, so a row for a session + running elsewhere can show that it is running. Absent for hosts that publish no such + status (the cloud task managers), which read as idle. + """ name: str | None = None """Optional human-friendly name set via /rename.""" @@ -19531,6 +26567,8 @@ def from_dict(obj: Any) -> 'RemoteSessionMetadataValue': 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")) + host_activity = from_union([from_str, from_none], obj.get("hostActivity")) + host_status = from_union([RemoteSessionHostStatus, from_none], obj.get("hostStatus")) 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")) @@ -19538,7 +26576,7 @@ def from_dict(obj: Any) -> 'RemoteSessionMetadataValue': 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) + return RemoteSessionMetadataValue(is_remote, modified_time, remote_session_ids, repository, session_id, start_time, context, host_activity, host_status, name, pull_request_number, resource_id, stale_at, state, summary, task_type) def to_dict(self) -> dict: result: dict = {} @@ -19550,6 +26588,10 @@ def to_dict(self) -> dict: 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.host_activity is not None: + result["hostActivity"] = from_union([from_str, from_none], self.host_activity) + if self.host_status is not None: + result["hostStatus"] = from_union([lambda x: to_enum(RemoteSessionHostStatus, x), from_none], self.host_status) if self.name is not None: result["name"] = from_union([from_str, from_none], self.name) if self.pull_request_number is not None: @@ -19618,9 +26660,11 @@ class PermissionPathsConfig: """ 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). + directory). Conventional `.github/skills/` and `.github/agents/` definitions under them + also join the session catalogs when their subsystem gates are enabled, so supplying a + directory is a trust decision for configuration stored there. 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). @@ -19786,6 +26830,32 @@ def to_dict(self) -> dict: 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: @@ -19824,125 +26894,6 @@ def to_dict(self) -> 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 configuration for an individual MCP server start.""" - - config: MCPServerConfig - """MCP server configuration (stdio process or remote HTTP/SSE)""" - - server_name: str - """Name of the MCP server to start""" - - @staticmethod - def from_dict(obj: Any) -> 'MCPStartServerRequest': - assert isinstance(obj, dict) - config = MCPServerConfig.from_dict(obj.get("config")) - server_name = from_str(obj.get("serverName")) - return MCPStartServerRequest(config, server_name) - - def to_dict(self) -> dict: - result: dict = {} - result["config"] = to_class(MCPServerConfig, self.config) - 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 MCPHeadersHandlePendingHeadersRefreshRequestRequest: @@ -19967,30 +26918,6 @@ def to_dict(self) -> dict: 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: @@ -20139,7 +27066,7 @@ class ModelBilling: promo: ModelBillingPromo | None = None """Active server-driven promotion for this model, if any. Present when the model is being - promoted with a time-boxed discount. + promoted with a discount, which may be time-boxed or open-ended. """ token_prices: ModelBillingTokenPrices | None = None """Token-level pricing information for this model""" @@ -20206,6 +27133,8 @@ class ModelCapabilitiesOverride: Override individual model capabilities resolved by the runtime + Overrides for model capabilities when they cannot be inferred from modelId. + Initial model capability overrides. Per-property model capability overrides for the selected model. @@ -20231,33 +27160,6 @@ def to_dict(self) -> dict: 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: @@ -20265,7 +27167,11 @@ class OptionsUpdateAdditionalContentExclusionPolicy: data, and scope. """ last_updated_at: Any + """Opaque policy update timestamp supplied by the host.""" + rules: list[OptionsUpdateAdditionalContentExclusionPolicyRule] + """Content-exclusion rules to apply.""" + scope: AdditionalContentExclusionPolicyScope """Allowed values for the `OptionsUpdateAdditionalContentExclusionPolicyScope` enumeration.""" @@ -20284,6 +27190,38 @@ def to_dict(self) -> dict: 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: @@ -20291,7 +27229,11 @@ class PermissionsConfigureAdditionalContentExclusionPolicy: last-updated data, and scope. """ last_updated_at: Any + """Opaque policy update timestamp supplied by the host.""" + rules: list[PermissionsConfigureAdditionalContentExclusionPolicyRule] + """Content-exclusion rules to apply.""" + scope: AdditionalContentExclusionPolicyScope """Allowed values for the `PermissionsConfigureAdditionalContentExclusionPolicyScope` enumeration. @@ -20556,6 +27498,30 @@ def to_dict(self) -> dict: 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 + """Queued message contents and delivery metadata.""" + + 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: @@ -20569,18 +27535,62 @@ class QueuePendingItemsResult: """Display text for messages currently in the immediate steering queue (interjections sent during a running turn). """ + in_flight_steering_count: int | None = None + """How many leading entries of `steeringMessages` have already been folded into the running + turn (and so have an emitted `user.message`), as opposed to still waiting for one. Absent + for hosts that do not distinguish the two. + """ @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) + in_flight_steering_count = from_union([from_int, from_none], obj.get("inFlightSteeringCount")) + return QueuePendingItemsResult(items, steering_messages, in_flight_steering_count) + + 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.in_flight_steering_count is not None: + result["inFlightSteeringCount"] = from_union([from_int, from_none], self.in_flight_steering_count) + 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. @@ -20740,278 +27750,947 @@ def to_dict(self) -> dict: # 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""" +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] + """Ordered SQL statements to execute in one transaction.""" + + @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 + """Opaque policy update timestamp supplied by the host.""" + + rules: list[SessionOpenOptionsAdditionalContentExclusionPolicyRule] + """Content-exclusion rules to apply.""" + + 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.""" + + credentials: ShellCredentials | None = None + """Command-scoped GitHub credential injection for shell commands.""" + + 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) + credentials = from_union([ShellCredentials.from_dict, from_none], obj.get("credentials")) + 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(credentials, init_profile, init_scripts, process_flags) + + def to_dict(self) -> dict: + result: dict = {} + if self.credentials is not None: + result["credentials"] = from_union([lambda x: to_class(ShellCredentials, x), from_none], self.credentials) + 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 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. +# Internal: this type is an internal SDK API and is not part of the public surface. +@dataclass +class _FactoryToolRunRequest: + """Internal parameters for invoking a registered factory from a tool.""" + + args: Any + """Factory input value.""" + + name: str + """Registered factory name.""" + + options: _FactoryToolRunOptions | None = None + """Tool-originated factory invocation options.""" + + tool_call_id: str | None = None + """Opaque identifier of the originating tool call.""" + + @staticmethod + def from_dict(obj: Any) -> '_FactoryToolRunRequest': + assert isinstance(obj, dict) + args = obj.get("args") + name = from_str(obj.get("name")) + options = from_union([_FactoryToolRunOptions.from_dict, from_none], obj.get("options")) + tool_call_id = from_union([from_str, from_none], obj.get("toolCallId")) + return _FactoryToolRunRequest(args, name, options, tool_call_id) + + 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(_FactoryToolRunOptions, x), from_none], self.options) + if self.tool_call_id is not None: + result["toolCallId"] = from_union([from_str, from_none], self.tool_call_id) + return result + +# Experimental: this type is part of an experimental API and may change or be removed. +@dataclass +class MCPSerializableServerConfig: + """MCP server configuration (stdio process or remote HTTP/SSE) + + Serializable MCP server configuration (stdio process or remote HTTP/SSE) + + 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). + + MCP server configuration (stdio process or remote HTTP/SSE). Omit to start the server + with its already-registered configuration (config-free start-by-name). + + Stdio MCP server configuration launched as a child process. + + Remote MCP server configuration accessed over HTTP or SSE. + """ + args: list[str] | None = None + """Command-line arguments passed to the Stdio MCP server process.""" + + auth: bool | MCPServerAuthConfigRedirectPort | None = None + """Set to `true` to use defaults, or provide an object with additional auth or OIDC settings.""" + + command: str | None = None + """Executable command used to start the Stdio MCP server process.""" + + config_warnings: list[str] | None = None + """Configuration warnings recorded while loading the server.""" + + 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_secret_masking: bool | None = None + """Whether secret masking is disabled for calls to this server.""" + + disable_tool_cache: bool | None = None + """Set to true to disable persisted MCP tool snapshots for this server. Live tool discovery + is unaffected. + """ + display_name: str | None = None + """Optional human-readable server name.""" + + env: dict[str, str] | None = None + """Environment variables to pass to the Stdio MCP server process.""" + + events: list[str] | None = None + """Event types this server receives as Copilot notifications.""" + + exclude_tools: list[str] | None = None + """Tool names excluded after the include filter is applied.""" + + 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. + """ + notifications: list[str] | None = None + """Copilot notification types this server may send to the host.""" + + oidc: bool | MCPServerAuthConfigRedirectPort | None = None + """Set to `true` to use defaults, or provide an object with additional auth or OIDC settings.""" + + safe_for_telemetry: bool | MCPSafeForTelemetryFields | None = None + """Telemetry-obfuscation policy for this server's tools.""" + + source: McpServerSource | None = None + """The origin of this server configuration.""" + + source_path: str | None = None + """Source file path recorded while loading the config.""" + + source_plugin: str | None = None + """Plugin that provided this server.""" + + source_plugin_spec: bool | None = None + """Whether the providing plugin uses the Open Plugin Spec.""" + + source_plugin_version: str | None = None + """Version of the plugin that provided this server.""" + + timeout: int | None = None + """Timeout in milliseconds for tool discovery and tool calls.""" + + tools: list[str] | None = None + """Tools to include. Defaults to all tools if not specified.""" + + type: MCPSerializableServerConfigType | None = None + """Local transport type. Defaults to stdio when omitted. + + Remote transport type. Defaults to "http" when omitted. + """ + headers: dict[str, str] | None = None + """HTTP headers to include in requests to the remote MCP server.""" + + headers_refresh_ttl_ms: int | None = None + """Dynamic-header refresh cache lifetime in milliseconds.""" + + oauth_client_id: str | None = None + """OAuth client ID for a pre-registered remote MCP OAuth client.""" + + oauth_grant_type: MCPGrantType | 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.""" + + url: str | None = None + """URL of the remote MCP server endpoint.""" + + @staticmethod + def from_dict(obj: Any) -> 'MCPSerializableServerConfig': + 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")) + config_warnings = from_union([lambda x: from_list(from_str, x), from_none], obj.get("configWarnings")) + cwd = from_union([from_str, from_none], obj.get("cwd")) + defer_tools = from_union([MCPServerConfigDeferTools, from_none], obj.get("deferTools")) + disable_secret_masking = from_union([from_bool, from_none], obj.get("disableSecretMasking")) + disable_tool_cache = from_union([from_bool, from_none], obj.get("disableToolCache")) + display_name = from_union([from_str, from_none], obj.get("displayName")) + env = from_union([lambda x: from_dict(from_str, x), from_none], obj.get("env")) + events = from_union([lambda x: from_list(from_str, x), from_none], obj.get("events")) + exclude_tools = from_union([lambda x: from_list(from_str, x), from_none], obj.get("excludeTools")) + 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")) + notifications = from_union([lambda x: from_list(from_str, x), from_none], obj.get("notifications")) + oidc = from_union([from_bool, MCPServerAuthConfigRedirectPort.from_dict, from_none], obj.get("oidc")) + safe_for_telemetry = from_union([from_bool, MCPSafeForTelemetryFields.from_dict, from_none], obj.get("safeForTelemetry")) + source = from_union([McpServerSource, from_none], obj.get("source")) + source_path = from_union([from_str, from_none], obj.get("sourcePath")) + source_plugin = from_union([from_str, from_none], obj.get("sourcePlugin")) + source_plugin_spec = from_union([from_bool, from_none], obj.get("sourcePluginSpec")) + source_plugin_version = from_union([from_str, from_none], obj.get("sourcePluginVersion")) + 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([MCPSerializableServerConfigType, from_none], obj.get("type")) + headers = from_union([lambda x: from_dict(from_str, x), from_none], obj.get("headers")) + headers_refresh_ttl_ms = from_union([from_int, from_none], obj.get("headersRefreshTtlMs")) + 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")) + url = from_union([from_str, from_none], obj.get("url")) + return MCPSerializableServerConfig(args, auth, command, config_warnings, cwd, defer_tools, disable_secret_masking, disable_tool_cache, display_name, env, events, exclude_tools, filter_mapping, is_default_server, notifications, oidc, safe_for_telemetry, source, source_path, source_plugin, source_plugin_spec, source_plugin_version, timeout, tools, type, headers, headers_refresh_ttl_ms, oauth_client_id, oauth_grant_type, oauth_public_client, url) + + 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.config_warnings is not None: + result["configWarnings"] = from_union([lambda x: from_list(from_str, x), from_none], self.config_warnings) + 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_secret_masking is not None: + result["disableSecretMasking"] = from_union([from_bool, from_none], self.disable_secret_masking) + if self.disable_tool_cache is not None: + result["disableToolCache"] = from_union([from_bool, from_none], self.disable_tool_cache) + if self.display_name is not None: + result["displayName"] = from_union([from_str, from_none], self.display_name) + if self.env is not None: + result["env"] = from_union([lambda x: from_dict(from_str, x), from_none], self.env) + if self.events is not None: + result["events"] = from_union([lambda x: from_list(from_str, x), from_none], self.events) + if self.exclude_tools is not None: + result["excludeTools"] = from_union([lambda x: from_list(from_str, x), from_none], self.exclude_tools) + 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.notifications is not None: + result["notifications"] = from_union([lambda x: from_list(from_str, x), from_none], self.notifications) + if self.oidc is not None: + result["oidc"] = from_union([from_bool, lambda x: to_class(MCPServerAuthConfigRedirectPort, x), from_none], self.oidc) + if self.safe_for_telemetry is not None: + result["safeForTelemetry"] = from_union([from_bool, lambda x: to_class(MCPSafeForTelemetryFields, x), from_none], self.safe_for_telemetry) + if self.source is not None: + result["source"] = from_union([lambda x: to_enum(McpServerSource, x), from_none], self.source) + if self.source_path is not None: + result["sourcePath"] = from_union([from_str, from_none], self.source_path) + if self.source_plugin is not None: + result["sourcePlugin"] = from_union([from_str, from_none], self.source_plugin) + if self.source_plugin_spec is not None: + result["sourcePluginSpec"] = from_union([from_bool, from_none], self.source_plugin_spec) + if self.source_plugin_version is not None: + result["sourcePluginVersion"] = from_union([from_str, from_none], self.source_plugin_version) + 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(MCPSerializableServerConfigType, x), from_none], self.type) + if self.headers is not None: + result["headers"] = from_union([lambda x: from_dict(from_str, x), from_none], self.headers) + if self.headers_refresh_ttl_ms is not None: + result["headersRefreshTtlMs"] = from_union([from_int, from_none], self.headers_refresh_ttl_ms) + 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.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 MCPServerConfigHTTP: + """Remote MCP server configuration accessed over HTTP or SSE.""" - is_directory: bool - """Whether the path is a directory""" + url: str + """URL of the remote MCP server endpoint.""" - is_file: bool - """Whether the path is a file""" + auth: bool | MCPServerAuthConfigRedirectPort | None = None + """Set to `true` to use defaults, or provide an object with additional auth or OIDC settings.""" - mtime: datetime - """ISO 8601 timestamp of last modification""" + config_warnings: list[str] | None = None + """Configuration warnings recorded while loading the server.""" - size: int - """File size in bytes""" + 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_secret_masking: bool | None = None + """Whether secret masking is disabled for calls to this server.""" - error: SessionFSError | None = None - """Describes a filesystem error.""" + disable_tool_cache: bool | None = None + """Set to true to disable persisted MCP tool snapshots for this server. Live tool discovery + is unaffected. + """ + display_name: str | None = None + """Optional human-readable server name.""" - @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) + events: list[str] | None = None + """Event types this server receives as Copilot notifications.""" - 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 + exclude_tools: list[str] | None = None + """Tool names excluded after the include filter is applied.""" -# 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. + 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. """ - last_updated_at: Any - rules: list[SessionOpenOptionsAdditionalContentExclusionPolicyRule] - scope: AdditionalContentExclusionPolicyScope - """Allowed values for the `SessionOpenOptionsAdditionalContentExclusionPolicyScope` - enumeration. + headers: dict[str, str] | None = None + """HTTP headers to include in requests to the remote MCP server.""" + + headers_refresh_ttl_ms: int | None = None + """Dynamic-header refresh cache lifetime in milliseconds.""" + + is_default_server: bool | None = None + """Whether this server is a built-in fallback used when the user has not configured their + own server. """ + notifications: list[str] | None = None + """Copilot notification types this server may send to the host.""" - @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) + oauth_client_id: str | None = None + """OAuth client ID for a pre-registered remote MCP OAuth client.""" - 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 + oauth_grant_type: MCPGrantType | None = None + """OAuth grant type to use when authenticating to the remote MCP server.""" -# 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 + oauth_public_client: bool | None = None + """Whether the configured OAuth client is public and does not require a client secret.""" - @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) + oidc: 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 = {} - 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 + safe_for_telemetry: bool | MCPSafeForTelemetryFields | None = None + """Telemetry-obfuscation policy for this server's tools.""" -# 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.""" + source: McpServerSource | None = None + """The origin of this server configuration.""" - agent: AgentInfo | None = None - """Currently selected custom agent, or null if using the default agent""" + source_path: str | None = None + """Source file path recorded while loading the config.""" - @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) + source_plugin: str | None = None + """Plugin that provided this server.""" - 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 + source_plugin_spec: bool | None = None + """Whether the providing plugin uses the Open Plugin Spec.""" -# Experimental: this type is part of an experimental API and may change or be removed. -@dataclass -class AgentList: - """Custom agents available to the session.""" + source_plugin_version: str | None = None + """Version of the plugin that provided this server.""" - agents: list[AgentInfo] - """Available custom agents""" + timeout: int | None = None + """Timeout in milliseconds for tool discovery and tool calls.""" + + tools: list[str] | None = None + """Tools to include. Defaults to all tools if not specified.""" + + type: MCPServerConfigHTTPType | None = None + """Remote transport type. Defaults to "http" when omitted.""" @staticmethod - def from_dict(obj: Any) -> 'AgentList': + def from_dict(obj: Any) -> 'MCPServerConfigHTTP': assert isinstance(obj, dict) - agents = from_list(AgentInfo.from_dict, obj.get("agents")) - return AgentList(agents) + url = from_str(obj.get("url")) + auth = from_union([from_bool, MCPServerAuthConfigRedirectPort.from_dict, from_none], obj.get("auth")) + config_warnings = from_union([lambda x: from_list(from_str, x), from_none], obj.get("configWarnings")) + defer_tools = from_union([MCPServerConfigDeferTools, from_none], obj.get("deferTools")) + disable_secret_masking = from_union([from_bool, from_none], obj.get("disableSecretMasking")) + disable_tool_cache = from_union([from_bool, from_none], obj.get("disableToolCache")) + display_name = from_union([from_str, from_none], obj.get("displayName")) + events = from_union([lambda x: from_list(from_str, x), from_none], obj.get("events")) + exclude_tools = from_union([lambda x: from_list(from_str, x), from_none], obj.get("excludeTools")) + 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")) + headers_refresh_ttl_ms = from_union([from_int, from_none], obj.get("headersRefreshTtlMs")) + is_default_server = from_union([from_bool, from_none], obj.get("isDefaultServer")) + notifications = from_union([lambda x: from_list(from_str, x), from_none], obj.get("notifications")) + 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")) + safe_for_telemetry = from_union([from_bool, MCPSafeForTelemetryFields.from_dict, from_none], obj.get("safeForTelemetry")) + source = from_union([McpServerSource, from_none], obj.get("source")) + source_path = from_union([from_str, from_none], obj.get("sourcePath")) + source_plugin = from_union([from_str, from_none], obj.get("sourcePlugin")) + source_plugin_spec = from_union([from_bool, from_none], obj.get("sourcePluginSpec")) + source_plugin_version = from_union([from_str, from_none], obj.get("sourcePluginVersion")) + 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, config_warnings, defer_tools, disable_secret_masking, disable_tool_cache, display_name, events, exclude_tools, filter_mapping, headers, headers_refresh_ttl_ms, is_default_server, notifications, oauth_client_id, oauth_grant_type, oauth_public_client, oidc, safe_for_telemetry, source, source_path, source_plugin, source_plugin_spec, source_plugin_version, timeout, tools, type) def to_dict(self) -> dict: result: dict = {} - result["agents"] = from_list(lambda x: to_class(AgentInfo, x), self.agents) + 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.config_warnings is not None: + result["configWarnings"] = from_union([lambda x: from_list(from_str, x), from_none], self.config_warnings) + 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_secret_masking is not None: + result["disableSecretMasking"] = from_union([from_bool, from_none], self.disable_secret_masking) + if self.disable_tool_cache is not None: + result["disableToolCache"] = from_union([from_bool, from_none], self.disable_tool_cache) + if self.display_name is not None: + result["displayName"] = from_union([from_str, from_none], self.display_name) + if self.events is not None: + result["events"] = from_union([lambda x: from_list(from_str, x), from_none], self.events) + if self.exclude_tools is not None: + result["excludeTools"] = from_union([lambda x: from_list(from_str, x), from_none], self.exclude_tools) + 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.headers_refresh_ttl_ms is not None: + result["headersRefreshTtlMs"] = from_union([from_int, from_none], self.headers_refresh_ttl_ms) + if self.is_default_server is not None: + result["isDefaultServer"] = from_union([from_bool, from_none], self.is_default_server) + if self.notifications is not None: + result["notifications"] = from_union([lambda x: from_list(from_str, x), from_none], self.notifications) + 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.safe_for_telemetry is not None: + result["safeForTelemetry"] = from_union([from_bool, lambda x: to_class(MCPSafeForTelemetryFields, x), from_none], self.safe_for_telemetry) + if self.source is not None: + result["source"] = from_union([lambda x: to_enum(McpServerSource, x), from_none], self.source) + if self.source_path is not None: + result["sourcePath"] = from_union([from_str, from_none], self.source_path) + if self.source_plugin is not None: + result["sourcePlugin"] = from_union([from_str, from_none], self.source_plugin) + if self.source_plugin_spec is not None: + result["sourcePluginSpec"] = from_union([from_bool, from_none], self.source_plugin_spec) + if self.source_plugin_version is not None: + result["sourcePluginVersion"] = from_union([from_str, from_none], self.source_plugin_version) + 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 AgentReloadResult: - """Custom agents available to the session after reloading definitions from disk.""" +class MCPServerConfigStdio: + """Stdio MCP server configuration launched as a child process.""" - agents: list[AgentInfo] - """Reloaded custom agents""" + command: str + """Executable command used to start the Stdio MCP server process.""" - @staticmethod - def from_dict(obj: Any) -> 'AgentReloadResult': - assert isinstance(obj, dict) - agents = from_list(AgentInfo.from_dict, obj.get("agents")) - return AgentReloadResult(agents) + args: list[str] | None = None + """Command-line arguments passed to the Stdio MCP server process.""" - def to_dict(self) -> dict: - result: dict = {} - result["agents"] = from_list(lambda x: to_class(AgentInfo, x), self.agents) - return result + auth: bool | MCPServerAuthConfigRedirectPort | None = None + """Set to `true` to use defaults, or provide an object with additional auth or OIDC settings.""" -# Experimental: this type is part of an experimental API and may change or be removed. -@dataclass -class AgentSelectResult: - """The newly selected custom agent.""" + config_warnings: list[str] | None = None + """Configuration warnings recorded while loading the server.""" - agent: AgentInfo - """The newly selected custom agent""" + cwd: str | None = None + """Working directory for the Stdio MCP server process.""" - @staticmethod - def from_dict(obj: Any) -> 'AgentSelectResult': - assert isinstance(obj, dict) - agent = AgentInfo.from_dict(obj.get("agent")) - return AgentSelectResult(agent) + 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_secret_masking: bool | None = None + """Whether secret masking is disabled for calls to this server.""" - def to_dict(self) -> dict: - result: dict = {} - result["agent"] = to_class(AgentInfo, self.agent) - return result + disable_tool_cache: bool | None = None + """Set to true to disable persisted MCP tool snapshots for this server. Live tool discovery + is unaffected. + """ + display_name: str | None = None + """Optional human-readable server name.""" -# 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.""" + env: dict[str, str] | None = None + """Environment variables to pass to the Stdio MCP server process.""" - agents: list[AgentInfo] - """All discovered agents across all sources""" + events: list[str] | None = None + """Event types this server receives as Copilot notifications.""" - @staticmethod - def from_dict(obj: Any) -> 'ServerAgentList': - assert isinstance(obj, dict) - agents = from_list(AgentInfo.from_dict, obj.get("agents")) - return ServerAgentList(agents) + exclude_tools: list[str] | None = None + """Tool names excluded after the include filter is applied.""" - def to_dict(self) -> dict: - result: dict = {} - result["agents"] = from_list(lambda x: to_class(AgentInfo, x), self.agents) - return result + 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. + """ + notifications: list[str] | None = None + """Copilot notification types this server may send to the host.""" -# 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).""" + oidc: bool | MCPServerAuthConfigRedirectPort | None = None + """Set to `true` to use defaults, or provide an object with additional auth or OIDC settings.""" - skills: list[SkillsInvokedSkill] - """Skills invoked during this session, ordered by invocation time (most recent last)""" + safe_for_telemetry: bool | MCPSafeForTelemetryFields | None = None + """Telemetry-obfuscation policy for this server's tools.""" - @staticmethod - def from_dict(obj: Any) -> 'SkillsGetInvokedResult': - assert isinstance(obj, dict) - skills = from_list(SkillsInvokedSkill.from_dict, obj.get("skills")) - return SkillsGetInvokedResult(skills) + source: McpServerSource | None = None + """The origin of this server configuration.""" - def to_dict(self) -> dict: - result: dict = {} - result["skills"] = from_list(lambda x: to_class(SkillsInvokedSkill, x), self.skills) - return result + source_path: str | None = None + """Source file path recorded while loading the config.""" -# 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.""" + source_plugin: str | None = None + """Plugin that provided this server.""" - paths: list[SkillDiscoveryPath] - """Canonical skill create/discovery directories, in priority order""" + source_plugin_spec: bool | None = None + """Whether the providing plugin uses the Open Plugin Spec.""" - @staticmethod - def from_dict(obj: Any) -> 'SkillDiscoveryPathList': - assert isinstance(obj, dict) - paths = from_list(SkillDiscoveryPath.from_dict, obj.get("paths")) - return SkillDiscoveryPathList(paths) + source_plugin_version: str | None = None + """Version of the plugin that provided this server.""" - def to_dict(self) -> dict: - result: dict = {} - result["paths"] = from_list(lambda x: to_class(SkillDiscoveryPath, x), self.paths) - return result + timeout: int | None = None + """Timeout in milliseconds for tool discovery and tool calls.""" -# 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.""" + tools: list[str] | None = None + """Tools to include. Defaults to all tools if not specified.""" - progress: TaskProgress | None = None - """Progress information for the task, discriminated by type. Returns null when no task with - this ID is currently tracked. - """ + type: MCPServerConfigStdioType | None = None + """Local transport type. Defaults to stdio when omitted.""" @staticmethod - def from_dict(obj: Any) -> 'TasksGetProgressResult': + def from_dict(obj: Any) -> 'MCPServerConfigStdio': assert isinstance(obj, dict) - progress = from_union([TaskProgress.from_dict, from_none], obj.get("progress")) - return TasksGetProgressResult(progress) + 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")) + config_warnings = from_union([lambda x: from_list(from_str, x), from_none], obj.get("configWarnings")) + cwd = from_union([from_str, from_none], obj.get("cwd")) + defer_tools = from_union([MCPServerConfigDeferTools, from_none], obj.get("deferTools")) + disable_secret_masking = from_union([from_bool, from_none], obj.get("disableSecretMasking")) + disable_tool_cache = from_union([from_bool, from_none], obj.get("disableToolCache")) + display_name = from_union([from_str, from_none], obj.get("displayName")) + env = from_union([lambda x: from_dict(from_str, x), from_none], obj.get("env")) + events = from_union([lambda x: from_list(from_str, x), from_none], obj.get("events")) + exclude_tools = from_union([lambda x: from_list(from_str, x), from_none], obj.get("excludeTools")) + 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")) + notifications = from_union([lambda x: from_list(from_str, x), from_none], obj.get("notifications")) + oidc = from_union([from_bool, MCPServerAuthConfigRedirectPort.from_dict, from_none], obj.get("oidc")) + safe_for_telemetry = from_union([from_bool, MCPSafeForTelemetryFields.from_dict, from_none], obj.get("safeForTelemetry")) + source = from_union([McpServerSource, from_none], obj.get("source")) + source_path = from_union([from_str, from_none], obj.get("sourcePath")) + source_plugin = from_union([from_str, from_none], obj.get("sourcePlugin")) + source_plugin_spec = from_union([from_bool, from_none], obj.get("sourcePluginSpec")) + source_plugin_version = from_union([from_str, from_none], obj.get("sourcePluginVersion")) + 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([MCPServerConfigStdioType, from_none], obj.get("type")) + return MCPServerConfigStdio(command, args, auth, config_warnings, cwd, defer_tools, disable_secret_masking, disable_tool_cache, display_name, env, events, exclude_tools, filter_mapping, is_default_server, notifications, oidc, safe_for_telemetry, source, source_path, source_plugin, source_plugin_spec, source_plugin_version, timeout, tools, type) 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) + 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.config_warnings is not None: + result["configWarnings"] = from_union([lambda x: from_list(from_str, x), from_none], self.config_warnings) + 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_secret_masking is not None: + result["disableSecretMasking"] = from_union([from_bool, from_none], self.disable_secret_masking) + if self.disable_tool_cache is not None: + result["disableToolCache"] = from_union([from_bool, from_none], self.disable_tool_cache) + if self.display_name is not None: + result["displayName"] = from_union([from_str, from_none], self.display_name) + if self.env is not None: + result["env"] = from_union([lambda x: from_dict(from_str, x), from_none], self.env) + if self.events is not None: + result["events"] = from_union([lambda x: from_list(from_str, x), from_none], self.events) + if self.exclude_tools is not None: + result["excludeTools"] = from_union([lambda x: from_list(from_str, x), from_none], self.exclude_tools) + 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.notifications is not None: + result["notifications"] = from_union([lambda x: from_list(from_str, x), from_none], self.notifications) + if self.oidc is not None: + result["oidc"] = from_union([from_bool, lambda x: to_class(MCPServerAuthConfigRedirectPort, x), from_none], self.oidc) + if self.safe_for_telemetry is not None: + result["safeForTelemetry"] = from_union([from_bool, lambda x: to_class(MCPSafeForTelemetryFields, x), from_none], self.safe_for_telemetry) + if self.source is not None: + result["source"] = from_union([lambda x: to_enum(McpServerSource, x), from_none], self.source) + if self.source_path is not None: + result["sourcePath"] = from_union([from_str, from_none], self.source_path) + if self.source_plugin is not None: + result["sourcePlugin"] = from_union([from_str, from_none], self.source_plugin) + if self.source_plugin_spec is not None: + result["sourcePluginSpec"] = from_union([from_bool, from_none], self.source_plugin_spec) + if self.source_plugin_version is not None: + result["sourcePluginVersion"] = from_union([from_str, from_none], self.source_plugin_version) + 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(MCPServerConfigStdioType, x), from_none], self.type) return result # Experimental: this type is part of an experimental API and may change or be removed. @@ -21048,6 +28727,62 @@ def to_dict(self) -> dict: 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 ToolsGetBuiltinDescriptorsRequest: + """Options controlling how Rust-owned built-in tool descriptors are materialized.""" + + background_task_notifications_enabled: bool | None = None + """Whether background task completion notifications are enabled.""" + + include_author: bool | None = None + """Whether tool descriptors should include authoring metadata.""" + + reduce_user_intervention: bool | None = None + """Whether descriptors should favor fewer user-intervention prompts.""" + + shell_config: ToolsShellDescriptorConfig | None = None + """Shell-specific names and description lines for shell tools.""" + + shell_supports_power_shell7_syntax: bool | None = None + """Whether the configured shell supports PowerShell 7 syntax.""" + + shell_timeout_ms: float | None = None + """Default shell timeout in milliseconds.""" + + skill_embedding_enabled: bool | None = None + """Whether semantic skill lookup is available.""" + + @staticmethod + def from_dict(obj: Any) -> 'ToolsGetBuiltinDescriptorsRequest': + assert isinstance(obj, dict) + background_task_notifications_enabled = from_union([from_bool, from_none], obj.get("backgroundTaskNotificationsEnabled")) + include_author = from_union([from_bool, from_none], obj.get("includeAuthor")) + reduce_user_intervention = from_union([from_bool, from_none], obj.get("reduceUserIntervention")) + shell_config = from_union([ToolsShellDescriptorConfig.from_dict, from_none], obj.get("shellConfig")) + shell_supports_power_shell7_syntax = from_union([from_bool, from_none], obj.get("shellSupportsPowerShell7Syntax")) + shell_timeout_ms = from_union([from_float, from_none], obj.get("shellTimeoutMs")) + skill_embedding_enabled = from_union([from_bool, from_none], obj.get("skillEmbeddingEnabled")) + return ToolsGetBuiltinDescriptorsRequest(background_task_notifications_enabled, include_author, reduce_user_intervention, shell_config, shell_supports_power_shell7_syntax, shell_timeout_ms, skill_embedding_enabled) + + def to_dict(self) -> dict: + result: dict = {} + if self.background_task_notifications_enabled is not None: + result["backgroundTaskNotificationsEnabled"] = from_union([from_bool, from_none], self.background_task_notifications_enabled) + if self.include_author is not None: + result["includeAuthor"] = from_union([from_bool, from_none], self.include_author) + if self.reduce_user_intervention is not None: + result["reduceUserIntervention"] = from_union([from_bool, from_none], self.reduce_user_intervention) + if self.shell_config is not None: + result["shellConfig"] = from_union([lambda x: to_class(ToolsShellDescriptorConfig, x), from_none], self.shell_config) + if self.shell_supports_power_shell7_syntax is not None: + result["shellSupportsPowerShell7Syntax"] = from_union([from_bool, from_none], self.shell_supports_power_shell7_syntax) + if self.shell_timeout_ms is not None: + result["shellTimeoutMs"] = from_union([to_float, from_none], self.shell_timeout_ms) + if self.skill_embedding_enabled is not None: + result["skillEmbeddingEnabled"] = from_union([from_bool, from_none], self.skill_embedding_enabled) + return result + # Experimental: this type is part of an experimental API and may change or be removed. @dataclass class UIElicitationArrayAnyOfField: @@ -21361,76 +29096,47 @@ def to_dict(self) -> dict: # 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 UsageMetricsAgentMetric: + """Usage attributed to one agent instance, including its identity, API duration, AI units, + and per-model breakdown. """ - 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""" + """Per-model usage for this agent, keyed by model identifier""" 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""" + """Time spent in model API calls by this agent, in milliseconds""" - token_details: dict[str, UsageMetricsTokenDetail] | None = None - """Session-wide per-token-type accumulated token counts""" + total_nano_aiu: float + """Accumulated nano-AI units cost for this agent""" - total_nano_aiu: float | None = None - """Session-wide accumulated nano-AI units cost""" + agent_display_name: str | None = None + """Human-readable label for this subagent invocation, copied from the originating + `subagent.started` event. For task-tool subagents this is the invocation's task + description rather than the agent's configured display name, so group by `agentName` for + stable per-agent labels. + """ + agent_name: str | None = None + """Configured agent name, when this is a subagent""" @staticmethod - def from_dict(obj: Any) -> 'UsageGetMetricsResult': + def from_dict(obj: Any) -> 'UsageMetricsAgentMetric': 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) + total_nano_aiu = from_float(obj.get("totalNanoAiu")) + agent_display_name = from_union([from_str, from_none], obj.get("agentDisplayName")) + agent_name = from_union([from_str, from_none], obj.get("agentName")) + return UsageMetricsAgentMetric(model_metrics, total_api_duration_ms, total_nano_aiu, agent_display_name, agent_name) 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["totalNanoAiu"] = to_float(self.total_nano_aiu) + if self.agent_display_name is not None: + result["agentDisplayName"] = from_union([from_str, from_none], self.agent_display_name) + if self.agent_name is not None: + result["agentName"] = from_union([from_str, from_none], self.agent_name) return result # Experimental: this type is part of an experimental API and may change or be removed. @@ -21442,8 +29148,9 @@ class WorkspaceDiffResult: """Changed files and their unified diffs.""" is_fallback: bool - """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. + """ mode: WorkspaceDiffMode """Effective mode used for the returned changes.""" @@ -21453,6 +29160,16 @@ class WorkspaceDiffResult: 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) @@ -21461,7 +29178,8 @@ def from_dict(obj: Any) -> 'WorkspaceDiffResult': 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) + 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 = {} @@ -21471,6 +29189,92 @@ def to_dict(self) -> dict: 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 MCPInstallPlan: + """A normalised, inert description of what installing an MCP server would involve. Carries + no raw card, no install specification, and no secret value. + + The normalised plan. + """ + configuration_changes: list[MCPPlanConfigurationChange] + """The configuration changes installing would make, described rather than serialised, so the + mutable configuration payload stays behind the runtime boundary. + """ + identity: MCPPlanResourceIdentity + """Normalised identity of the server the plan would install.""" + + plan_handle: str + """Opaque, runtime-instance scoped, TTL-bound, single-use handle for this plan. Rejected + when stale, replayed, or presented to a different runtime instance. Never logged. + """ + plan_handle_expires_at: str + """ISO 8601 timestamp after which the plan handle is stale and will be rejected. Abandoning + a plan needs no call: an unused handle simply expires, so cancellation before commit is + side-effect free. + """ + policy: MCPPlanPolicyResult + """Outcome of evaluating the server against registry and enterprise policy.""" + + provenance: MCPPlanProvenance + """Origin and semantic digest of the exact validated JSON MCP card content bound to this + plan. + """ + reload_required: bool + """Whether applying this plan would require an MCP reload to take effect. Planning itself + never reloads. + """ + requires_interactive_configuration: bool + """Whether the plan cannot be applied without further input, because a required value has no + default or a secret must be supplied. + """ + target: MCPPlanTarget + """Configuration scope and key the plan would write to.""" + + transport_choices: list[MCPPlanTransportChoice] + """Every eligible transport, so a host can present an explicit choice. A completed plan + always has at least one; when none is eligible, planning returns + `CatalogUnavailableTransportError` instead. + """ + recommended_transport_choice_id: str | None = None + """Identifier of the choice the runtime would pick by default. Omitted when there is no + eligible transport, or when the runtime expresses no preference. + """ + + @staticmethod + def from_dict(obj: Any) -> 'MCPInstallPlan': + assert isinstance(obj, dict) + configuration_changes = from_list(MCPPlanConfigurationChange.from_dict, obj.get("configurationChanges")) + identity = MCPPlanResourceIdentity.from_dict(obj.get("identity")) + plan_handle = from_str(obj.get("planHandle")) + plan_handle_expires_at = from_str(obj.get("planHandleExpiresAt")) + policy = MCPPlanPolicyResult.from_dict(obj.get("policy")) + provenance = MCPPlanProvenance.from_dict(obj.get("provenance")) + reload_required = from_bool(obj.get("reloadRequired")) + requires_interactive_configuration = from_bool(obj.get("requiresInteractiveConfiguration")) + target = MCPPlanTarget.from_dict(obj.get("target")) + transport_choices = from_list(_load_MCPPlanTransportChoice, obj.get("transportChoices")) + recommended_transport_choice_id = from_union([from_str, from_none], obj.get("recommendedTransportChoiceId")) + return MCPInstallPlan(configuration_changes, identity, plan_handle, plan_handle_expires_at, policy, provenance, reload_required, requires_interactive_configuration, target, transport_choices, recommended_transport_choice_id) + + def to_dict(self) -> dict: + result: dict = {} + result["configurationChanges"] = from_list(lambda x: to_class(MCPPlanConfigurationChange, x), self.configuration_changes) + result["identity"] = to_class(MCPPlanResourceIdentity, self.identity) + result["planHandle"] = from_str(self.plan_handle) + result["planHandleExpiresAt"] = from_str(self.plan_handle_expires_at) + result["policy"] = to_class(MCPPlanPolicyResult, self.policy) + result["provenance"] = to_class(MCPPlanProvenance, self.provenance) + result["reloadRequired"] = from_bool(self.reload_required) + result["requiresInteractiveConfiguration"] = from_bool(self.requires_interactive_configuration) + result["target"] = to_class(MCPPlanTarget, self.target) + result["transportChoices"] = from_list(lambda x: (x).to_dict(), self.transport_choices) + if self.recommended_transport_choice_id is not None: + result["recommendedTransportChoiceId"] = from_union([from_str, from_none], self.recommended_transport_choice_id) return result # Experimental: this type is part of an experimental API and may change or be removed. @@ -21647,6 +29451,50 @@ def to_dict(self) -> dict: 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 CatalogSearchSucceeded: + """A completed catalog search: inert candidate summaries, each carrying a single-use handle.""" + + candidates: list[CatalogCandidate] + """Matching candidates, never more than the requested limit. All text is inert untrusted + data. + """ + kind: ClassVar[str] = "succeeded" + """Discriminator: the search completed""" + + negotiated: CatalogNegotiatedContract + """Protocol version and capabilities the runtime honoured.""" + + search_id: str + """Pseudonymous identifier for this search, issued by the runtime or by the catalog + authority it queried and never by the caller, so it cannot be forged or replayed to + attribute an install to a search that never happened. Always present on a success, so a + result set can be tied to the installs it leads to. It identifies a search rather than a + person: it is derived from no user, account, device, or query data, and must never be + joined with user identity to re-identify anyone. + """ + truncated: bool + """Whether further matches existed beyond the requested limit.""" + + @staticmethod + def from_dict(obj: Any) -> 'CatalogSearchSucceeded': + assert isinstance(obj, dict) + candidates = from_list(CatalogCandidate.from_dict, obj.get("candidates")) + negotiated = CatalogNegotiatedContract.from_dict(obj.get("negotiated")) + search_id = from_str(obj.get("searchId")) + truncated = from_bool(obj.get("truncated")) + return CatalogSearchSucceeded(candidates, negotiated, search_id, truncated) + + def to_dict(self) -> dict: + result: dict = {} + result["candidates"] = from_list(lambda x: to_class(CatalogCandidate, x), self.candidates) + result["kind"] = self.kind + result["negotiated"] = to_class(CatalogNegotiatedContract, self.negotiated) + result["searchId"] = from_str(self.search_id) + result["truncated"] = from_bool(self.truncated) + return result + # Experimental: this type is part of an experimental API and may change or be removed. @dataclass class HandlePendingToolCallRequest: @@ -21679,6 +29527,164 @@ def to_dict(self) -> dict: 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 ToolsTaskCompleteEventDataRequest: + """Task-completion tool arguments and final result used to build a label-safe session event + payload. + """ + final_result: ToolResultExpanded + """Final expanded result returned by the task_complete tool.""" + + tool_args: Any + """Arguments supplied to the completed task_complete tool call.""" + + @staticmethod + def from_dict(obj: Any) -> 'ToolsTaskCompleteEventDataRequest': + assert isinstance(obj, dict) + final_result = ToolResultExpanded.from_dict(obj.get("finalResult")) + tool_args = obj.get("toolArgs") + return ToolsTaskCompleteEventDataRequest(final_result, tool_args) + + def to_dict(self) -> dict: + result: dict = {} + result["finalResult"] = to_class(ToolResultExpanded, self.final_result) + result["toolArgs"] = self.tool_args + 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 + """Durable resource consumption.""" + + created_at: int + """Epoch milliseconds when the run was created.""" + + declared_limits: FactoryDeclaredLimits + """Resource ceilings declared by the factory.""" + + declared_phase_count: int + """Number of phases declared by the factory.""" + + description: str + """Human-readable factory description.""" + + factory_name: str + """Registered factory name.""" + + live_agent_count: int + """Number of direct factory agents currently live.""" + + observed_at: int + """Epoch milliseconds when this live-overlay snapshot was observed.""" + + revision: int + """Monotonic durable run revision.""" + + run_id: str + """Factory run identifier.""" + + status: FactoryRunStatus + """Current factory run status.""" + + total_spawned_agent_count: int + """Total direct factory agents spawned across all attempts.""" + + updated_at: int + """Epoch milliseconds when the durable run was last updated.""" + + active_segment_started_at: int | None = None + """Epoch milliseconds when the current active segment started, or null while inactive.""" + + approved: FactoryDeclaredLimits | None = None + """Approved effective resource ceilings, or null until approved.""" + + completed_at: int | None = None + """Epoch milliseconds when the run completed, or null while nonterminal.""" + + current_phase: FactoryCurrentPhase | None = None + """Current phase identity, or null before any phase is entered.""" + + started_at: int | None = None + """Epoch milliseconds when execution first started, or null before start.""" + + terminal: FactoryRunTerminal | None = None + """Terminal run outcome, or null while nonterminal.""" + + @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 SessionsSetAdditionalPluginsRequest: @@ -21743,6 +29749,26 @@ def to_dict(self) -> 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: @@ -22019,7 +30045,7 @@ class ProviderModelConfig: in the model list and passed to switchTo) is the provider-qualified `provider/id`. """ provider: str - """Name of the NamedProviderConfig that serves this model.""" + """Name of the configured provider that serves this model.""" capabilities: ModelCapabilitiesOverride | None = None """Optional capability overrides (vision, tool_calls, reasoning, etc.).""" @@ -22077,6 +30103,128 @@ def to_dict(self) -> dict: 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 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_capabilities: ModelCapabilitiesOverride | None = None + """Overrides for model capabilities when they cannot be inferred from modelId.""" + + 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. + """ + provider_name: str | None = None + """Provider name used for model and telemetry attribution.""" + + 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_capabilities = from_union([ModelCapabilitiesOverride.from_dict, from_none], obj.get("modelCapabilities")) + model_id = from_union([from_str, from_none], obj.get("modelId")) + provider_name = from_union([from_str, from_none], obj.get("providerName")) + 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_capabilities, model_id, provider_name, 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_capabilities is not None: + result["modelCapabilities"] = from_union([lambda x: to_class(ModelCapabilitiesOverride, x), from_none], self.model_capabilities) + if self.model_id is not None: + result["modelId"] = from_union([from_str, from_none], self.model_id) + if self.provider_name is not None: + result["providerName"] = from_union([from_str, from_none], self.provider_name) + 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 PermissionsConfigureParams: @@ -22148,15 +30296,22 @@ class SandboxConfig: add_current_working_directory: bool | None = None """Whether to auto-add the current working directory to readwritePaths. Default: true.""" - gh_auth: 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_auth: bool | None = None - """Whether to inject the Copilot GitHub token as an `http..extraheader` so - authenticated HTTPS git works inside the sandbox without the shell-based credential - helper the sandbox blocks. Default: false (opt-in). - """ + allow_dev_tool_access: bool | None = None + """Whether to auto-grant read access to tool directories discovered on PATH and in toolchain + environment variables (GOROOT, JAVA_HOME, VIRTUAL_ENV, and similar), and to common + developer-tool caches, config, and toolchains. Writable grants cover scratch caches, the + Unix GitHub CLI cache, and Cargo's registry, git store, and lock/tracker files. A + relocated CARGO_HOME gets the same narrow split: registry and git are read-write; bin is + read-only; the home root, config.toml, and credentials.toml stay ungranted. Set to false + to disable every grant listed above; user-installed toolchains and caches then need + explicit userPolicy.filesystem readonlyPaths and readwritePaths entries. The working + directory (see addCurrentWorkingDirectory), temporary storage, session log paths, and + system locations follow their own rules and stay granted. 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.""" @@ -22165,24 +30320,172 @@ 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")) - gh_auth = from_union([from_bool, from_none], obj.get("ghAuth")) - git_auth = from_union([from_bool, from_none], obj.get("gitAuth")) + 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, gh_auth, git_auth, user_policy) + 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.gh_auth is not None: - result["ghAuth"] = from_union([from_bool, from_none], self.gh_auth) - if self.git_auth is not None: - result["gitAuth"] = from_union([from_bool, from_none], self.git_auth) + 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] + """Per-statement query results in input order.""" + + error: SessionFSSqliteTransactionError | None = None + """Classified transaction failure, when execution did not succeed.""" + + @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 MCPConfigAddRequest: + """MCP server name and configuration to add to user configuration.""" + + config: MCPSerializableServerConfig + """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 = MCPSerializableServerConfig.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(MCPSerializableServerConfig, 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, MCPSerializableServerConfig] + """All MCP servers from user config, keyed by name""" + + @staticmethod + def from_dict(obj: Any) -> 'MCPConfigList': + assert isinstance(obj, dict) + servers = from_dict(MCPSerializableServerConfig.from_dict, obj.get("servers")) + return MCPConfigList(servers) + + def to_dict(self) -> dict: + result: dict = {} + result["servers"] = from_dict(lambda x: to_class(MCPSerializableServerConfig, 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: MCPSerializableServerConfig + """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 = MCPSerializableServerConfig.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(MCPSerializableServerConfig, 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: MCPSerializableServerConfig | 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([MCPSerializableServerConfig.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(MCPSerializableServerConfig, 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: MCPSerializableServerConfig | 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([MCPSerializableServerConfig.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(MCPSerializableServerConfig, x), from_none], self.config) + return result + # Experimental: this type is part of an experimental API and may change or be removed. @dataclass class MCPListToolsResult: @@ -22210,7 +30513,7 @@ class UIElicitationSchema: properties: dict[str, UIElicitationSchemaProperty] """Form field definitions, keyed by field name""" - type: UIElicitationSchemaType + type: BuiltinToolInputSchemaType """Schema type indicator (always 'object')""" required: list[str] | None = None @@ -22220,18 +30523,171 @@ class UIElicitationSchema: def from_dict(obj: Any) -> 'UIElicitationSchema': assert isinstance(obj, dict) properties = from_dict(UIElicitationSchemaProperty.from_dict, obj.get("properties")) - type = UIElicitationSchemaType(obj.get("type")) + type = BuiltinToolInputSchemaType(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) + result["type"] = to_enum(BuiltinToolInputSchemaType, 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 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""" + + agent_metrics: dict[str, UsageMetricsAgentMetric] | None = None + """Per-agent usage metrics, keyed by agent instance identifier. The main conversation uses + the stable key `main`. + """ + 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")) + agent_metrics = from_union([lambda x: from_dict(UsageMetricsAgentMetric.from_dict, x), from_none], obj.get("agentMetrics")) + 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, agent_metrics, 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.agent_metrics is not None: + result["agentMetrics"] = from_union([lambda x: from_dict(lambda x: to_class(UsageMetricsAgentMetric, x), x), from_none], self.agent_metrics) + 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 MCPPlanInstallPlanned: + """A computed MCP install plan. Nothing has been applied: the plan describes what installing + would change, and the plan handle is what a later apply operation would consume. + """ + kind: ClassVar[str] = "planned" + """Discriminator: a plan was computed and nothing was changed""" + + negotiated: CatalogNegotiatedContract + """Protocol version and capabilities the runtime honoured.""" + + plan: MCPInstallPlan + """The normalised plan.""" + + @staticmethod + def from_dict(obj: Any) -> 'MCPPlanInstallPlanned': + assert isinstance(obj, dict) + negotiated = CatalogNegotiatedContract.from_dict(obj.get("negotiated")) + plan = MCPInstallPlan.from_dict(obj.get("plan")) + return MCPPlanInstallPlanned(negotiated, plan) + + def to_dict(self) -> dict: + result: dict = {} + result["kind"] = self.kind + result["negotiated"] = to_class(CatalogNegotiatedContract, self.negotiated) + result["plan"] = to_class(MCPInstallPlan, self.plan) + 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] + """Factory run summaries in durable creation order.""" + + 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 ProviderAddRequest: @@ -22279,6 +30735,19 @@ class SessionOpenOptions: 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). Conventional `.github/skills/` and `.github/agents/` + definitions under each directory also join the session's project catalogs when their + existing subsystem gates are enabled: added-root skills require both + `enableConfigDiscovery` and effective `enableSkills`; added-root agents require + `enableConfigDiscovery`. Supplying a directory therefore activates configuration from it + and should be treated as a trust decision. 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 during session creation and cold + resume and is not persisted, so a cold resume must re-supply the directories. + """ agent_context: str | None = None """Runtime context discriminator for agent filtering.""" @@ -22328,13 +30797,39 @@ class SessionOpenOptions: 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. + """Experimental: enable native model citations for supported Anthropic and OpenAI models, + 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.""" @@ -22354,6 +30849,9 @@ class SessionOpenOptions: 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 @@ -22377,6 +30875,11 @@ class SessionOpenOptions: are available, subject to runtime availability and exclusions. Custom agents with the same name remain available. """ + included_builtin_skills: list[str] | None = None + """Built-in skill names to include in this session. When specified, only these + runtime-bundled skills are available. Skills from other sources with the same name remain + available. + """ installed_plugins: list[InstalledPlugin] | None = None """Installed plugins visible to the session.""" @@ -22392,6 +30895,10 @@ class SessionOpenOptions: 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). @@ -22420,8 +30927,10 @@ class SessionOpenOptions: rejected. """ reasoning_effort: str | None = None - """Initial reasoning effort level.""" - + """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.""" @@ -22440,6 +30949,11 @@ class SessionOpenOptions: sandbox_config: SandboxConfig | None = None """Resolved sandbox configuration.""" + # Internal: this field is an internal SDK API and is not part of the public surface. + sandbox_config_source: _SandboxConfigSource | None = None + """Origin of the sandbox choice. The runtime uses this only for internal telemetry + provenance; managed policy is derived independently. + """ session_capabilities: list[SessionCapability] | None = None """Capabilities enabled for this session.""" @@ -22449,11 +30963,14 @@ class SessionOpenOptions: 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 - """Shell init profile.""" + """Use shell.initProfile instead. Shell init profile.""" shell_process_flags: list[str] | None = None - """Per-shell process flags.""" + """PowerShell process flags applied to built-in and user-requested shell commands.""" skill_directories: list[str] | None = None """Additional directories to search for skills.""" @@ -22477,6 +30994,7 @@ class SessionOpenOptions: 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")) @@ -22493,24 +31011,29 @@ def from_dict(obj: Any) -> 'SessionOpenOptions': 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")) + included_builtin_skills = from_union([lambda x: from_list(from_str, x), from_none], obj.get("includedBuiltinSkills")) 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")) @@ -22526,9 +31049,11 @@ def from_dict(obj: Any) -> 'SessionOpenOptions': 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")) + sandbox_config_source = from_union([_SandboxConfigSource, from_none], obj.get("sandboxConfigSource")) 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")) @@ -22537,12 +31062,14 @@ def from_dict(obj: Any) -> 'SessionOpenOptions': 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, 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_skills, enable_citations, enable_managed_settings, enable_on_demand_instruction_discovery, enable_script_safety, enable_streaming, env_value_mode, events_log_directory, 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, 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_init_profile, shell_process_flags, skill_directories, skip_custom_instructions, trajectory_file, verbosity, working_directory, working_directory_context) + 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, included_builtin_skills, 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, sandbox_config_source, 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: @@ -22575,10 +31102,14 @@ def to_dict(self) -> dict: 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: @@ -22591,6 +31122,8 @@ def to_dict(self) -> dict: 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: @@ -22601,6 +31134,8 @@ def to_dict(self) -> dict: 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.included_builtin_skills is not None: + result["includedBuiltinSkills"] = from_union([lambda x: from_list(from_str, x), from_none], self.included_builtin_skills) 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: @@ -22611,6 +31146,8 @@ def to_dict(self) -> dict: 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: @@ -22641,12 +31178,16 @@ def to_dict(self) -> dict: 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.sandbox_config_source is not None: + result["sandboxConfigSource"] = from_union([lambda x: to_enum(_SandboxConfigSource, x), from_none], self.sandbox_config_source) 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: @@ -22726,7 +31267,7 @@ class SessionUpdateOptionsParams: 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. + `skipCustomInstructions`. """ enable_reasoning_summaries: bool | None = None """Whether to surface reasoning-summary events from the model.""" @@ -22752,6 +31293,9 @@ class SessionUpdateOptionsParams: """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 @@ -22768,6 +31312,11 @@ class SessionUpdateOptionsParams: are available, subject to runtime availability and exclusions. Custom agents with the same name remain available. Set to null to remove the allowlist restriction. """ + included_builtin_skills: list[str] | None = None + """Built-in skill names to include in this session. When specified, only these + runtime-bundled skills are available. Skills from other sources 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. @@ -22808,8 +31357,10 @@ class SessionUpdateOptionsParams: """Custom model-provider configuration (BYOK).""" reasoning_effort: str | None = None - """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. + """ reasoning_summary: ReasoningSummary | None = None """Reasoning summary mode for supported model clients.""" @@ -22819,6 +31370,11 @@ class SessionUpdateOptionsParams: sandbox_config: SandboxConfig | None = None """Resolved sandbox configuration.""" + # Internal: this field is an internal SDK API and is not part of the public surface. + sandbox_config_source: _SandboxConfigSource | None = None + """Origin of the sandbox choice. The runtime uses this only for internal telemetry + provenance; managed policy is derived independently. + """ 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 @@ -22827,11 +31383,14 @@ class SessionUpdateOptionsParams: 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 - """Shell init profile (`None` or `NonInteractive`).""" + """Use shell.initProfile instead. Shell init profile (`None` or `NonInteractive`).""" shell_process_flags: list[str] | None = None - """Per-shell process flags (e.g., `pwsh` arguments).""" + """PowerShell process flags applied to built-in and user-requested shell commands.""" skill_directories: list[str] | None = None """Additional directories to search for skills.""" @@ -22887,10 +31446,12 @@ def from_dict(obj: Any) -> 'SessionUpdateOptionsParams': 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")) + included_builtin_skills = from_union([lambda x: from_list(from_str, x), from_none], obj.get("includedBuiltinSkills")) 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")) @@ -22906,8 +31467,10 @@ def from_dict(obj: Any) -> 'SessionUpdateOptionsParams': 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")) + sandbox_config_source = from_union([_SandboxConfigSource, from_none], obj.get("sandboxConfigSource")) 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")) @@ -22918,7 +31481,7 @@ def from_dict(obj: Any) -> 'SessionUpdateOptionsParams': 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, 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_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) + 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, included_builtin_skills, 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, sandbox_config_source, 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 = {} @@ -22970,6 +31533,8 @@ def to_dict(self) -> dict: 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: @@ -22978,6 +31543,8 @@ def to_dict(self) -> dict: 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.included_builtin_skills is not None: + result["includedBuiltinSkills"] = from_union([lambda x: from_list(from_str, x), from_none], self.included_builtin_skills) 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: @@ -23008,10 +31575,14 @@ def to_dict(self) -> dict: 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.sandbox_config_source is not None: + result["sandboxConfigSource"] = from_union([lambda x: to_enum(_SandboxConfigSource, x), from_none], self.sandbox_config_source) 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: @@ -23045,17 +31616,35 @@ class UIElicitationRequest: requested_schema: UIElicitationSchema """JSON Schema describing the form fields to present to the user""" + meta: dict[str, Any] | None = None + """MCP request metadata.""" + + mode: MCPElicitationFormMode | None = None + """Elicitation mode. Omitted and form are equivalent for structured elicitation.""" + + task: MCPTaskMetadata | None = None + """MCP task metadata.""" + @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) + meta = from_union([lambda x: from_dict(lambda x: x, x), from_none], obj.get("_meta")) + mode = from_union([MCPElicitationFormMode, from_none], obj.get("mode")) + task = from_union([MCPTaskMetadata.from_dict, from_none], obj.get("task")) + return UIElicitationRequest(message, requested_schema, meta, mode, task) def to_dict(self) -> dict: result: dict = {} result["message"] = from_str(self.message) result["requestedSchema"] = to_class(UIElicitationSchema, self.requested_schema) + if self.meta is not None: + result["_meta"] = from_union([lambda x: from_dict(lambda x: x, x), from_none], self.meta) + if self.mode is not None: + result["mode"] = from_union([lambda x: to_enum(MCPElicitationFormMode, x), from_none], self.mode) + if self.task is not None: + result["task"] = from_union([lambda x: to_class(MCPTaskMetadata, x), from_none], self.task) return result # Experimental: this type is part of an experimental API and may change or be removed. @@ -23206,6 +31795,10 @@ 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. + + Snapshot of the authenticated user's Copilot subscription info, if known. + + Snapshot of the authenticated user's Copilot subscription info, if known """ access_type_sku: str | None = None """Copilot access SKU identifier (e.g. `free_limited_copilot`, @@ -23601,8 +32194,8 @@ def to_dict(self) -> dict: # 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. + """Authentication-info input variant for API-key authentication to a non-GitHub LLM + provider, carrying the secret `apiKey` and host. """ api_key: str """The API key. Treat as a secret.""" @@ -23636,6 +32229,120 @@ def to_dict(self) -> dict: 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 AuthIdentity: + """Credential-free authentication identity safe to expose to hosts and user interfaces.""" + + host: str + """Authentication host""" + + type: AuthInfoType + """Authentication type""" + + copilot_user: CopilotUserResponse | None = None + """Snapshot of the authenticated user's Copilot subscription info, if known""" + + env_var: str | None = None + """Name of the environment variable that supplied the credential, when applicable""" + + login: str | None = None + """Authenticated login, when available""" + + registration_id: str | None = None + """Opaque SDK GitHub credential registration backing this identity. Routing metadata only; + never a credential. + """ + + @staticmethod + def from_dict(obj: Any) -> 'AuthIdentity': + assert isinstance(obj, dict) + host = from_str(obj.get("host")) + type = AuthInfoType(obj.get("type")) + copilot_user = from_union([CopilotUserResponse.from_dict, from_none], obj.get("copilotUser")) + env_var = from_union([from_str, from_none], obj.get("envVar")) + login = from_union([from_str, from_none], obj.get("login")) + registration_id = from_union([from_str, from_none], obj.get("registrationId")) + return AuthIdentity(host, type, copilot_user, env_var, login, registration_id) + + def to_dict(self) -> dict: + result: dict = {} + result["host"] = from_str(self.host) + result["type"] = to_enum(AuthInfoType, 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.env_var is not None: + result["envVar"] = from_union([from_str, from_none], self.env_var) + if self.login is not None: + result["login"] = from_union([from_str, from_none], self.login) + if self.registration_id is not None: + result["registrationId"] = from_union([from_str, from_none], self.registration_id) + return result + +# Experimental: this type is part of an experimental API and may change or be removed. +@dataclass +class BuiltinToolDescriptor: + """Rust-owned metadata and input schema for a built-in tool.""" + + description: str + """Model-facing description of the tool's behavior.""" + + has_summarise_intention: bool + """Whether the tool provides a specialized intention summary.""" + + is_terminal: bool + """Whether the tool executes commands in a terminal.""" + + name: str + """Stable name used to invoke the built-in tool.""" + + safe_for_telemetry: bool | BuiltinToolSafeTelemetryFields + """Policy describing which tool metadata may be recorded without obfuscation.""" + + format: BuiltinToolFormat | None = None + """Optional custom input format used instead of a JSON Schema.""" + + input_schema: BuiltinToolInputSchema | None = None + """JSON Schema for the tool input, or null when the tool uses a custom format.""" + + instructions: str | None = None + """Optional supplemental usage instructions for the tool.""" + + title: str | None = None + """Optional human-readable title for the tool.""" + + type: str | None = None + """Optional tool category discriminator.""" + + @staticmethod + def from_dict(obj: Any) -> 'BuiltinToolDescriptor': + assert isinstance(obj, dict) + description = from_str(obj.get("description")) + has_summarise_intention = from_bool(obj.get("hasSummariseIntention")) + is_terminal = from_bool(obj.get("isTerminal")) + name = from_str(obj.get("name")) + safe_for_telemetry = from_union([from_bool, BuiltinToolSafeTelemetryFields.from_dict], obj.get("safeForTelemetry")) + format = from_union([BuiltinToolFormat.from_dict, from_none], obj.get("format")) + input_schema = from_union([BuiltinToolInputSchema.from_dict, from_none], obj.get("inputSchema")) + instructions = from_union([from_none, from_str], obj.get("instructions")) + title = from_union([from_none, from_str], obj.get("title")) + type = from_union([from_none, from_str], obj.get("type")) + return BuiltinToolDescriptor(description, has_summarise_intention, is_terminal, name, safe_for_telemetry, format, input_schema, instructions, title, type) + + def to_dict(self) -> dict: + result: dict = {} + result["description"] = from_str(self.description) + result["hasSummariseIntention"] = from_bool(self.has_summarise_intention) + result["isTerminal"] = from_bool(self.is_terminal) + result["name"] = from_str(self.name) + result["safeForTelemetry"] = from_union([from_bool, lambda x: to_class(BuiltinToolSafeTelemetryFields, x)], self.safe_for_telemetry) + result["format"] = from_union([lambda x: to_class(BuiltinToolFormat, x), from_none], self.format) + result["inputSchema"] = from_union([lambda x: to_class(BuiltinToolInputSchema, x), from_none], self.input_schema) + result["instructions"] = from_union([from_none, from_str], self.instructions) + result["title"] = from_union([from_none, from_str], self.title) + result["type"] = from_union([from_none, from_str], self.type) + return result + # Experimental: this type is part of an experimental API and may change or be removed. @dataclass class CopilotAPITokenAuthInfo: @@ -23728,8 +32435,8 @@ def to_dict(self) -> dict: # 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. + """Authentication-info input variant for a token sourced from an environment variable, with + host, optional login, token, and env var name. """ env_var: str """Name of the environment variable the token was sourced from.""" @@ -23776,11 +32483,225 @@ def to_dict(self) -> dict: 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 FactoryAgentSummary: + """Prompt-safe durable identity and live status for a direct factory agent.""" + + active_ms: int + """Accumulated active agent time in milliseconds.""" + + agent_id: str + """Stable direct-agent identifier.""" + + agent_type: str + """Registered agent type.""" + + label: str + """Friendly, non-unique name intended for display""" + + run_id: str + """Owning factory run identifier.""" + + status: str + """Current durable or live agent status.""" + + tool_call_id: str + """Tool-call identifier that launched the agent.""" + + activity: str | None = None + """Prompt-safe live activity text.""" + + completed_at: int | None = None + """Epoch milliseconds when the agent completed.""" + + display_name: str | None = None + """Friendly, non-unique name intended for display""" + + phase_id: str | None = None + """Phase identifier active when the agent was launched, or null.""" + + requested_model: str | None = None + """Model requested when the agent was launched.""" + + resolved_model: str | None = None + """Concrete model resolved for the agent.""" + + started_at: int | None = None + """Epoch milliseconds when the agent started.""" + + @staticmethod + def from_dict(obj: Any) -> 'FactoryAgentSummary': + assert isinstance(obj, dict) + 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")) + display_name = from_union([from_str, from_none], obj.get("displayName")) + 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, display_name, phase_id, requested_model, resolved_model, started_at) + + def to_dict(self) -> dict: + result: dict = {} + 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) + if self.display_name is not None: + result["displayName"] = from_union([from_str, from_none], self.display_name) + 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 + +# 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] + """Durable identities and live statuses for direct factory agents.""" + + consumed: FactoryRunConsumed + """Durable resource consumption.""" + + created_at: int + """Epoch milliseconds when the run was created.""" + + declared_limits: FactoryDeclaredLimits + """Resource ceilings declared by the factory.""" + + declared_phase_count: int + """Number of phases declared by the factory.""" + + description: str + """Human-readable factory description.""" + + factory_name: str + """Registered factory name.""" + + live_agent_count: int + """Number of direct factory agents currently live.""" + + observed_at: int + """Epoch milliseconds when this live-overlay snapshot was observed.""" + + phases: list[FactoryPhaseObservation] + """Lifecycle and timing observations for each factory phase.""" + + progress: FactoryProgressPage + """Bidirectional page of durable factory progress.""" + + revision: int + """Monotonic durable run revision.""" + + run_id: str + """Factory run identifier.""" + + status: FactoryRunStatus + """Current factory run status.""" + + total_spawned_agent_count: int + """Total direct factory agents spawned across all attempts.""" + + updated_at: int + """Epoch milliseconds when the durable run was last updated.""" + + active_segment_started_at: int | None = None + """Epoch milliseconds when the current active segment started, or null while inactive.""" + + approved: FactoryDeclaredLimits | None = None + """Approved effective resource ceilings, or null until approved.""" + + completed_at: int | None = None + """Epoch milliseconds when the run completed, or null while nonterminal.""" + + current_phase: FactoryCurrentPhase | None = None + """Current phase identity, or null before any phase is entered.""" + + started_at: int | None = None + """Epoch milliseconds when execution first started, or null before start.""" + + terminal: FactoryRunTerminal | None = None + """Terminal run outcome, or null while nonterminal.""" + + @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 GhCLIAuthInfo: - """Authentication-info variant for GitHub CLI credentials, carrying host, login, and the `gh - auth token` value. + """Authentication-info input variant for GitHub CLI credentials, carrying host, login, and + the `gh auth token` value. """ host: str """Authentication host.""" @@ -23934,8 +32855,8 @@ def to_dict(self) -> dict: # Experimental: this type is part of an experimental API and may change or be removed. @dataclass class HMACAuthInfo: - """Authentication-info variant for GitHub-internal HMAC auth, carrying the public GitHub - host and HMAC secret. + """Authentication-info input variant for GitHub-internal HMAC auth, carrying the public + GitHub host and HMAC secret. """ hmac: str """HMAC secret used to sign requests.""" @@ -24009,6 +32930,58 @@ def to_dict(self) -> dict: 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 MCPOauthProbeResult: + """Passive MCP OAuth probe result. `authenticated` means the server accepted the probe + request while an OAuth-origin access token was attached; it does not prove the server + required or independently validated that token. The probe does not make a second + unauthenticated request. Failed is an expected probe-domain outcome; JSON-RPC errors are + reserved for API-call failures. + """ + status: Status + """Probe outcome variant discriminator.""" + + http_response: ExternalRefMCPOauthHTTPResponse | None = None + """HTTP response returned by the server. + + HTTP 401 or 403 response returned by the server. + + HTTP response returned by the server, when the probe reached the server and captured the + complete response. + """ + reason: MCPOauthProbeNeedsAuthReason | None = None + """Why authentication is needed.""" + + www_authenticate_params: McpOauthWWWAuthenticateParams | None = None + """Parsed WWW-Authenticate challenge parameters, when present and parseable.""" + + error: str | None = None + """Human-readable probe failure detail.""" + + @staticmethod + def from_dict(obj: Any) -> 'MCPOauthProbeResult': + assert isinstance(obj, dict) + status = Status(obj.get("status")) + http_response = from_union([ExternalRefMCPOauthHTTPResponse.from_dict, from_none], obj.get("httpResponse")) + reason = from_union([MCPOauthProbeNeedsAuthReason, from_none], obj.get("reason")) + www_authenticate_params = from_union([McpOauthWWWAuthenticateParams.from_dict, from_none], obj.get("wwwAuthenticateParams")) + error = from_union([from_str, from_none], obj.get("error")) + return MCPOauthProbeResult(status, http_response, reason, www_authenticate_params, error) + + def to_dict(self) -> dict: + result: dict = {} + result["status"] = to_enum(Status, self.status) + if self.http_response is not None: + result["httpResponse"] = from_union([lambda x: to_class(ExternalRefMCPOauthHTTPResponse, x), from_none], self.http_response) + if self.reason is not None: + result["reason"] = from_union([lambda x: to_enum(MCPOauthProbeNeedsAuthReason, x), from_none], self.reason) + if self.www_authenticate_params is not None: + result["wwwAuthenticateParams"] = from_union([lambda x: to_class(McpOauthWWWAuthenticateParams, x), from_none], self.www_authenticate_params) + 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. # Internal: this type is an internal SDK API and is not part of the public surface. @dataclass @@ -24048,6 +33021,304 @@ def to_dict(self) -> dict: result["transport"] = self.transport return result +# Experimental: this type is part of an experimental API and may change or be removed. +@dataclass +class MCPServerConfig: + """MCP server configuration (stdio, remote HTTP/SSE, or in-process) + + Stdio MCP server configuration launched as a child process. + + Remote MCP server configuration accessed over HTTP or SSE. + + In-process MCP server configuration used by embedded SDK clients. + """ + args: list[str] | None = None + """Command-line arguments passed to the Stdio MCP server process.""" + + auth: bool | MCPServerAuthConfigRedirectPort | None = None + """Set to `true` to use defaults, or provide an object with additional auth or OIDC settings.""" + + command: str | None = None + """Executable command used to start the Stdio MCP server process.""" + + config_warnings: list[str] | None = None + """Configuration warnings recorded while loading the server.""" + + 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) + + Controls whether tools can be loaded on demand. + """ + disable_secret_masking: bool | None = None + """Whether secret masking is disabled for calls to this server.""" + + disable_tool_cache: bool | None = None + """Set to true to disable persisted MCP tool snapshots for this server. Live tool discovery + is unaffected. + + Whether persisted tool snapshots are disabled. + """ + display_name: str | None = None + """Optional human-readable server name.""" + + env: dict[str, str] | None = None + """Environment variables to pass to the Stdio MCP server process.""" + + events: list[str] | None = None + """Event types this server receives as Copilot notifications.""" + + exclude_tools: list[str] | None = None + """Tool names excluded after the include filter is applied.""" + + 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. + + Content filtering mode to apply to this server's tools. + """ + is_default_server: bool | None = None + """Whether this server is a built-in fallback used when the user has not configured their + own server. + + Whether this server is a built-in fallback. + """ + notifications: list[str] | None = None + """Copilot notification types this server may send to the host.""" + + oidc: bool | MCPServerAuthConfigRedirectPort | None = None + """Set to `true` to use defaults, or provide an object with additional auth or OIDC + settings. + + Set to `true` to use default OIDC settings. + """ + safe_for_telemetry: bool | MCPSafeForTelemetryFields | None = None + """Telemetry-obfuscation policy for this server's tools.""" + + source: McpServerSource | None = None + """The origin of this server configuration.""" + + source_path: str | None = None + """Source file path recorded while loading the config.""" + + source_plugin: str | None = None + """Plugin that provided this server.""" + + source_plugin_spec: bool | None = None + """Whether the providing plugin uses the Open Plugin Spec.""" + + source_plugin_version: str | None = None + """Version of the plugin that provided this server.""" + + timeout: int | None = None + """Timeout in milliseconds for tool discovery and tool calls.""" + + tools: list[str] | None = None + """Tools to include. Defaults to all tools if not specified.""" + + type: MCPServerConfigType | None = None + """Local transport type. Defaults to stdio when omitted. + + Remote transport type. Defaults to "http" when omitted. + """ + headers: dict[str, str] | None = None + """HTTP headers to include in requests to the remote MCP server.""" + + headers_refresh_ttl_ms: int | None = None + """Dynamic-header refresh cache lifetime in milliseconds.""" + + oauth_client_id: str | None = None + """OAuth client ID for a pre-registered remote MCP OAuth client.""" + + oauth_grant_type: MCPGrantType | 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.""" + + url: str | None = None + """URL of the remote MCP server endpoint.""" + + server_instance: Any = None + """In-process MCP server instance. This value cannot cross a JSON-RPC boundary.""" + + @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")) + config_warnings = from_union([lambda x: from_list(from_str, x), from_none], obj.get("configWarnings")) + cwd = from_union([from_str, from_none], obj.get("cwd")) + defer_tools = from_union([MCPServerConfigDeferTools, from_none], obj.get("deferTools")) + disable_secret_masking = from_union([from_bool, from_none], obj.get("disableSecretMasking")) + disable_tool_cache = from_union([from_bool, from_none], obj.get("disableToolCache")) + display_name = from_union([from_str, from_none], obj.get("displayName")) + env = from_union([lambda x: from_dict(from_str, x), from_none], obj.get("env")) + events = from_union([lambda x: from_list(from_str, x), from_none], obj.get("events")) + exclude_tools = from_union([lambda x: from_list(from_str, x), from_none], obj.get("excludeTools")) + 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")) + notifications = from_union([lambda x: from_list(from_str, x), from_none], obj.get("notifications")) + oidc = from_union([from_bool, MCPServerAuthConfigRedirectPort.from_dict, from_none], obj.get("oidc")) + safe_for_telemetry = from_union([from_bool, MCPSafeForTelemetryFields.from_dict, from_none], obj.get("safeForTelemetry")) + source = from_union([McpServerSource, from_none], obj.get("source")) + source_path = from_union([from_str, from_none], obj.get("sourcePath")) + source_plugin = from_union([from_str, from_none], obj.get("sourcePlugin")) + source_plugin_spec = from_union([from_bool, from_none], obj.get("sourcePluginSpec")) + source_plugin_version = from_union([from_str, from_none], obj.get("sourcePluginVersion")) + 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([MCPServerConfigType, from_none], obj.get("type")) + headers = from_union([lambda x: from_dict(from_str, x), from_none], obj.get("headers")) + headers_refresh_ttl_ms = from_union([from_int, from_none], obj.get("headersRefreshTtlMs")) + 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")) + url = from_union([from_str, from_none], obj.get("url")) + server_instance = obj.get("serverInstance") + return MCPServerConfig(args, auth, command, config_warnings, cwd, defer_tools, disable_secret_masking, disable_tool_cache, display_name, env, events, exclude_tools, filter_mapping, is_default_server, notifications, oidc, safe_for_telemetry, source, source_path, source_plugin, source_plugin_spec, source_plugin_version, timeout, tools, type, headers, headers_refresh_ttl_ms, oauth_client_id, oauth_grant_type, oauth_public_client, url, server_instance) + + 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.config_warnings is not None: + result["configWarnings"] = from_union([lambda x: from_list(from_str, x), from_none], self.config_warnings) + 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_secret_masking is not None: + result["disableSecretMasking"] = from_union([from_bool, from_none], self.disable_secret_masking) + if self.disable_tool_cache is not None: + result["disableToolCache"] = from_union([from_bool, from_none], self.disable_tool_cache) + if self.display_name is not None: + result["displayName"] = from_union([from_str, from_none], self.display_name) + if self.env is not None: + result["env"] = from_union([lambda x: from_dict(from_str, x), from_none], self.env) + if self.events is not None: + result["events"] = from_union([lambda x: from_list(from_str, x), from_none], self.events) + if self.exclude_tools is not None: + result["excludeTools"] = from_union([lambda x: from_list(from_str, x), from_none], self.exclude_tools) + 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.notifications is not None: + result["notifications"] = from_union([lambda x: from_list(from_str, x), from_none], self.notifications) + if self.oidc is not None: + result["oidc"] = from_union([from_bool, lambda x: to_class(MCPServerAuthConfigRedirectPort, x), from_none], self.oidc) + if self.safe_for_telemetry is not None: + result["safeForTelemetry"] = from_union([from_bool, lambda x: to_class(MCPSafeForTelemetryFields, x), from_none], self.safe_for_telemetry) + if self.source is not None: + result["source"] = from_union([lambda x: to_enum(McpServerSource, x), from_none], self.source) + if self.source_path is not None: + result["sourcePath"] = from_union([from_str, from_none], self.source_path) + if self.source_plugin is not None: + result["sourcePlugin"] = from_union([from_str, from_none], self.source_plugin) + if self.source_plugin_spec is not None: + result["sourcePluginSpec"] = from_union([from_bool, from_none], self.source_plugin_spec) + if self.source_plugin_version is not None: + result["sourcePluginVersion"] = from_union([from_str, from_none], self.source_plugin_version) + 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(MCPServerConfigType, x), from_none], self.type) + if self.headers is not None: + result["headers"] = from_union([lambda x: from_dict(from_str, x), from_none], self.headers) + if self.headers_refresh_ttl_ms is not None: + result["headersRefreshTtlMs"] = from_union([from_int, from_none], self.headers_refresh_ttl_ms) + 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.url is not None: + result["url"] = from_union([from_str, from_none], self.url) + if self.server_instance is not None: + result["serverInstance"] = self.server_instance + 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 MCPReloadConfig: + """In-process MCP reload configuration.""" + + mcp_servers: dict[str, MCPServerConfig] + active_git_hub_token: str | None = None + cli_enabled_servers: list[str] | None = None + """Server names the CLI enabled for this session via `--enable-mcp-server`.""" + + config_filter: Any = None + disabled_servers: list[str] | None = None + enabled_servers: list[str] | None = None + force_restart: bool | None = None + github_mcp_tool_options: Any = None + github_mcp_user_override: bool | None = None + include_workspace_sources: bool | None = None + mcp3_p_enabled: bool | None = None + secret_store: Any = None + use_cached_tool_snapshots: bool | None = None + + @staticmethod + def from_dict(obj: Any) -> 'MCPReloadConfig': + assert isinstance(obj, dict) + mcp_servers = from_dict(MCPServerConfig.from_dict, obj.get("mcpServers")) + active_git_hub_token = from_union([from_str, from_none], obj.get("activeGitHubToken")) + cli_enabled_servers = from_union([lambda x: from_list(from_str, x), from_none], obj.get("cliEnabledServers")) + config_filter = obj.get("configFilter") + disabled_servers = from_union([lambda x: from_list(from_str, x), from_none], obj.get("disabledServers")) + enabled_servers = from_union([lambda x: from_list(from_str, x), from_none], obj.get("enabledServers")) + force_restart = from_union([from_bool, from_none], obj.get("forceRestart")) + github_mcp_tool_options = obj.get("githubMcpToolOptions") + github_mcp_user_override = from_union([from_bool, from_none], obj.get("githubMcpUserOverride")) + include_workspace_sources = from_union([from_bool, from_none], obj.get("includeWorkspaceSources")) + mcp3_p_enabled = from_union([from_bool, from_none], obj.get("mcp3pEnabled")) + secret_store = obj.get("secretStore") + use_cached_tool_snapshots = from_union([from_bool, from_none], obj.get("useCachedToolSnapshots")) + return MCPReloadConfig(mcp_servers, active_git_hub_token, cli_enabled_servers, config_filter, disabled_servers, enabled_servers, force_restart, github_mcp_tool_options, github_mcp_user_override, include_workspace_sources, mcp3_p_enabled, secret_store, use_cached_tool_snapshots) + + def to_dict(self) -> dict: + result: dict = {} + result["mcpServers"] = from_dict(lambda x: to_class(MCPServerConfig, x), self.mcp_servers) + if self.active_git_hub_token is not None: + result["activeGitHubToken"] = from_union([from_str, from_none], self.active_git_hub_token) + if self.cli_enabled_servers is not None: + result["cliEnabledServers"] = from_union([lambda x: from_list(from_str, x), from_none], self.cli_enabled_servers) + if self.config_filter is not None: + result["configFilter"] = self.config_filter + if self.disabled_servers is not None: + result["disabledServers"] = from_union([lambda x: from_list(from_str, x), from_none], self.disabled_servers) + if self.enabled_servers is not None: + result["enabledServers"] = from_union([lambda x: from_list(from_str, x), from_none], self.enabled_servers) + if self.force_restart is not None: + result["forceRestart"] = from_union([from_bool, from_none], self.force_restart) + if self.github_mcp_tool_options is not None: + result["githubMcpToolOptions"] = self.github_mcp_tool_options + if self.github_mcp_user_override is not None: + result["githubMcpUserOverride"] = from_union([from_bool, from_none], self.github_mcp_user_override) + if self.include_workspace_sources is not None: + result["includeWorkspaceSources"] = from_union([from_bool, from_none], self.include_workspace_sources) + if self.mcp3_p_enabled is not None: + result["mcp3pEnabled"] = from_union([from_bool, from_none], self.mcp3_p_enabled) + if self.secret_store is not None: + result["secretStore"] = self.secret_store + if self.use_cached_tool_snapshots is not None: + result["useCachedToolSnapshots"] = from_union([from_bool, from_none], self.use_cached_tool_snapshots) + return result + # Experimental: this type is part of an experimental API and may change or be removed. @dataclass class MCPResourceAnnotations: @@ -24283,6 +33554,143 @@ def to_dict(self) -> dict: 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. +# Internal: this type is an internal SDK API and is not part of the public surface. +@dataclass +class MCPServerConfigMemory: + """In-process MCP server configuration used by embedded SDK clients.""" + + type: MCPServerConfigMemoryType + server_instance: Any = None + """In-process MCP server instance. This value cannot cross a JSON-RPC boundary.""" + + config_warnings: list[str] | None = None + """Configuration warnings recorded while loading the server.""" + + defer_tools: MCPServerConfigDeferTools | None = None + """Controls whether tools can be loaded on demand.""" + + disable_secret_masking: bool | None = None + """Whether secret masking is disabled for calls to this server.""" + + disable_tool_cache: bool | None = None + """Whether persisted tool snapshots are disabled.""" + + display_name: str | None = None + """Optional human-readable server name.""" + + events: list[str] | None = None + """Event types this server receives as Copilot notifications.""" + + exclude_tools: list[str] | None = None + """Tool names excluded after the include filter is applied.""" + + filter_mapping: dict[str, ContentFilterMode] | ContentFilterMode | None = None + """Content filtering mode to apply to this server's tools.""" + + is_default_server: bool | None = None + """Whether this server is a built-in fallback.""" + + notifications: list[str] | None = None + """Copilot notification types this server may send to the host.""" + + oidc: bool | MCPServerAuthConfigRedirectPort | None = None + """Set to `true` to use default OIDC settings.""" + + safe_for_telemetry: bool | MCPSafeForTelemetryFields | None = None + """Telemetry-obfuscation policy for this server's tools.""" + + source: McpServerSource | None = None + """The origin of this server configuration.""" + + source_path: str | None = None + """Source file path recorded while loading the config.""" + + source_plugin: str | None = None + """Plugin that provided this server.""" + + source_plugin_spec: bool | None = None + """Whether the providing plugin uses the Open Plugin Spec.""" + + source_plugin_version: str | None = None + """Version of the plugin that provided this server.""" + + timeout: int | None = None + """Timeout in milliseconds for tool discovery and tool calls.""" + + tools: list[str] | None = None + """Tools to include. Defaults to all tools if not specified.""" + + @staticmethod + def from_dict(obj: Any) -> 'MCPServerConfigMemory': + assert isinstance(obj, dict) + server_instance = obj.get("serverInstance") + type = MCPServerConfigMemoryType(obj.get("type")) + config_warnings = from_union([lambda x: from_list(from_str, x), from_none], obj.get("configWarnings")) + defer_tools = from_union([MCPServerConfigDeferTools, from_none], obj.get("deferTools")) + disable_secret_masking = from_union([from_bool, from_none], obj.get("disableSecretMasking")) + disable_tool_cache = from_union([from_bool, from_none], obj.get("disableToolCache")) + display_name = from_union([from_str, from_none], obj.get("displayName")) + events = from_union([lambda x: from_list(from_str, x), from_none], obj.get("events")) + exclude_tools = from_union([lambda x: from_list(from_str, x), from_none], obj.get("excludeTools")) + 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")) + notifications = from_union([lambda x: from_list(from_str, x), from_none], obj.get("notifications")) + oidc = from_union([from_bool, MCPServerAuthConfigRedirectPort.from_dict, from_none], obj.get("oidc")) + safe_for_telemetry = from_union([from_bool, MCPSafeForTelemetryFields.from_dict, from_none], obj.get("safeForTelemetry")) + source = from_union([McpServerSource, from_none], obj.get("source")) + source_path = from_union([from_str, from_none], obj.get("sourcePath")) + source_plugin = from_union([from_str, from_none], obj.get("sourcePlugin")) + source_plugin_spec = from_union([from_bool, from_none], obj.get("sourcePluginSpec")) + source_plugin_version = from_union([from_str, from_none], obj.get("sourcePluginVersion")) + 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 MCPServerConfigMemory(server_instance, type, config_warnings, defer_tools, disable_secret_masking, disable_tool_cache, display_name, events, exclude_tools, filter_mapping, is_default_server, notifications, oidc, safe_for_telemetry, source, source_path, source_plugin, source_plugin_spec, source_plugin_version, timeout, tools) + + def to_dict(self) -> dict: + result: dict = {} + result["serverInstance"] = self.server_instance + result["type"] = to_enum(MCPServerConfigMemoryType, self.type) + if self.config_warnings is not None: + result["configWarnings"] = from_union([lambda x: from_list(from_str, x), from_none], self.config_warnings) + 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_secret_masking is not None: + result["disableSecretMasking"] = from_union([from_bool, from_none], self.disable_secret_masking) + if self.disable_tool_cache is not None: + result["disableToolCache"] = from_union([from_bool, from_none], self.disable_tool_cache) + if self.display_name is not None: + result["displayName"] = from_union([from_str, from_none], self.display_name) + if self.events is not None: + result["events"] = from_union([lambda x: from_list(from_str, x), from_none], self.events) + if self.exclude_tools is not None: + result["excludeTools"] = from_union([lambda x: from_list(from_str, x), from_none], self.exclude_tools) + 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.notifications is not None: + result["notifications"] = from_union([lambda x: from_list(from_str, x), from_none], self.notifications) + if self.oidc is not None: + result["oidc"] = from_union([from_bool, lambda x: to_class(MCPServerAuthConfigRedirectPort, x), from_none], self.oidc) + if self.safe_for_telemetry is not None: + result["safeForTelemetry"] = from_union([from_bool, lambda x: to_class(MCPSafeForTelemetryFields, x), from_none], self.safe_for_telemetry) + if self.source is not None: + result["source"] = from_union([lambda x: to_enum(McpServerSource, x), from_none], self.source) + if self.source_path is not None: + result["sourcePath"] = from_union([from_str, from_none], self.source_path) + if self.source_plugin is not None: + result["sourcePlugin"] = from_union([from_str, from_none], self.source_plugin) + if self.source_plugin_spec is not None: + result["sourcePluginSpec"] = from_union([from_bool, from_none], self.source_plugin_spec) + if self.source_plugin_version is not None: + result["sourcePluginVersion"] = from_union([from_str, from_none], self.source_plugin_version) + 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 MetadataContextInfoRequest: @@ -24391,6 +33799,11 @@ class Model: default_reasoning_effort: str | None = None """Default reasoning effort level (only present if model supports reasoning effort)""" + info_messages: list[ModelMessage] | None = None + """Informational notices the service published for this model, such as an upcoming change or + a recommended alternative. Present only when the service published at least one notice. + Hosts should surface these without implying anything is wrong with the model. + """ model_picker_category: ModelPickerCategory | None = None """Model capability category for grouping in the model picker""" @@ -24400,9 +33813,25 @@ class Model: policy: ModelPolicy | None = None """Policy state (if applicable)""" + supported_context_tiers: list[str] | None = None + """Context-window tiers this model offers, when the provider advertises them independently + of tiered token pricing. Copilot models carry their tiers in `billing.tokenPrices`; a + provider that has no pricing to publish (an agent host reached over AHP, for example) + declares them here instead, so the model picker can still offer the tier toggle. + """ supported_reasoning_efforts: list[str] | None = None """Supported reasoning effort levels (only present if model supports reasoning effort)""" + warning_messages: list[ModelMessage] | None = None + """Warnings the service published for this model, such as a deprecated client version. + Present only when the service published at least one warning. The model remains usable; + hosts should surface these as advisory rather than blocking. + """ + warning_text: ModelWarningText | None = None + """Warning text the service requires hosts to surface for this model. Present only when the + service published at least one warning. + """ + @staticmethod def from_dict(obj: Any) -> 'Model': assert isinstance(obj, dict) @@ -24411,11 +33840,15 @@ def from_dict(obj: Any) -> 'Model': 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")) + info_messages = from_union([lambda x: from_list(ModelMessage.from_dict, x), from_none], obj.get("infoMessages")) 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_context_tiers = from_union([lambda x: from_list(from_str, x), from_none], obj.get("supportedContextTiers")) 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) + warning_messages = from_union([lambda x: from_list(ModelMessage.from_dict, x), from_none], obj.get("warningMessages")) + warning_text = from_union([ModelWarningText.from_dict, from_none], obj.get("warningText")) + return Model(capabilities, id, name, billing, default_reasoning_effort, info_messages, model_picker_category, model_picker_price_category, policy, supported_context_tiers, supported_reasoning_efforts, warning_messages, warning_text) def to_dict(self) -> dict: result: dict = {} @@ -24426,14 +33859,78 @@ def to_dict(self) -> dict: 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.info_messages is not None: + result["infoMessages"] = from_union([lambda x: from_list(lambda x: to_class(ModelMessage, x), x), from_none], self.info_messages) 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: result["modelPickerPriceCategory"] = from_union([lambda x: to_enum(ModelPickerPriceCategory, x), from_none], self.model_picker_price_category) if self.policy is not None: result["policy"] = from_union([lambda x: to_class(ModelPolicy, x), from_none], self.policy) + if self.supported_context_tiers is not None: + result["supportedContextTiers"] = from_union([lambda x: from_list(from_str, x), from_none], self.supported_context_tiers) if self.supported_reasoning_efforts is not None: result["supportedReasoningEfforts"] = from_union([lambda x: from_list(from_str, x), from_none], self.supported_reasoning_efforts) + if self.warning_messages is not None: + result["warningMessages"] = from_union([lambda x: from_list(lambda x: to_class(ModelMessage, x), x), from_none], self.warning_messages) + if self.warning_text is not None: + result["warningText"] = from_union([lambda x: to_class(ModelWarningText, x), from_none], self.warning_text) + return result + +# Experimental: this type is part of an experimental API and may change or be removed. +@dataclass +class ModelApplyStartupOverlayRequest: + """Managed, repository, and CLI model overrides to overlay onto the session at startup.""" + + cli_model: str | None = None + """Model explicitly selected by the CLI, when provided.""" + + deferred_resume: bool | None = None + """Whether the overlay is being applied while resuming a deferred session.""" + + device_managed_model: str | None = None + """Model required by device-managed policy, when configured.""" + + repo_context_tier: str | None = None + """Context tier selected by repository settings, when configured.""" + + repo_model: str | None = None + """Model selected by repository settings, when configured.""" + + repo_reasoning_effort: str | None = None + """Reasoning effort selected by repository settings, when configured.""" + + server_managed_model: str | None = None + """Model required by server-managed policy, when configured.""" + + @staticmethod + def from_dict(obj: Any) -> 'ModelApplyStartupOverlayRequest': + assert isinstance(obj, dict) + cli_model = from_union([from_str, from_none], obj.get("cliModel")) + deferred_resume = from_union([from_bool, from_none], obj.get("deferredResume")) + device_managed_model = from_union([from_str, from_none], obj.get("deviceManagedModel")) + repo_context_tier = from_union([from_str, from_none], obj.get("repoContextTier")) + repo_model = from_union([from_str, from_none], obj.get("repoModel")) + repo_reasoning_effort = from_union([from_str, from_none], obj.get("repoReasoningEffort")) + server_managed_model = from_union([from_str, from_none], obj.get("serverManagedModel")) + return ModelApplyStartupOverlayRequest(cli_model, deferred_resume, device_managed_model, repo_context_tier, repo_model, repo_reasoning_effort, server_managed_model) + + def to_dict(self) -> dict: + result: dict = {} + if self.cli_model is not None: + result["cliModel"] = from_union([from_str, from_none], self.cli_model) + if self.deferred_resume is not None: + result["deferredResume"] = from_union([from_bool, from_none], self.deferred_resume) + if self.device_managed_model is not None: + result["deviceManagedModel"] = from_union([from_str, from_none], self.device_managed_model) + if self.repo_context_tier is not None: + result["repoContextTier"] = from_union([from_str, from_none], self.repo_context_tier) + if self.repo_model is not None: + result["repoModel"] = from_union([from_str, from_none], self.repo_model) + if self.repo_reasoning_effort is not None: + result["repoReasoningEffort"] = from_union([from_str, from_none], self.repo_reasoning_effort) + if self.server_managed_model is not None: + result["serverManagedModel"] = from_union([from_str, from_none], self.server_managed_model) return result # Experimental: this type is part of an experimental API and may change or be removed. @@ -24467,19 +33964,51 @@ class ModelSwitchToRequest: `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. """ + compaction_decision: str | None = None + """Explicit response to a model-switch compaction preflight. Omit to request a confirmation + projection when compaction is necessary. + """ 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.""" + model_change_scope: str | None = None + """Settings scope used when persisting the selected model.""" + + picker_persistence: ModelPickerPersistenceRequest | None = None + """Optional settings context and explicit-override flags used to persist a picker selection.""" + reasoning_effort: str | None = None + """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""" + repo_scope: str | None = None + """Optional repository settings scope to persist after the switch commits.""" + + require_available: bool | None = None + """Require the target to be currently available and enabled before applying the switch.""" + + run_compaction_preflight: bool | None = None + """When true, evaluate context-window compaction policy before applying the switch.""" + + source: ModelChangeSource | None = None + """Origin to record on the effective `session.model_change` event. Defaults to `sdk` when + omitted. + """ verbosity: Verbosity | None = None """Output verbosity level to request for supported models""" @@ -24487,123 +34016,190 @@ class ModelSwitchToRequest: def from_dict(obj: Any) -> 'ModelSwitchToRequest': assert isinstance(obj, dict) model_id = from_str(obj.get("modelId")) + compaction_decision = from_union([from_str, from_none], obj.get("compactionDecision")) 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")) + model_change_scope = from_union([from_str, from_none], obj.get("modelChangeScope")) + picker_persistence = from_union([ModelPickerPersistenceRequest.from_dict, from_none], obj.get("pickerPersistence")) reasoning_effort = from_union([from_str, from_none], obj.get("reasoningEffort")) reasoning_summary = from_union([ReasoningSummary, from_none], obj.get("reasoningSummary")) + repo_scope = from_union([from_str, from_none], obj.get("repoScope")) + require_available = from_union([from_bool, from_none], obj.get("requireAvailable")) + run_compaction_preflight = from_union([from_bool, from_none], obj.get("runCompactionPreflight")) + source = from_union([ModelChangeSource, from_none], obj.get("source")) verbosity = from_union([Verbosity, from_none], obj.get("verbosity")) - return ModelSwitchToRequest(model_id, context_tier, model_capabilities, reasoning_effort, reasoning_summary, verbosity) + return ModelSwitchToRequest(model_id, compaction_decision, context_tier, defer_if_model_change_queued, model_capabilities, model_change_scope, picker_persistence, reasoning_effort, reasoning_summary, repo_scope, require_available, run_compaction_preflight, source, verbosity) def to_dict(self) -> dict: result: dict = {} result["modelId"] = from_str(self.model_id) + if self.compaction_decision is not None: + result["compactionDecision"] = from_union([from_str, from_none], self.compaction_decision) if self.context_tier is not None: 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.model_change_scope is not None: + result["modelChangeScope"] = from_union([from_str, from_none], self.model_change_scope) + if self.picker_persistence is not None: + result["pickerPersistence"] = from_union([lambda x: to_class(ModelPickerPersistenceRequest, x), from_none], self.picker_persistence) 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.repo_scope is not None: + result["repoScope"] = from_union([from_str, from_none], self.repo_scope) + if self.require_available is not None: + result["requireAvailable"] = from_union([from_bool, from_none], self.require_available) + if self.run_compaction_preflight is not None: + result["runCompactionPreflight"] = from_union([from_bool, from_none], self.run_compaction_preflight) + if self.source is not None: + result["source"] = from_union([lambda x: to_enum(ModelChangeSource, x), from_none], self.source) 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. -class PermissionsSetAAllSource(Enum): - """Optional source for allow-all telemetry. Defaults to `rpc` when omitted for SDK callers.""" +class PermissionSource(Enum): + """Optional source for permission-mode telemetry. Defaults to `rpc` when omitted for SDK + callers. + Optional source for allow-all telemetry. Defaults to `rpc` when omitted for SDK callers. + """ AUTOPILOT_CONFIRMATION = "autopilot_confirmation" CLI_FLAG = "cli_flag" RPC = "rpc" SLASH_COMMAND = "slash_command" + USER_SETTING = "user_setting" # Experimental: this type is part of an experimental API and may change or be removed. @dataclass -class PermissionsSetAllowAllRequest: - """Allow-all mode to apply for the session.""" +class PermissionsSetApproveAllRequest: + """Allow-all toggle for tool permission requests, with an optional telemetry source.""" - 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's active model is used. - """ - source: PermissionsSetAAllSource | None = None + enabled: bool + """Whether to auto-approve all tool permission requests""" + + source: PermissionSource | None = None """Optional source for allow-all telemetry. Defaults to `rpc` when omitted for SDK callers.""" @staticmethod - def from_dict(obj: Any) -> 'PermissionsSetAllowAllRequest': + def from_dict(obj: Any) -> 'PermissionsSetApproveAllRequest': 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) + enabled = from_bool(obj.get("enabled")) + source = from_union([PermissionSource, from_none], obj.get("source")) + return PermissionsSetApproveAllRequest(enabled, 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) + 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["source"] = from_union([lambda x: to_enum(PermissionSource, 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.""" +class PermissionsSetModeRequest: + """Permission mode to apply for the session.""" - enabled: bool - """Whether to auto-approve all tool permission requests""" + mode: PermissionMode + """Permission mode to apply""" - source: PermissionsSetAAllSource | None = None - """Optional source for allow-all telemetry. Defaults to `rpc` when omitted for SDK callers.""" + assisted_approval_model: str | None = None + """Optional judge model id for assisted mode. When omitted, the session resolves the + provider default: `gpt-5.5` for CAPI sessions and the active session model for BYOK + sessions. + """ + source: PermissionSource | None = None + """Optional source for permission-mode telemetry. Defaults to `rpc` when omitted for SDK + callers. + """ @staticmethod - def from_dict(obj: Any) -> 'PermissionsSetApproveAllRequest': + def from_dict(obj: Any) -> 'PermissionsSetModeRequest': assert isinstance(obj, dict) - enabled = from_bool(obj.get("enabled")) - source = from_union([PermissionsSetAAllSource, from_none], obj.get("source")) - return PermissionsSetApproveAllRequest(enabled, source) + mode = PermissionMode(obj.get("mode")) + assisted_approval_model = from_union([from_str, from_none], obj.get("assistedApprovalModel")) + source = from_union([PermissionSource, from_none], obj.get("source")) + return PermissionsSetModeRequest(mode, assisted_approval_model, source) def to_dict(self) -> dict: result: dict = {} - result["enabled"] = from_bool(self.enabled) + result["mode"] = to_enum(PermissionMode, self.mode) + if self.assisted_approval_model is not None: + result["assistedApprovalModel"] = from_union([from_str, from_none], self.assisted_approval_model) if self.source is not None: - result["source"] = from_union([lambda x: to_enum(PermissionsSetAAllSource, x), from_none], self.source) + result["source"] = from_union([lambda x: to_enum(PermissionSource, x), from_none], self.source) return result # Experimental: this type is part of an experimental API and may change or be removed. @dataclass -class ProviderGetEndpointRequest: - """Optional model identifier to scope the endpoint snapshot to.""" - - 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. +class ProtocolExternalToolDefinition: + """Serializable definition of a caller-implemented tool whose execution is handled over the + SDK connection. """ + description: str + """Model-visible explanation of what the tool does.""" + + name: str + """Unique model-visible tool name.""" + + defer: MCPServerConfigDeferTools | None = None + """Tool-loading deferral policy.""" + + is_terminal: bool | None = None + """Whether the tool executes commands in a terminal.""" + + metadata: dict[str, Any] | None = None + """Optional caller-defined metadata associated with the tool.""" + + overrides_built_in_tool: bool | None = None + """Whether this definition replaces a built-in tool with the same name.""" + + parameters: dict[str, Any] | None = None + """JSON Schema describing the tool's input arguments.""" + + skip_permission: bool | None = None + """Whether execution bypasses the normal tool permission prompt.""" + + title: str | None = None + """Optional human-readable display title.""" @staticmethod - def from_dict(obj: Any) -> 'ProviderGetEndpointRequest': + def from_dict(obj: Any) -> 'ProtocolExternalToolDefinition': assert isinstance(obj, dict) - model_id = from_union([from_str, from_none], obj.get("modelId")) - return ProviderGetEndpointRequest(model_id) + description = from_str(obj.get("description")) + name = from_str(obj.get("name")) + defer = from_union([MCPServerConfigDeferTools, from_none], obj.get("defer")) + is_terminal = from_union([from_bool, from_none], obj.get("isTerminal")) + metadata = from_union([lambda x: from_dict(lambda x: x, x), from_none], obj.get("metadata")) + overrides_built_in_tool = from_union([from_bool, from_none], obj.get("overridesBuiltInTool")) + parameters = from_union([lambda x: from_dict(lambda x: x, x), from_none], obj.get("parameters")) + skip_permission = from_union([from_bool, from_none], obj.get("skipPermission")) + title = from_union([from_str, from_none], obj.get("title")) + return ProtocolExternalToolDefinition(description, name, defer, is_terminal, metadata, overrides_built_in_tool, parameters, skip_permission, title) 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["description"] = from_str(self.description) + result["name"] = from_str(self.name) + if self.defer is not None: + result["defer"] = from_union([lambda x: to_enum(MCPServerConfigDeferTools, x), from_none], self.defer) + if self.is_terminal is not None: + result["isTerminal"] = from_union([from_bool, from_none], self.is_terminal) + if self.metadata is not None: + result["metadata"] = from_union([lambda x: from_dict(lambda x: x, x), from_none], self.metadata) + if self.overrides_built_in_tool is not None: + result["overridesBuiltInTool"] = from_union([from_bool, from_none], self.overrides_built_in_tool) + if self.parameters is not None: + result["parameters"] = from_union([lambda x: from_dict(lambda x: x, x), from_none], self.parameters) + if self.skip_permission is not None: + result["skipPermission"] = from_union([from_bool, from_none], self.skip_permission) + 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. @@ -24628,6 +34224,256 @@ def to_dict(self) -> 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 result variant discriminator.""" + + 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 SessionSettingsValidationSnapshot: + """Redacted validation and memory-tool settings. + + Redacted validation and memory-tool settings for a session. + """ + advisory_enabled: bool | None = None + """Whether advisory validation is enabled.""" + + codeql_enabled: bool | None = None + """Whether CodeQL validation is enabled.""" + + code_review_enabled: bool | None = None + """Whether code-review validation is enabled.""" + + code_review_model: str | None = None + """Model used for code-review validation.""" + + dependabot_timeout: float | None = None + """Dependabot validation timeout budget in seconds.""" + + memory_store_enabled: bool | None = None + """Whether the memory-store tool is enabled.""" + + memory_vote_enabled: bool | None = None + """Whether the memory-vote tool is enabled.""" + + secret_scanning_enabled: bool | None = None + """Whether secret-scanning validation is enabled.""" + + timeout: float | None = None + """General validation timeout budget in seconds.""" + + @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 + +# 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 + """Redacted job settings.""" + + model: SessionSettingsModelSnapshot + """Redacted model routing settings.""" + + online_evaluation: SessionSettingsOnlineEvaluationSnapshot + """Online-evaluation settings safe for SDK consumers.""" + + repo: SessionSettingsRepoSnapshot + """Redacted repository and host settings.""" + + validation: SessionSettingsValidationSnapshot + """Redacted validation and memory-tool settings.""" + + client_name: str | None = None + """Name of the SDK client that created the session.""" + + start_time_ms: float | None = None + """Session start time as Unix epoch milliseconds.""" + + timeout_ms: float | None = None + """Session timeout in milliseconds.""" + + version: str | None = None + """Agent runtime version selector copied from the session settings, such as `latest` or a + runtime release identifier. + """ + + @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 SessionsOpenCloud: @@ -24738,6 +34584,164 @@ def to_dict(self) -> dict: 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 SettableTokenAuthInfo: + """Token authentication accepted by session.gitHubAuth.setCredentials.""" + + host: str + """Authentication host.""" + + token: str + """The token value itself. Treat as a secret.""" + + type: ClassVar[str] = "token" + """SDK-side token authentication; the host configured the token directly via the SDK.""" + + 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) -> 'SettableTokenAuthInfo': + 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 SettableTokenAuthInfo(host, token, copilot_user) + + 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) + return result + +# Experimental: this type is part of an experimental API and may change or be removed. +@dataclass +class SlashCommandModelPickerDialog: + """Dialog the host should display.""" + + kind: SlashCommandModelPickerDialogKind + """Discriminator for a model-picker dialog.""" + + model_to_enable: str | None = None + """Model that should be enabled before it can be selected.""" + + scope: str | None = None + """Settings scope the picker should modify.""" + + target: str | None = None + """Model-selection target represented by the picker.""" + + @staticmethod + def from_dict(obj: Any) -> 'SlashCommandModelPickerDialog': + assert isinstance(obj, dict) + kind = SlashCommandModelPickerDialogKind(obj.get("kind")) + model_to_enable = from_union([from_str, from_none], obj.get("modelToEnable")) + scope = from_union([from_str, from_none], obj.get("scope")) + target = from_union([from_str, from_none], obj.get("target")) + return SlashCommandModelPickerDialog(kind, model_to_enable, scope, target) + + def to_dict(self) -> dict: + result: dict = {} + result["kind"] = to_enum(SlashCommandModelPickerDialogKind, self.kind) + if self.model_to_enable is not None: + result["modelToEnable"] = from_union([from_str, from_none], self.model_to_enable) + if self.scope is not None: + result["scope"] = from_union([from_str, from_none], self.scope) + if self.target is not None: + result["target"] = from_union([from_str, from_none], self.target) + return result + +# Experimental: this type is part of an experimental API and may change or be removed. +@dataclass +class SlashCommandSetModelResult: + kind: ClassVar[str] = "set-model" + """Discriminator for a set-model result.""" + + model: str + """Model selected by the command.""" + + reasoning_effort: str | None = None + """Reasoning effort selected for the model.""" + + repo_scope: str | None = None + """Repository settings scope modified by the command.""" + + revert_on_cancel: dict[str, Any] | None = None + """User-settings snapshot to restore if the host cancels the model switch.""" + + runtime_settings_changed: bool | None = None + """Whether command execution changed persisted runtime settings.""" + + scope: str | None = None + """Settings scope modified by the command.""" + + warning: str | None = None + """User-facing warning produced while selecting the model.""" + + @staticmethod + def from_dict(obj: Any) -> 'SlashCommandSetModelResult': + assert isinstance(obj, dict) + model = from_str(obj.get("model")) + reasoning_effort = from_union([from_str, from_none], obj.get("reasoningEffort")) + repo_scope = from_union([from_str, from_none], obj.get("repoScope")) + revert_on_cancel = from_union([lambda x: from_dict(lambda x: x, x), from_none], obj.get("revertOnCancel")) + runtime_settings_changed = from_union([from_bool, from_none], obj.get("runtimeSettingsChanged")) + scope = from_union([from_str, from_none], obj.get("scope")) + warning = from_union([from_str, from_none], obj.get("warning")) + return SlashCommandSetModelResult(model, reasoning_effort, repo_scope, revert_on_cancel, runtime_settings_changed, scope, warning) + + def to_dict(self) -> dict: + result: dict = {} + result["kind"] = self.kind + result["model"] = from_str(self.model) + if self.reasoning_effort is not None: + result["reasoningEffort"] = from_union([from_str, from_none], self.reasoning_effort) + if self.repo_scope is not None: + result["repoScope"] = from_union([from_str, from_none], self.repo_scope) + if self.revert_on_cancel is not None: + result["revertOnCancel"] = from_union([lambda x: from_dict(lambda x: x, x), from_none], self.revert_on_cancel) + if self.runtime_settings_changed is not None: + result["runtimeSettingsChanged"] = from_union([from_bool, from_none], self.runtime_settings_changed) + if self.scope is not None: + result["scope"] = from_union([from_str, from_none], self.scope) + if self.warning is not None: + result["warning"] = from_union([from_str, from_none], self.warning) + return result + +# Experimental: this type is part of an experimental API and may change or be removed. +@dataclass +class SlashCommandShowDialogResult: + dialog: SlashCommandModelPickerDialog + """Dialog the host should display.""" + + kind: ClassVar[str] = "show-dialog" + """Discriminator for a show-dialog result.""" + + runtime_settings_changed: bool | None = None + """Whether command execution changed persisted runtime settings.""" + + @staticmethod + def from_dict(obj: Any) -> 'SlashCommandShowDialogResult': + assert isinstance(obj, dict) + dialog = SlashCommandModelPickerDialog.from_dict(obj.get("dialog")) + runtime_settings_changed = from_union([from_bool, from_none], obj.get("runtimeSettingsChanged")) + return SlashCommandShowDialogResult(dialog, runtime_settings_changed) + + def to_dict(self) -> dict: + result: dict = {} + result["dialog"] = to_class(SlashCommandModelPickerDialog, self.dialog) + result["kind"] = self.kind + 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 SubagentSettingsEntry: @@ -24812,8 +34816,8 @@ def to_dict(self) -> dict: # 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. + """Authentication-info input variant for SDK-configured token authentication, carrying host + and the secret token value. """ host: str """Authentication host.""" @@ -24829,6 +34833,8 @@ class TokenAuthInfo: GitHub API `/copilot_internal/v2/token` user response shape β€” the runtime trusts this verbatim and does not re-fetch when set. """ + registration_id: str | None = None + """Opaque native GitHub credential registration backing this token identity, when applicable.""" @staticmethod def from_dict(obj: Any) -> 'TokenAuthInfo': @@ -24836,7 +34842,8 @@ def from_dict(obj: Any) -> 'TokenAuthInfo': 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) + registration_id = from_union([from_str, from_none], obj.get("registrationId")) + return TokenAuthInfo(host, token, copilot_user, registration_id) def to_dict(self) -> dict: result: dict = {} @@ -24845,6 +34852,62 @@ def to_dict(self) -> dict: 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.registration_id is not None: + result["registrationId"] = from_union([from_str, from_none], self.registration_id) + return result + +# Experimental: this type is part of an experimental API and may change or be removed. +@dataclass +class TokenProviderAuthInfo: + """Authentication-info variant backed by an SDK GitHub token callback. It carries routing + metadata but never a plaintext token. + """ + host: str + """Authentication host.""" + + registration_id: str + """Opaque SDK callback registration identifier.""" + + type: ClassVar[str] = "token-provider" + """SDK callback-backed GitHub token authentication.""" + + copilot_user: CopilotUserResponse | None = None + """Snapshot of the authenticated user's Copilot subscription info, if known.""" + + @staticmethod + def from_dict(obj: Any) -> 'TokenProviderAuthInfo': + assert isinstance(obj, dict) + host = from_str(obj.get("host")) + registration_id = from_str(obj.get("registrationId")) + copilot_user = from_union([CopilotUserResponse.from_dict, from_none], obj.get("copilotUser")) + return TokenProviderAuthInfo(host, registration_id, copilot_user) + + def to_dict(self) -> dict: + result: dict = {} + result["host"] = from_str(self.host) + result["registrationId"] = from_str(self.registration_id) + 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 ToolsGetBuiltinDescriptorsResult: + """Rust-owned built-in tool descriptors for the session.""" + + tools: list[BuiltinToolDescriptor] + """Built-in tool descriptors materialized for the session.""" + + @staticmethod + def from_dict(obj: Any) -> 'ToolsGetBuiltinDescriptorsResult': + assert isinstance(obj, dict) + tools = from_list(BuiltinToolDescriptor.from_dict, obj.get("tools")) + return ToolsGetBuiltinDescriptorsResult(tools) + + def to_dict(self) -> dict: + result: dict = {} + result["tools"] = from_list(lambda x: to_class(BuiltinToolDescriptor, x), self.tools) return result # Experimental: this type is part of an experimental API and may change or be removed. @@ -24866,6 +34929,26 @@ def to_dict(self) -> dict: 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 ToolsSetRequest: + """Complete externally implemented tool list for the calling connection. An empty list + removes every tool previously supplied by that connection. + """ + tools: list[ProtocolExternalToolDefinition] + """Complete replacement list for the calling connection.""" + + @staticmethod + def from_dict(obj: Any) -> 'ToolsSetRequest': + assert isinstance(obj, dict) + tools = from_list(ProtocolExternalToolDefinition.from_dict, obj.get("tools")) + return ToolsSetRequest(tools) + + def to_dict(self) -> dict: + result: dict = {} + result["tools"] = from_list(lambda x: to_class(ProtocolExternalToolDefinition, x), self.tools) + return result + # Experimental: this type is part of an experimental API and may change or be removed. @dataclass class UIEphemeralQueryRequest: @@ -24985,6 +35068,7 @@ class RPC: 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 @@ -25005,12 +35089,23 @@ class RPC: 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_identity: AuthIdentity auth_info: AuthInfo auth_info_type: AuthInfoType + auth_validation_error: AuthValidationError + auth_validation_errors: list[AuthValidationError] + built_in_model_catalog: BuiltInModelCatalog + built_in_model_catalog_entry: BuiltInModelCatalogEntry + builtin_tool_descriptor: BuiltinToolDescriptor + builtin_tool_format: BuiltinToolFormat + builtin_tool_format_type: BuiltinToolFormatType + builtin_tool_input_schema: BuiltinToolInputSchema + builtin_tool_input_schema_type: BuiltinToolInputSchemaType + builtin_tool_safe_for_telemetry: bool | BuiltinToolSafeTelemetryFields + builtin_tool_safe_telemetry_fields: BuiltinToolSafeTelemetryFields cancel_user_requested_shell_command_result: CancelUserRequestedShellCommandResult canvas_action: CanvasAction canvas_action_invoke_request: CanvasActionInvokeRequest @@ -25026,25 +35121,81 @@ class RPC: canvas_provider_invoke_action_request: CanvasProviderInvokeActionRequest canvas_provider_open_request: CanvasProviderOpenRequest canvas_provider_open_result: CanvasProviderOpenResult + canvas_provider_register_request: CanvasProviderRegisterRequest + canvas_provider_unregister_request: CanvasProviderUnregisterRequest canvas_session_context: CanvasSessionContext capi_session_options: CapiSessionOptions + card_digest: CardDigest + card_digest_algorithm: CardDigestAlgorithm + card_digest_value: str + catalog_ai_skill_candidate: CatalogAISkillCandidate + catalog_ai_skill_candidate_provenance: CatalogAISkillCandidateProvenance + catalog_authentication_required_error: CatalogAuthenticationRequiredError + catalog_authentication_required_reason: CatalogAuthenticationRequiredReason + catalog_candidate: CatalogCandidate + catalog_candidate_kind: CatalogCandidateKind + catalog_candidate_source: CatalogCandidateSource + catalog_candidate_source_embedded: CatalogCandidateSourceEmbedded + catalog_candidate_source_url: CatalogCandidateSourceURL + catalog_capability: CatalogCapability + catalog_capability_id: str + catalog_client_contract: CatalogClientContract + catalog_contract_violation_error: CatalogContractViolationError + catalog_contract_violation_reason: CatalogContractViolationReason + catalog_handle_rejected_error: CatalogHandleRejectedError + catalog_handle_rejection_reason: CatalogHandleRejectionReason + catalog_handle_type: CatalogHandleType + catalog_invalid_request_error: CatalogInvalidRequestError + catalog_invalid_request_field: CatalogInvalidRequestField + catalog_malformed_card_error: CatalogMalformedCardError + catalog_malformed_card_reason: CatalogMalformedCardReason + catalog_mcp_server_candidate: CatalogMCPServerCandidate + catalog_mcp_server_candidate_provenance: CatalogMCPServerCandidateProvenance + catalog_mcp_server_installability: CatalogMCPServerInstallabilityEnum + catalog_media_type: CatalogMediaType + catalog_negotiated_contract: CatalogNegotiatedContract + catalog_negotiation_refused_error: CatalogNegotiationRefusedError + catalog_negotiation_refused_reason: CatalogNegotiationRefusedReason + catalog_network_failure_error: CatalogNetworkFailureError + catalog_network_failure_reason: CatalogNetworkFailureReason + catalog_not_installable_error: CatalogNotInstallableError + catalog_not_installable_reason: CatalogNotInstallableReason + catalog_policy_rejected_error: CatalogPolicyRejectedError + catalog_search_request: CatalogSearchRequest + catalog_search_result: CatalogSearchResult + catalog_search_succeeded: CatalogSearchSucceeded + catalog_unavailable_error: CatalogUnavailableError + catalog_unavailable_reason: CatalogUnavailableReason + catalog_unavailable_transport_error: CatalogUnavailableTransportError + catalog_unavailable_transport_reason: CatalogUnavailableTransportReason + catalog_unsafe_retrieval_error: CatalogUnsafeRetrievalError + catalog_unsafe_retrieval_reason: CatalogUnsafeRetrievalReason + catalog_unsupported_kind_error: CatalogUnsupportedKindError command_list: CommandList + commands_finalize_invocation_effect_request: CommandsFinalizeInvocationEffectRequest + commands_finalize_invocation_effect_result: CommandsFinalizeInvocationEffectResult commands_handle_pending_command_request: CommandsHandlePendingCommandRequest commands_handle_pending_command_result: CommandsHandlePendingCommandResult + commands_invocation_effect_outcome: CommandsInvocationEffectOutcome + commands_invocation_origin: CommandsInvocationOrigin 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 + connect_client_info: _ConnectClientInfo 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 @@ -25068,6 +35219,13 @@ class RPC: debug_collect_logs_skipped_entry: DebugCollectLogsSkippedEntry debug_collect_logs_source: DebugCollectLogsSource 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 @@ -25079,11 +35237,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 @@ -25109,22 +35271,42 @@ class RPC: 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 + factory_tool_resume_request: _FactoryToolResumeRequest + factory_tool_run_options: _FactoryToolRunOptions + factory_tool_run_request: _FactoryToolRunRequest filter_mapping: dict[str, ContentFilterMode] | ContentFilterMode fleet_start_request: FleetStartRequest fleet_start_result: FleetStartResult @@ -25135,13 +35317,31 @@ class RPC: git_hub_telemetry_client_info: GitHubTelemetryClientInfo git_hub_telemetry_event: GitHubTelemetryEvent git_hub_telemetry_notification: GitHubTelemetryNotification + git_hub_token_acquire_reason: GitHubTokenAcquireReason + git_hub_token_acquire_request: GitHubTokenAcquireRequest + git_hub_token_acquire_result: GitHubTokenAcquireResult 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 @@ -25165,6 +35365,8 @@ class RPC: 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 @@ -25181,6 +35383,7 @@ class RPC: 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 @@ -25225,26 +35428,70 @@ class RPC: mcp_disable_request: MCPDisableRequest mcp_discover_request: MCPDiscoverRequest mcp_discover_result: MCPDiscoverResult + mcp_elicitation_form_mode: MCPElicitationFormMode mcp_enable_request: MCPEnableRequest mcp_execute_sampling_params: MCPExecuteSamplingParams mcp_execute_sampling_request: dict[str, Any] mcp_execute_sampling_result: dict[str, Any] + mcp_failed_server: MCPFailedServer 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_install_plan: MCPInstallPlan 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_probe_needs_auth_reason: MCPOauthProbeNeedsAuthReason + mcp_oauth_probe_request: MCPOauthProbeRequest + mcp_oauth_probe_result: MCPOauthProbeResult + mcp_oauth_respond_request: MCPOauthRespondRequest + mcp_oauth_respond_result: MCPOauthRespondResult + mcp_plan_configuration_change: MCPPlanConfigurationChange + mcp_plan_configuration_operation: MCPPlanConfigurationOperation + mcp_plan_enum_value_type: MCPPlan + mcp_plan_install_planned: MCPPlanInstallPlanned + mcp_plan_install_request: MCPPlanInstallRequest + mcp_plan_install_result: MCPPlanInstallResult + mcp_plan_install_source: MCPPlanInstallSource + mcp_plan_install_source_candidate: MCPPlanInstallSourceCandidate + mcp_plan_install_source_candidate_kind: MCPPlanInstallSourceCandidateKind + mcp_plan_install_source_card: MCPPlanInstallSourceCard + mcp_plan_install_source_card_kind: MCPPlanInstallSourceCardKind + mcp_plan_package_install_method: MCPPlanPackageInstallMethod + mcp_plan_package_transport: MCPPlanPackageTransport + mcp_plan_policy_decision: MCPPlanPolicyDecision + mcp_plan_policy_result: MCPPlanPolicyResult + mcp_plan_policy_source: MCPPlanPolicySource + mcp_plan_provenance: MCPPlanProvenance + mcp_plan_remote_install_method: MCPPlanRemoteInstallMethod + mcp_plan_remote_transport: MCPPlanRemoteTransport + mcp_plan_required_value: MCPPlanRequiredValue + mcp_plan_required_value_enum: MCPPlanRequiredValueEnum + mcp_plan_required_value_enum_kind: MCPPlan + mcp_plan_required_value_scalar: MCPPlanRequiredValueScalar + mcp_plan_required_value_scalar_kind: MCPPlanRequiredValueScalarKind + mcp_plan_resource_identity: MCPPlanResourceIdentity + mcp_plan_scalar_value_type: MCPPlanScalarValueTypeEnum + mcp_plan_scope: MCPPlanScope + mcp_plan_secret_placeholder: MCPPlanSecretPlaceholder + mcp_plan_secret_reference: str + mcp_plan_target: MCPPlanTarget + mcp_plan_transport_choice: MCPPlanTransportChoice + mcp_plan_transport_choice_package: MCPPlanTransportChoicePackage + mcp_plan_transport_choice_remote: MCPPlanTransportChoiceRemote + mcp_plan_value_category: MCPPlanValueCategory mcp_register_external_client_request: MCPRegisterExternalClientRequest + mcp_reload_config: MCPReloadConfig mcp_reload_with_config_request: MCPReloadWithConfigRequest mcp_remove_git_hub_result: MCPRemoveGitHubResult mcp_resource: MCPResource @@ -25259,17 +35506,29 @@ class RPC: mcp_resources_read_result: MCPResourcesReadResult mcp_resource_template: MCPResourceTemplate mcp_restart_server_request: MCPRestartServerRequest + mcp_safe_for_telemetry: bool | MCPSafeForTelemetryFields + mcp_safe_for_telemetry_fields: MCPSafeForTelemetryFields mcp_sampling_execution_action: MCPSamplingExecutionAction mcp_sampling_execution_result: MCPSamplingExecutionResult + mcp_serializable_server_config: MCPSerializableServerConfig mcp_server: MCPServer mcp_server_auth_config: bool | MCPServerAuthConfigRedirectPort mcp_server_auth_config_redirect_port: MCPServerAuthConfigRedirectPort + mcp_server_card_embedded: MCPServerCardEmbedded + mcp_server_card_embedded_kind: MCPServerCardEmbeddedKind + mcp_server_card_media_type: MCPServerCardMediaType + mcp_server_card_reference: MCPServerCardReference + mcp_server_card_url: MCPServerCardURL + mcp_server_card_url_kind: MCPServerCardURLKind mcp_server_config: MCPServerConfig mcp_server_config_defer_tools: MCPServerConfigDeferTools mcp_server_config_http: MCPServerConfigHTTP mcp_server_config_http_oauth_grant_type: MCPGrantType mcp_server_config_http_type: MCPServerConfigHTTPType + mcp_server_config_memory: MCPServerConfigMemory + mcp_server_config_memory_type: MCPServerConfigMemoryType mcp_server_config_stdio: MCPServerConfigStdio + mcp_server_config_stdio_type: MCPServerConfigStdioType mcp_server_failure_info: MCPServerFailureInfo mcp_server_list: MCPServerList mcp_server_needs_auth_info: MCPServerNeedsAuthInfo @@ -25279,6 +35538,7 @@ class RPC: mcp_start_server_request: MCPStartServerRequest mcp_start_servers_result: MCPStartServersResult mcp_stop_server_request: MCPStopServerRequest + mcp_task_metadata: MCPTaskMetadata mcp_tools: MCPTools mcp_tool_ui: MCPToolUI mcp_tool_ui_visibility: MCPToolUIVisibility @@ -25301,6 +35561,7 @@ class RPC: metadata_snapshot_remote_metadata_repository: MetadataSnapshotRemoteMetadataRepository metadata_snapshot_remote_metadata_task_type: TaskType model: Model + model_apply_startup_overlay_request: ModelApplyStartupOverlayRequest model_billing: ModelBilling model_billing_promo: ModelBillingPromo model_billing_token_prices: ModelBillingTokenPrices @@ -25314,17 +35575,24 @@ class RPC: model_capabilities_override_supports: ModelCapabilitiesOverrideSupports model_capabilities_supports: ModelCapabilitiesSupports model_list: ModelList - model_list_request: ModelListRequest + model_list_request: Any + model_message: ModelMessage model_picker_category: ModelPickerCategory + model_picker_persistence_request: ModelPickerPersistenceRequest model_picker_price_category: ModelPickerPriceCategory + model_picker_settings_context: ModelPickerSettingsContext model_policy: ModelPolicy model_policy_state: ModelPolicyState model_set_reasoning_effort_request: ModelSetReasoningEffortRequest model_set_reasoning_effort_result: ModelSetReasoningEffortResult models_list_request: ModelsListRequest + model_switch_confirmation: ModelSwitchConfirmation model_switch_to_request: ModelSwitchToRequest model_switch_to_result: ModelSwitchToResult + model_warning_text: ModelWarningText mode_set_request: ModeSetRequest + mode_set_result: ModeSetResult + move_mcp_loading_to_background_result: MoveMCPLoadingToBackgroundResult named_provider_config: NamedProviderConfig name_get_result: NameGetResult name_set_auto_request: NameSetAutoRequest @@ -25349,8 +35617,10 @@ class RPC: permission_decision_approve_for_location_approval: PermissionDecisionApproveForLocationApproval permission_decision_approve_for_location_approval_commands: PermissionDecisionApproveForLocationApprovalCommands permission_decision_approve_for_location_approval_custom_tool: PermissionDecisionApproveForLocationApprovalCustomTool + permission_decision_approve_for_location_approval_extension_env_access: PermissionDecisionApproveForLocationApprovalExtensionEnvAccess 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 @@ -25360,8 +35630,10 @@ class RPC: permission_decision_approve_for_session_approval: PermissionDecisionApproveForSessionApproval permission_decision_approve_for_session_approval_commands: PermissionDecisionApproveForSessionApprovalCommands permission_decision_approve_for_session_approval_custom_tool: PermissionDecisionApproveForSessionApprovalCustomTool + permission_decision_approve_for_session_approval_extension_env_access: PermissionDecisionApproveForSessionApprovalExtensionEnvAccess 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 @@ -25370,13 +35642,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 @@ -25384,6 +35660,7 @@ class RPC: permission_location_resolve_params: PermissionLocationResolveParams permission_location_resolve_result: PermissionLocationResolveResult permission_location_type: PermissionLocationType + permission_mode_source: PermissionSource permission_paths_add_params: PermissionPathsAddParams permission_paths_allowed_check_params: PermissionPathsAllowedCheckParams permission_paths_allowed_check_result: PermissionPathsAllowedCheckResult @@ -25394,8 +35671,8 @@ class RPC: permission_paths_workspace_check_result: PermissionPathsWorkspaceCheckResult permission_prompt_shown_notification: PermissionPromptShownNotification permission_request_result: PermissionRequestResult + permission_response_capability: PermissionResponseCapability 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 @@ -25403,12 +35680,15 @@ class RPC: permissions_configure_params: PermissionsConfigureParams permissions_configure_result: PermissionsConfigureResult permissions_folder_trust_add_trusted_result: PermissionsFolderTrustAddTrustedResult - permissions_get_allow_all_request: PermissionsGetAllowAllRequest + permissions_get_mode_request: PermissionsGetModeRequest + permissions_get_mode_result: PermissionsGetModeResult permissions_locations_add_tool_approval_details: PermissionsLocationsAddToolApprovalDetails permissions_locations_add_tool_approval_details_commands: PermissionsLocationsAddToolApprovalDetailsCommands permissions_locations_add_tool_approval_details_custom_tool: PermissionsLocationsAddToolApprovalDetailsCustomTool + permissions_locations_add_tool_approval_details_extension_env_access: PermissionsLocationsAddToolApprovalDetailsExtensionEnvAccess 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 @@ -25425,11 +35705,11 @@ class RPC: permissions_pending_requests_request: PermissionsPendingRequestsRequest permissions_reset_session_approvals_request: PermissionsResetSessionApprovalsRequest permissions_reset_session_approvals_result: PermissionsResetSessionApprovalsResult - permissions_set_allow_all_request: PermissionsSetAllowAllRequest - permissions_set_allow_all_source: PermissionsSetAAllSource permissions_set_approve_all_request: PermissionsSetApproveAllRequest permissions_set_approve_all_result: PermissionsSetApproveAllResult - permissions_set_approve_all_source: PermissionsSetAAllSource + permissions_set_approve_all_source: PermissionSource + permissions_set_mode_request: PermissionsSetModeRequest + permissions_set_mode_result: PermissionsSetModeResult permissions_set_required_request: PermissionsSetRequiredRequest permissions_set_required_result: PermissionsSetRequiredResult permissions_urls_set_unrestricted_mode_result: PermissionsUrlsSetUnrestrictedModeResult @@ -25447,6 +35727,7 @@ class RPC: plugin_install_result: PluginInstallResult plugin_list: PluginList plugin_list_result: PluginListResult + plugins_builtin_set_request: PluginsBuiltinSetRequest plugins_disable_request: PluginsDisableRequest plugins_enable_request: PluginsEnableRequest plugins_install_request: PluginsInstallRequest @@ -25454,12 +35735,14 @@ class RPC: plugins_marketplaces_browse_request: PluginsMarketplacesBrowseRequest plugins_marketplaces_refresh_request: PluginsMarketplacesRefreshRequest plugins_marketplaces_remove_request: PluginsMarketplacesRemoveRequest - plugins_reload_request: PluginsReloadRequest + 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 + protocol_external_tool_defer: MCPServerConfigDeferTools + protocol_external_tool_definition: ProtocolExternalToolDefinition provider_add_request: ProviderAddRequest provider_add_result: ProviderAddResult provider_config: ProviderConfig @@ -25471,7 +35754,7 @@ class RPC: provider_endpoint_transport: ProviderTransport provider_endpoint_type: ProviderType provider_endpoint_wire_api: ProviderWireAPI - provider_get_endpoint_request: ProviderGetEndpointRequest + provider_get_endpoint_request: Any provider_model_config: ProviderModelConfig provider_session_token: ProviderSessionToken provider_token_acquire_request: ProviderTokenAcquireRequest @@ -25499,13 +35782,36 @@ class RPC: 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 @@ -25526,6 +35832,7 @@ class RPC: remote_notify_steerable_changed_request: RemoteNotifySteerableChangedRequest remote_notify_steerable_changed_result: RemoteNotifySteerableChangedResult remote_session_connection_result: RemoteSessionConnectionResult + remote_session_host_status: RemoteSessionHostStatus remote_session_metadata_repository: RemoteSessionMetadataRepository remote_session_metadata_task_type: TaskType remote_session_metadata_value: RemoteSessionMetadataValue @@ -25533,14 +35840,24 @@ class RPC: remote_session_repository: RemoteSessionRepository run_options: RunOptions sandbox_config: SandboxConfig + sandbox_config_auth: SandboxConfigAuth + sandbox_config_source: _SandboxConfigSource 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 @@ -25553,14 +35870,21 @@ class RPC: 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_login_request: SessionAuthLoginRequest + session_auth_logout_user_request: SessionAuthLogoutUserRequest session_auth_status: SessionAuthStatus + session_auth_switch_request: SessionAuthSwitchRequest 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 @@ -25590,23 +35914,45 @@ 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_git_hub_auth_get_all_auth_available_result: list[SessionAuthStatus] + session_git_hub_auth_logout_result: bool + session_git_hub_auth_logout_user_result: bool + session_history_compact_request: SessionHistoryCompactRequest session_installed_plugin: SessionInstalledPlugin session_installed_plugin_source: SessionInstalledPluginSource | str 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_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 @@ -25617,12 +35963,15 @@ class RPC: 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 @@ -25648,9 +35997,13 @@ class RPC: 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 @@ -25686,13 +36039,20 @@ class RPC: session_visibility_status: SessionVisibilityStatus session_working_directory_context: SessionWorkingDirectoryContext session_working_directory_context_host_type: HostType + settable_auth_info: SettableAuthInfo + settable_token_auth_info: SettableTokenAuthInfo shell_cancel_user_requested_request: ShellCancelUserRequestedRequest + shell_credentials: ShellCredentials 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 @@ -25700,6 +36060,7 @@ class RPC: skill_discovery_scope: SkillDiscoveryScope skill_list: SkillList skills_config_set_disabled_skills_request: SkillsConfigSetDisabledSkillsRequest + skills_config_set_skill_disabled_request: SkillsConfigSetSkillDisabledRequest skills_disable_request: SkillsDisableRequest skills_discover_request: SkillsDiscoverRequest skills_enable_request: SkillsEnableRequest @@ -25707,6 +36068,7 @@ class RPC: skills_get_invoked_result: SkillsGetInvokedResult skills_invoked_skill: SkillsInvokedSkill skills_load_diagnostics: SkillsLoadDiagnostics + slash_command_add_timeline_entry_result: SlashCommandAddTimelineEntryResult slash_command_agent_prompt_result: SlashCommandAgentPromptResult slash_command_completed_result: SlashCommandCompletedResult slash_command_info: SlashCommandInfo @@ -25715,13 +36077,20 @@ class RPC: slash_command_input_completion: SlashCommandInputCompletion slash_command_invocation_result: SlashCommandInvocationResult slash_command_kind: SlashCommandKind + slash_command_model_picker_dialog: SlashCommandModelPickerDialog slash_command_select_subcommand_option: SlashCommandSelectSubcommandOption slash_command_select_subcommand_result: SlashCommandSelectSubcommandResult + slash_command_set_model_result: SlashCommandSetModelResult + slash_command_set_plan_model_result: SlashCommandSetPlanModelResult + slash_command_show_dialog_result: SlashCommandShowDialogResult slash_command_text_result: SlashCommandTextResult + slash_command_timeline_entry: SlashCommandTimelineEntry subagent_settings_entry: SubagentSettingsEntry subagent_settings_entry_context_tier: SubagentSettingsEntryContextTier task_agent_info: TaskAgentInfo task_agent_progress: TaskAgentProgress + task_complete_data: TaskCompleteData + task_completion_decision: TaskCompletionDecision task_execution_mode: TaskExecutionMode task_info: TaskInfo task_list: TaskList @@ -25748,11 +36117,23 @@ class RPC: tasks_wait_for_pending_result: TasksWaitForPendingResult telemetry_set_feature_overrides_request: TelemetrySetFeatureOverridesRequest token_auth_info: TokenAuthInfo + token_provider_auth_info: TokenProviderAuthInfo tool: Tool tool_list: ToolList + tool_result: ToolResultExpanded | str + tool_result_expanded: ToolResultExpanded + tool_result_new_message: ToolResultNewMessage + tool_result_type: ToolResultType + tools_execute_request: ToolsExecuteRequest + tools_get_builtin_descriptors_request: ToolsGetBuiltinDescriptorsRequest + tools_get_builtin_descriptors_result: ToolsGetBuiltinDescriptorsResult tools_get_current_metadata_result: ToolsGetCurrentMetadataResult tools_initialize_and_validate_result: ToolsInitializeAndValidateResult tools_list_request: ToolsListRequest + tools_set_request: ToolsSetRequest + tools_set_result: ToolsSetResult + tools_shell_descriptor_config: ToolsShellDescriptorConfig + tools_task_complete_event_data_request: ToolsTaskCompleteEventDataRequest tools_update_subagent_settings_result: ToolsUpdateSubagentSettingsResult ui_auto_mode_switch_response: UIAutoModeSwitchResponse ui_elicitation_array_any_of_field: UIElicitationArrayAnyOfField @@ -25796,6 +36177,7 @@ class RPC: ui_user_input_response: UIUserInputResponse update_subagent_settings_request: UpdateSubagentSettingsRequest usage_get_metrics_result: UsageGetMetricsResult + usage_metrics_agent_metric: UsageMetricsAgentMetric usage_metrics_code_changes: UsageMetricsCodeChanges usage_metrics_model_metric: UsageMetricsModelMetric usage_metrics_model_metric_requests: UsageMetricsModelMetricRequests @@ -25815,20 +36197,31 @@ class RPC: 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_auth_info_result: AuthIdentity | None = None session_context_attribution: SessionContextAttribution | None = None session_context_info: SessionContextInfo | None = None subagent_settings: SubagentSettings | None = None @@ -25858,6 +36251,7 @@ def from_dict(obj: Any) -> 'RPC': 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")) @@ -25878,12 +36272,23 @@ def from_dict(obj: Any) -> 'RPC': 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_identity = AuthIdentity.from_dict(obj.get("AuthIdentity")) auth_info = _load_AuthInfo(obj.get("AuthInfo")) auth_info_type = AuthInfoType(obj.get("AuthInfoType")) + auth_validation_error = AuthValidationError.from_dict(obj.get("AuthValidationError")) + auth_validation_errors = from_list(AuthValidationError.from_dict, obj.get("AuthValidationErrors")) + built_in_model_catalog = BuiltInModelCatalog.from_dict(obj.get("BuiltInModelCatalog")) + built_in_model_catalog_entry = BuiltInModelCatalogEntry.from_dict(obj.get("BuiltInModelCatalogEntry")) + builtin_tool_descriptor = BuiltinToolDescriptor.from_dict(obj.get("BuiltinToolDescriptor")) + builtin_tool_format = BuiltinToolFormat.from_dict(obj.get("BuiltinToolFormat")) + builtin_tool_format_type = BuiltinToolFormatType(obj.get("BuiltinToolFormatType")) + builtin_tool_input_schema = BuiltinToolInputSchema.from_dict(obj.get("BuiltinToolInputSchema")) + builtin_tool_input_schema_type = BuiltinToolInputSchemaType(obj.get("BuiltinToolInputSchemaType")) + builtin_tool_safe_for_telemetry = from_union([from_bool, BuiltinToolSafeTelemetryFields.from_dict], obj.get("BuiltinToolSafeForTelemetry")) + builtin_tool_safe_telemetry_fields = BuiltinToolSafeTelemetryFields.from_dict(obj.get("BuiltinToolSafeTelemetryFields")) 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")) @@ -25899,25 +36304,81 @@ def from_dict(obj: Any) -> 'RPC': canvas_provider_invoke_action_request = CanvasProviderInvokeActionRequest.from_dict(obj.get("CanvasProviderInvokeActionRequest")) canvas_provider_open_request = CanvasProviderOpenRequest.from_dict(obj.get("CanvasProviderOpenRequest")) canvas_provider_open_result = CanvasProviderOpenResult.from_dict(obj.get("CanvasProviderOpenResult")) + canvas_provider_register_request = CanvasProviderRegisterRequest.from_dict(obj.get("CanvasProviderRegisterRequest")) + canvas_provider_unregister_request = CanvasProviderUnregisterRequest.from_dict(obj.get("CanvasProviderUnregisterRequest")) canvas_session_context = CanvasSessionContext.from_dict(obj.get("CanvasSessionContext")) capi_session_options = CapiSessionOptions.from_dict(obj.get("CapiSessionOptions")) + card_digest = CardDigest.from_dict(obj.get("CardDigest")) + card_digest_algorithm = CardDigestAlgorithm(obj.get("CardDigestAlgorithm")) + card_digest_value = from_str(obj.get("CardDigestValue")) + catalog_ai_skill_candidate = CatalogAISkillCandidate.from_dict(obj.get("CatalogAiSkillCandidate")) + catalog_ai_skill_candidate_provenance = CatalogAISkillCandidateProvenance.from_dict(obj.get("CatalogAiSkillCandidateProvenance")) + catalog_authentication_required_error = CatalogAuthenticationRequiredError.from_dict(obj.get("CatalogAuthenticationRequiredError")) + catalog_authentication_required_reason = CatalogAuthenticationRequiredReason(obj.get("CatalogAuthenticationRequiredReason")) + catalog_candidate = CatalogCandidate.from_dict(obj.get("CatalogCandidate")) + catalog_candidate_kind = CatalogCandidateKind(obj.get("CatalogCandidateKind")) + catalog_candidate_source = _load_CatalogCandidateSource(obj.get("CatalogCandidateSource")) + catalog_candidate_source_embedded = CatalogCandidateSourceEmbedded.from_dict(obj.get("CatalogCandidateSourceEmbedded")) + catalog_candidate_source_url = CatalogCandidateSourceURL.from_dict(obj.get("CatalogCandidateSourceUrl")) + catalog_capability = CatalogCapability(obj.get("CatalogCapability")) + catalog_capability_id = from_str(obj.get("CatalogCapabilityId")) + catalog_client_contract = CatalogClientContract.from_dict(obj.get("CatalogClientContract")) + catalog_contract_violation_error = CatalogContractViolationError.from_dict(obj.get("CatalogContractViolationError")) + catalog_contract_violation_reason = CatalogContractViolationReason(obj.get("CatalogContractViolationReason")) + catalog_handle_rejected_error = CatalogHandleRejectedError.from_dict(obj.get("CatalogHandleRejectedError")) + catalog_handle_rejection_reason = CatalogHandleRejectionReason(obj.get("CatalogHandleRejectionReason")) + catalog_handle_type = CatalogHandleType(obj.get("CatalogHandleType")) + catalog_invalid_request_error = CatalogInvalidRequestError.from_dict(obj.get("CatalogInvalidRequestError")) + catalog_invalid_request_field = CatalogInvalidRequestField(obj.get("CatalogInvalidRequestField")) + catalog_malformed_card_error = CatalogMalformedCardError.from_dict(obj.get("CatalogMalformedCardError")) + catalog_malformed_card_reason = CatalogMalformedCardReason(obj.get("CatalogMalformedCardReason")) + catalog_mcp_server_candidate = CatalogMCPServerCandidate.from_dict(obj.get("CatalogMcpServerCandidate")) + catalog_mcp_server_candidate_provenance = CatalogMCPServerCandidateProvenance.from_dict(obj.get("CatalogMcpServerCandidateProvenance")) + catalog_mcp_server_installability = CatalogMCPServerInstallabilityEnum(obj.get("CatalogMcpServerInstallability")) + catalog_media_type = CatalogMediaType(obj.get("CatalogMediaType")) + catalog_negotiated_contract = CatalogNegotiatedContract.from_dict(obj.get("CatalogNegotiatedContract")) + catalog_negotiation_refused_error = CatalogNegotiationRefusedError.from_dict(obj.get("CatalogNegotiationRefusedError")) + catalog_negotiation_refused_reason = CatalogNegotiationRefusedReason(obj.get("CatalogNegotiationRefusedReason")) + catalog_network_failure_error = CatalogNetworkFailureError.from_dict(obj.get("CatalogNetworkFailureError")) + catalog_network_failure_reason = CatalogNetworkFailureReason(obj.get("CatalogNetworkFailureReason")) + catalog_not_installable_error = CatalogNotInstallableError.from_dict(obj.get("CatalogNotInstallableError")) + catalog_not_installable_reason = CatalogNotInstallableReason(obj.get("CatalogNotInstallableReason")) + catalog_policy_rejected_error = CatalogPolicyRejectedError.from_dict(obj.get("CatalogPolicyRejectedError")) + catalog_search_request = CatalogSearchRequest.from_dict(obj.get("CatalogSearchRequest")) + catalog_search_result = _load_CatalogSearchResult(obj.get("CatalogSearchResult")) + catalog_search_succeeded = CatalogSearchSucceeded.from_dict(obj.get("CatalogSearchSucceeded")) + catalog_unavailable_error = CatalogUnavailableError.from_dict(obj.get("CatalogUnavailableError")) + catalog_unavailable_reason = CatalogUnavailableReason(obj.get("CatalogUnavailableReason")) + catalog_unavailable_transport_error = CatalogUnavailableTransportError.from_dict(obj.get("CatalogUnavailableTransportError")) + catalog_unavailable_transport_reason = CatalogUnavailableTransportReason(obj.get("CatalogUnavailableTransportReason")) + catalog_unsafe_retrieval_error = CatalogUnsafeRetrievalError.from_dict(obj.get("CatalogUnsafeRetrievalError")) + catalog_unsafe_retrieval_reason = CatalogUnsafeRetrievalReason(obj.get("CatalogUnsafeRetrievalReason")) + catalog_unsupported_kind_error = CatalogUnsupportedKindError.from_dict(obj.get("CatalogUnsupportedKindError")) command_list = CommandList.from_dict(obj.get("CommandList")) + commands_finalize_invocation_effect_request = CommandsFinalizeInvocationEffectRequest.from_dict(obj.get("CommandsFinalizeInvocationEffectRequest")) + commands_finalize_invocation_effect_result = CommandsFinalizeInvocationEffectResult.from_dict(obj.get("CommandsFinalizeInvocationEffectResult")) commands_handle_pending_command_request = CommandsHandlePendingCommandRequest.from_dict(obj.get("CommandsHandlePendingCommandRequest")) commands_handle_pending_command_result = CommandsHandlePendingCommandResult.from_dict(obj.get("CommandsHandlePendingCommandResult")) + commands_invocation_effect_outcome = CommandsInvocationEffectOutcome(obj.get("CommandsInvocationEffectOutcome")) + commands_invocation_origin = CommandsInvocationOrigin(obj.get("CommandsInvocationOrigin")) 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")) + connect_client_info = _ConnectClientInfo.from_dict(obj.get("ConnectClientInfo")) 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")) @@ -25941,6 +36402,13 @@ def from_dict(obj: Any) -> 'RPC': debug_collect_logs_skipped_entry = DebugCollectLogsSkippedEntry.from_dict(obj.get("DebugCollectLogsSkippedEntry")) debug_collect_logs_source = DebugCollectLogsSource(obj.get("DebugCollectLogsSource")) 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")) @@ -25952,11 +36420,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")) @@ -25982,22 +36454,42 @@ def from_dict(obj: Any) -> 'RPC': 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")) + factory_tool_resume_request = _FactoryToolResumeRequest.from_dict(obj.get("FactoryToolResumeRequest")) + factory_tool_run_options = _FactoryToolRunOptions.from_dict(obj.get("FactoryToolRunOptions")) + factory_tool_run_request = _FactoryToolRunRequest.from_dict(obj.get("FactoryToolRunRequest")) 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")) @@ -26008,13 +36500,31 @@ def from_dict(obj: Any) -> 'RPC': 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")) + git_hub_token_acquire_reason = GitHubTokenAcquireReason(obj.get("GitHubTokenAcquireReason")) + git_hub_token_acquire_request = GitHubTokenAcquireRequest.from_dict(obj.get("GitHubTokenAcquireRequest")) + git_hub_token_acquire_result = GitHubTokenAcquireResult.from_dict(obj.get("GitHubTokenAcquireResult")) 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")) @@ -26038,6 +36548,8 @@ def from_dict(obj: Any) -> 'RPC': 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")) @@ -26054,6 +36566,7 @@ def from_dict(obj: Any) -> 'RPC': 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")) @@ -26098,26 +36611,70 @@ def from_dict(obj: Any) -> 'RPC': 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")) + mcp_elicitation_form_mode = MCPElicitationFormMode(obj.get("McpElicitationFormMode")) mcp_enable_request = MCPEnableRequest.from_dict(obj.get("McpEnableRequest")) 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_failed_server = MCPFailedServer.from_dict(obj.get("McpFailedServer")) 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_install_plan = MCPInstallPlan.from_dict(obj.get("McpInstallPlan")) 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_probe_needs_auth_reason = MCPOauthProbeNeedsAuthReason(obj.get("McpOauthProbeNeedsAuthReason")) + mcp_oauth_probe_request = MCPOauthProbeRequest.from_dict(obj.get("McpOauthProbeRequest")) + mcp_oauth_probe_result = MCPOauthProbeResult.from_dict(obj.get("McpOauthProbeResult")) + mcp_oauth_respond_request = MCPOauthRespondRequest.from_dict(obj.get("McpOauthRespondRequest")) + mcp_oauth_respond_result = MCPOauthRespondResult.from_dict(obj.get("McpOauthRespondResult")) + mcp_plan_configuration_change = MCPPlanConfigurationChange.from_dict(obj.get("McpPlanConfigurationChange")) + mcp_plan_configuration_operation = MCPPlanConfigurationOperation(obj.get("McpPlanConfigurationOperation")) + mcp_plan_enum_value_type = MCPPlan(obj.get("McpPlanEnumValueType")) + mcp_plan_install_planned = MCPPlanInstallPlanned.from_dict(obj.get("McpPlanInstallPlanned")) + mcp_plan_install_request = MCPPlanInstallRequest.from_dict(obj.get("McpPlanInstallRequest")) + mcp_plan_install_result = _load_MCPPlanInstallResult(obj.get("McpPlanInstallResult")) + mcp_plan_install_source = _load_MCPPlanInstallSource(obj.get("McpPlanInstallSource")) + mcp_plan_install_source_candidate = MCPPlanInstallSourceCandidate.from_dict(obj.get("McpPlanInstallSourceCandidate")) + mcp_plan_install_source_candidate_kind = MCPPlanInstallSourceCandidateKind(obj.get("McpPlanInstallSourceCandidateKind")) + mcp_plan_install_source_card = MCPPlanInstallSourceCard.from_dict(obj.get("McpPlanInstallSourceCard")) + mcp_plan_install_source_card_kind = MCPPlanInstallSourceCardKind(obj.get("McpPlanInstallSourceCardKind")) + mcp_plan_package_install_method = MCPPlanPackageInstallMethod(obj.get("McpPlanPackageInstallMethod")) + mcp_plan_package_transport = MCPPlanPackageTransport(obj.get("McpPlanPackageTransport")) + mcp_plan_policy_decision = MCPPlanPolicyDecision(obj.get("McpPlanPolicyDecision")) + mcp_plan_policy_result = MCPPlanPolicyResult.from_dict(obj.get("McpPlanPolicyResult")) + mcp_plan_policy_source = MCPPlanPolicySource(obj.get("McpPlanPolicySource")) + mcp_plan_provenance = MCPPlanProvenance.from_dict(obj.get("McpPlanProvenance")) + mcp_plan_remote_install_method = MCPPlanRemoteInstallMethod(obj.get("McpPlanRemoteInstallMethod")) + mcp_plan_remote_transport = MCPPlanRemoteTransport(obj.get("McpPlanRemoteTransport")) + mcp_plan_required_value = _load_MCPPlanRequiredValue(obj.get("McpPlanRequiredValue")) + mcp_plan_required_value_enum = MCPPlanRequiredValueEnum.from_dict(obj.get("McpPlanRequiredValueEnum")) + mcp_plan_required_value_enum_kind = MCPPlan(obj.get("McpPlanRequiredValueEnumKind")) + mcp_plan_required_value_scalar = MCPPlanRequiredValueScalar.from_dict(obj.get("McpPlanRequiredValueScalar")) + mcp_plan_required_value_scalar_kind = MCPPlanRequiredValueScalarKind(obj.get("McpPlanRequiredValueScalarKind")) + mcp_plan_resource_identity = MCPPlanResourceIdentity.from_dict(obj.get("McpPlanResourceIdentity")) + mcp_plan_scalar_value_type = MCPPlanScalarValueTypeEnum(obj.get("McpPlanScalarValueType")) + mcp_plan_scope = MCPPlanScope(obj.get("McpPlanScope")) + mcp_plan_secret_placeholder = MCPPlanSecretPlaceholder.from_dict(obj.get("McpPlanSecretPlaceholder")) + mcp_plan_secret_reference = from_str(obj.get("McpPlanSecretReference")) + mcp_plan_target = MCPPlanTarget.from_dict(obj.get("McpPlanTarget")) + mcp_plan_transport_choice = _load_MCPPlanTransportChoice(obj.get("McpPlanTransportChoice")) + mcp_plan_transport_choice_package = MCPPlanTransportChoicePackage.from_dict(obj.get("McpPlanTransportChoicePackage")) + mcp_plan_transport_choice_remote = MCPPlanTransportChoiceRemote.from_dict(obj.get("McpPlanTransportChoiceRemote")) + mcp_plan_value_category = MCPPlanValueCategory(obj.get("McpPlanValueCategory")) mcp_register_external_client_request = MCPRegisterExternalClientRequest.from_dict(obj.get("McpRegisterExternalClientRequest")) + mcp_reload_config = MCPReloadConfig.from_dict(obj.get("McpReloadConfig")) 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")) @@ -26132,17 +36689,29 @@ def from_dict(obj: Any) -> 'RPC': 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_safe_for_telemetry = from_union([from_bool, MCPSafeForTelemetryFields.from_dict], obj.get("McpSafeForTelemetry")) + mcp_safe_for_telemetry_fields = MCPSafeForTelemetryFields.from_dict(obj.get("McpSafeForTelemetryFields")) mcp_sampling_execution_action = MCPSamplingExecutionAction(obj.get("McpSamplingExecutionAction")) mcp_sampling_execution_result = MCPSamplingExecutionResult.from_dict(obj.get("McpSamplingExecutionResult")) + mcp_serializable_server_config = MCPSerializableServerConfig.from_dict(obj.get("McpSerializableServerConfig")) 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_card_embedded = MCPServerCardEmbedded.from_dict(obj.get("McpServerCardEmbedded")) + mcp_server_card_embedded_kind = MCPServerCardEmbeddedKind(obj.get("McpServerCardEmbeddedKind")) + mcp_server_card_media_type = MCPServerCardMediaType(obj.get("McpServerCardMediaType")) + mcp_server_card_reference = _load_MCPServerCardReference(obj.get("McpServerCardReference")) + mcp_server_card_url = MCPServerCardURL.from_dict(obj.get("McpServerCardUrl")) + mcp_server_card_url_kind = MCPServerCardURLKind(obj.get("McpServerCardUrlKind")) 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 = MCPGrantType(obj.get("McpServerConfigHttpOauthGrantType")) mcp_server_config_http_type = MCPServerConfigHTTPType(obj.get("McpServerConfigHttpType")) + mcp_server_config_memory = MCPServerConfigMemory.from_dict(obj.get("McpServerConfigMemory")) + mcp_server_config_memory_type = MCPServerConfigMemoryType(obj.get("McpServerConfigMemoryType")) mcp_server_config_stdio = MCPServerConfigStdio.from_dict(obj.get("McpServerConfigStdio")) + mcp_server_config_stdio_type = MCPServerConfigStdioType(obj.get("McpServerConfigStdioType")) 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")) @@ -26152,6 +36721,7 @@ def from_dict(obj: Any) -> 'RPC': 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_task_metadata = MCPTaskMetadata.from_dict(obj.get("McpTaskMetadata")) 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")) @@ -26174,6 +36744,7 @@ def from_dict(obj: Any) -> 'RPC': metadata_snapshot_remote_metadata_repository = MetadataSnapshotRemoteMetadataRepository.from_dict(obj.get("MetadataSnapshotRemoteMetadataRepository")) metadata_snapshot_remote_metadata_task_type = TaskType(obj.get("MetadataSnapshotRemoteMetadataTaskType")) model = Model.from_dict(obj.get("Model")) + model_apply_startup_overlay_request = ModelApplyStartupOverlayRequest.from_dict(obj.get("ModelApplyStartupOverlayRequest")) 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")) @@ -26187,17 +36758,24 @@ def from_dict(obj: Any) -> 'RPC': model_capabilities_override_supports = ModelCapabilitiesOverrideSupports.from_dict(obj.get("ModelCapabilitiesOverrideSupports")) model_capabilities_supports = ModelCapabilitiesSupports.from_dict(obj.get("ModelCapabilitiesSupports")) model_list = ModelList.from_dict(obj.get("ModelList")) - model_list_request = ModelListRequest.from_dict(obj.get("ModelListRequest")) + model_list_request = obj.get("ModelListRequest") + model_message = ModelMessage.from_dict(obj.get("ModelMessage")) model_picker_category = ModelPickerCategory(obj.get("ModelPickerCategory")) + model_picker_persistence_request = ModelPickerPersistenceRequest.from_dict(obj.get("ModelPickerPersistenceRequest")) model_picker_price_category = ModelPickerPriceCategory(obj.get("ModelPickerPriceCategory")) + model_picker_settings_context = ModelPickerSettingsContext.from_dict(obj.get("ModelPickerSettingsContext")) model_policy = ModelPolicy.from_dict(obj.get("ModelPolicy")) model_policy_state = ModelPolicyState(obj.get("ModelPolicyState")) model_set_reasoning_effort_request = ModelSetReasoningEffortRequest.from_dict(obj.get("ModelSetReasoningEffortRequest")) model_set_reasoning_effort_result = ModelSetReasoningEffortResult.from_dict(obj.get("ModelSetReasoningEffortResult")) models_list_request = ModelsListRequest.from_dict(obj.get("ModelsListRequest")) + model_switch_confirmation = ModelSwitchConfirmation.from_dict(obj.get("ModelSwitchConfirmation")) model_switch_to_request = ModelSwitchToRequest.from_dict(obj.get("ModelSwitchToRequest")) model_switch_to_result = ModelSwitchToResult.from_dict(obj.get("ModelSwitchToResult")) + model_warning_text = ModelWarningText.from_dict(obj.get("ModelWarningText")) mode_set_request = ModeSetRequest.from_dict(obj.get("ModeSetRequest")) + mode_set_result = ModeSetResult.from_dict(obj.get("ModeSetResult")) + move_mcp_loading_to_background_result = MoveMCPLoadingToBackgroundResult.from_dict(obj.get("MoveMcpLoadingToBackgroundResult")) 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")) @@ -26222,8 +36800,10 @@ def from_dict(obj: Any) -> 'RPC': permission_decision_approve_for_location_approval = _load_PermissionDecisionApproveForLocationApproval(obj.get("PermissionDecisionApproveForLocationApproval")) permission_decision_approve_for_location_approval_commands = PermissionDecisionApproveForLocationApprovalCommands.from_dict(obj.get("PermissionDecisionApproveForLocationApprovalCommands")) permission_decision_approve_for_location_approval_custom_tool = PermissionDecisionApproveForLocationApprovalCustomTool.from_dict(obj.get("PermissionDecisionApproveForLocationApprovalCustomTool")) + permission_decision_approve_for_location_approval_extension_env_access = PermissionDecisionApproveForLocationApprovalExtensionEnvAccess.from_dict(obj.get("PermissionDecisionApproveForLocationApprovalExtensionEnvAccess")) 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")) @@ -26233,8 +36813,10 @@ def from_dict(obj: Any) -> 'RPC': permission_decision_approve_for_session_approval = _load_PermissionDecisionApproveForSessionApproval(obj.get("PermissionDecisionApproveForSessionApproval")) permission_decision_approve_for_session_approval_commands = PermissionDecisionApproveForSessionApprovalCommands.from_dict(obj.get("PermissionDecisionApproveForSessionApprovalCommands")) permission_decision_approve_for_session_approval_custom_tool = PermissionDecisionApproveForSessionApprovalCustomTool.from_dict(obj.get("PermissionDecisionApproveForSessionApprovalCustomTool")) + permission_decision_approve_for_session_approval_extension_env_access = PermissionDecisionApproveForSessionApprovalExtensionEnvAccess.from_dict(obj.get("PermissionDecisionApproveForSessionApprovalExtensionEnvAccess")) 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")) @@ -26243,13 +36825,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")) @@ -26257,6 +36843,7 @@ def from_dict(obj: Any) -> 'RPC': permission_location_resolve_params = PermissionLocationResolveParams.from_dict(obj.get("PermissionLocationResolveParams")) permission_location_resolve_result = PermissionLocationResolveResult.from_dict(obj.get("PermissionLocationResolveResult")) permission_location_type = PermissionLocationType(obj.get("PermissionLocationType")) + permission_mode_source = PermissionSource(obj.get("PermissionModeSource")) permission_paths_add_params = PermissionPathsAddParams.from_dict(obj.get("PermissionPathsAddParams")) permission_paths_allowed_check_params = PermissionPathsAllowedCheckParams.from_dict(obj.get("PermissionPathsAllowedCheckParams")) permission_paths_allowed_check_result = PermissionPathsAllowedCheckResult.from_dict(obj.get("PermissionPathsAllowedCheckResult")) @@ -26267,8 +36854,8 @@ def from_dict(obj: Any) -> 'RPC': permission_paths_workspace_check_result = PermissionPathsWorkspaceCheckResult.from_dict(obj.get("PermissionPathsWorkspaceCheckResult")) permission_prompt_shown_notification = PermissionPromptShownNotification.from_dict(obj.get("PermissionPromptShownNotification")) permission_request_result = PermissionRequestResult.from_dict(obj.get("PermissionRequestResult")) + permission_response_capability = PermissionResponseCapability(obj.get("PermissionResponseCapability")) 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")) @@ -26276,12 +36863,15 @@ def from_dict(obj: Any) -> 'RPC': 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")) - permissions_get_allow_all_request = PermissionsGetAllowAllRequest.from_dict(obj.get("PermissionsGetAllowAllRequest")) + permissions_get_mode_request = PermissionsGetModeRequest.from_dict(obj.get("PermissionsGetModeRequest")) + permissions_get_mode_result = PermissionsGetModeResult.from_dict(obj.get("PermissionsGetModeResult")) permissions_locations_add_tool_approval_details = _load_PermissionsLocationsAddToolApprovalDetails(obj.get("PermissionsLocationsAddToolApprovalDetails")) permissions_locations_add_tool_approval_details_commands = PermissionsLocationsAddToolApprovalDetailsCommands.from_dict(obj.get("PermissionsLocationsAddToolApprovalDetailsCommands")) permissions_locations_add_tool_approval_details_custom_tool = PermissionsLocationsAddToolApprovalDetailsCustomTool.from_dict(obj.get("PermissionsLocationsAddToolApprovalDetailsCustomTool")) + permissions_locations_add_tool_approval_details_extension_env_access = PermissionsLocationsAddToolApprovalDetailsExtensionEnvAccess.from_dict(obj.get("PermissionsLocationsAddToolApprovalDetailsExtensionEnvAccess")) 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")) @@ -26298,11 +36888,11 @@ def from_dict(obj: Any) -> 'RPC': permissions_pending_requests_request = PermissionsPendingRequestsRequest.from_dict(obj.get("PermissionsPendingRequestsRequest")) permissions_reset_session_approvals_request = PermissionsResetSessionApprovalsRequest.from_dict(obj.get("PermissionsResetSessionApprovalsRequest")) permissions_reset_session_approvals_result = PermissionsResetSessionApprovalsResult.from_dict(obj.get("PermissionsResetSessionApprovalsResult")) - permissions_set_allow_all_request = PermissionsSetAllowAllRequest.from_dict(obj.get("PermissionsSetAllowAllRequest")) - permissions_set_allow_all_source = PermissionsSetAAllSource(obj.get("PermissionsSetAllowAllSource")) permissions_set_approve_all_request = PermissionsSetApproveAllRequest.from_dict(obj.get("PermissionsSetApproveAllRequest")) permissions_set_approve_all_result = PermissionsSetApproveAllResult.from_dict(obj.get("PermissionsSetApproveAllResult")) - permissions_set_approve_all_source = PermissionsSetAAllSource(obj.get("PermissionsSetApproveAllSource")) + permissions_set_approve_all_source = PermissionSource(obj.get("PermissionsSetApproveAllSource")) + permissions_set_mode_request = PermissionsSetModeRequest.from_dict(obj.get("PermissionsSetModeRequest")) + permissions_set_mode_result = PermissionsSetModeResult.from_dict(obj.get("PermissionsSetModeResult")) permissions_set_required_request = PermissionsSetRequiredRequest.from_dict(obj.get("PermissionsSetRequiredRequest")) permissions_set_required_result = PermissionsSetRequiredResult.from_dict(obj.get("PermissionsSetRequiredResult")) permissions_urls_set_unrestricted_mode_result = PermissionsUrlsSetUnrestrictedModeResult.from_dict(obj.get("PermissionsUrlsSetUnrestrictedModeResult")) @@ -26320,6 +36910,7 @@ def from_dict(obj: Any) -> 'RPC': 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_builtin_set_request = PluginsBuiltinSetRequest.from_dict(obj.get("PluginsBuiltinSetRequest")) 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")) @@ -26327,12 +36918,14 @@ def from_dict(obj: Any) -> 'RPC': 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 = PluginsReloadRequest.from_dict(obj.get("PluginsReloadRequest")) + 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")) + protocol_external_tool_defer = MCPServerConfigDeferTools(obj.get("ProtocolExternalToolDefer")) + protocol_external_tool_definition = ProtocolExternalToolDefinition.from_dict(obj.get("ProtocolExternalToolDefinition")) 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")) @@ -26344,7 +36937,7 @@ def from_dict(obj: Any) -> 'RPC': 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 = ProviderGetEndpointRequest.from_dict(obj.get("ProviderGetEndpointRequest")) + 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")) @@ -26372,13 +36965,36 @@ def from_dict(obj: Any) -> 'RPC': 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")) @@ -26399,6 +37015,7 @@ def from_dict(obj: Any) -> 'RPC': 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_host_status = RemoteSessionHostStatus(obj.get("RemoteSessionHostStatus")) 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")) @@ -26406,14 +37023,24 @@ def from_dict(obj: Any) -> 'RPC': 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_source = _SandboxConfigSource(obj.get("SandboxConfigSource")) 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")) @@ -26426,14 +37053,21 @@ def from_dict(obj: Any) -> 'RPC': 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_login_request = SessionAuthLoginRequest.from_dict(obj.get("SessionAuthLoginRequest")) + session_auth_logout_user_request = SessionAuthLogoutUserRequest.from_dict(obj.get("SessionAuthLogoutUserRequest")) session_auth_status = SessionAuthStatus.from_dict(obj.get("SessionAuthStatus")) + session_auth_switch_request = SessionAuthSwitchRequest.from_dict(obj.get("SessionAuthSwitchRequest")) 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")) @@ -26463,23 +37097,45 @@ 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_git_hub_auth_get_all_auth_available_result = from_list(SessionAuthStatus.from_dict, obj.get("SessionGitHubAuthGetAllAuthAvailableResult")) + session_git_hub_auth_logout_result = from_bool(obj.get("SessionGitHubAuthLogoutResult")) + session_git_hub_auth_logout_user_result = from_bool(obj.get("SessionGitHubAuthLogoutUserResult")) + 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_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_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")) @@ -26490,12 +37146,15 @@ def from_dict(obj: Any) -> 'RPC': 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")) @@ -26521,9 +37180,13 @@ def from_dict(obj: Any) -> 'RPC': 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")) @@ -26559,13 +37222,20 @@ def from_dict(obj: Any) -> 'RPC': 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")) + settable_auth_info = _load_SettableAuthInfo(obj.get("SettableAuthInfo")) + settable_token_auth_info = SettableTokenAuthInfo.from_dict(obj.get("SettableTokenAuthInfo")) shell_cancel_user_requested_request = ShellCancelUserRequestedRequest.from_dict(obj.get("ShellCancelUserRequestedRequest")) + shell_credentials = ShellCredentials.from_dict(obj.get("ShellCredentials")) 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")) @@ -26573,6 +37243,7 @@ def from_dict(obj: Any) -> 'RPC': 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_config_set_skill_disabled_request = SkillsConfigSetSkillDisabledRequest.from_dict(obj.get("SkillsConfigSetSkillDisabledRequest")) 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")) @@ -26580,6 +37251,7 @@ def from_dict(obj: Any) -> 'RPC': 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")) + slash_command_add_timeline_entry_result = SlashCommandAddTimelineEntryResult.from_dict(obj.get("SlashCommandAddTimelineEntryResult")) slash_command_agent_prompt_result = SlashCommandAgentPromptResult.from_dict(obj.get("SlashCommandAgentPromptResult")) slash_command_completed_result = SlashCommandCompletedResult.from_dict(obj.get("SlashCommandCompletedResult")) slash_command_info = SlashCommandInfo.from_dict(obj.get("SlashCommandInfo")) @@ -26588,13 +37260,20 @@ def from_dict(obj: Any) -> 'RPC': 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_model_picker_dialog = SlashCommandModelPickerDialog.from_dict(obj.get("SlashCommandModelPickerDialog")) slash_command_select_subcommand_option = SlashCommandSelectSubcommandOption.from_dict(obj.get("SlashCommandSelectSubcommandOption")) slash_command_select_subcommand_result = SlashCommandSelectSubcommandResult.from_dict(obj.get("SlashCommandSelectSubcommandResult")) + slash_command_set_model_result = SlashCommandSetModelResult.from_dict(obj.get("SlashCommandSetModelResult")) + slash_command_set_plan_model_result = SlashCommandSetPlanModelResult.from_dict(obj.get("SlashCommandSetPlanModelResult")) + slash_command_show_dialog_result = SlashCommandShowDialogResult.from_dict(obj.get("SlashCommandShowDialogResult")) slash_command_text_result = SlashCommandTextResult.from_dict(obj.get("SlashCommandTextResult")) + slash_command_timeline_entry = SlashCommandTimelineEntry.from_dict(obj.get("SlashCommandTimelineEntry")) 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_complete_data = TaskCompleteData.from_dict(obj.get("TaskCompleteData")) + task_completion_decision = TaskCompletionDecision.from_dict(obj.get("TaskCompletionDecision")) task_execution_mode = TaskExecutionMode(obj.get("TaskExecutionMode")) task_info = _load_TaskInfo(obj.get("TaskInfo")) task_list = TaskList.from_dict(obj.get("TaskList")) @@ -26621,11 +37300,23 @@ def from_dict(obj: Any) -> 'RPC': tasks_wait_for_pending_result = TasksWaitForPendingResult.from_dict(obj.get("TasksWaitForPendingResult")) telemetry_set_feature_overrides_request = TelemetrySetFeatureOverridesRequest.from_dict(obj.get("TelemetrySetFeatureOverridesRequest")) token_auth_info = TokenAuthInfo.from_dict(obj.get("TokenAuthInfo")) + token_provider_auth_info = TokenProviderAuthInfo.from_dict(obj.get("TokenProviderAuthInfo")) tool = Tool.from_dict(obj.get("Tool")) tool_list = ToolList.from_dict(obj.get("ToolList")) + tool_result = from_union([ToolResultExpanded.from_dict, from_str], obj.get("ToolResult")) + tool_result_expanded = ToolResultExpanded.from_dict(obj.get("ToolResultExpanded")) + tool_result_new_message = ToolResultNewMessage.from_dict(obj.get("ToolResultNewMessage")) + tool_result_type = ToolResultType(obj.get("ToolResultType")) + tools_execute_request = ToolsExecuteRequest.from_dict(obj.get("ToolsExecuteRequest")) + tools_get_builtin_descriptors_request = ToolsGetBuiltinDescriptorsRequest.from_dict(obj.get("ToolsGetBuiltinDescriptorsRequest")) + tools_get_builtin_descriptors_result = ToolsGetBuiltinDescriptorsResult.from_dict(obj.get("ToolsGetBuiltinDescriptorsResult")) 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_set_request = ToolsSetRequest.from_dict(obj.get("ToolsSetRequest")) + tools_set_result = ToolsSetResult.from_dict(obj.get("ToolsSetResult")) + tools_shell_descriptor_config = ToolsShellDescriptorConfig.from_dict(obj.get("ToolsShellDescriptorConfig")) + tools_task_complete_event_data_request = ToolsTaskCompleteEventDataRequest.from_dict(obj.get("ToolsTaskCompleteEventDataRequest")) 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")) @@ -26669,6 +37360,7 @@ def from_dict(obj: Any) -> 'RPC': 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_agent_metric = UsageMetricsAgentMetric.from_dict(obj.get("UsageMetricsAgentMetric")) usage_metrics_code_changes = UsageMetricsCodeChanges.from_dict(obj.get("UsageMetricsCodeChanges")) usage_metrics_model_metric = UsageMetricsModelMetric.from_dict(obj.get("UsageMetricsModelMetric")) usage_metrics_model_metric_requests = UsageMetricsModelMetricRequests.from_dict(obj.get("UsageMetricsModelMetricRequests")) @@ -26688,26 +37380,37 @@ def from_dict(obj: Any) -> 'RPC': 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_auth_info_result = from_union([AuthIdentity.from_dict, from_none], obj.get("SessionAuthInfoResult")) 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_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_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, agents_get_discovery_paths_request, allow_all_permission_set_result, allow_all_permission_state, api_key_auth_info, auth_info, auth_info_type, 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_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, 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_context_push_input, 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_cancel_request, factory_execute_request, factory_execute_result, factory_get_run_request, factory_journal_get_request, factory_journal_get_result, factory_journal_put_request, factory_log_line, factory_log_line_kind, factory_log_request, factory_run_failure, factory_run_failure_kind, factory_run_limits, factory_run_request, factory_run_result, factory_run_status, 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_compact_context_window, history_compact_request, history_compact_result, 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, 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, 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_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_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_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_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_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, 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, 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_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_seatbelt, schedule_entry, schedule_list, 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, server_agent_list, server_instruction_source_list, server_skill, server_skill_list, session_activity, session_auth_status, session_bulk_delete_result, session_capability, 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_stat_request, session_fs_stat_result, session_fs_write_file_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_list, session_list_entry, session_list_filter, session_load_deferred_repo_hooks_result, session_log_level, session_mcp_apps_call_tool_result, session_metadata_snapshot, session_mode, session_model_list, 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_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, 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_persisted_remote_steerable_request, sessions_get_persisted_remote_steerable_result, session_sizes, 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_kill_request, shell_kill_result, shell_kill_signal, 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_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_attribution, session_context_info, subagent_settings, 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, api_key_auth_info, auth_identity, auth_info, auth_info_type, auth_validation_error, auth_validation_errors, built_in_model_catalog, built_in_model_catalog_entry, builtin_tool_descriptor, builtin_tool_format, builtin_tool_format_type, builtin_tool_input_schema, builtin_tool_input_schema_type, builtin_tool_safe_for_telemetry, builtin_tool_safe_telemetry_fields, 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_provider_register_request, canvas_provider_unregister_request, canvas_session_context, capi_session_options, card_digest, card_digest_algorithm, card_digest_value, catalog_ai_skill_candidate, catalog_ai_skill_candidate_provenance, catalog_authentication_required_error, catalog_authentication_required_reason, catalog_candidate, catalog_candidate_kind, catalog_candidate_source, catalog_candidate_source_embedded, catalog_candidate_source_url, catalog_capability, catalog_capability_id, catalog_client_contract, catalog_contract_violation_error, catalog_contract_violation_reason, catalog_handle_rejected_error, catalog_handle_rejection_reason, catalog_handle_type, catalog_invalid_request_error, catalog_invalid_request_field, catalog_malformed_card_error, catalog_malformed_card_reason, catalog_mcp_server_candidate, catalog_mcp_server_candidate_provenance, catalog_mcp_server_installability, catalog_media_type, catalog_negotiated_contract, catalog_negotiation_refused_error, catalog_negotiation_refused_reason, catalog_network_failure_error, catalog_network_failure_reason, catalog_not_installable_error, catalog_not_installable_reason, catalog_policy_rejected_error, catalog_search_request, catalog_search_result, catalog_search_succeeded, catalog_unavailable_error, catalog_unavailable_reason, catalog_unavailable_transport_error, catalog_unavailable_transport_reason, catalog_unsafe_retrieval_error, catalog_unsafe_retrieval_reason, catalog_unsupported_kind_error, command_list, commands_finalize_invocation_effect_request, commands_finalize_invocation_effect_result, commands_handle_pending_command_request, commands_handle_pending_command_result, commands_invocation_effect_outcome, commands_invocation_origin, 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, connect_client_info, 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, 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, factory_tool_resume_request, factory_tool_run_options, factory_tool_run_request, 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, git_hub_token_acquire_reason, git_hub_token_acquire_request, git_hub_token_acquire_result, 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_elicitation_form_mode, mcp_enable_request, mcp_execute_sampling_params, mcp_execute_sampling_request, mcp_execute_sampling_result, mcp_failed_server, 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_install_plan, 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_probe_needs_auth_reason, mcp_oauth_probe_request, mcp_oauth_probe_result, mcp_oauth_respond_request, mcp_oauth_respond_result, mcp_plan_configuration_change, mcp_plan_configuration_operation, mcp_plan_enum_value_type, mcp_plan_install_planned, mcp_plan_install_request, mcp_plan_install_result, mcp_plan_install_source, mcp_plan_install_source_candidate, mcp_plan_install_source_candidate_kind, mcp_plan_install_source_card, mcp_plan_install_source_card_kind, mcp_plan_package_install_method, mcp_plan_package_transport, mcp_plan_policy_decision, mcp_plan_policy_result, mcp_plan_policy_source, mcp_plan_provenance, mcp_plan_remote_install_method, mcp_plan_remote_transport, mcp_plan_required_value, mcp_plan_required_value_enum, mcp_plan_required_value_enum_kind, mcp_plan_required_value_scalar, mcp_plan_required_value_scalar_kind, mcp_plan_resource_identity, mcp_plan_scalar_value_type, mcp_plan_scope, mcp_plan_secret_placeholder, mcp_plan_secret_reference, mcp_plan_target, mcp_plan_transport_choice, mcp_plan_transport_choice_package, mcp_plan_transport_choice_remote, mcp_plan_value_category, mcp_register_external_client_request, mcp_reload_config, 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_safe_for_telemetry, mcp_safe_for_telemetry_fields, mcp_sampling_execution_action, mcp_sampling_execution_result, mcp_serializable_server_config, mcp_server, mcp_server_auth_config, mcp_server_auth_config_redirect_port, mcp_server_card_embedded, mcp_server_card_embedded_kind, mcp_server_card_media_type, mcp_server_card_reference, mcp_server_card_url, mcp_server_card_url_kind, 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_memory, mcp_server_config_memory_type, mcp_server_config_stdio, mcp_server_config_stdio_type, 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_task_metadata, 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_apply_startup_overlay_request, 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_message, model_picker_category, model_picker_persistence_request, model_picker_price_category, model_picker_settings_context, model_policy, model_policy_state, model_set_reasoning_effort_request, model_set_reasoning_effort_result, models_list_request, model_switch_confirmation, model_switch_to_request, model_switch_to_result, model_warning_text, mode_set_request, mode_set_result, move_mcp_loading_to_background_result, 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_env_access, 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_env_access, 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_mode_source, 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_response_capability, 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_mode_request, permissions_get_mode_result, 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_env_access, 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_approve_all_request, permissions_set_approve_all_result, permissions_set_approve_all_source, permissions_set_mode_request, permissions_set_mode_result, 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_builtin_set_request, 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, protocol_external_tool_defer, protocol_external_tool_definition, 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_host_status, 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_source, 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_login_request, session_auth_logout_user_request, session_auth_status, session_auth_switch_request, 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_git_hub_auth_get_all_auth_available_result, session_git_hub_auth_logout_result, session_git_hub_auth_logout_user_result, 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, settable_auth_info, settable_token_auth_info, shell_cancel_user_requested_request, shell_credentials, 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_config_set_skill_disabled_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_add_timeline_entry_result, 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_model_picker_dialog, slash_command_select_subcommand_option, slash_command_select_subcommand_result, slash_command_set_model_result, slash_command_set_plan_model_result, slash_command_show_dialog_result, slash_command_text_result, slash_command_timeline_entry, subagent_settings_entry, subagent_settings_entry_context_tier, task_agent_info, task_agent_progress, task_complete_data, task_completion_decision, 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, token_provider_auth_info, tool, tool_list, tool_result, tool_result_expanded, tool_result_new_message, tool_result_type, tools_execute_request, tools_get_builtin_descriptors_request, tools_get_builtin_descriptors_result, tools_get_current_metadata_result, tools_initialize_and_validate_result, tools_list_request, tools_set_request, tools_set_result, tools_shell_descriptor_config, tools_task_complete_event_data_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_agent_metric, 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_auth_info_result, session_context_attribution, session_context_info, subagent_settings, task_progress, workspace_summary) def to_dict(self) -> dict: result: dict = {} @@ -26731,6 +37434,7 @@ def to_dict(self) -> dict: 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) @@ -26751,12 +37455,23 @@ def to_dict(self) -> dict: 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["AuthIdentity"] = to_class(AuthIdentity, self.auth_identity) result["AuthInfo"] = (self.auth_info).to_dict() result["AuthInfoType"] = to_enum(AuthInfoType, self.auth_info_type) + result["AuthValidationError"] = to_class(AuthValidationError, self.auth_validation_error) + result["AuthValidationErrors"] = from_list(lambda x: to_class(AuthValidationError, x), self.auth_validation_errors) + result["BuiltInModelCatalog"] = to_class(BuiltInModelCatalog, self.built_in_model_catalog) + result["BuiltInModelCatalogEntry"] = to_class(BuiltInModelCatalogEntry, self.built_in_model_catalog_entry) + result["BuiltinToolDescriptor"] = to_class(BuiltinToolDescriptor, self.builtin_tool_descriptor) + result["BuiltinToolFormat"] = to_class(BuiltinToolFormat, self.builtin_tool_format) + result["BuiltinToolFormatType"] = to_enum(BuiltinToolFormatType, self.builtin_tool_format_type) + result["BuiltinToolInputSchema"] = to_class(BuiltinToolInputSchema, self.builtin_tool_input_schema) + result["BuiltinToolInputSchemaType"] = to_enum(BuiltinToolInputSchemaType, self.builtin_tool_input_schema_type) + result["BuiltinToolSafeForTelemetry"] = from_union([from_bool, lambda x: to_class(BuiltinToolSafeTelemetryFields, x)], self.builtin_tool_safe_for_telemetry) + result["BuiltinToolSafeTelemetryFields"] = to_class(BuiltinToolSafeTelemetryFields, self.builtin_tool_safe_telemetry_fields) 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) @@ -26772,25 +37487,81 @@ def to_dict(self) -> dict: result["CanvasProviderInvokeActionRequest"] = to_class(CanvasProviderInvokeActionRequest, self.canvas_provider_invoke_action_request) result["CanvasProviderOpenRequest"] = to_class(CanvasProviderOpenRequest, self.canvas_provider_open_request) result["CanvasProviderOpenResult"] = to_class(CanvasProviderOpenResult, self.canvas_provider_open_result) + result["CanvasProviderRegisterRequest"] = to_class(CanvasProviderRegisterRequest, self.canvas_provider_register_request) + result["CanvasProviderUnregisterRequest"] = to_class(CanvasProviderUnregisterRequest, self.canvas_provider_unregister_request) result["CanvasSessionContext"] = to_class(CanvasSessionContext, self.canvas_session_context) result["CapiSessionOptions"] = to_class(CapiSessionOptions, self.capi_session_options) + result["CardDigest"] = to_class(CardDigest, self.card_digest) + result["CardDigestAlgorithm"] = to_enum(CardDigestAlgorithm, self.card_digest_algorithm) + result["CardDigestValue"] = from_str(self.card_digest_value) + result["CatalogAiSkillCandidate"] = to_class(CatalogAISkillCandidate, self.catalog_ai_skill_candidate) + result["CatalogAiSkillCandidateProvenance"] = to_class(CatalogAISkillCandidateProvenance, self.catalog_ai_skill_candidate_provenance) + result["CatalogAuthenticationRequiredError"] = to_class(CatalogAuthenticationRequiredError, self.catalog_authentication_required_error) + result["CatalogAuthenticationRequiredReason"] = to_enum(CatalogAuthenticationRequiredReason, self.catalog_authentication_required_reason) + result["CatalogCandidate"] = to_class(CatalogCandidate, self.catalog_candidate) + result["CatalogCandidateKind"] = to_enum(CatalogCandidateKind, self.catalog_candidate_kind) + result["CatalogCandidateSource"] = (self.catalog_candidate_source).to_dict() + result["CatalogCandidateSourceEmbedded"] = to_class(CatalogCandidateSourceEmbedded, self.catalog_candidate_source_embedded) + result["CatalogCandidateSourceUrl"] = to_class(CatalogCandidateSourceURL, self.catalog_candidate_source_url) + result["CatalogCapability"] = to_enum(CatalogCapability, self.catalog_capability) + result["CatalogCapabilityId"] = from_str(self.catalog_capability_id) + result["CatalogClientContract"] = to_class(CatalogClientContract, self.catalog_client_contract) + result["CatalogContractViolationError"] = to_class(CatalogContractViolationError, self.catalog_contract_violation_error) + result["CatalogContractViolationReason"] = to_enum(CatalogContractViolationReason, self.catalog_contract_violation_reason) + result["CatalogHandleRejectedError"] = to_class(CatalogHandleRejectedError, self.catalog_handle_rejected_error) + result["CatalogHandleRejectionReason"] = to_enum(CatalogHandleRejectionReason, self.catalog_handle_rejection_reason) + result["CatalogHandleType"] = to_enum(CatalogHandleType, self.catalog_handle_type) + result["CatalogInvalidRequestError"] = to_class(CatalogInvalidRequestError, self.catalog_invalid_request_error) + result["CatalogInvalidRequestField"] = to_enum(CatalogInvalidRequestField, self.catalog_invalid_request_field) + result["CatalogMalformedCardError"] = to_class(CatalogMalformedCardError, self.catalog_malformed_card_error) + result["CatalogMalformedCardReason"] = to_enum(CatalogMalformedCardReason, self.catalog_malformed_card_reason) + result["CatalogMcpServerCandidate"] = to_class(CatalogMCPServerCandidate, self.catalog_mcp_server_candidate) + result["CatalogMcpServerCandidateProvenance"] = to_class(CatalogMCPServerCandidateProvenance, self.catalog_mcp_server_candidate_provenance) + result["CatalogMcpServerInstallability"] = to_enum(CatalogMCPServerInstallabilityEnum, self.catalog_mcp_server_installability) + result["CatalogMediaType"] = to_enum(CatalogMediaType, self.catalog_media_type) + result["CatalogNegotiatedContract"] = to_class(CatalogNegotiatedContract, self.catalog_negotiated_contract) + result["CatalogNegotiationRefusedError"] = to_class(CatalogNegotiationRefusedError, self.catalog_negotiation_refused_error) + result["CatalogNegotiationRefusedReason"] = to_enum(CatalogNegotiationRefusedReason, self.catalog_negotiation_refused_reason) + result["CatalogNetworkFailureError"] = to_class(CatalogNetworkFailureError, self.catalog_network_failure_error) + result["CatalogNetworkFailureReason"] = to_enum(CatalogNetworkFailureReason, self.catalog_network_failure_reason) + result["CatalogNotInstallableError"] = to_class(CatalogNotInstallableError, self.catalog_not_installable_error) + result["CatalogNotInstallableReason"] = to_enum(CatalogNotInstallableReason, self.catalog_not_installable_reason) + result["CatalogPolicyRejectedError"] = to_class(CatalogPolicyRejectedError, self.catalog_policy_rejected_error) + result["CatalogSearchRequest"] = to_class(CatalogSearchRequest, self.catalog_search_request) + result["CatalogSearchResult"] = (self.catalog_search_result).to_dict() + result["CatalogSearchSucceeded"] = to_class(CatalogSearchSucceeded, self.catalog_search_succeeded) + result["CatalogUnavailableError"] = to_class(CatalogUnavailableError, self.catalog_unavailable_error) + result["CatalogUnavailableReason"] = to_enum(CatalogUnavailableReason, self.catalog_unavailable_reason) + result["CatalogUnavailableTransportError"] = to_class(CatalogUnavailableTransportError, self.catalog_unavailable_transport_error) + result["CatalogUnavailableTransportReason"] = to_enum(CatalogUnavailableTransportReason, self.catalog_unavailable_transport_reason) + result["CatalogUnsafeRetrievalError"] = to_class(CatalogUnsafeRetrievalError, self.catalog_unsafe_retrieval_error) + result["CatalogUnsafeRetrievalReason"] = to_enum(CatalogUnsafeRetrievalReason, self.catalog_unsafe_retrieval_reason) + result["CatalogUnsupportedKindError"] = to_class(CatalogUnsupportedKindError, self.catalog_unsupported_kind_error) result["CommandList"] = to_class(CommandList, self.command_list) + result["CommandsFinalizeInvocationEffectRequest"] = to_class(CommandsFinalizeInvocationEffectRequest, self.commands_finalize_invocation_effect_request) + result["CommandsFinalizeInvocationEffectResult"] = to_class(CommandsFinalizeInvocationEffectResult, self.commands_finalize_invocation_effect_result) result["CommandsHandlePendingCommandRequest"] = to_class(CommandsHandlePendingCommandRequest, self.commands_handle_pending_command_request) result["CommandsHandlePendingCommandResult"] = to_class(CommandsHandlePendingCommandResult, self.commands_handle_pending_command_result) + result["CommandsInvocationEffectOutcome"] = to_enum(CommandsInvocationEffectOutcome, self.commands_invocation_effect_outcome) + result["CommandsInvocationOrigin"] = to_enum(CommandsInvocationOrigin, self.commands_invocation_origin) 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["ConnectClientInfo"] = to_class(_ConnectClientInfo, self.connect_client_info) 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) @@ -26814,6 +37585,13 @@ def to_dict(self) -> dict: result["DebugCollectLogsSkippedEntry"] = to_class(DebugCollectLogsSkippedEntry, self.debug_collect_logs_skipped_entry) result["DebugCollectLogsSource"] = to_enum(DebugCollectLogsSource, self.debug_collect_logs_source) 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) @@ -26825,11 +37603,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) @@ -26855,22 +37637,42 @@ def to_dict(self) -> dict: 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["FactoryToolResumeRequest"] = to_class(_FactoryToolResumeRequest, self.factory_tool_resume_request) + result["FactoryToolRunOptions"] = to_class(_FactoryToolRunOptions, self.factory_tool_run_options) + result["FactoryToolRunRequest"] = to_class(_FactoryToolRunRequest, self.factory_tool_run_request) 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) @@ -26881,13 +37683,31 @@ def to_dict(self) -> dict: 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["GitHubTokenAcquireReason"] = to_enum(GitHubTokenAcquireReason, self.git_hub_token_acquire_reason) + result["GitHubTokenAcquireRequest"] = to_class(GitHubTokenAcquireRequest, self.git_hub_token_acquire_request) + result["GitHubTokenAcquireResult"] = to_class(GitHubTokenAcquireResult, self.git_hub_token_acquire_result) 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) @@ -26911,6 +37731,8 @@ def to_dict(self) -> dict: 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) @@ -26927,6 +37749,7 @@ def to_dict(self) -> dict: 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) @@ -26971,26 +37794,70 @@ def to_dict(self) -> dict: 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) + result["McpElicitationFormMode"] = to_enum(MCPElicitationFormMode, self.mcp_elicitation_form_mode) result["McpEnableRequest"] = to_class(MCPEnableRequest, self.mcp_enable_request) 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["McpFailedServer"] = to_class(MCPFailedServer, self.mcp_failed_server) 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["McpInstallPlan"] = to_class(MCPInstallPlan, self.mcp_install_plan) 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["McpOauthProbeNeedsAuthReason"] = to_enum(MCPOauthProbeNeedsAuthReason, self.mcp_oauth_probe_needs_auth_reason) + result["McpOauthProbeRequest"] = to_class(MCPOauthProbeRequest, self.mcp_oauth_probe_request) + result["McpOauthProbeResult"] = to_class(MCPOauthProbeResult, self.mcp_oauth_probe_result) + result["McpOauthRespondRequest"] = to_class(MCPOauthRespondRequest, self.mcp_oauth_respond_request) + result["McpOauthRespondResult"] = to_class(MCPOauthRespondResult, self.mcp_oauth_respond_result) + result["McpPlanConfigurationChange"] = to_class(MCPPlanConfigurationChange, self.mcp_plan_configuration_change) + result["McpPlanConfigurationOperation"] = to_enum(MCPPlanConfigurationOperation, self.mcp_plan_configuration_operation) + result["McpPlanEnumValueType"] = to_enum(MCPPlan, self.mcp_plan_enum_value_type) + result["McpPlanInstallPlanned"] = to_class(MCPPlanInstallPlanned, self.mcp_plan_install_planned) + result["McpPlanInstallRequest"] = to_class(MCPPlanInstallRequest, self.mcp_plan_install_request) + result["McpPlanInstallResult"] = (self.mcp_plan_install_result).to_dict() + result["McpPlanInstallSource"] = (self.mcp_plan_install_source).to_dict() + result["McpPlanInstallSourceCandidate"] = to_class(MCPPlanInstallSourceCandidate, self.mcp_plan_install_source_candidate) + result["McpPlanInstallSourceCandidateKind"] = to_enum(MCPPlanInstallSourceCandidateKind, self.mcp_plan_install_source_candidate_kind) + result["McpPlanInstallSourceCard"] = to_class(MCPPlanInstallSourceCard, self.mcp_plan_install_source_card) + result["McpPlanInstallSourceCardKind"] = to_enum(MCPPlanInstallSourceCardKind, self.mcp_plan_install_source_card_kind) + result["McpPlanPackageInstallMethod"] = to_enum(MCPPlanPackageInstallMethod, self.mcp_plan_package_install_method) + result["McpPlanPackageTransport"] = to_enum(MCPPlanPackageTransport, self.mcp_plan_package_transport) + result["McpPlanPolicyDecision"] = to_enum(MCPPlanPolicyDecision, self.mcp_plan_policy_decision) + result["McpPlanPolicyResult"] = to_class(MCPPlanPolicyResult, self.mcp_plan_policy_result) + result["McpPlanPolicySource"] = to_enum(MCPPlanPolicySource, self.mcp_plan_policy_source) + result["McpPlanProvenance"] = to_class(MCPPlanProvenance, self.mcp_plan_provenance) + result["McpPlanRemoteInstallMethod"] = to_enum(MCPPlanRemoteInstallMethod, self.mcp_plan_remote_install_method) + result["McpPlanRemoteTransport"] = to_enum(MCPPlanRemoteTransport, self.mcp_plan_remote_transport) + result["McpPlanRequiredValue"] = (self.mcp_plan_required_value).to_dict() + result["McpPlanRequiredValueEnum"] = to_class(MCPPlanRequiredValueEnum, self.mcp_plan_required_value_enum) + result["McpPlanRequiredValueEnumKind"] = to_enum(MCPPlan, self.mcp_plan_required_value_enum_kind) + result["McpPlanRequiredValueScalar"] = to_class(MCPPlanRequiredValueScalar, self.mcp_plan_required_value_scalar) + result["McpPlanRequiredValueScalarKind"] = to_enum(MCPPlanRequiredValueScalarKind, self.mcp_plan_required_value_scalar_kind) + result["McpPlanResourceIdentity"] = to_class(MCPPlanResourceIdentity, self.mcp_plan_resource_identity) + result["McpPlanScalarValueType"] = to_enum(MCPPlanScalarValueTypeEnum, self.mcp_plan_scalar_value_type) + result["McpPlanScope"] = to_enum(MCPPlanScope, self.mcp_plan_scope) + result["McpPlanSecretPlaceholder"] = to_class(MCPPlanSecretPlaceholder, self.mcp_plan_secret_placeholder) + result["McpPlanSecretReference"] = from_str(self.mcp_plan_secret_reference) + result["McpPlanTarget"] = to_class(MCPPlanTarget, self.mcp_plan_target) + result["McpPlanTransportChoice"] = (self.mcp_plan_transport_choice).to_dict() + result["McpPlanTransportChoicePackage"] = to_class(MCPPlanTransportChoicePackage, self.mcp_plan_transport_choice_package) + result["McpPlanTransportChoiceRemote"] = to_class(MCPPlanTransportChoiceRemote, self.mcp_plan_transport_choice_remote) + result["McpPlanValueCategory"] = to_enum(MCPPlanValueCategory, self.mcp_plan_value_category) result["McpRegisterExternalClientRequest"] = to_class(MCPRegisterExternalClientRequest, self.mcp_register_external_client_request) + result["McpReloadConfig"] = to_class(MCPReloadConfig, self.mcp_reload_config) 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) @@ -27005,17 +37872,29 @@ def to_dict(self) -> dict: 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["McpSafeForTelemetry"] = from_union([from_bool, lambda x: to_class(MCPSafeForTelemetryFields, x)], self.mcp_safe_for_telemetry) + result["McpSafeForTelemetryFields"] = to_class(MCPSafeForTelemetryFields, self.mcp_safe_for_telemetry_fields) result["McpSamplingExecutionAction"] = to_enum(MCPSamplingExecutionAction, self.mcp_sampling_execution_action) result["McpSamplingExecutionResult"] = to_class(MCPSamplingExecutionResult, self.mcp_sampling_execution_result) + result["McpSerializableServerConfig"] = to_class(MCPSerializableServerConfig, self.mcp_serializable_server_config) 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["McpServerCardEmbedded"] = to_class(MCPServerCardEmbedded, self.mcp_server_card_embedded) + result["McpServerCardEmbeddedKind"] = to_enum(MCPServerCardEmbeddedKind, self.mcp_server_card_embedded_kind) + result["McpServerCardMediaType"] = to_enum(MCPServerCardMediaType, self.mcp_server_card_media_type) + result["McpServerCardReference"] = (self.mcp_server_card_reference).to_dict() + result["McpServerCardUrl"] = to_class(MCPServerCardURL, self.mcp_server_card_url) + result["McpServerCardUrlKind"] = to_enum(MCPServerCardURLKind, self.mcp_server_card_url_kind) 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(MCPGrantType, self.mcp_server_config_http_oauth_grant_type) result["McpServerConfigHttpType"] = to_enum(MCPServerConfigHTTPType, self.mcp_server_config_http_type) + result["McpServerConfigMemory"] = to_class(MCPServerConfigMemory, self.mcp_server_config_memory) + result["McpServerConfigMemoryType"] = to_enum(MCPServerConfigMemoryType, self.mcp_server_config_memory_type) result["McpServerConfigStdio"] = to_class(MCPServerConfigStdio, self.mcp_server_config_stdio) + result["McpServerConfigStdioType"] = to_enum(MCPServerConfigStdioType, self.mcp_server_config_stdio_type) 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) @@ -27025,6 +37904,7 @@ def to_dict(self) -> dict: 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["McpTaskMetadata"] = to_class(MCPTaskMetadata, self.mcp_task_metadata) 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) @@ -27047,6 +37927,7 @@ def to_dict(self) -> dict: result["MetadataSnapshotRemoteMetadataRepository"] = to_class(MetadataSnapshotRemoteMetadataRepository, self.metadata_snapshot_remote_metadata_repository) result["MetadataSnapshotRemoteMetadataTaskType"] = to_enum(TaskType, self.metadata_snapshot_remote_metadata_task_type) result["Model"] = to_class(Model, self.model) + result["ModelApplyStartupOverlayRequest"] = to_class(ModelApplyStartupOverlayRequest, self.model_apply_startup_overlay_request) 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) @@ -27060,17 +37941,24 @@ def to_dict(self) -> dict: result["ModelCapabilitiesOverrideSupports"] = to_class(ModelCapabilitiesOverrideSupports, self.model_capabilities_override_supports) result["ModelCapabilitiesSupports"] = to_class(ModelCapabilitiesSupports, self.model_capabilities_supports) result["ModelList"] = to_class(ModelList, self.model_list) - result["ModelListRequest"] = to_class(ModelListRequest, self.model_list_request) + result["ModelListRequest"] = self.model_list_request + result["ModelMessage"] = to_class(ModelMessage, self.model_message) result["ModelPickerCategory"] = to_enum(ModelPickerCategory, self.model_picker_category) + result["ModelPickerPersistenceRequest"] = to_class(ModelPickerPersistenceRequest, self.model_picker_persistence_request) result["ModelPickerPriceCategory"] = to_enum(ModelPickerPriceCategory, self.model_picker_price_category) + result["ModelPickerSettingsContext"] = to_class(ModelPickerSettingsContext, self.model_picker_settings_context) result["ModelPolicy"] = to_class(ModelPolicy, self.model_policy) result["ModelPolicyState"] = to_enum(ModelPolicyState, self.model_policy_state) result["ModelSetReasoningEffortRequest"] = to_class(ModelSetReasoningEffortRequest, self.model_set_reasoning_effort_request) result["ModelSetReasoningEffortResult"] = to_class(ModelSetReasoningEffortResult, self.model_set_reasoning_effort_result) result["ModelsListRequest"] = to_class(ModelsListRequest, self.models_list_request) + result["ModelSwitchConfirmation"] = to_class(ModelSwitchConfirmation, self.model_switch_confirmation) result["ModelSwitchToRequest"] = to_class(ModelSwitchToRequest, self.model_switch_to_request) result["ModelSwitchToResult"] = to_class(ModelSwitchToResult, self.model_switch_to_result) + result["ModelWarningText"] = to_class(ModelWarningText, self.model_warning_text) result["ModeSetRequest"] = to_class(ModeSetRequest, self.mode_set_request) + result["ModeSetResult"] = to_class(ModeSetResult, self.mode_set_result) + result["MoveMcpLoadingToBackgroundResult"] = to_class(MoveMCPLoadingToBackgroundResult, self.move_mcp_loading_to_background_result) 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) @@ -27095,8 +37983,10 @@ def to_dict(self) -> dict: result["PermissionDecisionApproveForLocationApproval"] = (self.permission_decision_approve_for_location_approval).to_dict() result["PermissionDecisionApproveForLocationApprovalCommands"] = to_class(PermissionDecisionApproveForLocationApprovalCommands, self.permission_decision_approve_for_location_approval_commands) result["PermissionDecisionApproveForLocationApprovalCustomTool"] = to_class(PermissionDecisionApproveForLocationApprovalCustomTool, self.permission_decision_approve_for_location_approval_custom_tool) + result["PermissionDecisionApproveForLocationApprovalExtensionEnvAccess"] = to_class(PermissionDecisionApproveForLocationApprovalExtensionEnvAccess, self.permission_decision_approve_for_location_approval_extension_env_access) 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) @@ -27106,8 +37996,10 @@ def to_dict(self) -> dict: result["PermissionDecisionApproveForSessionApproval"] = (self.permission_decision_approve_for_session_approval).to_dict() result["PermissionDecisionApproveForSessionApprovalCommands"] = to_class(PermissionDecisionApproveForSessionApprovalCommands, self.permission_decision_approve_for_session_approval_commands) result["PermissionDecisionApproveForSessionApprovalCustomTool"] = to_class(PermissionDecisionApproveForSessionApprovalCustomTool, self.permission_decision_approve_for_session_approval_custom_tool) + result["PermissionDecisionApproveForSessionApprovalExtensionEnvAccess"] = to_class(PermissionDecisionApproveForSessionApprovalExtensionEnvAccess, self.permission_decision_approve_for_session_approval_extension_env_access) 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) @@ -27116,13 +38008,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) @@ -27130,6 +38026,7 @@ def to_dict(self) -> dict: result["PermissionLocationResolveParams"] = to_class(PermissionLocationResolveParams, self.permission_location_resolve_params) result["PermissionLocationResolveResult"] = to_class(PermissionLocationResolveResult, self.permission_location_resolve_result) result["PermissionLocationType"] = to_enum(PermissionLocationType, self.permission_location_type) + result["PermissionModeSource"] = to_enum(PermissionSource, self.permission_mode_source) result["PermissionPathsAddParams"] = to_class(PermissionPathsAddParams, self.permission_paths_add_params) result["PermissionPathsAllowedCheckParams"] = to_class(PermissionPathsAllowedCheckParams, self.permission_paths_allowed_check_params) result["PermissionPathsAllowedCheckResult"] = to_class(PermissionPathsAllowedCheckResult, self.permission_paths_allowed_check_result) @@ -27140,8 +38037,8 @@ def to_dict(self) -> dict: result["PermissionPathsWorkspaceCheckResult"] = to_class(PermissionPathsWorkspaceCheckResult, self.permission_paths_workspace_check_result) result["PermissionPromptShownNotification"] = to_class(PermissionPromptShownNotification, self.permission_prompt_shown_notification) result["PermissionRequestResult"] = to_class(PermissionRequestResult, self.permission_request_result) + result["PermissionResponseCapability"] = to_enum(PermissionResponseCapability, self.permission_response_capability) 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) @@ -27149,12 +38046,15 @@ def to_dict(self) -> dict: 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) - result["PermissionsGetAllowAllRequest"] = to_class(PermissionsGetAllowAllRequest, self.permissions_get_allow_all_request) + result["PermissionsGetModeRequest"] = to_class(PermissionsGetModeRequest, self.permissions_get_mode_request) + result["PermissionsGetModeResult"] = to_class(PermissionsGetModeResult, self.permissions_get_mode_result) result["PermissionsLocationsAddToolApprovalDetails"] = (self.permissions_locations_add_tool_approval_details).to_dict() result["PermissionsLocationsAddToolApprovalDetailsCommands"] = to_class(PermissionsLocationsAddToolApprovalDetailsCommands, self.permissions_locations_add_tool_approval_details_commands) result["PermissionsLocationsAddToolApprovalDetailsCustomTool"] = to_class(PermissionsLocationsAddToolApprovalDetailsCustomTool, self.permissions_locations_add_tool_approval_details_custom_tool) + result["PermissionsLocationsAddToolApprovalDetailsExtensionEnvAccess"] = to_class(PermissionsLocationsAddToolApprovalDetailsExtensionEnvAccess, self.permissions_locations_add_tool_approval_details_extension_env_access) 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) @@ -27171,11 +38071,11 @@ def to_dict(self) -> dict: result["PermissionsPendingRequestsRequest"] = to_class(PermissionsPendingRequestsRequest, self.permissions_pending_requests_request) result["PermissionsResetSessionApprovalsRequest"] = to_class(PermissionsResetSessionApprovalsRequest, self.permissions_reset_session_approvals_request) result["PermissionsResetSessionApprovalsResult"] = to_class(PermissionsResetSessionApprovalsResult, self.permissions_reset_session_approvals_result) - result["PermissionsSetAllowAllRequest"] = to_class(PermissionsSetAllowAllRequest, self.permissions_set_allow_all_request) - result["PermissionsSetAllowAllSource"] = to_enum(PermissionsSetAAllSource, self.permissions_set_allow_all_source) result["PermissionsSetApproveAllRequest"] = to_class(PermissionsSetApproveAllRequest, self.permissions_set_approve_all_request) result["PermissionsSetApproveAllResult"] = to_class(PermissionsSetApproveAllResult, self.permissions_set_approve_all_result) - result["PermissionsSetApproveAllSource"] = to_enum(PermissionsSetAAllSource, self.permissions_set_approve_all_source) + result["PermissionsSetApproveAllSource"] = to_enum(PermissionSource, self.permissions_set_approve_all_source) + result["PermissionsSetModeRequest"] = to_class(PermissionsSetModeRequest, self.permissions_set_mode_request) + result["PermissionsSetModeResult"] = to_class(PermissionsSetModeResult, self.permissions_set_mode_result) result["PermissionsSetRequiredRequest"] = to_class(PermissionsSetRequiredRequest, self.permissions_set_required_request) result["PermissionsSetRequiredResult"] = to_class(PermissionsSetRequiredResult, self.permissions_set_required_result) result["PermissionsUrlsSetUnrestrictedModeResult"] = to_class(PermissionsUrlsSetUnrestrictedModeResult, self.permissions_urls_set_unrestricted_mode_result) @@ -27193,6 +38093,7 @@ def to_dict(self) -> dict: 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["PluginsBuiltinSetRequest"] = to_class(PluginsBuiltinSetRequest, self.plugins_builtin_set_request) 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) @@ -27200,12 +38101,14 @@ def to_dict(self) -> dict: 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"] = to_class(PluginsReloadRequest, self.plugins_reload_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["ProtocolExternalToolDefer"] = to_enum(MCPServerConfigDeferTools, self.protocol_external_tool_defer) + result["ProtocolExternalToolDefinition"] = to_class(ProtocolExternalToolDefinition, self.protocol_external_tool_definition) 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) @@ -27217,7 +38120,7 @@ def to_dict(self) -> dict: 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"] = to_class(ProviderGetEndpointRequest, self.provider_get_endpoint_request) + 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) @@ -27245,13 +38148,36 @@ def to_dict(self) -> dict: 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) @@ -27272,6 +38198,7 @@ def to_dict(self) -> dict: 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["RemoteSessionHostStatus"] = to_enum(RemoteSessionHostStatus, self.remote_session_host_status) 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) @@ -27279,14 +38206,24 @@ def to_dict(self) -> dict: 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["SandboxConfigSource"] = to_enum(_SandboxConfigSource, self.sandbox_config_source) 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) @@ -27299,14 +38236,21 @@ def to_dict(self) -> dict: 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["SessionAuthLoginRequest"] = to_class(SessionAuthLoginRequest, self.session_auth_login_request) + result["SessionAuthLogoutUserRequest"] = to_class(SessionAuthLogoutUserRequest, self.session_auth_logout_user_request) result["SessionAuthStatus"] = to_class(SessionAuthStatus, self.session_auth_status) + result["SessionAuthSwitchRequest"] = to_class(SessionAuthSwitchRequest, self.session_auth_switch_request) 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) @@ -27336,23 +38280,45 @@ 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["SessionGitHubAuthGetAllAuthAvailableResult"] = from_list(lambda x: to_class(SessionAuthStatus, x), self.session_git_hub_auth_get_all_auth_available_result) + result["SessionGitHubAuthLogoutResult"] = from_bool(self.session_git_hub_auth_logout_result) + result["SessionGitHubAuthLogoutUserResult"] = from_bool(self.session_git_hub_auth_logout_user_result) + 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_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["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) @@ -27363,12 +38329,15 @@ def to_dict(self) -> dict: 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) @@ -27394,9 +38363,13 @@ def to_dict(self) -> dict: 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) @@ -27432,13 +38405,20 @@ def to_dict(self) -> dict: 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["SettableAuthInfo"] = (self.settable_auth_info).to_dict() + result["SettableTokenAuthInfo"] = to_class(SettableTokenAuthInfo, self.settable_token_auth_info) result["ShellCancelUserRequestedRequest"] = to_class(ShellCancelUserRequestedRequest, self.shell_cancel_user_requested_request) + result["ShellCredentials"] = to_class(ShellCredentials, self.shell_credentials) 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) @@ -27446,6 +38426,7 @@ def to_dict(self) -> dict: 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["SkillsConfigSetSkillDisabledRequest"] = to_class(SkillsConfigSetSkillDisabledRequest, self.skills_config_set_skill_disabled_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) @@ -27453,6 +38434,7 @@ def to_dict(self) -> dict: 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) + result["SlashCommandAddTimelineEntryResult"] = to_class(SlashCommandAddTimelineEntryResult, self.slash_command_add_timeline_entry_result) result["SlashCommandAgentPromptResult"] = to_class(SlashCommandAgentPromptResult, self.slash_command_agent_prompt_result) result["SlashCommandCompletedResult"] = to_class(SlashCommandCompletedResult, self.slash_command_completed_result) result["SlashCommandInfo"] = to_class(SlashCommandInfo, self.slash_command_info) @@ -27461,13 +38443,20 @@ def to_dict(self) -> dict: 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["SlashCommandModelPickerDialog"] = to_class(SlashCommandModelPickerDialog, self.slash_command_model_picker_dialog) result["SlashCommandSelectSubcommandOption"] = to_class(SlashCommandSelectSubcommandOption, self.slash_command_select_subcommand_option) result["SlashCommandSelectSubcommandResult"] = to_class(SlashCommandSelectSubcommandResult, self.slash_command_select_subcommand_result) + result["SlashCommandSetModelResult"] = to_class(SlashCommandSetModelResult, self.slash_command_set_model_result) + result["SlashCommandSetPlanModelResult"] = to_class(SlashCommandSetPlanModelResult, self.slash_command_set_plan_model_result) + result["SlashCommandShowDialogResult"] = to_class(SlashCommandShowDialogResult, self.slash_command_show_dialog_result) result["SlashCommandTextResult"] = to_class(SlashCommandTextResult, self.slash_command_text_result) + result["SlashCommandTimelineEntry"] = to_class(SlashCommandTimelineEntry, self.slash_command_timeline_entry) 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["TaskCompleteData"] = to_class(TaskCompleteData, self.task_complete_data) + result["TaskCompletionDecision"] = to_class(TaskCompletionDecision, self.task_completion_decision) result["TaskExecutionMode"] = to_enum(TaskExecutionMode, self.task_execution_mode) result["TaskInfo"] = (self.task_info).to_dict() result["TaskList"] = to_class(TaskList, self.task_list) @@ -27494,11 +38483,23 @@ def to_dict(self) -> dict: result["TasksWaitForPendingResult"] = to_class(TasksWaitForPendingResult, self.tasks_wait_for_pending_result) result["TelemetrySetFeatureOverridesRequest"] = to_class(TelemetrySetFeatureOverridesRequest, self.telemetry_set_feature_overrides_request) result["TokenAuthInfo"] = to_class(TokenAuthInfo, self.token_auth_info) + result["TokenProviderAuthInfo"] = to_class(TokenProviderAuthInfo, self.token_provider_auth_info) result["Tool"] = to_class(Tool, self.tool) result["ToolList"] = to_class(ToolList, self.tool_list) + result["ToolResult"] = from_union([lambda x: to_class(ToolResultExpanded, x), from_str], self.tool_result) + result["ToolResultExpanded"] = to_class(ToolResultExpanded, self.tool_result_expanded) + result["ToolResultNewMessage"] = to_class(ToolResultNewMessage, self.tool_result_new_message) + result["ToolResultType"] = to_enum(ToolResultType, self.tool_result_type) + result["ToolsExecuteRequest"] = to_class(ToolsExecuteRequest, self.tools_execute_request) + result["ToolsGetBuiltinDescriptorsRequest"] = to_class(ToolsGetBuiltinDescriptorsRequest, self.tools_get_builtin_descriptors_request) + result["ToolsGetBuiltinDescriptorsResult"] = to_class(ToolsGetBuiltinDescriptorsResult, self.tools_get_builtin_descriptors_result) 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["ToolsSetRequest"] = to_class(ToolsSetRequest, self.tools_set_request) + result["ToolsSetResult"] = to_class(ToolsSetResult, self.tools_set_result) + result["ToolsShellDescriptorConfig"] = to_class(ToolsShellDescriptorConfig, self.tools_shell_descriptor_config) + result["ToolsTaskCompleteEventDataRequest"] = to_class(ToolsTaskCompleteEventDataRequest, self.tools_task_complete_event_data_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) @@ -27542,6 +38543,7 @@ def to_dict(self) -> dict: 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["UsageMetricsAgentMetric"] = to_class(UsageMetricsAgentMetric, self.usage_metrics_agent_metric) result["UsageMetricsCodeChanges"] = to_class(UsageMetricsCodeChanges, self.usage_metrics_code_changes) result["UsageMetricsModelMetric"] = to_class(UsageMetricsModelMetric, self.usage_metrics_model_metric) result["UsageMetricsModelMetricRequests"] = to_class(UsageMetricsModelMetricRequests, self.usage_metrics_model_metric_requests) @@ -27561,20 +38563,31 @@ def to_dict(self) -> dict: 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["SessionAuthInfoResult"] = from_union([lambda x: to_class(AuthIdentity, x), from_none], self.session_auth_info_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) @@ -27601,8 +38614,8 @@ def _load_AgentRegistrySpawnResult(obj: Any) -> "AgentRegistrySpawnResult": case "validation-error": return AgentRegistrySpawnValidationError.from_dict(obj) case _: raise ValueError(f"Unknown AgentRegistrySpawnResult kind: {kind!r}") -# Initial authentication info for the session. -AuthInfo = HMACAuthInfo | EnvAuthInfo | TokenAuthInfo | CopilotAPITokenAuthInfo | UserAuthInfo | GhCLIAuthInfo | APIKeyAuthInfo +# Authentication credentials accepted only at native protocol ingress. Runtime outputs use credential-free `AuthIdentity` metadata. +AuthInfo = HMACAuthInfo | EnvAuthInfo | TokenAuthInfo | TokenProviderAuthInfo | CopilotAPITokenAuthInfo | UserAuthInfo | GhCLIAuthInfo | APIKeyAuthInfo def _load_AuthInfo(obj: Any) -> "AuthInfo": assert isinstance(obj, dict) @@ -27611,12 +38624,44 @@ def _load_AuthInfo(obj: Any) -> "AuthInfo": case "hmac": return HMACAuthInfo.from_dict(obj) case "env": return EnvAuthInfo.from_dict(obj) case "token": return TokenAuthInfo.from_dict(obj) + case "token-provider": return TokenProviderAuthInfo.from_dict(obj) case "copilot-api-token": return CopilotAPITokenAuthInfo.from_dict(obj) case "user": return UserAuthInfo.from_dict(obj) case "gh-cli": return GhCLIAuthInfo.from_dict(obj) case "api-key": return APIKeyAuthInfo.from_dict(obj) case _: raise ValueError(f"Unknown AuthInfo type: {kind!r}") +# Where a candidate's card came from. Exactly one of a URL or embedded data: the union has no variant carrying both, and no variant carrying neither, so the rule holds structurally rather than by validation. +CatalogCandidateSource = CatalogCandidateSourceURL | CatalogCandidateSourceEmbedded + +def _load_CatalogCandidateSource(obj: Any) -> "CatalogCandidateSource": + assert isinstance(obj, dict) + kind = obj.get("kind") + match kind: + case "url": return CatalogCandidateSourceURL.from_dict(obj) + case "embedded": return CatalogCandidateSourceEmbedded.from_dict(obj) + case _: raise ValueError(f"Unknown CatalogCandidateSource kind: {kind!r}") + +# Outcome of a catalog.search call: either bounded inert candidates, or one typed refusal. Never a partial success. +CatalogSearchResult = CatalogSearchSucceeded | CatalogNegotiationRefusedError | CatalogUnsupportedKindError | CatalogInvalidRequestError | CatalogAuthenticationRequiredError | CatalogPolicyRejectedError | CatalogNetworkFailureError | CatalogUnsafeRetrievalError | CatalogMalformedCardError | CatalogContractViolationError | CatalogUnavailableError + +def _load_CatalogSearchResult(obj: Any) -> "CatalogSearchResult": + assert isinstance(obj, dict) + kind = obj.get("kind") + match kind: + case "succeeded": return CatalogSearchSucceeded.from_dict(obj) + case "negotiation-refused": return CatalogNegotiationRefusedError.from_dict(obj) + case "unsupported-kind": return CatalogUnsupportedKindError.from_dict(obj) + case "invalid-request": return CatalogInvalidRequestError.from_dict(obj) + case "authentication-required": return CatalogAuthenticationRequiredError.from_dict(obj) + case "policy-rejected": return CatalogPolicyRejectedError.from_dict(obj) + case "network-failure": return CatalogNetworkFailureError.from_dict(obj) + case "unsafe-retrieval": return CatalogUnsafeRetrievalError.from_dict(obj) + case "malformed-card": return CatalogMalformedCardError.from_dict(obj) + case "contract-violation": return CatalogContractViolationError.from_dict(obj) + case "unavailable": return CatalogUnavailableError.from_dict(obj) + case _: raise ValueError(f"Unknown CatalogSearchResult kind: {kind!r}") + # A content block within a tool result, which may be text, terminal output, image, audio, or a resource ExternalToolTextResultForLlmContent = ExternalToolTextResultForLlmContentText | ExternalToolTextResultForLlmContentTerminal | ExternalToolTextResultForLlmContentShellExit | ExternalToolTextResultForLlmContentImage | ExternalToolTextResultForLlmContentAudio | ExternalToolTextResultForLlmContentResourceLink | ExternalToolTextResultForLlmContentResource @@ -27633,6 +38678,72 @@ def _load_ExternalToolTextResultForLlmContent(obj: Any) -> "ExternalToolTextResu case "resource": return ExternalToolTextResultForLlmContentResource.from_dict(obj) case _: raise ValueError(f"Unknown ExternalToolTextResultForLlmContent type: {kind!r}") +# Outcome of an mcp.planInstall call: either a normalised plan, or one typed refusal. Nothing is written in either case. +MCPPlanInstallResult = MCPPlanInstallPlanned | CatalogNegotiationRefusedError | CatalogHandleRejectedError | CatalogInvalidRequestError | CatalogAuthenticationRequiredError | CatalogPolicyRejectedError | CatalogNetworkFailureError | CatalogUnsafeRetrievalError | CatalogMalformedCardError | CatalogContractViolationError | CatalogUnavailableTransportError | CatalogNotInstallableError | CatalogUnavailableError + +def _load_MCPPlanInstallResult(obj: Any) -> "MCPPlanInstallResult": + assert isinstance(obj, dict) + kind = obj.get("kind") + match kind: + case "planned": return MCPPlanInstallPlanned.from_dict(obj) + case "negotiation-refused": return CatalogNegotiationRefusedError.from_dict(obj) + case "handle-rejected": return CatalogHandleRejectedError.from_dict(obj) + case "invalid-request": return CatalogInvalidRequestError.from_dict(obj) + case "authentication-required": return CatalogAuthenticationRequiredError.from_dict(obj) + case "policy-rejected": return CatalogPolicyRejectedError.from_dict(obj) + case "network-failure": return CatalogNetworkFailureError.from_dict(obj) + case "unsafe-retrieval": return CatalogUnsafeRetrievalError.from_dict(obj) + case "malformed-card": return CatalogMalformedCardError.from_dict(obj) + case "contract-violation": return CatalogContractViolationError.from_dict(obj) + case "unavailable-transport": return CatalogUnavailableTransportError.from_dict(obj) + case "not-installable": return CatalogNotInstallableError.from_dict(obj) + case "unavailable": return CatalogUnavailableError.from_dict(obj) + case _: raise ValueError(f"Unknown MCPPlanInstallResult kind: {kind!r}") + +# What an install plan is computed from: a candidate handle from a previous search, or a card supplied directly. +MCPPlanInstallSource = MCPPlanInstallSourceCandidate | MCPPlanInstallSourceCard + +def _load_MCPPlanInstallSource(obj: Any) -> "MCPPlanInstallSource": + assert isinstance(obj, dict) + kind = obj.get("kind") + match kind: + case "candidate": return MCPPlanInstallSourceCandidate.from_dict(obj) + case "card": return MCPPlanInstallSourceCard.from_dict(obj) + case _: raise ValueError(f"Unknown MCPPlanInstallSource kind: {kind!r}") + +# One non-secret value a transport choice needs, represented as a scalar or enumerated variant so enum values cannot be missing or attached to another type. +MCPPlanRequiredValue = MCPPlanRequiredValueScalar | MCPPlanRequiredValueEnum + +def _load_MCPPlanRequiredValue(obj: Any) -> "MCPPlanRequiredValue": + assert isinstance(obj, dict) + kind = obj.get("kind") + match kind: + case "scalar": return MCPPlanRequiredValueScalar.from_dict(obj) + case "enum": return MCPPlanRequiredValueEnum.from_dict(obj) + case _: raise ValueError(f"Unknown MCPPlanRequiredValue kind: {kind!r}") + +# One eligible way to run the server, represented as a tagged package or remote variant so package identity and endpoint states cannot contradict the install method. +MCPPlanTransportChoice = MCPPlanTransportChoicePackage | MCPPlanTransportChoiceRemote + +def _load_MCPPlanTransportChoice(obj: Any) -> "MCPPlanTransportChoice": + assert isinstance(obj, dict) + kind = obj.get("installMethod") + match kind: + case "package": return MCPPlanTransportChoicePackage.from_dict(obj) + case "remote": return MCPPlanTransportChoiceRemote.from_dict(obj) + case _: raise ValueError(f"Unknown MCPPlanTransportChoice installMethod: {kind!r}") + +# A card supplied directly by the caller. Exactly one of a URL or embedded data, encoded structurally so neither both nor neither can be expressed. +MCPServerCardReference = MCPServerCardURL | MCPServerCardEmbedded + +def _load_MCPServerCardReference(obj: Any) -> "MCPServerCardReference": + assert isinstance(obj, dict) + kind = obj.get("kind") + match kind: + case "url": return MCPServerCardURL.from_dict(obj) + case "embedded": return MCPServerCardEmbedded.from_dict(obj) + case _: raise ValueError(f"Unknown MCPServerCardReference kind: {kind!r}") + # The client's response to the pending permission prompt PermissionDecision = PermissionDecisionApproveOnce | PermissionDecisionApproveForSession | PermissionDecisionApproveForLocation | PermissionDecisionApprovePermanently | PermissionDecisionReject | PermissionDecisionUserNotAvailable | PermissionDecisionApproved | PermissionDecisionApprovedForSession | PermissionDecisionApprovedForLocation | PermissionDecisionCancelled | PermissionDecisionDeniedByRules | PermissionDecisionDeniedNoApprovalRuleAndCouldNotRequestFromUser | PermissionDecisionDeniedInteractivelyByUser | PermissionDecisionDeniedByContentExclusionPolicy | PermissionDecisionDeniedByPermissionRequestHook @@ -27658,7 +38769,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 | PermissionDecisionApproveForLocationApprovalExtensionEnvAccess def _load_PermissionDecisionApproveForLocationApproval(obj: Any) -> "PermissionDecisionApproveForLocationApproval": assert isinstance(obj, dict) @@ -27672,11 +38783,13 @@ 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 "extension-env-access": return PermissionDecisionApproveForLocationApprovalExtensionEnvAccess.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 | PermissionDecisionApproveForSessionApprovalExtensionEnvAccess def _load_PermissionDecisionApproveForSessionApproval(obj: Any) -> "PermissionDecisionApproveForSessionApproval": assert isinstance(obj, dict) @@ -27690,11 +38803,13 @@ 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 "extension-env-access": return PermissionDecisionApproveForSessionApprovalExtensionEnvAccess.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 | PermissionsLocationsAddToolApprovalDetailsExtensionEnvAccess def _load_PermissionsLocationsAddToolApprovalDetails(obj: Any) -> "PermissionsLocationsAddToolApprovalDetails": assert isinstance(obj, dict) @@ -27708,7 +38823,9 @@ 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 "extension-env-access": return PermissionsLocationsAddToolApprovalDetailsExtensionEnvAccess.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. @@ -27742,8 +38859,8 @@ 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}") # State of the runtime-managed remote-control singleton. @@ -27766,8 +38883,8 @@ 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 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. @@ -27786,8 +38903,24 @@ def _load_SessionOpenParams(obj: Any) -> "SessionOpenParams": case "handoff": return SessionsOpenHandoff.from_dict(obj) case _: raise ValueError(f"Unknown SessionOpenParams kind: {kind!r}") +# Authentication credentials accepted by session.gitHubAuth.setCredentials. Session-owned token-provider identities cannot be installed through this method. +SettableAuthInfo = HMACAuthInfo | EnvAuthInfo | SettableTokenAuthInfo | CopilotAPITokenAuthInfo | UserAuthInfo | GhCLIAuthInfo | APIKeyAuthInfo + +def _load_SettableAuthInfo(obj: Any) -> "SettableAuthInfo": + assert isinstance(obj, dict) + kind = obj.get("type") + match kind: + case "hmac": return HMACAuthInfo.from_dict(obj) + case "env": return EnvAuthInfo.from_dict(obj) + case "token": return SettableTokenAuthInfo.from_dict(obj) + case "copilot-api-token": return CopilotAPITokenAuthInfo.from_dict(obj) + case "user": return UserAuthInfo.from_dict(obj) + case "gh-cli": return GhCLIAuthInfo.from_dict(obj) + case "api-key": return APIKeyAuthInfo.from_dict(obj) + case _: raise ValueError(f"Unknown SettableAuthInfo type: {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 +SlashCommandInvocationResult = SlashCommandTextResult | SlashCommandAgentPromptResult | SlashCommandCompletedResult | SlashCommandSelectSubcommandResult | SlashCommandAddTimelineEntryResult | SlashCommandShowDialogResult | SlashCommandSetModelResult | SlashCommandSetPlanModelResult def _load_SlashCommandInvocationResult(obj: Any) -> "SlashCommandInvocationResult": assert isinstance(obj, dict) @@ -27797,6 +38930,10 @@ def _load_SlashCommandInvocationResult(obj: Any) -> "SlashCommandInvocationResul case "agent-prompt": return SlashCommandAgentPromptResult.from_dict(obj) case "completed": return SlashCommandCompletedResult.from_dict(obj) case "select-subcommand": return SlashCommandSelectSubcommandResult.from_dict(obj) + case "add-timeline-entry": return SlashCommandAddTimelineEntryResult.from_dict(obj) + case "show-dialog": return SlashCommandShowDialogResult.from_dict(obj) + case "set-model": return SlashCommandSetModelResult.from_dict(obj) + case "set-plan-model": return SlashCommandSetPlanModelResult.from_dict(obj) case _: raise ValueError(f"Unknown SlashCommandInvocationResult kind: {kind!r}") # Tracked task union returned by task APIs, containing either an agent task or a shell task. @@ -27812,11 +38949,19 @@ def _load_TaskInfo(obj: Any) -> "TaskInfo": AccountGetAllUsersResult = list +AgentListRequest = Any +AuthValidationErrors = list +BuiltinToolSafeForTelemetry = bool CanvasActionInvokeResult = Any CanvasJsonSchema = Any +CardDigestValue = str +CatalogCapabilityId = str +CatalogMcpServerInstallability = CatalogMCPServerInstallabilityEnum +CommandsListRequest = Any ExternalToolResult = ExternalToolTextResultForLlm ExternalToolTextResultForLlmContentResourceLinkIconTheme = Theme FilterMapping = dict +HistoryCompactRequest = Any InstructionDiscoveryPathKind = DebugCollectLogsEntryKind InstructionDiscoveryPathLocation = InstructionLocation InstructionSourceLocation = InstructionLocation @@ -27831,24 +38976,44 @@ def _load_TaskInfo(obj: Any) -> "TaskInfo": McpExecuteSamplingRequest = dict McpExecuteSamplingResult = dict McpOauthLoginGrantType = MCPGrantType +McpPlanEnumValueType = MCPPlan +McpPlanInstallResult = MCPPlanInstallResult +McpPlanInstallSource = MCPPlanInstallSource +McpPlanRequiredValue = MCPPlanRequiredValue +McpPlanRequiredValueEnumKind = MCPPlan +McpPlanScalarValueType = MCPPlanScalarValueTypeEnum +McpPlanSecretReference = str +McpPlanTransportChoice = MCPPlanTransportChoice +McpSafeForTelemetry = bool McpServerAuthConfig = bool +McpServerCardReference = MCPServerCardReference McpServerConfigHttpOauthGrantType = MCPGrantType MetadataSnapshotRemoteMetadataTaskType = TaskType +ModelListRequest = Any OptionsUpdateAdditionalContentExclusionPolicyScope = AdditionalContentExclusionPolicyScope OptionsUpdateEnvValueMode = MCPSetEnvValueModeDetails OptionsUpdateReasoningSummary = ReasoningSummary +PermissionModeSource = PermissionSource PermissionsConfigureAdditionalContentExclusionPolicyScope = AdditionalContentExclusionPolicyScope -PermissionsSetAllowAllSource = PermissionsSetAAllSource -PermissionsSetApproveAllSource = PermissionsSetAAllSource +PermissionsSetApproveAllSource = PermissionSource +PluginsReloadRequest = Any +ProtocolExternalToolDefer = MCPServerConfigDeferTools ProviderConfigTransport = ProviderTransport ProviderConfigType = ProviderType ProviderConfigWireApi = ProviderWireAPI ProviderEndpointTransport = ProviderTransport ProviderEndpointType = ProviderType ProviderEndpointWireApi = ProviderWireAPI +ProviderGetEndpointRequest = Any RemoteSessionMetadataTaskType = TaskType +SessionAuthInfoResult = AuthIdentity +SessionCancelAllBackgroundAgentsResult = int SessionContextHostType = HostType SessionFsReaddirWithTypesEntryType = DebugCollectLogsEntryKind +SessionGitHubAuthGetAllAuthAvailableResult = list +SessionGitHubAuthLogoutResult = bool +SessionGitHubAuthLogoutUserResult = bool +SessionLimitPredictionRequest = Any SessionMcpAppsCallToolResult = dict SessionOpenOptionsAdditionalContentExclusionPolicyScope = AdditionalContentExclusionPolicyScope SessionOpenOptionsEnvValueMode = MCPSetEnvValueModeDetails @@ -27857,6 +39022,7 @@ def _load_TaskInfo(obj: Any) -> "TaskInfo": SessionWorkingDirectoryContextHostType = HostType TaskInfoExecutionMode = TaskExecutionMode TaskInfoStatus = TaskStatus +ToolResult = ToolResultExpanded WorkspaceSummaryHostType = HostType WorkspacesWorkspaceDetailsHostType = HostType @@ -27894,10 +39060,14 @@ def __init__(self, client: "JsonRpcClient"): self._client = client async def list(self, params: ModelsListRequest, *, timeout: float | None = None) -> ModelList: - "Lists Copilot models available to the authenticated user.\n\nArgs:\n params: Optional GitHub token used to list models for a specific user instead of the global auth context.\n\nReturns:\n List of Copilot models available to the resolved user, including capabilities and billing metadata." + "Lists Copilot models available to the authenticated user.\n\nArgs:\n params: Optional opaque account selection or compatibility GitHub token used to list models.\n\nReturns:\n List of Copilot models available to the resolved user, including capabilities and billing metadata." 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: @@ -27916,7 +39086,7 @@ def __init__(self, client: "JsonRpcClient"): self._client = client async def get_quota(self, params: AccountGetQuotaRequest, *, timeout: float | None = None) -> AccountGetQuotaResult: - "Gets Copilot quota usage for the authenticated user or supplied GitHub token.\n\nArgs:\n params: Optional GitHub token used to look up quota for a specific user instead of the global auth context.\n\nReturns:\n Quota usage snapshots for the resolved user, keyed by quota type." + "Gets Copilot quota usage for the current or opaquely selected authenticated user.\n\nArgs:\n params: Optional opaque account selection or compatibility GitHub token used to look up quota.\n\nReturns:\n Quota usage snapshots for the resolved user, keyed by quota type." 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))) @@ -27929,7 +39099,7 @@ async def get_all_users(self, *, timeout: float | None = None) -> list: 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" + "Validates and stores authentication credentials. When login is omitted, resolves the authenticated user from the token before persistence.\n\nArgs:\n params: Credentials to validate and store. Omit login to resolve the authenticated user from the token.\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))) @@ -28000,6 +39170,53 @@ async def discover(self, params: MCPDiscoverRequest, *, timeout: float | None = 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))) + async def plan_install(self, params: MCPPlanInstallRequest, *, timeout: float | None = None) -> MCPPlanInstallResult: + "Requests a side-effect-free MCP install plan from a catalog candidate handle or a caller-supplied card. This host-implemented server method is available through SDK/TUI hosts; standalone and C-ABI runtimes whose host does not implement server-method dispatch return JSON-RPC MethodNotFound. A runtime with planning available returns a normalised plan and opaque single-use plan handle; a runtime without it returns the typed planning-unavailable result. A completed plan reports resource identity, provenance, eligible transport choices, the user-scope target, required typed values and secret placeholders, the policy result, the configuration changes installing would make, and whether a reload would be needed. Planning never writes configuration, stores a secret, or reloads MCP servers, so abandoning a plan needs no call and leaves nothing behind.\n\nArgs:\n params: A side-effect-free request for an MCP install plan. Computing a plan never writes configuration, stores a secret, or reloads MCP servers.\n\nReturns:\n Outcome of an mcp.planInstall call: either a normalised plan, or one typed refusal. Nothing is written in either case." + params_dict = {k: v for k, v in params.to_dict().items() if v is not None} + return _load_MCPPlanInstallResult(await self._client.request("mcp.planInstall", 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 ServerCatalogApi: + def __init__(self, client: "JsonRpcClient"): + self._client = client + + async def search(self, params: CatalogSearchRequest, *, timeout: float | None = None) -> CatalogSearchResult: + "Requests a bounded catalog search. This host-implemented server method is available through SDK/TUI hosts; standalone and C-ABI runtimes whose host does not implement server-method dispatch return JSON-RPC MethodNotFound. A runtime with search available returns inert candidate summaries, each with an opaque single-use handle scoped to this runtime instance; a runtime without it returns the typed search-unavailable result. Public authorities may be searched anonymously, while an authority that requires credentials yields the typed authentication-required result. All returned text, URLs, and package metadata are untrusted external data and can never trigger instructions, tools, or installation. Read-only: nothing is installed, configured, or persisted.\n\nArgs:\n params: A bounded catalog search. Both the query length and the result count are capped by the schema so a caller cannot request an unbounded scan.\n\nReturns:\n Outcome of a catalog.search call: either bounded inert candidates, or one typed refusal. Never a partial success." + params_dict = {k: v for k, v in params.to_dict().items() if v is not None} + return _load_CatalogSearchResult(await self._client.request("catalog.search", params_dict, **_timeout_kwargs(timeout))) + + +# Experimental: this API group is experimental and may change or be removed. +class ServerPluginsBuiltinApi: + def __init__(self, client: "JsonRpcClient"): + self._client = client + + async def set(self, params: PluginsBuiltinSetRequest, *, timeout: float | None = None) -> None: + "Replaces this server's trusted built-in plugin directories while no sessions are active.\n\nArgs:\n params: Trusted built-in plugin directories to use for this runtime process." + params_dict = {k: v for k, v in params.to_dict().items() if v is not None} + await self._client.request("plugins.builtin.set", params_dict, **_timeout_kwargs(timeout)) + # Experimental: this API group is experimental and may change or be removed. class ServerPluginsMarketplacesApi: @@ -28035,6 +39252,7 @@ async def refresh(self, params: PluginsMarketplacesRefreshRequest, *, timeout: f class ServerPluginsApi: def __init__(self, client: "JsonRpcClient"): self._client = client + self.builtin = ServerPluginsBuiltinApi(client) self.marketplaces = ServerPluginsMarketplacesApi(client) async def list(self, *, timeout: float | None = None) -> PluginListResult: @@ -28081,6 +39299,11 @@ async def set_disabled_skills(self, params: SkillsConfigSetDisabledSkillsRequest params_dict = {k: v for k, v in params.to_dict().items() if v is not None} await self._client.request("skills.config.setDisabledSkills", params_dict, **_timeout_kwargs(timeout)) + async def set_skill_disabled(self, params: SkillsConfigSetSkillDisabledRequest, *, timeout: float | None = None) -> None: + "Atomically adds or removes one skill from the disabled list.\n\nArgs:\n params: Adds or removes a single skill from the global disabled list, leaving every other entry untouched." + params_dict = {k: v for k, v in params.to_dict().items() if v is not None} + await self._client.request("skills.config.setSkillDisabled", params_dict, **_timeout_kwargs(timeout)) + # Experimental: this API group is experimental and may change or be removed. class ServerSkillsApi: @@ -28167,6 +39390,16 @@ def __init__(self, client: "JsonRpcClient"): 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"): @@ -28347,12 +39580,15 @@ def __init__(self, client: "JsonRpcClient"): self.account = ServerAccountApi(client) self.secrets = ServerSecretsApi(client) self.mcp = ServerMcpApi(client) + self.extensions = ServerExtensionsApi(client) + self.catalog = ServerCatalogApi(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) @@ -28364,12 +39600,26 @@ async def ping(self, params: PingRequest, *, timeout: float | None = None) -> Pi 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} @@ -28380,6 +39630,11 @@ async def _get_persisted_remote_steerable(self, params: SessionsGetPersistedRemo 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} @@ -28403,7 +39658,7 @@ def __init__(self, client: "JsonRpcClient"): 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. 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." + "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: Connection-level opt-ins for the `server.connect` handshake. Transport authentication is consumed by the native protocol boundary before dispatch.\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))) @@ -28511,12 +39766,36 @@ async def run(self, params: FactoryRunRequest, *, timeout: float | None = 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} @@ -28558,7 +39837,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 @@ -28575,11 +39854,11 @@ async def get(self, *, timeout: float | None = None) -> SessionMode: "Gets the current agent interaction mode.\n\nReturns:\n The session mode the agent is operating in" return SessionMode(await self._client.request("session.mode.get", {"sessionId": self._session_id}, **_timeout_kwargs(timeout))) - async def set(self, params: ModeSetRequest, *, timeout: float | None = None) -> None: - "Sets the current agent interaction mode.\n\nArgs:\n params: Agent interaction mode to apply to the session." + async def set(self, params: ModeSetRequest, *, timeout: float | None = None) -> ModeSetResult: + "Sets the current agent interaction mode.\n\nArgs:\n params: Agent interaction mode to apply to the session.\n\nReturns:\n Outcome of a session mode change, including any model switch it triggered and follow-up the host must perform." 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.mode.set", params_dict, **_timeout_kwargs(timeout)) + return ModeSetResult.from_dict(await self._client.request("session.mode.set", params_dict, **_timeout_kwargs(timeout))) # Experimental: this API group is experimental and may change or be removed. @@ -28644,6 +39923,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))) @@ -28670,6 +39961,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} @@ -28677,7 +39998,7 @@ 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))) @@ -28730,9 +40051,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." @@ -28863,12 +40192,30 @@ async def handle_pending_request(self, params: MCPOauthHandlePendingRequest, *, 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, 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 probe(self, params: MCPOauthProbeRequest, *, timeout: float | None = None) -> MCPOauthProbeResult: + "Passively probes a configured remote MCP server to classify whether OAuth is required or a cached/override token is accepted. Does not start OAuth, emit pending OAuth requests, or mutate MCP connection state.\n\nArgs:\n params: Remote MCP server name for a passive OAuth status probe.\n\nReturns:\n Passive MCP OAuth probe result. `authenticated` means the server accepted the probe request while an OAuth-origin access token was attached; it does not prove the server required or independently validated that token. The probe does not make a second unauthenticated request. Failed is an expected probe-domain outcome; JSON-RPC errors are reserved for API-call failures." + 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 MCPOauthProbeResult.from_dict(await self._client.request("session.mcp.oauth.probe", 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: @@ -28985,6 +40332,10 @@ async def reload(self, *, timeout: float | None = None) -> None: "Reloads MCP server connections for the session." await self._client.request("session.mcp.reload", {"sessionId": self._session_id}, **_timeout_kwargs(timeout)) + async def move_loading_to_background(self, *, timeout: float | None = None) -> MoveMCPLoadingToBackgroundResult: + "Releases any turns waiting on an in-flight MCP load without cancelling the load, letting the agent proceed while MCP servers finish connecting in the background. No-op when no MCP load is in flight or waiting turns were already released.\n\nReturns:\n Result of moving in-flight MCP loading to the background." + return MoveMCPLoadingToBackgroundResult.from_dict(await self._client.request("session.mcp.moveLoadingToBackground", {"sessionId": self._session_id}, **_timeout_kwargs(timeout))) + async def execute_sampling(self, params: MCPExecuteSamplingParams, *, timeout: float | None = None) -> MCPSamplingExecutionResult: "Runs an MCP sampling inference on behalf of an MCP server.\n\nArgs:\n params: Identifiers and raw MCP CreateMessageRequest params used to run a sampling inference.\n\nReturns:\n Outcome of an MCP sampling execution: success result, failure error, or cancellation." params_dict: dict[str, Any] = {k: v for k, v in params.to_dict().items() if v is not None} @@ -29008,7 +40359,7 @@ async def remove_git_hub(self, *, timeout: float | None = None) -> MCPRemoveGitH 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 from a caller-supplied config. 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 configuration for an individual MCP server start." + "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)) @@ -29042,7 +40393,7 @@ 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: PluginsReloadRequest | None = None, *, timeout: float | None = None) -> None: + 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 @@ -29055,7 +40406,7 @@ def __init__(self, client: "JsonRpcClient", session_id: str): self._client = client self._session_id = session_id - async def get_endpoint(self, params: ProviderGetEndpointRequest | None = None, *, timeout: float | None = None) -> ProviderEndpoint: + 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 @@ -29133,6 +40484,24 @@ def __init__(self, client: "JsonRpcClient", session_id: str): self._client = client self._session_id = session_id + async def execute(self, params: ToolsExecuteRequest, *, timeout: float | None = None) -> ToolResultExpanded: + "Executes one tool from the session's currently offered tool set through the native invocation pipeline.\n\nArgs:\n params: A tool name and arguments to execute through the session's native invocation pipeline.\n\nReturns:\n Canonical result returned by a session tool." + 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 await self._client.request("session.tools.execute", params_dict, **_timeout_kwargs(timeout)) + + async def get_builtin_descriptors(self, params: ToolsGetBuiltinDescriptorsRequest, *, timeout: float | None = None) -> ToolsGetBuiltinDescriptorsResult: + "Returns the Rust-owned built-in tool descriptors used to construct the session's offered tool set.\n\nArgs:\n params: Options controlling how Rust-owned built-in tool descriptors are materialized.\n\nReturns:\n Rust-owned built-in tool descriptors for the session." + 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 ToolsGetBuiltinDescriptorsResult.from_dict(await self._client.request("session.tools.getBuiltinDescriptors", params_dict, **_timeout_kwargs(timeout))) + + async def task_complete_event_data(self, params: ToolsTaskCompleteEventDataRequest, *, timeout: float | None = None) -> TaskCompleteData: + "Projects a completed task_complete tool call into its label-safe session event payload.\n\nArgs:\n params: Task-completion tool arguments and final result used to build a label-safe session event payload.\n\nReturns:\n Task completion notification with summary from the 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 + return TaskCompleteData.from_dict(await self._client.request("session.tools.taskCompleteEventData", params_dict, **_timeout_kwargs(timeout))) + async def handle_pending_tool_call(self, params: HandlePendingToolCallRequest, *, timeout: float | None = None) -> HandlePendingToolCallResult: "Provides the result for a pending external tool call.\n\nArgs:\n params: Pending external tool call request ID, with the tool result or an error describing why it failed.\n\nReturns:\n Indicates whether the external tool call result was handled successfully." params_dict: dict[str, Any] = {k: v for k, v in params.to_dict().items() if v is not None} @@ -29147,6 +40516,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 set(self, params: ToolsSetRequest, *, timeout: float | None = None) -> ToolsSetResult: + "Atomically replaces the complete externally implemented tool list supplied by the calling connection. Built-in, MCP/plugin, extension-discovered, subagent, and tools supplied by other connections remain unchanged.\n\nArgs:\n params: Complete externally implemented tool list for the calling connection. An empty list removes every tool previously supplied by that connection.\n\nReturns:\n Empty result after replacing the calling connection's externally implemented tools." + 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 ToolsSetResult.from_dict(await self._client.request("session.tools.set", params_dict, **_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} @@ -29160,7 +40535,7 @@ 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 @@ -29221,7 +40596,7 @@ def __init__(self, client: "JsonRpcClient", session_id: str): 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." + "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 Completed transient query. Ordered chunks and the terminal outcome are also delivered through `ui.ephemeral_query` session events while it runs." 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))) @@ -29290,7 +40665,7 @@ async def list(self, *, timeout: float | None = None) -> PermissionPathsList: return PermissionPathsList.from_dict(await self._client.request("session.permissions.paths.list", {"sessionId": self._session_id}, **_timeout_kwargs(timeout))) async def add(self, params: PermissionPathsAddParams, *, timeout: float | None = None) -> PermissionsPathsAddResult: - "Adds a directory to the session's allow-list.\n\nArgs:\n params: Directory path to add to the session's allowed directories.\n\nReturns:\n Indicates whether the operation succeeded." + "Adds a directory to the session's allow-list and activates conventional skill and agent definitions under it.\n\nArgs:\n params: Directory path to add to the session's allowed directories.\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 PermissionsPathsAddResult.from_dict(await self._client.request("session.permissions.paths.add", params_dict, **_timeout_kwargs(timeout))) @@ -29403,15 +40778,15 @@ async def set_approve_all(self, params: PermissionsSetApproveAllRequest, *, time params_dict["sessionId"] = self._session_id 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: - "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." + async def set_mode(self, params: PermissionsSetModeRequest, *, timeout: float | None = None) -> PermissionsSetModeResult: + "Sets the permission mode for the session. `manual` follows the normal approval flow, `assisted` attaches LLM safety recommendations, and `allow-all` automatically approves permission requests. The result returns the authoritative post-mutation mode so callers can update local state without racing the `session.permissions_changed` notification.\n\nArgs:\n params: Permission mode to apply for the session.\n\nReturns:\n Indicates whether the requested permission mode was applied and reports the authoritative post-mutation 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 AllowAllPermissionSetResult.from_dict(await self._client.request("session.permissions.setAllowAll", params_dict, **_timeout_kwargs(timeout))) + return PermissionsSetModeResult.from_dict(await self._client.request("session.permissions.setMode", params_dict, **_timeout_kwargs(timeout))) - async def get_allow_all(self, *, timeout: float | None = None) -> AllowAllPermissionState: - "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 get_mode(self, *, timeout: float | None = None) -> PermissionsGetModeResult: + "Returns the current permission mode for the session.\n\nReturns:\n Current permission mode." + return PermissionsGetModeResult.from_dict(await self._client.request("session.permissions.getMode", {"sessionId": self._session_id}, **_timeout_kwargs(timeout))) async def modify_rules(self, params: PermissionsModifyRulesParams, *, timeout: float | None = None) -> PermissionsModifyRulesResult: "Adds or removes session-scoped or location-scoped permission rules.\n\nArgs:\n params: Scope and add/remove instructions for modifying session- or location-scoped permission rules.\n\nReturns:\n Indicates whether the operation succeeded." @@ -29425,9 +40800,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." @@ -29489,6 +40866,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): @@ -29496,13 +40886,13 @@ 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))) @@ -29526,7 +40916,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 @@ -29538,6 +40928,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))) @@ -29550,6 +40956,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: @@ -29561,6 +40973,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))) @@ -29577,7 +41031,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))) @@ -29610,6 +41064,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): @@ -29699,11 +41166,13 @@ 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) @@ -29730,6 +41199,16 @@ async def abort(self, params: AbortRequest, *, timeout: float | None = 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} @@ -29743,6 +41222,112 @@ 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 _InternalGitHubAuthApi: + def __init__(self, client: "JsonRpcClient", session_id: str): + self._client = client + self._session_id = session_id + + async def _get_current_auth_info(self, *, timeout: float | None = None) -> AuthIdentity | None: + "Gets the current authentication information for internal session hosts.\n\nReturns:\n Current authentication information, or null when no authentication is active.\n\n:meta private:\n\nInternal SDK API; not part of the public surface." + _result = await self._client.request("session.gitHubAuth.getCurrentAuthInfo", {"sessionId": self._session_id}, **_timeout_kwargs(timeout)) + return AuthIdentity(_result) if _result is not None else None + + async def _get_all_auth_available(self, *, timeout: float | None = None) -> list: + "Gets all authentication accounts available to the internal session host.\n\nReturns:\n Authentication accounts available to the internal session host.\n\n:meta private:\n\nInternal SDK API; not part of the public surface." + return list(await self._client.request("session.gitHubAuth.getAllAuthAvailable", {"sessionId": self._session_id}, **_timeout_kwargs(timeout))) + + async def _refresh_copilot_user(self, *, timeout: float | None = None) -> AuthIdentity | None: + "Refreshes Copilot account metadata for the current authentication.\n\nReturns:\n Current authentication information, or null when no authentication is active.\n\n:meta private:\n\nInternal SDK API; not part of the public surface." + _result = await self._client.request("session.gitHubAuth.refreshCopilotUser", {"sessionId": self._session_id}, **_timeout_kwargs(timeout)) + return AuthIdentity(_result) if _result is not None else None + + async def _login(self, params: SessionAuthLoginRequest, *, timeout: float | None = None) -> AuthInfo: + "Logs in a GitHub user through the internal session host.\n\nArgs:\n params: Internal GitHub login parameters.\n\nReturns:\n Authentication credentials accepted only at native protocol ingress. Runtime outputs use credential-free `AuthIdentity` metadata.\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 _load_AuthInfo(await self._client.request("session.gitHubAuth.login", params_dict, **_timeout_kwargs(timeout))) + + async def _switch_to_auth(self, params: SessionAuthSwitchRequest, *, timeout: float | None = None) -> None: + "Switches the session to another available authentication.\n\nArgs:\n params: Parameters for switching the session's active authentication.\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.gitHubAuth.switchToAuth", params_dict, **_timeout_kwargs(timeout)) + + async def _logout(self, *, timeout: float | None = None) -> bool: + "Logs out the session's current GitHub authentication.\n\nReturns:\n Whether the current authentication was logged out.\n\n:meta private:\n\nInternal SDK API; not part of the public surface." + return bool(await self._client.request("session.gitHubAuth.logout", {"sessionId": self._session_id}, **_timeout_kwargs(timeout))) + + async def _logout_user(self, params: SessionAuthLogoutUserRequest, *, timeout: float | None = None) -> bool: + "Logs out a specific GitHub authentication.\n\nArgs:\n params: Parameters identifying a GitHub authentication to log out.\n\nReturns:\n Whether the requested authentication was logged out.\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 bool(await self._client.request("session.gitHubAuth.logoutUser", params_dict, **_timeout_kwargs(timeout))) + + async def _last_auth_errors(self, *, timeout: float | None = None) -> list: + "Gets validation errors from the most recent authentication attempt.\n\nReturns:\n Validation errors from the most recent authentication attempt.\n\n:meta private:\n\nInternal SDK API; not part of the public surface." + return list(await self._client.request("session.gitHubAuth.lastAuthErrors", {"sessionId": self._session_id}, **_timeout_kwargs(timeout))) + + +# Experimental: this API group is experimental and may change or be removed. +class _InternalCanvasProviderApi: + def __init__(self, client: "JsonRpcClient", session_id: str): + self._client = client + self._session_id = session_id + + async def _register(self, params: CanvasProviderRegisterRequest, *, timeout: float | None = None) -> None: + "Registers an internal canvas provider connection and its contributions.\n\nArgs:\n params: Internal canvas provider registration parameters.\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.canvas.provider.register", params_dict, **_timeout_kwargs(timeout)) + + async def _unregister(self, params: CanvasProviderUnregisterRequest, *, timeout: float | None = None) -> None: + "Unregisters an internal canvas provider connection.\n\nArgs:\n params: Internal canvas provider unregistration parameters.\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.canvas.provider.unregister", params_dict, **_timeout_kwargs(timeout)) + + +# Experimental: this API group is experimental and may change or be removed. +class _InternalCanvasApi: + def __init__(self, client: "JsonRpcClient", session_id: str): + self._client = client + self._session_id = session_id + self.provider = _InternalCanvasProviderApi(client, session_id) + + +# Experimental: this API group is experimental and may change or be removed. +class _InternalFactoryApi: + def __init__(self, client: "JsonRpcClient", session_id: str): + self._client = client + self._session_id = session_id + + async def _run_from_tool(self, params: _FactoryToolRunRequest, *, timeout: float | None = None) -> FactoryRunResult: + "Internal tool-originated factory invocation.\n\nArgs:\n params: Internal parameters for invoking a registered factory from a tool.\n\nReturns:\n Complete current or terminal factory run envelope.\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 FactoryRunResult.from_dict(await self._client.request("session.factory.runFromTool", params_dict, **_timeout_kwargs(timeout))) + + async def _resume_from_tool(self, params: _FactoryToolResumeRequest, *, timeout: float | None = None) -> FactoryResumeResult: + "Internal tool-originated factory resume.\n\nArgs:\n params: Internal parameters for resuming a factory run from a tool.\n\nReturns:\n Resolved persisted factory identity and resumed run envelope.\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 FactoryResumeResult.from_dict(await self._client.request("session.factory.resumeFromTool", params_dict, **_timeout_kwargs(timeout))) + + +# Experimental: this API group is experimental and may change or be removed. +class _InternalModelApi: + def __init__(self, client: "JsonRpcClient", session_id: str): + self._client = client + self._session_id = session_id + + async def _apply_startup_overlay(self, params: ModelApplyStartupOverlayRequest, *, timeout: float | None = None) -> ModelSwitchToResult: + "Resolves and applies organization-managed and repository model overlays.\n\nArgs:\n params: Managed, repository, and CLI model overrides to overlay onto the session at startup.\n\nReturns:\n The model identifier active on the session after the switch.\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 ModelSwitchToResult.from_dict(await self._client.request("session.model.applyStartupOverlay", 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): @@ -29756,7 +41341,7 @@ async def _reload_with_config(self, params: MCPReloadWithConfigRequest, *, timeo 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." + "Configures the built-in GitHub MCP server for the session's current auth context.\n\nArgs:\n params: Credential-free authentication identity 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))) @@ -29774,6 +41359,19 @@ async def _unregister_external_client(self, params: MCPUnregisterExternalClientR 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 _InternalCommandsApi: + def __init__(self, client: "JsonRpcClient", session_id: str): + self._client = client + self._session_id = session_id + + async def _finalize_invocation_effect(self, params: CommandsFinalizeInvocationEffectRequest, *, timeout: float | None = None) -> CommandsFinalizeInvocationEffectResult: + "Finalizes persistence associated with a client-applied slash-command effect.\n\nArgs:\n params: The pending slash-command invocation effect to finalize, plus whether the host applied or cancelled it.\n\nReturns:\n Whether finalizing the invocation effect succeeded, and the failure reason when it did not.\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 CommandsFinalizeInvocationEffectResult.from_dict(await self._client.request("session.commands.finalizeInvocationEffect", 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): @@ -29791,13 +41389,118 @@ async def _evaluate_predicate(self, params: SessionSettingsEvaluatePredicateRequ 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.git_hub_auth = _InternalGitHubAuthApi(client, session_id) + self.canvas = _InternalCanvasApi(client, session_id) + self.factory = _InternalFactoryApi(client, session_id) + self.model = _InternalModelApi(client, session_id) self.mcp = _InternalMcpApi(client, session_id) + self.commands = _InternalCommandsApi(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. @@ -29848,7 +41551,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." @@ -29976,6 +41682,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 @@ -30011,6 +41724,12 @@ 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: @@ -30026,11 +41745,19 @@ 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 +# Experimental: this API group is experimental and may change or be removed. +class GitHubTokenHandler(Protocol): + async def get_token(self, params: GitHubTokenAcquireRequest) -> GitHubTokenAcquireResult: + "Asks the SDK client to mint a GitHub access token for a session whose configuration supplied a GitHub token provider. The runtime acquires the initial token during bootstrap and refreshes it during expiry preflight when one hour or less remains.\n\nArgs:\n params: Asks the SDK client to acquire a GitHub access token from an opaque callback registration.\n\nReturns:\n SDK host response to a GitHub credential request." + 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 + git_hub_token: GitHubTokenHandler | None = None def register_client_global_api_handlers( client: "JsonRpcClient", @@ -30049,6 +41776,13 @@ async def handle_hooks_invoke(params: dict) -> dict | None: 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 @@ -30070,6 +41804,13 @@ async def handle_git_hub_telemetry_event(params: dict) -> None: await handler.event(request) return None client.set_notification_method_handler("gitHubTelemetry.event", handle_git_hub_telemetry_event) + async def handle_git_hub_token_get_token(params: dict) -> dict | None: + request = GitHubTokenAcquireRequest.from_dict(params) + handler = handlers.git_hub_token + if handler is None: raise RuntimeError("No git_hub_token client-global handler registered") + result = await handler.get_token(request) + return result.value if hasattr(result, 'value') else result + client.set_request_handler("gitHubToken.getToken", handle_git_hub_token_get_token) __all__ = [ "APIKeyAuthInfo", @@ -30096,6 +41837,7 @@ async def handle_git_hub_telemetry_event(params: dict) -> None: "AgentInfo", "AgentInfoSource", "AgentList", + "AgentListRequest", "AgentRegistryLiveTargetEntry", "AgentRegistryLiveTargetEntryAttentionKind", "AgentRegistryLiveTargetEntryKind", @@ -30120,13 +41862,24 @@ async def handle_git_hub_telemetry_event(params: dict) -> None: "AgentReloadResult", "AgentSelectRequest", "AgentSelectResult", + "AgentSetPromptRequest", "AgentsDiscoverRequest", "AgentsGetDiscoveryPathsRequest", - "AllowAllPermissionSetResult", - "AllowAllPermissionState", "ApprovalKind", + "AuthIdentity", "AuthInfo", "AuthInfoType", + "AuthValidationError", + "AuthValidationErrors", + "BuiltInModelCatalog", + "BuiltInModelCatalogEntry", + "BuiltinToolDescriptor", + "BuiltinToolFormat", + "BuiltinToolFormatType", + "BuiltinToolInputSchema", + "BuiltinToolInputSchemaType", + "BuiltinToolSafeForTelemetry", + "BuiltinToolSafeTelemetryFields", "CancelUserRequestedShellCommandResult", "CanvasAction", "CanvasActionApi", @@ -30145,14 +41898,89 @@ async def handle_git_hub_telemetry_event(params: dict) -> None: "CanvasProviderInvokeActionRequest", "CanvasProviderOpenRequest", "CanvasProviderOpenResult", + "CanvasProviderRegisterRequest", + "CanvasProviderUnregisterRequest", "CanvasSessionContext", "CapiSessionOptions", + "CardDigest", + "CardDigestAlgorithm", + "CardDigestValue", + "CatalogAISkillCandidate", + "CatalogAISkillCandidateKind", + "CatalogAISkillCandidateProvenance", + "CatalogAuthenticationRequiredError", + "CatalogAuthenticationRequiredErrorKind", + "CatalogAuthenticationRequiredReason", + "CatalogCandidate", + "CatalogCandidateInstallability", + "CatalogCandidateKind", + "CatalogCandidateProvenance", + "CatalogCandidateSource", + "CatalogCandidateSourceEmbedded", + "CatalogCandidateSourceKind", + "CatalogCandidateSourceURL", + "CatalogCapability", + "CatalogCapabilityId", + "CatalogClientContract", + "CatalogContractViolationError", + "CatalogContractViolationErrorKind", + "CatalogContractViolationReason", + "CatalogHandleRejectedError", + "CatalogHandleRejectedErrorKind", + "CatalogHandleRejectionReason", + "CatalogHandleType", + "CatalogInvalidRequestError", + "CatalogInvalidRequestErrorKind", + "CatalogInvalidRequestField", + "CatalogMCPServerCandidate", + "CatalogMCPServerCandidateKind", + "CatalogMCPServerCandidateProvenance", + "CatalogMCPServerInstallabilityEnum", + "CatalogMalformedCardError", + "CatalogMalformedCardErrorKind", + "CatalogMalformedCardReason", + "CatalogMcpServerInstallability", + "CatalogMediaType", + "CatalogNegotiatedContract", + "CatalogNegotiationRefusedError", + "CatalogNegotiationRefusedErrorKind", + "CatalogNegotiationRefusedReason", + "CatalogNetworkFailureError", + "CatalogNetworkFailureErrorKind", + "CatalogNetworkFailureReason", + "CatalogNotInstallableError", + "CatalogNotInstallableErrorKind", + "CatalogNotInstallableReason", + "CatalogPolicyRejectedError", + "CatalogPolicyRejectedErrorKind", + "CatalogSearchRequest", + "CatalogSearchResult", + "CatalogSearchResultKind", + "CatalogSearchResultReason", + "CatalogSearchSucceeded", + "CatalogSearchSucceededKind", + "CatalogUnavailableError", + "CatalogUnavailableErrorKind", + "CatalogUnavailableReason", + "CatalogUnavailableTransportError", + "CatalogUnavailableTransportErrorKind", + "CatalogUnavailableTransportReason", + "CatalogUnsafeRetrievalError", + "CatalogUnsafeRetrievalErrorKind", + "CatalogUnsafeRetrievalReason", + "CatalogUnsupportedKindError", + "CatalogUnsupportedKindErrorKind", + "Categories", "ClientGlobalApiHandlers", "ClientSessionApiHandlers", "CommandList", "CommandsApi", + "CommandsFinalizeInvocationEffectRequest", + "CommandsFinalizeInvocationEffectResult", "CommandsHandlePendingCommandRequest", "CommandsHandlePendingCommandResult", + "CommandsInvocationEffectOutcome", + "CommandsInvocationOrigin", "CommandsInvokeRequest", "CommandsListRequest", "CommandsRespondToQueuedCommandRequest", @@ -30166,6 +41994,10 @@ async def handle_git_hub_telemetry_event(params: dict) -> None: "ConnectedRemoteSessionMetadata", "ConnectedRemoteSessionMetadataKind", "ConnectedRemoteSessionMetadataRepository", + "ContentExclusionApi", + "ContentExclusionCheckPathsRequest", + "ContentExclusionCheckPathsResult", + "ContentExclusionPathCheck", "ContentFilterMode", "ContextHeaviestMessage", "CopilotAPITokenAuthInfo", @@ -30191,6 +42023,13 @@ async def handle_git_hub_telemetry_event(params: dict) -> None: "DebugCollectLogsSkippedEntry", "DebugCollectLogsSource", "DiscoveredCanvas", + "DiscoveredExtension", + "DiscoveredExtensionMode", + "DiscoveredExtensionPlugin", + "DiscoveredExtensionSource", + "DiscoveredExtensions", + "DiscoveredExtensionsDisableRequest", + "DiscoveredExtensionsEnableRequest", "DiscoveredMCPServer", "DiscoveredMCPServerType", "EnqueueCommandParams", @@ -30205,18 +42044,24 @@ async def handle_git_hub_telemetry_event(params: dict) -> None: "EventLogTypes", "EventsAgentScope", "EventsCursorStatus", + "EventsReadDirection", "EventsReadResult", "ExecuteCommandParams", "ExecuteCommandResult", "Extension", "ExtensionContextPushInput", "ExtensionContextPushInputType", + "ExtensionLaunchProfile", + "ExtensionLaunchProviderHandler", + "ExtensionLaunchProviderResolveRequest", + "ExtensionLaunchProviderResolveResult", "ExtensionList", "ExtensionSource", "ExtensionStatus", "ExtensionsApi", "ExtensionsDisableRequest", "ExtensionsEnableRequest", + "ExternalRefMCPOauthHTTPResponse", "ExternalToolResult", "ExternalToolTextResultForLlm", "ExternalToolTextResultForLlmBinaryResultsForLlm", @@ -30244,19 +42089,34 @@ async def handle_git_hub_telemetry_event(params: dict) -> None: "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", @@ -30264,6 +42124,8 @@ async def handle_git_hub_telemetry_event(params: dict) -> None: "FactoryRunRequest", "FactoryRunResult", "FactoryRunStatus", + "FactoryRunSummary", + "FactoryRunTerminal", "FilterMapping", "FleetApi", "FleetStartRequest", @@ -30279,6 +42141,11 @@ async def handle_git_hub_telemetry_event(params: dict) -> None: "GitHubTelemetryEvent", "GitHubTelemetryHandler", "GitHubTelemetryNotification", + "GitHubTokenAcquireReason", + "GitHubTokenAcquireRequest", + "GitHubTokenAcquireResult", + "GitHubTokenAcquireResultKind", + "GitHubTokenHandler", "HMACAuthInfo", "HMACAuthInfoType", "HandlePendingToolCallRequest", @@ -30286,21 +42153,39 @@ async def handle_git_hub_telemetry_event(params: dict) -> None: "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", + "InstallMethod", + "Installability", "InstalledPlugin", "InstalledPluginInfo", "InstalledPluginSource", "InstalledPluginSourceGitHub", "InstalledPluginSourceLocal", "InstalledPluginSourceURL", + "InstalledPluginSourceURLSource", "InstructionDiscoveryPath", "InstructionDiscoveryPathKind", "InstructionDiscoveryPathList", @@ -30313,7 +42198,10 @@ async def handle_git_hub_telemetry_event(params: dict) -> None: "InstructionsDiscoverRequest", "InstructionsGetDiscoveryPathsRequest", "InstructionsGetSourcesResult", + "InterruptMainTurnRequest", + "InterruptMainTurnResult", "KindEnum", + "LimitPredictionApi", "LlmInferenceHTTPRequestChunkRequest", "LlmInferenceHTTPRequestChunkResult", "LlmInferenceHTTPRequestStartRequest", @@ -30362,8 +42250,10 @@ async def handle_git_hub_telemetry_event(params: dict) -> None: "MCPDisableRequest", "MCPDiscoverRequest", "MCPDiscoverResult", + "MCPElicitationFormMode", "MCPEnableRequest", "MCPExecuteSamplingParams", + "MCPFailedServer", "MCPFilteredServer", "MCPGrantType", "MCPHeadersHandlePendingHeadersRefreshRequest", @@ -30371,17 +42261,63 @@ async def handle_git_hub_telemetry_event(params: dict) -> None: "MCPHeadersHandlePendingHeadersRefreshRequestRequest", "MCPHeadersHandlePendingHeadersRefreshRequestResult", "MCPHostState", + "MCPInstallPlan", "MCPIsServerRunningRequest", "MCPIsServerRunningResult", "MCPListToolsRequest", "MCPListToolsResult", + "MCPOauthAuthenticationStateChangedRequest", "MCPOauthHandlePendingRequest", "MCPOauthHandlePendingResult", "MCPOauthLoginRequest", "MCPOauthLoginResult", "MCPOauthPendingRequestResponse", - "MCPOauthPendingRequestResponseKind", + "MCPOauthProbeNeedsAuthReason", + "MCPOauthProbeRequest", + "MCPOauthProbeResult", + "MCPOauthRespondRequest", + "MCPOauthRespondResult", + "MCPPlan", + "MCPPlanConfigurationChange", + "MCPPlanConfigurationOperation", + "MCPPlanETransport", + "MCPPlanInstallPlanned", + "MCPPlanInstallPlannedKind", + "MCPPlanInstallRequest", + "MCPPlanInstallResult", + "MCPPlanInstallResultKind", + "MCPPlanInstallResultReason", + "MCPPlanInstallSource", + "MCPPlanInstallSourceCandidate", + "MCPPlanInstallSourceCandidateKind", + "MCPPlanInstallSourceCard", + "MCPPlanInstallSourceCardKind", + "MCPPlanInstallSourceKind", + "MCPPlanPackageInstallMethod", + "MCPPlanPackageTransport", + "MCPPlanPolicyDecision", + "MCPPlanPolicyResult", + "MCPPlanPolicySource", + "MCPPlanProvenance", + "MCPPlanRemoteInstallMethod", + "MCPPlanRemoteTransport", + "MCPPlanRequiredValue", + "MCPPlanRequiredValueEnum", + "MCPPlanRequiredValueKind", + "MCPPlanRequiredValueScalar", + "MCPPlanRequiredValueScalarKind", + "MCPPlanRequiredValueValueType", + "MCPPlanResourceIdentity", + "MCPPlanScalarValueTypeEnum", + "MCPPlanScope", + "MCPPlanSecretPlaceholder", + "MCPPlanTarget", + "MCPPlanTransportChoice", + "MCPPlanTransportChoicePackage", + "MCPPlanTransportChoiceRemote", + "MCPPlanValueCategory", "MCPRegisterExternalClientRequest", + "MCPReloadConfig", "MCPReloadWithConfigRequest", "MCPRemoveGitHubResult", "MCPResource", @@ -30396,15 +42332,28 @@ async def handle_git_hub_telemetry_event(params: dict) -> None: "MCPResourcesReadRequest", "MCPResourcesReadResult", "MCPRestartServerRequest", + "MCPSafeForTelemetryFields", "MCPSamplingExecutionAction", "MCPSamplingExecutionResult", + "MCPSerializableServerConfig", + "MCPSerializableServerConfigType", "MCPServer", "MCPServerAuthConfigRedirectPort", + "MCPServerCardEmbedded", + "MCPServerCardEmbeddedKind", + "MCPServerCardMediaType", + "MCPServerCardReference", + "MCPServerCardURL", + "MCPServerCardURLKind", "MCPServerConfig", "MCPServerConfigDeferTools", "MCPServerConfigHTTP", "MCPServerConfigHTTPType", + "MCPServerConfigMemory", + "MCPServerConfigMemoryType", "MCPServerConfigStdio", + "MCPServerConfigStdioType", + "MCPServerConfigType", "MCPServerFailureInfo", "MCPServerList", "MCPServerNeedsAuthInfo", @@ -30414,10 +42363,12 @@ async def handle_git_hub_telemetry_event(params: dict) -> None: "MCPStartServerRequest", "MCPStartServersResult", "MCPStopServerRequest", + "MCPTaskMetadata", "MCPToolUI", "MCPToolUIVisibility", "MCPTools", "MCPUnregisterExternalClientRequest", + "ManagedSettingsReadResult", "MarketplaceAddResult", "MarketplaceBrowseResult", "MarketplaceInfo", @@ -30440,9 +42391,20 @@ async def handle_git_hub_telemetry_event(params: dict) -> None: "McpHeadersApi", "McpOauthApi", "McpOauthLoginGrantType", + "McpPlanEnumValueType", + "McpPlanInstallResult", + "McpPlanInstallSource", + "McpPlanRequiredValue", + "McpPlanRequiredValueEnumKind", + "McpPlanScalarValueType", + "McpPlanSecretReference", + "McpPlanTransportChoice", "McpResourcesApi", + "McpSafeForTelemetry", "McpServerAuthConfig", + "McpServerCardReference", "McpServerConfigHttpOauthGrantType", + "MediaType", "MemoryConfiguration", "MetadataApi", "MetadataContextAttributionResult", @@ -30463,8 +42425,10 @@ async def handle_git_hub_telemetry_event(params: dict) -> None: "MetadataSnapshotRemoteMetadataTaskType", "ModeApi", "ModeSetRequest", + "ModeSetResult", "Model", "ModelApi", + "ModelApplyStartupOverlayRequest", "ModelBilling", "ModelBillingPromo", "ModelBillingTokenPrices", @@ -30479,15 +42443,21 @@ async def handle_git_hub_telemetry_event(params: dict) -> None: "ModelCapabilitiesSupports", "ModelList", "ModelListRequest", + "ModelMessage", "ModelPickerCategory", + "ModelPickerPersistenceRequest", "ModelPickerPriceCategory", + "ModelPickerSettingsContext", "ModelPolicy", "ModelPolicyState", "ModelSetReasoningEffortRequest", "ModelSetReasoningEffortResult", + "ModelSwitchConfirmation", "ModelSwitchToRequest", "ModelSwitchToResult", + "ModelWarningText", "ModelsListRequest", + "MoveMCPLoadingToBackgroundResult", "NameApi", "NameGetResult", "NameSetAutoRequest", @@ -30507,23 +42477,25 @@ async def handle_git_hub_telemetry_event(params: dict) -> None: "PendingPermissionRequest", "PendingPermissionRequestList", "PermissionDecision", - "PermissionDecisionApproveForIonApproval", "PermissionDecisionApproveForLocation", "PermissionDecisionApproveForLocationApproval", "PermissionDecisionApproveForLocationApprovalCommands", "PermissionDecisionApproveForLocationApprovalCommandsKind", "PermissionDecisionApproveForLocationApprovalCustomTool", "PermissionDecisionApproveForLocationApprovalCustomToolKind", + "PermissionDecisionApproveForLocationApprovalExtensionEnvAccess", + "PermissionDecisionApproveForLocationApprovalExtensionEnvAccessKind", "PermissionDecisionApproveForLocationApprovalExtensionManagement", "PermissionDecisionApproveForLocationApprovalExtensionManagementKind", "PermissionDecisionApproveForLocationApprovalExtensionPermissionAccess", "PermissionDecisionApproveForLocationApprovalExtensionPermissionAccessKind", + "PermissionDecisionApproveForLocationApprovalFactory", + "PermissionDecisionApproveForLocationApprovalFactoryKind", "PermissionDecisionApproveForLocationApprovalMCP", "PermissionDecisionApproveForLocationApprovalMCPKind", "PermissionDecisionApproveForLocationApprovalMCPSampling", "PermissionDecisionApproveForLocationApprovalMCPSamplingKind", "PermissionDecisionApproveForLocationApprovalMemory", - "PermissionDecisionApproveForLocationApprovalMemoryKind", "PermissionDecisionApproveForLocationApprovalRead", "PermissionDecisionApproveForLocationApprovalReadKind", "PermissionDecisionApproveForLocationApprovalWrite", @@ -30533,8 +42505,10 @@ async def handle_git_hub_telemetry_event(params: dict) -> None: "PermissionDecisionApproveForSessionApproval", "PermissionDecisionApproveForSessionApprovalCommands", "PermissionDecisionApproveForSessionApprovalCustomTool", + "PermissionDecisionApproveForSessionApprovalExtensionEnvAccess", "PermissionDecisionApproveForSessionApprovalExtensionManagement", "PermissionDecisionApproveForSessionApprovalExtensionPermissionAccess", + "PermissionDecisionApproveForSessionApprovalFactory", "PermissionDecisionApproveForSessionApprovalMCP", "PermissionDecisionApproveForSessionApprovalMCPSampling", "PermissionDecisionApproveForSessionApprovalMemory", @@ -30553,6 +42527,7 @@ async def handle_git_hub_telemetry_event(params: dict) -> None: "PermissionDecisionApprovedKind", "PermissionDecisionCancelled", "PermissionDecisionCancelledKind", + "PermissionDecisionContext", "PermissionDecisionDeniedByContentExclusionPolicy", "PermissionDecisionDeniedByContentExclusionPolicyKind", "PermissionDecisionDeniedByPermissionRequestHook", @@ -30564,9 +42539,12 @@ async def handle_git_hub_telemetry_event(params: dict) -> None: "PermissionDecisionDeniedNoApprovalRuleAndCouldNotRequestFromUser", "PermissionDecisionDeniedNoApprovalRuleAndCouldNotRequestFromUserKind", "PermissionDecisionKind", + "PermissionDecisionOutcome", "PermissionDecisionReject", "PermissionDecisionRejectKind", "PermissionDecisionRequest", + "PermissionDecisionSource", + "PermissionDecisionSurface", "PermissionDecisionUserNotAvailable", "PermissionDecisionUserNotAvailableKind", "PermissionLocationAddToolApprovalParams", @@ -30575,6 +42553,7 @@ async def handle_git_hub_telemetry_event(params: dict) -> None: "PermissionLocationResolveParams", "PermissionLocationResolveResult", "PermissionLocationType", + "PermissionModeSource", "PermissionPathsAddParams", "PermissionPathsAllowedCheckParams", "PermissionPathsAllowedCheckResult", @@ -30585,10 +42564,11 @@ async def handle_git_hub_telemetry_event(params: dict) -> None: "PermissionPathsWorkspaceCheckResult", "PermissionPromptShownNotification", "PermissionRequestResult", + "PermissionResponseCapability", "PermissionRulesSet", + "PermissionSource", "PermissionUrlsConfig", "PermissionUrlsSetUnrestrictedModeParams", - "PermissionsAllowAllMode", "PermissionsApi", "PermissionsConfigureAdditionalContentExclusionPolicy", "PermissionsConfigureAdditionalContentExclusionPolicyRule", @@ -30598,12 +42578,15 @@ async def handle_git_hub_telemetry_event(params: dict) -> None: "PermissionsConfigureResult", "PermissionsFolderTrustAddTrustedResult", "PermissionsFolderTrustApi", - "PermissionsGetAllowAllRequest", + "PermissionsGetModeRequest", + "PermissionsGetModeResult", "PermissionsLocationsAddToolApprovalDetails", "PermissionsLocationsAddToolApprovalDetailsCommands", "PermissionsLocationsAddToolApprovalDetailsCustomTool", + "PermissionsLocationsAddToolApprovalDetailsExtensionEnvAccess", "PermissionsLocationsAddToolApprovalDetailsExtensionManagement", "PermissionsLocationsAddToolApprovalDetailsExtensionPermissionAccess", + "PermissionsLocationsAddToolApprovalDetailsFactory", "PermissionsLocationsAddToolApprovalDetailsMCP", "PermissionsLocationsAddToolApprovalDetailsMCPSampling", "PermissionsLocationsAddToolApprovalDetailsMemory", @@ -30622,12 +42605,11 @@ async def handle_git_hub_telemetry_event(params: dict) -> None: "PermissionsPendingRequestsRequest", "PermissionsResetSessionApprovalsRequest", "PermissionsResetSessionApprovalsResult", - "PermissionsSetAAllSource", - "PermissionsSetAllowAllRequest", - "PermissionsSetAllowAllSource", "PermissionsSetApproveAllRequest", "PermissionsSetApproveAllResult", "PermissionsSetApproveAllSource", + "PermissionsSetModeRequest", + "PermissionsSetModeResult", "PermissionsSetRequiredRequest", "PermissionsSetRequiredResult", "PermissionsUrlsApi", @@ -30649,6 +42631,7 @@ async def handle_git_hub_telemetry_event(params: dict) -> None: "PluginUpdateAllResult", "PluginUpdateResult", "PluginsApi", + "PluginsBuiltinSetRequest", "PluginsDisableRequest", "PluginsEnableRequest", "PluginsInstallRequest", @@ -30659,6 +42642,8 @@ async def handle_git_hub_telemetry_event(params: dict) -> None: "PluginsReloadRequest", "PluginsUninstallRequest", "PluginsUpdateRequest", + "ProtocolExternalToolDefer", + "ProtocolExternalToolDefinition", "ProviderAddRequest", "ProviderAddResult", "ProviderApi", @@ -30704,7 +42689,6 @@ async def handle_git_hub_telemetry_event(params: dict) -> None: "PushAttachmentGitHubReleaseType", "PushAttachmentGitHubRepository", "PushAttachmentGitHubRepositoryType", - "PushAttachmentGitHubSide", "PushAttachmentGitHubSnippet", "PushAttachmentGitHubSnippetType", "PushAttachmentGitHubTreeComparison", @@ -30720,10 +42704,33 @@ async def handle_git_hub_telemetry_event(params: dict) -> None: "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", @@ -30752,6 +42759,7 @@ async def handle_git_hub_telemetry_event(params: dict) -> None: "RemoteNotifySteerableChangedRequest", "RemoteNotifySteerableChangedResult", "RemoteSessionConnectionResult", + "RemoteSessionHostStatus", "RemoteSessionMetadataRepository", "RemoteSessionMetadataTaskType", "RemoteSessionMetadataValue", @@ -30759,16 +42767,25 @@ async def handle_git_hub_telemetry_event(params: dict) -> None: "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", @@ -30781,18 +42798,23 @@ async def handle_git_hub_telemetry_event(params: dict) -> None: "SendMode", "SendRequest", "SendResult", + "SendSystemNotificationRequest", "ServerAccountApi", "ServerAgentList", "ServerAgentRegistryApi", "ServerAgentsApi", + "ServerCatalogApi", "ServerCommandsApi", + "ServerExtensionsApi", "ServerInstructionSourceList", "ServerInstructionsApi", "ServerLlmInferenceApi", + "ServerManagedSettingsApi", "ServerMcpApi", "ServerMcpConfigApi", "ServerModelsApi", "ServerPluginsApi", + "ServerPluginsBuiltinApi", "ServerPluginsMarketplacesApi", "ServerRpc", "ServerRuntimeApi", @@ -30807,9 +42829,16 @@ async def handle_git_hub_telemetry_event(params: dict) -> None: "ServerUserApi", "ServerUserSettingsApi", "SessionActivity", + "SessionAgentListRequest", + "SessionAuthInfoResult", + "SessionAuthLoginRequest", + "SessionAuthLogoutUserRequest", "SessionAuthStatus", + "SessionAuthSwitchRequest", "SessionBulkDeleteResult", + "SessionCancelAllBackgroundAgentsResult", "SessionCapability", + "SessionCommandsListRequest", "SessionCompletionItem", "SessionContext", "SessionContextAttribution", @@ -30840,24 +42869,47 @@ async def handle_git_hub_telemetry_event(params: dict) -> None: "SessionFSSqliteQueryRequest", "SessionFSSqliteQueryResult", "SessionFSSqliteQueryType", + "SessionFSSqliteTransactionError", + "SessionFSSqliteTransactionErrorClass", + "SessionFSSqliteTransactionRequest", + "SessionFSSqliteTransactionResult", + "SessionFSSqliteTransactionStatement", "SessionFSStatRequest", "SessionFSStatResult", "SessionFSWriteFileRequest", "SessionFsHandler", "SessionFsReaddirWithTypesEntryType", + "SessionGitHubAuthGetAllAuthAvailableResult", + "SessionGitHubAuthLogoutResult", + "SessionGitHubAuthLogoutUserResult", + "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", @@ -30869,6 +42921,8 @@ async def handle_git_hub_telemetry_event(params: dict) -> None: "SessionOpenParams", "SessionOpenParamsKind", "SessionOpenResult", + "SessionPluginsReloadRequest", + "SessionProviderGetEndpointRequest", "SessionPruneResult", "SessionRpc", "SessionSetCredentialsParams", @@ -30896,6 +42950,7 @@ async def handle_git_hub_telemetry_event(params: dict) -> None: "SessionsCheckInUseResult", "SessionsCloseRequest", "SessionsCloseResult", + "SessionsDeleteRequest", "SessionsEnrichMetadataRequest", "SessionsFindByPrefixRequest", "SessionsFindByPrefixResult", @@ -30909,8 +42964,12 @@ async def handle_git_hub_telemetry_event(params: dict) -> None: "SessionsGetEventFilePathResult", "SessionsGetLastForContextRequest", "SessionsGetLastForContextResult", + "SessionsGetMetadataRequest", + "SessionsGetMetadataResult", "SessionsGetPersistedRemoteSteerableRequest", "SessionsGetPersistedRemoteSteerableResult", + "SessionsListNonEmptySessionIDSRequest", + "SessionsListNonEmptySessionIDSResult", "SessionsListRequest", "SessionsLoadDeferredRepoHooksRequest", "SessionsOpenAttach", @@ -30926,7 +42985,6 @@ async def handle_git_hub_telemetry_event(params: dict) -> None: "SessionsOpenProgressStatus", "SessionsOpenProgressStep", "SessionsOpenRemote", - "SessionsOpenRemoteKind", "SessionsOpenResume", "SessionsOpenResumeKind", "SessionsOpenResumeLast", @@ -30946,14 +43004,23 @@ async def handle_git_hub_telemetry_event(params: dict) -> None: "SessionsStartRemoteControlRequest", "SessionsStopRemoteControlRequest", "SessionsTransferRemoteControlRequest", + "SettableAuthInfo", + "SettableAuthInfoType", + "SettableTokenAuthInfo", + "SettableTokenAuthInfoType", "ShellApi", "ShellCancelUserRequestedRequest", + "ShellCredentials", "ShellExecRequest", "ShellExecResult", "ShellExecuteUserRequestedRequest", + "ShellInitProfile", + "ShellInitScript", + "ShellInitScriptShell", "ShellKillRequest", "ShellKillResult", "ShellKillSignal", + "ShellOptions", "ShutdownRequest", "Skill", "SkillDiscoveryPath", @@ -30962,6 +43029,7 @@ async def handle_git_hub_telemetry_event(params: dict) -> None: "SkillList", "SkillsApi", "SkillsConfigSetDisabledSkillsRequest", + "SkillsConfigSetSkillDisabledRequest", "SkillsDisableRequest", "SkillsDiscoverRequest", "SkillsEnableRequest", @@ -30969,6 +43037,8 @@ async def handle_git_hub_telemetry_event(params: dict) -> None: "SkillsGetInvokedResult", "SkillsInvokedSkill", "SkillsLoadDiagnostics", + "SlashCommandAddTimelineEntryResult", + "SlashCommandAddTimelineEntryResultKind", "SlashCommandAgentPromptResult", "SlashCommandAgentPromptResultKind", "SlashCommandCompletedResult", @@ -30980,17 +43050,28 @@ async def handle_git_hub_telemetry_event(params: dict) -> None: "SlashCommandInvocationResult", "SlashCommandInvocationResultKind", "SlashCommandKind", + "SlashCommandModelPickerDialog", + "SlashCommandModelPickerDialogKind", "SlashCommandSelectSubcommandOption", "SlashCommandSelectSubcommandResult", "SlashCommandSelectSubcommandResultKind", + "SlashCommandSetModelResult", + "SlashCommandSetModelResultKind", + "SlashCommandSetPlanModelResult", + "SlashCommandSetPlanModelResultKind", + "SlashCommandShowDialogResult", + "SlashCommandShowDialogResultKind", "SlashCommandTextResult", - "StickySource", + "SlashCommandTimelineEntry", + "Status", "SubagentSettings", "SubagentSettingsEntry", "SubagentSettingsEntryContextTier", "TaskAgentInfo", "TaskAgentInfoType", "TaskAgentProgress", + "TaskCompleteData", + "TaskCompletionDecision", "TaskExecutionMode", "TaskInfo", "TaskInfoExecutionMode", @@ -31024,17 +43105,29 @@ async def handle_git_hub_telemetry_event(params: dict) -> None: "TasksWaitForPendingResult", "TelemetryApi", "TelemetrySetFeatureOverridesRequest", - "TentacledSource", "Theme", "TokenAuthInfo", - "TokenAuthInfoType", + "TokenProviderAuthInfo", + "TokenProviderAuthInfoType", "Tool", "ToolList", + "ToolResult", + "ToolResultExpanded", + "ToolResultNewMessage", + "ToolResultType", "ToolsApi", + "ToolsExecuteRequest", + "ToolsGetBuiltinDescriptorsRequest", + "ToolsGetBuiltinDescriptorsResult", "ToolsGetCurrentMetadataResult", "ToolsInitializeAndValidateResult", "ToolsListRequest", + "ToolsSetRequest", + "ToolsSetResult", + "ToolsShellDescriptorConfig", + "ToolsTaskCompleteEventDataRequest", "ToolsUpdateSubagentSettingsResult", + "Trigger", "UIAutoModeSwitchResponse", "UIElicitationArrayAnyOfField", "UIElicitationArrayAnyOfFieldItems", @@ -31057,7 +43150,6 @@ async def handle_git_hub_telemetry_event(params: dict) -> None: "UIElicitationSchemaPropertyString", "UIElicitationSchemaPropertyStringFormat", "UIElicitationSchemaPropertyType", - "UIElicitationSchemaType", "UIElicitationStringEnumField", "UIElicitationStringOneOfField", "UIElicitationStringOneOfFieldOneOf", @@ -31082,6 +43174,7 @@ async def handle_git_hub_telemetry_event(params: dict) -> None: "UpdateSubagentSettingsRequest", "UsageApi", "UsageGetMetricsResult", + "UsageMetricsAgentMetric", "UsageMetricsCodeChanges", "UsageMetricsModelMetric", "UsageMetricsModelMetricRequests", @@ -31089,7 +43182,6 @@ async def handle_git_hub_telemetry_event(params: dict) -> None: "UsageMetricsModelMetricUsage", "UsageMetricsTokenDetail", "UserAuthInfo", - "UserAuthInfoType", "UserRequestedShellCommandResult", "UserSettingMetadata", "UserSettingsGetResult", @@ -31106,20 +43198,30 @@ async def handle_git_hub_telemetry_event(params: dict) -> None: "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 fecd5839ed..c22f9f24fc 100644 --- a/python/copilot/generated/session_events.py +++ b/python/copilot/generated/session_events.py @@ -24,8 +24,9 @@ def from_str(x: Any) -> str: def from_int(x: Any) -> int: - assert isinstance(x, int) and not isinstance(x, bool) - return x + assert isinstance(x, (int, float)) and not isinstance(x, bool) + assert not isinstance(x, float) or x.is_integer() + return int(x) def to_int(x: Any) -> int: @@ -137,6 +138,7 @@ class SessionEventType(Enum): SESSION_MODEL_CHANGE = "session.model_change" SESSION_MODE_CHANGED = "session.mode_changed" SESSION_SESSION_LIMITS_CHANGED = "session.session_limits_changed" + # Experimental: this event is part of an experimental API and may change or be removed. SESSION_PERMISSIONS_CHANGED = "session.permissions_changed" SESSION_PLAN_CHANGED = "session.plan_changed" SESSION_TODOS_CHANGED = "session.todos_changed" @@ -148,14 +150,30 @@ class SessionEventType(Enum): 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" + # Experimental: this event is part of an experimental API and may change or be removed. + SESSION_FUSION_ROUTE_STARTED = "session.fusion_route_started" + # Experimental: this event is part of an experimental API and may change or be removed. + SESSION_FUSION_ROUTE_FAILED = "session.fusion_route_failed" + # Experimental: this event is part of an experimental API and may change or be removed. + SESSION_FUSION_RESOLVED = "session.fusion_resolved" + # Experimental: this event is part of an experimental API and may change or be removed. + SESSION_FUSION_COMPLETED = "session.fusion_completed" USER_MESSAGE = "user.message" PENDING_MESSAGES_MODIFIED = "pending_messages.modified" ASSISTANT_TURN_START = "assistant.turn_start" ASSISTANT_TURN_RETRY = "assistant.turn_retry" + AGENT_INTERRUPTED = "agent.interrupted" ASSISTANT_INTENT = "assistant.intent" + # Experimental: this event is part of an experimental API and may change or be removed. + ASSISTANT_FUSION_PHASE_STARTED = "assistant.fusion_phase_started" + # Experimental: this event is part of an experimental API and may change or be removed. + ASSISTANT_FUSION_PHASE_COMPLETED = "assistant.fusion_phase_completed" + # Experimental: this event is part of an experimental API and may change or be removed. + ASSISTANT_FUSION_PHASE_FAILED = "assistant.fusion_phase_failed" ASSISTANT_SERVER_TOOL_PROGRESS = "assistant.server_tool_progress" ASSISTANT_REASONING = "assistant.reasoning" ASSISTANT_REASONING_DELTA = "assistant.reasoning_delta" @@ -167,7 +185,9 @@ class SessionEventType(Enum): ASSISTANT_TURN_END = "assistant.turn_end" ASSISTANT_IDLE = "assistant.idle" ASSISTANT_USAGE = "assistant.usage" + PROMPT_CACHE_BREAK = "prompt_cache_break" MODEL_CALL_FAILURE = "model.call_failure" + MODEL_CALL_FINISHED = "model.call_finished" MODEL_CALL_START = "model.call_start" ABORT = "abort" TOOL_USER_REQUESTED = "tool.user_requested" @@ -177,7 +197,9 @@ class SessionEventType(Enum): TOOL_EXECUTION_COMPLETE = "tool.execution_complete" TOOL_SEARCH_ACTIVATED = "tool_search.activated" SKILL_INVOKED = "skill.invoked" + SANDBOX_DECISION = "sandbox.decision" SUBAGENT_STARTED = "subagent.started" + SUBAGENT_CONFIGURED = "subagent.configured" SUBAGENT_COMPLETED = "subagent.completed" SUBAGENT_FAILED = "subagent.failed" SUBAGENT_SELECTED = "subagent.selected" @@ -202,6 +224,8 @@ class SessionEventType(Enum): MCP_HEADERS_REFRESH_REQUIRED = "mcp.headers_refresh_required" MCP_HEADERS_REFRESH_COMPLETED = "mcp.headers_refresh_completed" SESSION_CUSTOM_NOTIFICATION = "session.custom_notification" + # Experimental: this event is part of an experimental API and may change or be removed. + UI_EPHEMERAL_QUERY = "ui.ephemeral_query" EXTERNAL_TOOL_REQUESTED = "external_tool.requested" EXTERNAL_TOOL_COMPLETED = "external_tool.completed" COMMAND_QUEUED = "command.queued" @@ -223,6 +247,12 @@ class SessionEventType(Enum): 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" + # Experimental: this event is part of an experimental API and may change or be removed. + FACTORY_RUN_STARTED = "factory.run_started" + # Experimental: this event is part of an experimental API and may change or be removed. + FACTORY_RUN_SETTLED = "factory.run_settled" SESSION_SKILLS_LOADED = "session.skills_loaded" SESSION_CUSTOM_AGENTS_UPDATED = "session.custom_agents_updated" SESSION_MCP_SERVERS_LOADED = "session.mcp_servers_loaded" @@ -367,6 +397,219 @@ def to_dict(self) -> dict: return result +# Experimental: this type is part of an experimental API and may change or be removed. +@dataclass +class AssistantFusionPhaseCompletedData: + "Experimental durable HydraFusion phase output and lossless replay checkpoint." + content: str + conversation_scope: FusionConversationScope + duration_ms: float + fusion_id: str + model: str + phase_id: str + phase_kind: FusionPhaseKind + role: str + status: FusionPhaseStatus + usage: FusionPhaseUsage + verdict: str | None + # Internal: this field is an internal SDK API and is not part of the public surface. + _projection_message: Any = None + # Internal: this field is an internal SDK API and is not part of the public surface. + _projection_mode: _FusionProjectionMode | None = None + # Internal: this field is an internal SDK API and is not part of the public surface. + _staged_terminal: _FusionStagedTerminal | None = None + + @staticmethod + def from_dict(obj: Any) -> "AssistantFusionPhaseCompletedData": + assert isinstance(obj, dict) + content = from_str(obj.get("content")) + conversation_scope = parse_enum(FusionConversationScope, obj.get("conversationScope")) + duration_ms = from_float(obj.get("durationMs")) + fusion_id = from_str(obj.get("fusionId")) + model = from_str(obj.get("model")) + phase_id = from_str(obj.get("phaseId")) + phase_kind = parse_enum(FusionPhaseKind, obj.get("phaseKind")) + role = from_str(obj.get("role")) + status = parse_enum(FusionPhaseStatus, obj.get("status")) + usage = FusionPhaseUsage.from_dict(obj.get("usage")) + verdict = from_union([from_none, from_str], obj.get("verdict")) + _projection_message = obj.get("projectionMessage") + _projection_mode = from_union([from_none, lambda x: parse_enum(_FusionProjectionMode, x)], obj.get("projectionMode")) + _staged_terminal = from_union([from_none, _FusionStagedTerminal.from_dict], obj.get("stagedTerminal")) + return AssistantFusionPhaseCompletedData( + content=content, + conversation_scope=conversation_scope, + duration_ms=duration_ms, + fusion_id=fusion_id, + model=model, + phase_id=phase_id, + phase_kind=phase_kind, + role=role, + status=status, + usage=usage, + verdict=verdict, + _projection_message=_projection_message, + _projection_mode=_projection_mode, + _staged_terminal=_staged_terminal, + ) + + def to_dict(self) -> dict: + result: dict = {} + result["content"] = from_str(self.content) + result["conversationScope"] = to_enum(FusionConversationScope, self.conversation_scope) + result["durationMs"] = to_float(self.duration_ms) + result["fusionId"] = from_str(self.fusion_id) + result["model"] = from_str(self.model) + result["phaseId"] = from_str(self.phase_id) + result["phaseKind"] = to_enum(FusionPhaseKind, self.phase_kind) + result["role"] = from_str(self.role) + result["status"] = to_enum(FusionPhaseStatus, self.status) + result["usage"] = to_class(FusionPhaseUsage, self.usage) + result["verdict"] = from_union([from_none, from_str], self.verdict) + if self._projection_message is not None: + result["projectionMessage"] = self._projection_message + if self._projection_mode is not None: + result["projectionMode"] = from_union([from_none, lambda x: to_enum(_FusionProjectionMode, x)], self._projection_mode) + if self._staged_terminal is not None: + result["stagedTerminal"] = from_union([from_none, lambda x: to_class(_FusionStagedTerminal, x)], self._staged_terminal) + return result + + +# Experimental: this type is part of an experimental API and may change or be removed. +@dataclass +class AssistantFusionPhaseFailedData: + "Experimental durable typed HydraFusion phase failure and degradation transition." + conversation_scope: FusionConversationScope + duration_ms: float + fusion_id: str + model: str + phase_id: str + phase_kind: FusionPhaseKind + reason: str + role: str + status: FusionPhaseStatus + usage: FusionPhaseUsage + degraded_to_phase_id: str | None = None + error_message: str | None = None + + @staticmethod + def from_dict(obj: Any) -> "AssistantFusionPhaseFailedData": + assert isinstance(obj, dict) + conversation_scope = parse_enum(FusionConversationScope, obj.get("conversationScope")) + duration_ms = from_float(obj.get("durationMs")) + fusion_id = from_str(obj.get("fusionId")) + model = from_str(obj.get("model")) + phase_id = from_str(obj.get("phaseId")) + phase_kind = parse_enum(FusionPhaseKind, obj.get("phaseKind")) + reason = from_str(obj.get("reason")) + role = from_str(obj.get("role")) + status = parse_enum(FusionPhaseStatus, obj.get("status")) + usage = FusionPhaseUsage.from_dict(obj.get("usage")) + degraded_to_phase_id = from_union([from_none, from_str], obj.get("degradedToPhaseId")) + error_message = from_union([from_none, from_str], obj.get("errorMessage")) + return AssistantFusionPhaseFailedData( + conversation_scope=conversation_scope, + duration_ms=duration_ms, + fusion_id=fusion_id, + model=model, + phase_id=phase_id, + phase_kind=phase_kind, + reason=reason, + role=role, + status=status, + usage=usage, + degraded_to_phase_id=degraded_to_phase_id, + error_message=error_message, + ) + + def to_dict(self) -> dict: + result: dict = {} + result["conversationScope"] = to_enum(FusionConversationScope, self.conversation_scope) + result["durationMs"] = to_float(self.duration_ms) + result["fusionId"] = from_str(self.fusion_id) + result["model"] = from_str(self.model) + result["phaseId"] = from_str(self.phase_id) + result["phaseKind"] = to_enum(FusionPhaseKind, self.phase_kind) + result["reason"] = from_str(self.reason) + result["role"] = from_str(self.role) + result["status"] = to_enum(FusionPhaseStatus, self.status) + result["usage"] = to_class(FusionPhaseUsage, self.usage) + if self.degraded_to_phase_id is not None: + result["degradedToPhaseId"] = from_union([from_none, from_str], self.degraded_to_phase_id) + if self.error_message is not None: + result["errorMessage"] = from_union([from_none, from_str], self.error_message) + return result + + +# Experimental: this type is part of an experimental API and may change or be removed. +@dataclass +class AssistantFusionPhaseStartedData: + "Experimental transient HydraFusion phase/model/role signal." + conversation_scope: FusionConversationScope + fusion_id: str + model: str + pattern: FusionPattern + phase_id: str + phase_kind: FusionPhaseKind + role: str + + @staticmethod + def from_dict(obj: Any) -> "AssistantFusionPhaseStartedData": + assert isinstance(obj, dict) + conversation_scope = parse_enum(FusionConversationScope, obj.get("conversationScope")) + fusion_id = from_str(obj.get("fusionId")) + model = from_str(obj.get("model")) + pattern = parse_enum(FusionPattern, obj.get("pattern")) + phase_id = from_str(obj.get("phaseId")) + phase_kind = parse_enum(FusionPhaseKind, obj.get("phaseKind")) + role = from_str(obj.get("role")) + return AssistantFusionPhaseStartedData( + conversation_scope=conversation_scope, + fusion_id=fusion_id, + model=model, + pattern=pattern, + phase_id=phase_id, + phase_kind=phase_kind, + role=role, + ) + + def to_dict(self) -> dict: + result: dict = {} + result["conversationScope"] = to_enum(FusionConversationScope, self.conversation_scope) + result["fusionId"] = from_str(self.fusion_id) + result["model"] = from_str(self.model) + result["pattern"] = to_enum(FusionPattern, self.pattern) + result["phaseId"] = from_str(self.phase_id) + result["phaseKind"] = to_enum(FusionPhaseKind, self.phase_kind) + result["role"] = from_str(self.role) + return result + + +# Experimental: this type is part of an experimental API and may change or be removed. +@dataclass +class AssistantMessageReasoningBlocks: + "Neutral provider-tagged reasoning content blocks preserved verbatim for round-tripping" + provider: str + blocks: list[Any] | None = None + + @staticmethod + def from_dict(obj: Any) -> "AssistantMessageReasoningBlocks": + assert isinstance(obj, dict) + provider = from_str(obj.get("provider")) + blocks = from_union([from_none, lambda x: from_list(lambda x: x, x)], obj.get("blocks")) + return AssistantMessageReasoningBlocks( + provider=provider, + blocks=blocks, + ) + + def to_dict(self) -> dict: + result: dict = {} + result["provider"] = from_str(self.provider) + if self.blocks is not None: + result["blocks"] = from_union([from_none, lambda x: from_list(lambda x: x, x)], self.blocks) + return result + + # Experimental: this type is part of an experimental API and may change or be removed. @dataclass class AssistantMessageServerTools: @@ -774,6 +1017,299 @@ def to_dict(self) -> dict: return result +# Experimental: this type is part of an experimental API and may change or be removed. +@dataclass +class FactoryRunSettledData: + "Ephemeral signal that a factory run reached a terminal status." + consumed_nano_aiu: int + consumed_subagents: int + elapsed_ms: int + run_id: str + status: FactoryRunSettledStatus + failure_type: str | None = None + + @staticmethod + def from_dict(obj: Any) -> "FactoryRunSettledData": + assert isinstance(obj, dict) + consumed_nano_aiu = from_int(obj.get("consumedNanoAiu")) + consumed_subagents = from_int(obj.get("consumedSubagents")) + elapsed_ms = from_int(obj.get("elapsedMs")) + run_id = from_str(obj.get("runId")) + status = parse_enum(FactoryRunSettledStatus, obj.get("status")) + failure_type = from_union([from_none, from_str], obj.get("failureType")) + return FactoryRunSettledData( + consumed_nano_aiu=consumed_nano_aiu, + consumed_subagents=consumed_subagents, + elapsed_ms=elapsed_ms, + run_id=run_id, + status=status, + failure_type=failure_type, + ) + + def to_dict(self) -> dict: + result: dict = {} + result["consumedNanoAiu"] = to_int(self.consumed_nano_aiu) + result["consumedSubagents"] = to_int(self.consumed_subagents) + result["elapsedMs"] = to_int(self.elapsed_ms) + result["runId"] = from_str(self.run_id) + result["status"] = to_enum(FactoryRunSettledStatus, self.status) + if self.failure_type is not None: + result["failureType"] = from_union([from_none, from_str], self.failure_type) + return result + + +# Experimental: this type is part of an experimental API and may change or be removed. +@dataclass +class FactoryRunStartedData: + "Ephemeral signal that a factory run attempt began executing." + attempt: int + factory_name: str + run_id: str + + @staticmethod + def from_dict(obj: Any) -> "FactoryRunStartedData": + assert isinstance(obj, dict) + attempt = from_int(obj.get("attempt")) + factory_name = from_str(obj.get("factoryName")) + run_id = from_str(obj.get("runId")) + return FactoryRunStartedData( + attempt=attempt, + factory_name=factory_name, + run_id=run_id, + ) + + def to_dict(self) -> dict: + result: dict = {} + result["attempt"] = to_int(self.attempt) + result["factoryName"] = from_str(self.factory_name) + 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 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 FusionAttribution: + "Experimental attribution linking an ordinary event to the HydraFusion turn, phase, and concrete source that produced it." + fusion_id: str + pattern: str + policy: str + synthetic_model: str + commit_id: str | None = None + conversation_scope: str | None = None + phase_id: str | None = None + phase_kind: str | None = None + role: str | None = None + source_model: str | None = None + source_phase_id: str | None = None + + @staticmethod + def from_dict(obj: Any) -> "FusionAttribution": + assert isinstance(obj, dict) + fusion_id = from_str(obj.get("fusionId")) + pattern = from_str(obj.get("pattern")) + policy = from_str(obj.get("policy")) + synthetic_model = from_str(obj.get("syntheticModel")) + commit_id = from_union([from_none, from_str], obj.get("commitId")) + conversation_scope = from_union([from_none, from_str], obj.get("conversationScope")) + phase_id = from_union([from_none, from_str], obj.get("phaseId")) + phase_kind = from_union([from_none, from_str], obj.get("phaseKind")) + role = from_union([from_none, from_str], obj.get("role")) + source_model = from_union([from_none, from_str], obj.get("sourceModel")) + source_phase_id = from_union([from_none, from_str], obj.get("sourcePhaseId")) + return FusionAttribution( + fusion_id=fusion_id, + pattern=pattern, + policy=policy, + synthetic_model=synthetic_model, + commit_id=commit_id, + conversation_scope=conversation_scope, + phase_id=phase_id, + phase_kind=phase_kind, + role=role, + source_model=source_model, + source_phase_id=source_phase_id, + ) + + def to_dict(self) -> dict: + result: dict = {} + result["fusionId"] = from_str(self.fusion_id) + result["pattern"] = from_str(self.pattern) + result["policy"] = from_str(self.policy) + result["syntheticModel"] = from_str(self.synthetic_model) + if self.commit_id is not None: + result["commitId"] = from_union([from_none, from_str], self.commit_id) + if self.conversation_scope is not None: + result["conversationScope"] = from_union([from_none, from_str], self.conversation_scope) + if self.phase_id is not None: + result["phaseId"] = from_union([from_none, from_str], self.phase_id) + if self.phase_kind is not None: + result["phaseKind"] = from_union([from_none, from_str], self.phase_kind) + if self.role is not None: + result["role"] = from_union([from_none, from_str], self.role) + if self.source_model is not None: + result["sourceModel"] = from_union([from_none, from_str], self.source_model) + if self.source_phase_id is not None: + result["sourcePhaseId"] = from_union([from_none, from_str], self.source_phase_id) + return result + + +# Experimental: this type is part of an experimental API and may change or be removed. +@dataclass +class FusionFollowUpRecommendation: + "Durable server recommendation for subsequent HydraFusion turns." + compaction_turn: FusionFollowUpAction + user_turn: FusionFollowUpAction + + @staticmethod + def from_dict(obj: Any) -> "FusionFollowUpRecommendation": + assert isinstance(obj, dict) + compaction_turn = parse_enum(FusionFollowUpAction, obj.get("compactionTurn")) + user_turn = parse_enum(FusionFollowUpAction, obj.get("userTurn")) + return FusionFollowUpRecommendation( + compaction_turn=compaction_turn, + user_turn=user_turn, + ) + + def to_dict(self) -> dict: + result: dict = {} + result["compactionTurn"] = to_enum(FusionFollowUpAction, self.compaction_turn) + result["userTurn"] = to_enum(FusionFollowUpAction, self.user_turn) + return result + + +# Experimental: this type is part of an experimental API and may change or be removed. +@dataclass +class FusionPhaseUsage: + "Aggregate concrete-model usage for one HydraFusion phase." + cached_tokens: int + input_tokens: int + output_tokens: int + request_count: int + total_nano_aiu: float + cache_write_tokens: int | None = None + + @staticmethod + def from_dict(obj: Any) -> "FusionPhaseUsage": + assert isinstance(obj, dict) + cached_tokens = from_int(obj.get("cachedTokens")) + input_tokens = from_int(obj.get("inputTokens")) + output_tokens = from_int(obj.get("outputTokens")) + request_count = from_int(obj.get("requestCount")) + total_nano_aiu = from_float(obj.get("totalNanoAiu")) + cache_write_tokens = from_union([from_none, from_int], obj.get("cacheWriteTokens")) + return FusionPhaseUsage( + cached_tokens=cached_tokens, + input_tokens=input_tokens, + output_tokens=output_tokens, + request_count=request_count, + total_nano_aiu=total_nano_aiu, + cache_write_tokens=cache_write_tokens, + ) + + def to_dict(self) -> dict: + result: dict = {} + result["cachedTokens"] = to_int(self.cached_tokens) + result["inputTokens"] = to_int(self.input_tokens) + result["outputTokens"] = to_int(self.output_tokens) + result["requestCount"] = to_int(self.request_count) + result["totalNanoAiu"] = to_float(self.total_nano_aiu) + if self.cache_write_tokens is not None: + result["cacheWriteTokens"] = from_union([from_none, to_int], self.cache_write_tokens) + return result + + +# Experimental: this type is part of an experimental API and may change or be removed. +@dataclass +class FusionScores: + "Validated HydraFusion routing capability scores." + code_gen: float + debugging: float + reasoning: float + tool_use: float + + @staticmethod + def from_dict(obj: Any) -> "FusionScores": + assert isinstance(obj, dict) + code_gen = from_float(obj.get("codeGen")) + debugging = from_float(obj.get("debugging")) + reasoning = from_float(obj.get("reasoning")) + tool_use = from_float(obj.get("toolUse")) + return FusionScores( + code_gen=code_gen, + debugging=debugging, + reasoning=reasoning, + tool_use=tool_use, + ) + + def to_dict(self) -> dict: + result: dict = {} + result["codeGen"] = to_float(self.code_gen) + result["debugging"] = to_float(self.debugging) + result["reasoning"] = to_float(self.reasoning) + result["toolUse"] = to_float(self.tool_use) + return result + + +# Experimental: this type is part of an experimental API and may change or be removed. +@dataclass +class _FusionStagedTerminal: + "Internal durable terminal request staged by a HydraFusion phase until an idempotent final commit selects it." + arguments: str + assistant_message: Any + phase_id: str + tool_call_id: str + tool_name: str + + @staticmethod + def from_dict(obj: Any) -> "_FusionStagedTerminal": + assert isinstance(obj, dict) + arguments = from_str(obj.get("arguments")) + assistant_message = obj.get("assistantMessage") + phase_id = from_str(obj.get("phaseId")) + tool_call_id = from_str(obj.get("toolCallId")) + tool_name = from_str(obj.get("toolName")) + return _FusionStagedTerminal( + arguments=arguments, + assistant_message=assistant_message, + phase_id=phase_id, + tool_call_id=tool_call_id, + tool_name=tool_name, + ) + + def to_dict(self) -> dict: + result: dict = {} + result["arguments"] = from_str(self.arguments) + result["assistantMessage"] = self.assistant_message + result["phaseId"] = from_str(self.phase_id) + result["toolCallId"] = from_str(self.tool_call_id) + 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 OmittedBinaryResult: @@ -818,24 +1354,34 @@ def to_dict(self) -> dict: # 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 +class PermissionAssistedApproval: + "Assisted-approval judge information attached to a permission request. Present only in assisted mode; its absence means the judge did not evaluate the request. The `recommendation` conveys the judge's disposition for this request." + recommendation: AssistedApprovalRecommendation + failure_reason: AssistedApprovalJudgeFailureReason | None = None + model: str | None = None reason: str | None = None @staticmethod - def from_dict(obj: Any) -> "PermissionAutoApproval": + def from_dict(obj: Any) -> "PermissionAssistedApproval": assert isinstance(obj, dict) - recommendation = parse_enum(AutoApprovalRecommendation, obj.get("recommendation")) + recommendation = parse_enum(AssistedApprovalRecommendation, obj.get("recommendation")) + failure_reason = from_union([from_none, lambda x: parse_enum(AssistedApprovalJudgeFailureReason, 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( + return PermissionAssistedApproval( recommendation=recommendation, + failure_reason=failure_reason, + model=model, reason=reason, ) def to_dict(self) -> dict: result: dict = {} - result["recommendation"] = to_enum(AutoApprovalRecommendation, self.recommendation) + result["recommendation"] = to_enum(AssistedApprovalRecommendation, self.recommendation) + if self.failure_reason is not None: + result["failureReason"] = from_union([from_none, lambda x: to_enum(AssistedApprovalJudgeFailureReason, 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 @@ -846,43 +1392,88 @@ def to_dict(self) -> dict: 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 @@ -1086,6 +1677,281 @@ def to_dict(self) -> dict: return result +# Experimental: this type is part of an experimental API and may change or be removed. +@dataclass +class SessionFusionCompletedData: + "Experimental durable aggregate outcome of a HydraFusion turn." + cached_tokens: int + commit_id: str + degraded_reason: str | None + duration_ms: float + final_source_model: str | None + final_source_phase_id: str | None + follow_up_model: str + fusion_id: str + input_tokens: int + outcome: str + output_tokens: int + pattern: FusionPattern + phase_count: int + request_count: int + synthetic_model: str + total_nano_aiu: float + turn_id: str + cache_write_tokens: int | None = None + + @staticmethod + def from_dict(obj: Any) -> "SessionFusionCompletedData": + assert isinstance(obj, dict) + cached_tokens = from_int(obj.get("cachedTokens")) + commit_id = from_str(obj.get("commitId")) + degraded_reason = from_union([from_none, from_str], obj.get("degradedReason")) + duration_ms = from_float(obj.get("durationMs")) + final_source_model = from_union([from_none, from_str], obj.get("finalSourceModel")) + final_source_phase_id = from_union([from_none, from_str], obj.get("finalSourcePhaseId")) + follow_up_model = from_str(obj.get("followUpModel")) + fusion_id = from_str(obj.get("fusionId")) + input_tokens = from_int(obj.get("inputTokens")) + outcome = from_str(obj.get("outcome")) + output_tokens = from_int(obj.get("outputTokens")) + pattern = parse_enum(FusionPattern, obj.get("pattern")) + phase_count = from_int(obj.get("phaseCount")) + request_count = from_int(obj.get("requestCount")) + synthetic_model = from_str(obj.get("syntheticModel")) + total_nano_aiu = from_float(obj.get("totalNanoAiu")) + turn_id = from_str(obj.get("turnId")) + cache_write_tokens = from_union([from_none, from_int], obj.get("cacheWriteTokens")) + return SessionFusionCompletedData( + cached_tokens=cached_tokens, + commit_id=commit_id, + degraded_reason=degraded_reason, + duration_ms=duration_ms, + final_source_model=final_source_model, + final_source_phase_id=final_source_phase_id, + follow_up_model=follow_up_model, + fusion_id=fusion_id, + input_tokens=input_tokens, + outcome=outcome, + output_tokens=output_tokens, + pattern=pattern, + phase_count=phase_count, + request_count=request_count, + synthetic_model=synthetic_model, + total_nano_aiu=total_nano_aiu, + turn_id=turn_id, + cache_write_tokens=cache_write_tokens, + ) + + def to_dict(self) -> dict: + result: dict = {} + result["cachedTokens"] = to_int(self.cached_tokens) + result["commitId"] = from_str(self.commit_id) + result["degradedReason"] = from_union([from_none, from_str], self.degraded_reason) + result["durationMs"] = to_float(self.duration_ms) + result["finalSourceModel"] = from_union([from_none, from_str], self.final_source_model) + result["finalSourcePhaseId"] = from_union([from_none, from_str], self.final_source_phase_id) + result["followUpModel"] = from_str(self.follow_up_model) + result["fusionId"] = from_str(self.fusion_id) + result["inputTokens"] = to_int(self.input_tokens) + result["outcome"] = from_str(self.outcome) + result["outputTokens"] = to_int(self.output_tokens) + result["pattern"] = to_enum(FusionPattern, self.pattern) + result["phaseCount"] = to_int(self.phase_count) + result["requestCount"] = to_int(self.request_count) + result["syntheticModel"] = from_str(self.synthetic_model) + result["totalNanoAiu"] = to_float(self.total_nano_aiu) + result["turnId"] = from_str(self.turn_id) + if self.cache_write_tokens is not None: + result["cacheWriteTokens"] = from_union([from_none, to_int], self.cache_write_tokens) + return result + + +# Experimental: this type is part of an experimental API and may change or be removed. +@dataclass +class SessionFusionResolvedData: + "Experimental durable validated HydraFusion route and turn policy." + contract_version: int + fallback_model: str + follow_up_model: str + fusion_id: str + pattern: FusionPattern + policy: str + primary_model: str + secondary_model: str | None + synthetic_model: str + turn_id: str + follow_up: FusionFollowUpRecommendation | None = None + model_universe_version: str | None = None + plan_version: str | None = None + policy_version: str | None = None + route_source: str | None = None + routing_latency_ms: float | None = None + rule_id: str | None = None + rule_index: int | None = None + rule_name: str | None = None + scores: FusionScores | None = None + + @staticmethod + def from_dict(obj: Any) -> "SessionFusionResolvedData": + assert isinstance(obj, dict) + contract_version = from_int(obj.get("contractVersion")) + fallback_model = from_str(obj.get("fallbackModel")) + follow_up_model = from_str(obj.get("followUpModel")) + fusion_id = from_str(obj.get("fusionId")) + pattern = parse_enum(FusionPattern, obj.get("pattern")) + policy = from_str(obj.get("policy")) + primary_model = from_str(obj.get("primaryModel")) + secondary_model = from_union([from_none, from_str], obj.get("secondaryModel")) + synthetic_model = from_str(obj.get("syntheticModel")) + turn_id = from_str(obj.get("turnId")) + follow_up = from_union([from_none, FusionFollowUpRecommendation.from_dict], obj.get("followUp")) + model_universe_version = from_union([from_none, from_str], obj.get("modelUniverseVersion")) + plan_version = from_union([from_none, from_str], obj.get("planVersion")) + policy_version = from_union([from_none, from_str], obj.get("policyVersion")) + route_source = from_union([from_none, from_str], obj.get("routeSource")) + routing_latency_ms = from_union([from_none, from_float], obj.get("routingLatencyMs")) + rule_id = from_union([from_none, from_str], obj.get("ruleId")) + rule_index = from_union([from_none, from_int], obj.get("ruleIndex")) + rule_name = from_union([from_none, from_str], obj.get("ruleName")) + scores = from_union([from_none, FusionScores.from_dict], obj.get("scores")) + return SessionFusionResolvedData( + contract_version=contract_version, + fallback_model=fallback_model, + follow_up_model=follow_up_model, + fusion_id=fusion_id, + pattern=pattern, + policy=policy, + primary_model=primary_model, + secondary_model=secondary_model, + synthetic_model=synthetic_model, + turn_id=turn_id, + follow_up=follow_up, + model_universe_version=model_universe_version, + plan_version=plan_version, + policy_version=policy_version, + route_source=route_source, + routing_latency_ms=routing_latency_ms, + rule_id=rule_id, + rule_index=rule_index, + rule_name=rule_name, + scores=scores, + ) + + def to_dict(self) -> dict: + result: dict = {} + result["contractVersion"] = to_int(self.contract_version) + result["fallbackModel"] = from_str(self.fallback_model) + result["followUpModel"] = from_str(self.follow_up_model) + result["fusionId"] = from_str(self.fusion_id) + result["pattern"] = to_enum(FusionPattern, self.pattern) + result["policy"] = from_str(self.policy) + result["primaryModel"] = from_str(self.primary_model) + result["secondaryModel"] = from_union([from_none, from_str], self.secondary_model) + result["syntheticModel"] = from_str(self.synthetic_model) + result["turnId"] = from_str(self.turn_id) + if self.follow_up is not None: + result["followUp"] = from_union([from_none, lambda x: to_class(FusionFollowUpRecommendation, x)], self.follow_up) + if self.model_universe_version is not None: + result["modelUniverseVersion"] = from_union([from_none, from_str], self.model_universe_version) + if self.plan_version is not None: + result["planVersion"] = from_union([from_none, from_str], self.plan_version) + if self.policy_version is not None: + result["policyVersion"] = from_union([from_none, from_str], self.policy_version) + if self.route_source is not None: + result["routeSource"] = from_union([from_none, from_str], self.route_source) + if self.routing_latency_ms is not None: + result["routingLatencyMs"] = from_union([from_none, to_float], self.routing_latency_ms) + if self.rule_id is not None: + result["ruleId"] = from_union([from_none, from_str], self.rule_id) + if self.rule_index is not None: + result["ruleIndex"] = from_union([from_none, to_int], self.rule_index) + if self.rule_name is not None: + result["ruleName"] = from_union([from_none, from_str], self.rule_name) + if self.scores is not None: + result["scores"] = from_union([from_none, lambda x: to_class(FusionScores, x)], self.scores) + return result + + +# Experimental: this type is part of an experimental API and may change or be removed. +@dataclass +class SessionFusionRouteFailedData: + "Experimental durable HydraFusion routing failure and the deterministic concrete fallback selected for the turn." + attempt_id: str + fallback_model: str + policy: str + reason: str + synthetic_model: str + error_message: str | None = None + routing_latency_ms: float | None = None + + @staticmethod + def from_dict(obj: Any) -> "SessionFusionRouteFailedData": + assert isinstance(obj, dict) + attempt_id = from_str(obj.get("attemptId")) + fallback_model = from_str(obj.get("fallbackModel")) + policy = from_str(obj.get("policy")) + reason = from_str(obj.get("reason")) + synthetic_model = from_str(obj.get("syntheticModel")) + error_message = from_union([from_none, from_str], obj.get("errorMessage")) + routing_latency_ms = from_union([from_none, from_float], obj.get("routingLatencyMs")) + return SessionFusionRouteFailedData( + attempt_id=attempt_id, + fallback_model=fallback_model, + policy=policy, + reason=reason, + synthetic_model=synthetic_model, + error_message=error_message, + routing_latency_ms=routing_latency_ms, + ) + + def to_dict(self) -> dict: + result: dict = {} + result["attemptId"] = from_str(self.attempt_id) + result["fallbackModel"] = from_str(self.fallback_model) + result["policy"] = from_str(self.policy) + result["reason"] = from_str(self.reason) + result["syntheticModel"] = from_str(self.synthetic_model) + if self.error_message is not None: + result["errorMessage"] = from_union([from_none, from_str], self.error_message) + if self.routing_latency_ms is not None: + result["routingLatencyMs"] = from_union([from_none, to_float], self.routing_latency_ms) + return result + + +# Experimental: this type is part of an experimental API and may change or be removed. +@dataclass +class SessionFusionRouteStartedData: + "Experimental transient signal that HydraFusion routing has started for an eligible turn." + attempt_id: str + turn_kind: FusionTurnKind + policy: str | None = None + synthetic_model: str | None = None + + @staticmethod + def from_dict(obj: Any) -> "SessionFusionRouteStartedData": + assert isinstance(obj, dict) + attempt_id = from_str(obj.get("attemptId")) + turn_kind = parse_enum(FusionTurnKind, obj.get("turnKind")) + policy = from_union([from_none, from_str], obj.get("policy")) + synthetic_model = from_union([from_none, from_str], obj.get("syntheticModel")) + return SessionFusionRouteStartedData( + attempt_id=attempt_id, + turn_kind=turn_kind, + policy=policy, + synthetic_model=synthetic_model, + ) + + def to_dict(self) -> dict: + result: dict = {} + result["attemptId"] = from_str(self.attempt_id) + result["turnKind"] = to_enum(FusionTurnKind, self.turn_kind) + if self.policy is not None: + result["policy"] = from_union([from_none, from_str], self.policy) + if self.synthetic_model is not None: + result["syntheticModel"] = from_union([from_none, from_str], self.synthetic_model) + return result + + # Experimental: this type is part of an experimental API and may change or be removed. @dataclass class SessionManagedSettingsEnforcedData: @@ -1126,13 +1992,16 @@ def to_dict(self) -> dict: # 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 where they came from, so SDK clients can show users what is enterprise-managed and by which authority. 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; for a session-independent pull, use the SDK `getManagedSettings()` API, which returns the identical payload. Managed settings have a single authoritative source, so the highest-authority present layer (server > device) wins wholesale; `bypassPermissionsDisabled` is deny-wins across layers. Marked experimental while the managed-settings surface stabilizes." + "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 + sandbox_enabled_by_undetermined_policy: bool | None = None settings: Any = None @staticmethod @@ -1144,6 +2013,9 @@ def from_dict(obj: Any) -> "SessionManagedSettingsResolvedData": 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")) + sandbox_enabled_by_undetermined_policy = from_union([from_none, from_bool], obj.get("sandboxEnabledByUndeterminedPolicy")) settings = obj.get("settings") return SessionManagedSettingsResolvedData( bypass_permissions_disabled=bypass_permissions_disabled, @@ -1152,6 +2024,9 @@ def from_dict(obj: Any) -> "SessionManagedSettingsResolvedData": managed_keys=managed_keys, server_managed=server_managed, source=source, + client_managed=client_managed, + permissions_allow_intersected=permissions_allow_intersected, + sandbox_enabled_by_undetermined_policy=sandbox_enabled_by_undetermined_policy, settings=settings, ) @@ -1163,11 +2038,88 @@ def to_dict(self) -> dict: 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.sandbox_enabled_by_undetermined_policy is not None: + result["sandboxEnabledByUndeterminedPolicy"] = from_union([from_none, from_bool], self.sandbox_enabled_by_undetermined_policy) if self.settings is not None: result["settings"] = self.settings return result +# Experimental: this type is part of an experimental API and may change or be removed. +@dataclass +class SessionPermissionsChangedData: + "Permission-mode transition details." + # Experimental: this field is part of an experimental API and may change or be removed. + mode: PermissionMode + # Experimental: this field is part of an experimental API and may change or be removed. + previous_mode: PermissionMode + # Experimental: this field is part of an experimental API and may change or be removed. + assisted_approval_model: str | None = None + + @staticmethod + def from_dict(obj: Any) -> "SessionPermissionsChangedData": + assert isinstance(obj, dict) + mode = parse_enum(PermissionMode, obj.get("mode")) + previous_mode = parse_enum(PermissionMode, obj.get("previousMode")) + assisted_approval_model = from_union([from_none, from_str], obj.get("assistedApprovalModel")) + return SessionPermissionsChangedData( + mode=mode, + previous_mode=previous_mode, + assisted_approval_model=assisted_approval_model, + ) + + def to_dict(self) -> dict: + result: dict = {} + result["mode"] = to_enum(PermissionMode, self.mode) + result["previousMode"] = to_enum(PermissionMode, self.previous_mode) + if self.assisted_approval_model is not None: + result["assistedApprovalModel"] = from_union([from_none, from_str], self.assisted_approval_model) + return result + + +# Experimental: this type is part of an experimental API and may change or be removed. +@dataclass +class UiEphemeralQueryData: + "Ordered output and terminal state for a transient query that does not modify conversation history." + phase: UIEphemeralQueryPhase + request_id: str + answer: str | None = None + chunk: str | None = None + error: str | None = None + + @staticmethod + def from_dict(obj: Any) -> "UiEphemeralQueryData": + assert isinstance(obj, dict) + phase = parse_enum(UIEphemeralQueryPhase, obj.get("phase")) + request_id = from_str(obj.get("requestId")) + answer = from_union([from_none, from_str], obj.get("answer")) + chunk = from_union([from_none, from_str], obj.get("chunk")) + error = from_union([from_none, from_str], obj.get("error")) + return UiEphemeralQueryData( + phase=phase, + request_id=request_id, + answer=answer, + chunk=chunk, + error=error, + ) + + def to_dict(self) -> dict: + result: dict = {} + result["phase"] = to_enum(UIEphemeralQueryPhase, self.phase) + 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.chunk is not None: + result["chunk"] = from_union([from_none, from_str], self.chunk) + if self.error is not None: + result["error"] = from_union([from_none, from_str], self.error) + return result + + @dataclass class AbortData: "Turn abort information including the reason for termination" @@ -1187,6 +2139,83 @@ def to_dict(self) -> dict: return result +@dataclass +class AgentInterruptedData: + "Metadata for work the user interrupted while the agent was running" + activity: AgentInterruptedActivity + elapsed: timedelta + turn: int + api_endpoint: str | None = None + cancel_phase: AgentInterruptedCancelPhase | None = None + interrupted_agent_count: int | None = None + model: str | None = None + output_ttft: timedelta | None = None + reasoning_effort: str | None = None + safe_tool_names: list[str] | None = None + tool_call_ids: list[str] | None = None + tool_names: list[str] | None = None + transport: ModelCallFailureTransport | None = None + + @staticmethod + def from_dict(obj: Any) -> "AgentInterruptedData": + assert isinstance(obj, dict) + activity = parse_enum(AgentInterruptedActivity, obj.get("activity")) + elapsed = from_timedelta(obj.get("elapsedMs")) + turn = from_int(obj.get("turn")) + api_endpoint = from_union([from_none, from_str], obj.get("apiEndpoint")) + cancel_phase = from_union([from_none, lambda x: parse_enum(AgentInterruptedCancelPhase, x)], obj.get("cancelPhase")) + interrupted_agent_count = from_union([from_none, from_int], obj.get("interruptedAgentCount")) + model = from_union([from_none, from_str], obj.get("model")) + output_ttft = from_union([from_none, from_timedelta], obj.get("outputTtftMs")) + reasoning_effort = from_union([from_none, from_str], obj.get("reasoningEffort")) + safe_tool_names = from_union([from_none, lambda x: from_list(from_str, x)], obj.get("safeToolNames")) + tool_call_ids = from_union([from_none, lambda x: from_list(from_str, x)], obj.get("toolCallIds")) + tool_names = from_union([from_none, lambda x: from_list(from_str, x)], obj.get("toolNames")) + transport = from_union([from_none, lambda x: parse_enum(ModelCallFailureTransport, x)], obj.get("transport")) + return AgentInterruptedData( + activity=activity, + elapsed=elapsed, + turn=turn, + api_endpoint=api_endpoint, + cancel_phase=cancel_phase, + interrupted_agent_count=interrupted_agent_count, + model=model, + output_ttft=output_ttft, + reasoning_effort=reasoning_effort, + safe_tool_names=safe_tool_names, + tool_call_ids=tool_call_ids, + tool_names=tool_names, + transport=transport, + ) + + def to_dict(self) -> dict: + result: dict = {} + result["activity"] = to_enum(AgentInterruptedActivity, self.activity) + result["elapsedMs"] = to_timedelta(self.elapsed) + result["turn"] = to_int(self.turn) + if self.api_endpoint is not None: + result["apiEndpoint"] = from_union([from_none, from_str], self.api_endpoint) + if self.cancel_phase is not None: + result["cancelPhase"] = from_union([from_none, lambda x: to_enum(AgentInterruptedCancelPhase, x)], self.cancel_phase) + if self.interrupted_agent_count is not None: + result["interruptedAgentCount"] = from_union([from_none, to_int], self.interrupted_agent_count) + if self.model is not None: + result["model"] = from_union([from_none, from_str], self.model) + if self.output_ttft is not None: + result["outputTtftMs"] = from_union([from_none, to_timedelta], self.output_ttft) + if self.reasoning_effort is not None: + result["reasoningEffort"] = from_union([from_none, from_str], self.reasoning_effort) + if self.safe_tool_names is not None: + result["safeToolNames"] = from_union([from_none, lambda x: from_list(from_str, x)], self.safe_tool_names) + if self.tool_call_ids is not None: + result["toolCallIds"] = from_union([from_none, lambda x: from_list(from_str, x)], self.tool_call_ids) + if self.tool_names is not None: + result["toolNames"] = from_union([from_none, lambda x: from_list(from_str, x)], self.tool_names) + if self.transport is not None: + result["transport"] = from_union([from_none, lambda x: to_enum(ModelCallFailureTransport, x)], self.transport) + 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" @@ -1232,20 +2261,26 @@ class AssistantMessageData: 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 + # Experimental: this field is part of an experimental API and may change or be removed. + fusion: FusionAttribution | 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_blocks: AssistantMessageReasoningBlocks | 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 @@ -1257,18 +2292,23 @@ def from_dict(obj: Any) -> "AssistantMessageData": 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")) + fusion = from_union([from_none, FusionAttribution.from_dict], obj.get("fusion")) 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_blocks = from_union([from_none, AssistantMessageReasoningBlocks.from_dict], obj.get("reasoningBlocks")) 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")) @@ -1277,18 +2317,23 @@ def from_dict(obj: Any) -> "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, + fusion=fusion, interaction_id=interaction_id, model=model, output_tokens=output_tokens, parent_tool_call_id=parent_tool_call_id, phase=phase, + reasoning_blocks=reasoning_blocks, 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, @@ -1301,12 +2346,18 @@ def to_dict(self) -> dict: 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.fusion is not None: + result["fusion"] = from_union([from_none, lambda x: to_class(FusionAttribution, x)], self.fusion) if self.interaction_id is not None: result["interactionId"] = from_union([from_none, from_str], self.interaction_id) if self.model is not None: @@ -1317,6 +2368,8 @@ def to_dict(self) -> dict: 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_blocks is not None: + result["reasoningBlocks"] = from_union([from_none, lambda x: to_class(AssistantMessageReasoningBlocks, x)], self.reasoning_blocks) 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: @@ -1325,6 +2378,8 @@ def to_dict(self) -> dict: 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: @@ -1447,21 +2502,26 @@ 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 @@ -1709,10 +2769,17 @@ def to_dict(self) -> dict: class AssistantUsageData: "LLM API call usage metrics including tokens, costs, quotas, and billing information" model: str + accepted_prediction_tokens: int | None = None 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 + # Internal: this field is an internal SDK API and is not part of the public surface. + _cache_details_reported: bool | None = None cache_expires_at: datetime | None = None cache_read_tokens: int | None = None + # Internal: this field is an internal SDK API and is not part of the public surface. + _cache_ttl_seconds: int | None = None cache_write_tokens: int | None = None content_filter_triggered: bool | None = None copilot_usage: AssistantUsageCopilotUsage | None = None @@ -1720,81 +2787,147 @@ class AssistantUsageData: cost: float | None = None duration: timedelta | None = None finish_reason: str | None = None + # Internal: this field is an internal SDK API and is not part of the public surface. + _frontier_source: str | None = None + # Experimental: this field is part of an experimental API and may change or be removed. + fusion: FusionAttribution | None = None initiator: str | None = None input_tokens: int | None = None + interaction_type: str | None = None inter_token_latency: timedelta | None = None + is_auto: bool | None = None + is_byok: bool | None = None + max_output_tokens: int | None = None + max_prompt_tokens: int | 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 + output_ttft: timedelta | 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_summary: ReasoningSummary | None = None reasoning_tokens: int | None = None + rejected_prediction_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 + transport: AssistantUsageTransport | None = None @staticmethod def from_dict(obj: Any) -> "AssistantUsageData": assert isinstance(obj, dict) model = from_str(obj.get("model")) + accepted_prediction_tokens = from_union([from_none, from_int], obj.get("acceptedPredictionTokens")) 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_details_reported = from_union([from_none, from_bool], obj.get("cacheDetailsReported")) 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_ttl_seconds = from_union([from_none, from_int], obj.get("cacheTtlSeconds")) 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")) + _frontier_source = from_union([from_none, from_str], obj.get("frontierSource")) + fusion = from_union([from_none, FusionAttribution.from_dict], obj.get("fusion")) 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")) + 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")) + _num_tool_calls = from_union([from_none, from_int], obj.get("numToolCalls")) output_tokens = from_union([from_none, from_int], obj.get("outputTokens")) + output_ttft = from_union([from_none, from_timedelta], obj.get("outputTtftMs")) 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_summary = from_union([from_none, lambda x: parse_enum(ReasoningSummary, x)], obj.get("reasoningSummary")) reasoning_tokens = from_union([from_none, from_int], obj.get("reasoningTokens")) + rejected_prediction_tokens = from_union([from_none, from_int], obj.get("rejectedPredictionTokens")) + 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")) + transport = from_union([from_none, lambda x: parse_enum(AssistantUsageTransport, x)], obj.get("transport")) return AssistantUsageData( model=model, + accepted_prediction_tokens=accepted_prediction_tokens, api_call_id=api_call_id, api_endpoint=api_endpoint, + _available_tool_count=_available_tool_count, + _cache_details_reported=_cache_details_reported, cache_expires_at=cache_expires_at, cache_read_tokens=cache_read_tokens, + _cache_ttl_seconds=_cache_ttl_seconds, cache_write_tokens=cache_write_tokens, content_filter_triggered=content_filter_triggered, copilot_usage=copilot_usage, cost=cost, duration=duration, finish_reason=finish_reason, + _frontier_source=_frontier_source, + fusion=fusion, initiator=initiator, input_tokens=input_tokens, + interaction_type=interaction_type, inter_token_latency=inter_token_latency, + is_auto=is_auto, + is_byok=is_byok, + max_output_tokens=max_output_tokens, + max_prompt_tokens=max_prompt_tokens, + _num_tool_calls=_num_tool_calls, output_tokens=output_tokens, + output_ttft=output_ttft, parent_tool_call_id=parent_tool_call_id, provider_call_id=provider_call_id, _quota_snapshots=_quota_snapshots, reasoning_effort=reasoning_effort, + reasoning_summary=reasoning_summary, reasoning_tokens=reasoning_tokens, + rejected_prediction_tokens=rejected_prediction_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, + transport=transport, ) def to_dict(self) -> dict: result: dict = {} result["model"] = from_str(self.model) + if self.accepted_prediction_tokens is not None: + result["acceptedPredictionTokens"] = from_union([from_none, to_int], self.accepted_prediction_tokens) 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_details_reported is not None: + result["cacheDetailsReported"] = from_union([from_none, from_bool], self._cache_details_reported) 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_ttl_seconds is not None: + result["cacheTtlSeconds"] = from_union([from_none, to_int], self._cache_ttl_seconds) 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: @@ -1807,14 +2940,32 @@ def to_dict(self) -> dict: 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._frontier_source is not None: + result["frontierSource"] = from_union([from_none, from_str], self._frontier_source) + if self.fusion is not None: + result["fusion"] = from_union([from_none, lambda x: to_class(FusionAttribution, x)], self.fusion) 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.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._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.output_ttft is not None: + result["outputTtftMs"] = from_union([from_none, to_timedelta], self.output_ttft) 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: @@ -1823,12 +2974,24 @@ def to_dict(self) -> dict: 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_summary is not None: + result["reasoningSummary"] = from_union([from_none, lambda x: to_enum(ReasoningSummary, x)], self.reasoning_summary) if self.reasoning_tokens is not None: result["reasoningTokens"] = from_union([from_none, to_int], self.reasoning_tokens) + if self.rejected_prediction_tokens is not None: + result["rejectedPredictionTokens"] = from_union([from_none, to_int], self.rejected_prediction_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) + if self.transport is not None: + result["transport"] = from_union([from_none, lambda x: to_enum(AssistantUsageTransport, x)], self.transport) return result @@ -3168,6 +4331,7 @@ class ExitPlanModeRequestedData: recommended_action: ExitPlanModeAction request_id: str summary: str + model: str | None = None @staticmethod def from_dict(obj: Any) -> "ExitPlanModeRequestedData": @@ -3177,12 +4341,14 @@ def from_dict(obj: Any) -> "ExitPlanModeRequestedData": recommended_action = parse_enum(ExitPlanModeAction, obj.get("recommendedAction")) request_id = from_str(obj.get("requestId")) summary = from_str(obj.get("summary")) + model = from_union([from_none, from_str], obj.get("model")) return ExitPlanModeRequestedData( actions=actions, plan_content=plan_content, recommended_action=recommended_action, request_id=request_id, summary=summary, + model=model, ) def to_dict(self) -> dict: @@ -3192,6 +4358,8 @@ def to_dict(self) -> dict: result["recommendedAction"] = to_enum(ExitPlanModeAction, self.recommended_action) result["requestId"] = from_str(self.request_id) result["summary"] = from_str(self.summary) + if self.model is not None: + result["model"] = from_union([from_none, from_str], self.model) return result @@ -3253,6 +4421,7 @@ class ExternalToolRequestedData: tool_call_id: str tool_name: str arguments: Any = None + provider_id: str | None = None traceparent: str | None = None tracestate: str | None = None working_directory: str | None = None @@ -3265,6 +4434,7 @@ def from_dict(obj: Any) -> "ExternalToolRequestedData": tool_call_id = from_str(obj.get("toolCallId")) tool_name = from_str(obj.get("toolName")) arguments = obj.get("arguments") + provider_id = from_union([from_none, from_str], obj.get("providerId")) traceparent = from_union([from_none, from_str], obj.get("traceparent")) tracestate = from_union([from_none, from_str], obj.get("tracestate")) working_directory = from_union([from_none, from_str], obj.get("workingDirectory")) @@ -3274,6 +4444,7 @@ def from_dict(obj: Any) -> "ExternalToolRequestedData": tool_call_id=tool_call_id, tool_name=tool_name, arguments=arguments, + provider_id=provider_id, traceparent=traceparent, tracestate=tracestate, working_directory=working_directory, @@ -3287,6 +4458,8 @@ def to_dict(self) -> dict: result["toolName"] = from_str(self.tool_name) if self.arguments is not None: result["arguments"] = self.arguments + if self.provider_id is not None: + result["providerId"] = from_union([from_none, from_str], self.provider_id) if self.traceparent is not None: result["traceparent"] = from_union([from_none, from_str], self.traceparent) if self.tracestate is not None: @@ -3296,6 +4469,65 @@ 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." @@ -3383,6 +4615,7 @@ class HookEndData: success: bool error: HookEndError | None = None output: Any = None + parent_tool_call_id: str | None = None @staticmethod def from_dict(obj: Any) -> "HookEndData": @@ -3392,12 +4625,14 @@ def from_dict(obj: Any) -> "HookEndData": success = from_bool(obj.get("success")) error = from_union([from_none, HookEndError.from_dict], obj.get("error")) output = obj.get("output") + parent_tool_call_id = from_union([from_none, from_str], obj.get("parentToolCallId")) return HookEndData( hook_invocation_id=hook_invocation_id, hook_type=hook_type, success=success, error=error, output=output, + parent_tool_call_id=parent_tool_call_id, ) def to_dict(self) -> dict: @@ -3409,6 +4644,8 @@ def to_dict(self) -> dict: result["error"] = from_union([from_none, lambda x: to_class(HookEndError, x)], self.error) if self.output is not None: result["output"] = self.output + if self.parent_tool_call_id is not None: + result["parentToolCallId"] = from_union([from_none, from_str], self.parent_tool_call_id) return result @@ -3471,6 +4708,7 @@ class HookStartData: hook_invocation_id: str hook_type: str input: Any = None + parent_tool_call_id: str | None = None @staticmethod def from_dict(obj: Any) -> "HookStartData": @@ -3478,10 +4716,12 @@ def from_dict(obj: Any) -> "HookStartData": hook_invocation_id = from_str(obj.get("hookInvocationId")) hook_type = from_str(obj.get("hookType")) input = obj.get("input") + parent_tool_call_id = from_union([from_none, from_str], obj.get("parentToolCallId")) return HookStartData( hook_invocation_id=hook_invocation_id, hook_type=hook_type, input=input, + parent_tool_call_id=parent_tool_call_id, ) def to_dict(self) -> dict: @@ -3490,6 +4730,8 @@ def to_dict(self) -> dict: result["hookType"] = from_str(self.hook_type) if self.input is not None: result["input"] = self.input + if self.parent_tool_call_id is not None: + result["parentToolCallId"] = from_union([from_none, from_str], self.parent_tool_call_id) return result @@ -3945,7 +5187,10 @@ class ModelCallFailureData: error_message: str | None = None error_type: str | None = None failure_kind: ModelCallFailureKind | None = None + # Experimental: this field is part of an experimental API and may change or be removed. + fusion: FusionAttribution | None = None initiator: str | None = None + interaction_type: str | None = None is_auto: bool | None = None is_byok: bool | None = None max_output_tokens: int | None = None @@ -3956,6 +5201,7 @@ class ModelCallFailureData: _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 @@ -3972,7 +5218,9 @@ def from_dict(obj: Any) -> "ModelCallFailureData": 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")) + fusion = from_union([from_none, FusionAttribution.from_dict], obj.get("fusion")) initiator = from_union([from_none, from_str], obj.get("initiator")) + interaction_type = from_union([from_none, from_str], obj.get("interactionType")) 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")) @@ -3982,6 +5230,7 @@ def from_dict(obj: Any) -> "ModelCallFailureData": _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")) @@ -3995,7 +5244,9 @@ def from_dict(obj: Any) -> "ModelCallFailureData": error_message=error_message, error_type=error_type, failure_kind=failure_kind, + fusion=fusion, initiator=initiator, + interaction_type=interaction_type, is_auto=is_auto, is_byok=is_byok, max_output_tokens=max_output_tokens, @@ -4005,6 +5256,7 @@ def from_dict(obj: Any) -> "ModelCallFailureData": _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, @@ -4029,8 +5281,12 @@ def to_dict(self) -> dict: 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.fusion is not None: + result["fusion"] = from_union([from_none, lambda x: to_class(FusionAttribution, x)], self.fusion) if self.initiator is not None: result["initiator"] = from_union([from_none, from_str], self.initiator) + if self.interaction_type is not None: + result["interactionType"] = from_union([from_none, from_str], self.interaction_type) 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: @@ -4049,6 +5305,8 @@ def to_dict(self) -> dict: 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: @@ -4102,27 +5360,80 @@ def to_dict(self) -> dict: return result +@dataclass +class ModelCallFinishedData: + "Final lifecycle outcome for one logical model dispatch. A logical dispatch may include internal reconnect or fallback work, so event count is not provider HTTP-request count." + dispatch_duration: timedelta + edit_classifier_version: int + outcome: ModelCallFinishedOutcome + turn_id: str + contains_built_in_file_edit_request: bool | None = None + interaction_id: str | None = None + + @staticmethod + def from_dict(obj: Any) -> "ModelCallFinishedData": + assert isinstance(obj, dict) + dispatch_duration = from_timedelta(obj.get("dispatchDurationMs")) + edit_classifier_version = from_int(obj.get("editClassifierVersion")) + outcome = parse_enum(ModelCallFinishedOutcome, obj.get("outcome")) + turn_id = from_str(obj.get("turnId")) + contains_built_in_file_edit_request = from_union([from_none, from_bool], obj.get("containsBuiltInFileEditRequest")) + interaction_id = from_union([from_none, from_str], obj.get("interactionId")) + return ModelCallFinishedData( + dispatch_duration=dispatch_duration, + edit_classifier_version=edit_classifier_version, + outcome=outcome, + turn_id=turn_id, + contains_built_in_file_edit_request=contains_built_in_file_edit_request, + interaction_id=interaction_id, + ) + + def to_dict(self) -> dict: + result: dict = {} + result["dispatchDurationMs"] = to_timedelta(self.dispatch_duration) + result["editClassifierVersion"] = to_int(self.edit_classifier_version) + result["outcome"] = to_enum(ModelCallFinishedOutcome, self.outcome) + result["turnId"] = from_str(self.turn_id) + if self.contains_built_in_file_edit_request is not None: + result["containsBuiltInFileEditRequest"] = from_union([from_none, from_bool], self.contains_built_in_file_edit_request) + if self.interaction_id is not None: + result["interactionId"] = from_union([from_none, from_str], self.interaction_id) + return result + + @dataclass class ModelCallStartData: "Model API dispatch metadata for internal telemetry" turn_id: str + # Experimental: this field is part of an experimental API and may change or be removed. + fusion: FusionAttribution | None = None 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")) + fusion = from_union([from_none, FusionAttribution.from_dict], obj.get("fusion")) 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, + fusion=fusion, model=model, + _previous_response_id=_previous_response_id, ) def to_dict(self) -> dict: result: dict = {} result["turnId"] = from_str(self.turn_id) + if self.fusion is not None: + result["fusion"] = from_union([from_none, lambda x: to_class(FusionAttribution, x)], self.fusion) 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 @@ -4142,16 +5453,21 @@ def to_dict(self) -> dict: class PermissionApproved: "Permission response variant indicating the request was approved without persisting an approval rule." kind: ClassVar[str] = "approved" + managed_approval_handled: bool | None = None @staticmethod def from_dict(obj: Any) -> "PermissionApproved": assert isinstance(obj, dict) + managed_approval_handled = from_union([from_none, from_bool], obj.get("managedApprovalHandled")) return PermissionApproved( + managed_approval_handled=managed_approval_handled, ) def to_dict(self) -> dict: result: dict = {} result["kind"] = self.kind + if self.managed_approval_handled is not None: + result["managedApprovalHandled"] = from_union([from_none, from_bool], self.managed_approval_handled) return result @@ -4161,15 +5477,18 @@ class PermissionApprovedForLocation: approval: UserToolSessionApproval kind: ClassVar[str] = "approved-for-location" location_key: str + managed_approval_handled: bool | None = None @staticmethod def from_dict(obj: Any) -> "PermissionApprovedForLocation": assert isinstance(obj, dict) approval = _load_UserToolSessionApproval(obj.get("approval")) location_key = from_str(obj.get("locationKey")) + managed_approval_handled = from_union([from_none, from_bool], obj.get("managedApprovalHandled")) return PermissionApprovedForLocation( approval=approval, location_key=location_key, + managed_approval_handled=managed_approval_handled, ) def to_dict(self) -> dict: @@ -4177,6 +5496,8 @@ def to_dict(self) -> dict: result["approval"] = self.approval.to_dict() result["kind"] = self.kind result["locationKey"] = from_str(self.location_key) + if self.managed_approval_handled is not None: + result["managedApprovalHandled"] = from_union([from_none, from_bool], self.managed_approval_handled) return result @@ -4185,19 +5506,24 @@ class PermissionApprovedForSession: "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" + managed_approval_handled: bool | None = None @staticmethod def from_dict(obj: Any) -> "PermissionApprovedForSession": assert isinstance(obj, dict) approval = _load_UserToolSessionApproval(obj.get("approval")) + managed_approval_handled = from_union([from_none, from_bool], obj.get("managedApprovalHandled")) return PermissionApprovedForSession( approval=approval, + managed_approval_handled=managed_approval_handled, ) def to_dict(self) -> dict: result: dict = {} result["approval"] = self.approval.to_dict() result["kind"] = self.kind + if self.managed_approval_handled is not None: + result["managedApprovalHandled"] = from_union([from_none, from_bool], self.managed_approval_handled) return result @@ -4377,7 +5703,8 @@ class PermissionPromptRequestCommands: 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 + assisted_approval: PermissionAssistedApproval | None = None + managed_approval_required: bool | None = None tool_call_id: str | None = None warning: str | None = None @@ -4388,7 +5715,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")) + assisted_approval = from_union([from_none, PermissionAssistedApproval.from_dict], obj.get("assistedApproval")) + 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( @@ -4396,7 +5724,8 @@ def from_dict(obj: Any) -> "PermissionPromptRequestCommands": command_identifiers=command_identifiers, full_command_text=full_command_text, intention=intention, - auto_approval=auto_approval, + assisted_approval=assisted_approval, + managed_approval_required=managed_approval_required, tool_call_id=tool_call_id, warning=warning, ) @@ -4408,8 +5737,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.assisted_approval is not None: + result["assistedApproval"] = from_union([from_none, lambda x: to_class(PermissionAssistedApproval, x)], self.assisted_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: @@ -4425,7 +5756,7 @@ class PermissionPromptRequestCustomTool: 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 + assisted_approval: PermissionAssistedApproval | None = None tool_call_id: str | None = None @staticmethod @@ -4434,13 +5765,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")) + assisted_approval = from_union([from_none, PermissionAssistedApproval.from_dict], obj.get("assistedApproval")) 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, + assisted_approval=assisted_approval, tool_call_id=tool_call_id, ) @@ -4451,8 +5782,44 @@ 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.assisted_approval is not None: + result["assistedApproval"] = from_union([from_none, lambda x: to_class(PermissionAssistedApproval, x)], self.assisted_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 PermissionPromptRequestExtensionEnvAccess: + "Extension sensitive environment variable access prompt" + environment_variables: list[str] + extension_name: str + kind: ClassVar[str] = "extension-env-access" + # Experimental: this field is part of an experimental API and may change or be removed. + assisted_approval: PermissionAssistedApproval | None = None + tool_call_id: str | None = None + + @staticmethod + def from_dict(obj: Any) -> "PermissionPromptRequestExtensionEnvAccess": + assert isinstance(obj, dict) + environment_variables = from_list(from_str, obj.get("environmentVariables")) + extension_name = from_str(obj.get("extensionName")) + assisted_approval = from_union([from_none, PermissionAssistedApproval.from_dict], obj.get("assistedApproval")) + tool_call_id = from_union([from_none, from_str], obj.get("toolCallId")) + return PermissionPromptRequestExtensionEnvAccess( + environment_variables=environment_variables, + extension_name=extension_name, + assisted_approval=assisted_approval, + tool_call_id=tool_call_id, + ) + + def to_dict(self) -> dict: + result: dict = {} + result["environmentVariables"] = from_list(from_str, self.environment_variables) + result["extensionName"] = from_str(self.extension_name) + result["kind"] = self.kind + if self.assisted_approval is not None: + result["assistedApproval"] = from_union([from_none, lambda x: to_class(PermissionAssistedApproval, x)], self.assisted_approval) if self.tool_call_id is not None: result["toolCallId"] = from_union([from_none, from_str], self.tool_call_id) return result @@ -4464,7 +5831,7 @@ class PermissionPromptRequestExtensionManagement: 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 + assisted_approval: PermissionAssistedApproval | None = None extension_name: str | None = None tool_call_id: str | None = None @@ -4472,12 +5839,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")) + assisted_approval = from_union([from_none, PermissionAssistedApproval.from_dict], obj.get("assistedApproval")) 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, + assisted_approval=assisted_approval, extension_name=extension_name, tool_call_id=tool_call_id, ) @@ -4486,8 +5853,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.assisted_approval is not None: + result["assistedApproval"] = from_union([from_none, lambda x: to_class(PermissionAssistedApproval, x)], self.assisted_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: @@ -4502,7 +5869,7 @@ class PermissionPromptRequestExtensionPermissionAccess: 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 + assisted_approval: PermissionAssistedApproval | None = None tool_call_id: str | None = None @staticmethod @@ -4510,12 +5877,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")) + assisted_approval = from_union([from_none, PermissionAssistedApproval.from_dict], obj.get("assistedApproval")) tool_call_id = from_union([from_none, from_str], obj.get("toolCallId")) return PermissionPromptRequestExtensionPermissionAccess( capabilities=capabilities, extension_name=extension_name, - auto_approval=auto_approval, + assisted_approval=assisted_approval, tool_call_id=tool_call_id, ) @@ -4524,8 +5891,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.assisted_approval is not None: + result["assistedApproval"] = from_union([from_none, lambda x: to_class(PermissionAssistedApproval, x)], self.assisted_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. + assisted_approval: PermissionAssistedApproval | 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")) + assisted_approval = from_union([from_none, PermissionAssistedApproval.from_dict], obj.get("assistedApproval")) + 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, + assisted_approval=assisted_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.assisted_approval is not None: + result["assistedApproval"] = from_union([from_none, lambda x: to_class(PermissionAssistedApproval, x)], self.assisted_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 @@ -4537,7 +6001,7 @@ class PermissionPromptRequestHook: 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 + assisted_approval: PermissionAssistedApproval | None = None hook_message: str | None = None tool_args: Any = None tool_call_id: str | None = None @@ -4546,13 +6010,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")) + assisted_approval = from_union([from_none, PermissionAssistedApproval.from_dict], obj.get("assistedApproval")) 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, + assisted_approval=assisted_approval, hook_message=hook_message, tool_args=tool_args, tool_call_id=tool_call_id, @@ -4562,8 +6026,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.assisted_approval is not None: + result["assistedApproval"] = from_union([from_none, lambda x: to_class(PermissionAssistedApproval, x)], self.assisted_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: @@ -4582,7 +6046,10 @@ class PermissionPromptRequestMcp: tool_title: str args: Any = None # Experimental: this field is part of an experimental API and may change or be removed. - auto_approval: PermissionAutoApproval | None = None + assisted_approval: PermissionAssistedApproval | None = None + can_offer_server_wide_approval: bool | None = None + # Experimental: this field is part of an experimental API and may change or be removed. + permission_recommendation: PermissionRecommendation | None = None tool_call_id: str | None = None @staticmethod @@ -4592,14 +6059,18 @@ def from_dict(obj: Any) -> "PermissionPromptRequestMcp": tool_name = from_str(obj.get("toolName")) tool_title = from_str(obj.get("toolTitle")) args = obj.get("args") - auto_approval = from_union([from_none, PermissionAutoApproval.from_dict], obj.get("autoApproval")) + assisted_approval = from_union([from_none, PermissionAssistedApproval.from_dict], obj.get("assistedApproval")) + can_offer_server_wide_approval = from_union([from_none, from_bool], obj.get("canOfferServerWideApproval")) + permission_recommendation = from_union([from_none, lambda x: parse_enum(PermissionRecommendation, x)], obj.get("permissionRecommendation")) 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, + assisted_approval=assisted_approval, + can_offer_server_wide_approval=can_offer_server_wide_approval, + permission_recommendation=permission_recommendation, tool_call_id=tool_call_id, ) @@ -4611,8 +6082,12 @@ def to_dict(self) -> dict: result["toolTitle"] = from_str(self.tool_title) 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.assisted_approval is not None: + result["assistedApproval"] = from_union([from_none, lambda x: to_class(PermissionAssistedApproval, x)], self.assisted_approval) + if self.can_offer_server_wide_approval is not None: + result["canOfferServerWideApproval"] = from_union([from_none, from_bool], self.can_offer_server_wide_approval) + if self.permission_recommendation is not None: + result["permissionRecommendation"] = from_union([from_none, lambda x: to_enum(PermissionRecommendation, x)], self.permission_recommendation) if self.tool_call_id is not None: result["toolCallId"] = from_union([from_none, from_str], self.tool_call_id) return result @@ -4625,7 +6100,7 @@ class PermissionPromptRequestMemory: 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 + assisted_approval: PermissionAssistedApproval | None = None citations: str | None = None direction: PermissionRequestMemoryDirection | None = None reason: str | None = None @@ -4637,7 +6112,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")) + assisted_approval = from_union([from_none, PermissionAssistedApproval.from_dict], obj.get("assistedApproval")) 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")) @@ -4646,7 +6121,7 @@ def from_dict(obj: Any) -> "PermissionPromptRequestMemory": return PermissionPromptRequestMemory( fact=fact, action=action, - auto_approval=auto_approval, + assisted_approval=assisted_approval, citations=citations, direction=direction, reason=reason, @@ -4660,8 +6135,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.assisted_approval is not None: + result["assistedApproval"] = from_union([from_none, lambda x: to_class(PermissionAssistedApproval, x)], self.assisted_approval) if self.citations is not None: result["citations"] = from_union([from_none, from_str], self.citations) if self.direction is not None: @@ -4682,7 +6157,7 @@ class PermissionPromptRequestPath: 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 + assisted_approval: PermissionAssistedApproval | None = None tool_call_id: str | None = None @staticmethod @@ -4690,12 +6165,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")) + assisted_approval = from_union([from_none, PermissionAssistedApproval.from_dict], obj.get("assistedApproval")) tool_call_id = from_union([from_none, from_str], obj.get("toolCallId")) return PermissionPromptRequestPath( access_kind=access_kind, paths=paths, - auto_approval=auto_approval, + assisted_approval=assisted_approval, tool_call_id=tool_call_id, ) @@ -4704,8 +6179,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.assisted_approval is not None: + result["assistedApproval"] = from_union([from_none, lambda x: to_class(PermissionAssistedApproval, x)], self.assisted_approval) if self.tool_call_id is not None: result["toolCallId"] = from_union([from_none, from_str], self.tool_call_id) return result @@ -4718,7 +6193,8 @@ class PermissionPromptRequestRead: 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 + assisted_approval: PermissionAssistedApproval | None = None + managed_approval_required: bool | None = None tool_call_id: str | None = None @staticmethod @@ -4726,12 +6202,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")) + assisted_approval = from_union([from_none, PermissionAssistedApproval.from_dict], obj.get("assistedApproval")) + 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, + assisted_approval=assisted_approval, + managed_approval_required=managed_approval_required, tool_call_id=tool_call_id, ) @@ -4740,8 +6218,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.assisted_approval is not None: + result["assistedApproval"] = from_union([from_none, lambda x: to_class(PermissionAssistedApproval, x)], self.assisted_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 @@ -4754,7 +6234,9 @@ class PermissionPromptRequestUrl: 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 + assisted_approval: PermissionAssistedApproval | 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 @@ -4764,14 +6246,18 @@ 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")) + assisted_approval = from_union([from_none, PermissionAssistedApproval.from_dict], obj.get("assistedApproval")) + 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, + assisted_approval=assisted_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, @@ -4782,8 +6268,12 @@ 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.assisted_approval is not None: + result["assistedApproval"] = from_union([from_none, lambda x: to_class(PermissionAssistedApproval, x)], self.assisted_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: @@ -4802,7 +6292,8 @@ class PermissionPromptRequestWrite: 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 + assisted_approval: PermissionAssistedApproval | None = None + managed_approval_required: bool | None = None new_file_contents: str | None = None tool_call_id: str | None = None @@ -4813,7 +6304,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")) + assisted_approval = from_union([from_none, PermissionAssistedApproval.from_dict], obj.get("assistedApproval")) + 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( @@ -4821,7 +6313,8 @@ def from_dict(obj: Any) -> "PermissionPromptRequestWrite": diff=diff, file_name=file_name, intention=intention, - auto_approval=auto_approval, + assisted_approval=assisted_approval, + managed_approval_required=managed_approval_required, new_file_contents=new_file_contents, tool_call_id=tool_call_id, ) @@ -4833,8 +6326,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.assisted_approval is not None: + result["assistedApproval"] = from_union([from_none, lambda x: to_class(PermissionAssistedApproval, x)], self.assisted_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: @@ -4850,6 +6345,8 @@ class PermissionRequestCustomTool: tool_name: str args: Any = None tool_call_id: str | None = None + managed_approval_required: bool | None = None + skip_permission: bool | None = None @staticmethod def from_dict(obj: Any) -> "PermissionRequestCustomTool": @@ -4858,11 +6355,15 @@ 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")) + skip_permission = from_union([from_none, from_bool], obj.get("skipPermission")) return PermissionRequestCustomTool( tool_description=tool_description, tool_name=tool_name, args=args, tool_call_id=tool_call_id, + managed_approval_required=managed_approval_required, + skip_permission=skip_permission, ) def to_dict(self) -> dict: @@ -4874,6 +6375,45 @@ 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) + if self.skip_permission is not None: + result["skipPermission"] = from_union([from_none, from_bool], self.skip_permission) + return result + + +@dataclass +class PermissionRequestExtensionEnvAccess: + "Extension sensitive environment variable access request" + environment_variables: list[str] + extension_name: str + kind: ClassVar[str] = "extension-env-access" + tool_call_id: str | None = None + managed_approval_required: bool | None = None + + @staticmethod + def from_dict(obj: Any) -> "PermissionRequestExtensionEnvAccess": + assert isinstance(obj, dict) + environment_variables = from_list(from_str, obj.get("environmentVariables")) + 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 PermissionRequestExtensionEnvAccess( + environment_variables=environment_variables, + extension_name=extension_name, + tool_call_id=tool_call_id, + managed_approval_required=managed_approval_required, + ) + + def to_dict(self) -> dict: + result: dict = {} + result["environmentVariables"] = from_list(from_str, self.environment_variables) + result["extensionName"] = from_str(self.extension_name) + 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 @@ -4884,6 +6424,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": @@ -4891,10 +6432,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: @@ -4905,6 +6448,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 @@ -4915,6 +6460,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": @@ -4922,10 +6468,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: @@ -4935,6 +6483,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 @@ -4946,6 +6587,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": @@ -4954,11 +6596,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: @@ -4971,6 +6615,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 @@ -4983,7 +6629,10 @@ class PermissionRequestMcp: tool_name: str tool_title: str args: Any = None + # Experimental: this field is part of an experimental API and may change or be removed. + permission_recommendation: PermissionRecommendation | None = None tool_call_id: str | None = None + managed_approval_required: bool | None = None @staticmethod def from_dict(obj: Any) -> "PermissionRequestMcp": @@ -4993,14 +6642,18 @@ def from_dict(obj: Any) -> "PermissionRequestMcp": tool_name = from_str(obj.get("toolName")) tool_title = from_str(obj.get("toolTitle")) args = obj.get("args") + permission_recommendation = from_union([from_none, lambda x: parse_enum(PermissionRecommendation, x)], obj.get("permissionRecommendation")) 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, tool_name=tool_name, tool_title=tool_title, args=args, + permission_recommendation=permission_recommendation, tool_call_id=tool_call_id, + managed_approval_required=managed_approval_required, ) def to_dict(self) -> dict: @@ -5012,8 +6665,12 @@ def to_dict(self) -> dict: result["toolTitle"] = from_str(self.tool_title) if self.args is not None: result["args"] = self.args + if self.permission_recommendation is not None: + result["permissionRecommendation"] = from_union([from_none, lambda x: to_enum(PermissionRecommendation, x)], self.permission_recommendation) 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 @@ -5023,30 +6680,43 @@ class PermissionRequestMemory: 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. + assisted_approval: PermissionAssistedApproval | None = None citations: str | None = None direction: PermissionRequestMemoryDirection | None = None reason: str | None = None + repo_nwo: str | None = None + scope: PermissionRequestMemoryScope | 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": assert isinstance(obj, dict) fact = from_str(obj.get("fact")) action = from_union([from_none, lambda x: parse_enum(PermissionRequestMemoryAction, x)], obj.get("action")) + assisted_approval = from_union([from_none, PermissionAssistedApproval.from_dict], obj.get("assistedApproval")) 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")) + repo_nwo = from_union([from_none, from_str], obj.get("repoNwo")) + scope = from_union([from_none, lambda x: parse_enum(PermissionRequestMemoryScope, x)], obj.get("scope")) 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, + assisted_approval=assisted_approval, citations=citations, direction=direction, reason=reason, + repo_nwo=repo_nwo, + scope=scope, subject=subject, tool_call_id=tool_call_id, + managed_approval_required=managed_approval_required, ) def to_dict(self) -> dict: @@ -5055,16 +6725,24 @@ 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.assisted_approval is not None: + result["assistedApproval"] = from_union([from_none, lambda x: to_class(PermissionAssistedApproval, x)], self.assisted_approval) if self.citations is not None: result["citations"] = from_union([from_none, from_str], self.citations) if self.direction is not None: result["direction"] = from_union([from_none, lambda x: to_enum(PermissionRequestMemoryDirection, x)], self.direction) if self.reason is not None: result["reason"] = from_union([from_none, from_str], self.reason) + if self.repo_nwo is not None: + result["repoNwo"] = from_union([from_none, from_str], self.repo_nwo) + if self.scope is not None: + result["scope"] = from_union([from_none, lambda x: to_enum(PermissionRequestMemoryScope, x)], self.scope) if self.subject is not None: 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 @@ -5074,6 +6752,7 @@ 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 @@ -5083,12 +6762,14 @@ 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, @@ -5099,6 +6780,8 @@ 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: @@ -5119,6 +6802,8 @@ 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 @@ -5134,6 +6819,8 @@ 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")) @@ -5146,6 +6833,8 @@ 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, @@ -5162,6 +6851,10 @@ 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: @@ -5196,6 +6889,29 @@ 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: "A URL that may be accessed by a command in a shell permission request." @@ -5221,6 +6937,8 @@ 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 @@ -5230,12 +6948,16 @@ 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, @@ -5246,6 +6968,10 @@ 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: @@ -5263,6 +6989,7 @@ 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 @@ -5275,6 +7002,7 @@ 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")) @@ -5284,6 +7012,7 @@ def from_dict(obj: Any) -> "PermissionRequestWrite": 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, @@ -5297,6 +7026,8 @@ 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: @@ -5315,6 +7046,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": @@ -5323,11 +7055,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: @@ -5338,6 +7072,8 @@ 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 @@ -5401,6 +7137,147 @@ def to_dict(self) -> dict: return result +@dataclass +class PromptCacheBreakData: + "A detected loss of a previously cached prompt prefix" + contributing_reasons: list[str] + frontier_tokens: int + primary_reason: str + retention_ratio: float + shortfall_tokens: int + survived_tokens: int + # Internal: this field is an internal SDK API and is not part of the public surface. + _after_request: Any = None + # Internal: this field is an internal SDK API and is not part of the public surface. + _agent_name: str | None = None + # Internal: this field is an internal SDK API and is not part of the public surface. + _before_request: Any = None + # Internal: this field is an internal SDK API and is not part of the public surface. + _cache_config_changed_fields: list[str] | None = None + # Internal: this field is an internal SDK API and is not part of the public surface. + _model_from: str | None = None + # Internal: this field is an internal SDK API and is not part of the public surface. + _model_to: str | None = None + # Internal: this field is an internal SDK API and is not part of the public surface. + _rewrite_message_index: int | None = None + # Internal: this field is an internal SDK API and is not part of the public surface. + _rewrite_shape: str | None = None + # Internal: this field is an internal SDK API and is not part of the public surface. + _rewrite_source: list[str] | None = None + # Internal: this field is an internal SDK API and is not part of the public surface. + _system_segments_changed: list[str] | None = None + # Internal: this field is an internal SDK API and is not part of the public surface. + _tools_added: list[str] | None = None + # Internal: this field is an internal SDK API and is not part of the public surface. + _tools_added_raw: list[str] | None = None + # Internal: this field is an internal SDK API and is not part of the public surface. + _tools_redefined: list[str] | None = None + # Internal: this field is an internal SDK API and is not part of the public surface. + _tools_redefined_raw: list[str] | None = None + # Internal: this field is an internal SDK API and is not part of the public surface. + _tools_removed: list[str] | None = None + # Internal: this field is an internal SDK API and is not part of the public surface. + _tools_removed_raw: list[str] | None = None + # Internal: this field is an internal SDK API and is not part of the public surface. + _tools_reordered: bool | None = None + + @staticmethod + def from_dict(obj: Any) -> "PromptCacheBreakData": + assert isinstance(obj, dict) + contributing_reasons = from_list(from_str, obj.get("contributingReasons")) + frontier_tokens = from_int(obj.get("frontierTokens")) + primary_reason = from_str(obj.get("primaryReason")) + retention_ratio = from_float(obj.get("retentionRatio")) + shortfall_tokens = from_int(obj.get("shortfallTokens")) + survived_tokens = from_int(obj.get("survivedTokens")) + _after_request = obj.get("afterRequest") + _agent_name = from_union([from_none, from_str], obj.get("agentName")) + _before_request = obj.get("beforeRequest") + _cache_config_changed_fields = from_union([from_none, lambda x: from_list(from_str, x)], obj.get("cacheConfigChangedFields")) + _model_from = from_union([from_none, from_str], obj.get("modelFrom")) + _model_to = from_union([from_none, from_str], obj.get("modelTo")) + _rewrite_message_index = from_union([from_none, from_int], obj.get("rewriteMessageIndex")) + _rewrite_shape = from_union([from_none, from_str], obj.get("rewriteShape")) + _rewrite_source = from_union([from_none, lambda x: from_list(from_str, x)], obj.get("rewriteSource")) + _system_segments_changed = from_union([from_none, lambda x: from_list(from_str, x)], obj.get("systemSegmentsChanged")) + _tools_added = from_union([from_none, lambda x: from_list(from_str, x)], obj.get("toolsAdded")) + _tools_added_raw = from_union([from_none, lambda x: from_list(from_str, x)], obj.get("toolsAddedRaw")) + _tools_redefined = from_union([from_none, lambda x: from_list(from_str, x)], obj.get("toolsRedefined")) + _tools_redefined_raw = from_union([from_none, lambda x: from_list(from_str, x)], obj.get("toolsRedefinedRaw")) + _tools_removed = from_union([from_none, lambda x: from_list(from_str, x)], obj.get("toolsRemoved")) + _tools_removed_raw = from_union([from_none, lambda x: from_list(from_str, x)], obj.get("toolsRemovedRaw")) + _tools_reordered = from_union([from_none, from_bool], obj.get("toolsReordered")) + return PromptCacheBreakData( + contributing_reasons=contributing_reasons, + frontier_tokens=frontier_tokens, + primary_reason=primary_reason, + retention_ratio=retention_ratio, + shortfall_tokens=shortfall_tokens, + survived_tokens=survived_tokens, + _after_request=_after_request, + _agent_name=_agent_name, + _before_request=_before_request, + _cache_config_changed_fields=_cache_config_changed_fields, + _model_from=_model_from, + _model_to=_model_to, + _rewrite_message_index=_rewrite_message_index, + _rewrite_shape=_rewrite_shape, + _rewrite_source=_rewrite_source, + _system_segments_changed=_system_segments_changed, + _tools_added=_tools_added, + _tools_added_raw=_tools_added_raw, + _tools_redefined=_tools_redefined, + _tools_redefined_raw=_tools_redefined_raw, + _tools_removed=_tools_removed, + _tools_removed_raw=_tools_removed_raw, + _tools_reordered=_tools_reordered, + ) + + def to_dict(self) -> dict: + result: dict = {} + result["contributingReasons"] = from_list(from_str, self.contributing_reasons) + result["frontierTokens"] = to_int(self.frontier_tokens) + result["primaryReason"] = from_str(self.primary_reason) + result["retentionRatio"] = to_float(self.retention_ratio) + result["shortfallTokens"] = to_int(self.shortfall_tokens) + result["survivedTokens"] = to_int(self.survived_tokens) + if self._after_request is not None: + result["afterRequest"] = self._after_request + if self._agent_name is not None: + result["agentName"] = from_union([from_none, from_str], self._agent_name) + if self._before_request is not None: + result["beforeRequest"] = self._before_request + if self._cache_config_changed_fields is not None: + result["cacheConfigChangedFields"] = from_union([from_none, lambda x: from_list(from_str, x)], self._cache_config_changed_fields) + if self._model_from is not None: + result["modelFrom"] = from_union([from_none, from_str], self._model_from) + if self._model_to is not None: + result["modelTo"] = from_union([from_none, from_str], self._model_to) + if self._rewrite_message_index is not None: + result["rewriteMessageIndex"] = from_union([from_none, to_int], self._rewrite_message_index) + if self._rewrite_shape is not None: + result["rewriteShape"] = from_union([from_none, from_str], self._rewrite_shape) + if self._rewrite_source is not None: + result["rewriteSource"] = from_union([from_none, lambda x: from_list(from_str, x)], self._rewrite_source) + if self._system_segments_changed is not None: + result["systemSegmentsChanged"] = from_union([from_none, lambda x: from_list(from_str, x)], self._system_segments_changed) + if self._tools_added is not None: + result["toolsAdded"] = from_union([from_none, lambda x: from_list(from_str, x)], self._tools_added) + if self._tools_added_raw is not None: + result["toolsAddedRaw"] = from_union([from_none, lambda x: from_list(from_str, x)], self._tools_added_raw) + if self._tools_redefined is not None: + result["toolsRedefined"] = from_union([from_none, lambda x: from_list(from_str, x)], self._tools_redefined) + if self._tools_redefined_raw is not None: + result["toolsRedefinedRaw"] = from_union([from_none, lambda x: from_list(from_str, x)], self._tools_redefined_raw) + if self._tools_removed is not None: + result["toolsRemoved"] = from_union([from_none, lambda x: from_list(from_str, x)], self._tools_removed) + if self._tools_removed_raw is not None: + result["toolsRemovedRaw"] = from_union([from_none, lambda x: from_list(from_str, x)], self._tools_removed_raw) + if self._tools_reordered is not None: + result["toolsReordered"] = from_union([from_none, from_bool], self._tools_reordered) + return result + + @dataclass class SamplingCompletedData: "Sampling request completion notification signaling UI dismissal" @@ -5447,6 +7324,18 @@ def to_dict(self) -> dict: return result +@dataclass +class SandboxDecisionData: + "Payload of `sandbox.decision`, a bounded governance record of what the process sandbox was configured to do and whether it took effect. Discriminated by `kind`." + @staticmethod + def from_dict(obj: Any) -> "SandboxDecisionData": + assert isinstance(obj, dict) + return SandboxDecisionData() + + def to_dict(self) -> dict: + return {} + + @dataclass class SessionAutopilotObjectiveChangedData: "Autopilot objective state file operation details indicating what changed" @@ -5537,6 +7426,7 @@ def to_dict(self) -> dict: class SessionCompactionCompleteData: "Conversation compaction results including success status, metrics, and optional error details" success: bool + behavior_model_id: str | None = None checkpoint_number: int | None = None checkpoint_path: str | None = None compaction_tokens_used: CompactionCompleteCompactionTokensUsed | None = None @@ -5552,13 +7442,16 @@ class SessionCompactionCompleteData: 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": assert isinstance(obj, dict) success = from_bool(obj.get("success")) + behavior_model_id = from_union([from_none, from_str], obj.get("behaviorModelId")) checkpoint_number = from_union([from_none, from_int], obj.get("checkpointNumber")) checkpoint_path = from_union([from_none, from_str], obj.get("checkpointPath")) compaction_tokens_used = from_union([from_none, CompactionCompleteCompactionTokensUsed.from_dict], obj.get("compactionTokensUsed")) @@ -5574,10 +7467,13 @@ def from_dict(obj: Any) -> "SessionCompactionCompleteData": 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, + behavior_model_id=behavior_model_id, checkpoint_number=checkpoint_number, checkpoint_path=checkpoint_path, compaction_tokens_used=compaction_tokens_used, @@ -5593,13 +7489,17 @@ def from_dict(obj: Any) -> "SessionCompactionCompleteData": 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: result: dict = {} result["success"] = from_bool(self.success) + if self.behavior_model_id is not None: + result["behaviorModelId"] = from_union([from_none, from_str], self.behavior_model_id) if self.checkpoint_number is not None: result["checkpointNumber"] = from_union([from_none, to_int], self.checkpoint_number) if self.checkpoint_path is not None: @@ -5630,10 +7530,14 @@ def to_dict(self) -> dict: 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 @@ -5641,34 +7545,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 @@ -5681,6 +7600,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 @@ -5693,6 +7613,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( @@ -5702,6 +7623,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, ) @@ -5719,6 +7641,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: @@ -5726,6 +7650,30 @@ 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: "Payload of `session.custom_agents_updated` with loaded custom agents plus non-fatal warnings and fatal errors." @@ -5938,19 +7886,24 @@ def to_dict(self) -> dict: class SessionIdleData: "Payload indicating the session is idle with no background agents or attached shell commands in flight" aborted: bool | None = None + mode: SessionMode | None = None @staticmethod def from_dict(obj: Any) -> "SessionIdleData": assert isinstance(obj, dict) aborted = from_union([from_none, from_bool], obj.get("aborted")) + mode = from_union([from_none, lambda x: parse_enum(SessionMode, x)], obj.get("mode")) return SessionIdleData( aborted=aborted, + mode=mode, ) def to_dict(self) -> dict: result: dict = {} if self.aborted is not None: result["aborted"] = from_union([from_none, from_bool], self.aborted) + if self.mode is not None: + result["mode"] = from_union([from_none, lambda x: to_enum(SessionMode, x)], self.mode) return result @@ -6168,6 +8121,7 @@ class SessionModelChangeData: previous_verbosity: Verbosity | None = None reasoning_effort: str | None = None reasoning_summary: ReasoningSummary | None = None + source: ModelChangeSource | None = None verbosity: Verbosity | None = None @staticmethod @@ -6182,6 +8136,7 @@ def from_dict(obj: Any) -> "SessionModelChangeData": 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")) + source = from_union([from_none, lambda x: parse_enum(ModelChangeSource, x)], obj.get("source")) verbosity = from_union([from_none, lambda x: parse_enum(Verbosity, x)], obj.get("verbosity")) return SessionModelChangeData( new_model=new_model, @@ -6193,6 +8148,7 @@ def from_dict(obj: Any) -> "SessionModelChangeData": previous_verbosity=previous_verbosity, reasoning_effort=reasoning_effort, reasoning_summary=reasoning_summary, + source=source, verbosity=verbosity, ) @@ -6215,46 +8171,13 @@ def to_dict(self) -> dict: 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.source is not None: + result["source"] = from_union([from_none, lambda x: to_enum(ModelChangeSource, x)], self.source) 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 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 - - @dataclass class SessionPlanChangedData: "Plan file operation details indicating what changed" @@ -6404,6 +8327,7 @@ class SessionScheduleCreatedData: 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 @@ -6417,6 +8341,7 @@ def from_dict(obj: Any) -> "SessionScheduleCreatedData": 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")) @@ -6427,6 +8352,7 @@ def from_dict(obj: Any) -> "SessionScheduleCreatedData": cron=cron, display_prompt=display_prompt, interval=interval, + origin=origin, recurring=recurring, self_paced=self_paced, tz=tz, @@ -6444,6 +8370,8 @@ def to_dict(self) -> dict: 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: @@ -6503,6 +8431,7 @@ class SessionShutdownData: session_start_time: int shutdown_type: ShutdownType total_api_duration: timedelta + agent_metrics: dict[str, ShutdownAgentMetric] | None = None conversation_tokens: int | None = None current_model: str | None = None current_tokens: int | None = None @@ -6524,6 +8453,7 @@ def from_dict(obj: Any) -> "SessionShutdownData": session_start_time = from_int(obj.get("sessionStartTime")) shutdown_type = parse_enum(ShutdownType, obj.get("shutdownType")) total_api_duration = from_timedelta(obj.get("totalApiDurationMs")) + agent_metrics = from_union([from_none, lambda x: from_dict(ShutdownAgentMetric.from_dict, x)], obj.get("agentMetrics")) conversation_tokens = from_union([from_none, from_int], obj.get("conversationTokens")) current_model = from_union([from_none, from_str], obj.get("currentModel")) current_tokens = from_union([from_none, from_int], obj.get("currentTokens")) @@ -6540,6 +8470,7 @@ def from_dict(obj: Any) -> "SessionShutdownData": session_start_time=session_start_time, shutdown_type=shutdown_type, total_api_duration=total_api_duration, + agent_metrics=agent_metrics, conversation_tokens=conversation_tokens, current_model=current_model, current_tokens=current_tokens, @@ -6559,6 +8490,8 @@ def to_dict(self) -> dict: result["sessionStartTime"] = to_int(self.session_start_time) result["shutdownType"] = to_enum(ShutdownType, self.shutdown_type) result["totalApiDurationMs"] = to_timedelta_int(self.total_api_duration) + if self.agent_metrics is not None: + result["agentMetrics"] = from_union([from_none, lambda x: from_dict(lambda x: to_class(ShutdownAgentMetric, x), x)], self.agent_metrics) if self.conversation_tokens is not None: result["conversationTokens"] = from_union([from_none, to_int], self.conversation_tokens) if self.current_model is not None: @@ -6636,6 +8569,7 @@ class SessionStartData: context: WorkingDirectoryContext | 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 @@ -6655,6 +8589,7 @@ def from_dict(obj: Any) -> "SessionStartData": context = from_union([from_none, WorkingDirectoryContext.from_dict], obj.get("context")) 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")) @@ -6671,6 +8606,7 @@ 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, @@ -6694,6 +8630,8 @@ def to_dict(self) -> dict: 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: @@ -6712,21 +8650,36 @@ def to_dict(self) -> dict: @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: @@ -6838,6 +8791,8 @@ class SessionUsageCheckpointData: # 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. + _prompt_cache_break_state: list[Any] | 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 @@ -6845,10 +8800,12 @@ 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")) + _prompt_cache_break_state = from_union([from_none, lambda x: from_list(lambda x: x, x)], obj.get("promptCacheBreakState")) _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, + _prompt_cache_break_state=_prompt_cache_break_state, _total_premium_requests=_total_premium_requests, ) @@ -6857,6 +8814,8 @@ def to_dict(self) -> 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._prompt_cache_break_state is not None: + result["promptCacheBreakState"] = from_union([from_none, lambda x: from_list(lambda x: x, x)], self._prompt_cache_break_state) if self._total_premium_requests is not None: result["totalPremiumRequests"] = from_union([from_none, to_float], self._total_premium_requests) return result @@ -6960,6 +8919,43 @@ def to_dict(self) -> dict: return result +@dataclass +class ShutdownAgentMetric: + "Usage attributed to one agent instance at session shutdown." + model_metrics: dict[str, ShutdownModelMetric] + total_api_duration: timedelta + total_nano_aiu: float + agent_display_name: str | None = None + agent_name: str | None = None + + @staticmethod + def from_dict(obj: Any) -> "ShutdownAgentMetric": + assert isinstance(obj, dict) + model_metrics = from_dict(ShutdownModelMetric.from_dict, obj.get("modelMetrics")) + total_api_duration = from_timedelta(obj.get("totalApiDurationMs")) + total_nano_aiu = from_float(obj.get("totalNanoAiu")) + agent_display_name = from_union([from_none, from_str], obj.get("agentDisplayName")) + agent_name = from_union([from_none, from_str], obj.get("agentName")) + return ShutdownAgentMetric( + model_metrics=model_metrics, + total_api_duration=total_api_duration, + total_nano_aiu=total_nano_aiu, + agent_display_name=agent_display_name, + agent_name=agent_name, + ) + + def to_dict(self) -> dict: + result: dict = {} + result["modelMetrics"] = from_dict(lambda x: to_class(ShutdownModelMetric, x), self.model_metrics) + result["totalApiDurationMs"] = to_timedelta_int(self.total_api_duration) + result["totalNanoAiu"] = to_float(self.total_nano_aiu) + if self.agent_display_name is not None: + result["agentDisplayName"] = from_union([from_none, from_str], self.agent_display_name) + if self.agent_name is not None: + result["agentName"] = from_union([from_none, from_str], self.agent_name) + return result + + @dataclass class ShutdownCodeChanges: "Aggregate code change metrics for the session" @@ -7193,6 +9189,7 @@ class SkillsLoadedSkill: source: SkillSource user_invocable: bool argument_hint: str | None = None + command_name: str | None = None path: str | None = None @staticmethod @@ -7204,6 +9201,7 @@ def from_dict(obj: Any) -> "SkillsLoadedSkill": 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, @@ -7212,6 +9210,7 @@ def from_dict(obj: Any) -> "SkillsLoadedSkill": source=source, user_invocable=user_invocable, argument_hint=argument_hint, + command_name=command_name, path=path, ) @@ -7224,6 +9223,8 @@ def to_dict(self) -> dict: 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 @@ -7235,7 +9236,13 @@ class SubagentCompletedData: agent_display_name: str agent_name: str tool_call_id: str + cancelled: bool | None = None + configured_model_matches_actual: bool | None = None + configured_model_preference: str | None = None duration: timedelta | None = None + explicit_model_matches_preference: bool | None = None + explicit_model_override: str | None = None + first_dispatched_model: str | None = None model: str | None = None total_tokens: int | None = None total_tool_calls: int | None = None @@ -7246,7 +9253,13 @@ 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")) + configured_model_matches_actual = from_union([from_none, from_bool], obj.get("configuredModelMatchesActual")) + configured_model_preference = from_union([from_none, from_str], obj.get("configuredModelPreference")) duration = from_union([from_none, from_timedelta], obj.get("durationMs")) + explicit_model_matches_preference = from_union([from_none, from_bool], obj.get("explicitModelMatchesPreference")) + explicit_model_override = from_union([from_none, from_str], obj.get("explicitModelOverride")) + first_dispatched_model = from_union([from_none, from_str], obj.get("firstDispatchedModel")) model = from_union([from_none, from_str], obj.get("model")) total_tokens = from_union([from_none, from_int], obj.get("totalTokens")) total_tool_calls = from_union([from_none, from_int], obj.get("totalToolCalls")) @@ -7254,7 +9267,13 @@ def from_dict(obj: Any) -> "SubagentCompletedData": agent_display_name=agent_display_name, agent_name=agent_name, tool_call_id=tool_call_id, + cancelled=cancelled, + configured_model_matches_actual=configured_model_matches_actual, + configured_model_preference=configured_model_preference, duration=duration, + explicit_model_matches_preference=explicit_model_matches_preference, + explicit_model_override=explicit_model_override, + first_dispatched_model=first_dispatched_model, model=model, total_tokens=total_tokens, total_tool_calls=total_tool_calls, @@ -7265,8 +9284,20 @@ 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.configured_model_matches_actual is not None: + result["configuredModelMatchesActual"] = from_union([from_none, from_bool], self.configured_model_matches_actual) + if self.configured_model_preference is not None: + result["configuredModelPreference"] = from_union([from_none, from_str], self.configured_model_preference) if self.duration is not None: result["durationMs"] = from_union([from_none, to_timedelta_int], self.duration) + if self.explicit_model_matches_preference is not None: + result["explicitModelMatchesPreference"] = from_union([from_none, from_bool], self.explicit_model_matches_preference) + if self.explicit_model_override is not None: + result["explicitModelOverride"] = from_union([from_none, from_str], self.explicit_model_override) + if self.first_dispatched_model is not None: + result["firstDispatchedModel"] = from_union([from_none, from_str], self.first_dispatched_model) if self.model is not None: result["model"] = from_union([from_none, from_str], self.model) if self.total_tokens is not None: @@ -7276,6 +9307,39 @@ def to_dict(self) -> dict: return result +@dataclass +class SubagentConfiguredData: + "Resolved runtime configuration for a configured sub-agent" + model: str + multi_turn: bool + context_tier: str | None = None + reasoning_effort: str | None = None + + @staticmethod + def from_dict(obj: Any) -> "SubagentConfiguredData": + assert isinstance(obj, dict) + model = from_str(obj.get("model")) + multi_turn = from_bool(obj.get("multiTurn")) + context_tier = from_union([from_none, from_str], obj.get("contextTier")) + reasoning_effort = from_union([from_none, from_str], obj.get("reasoningEffort")) + return SubagentConfiguredData( + model=model, + multi_turn=multi_turn, + context_tier=context_tier, + reasoning_effort=reasoning_effort, + ) + + def to_dict(self) -> dict: + result: dict = {} + result["model"] = from_str(self.model) + result["multiTurn"] = from_bool(self.multi_turn) + if self.context_tier is not None: + result["contextTier"] = from_union([from_none, from_str], self.context_tier) + if self.reasoning_effort is not None: + result["reasoningEffort"] = from_union([from_none, from_str], self.reasoning_effort) + return result + + @dataclass class SubagentDeselectedData: "Empty payload; the event signals that the custom agent was deselected, returning to the default agent" @@ -7295,7 +9359,12 @@ class SubagentFailedData: agent_name: str error: str tool_call_id: str + configured_model_matches_actual: bool | None = None + configured_model_preference: str | None = None duration: timedelta | None = None + explicit_model_matches_preference: bool | None = None + explicit_model_override: str | None = None + first_dispatched_model: str | None = None model: str | None = None total_tokens: int | None = None total_tool_calls: int | None = None @@ -7307,7 +9376,12 @@ def from_dict(obj: Any) -> "SubagentFailedData": agent_name = from_str(obj.get("agentName")) error = from_str(obj.get("error")) tool_call_id = from_str(obj.get("toolCallId")) + configured_model_matches_actual = from_union([from_none, from_bool], obj.get("configuredModelMatchesActual")) + configured_model_preference = from_union([from_none, from_str], obj.get("configuredModelPreference")) duration = from_union([from_none, from_timedelta], obj.get("durationMs")) + explicit_model_matches_preference = from_union([from_none, from_bool], obj.get("explicitModelMatchesPreference")) + explicit_model_override = from_union([from_none, from_str], obj.get("explicitModelOverride")) + first_dispatched_model = from_union([from_none, from_str], obj.get("firstDispatchedModel")) model = from_union([from_none, from_str], obj.get("model")) total_tokens = from_union([from_none, from_int], obj.get("totalTokens")) total_tool_calls = from_union([from_none, from_int], obj.get("totalToolCalls")) @@ -7316,7 +9390,12 @@ def from_dict(obj: Any) -> "SubagentFailedData": agent_name=agent_name, error=error, tool_call_id=tool_call_id, + configured_model_matches_actual=configured_model_matches_actual, + configured_model_preference=configured_model_preference, duration=duration, + explicit_model_matches_preference=explicit_model_matches_preference, + explicit_model_override=explicit_model_override, + first_dispatched_model=first_dispatched_model, model=model, total_tokens=total_tokens, total_tool_calls=total_tool_calls, @@ -7328,8 +9407,18 @@ def to_dict(self) -> dict: result["agentName"] = from_str(self.agent_name) result["error"] = from_str(self.error) result["toolCallId"] = from_str(self.tool_call_id) + if self.configured_model_matches_actual is not None: + result["configuredModelMatchesActual"] = from_union([from_none, from_bool], self.configured_model_matches_actual) + if self.configured_model_preference is not None: + result["configuredModelPreference"] = from_union([from_none, from_str], self.configured_model_preference) if self.duration is not None: result["durationMs"] = from_union([from_none, to_timedelta_int], self.duration) + if self.explicit_model_matches_preference is not None: + result["explicitModelMatchesPreference"] = from_union([from_none, from_bool], self.explicit_model_matches_preference) + if self.explicit_model_override is not None: + result["explicitModelOverride"] = from_union([from_none, from_str], self.explicit_model_override) + if self.first_dispatched_model is not None: + result["firstDispatchedModel"] = from_union([from_none, from_str], self.first_dispatched_model) if self.model is not None: result["model"] = from_union([from_none, from_str], self.model) if self.total_tokens is not None: @@ -7373,7 +9462,12 @@ class SubagentStartedData: agent_display_name: str agent_name: str tool_call_id: str + agent_type: str | None = None + execution_mode: str | None = None + factory_run_id: str | None = None model: str | None = None + parent_id: str | None = None + resumable: bool | None = None @staticmethod def from_dict(obj: Any) -> "SubagentStartedData": @@ -7382,13 +9476,23 @@ def from_dict(obj: Any) -> "SubagentStartedData": agent_display_name = from_str(obj.get("agentDisplayName")) agent_name = from_str(obj.get("agentName")) tool_call_id = from_str(obj.get("toolCallId")) + agent_type = from_union([from_none, from_str], obj.get("agentType")) + execution_mode = from_union([from_none, from_str], obj.get("executionMode")) + factory_run_id = from_union([from_none, from_str], obj.get("factoryRunId")) model = from_union([from_none, from_str], obj.get("model")) + parent_id = from_union([from_none, from_str], obj.get("parentId")) + resumable = from_union([from_none, from_bool], obj.get("resumable")) return SubagentStartedData( agent_description=agent_description, agent_display_name=agent_display_name, agent_name=agent_name, tool_call_id=tool_call_id, + agent_type=agent_type, + execution_mode=execution_mode, + factory_run_id=factory_run_id, model=model, + parent_id=parent_id, + resumable=resumable, ) def to_dict(self) -> dict: @@ -7397,8 +9501,18 @@ 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.agent_type is not None: + result["agentType"] = from_union([from_none, from_str], self.agent_type) + if self.execution_mode is not None: + result["executionMode"] = from_union([from_none, from_str], self.execution_mode) + if self.factory_run_id is not None: + result["factoryRunId"] = from_union([from_none, from_str], self.factory_run_id) if self.model is not None: result["model"] = from_union([from_none, from_str], self.model) + if self.parent_id is not None: + result["parentId"] = from_union([from_none, from_str], self.parent_id) + if self.resumable is not None: + result["resumable"] = from_union([from_none, from_bool], self.resumable) return result @@ -7407,6 +9521,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 @@ -7415,11 +9530,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, ) @@ -7428,6 +9545,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: @@ -7468,6 +9587,7 @@ class SystemNotificationAgentCompleted: status: SystemNotificationAgentCompletedStatus type: ClassVar[str] = "agent_completed" description: str | None = None + display_name: str | None = None prompt: str | None = None @staticmethod @@ -7477,12 +9597,14 @@ def from_dict(obj: Any) -> "SystemNotificationAgentCompleted": agent_type = from_str(obj.get("agentType")) status = parse_enum(SystemNotificationAgentCompletedStatus, obj.get("status")) description = from_union([from_none, from_str], obj.get("description")) + display_name = from_union([from_none, from_str], obj.get("displayName")) prompt = from_union([from_none, from_str], obj.get("prompt")) return SystemNotificationAgentCompleted( agent_id=agent_id, agent_type=agent_type, status=status, description=description, + display_name=display_name, prompt=prompt, ) @@ -7494,6 +9616,8 @@ def to_dict(self) -> dict: result["type"] = self.type if self.description is not None: result["description"] = from_union([from_none, from_str], self.description) + if self.display_name is not None: + result["displayName"] = from_union([from_none, from_str], self.display_name) if self.prompt is not None: result["prompt"] = from_union([from_none, from_str], self.prompt) return result @@ -7506,6 +9630,7 @@ class SystemNotificationAgentIdle: agent_type: str type: ClassVar[str] = "agent_idle" description: str | None = None + display_name: str | None = None @staticmethod def from_dict(obj: Any) -> "SystemNotificationAgentIdle": @@ -7513,10 +9638,12 @@ def from_dict(obj: Any) -> "SystemNotificationAgentIdle": agent_id = from_str(obj.get("agentId")) agent_type = from_str(obj.get("agentType")) description = from_union([from_none, from_str], obj.get("description")) + display_name = from_union([from_none, from_str], obj.get("displayName")) return SystemNotificationAgentIdle( agent_id=agent_id, agent_type=agent_type, description=description, + display_name=display_name, ) def to_dict(self) -> dict: @@ -7526,6 +9653,8 @@ def to_dict(self) -> dict: result["type"] = self.type if self.description is not None: result["description"] = from_union([from_none, from_str], self.description) + if self.display_name is not None: + result["displayName"] = from_union([from_none, from_str], self.display_name) return result @@ -7552,6 +9681,66 @@ 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: "System notification metadata for an instruction file discovered during tool access, including source, trigger file, and tool." @@ -7676,6 +9865,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" @@ -7838,6 +10049,7 @@ class ToolExecutionCompleteContentShellExit: shell_id: str type: ClassVar[str] = "shell_exit" cwd: str | None = None + output_file_path: str | None = None output_preview: str | None = None output_truncated: bool | None = None @@ -7847,12 +10059,14 @@ def from_dict(obj: Any) -> "ToolExecutionCompleteContentShellExit": exit_code = from_int(obj.get("exitCode")) shell_id = from_str(obj.get("shellId")) cwd = from_union([from_none, from_str], obj.get("cwd")) + output_file_path = from_union([from_none, from_str], obj.get("outputFilePath")) 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_file_path=output_file_path, output_preview=output_preview, output_truncated=output_truncated, ) @@ -7864,6 +10078,8 @@ def to_dict(self) -> dict: result["type"] = self.type if self.cwd is not None: result["cwd"] = from_union([from_none, from_str], self.cwd) + if self.output_file_path is not None: + result["outputFilePath"] = from_union([from_none, from_str], self.output_file_path) 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: @@ -7898,6 +10114,8 @@ class ToolExecutionCompleteData: success: bool tool_call_id: str error: ToolExecutionCompleteError | None = None + # Experimental: this field is part of an experimental API and may change or be removed. + fusion: FusionAttribution | 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. @@ -7906,6 +10124,7 @@ class ToolExecutionCompleteData: # 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 @@ -7917,12 +10136,14 @@ def from_dict(obj: Any) -> "ToolExecutionCompleteData": success = from_bool(obj.get("success")) tool_call_id = from_str(obj.get("toolCallId")) error = from_union([from_none, ToolExecutionCompleteError.from_dict], obj.get("error")) + fusion = from_union([from_none, FusionAttribution.from_dict], obj.get("fusion")) 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")) @@ -7931,12 +10152,14 @@ def from_dict(obj: Any) -> "ToolExecutionCompleteData": success=success, tool_call_id=tool_call_id, error=error, + fusion=fusion, 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, @@ -7949,6 +10172,8 @@ def to_dict(self) -> dict: result["toolCallId"] = from_str(self.tool_call_id) if self.error is not None: result["error"] = from_union([from_none, lambda x: to_class(ToolExecutionCompleteError, x)], self.error) + if self.fusion is not None: + result["fusion"] = from_union([from_none, lambda x: to_class(FusionAttribution, x)], self.fusion) if self.interaction_id is not None: result["interactionId"] = from_union([from_none, from_str], self.interaction_id) if self.is_user_requested is not None: @@ -7961,6 +10186,8 @@ def to_dict(self) -> dict: 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: @@ -8391,11 +10618,14 @@ class ToolExecutionStartData: tool_name: str arguments: Any = None display_verbatim: bool | None = None + # Experimental: this field is part of an experimental API and may change or be removed. + fusion: FusionAttribution | 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 @@ -8407,10 +10637,12 @@ def from_dict(obj: Any) -> "ToolExecutionStartData": tool_name = from_str(obj.get("toolName")) arguments = obj.get("arguments") display_verbatim = from_union([from_none, from_bool], obj.get("displayVerbatim")) + fusion = from_union([from_none, FusionAttribution.from_dict], obj.get("fusion")) 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")) @@ -8419,10 +10651,12 @@ def from_dict(obj: Any) -> "ToolExecutionStartData": tool_name=tool_name, arguments=arguments, display_verbatim=display_verbatim, + fusion=fusion, 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, @@ -8436,6 +10670,8 @@ def to_dict(self) -> dict: result["arguments"] = self.arguments if self.display_verbatim is not None: result["displayVerbatim"] = from_union([from_none, from_bool], self.display_verbatim) + if self.fusion is not None: + result["fusion"] = from_union([from_none, lambda x: to_class(FusionAttribution, x)], self.fusion) 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: @@ -8444,6 +10680,8 @@ def to_dict(self) -> dict: 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: @@ -8458,21 +10696,27 @@ 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) -> "ToolExecutionStartShellToolInfo": assert isinstance(obj, dict) 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["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 @@ -8710,6 +10954,7 @@ class UserMessageData: source: str | None = None supported_native_document_mime_types: list[str] | None = None transformed_content: str | None = None + turn_id: str | None = None @staticmethod def from_dict(obj: Any) -> "UserMessageData": @@ -8725,6 +10970,7 @@ def from_dict(obj: Any) -> "UserMessageData": source = from_union([from_none, from_str], obj.get("source")) supported_native_document_mime_types = from_union([from_none, lambda x: from_list(from_str, x)], obj.get("supportedNativeDocumentMimeTypes")) transformed_content = from_union([from_none, from_str], obj.get("transformedContent")) + turn_id = from_union([from_none, from_str], obj.get("turnId")) return UserMessageData( content=content, agent_mode=agent_mode, @@ -8737,6 +10983,7 @@ def from_dict(obj: Any) -> "UserMessageData": source=source, supported_native_document_mime_types=supported_native_document_mime_types, transformed_content=transformed_content, + turn_id=turn_id, ) def to_dict(self) -> dict: @@ -8762,6 +11009,8 @@ def to_dict(self) -> dict: result["supportedNativeDocumentMimeTypes"] = from_union([from_none, lambda x: from_list(from_str, x)], self.supported_native_document_mime_types) if self.transformed_content is not None: result["transformedContent"] = from_union([from_none, from_str], self.transformed_content) + if self.turn_id is not None: + result["turnId"] = from_union([from_none, from_str], self.turn_id) return result @@ -8807,6 +11056,31 @@ def to_dict(self) -> dict: return result +@dataclass +class UserToolSessionApprovalExtensionEnvAccess: + "Session-scoped tool-approval rule for an extension's access to sensitive environment variables, keyed by extension name and the exact set of variable names." + environment_variables: list[str] + extension_name: str + kind: ClassVar[str] = "extension-env-access" + + @staticmethod + def from_dict(obj: Any) -> "UserToolSessionApprovalExtensionEnvAccess": + assert isinstance(obj, dict) + environment_variables = from_list(from_str, obj.get("environmentVariables")) + extension_name = from_str(obj.get("extensionName")) + return UserToolSessionApprovalExtensionEnvAccess( + environment_variables=environment_variables, + extension_name=extension_name, + ) + + def to_dict(self) -> dict: + result: dict = {} + result["environmentVariables"] = from_list(from_str, self.environment_variables) + result["extensionName"] = from_str(self.extension_name) + result["kind"] = self.kind + return result + + @dataclass class UserToolSessionApprovalExtensionManagement: "Session-scoped tool-approval rule for extension-management operations, optionally narrowed by operation." @@ -8850,6 +11124,28 @@ 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: "Session-scoped tool-approval rule for an MCP server tool, or all tools on the server when `toolName` is null." @@ -8935,6 +11231,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 @@ -8947,6 +11244,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( @@ -8956,6 +11254,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, ) @@ -8973,6 +11272,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: @@ -9026,7 +11327,9 @@ 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 "extension-env-access": return PermissionPromptRequestExtensionEnvAccess.from_dict(obj) case _: raise ValueError(f"Unknown PermissionPromptRequest kind: {kind!r}") @@ -9043,7 +11346,9 @@ 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 "extension-env-access": return PermissionRequestExtensionEnvAccess.from_dict(obj) case _: raise ValueError(f"Unknown PermissionRequest kind: {kind!r}") @@ -9073,6 +11378,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}") @@ -9101,7 +11408,9 @@ 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 "extension-env-access": return UserToolSessionApprovalExtensionEnvAccess.from_dict(obj) case _: raise ValueError(f"Unknown UserToolSessionApproval kind: {kind!r}") @@ -9118,11 +11427,11 @@ def _load_UserToolSessionApproval(obj: Any) -> "UserToolSessionApproval": # 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 | PermissionPromptRequestExtensionEnvAccess # 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 | PermissionRequestExtensionEnvAccess # Location within a cited source (character, page, or content-block range) that supports a span. @@ -9130,11 +11439,11 @@ def _load_UserToolSessionApproval(obj: Any) -> "UserToolSessionApproval": # 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 | UserToolSessionApprovalExtensionEnvAccess # The embedded resource contents, either text or base64-encoded binary @@ -9146,13 +11455,28 @@ def _load_UserToolSessionApproval(obj: Any) -> "UserToolSessionApproval": # 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)." +class AssistedApprovalJudgeFailureReason(Enum): + "Why the assisted-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 AssistedApprovalRecommendation(Enum): + "Outcome of the assisted-approval safety judge for a permission request. Present only in assisted mode; its absence means the judge did not evaluate the request." # 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. + # The judge evaluated the request and does not recommend automatically 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. + # Assisted mode is enabled, but this request category is never automatically 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" @@ -9170,14 +11494,115 @@ class CitationProvider(Enum): # Experimental: this enum is part of an experimental API and may change or be removed. -class PermissionAllowAllMode(Enum): - "Allow-all mode for the session." +class FusionConversationScope(Enum): + "Conversation scope in which a HydraFusion phase executes." + # Canonical root conversation history. + ROOT = "root" + # Isolated read-only review history that does not enter the root conversation. + REVIEW = "review" + + +# Experimental: this enum is part of an experimental API and may change or be removed. +class FusionFollowUpAction(Enum): + "Server-recommended routing behavior for a later HydraFusion turn." + # Reuse the durable primary model without routing. + REUSE_PRIMARY = "reuse_primary" + # Request a new routing decision. + REROUTE = "reroute" + + +# Experimental: this enum is part of an experimental API and may change or be removed. +class FusionPattern(Enum): + "Validated HydraFusion execution pattern." + # Run one primary solver phase. + SINGLE = "single" + # Run a primary phase, a judge, and an optional repair. + CASCADE = "cascade" + # Run a primary draft, a read-only critique, and a revision. + CRITIQUE = "critique" + + +# Experimental: this enum is part of an experimental API and may change or be removed. +class FusionPhaseKind(Enum): + "HydraFusion phase kind." + # Primary solver phase. + PRIMARY = "primary" + # Read-only cascade judge phase. + JUDGE = "judge" + # Cascade repair phase. + REPAIR = "repair" + # Initial critique-pattern draft phase. + DRAFT = "draft" + # Read-only critique phase. + CRITIC = "critic" + # Critique-pattern revision phase. + REVISION = "revision" + # Follow-up phase continuing from the resolved model. + FOLLOW_UP = "follow_up" + + +# Experimental: this enum is part of an experimental API and may change or be removed. +class FusionPhaseStatus(Enum): + "Durable outcome status of a HydraFusion phase." + # The phase completed successfully. + SUCCEEDED = "succeeded" + # The phase failed. + FAILED = "failed" + # The phase was cancelled. + CANCELLED = "cancelled" + + +# Experimental: this enum is part of an experimental API and may change or be removed. +class _FusionProjectionMode(Enum): + "How a durable phase checkpoint contributes its exact message to canonical root history." + # Append the exact root message immediately. + APPEND = "append" + # Hold a terminal message outside canonical history until the final commit selects it. + STAGED = "staged" + # Do not project the checkpoint into root history. + NONE = "none" + + +# Experimental: this enum is part of an experimental API and may change or be removed. +class FusionTurnKind(Enum): + "Kind of turn for which HydraFusion routing is running." + # A user-message turn. + USER = "user" + # A conversation-compaction turn. + COMPACTION = "compaction" + + +# Experimental: this enum is part of an experimental API and may change or be removed. +class PermissionMode(Enum): + "Permission mode for the session." # Permission requests follow the normal approval flow. - OFF = "off" + MANUAL = "manual" + # Permission requests include an LLM safety recommendation; clients may automatically approve requests judged acceptable. + ASSISTED = "assisted" # 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" + ALLOW_ALL = "allow-all" + + +# Experimental: this enum is part of an experimental API and may change or be removed. +class PermissionRecommendation(Enum): + "Advisory recommendation the runtime attaches to a permission request whose origin it can vouch for by construction. Unlike the auto-approval judge this does not depend on auto mode and does not evaluate what the tool call does; its absence simply means the runtime has no opinion and the request follows the host's normal approval flow." + # The runtime vouches for the request's origin and recommends approving it without prompting. The host still owns the decision and may deny it; deny rules, managed policy, and the auto-approval safety judge all outrank this recommendation. + APPROVE = "approve" + + +# Experimental: this enum is part of an experimental API and may change or be removed. +class UIEphemeralQueryPhase(Enum): + "Lifecycle phase for a Rust-owned ephemeral query stream." + # The ephemeral query stream has begun. + STARTED = "started" + # A partial result chunk was produced by the stream. + CHUNK = "chunk" + # The ephemeral query stream finished successfully. + COMPLETED = "completed" + # The ephemeral query stream ended with an error. + FAILED = "failed" + # The ephemeral query stream was cancelled before completing. + ABORTED = "aborted" class AbortReason(Enum): @@ -9188,6 +11613,28 @@ 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 AgentInterruptedActivity(Enum): + "What the agent was doing when the user interrupted it." + # A request to the model was open. + MODEL_CALL = "model_call" + # The turn was sleeping between retry attempts. + RETRY_BACKOFF = "retry_backoff" + # One or more tools were executing. + TOOL_CALL = "tool_call" + # Background sub-agents were running while the main loop was idle. + BACKGROUND_AGENT = "background_agent" + + +class AgentInterruptedCancelPhase(Enum): + "Where the interruption landed relative to the first streamed token." + # No output had been produced when the request was cancelled. + PRE_FIRST_TOKEN = "pre_first_token" + # The response was already streaming when the request was cancelled. + MID_STREAM = "mid_stream" class AssistantMessageToolRequestType(Enum): @@ -9210,6 +11657,14 @@ class AssistantUsageApiEndpoint(Enum): WS_RESPONSES = "ws:/responses" +class AssistantUsageTransport(Enum): + "Transport used for a successful model call" + # HTTP transport, including SSE streams. + HTTP = "http" + # WebSocket transport. + WEBSOCKET = "websocket" + + class AttachmentGitHubReferenceType(Enum): "Type of GitHub reference" # GitHub issue reference. @@ -9278,6 +11733,20 @@ class BinaryAssetType(Enum): 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. @@ -9340,6 +11809,26 @@ 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 FactoryRunSettledStatus(Enum): + "Terminal status a factory run committed. A settled run is never `pending` or `running`, so those two members of the run-status domain are deliberately absent." + # The factory body resolved and its result was committed. + COMPLETED = "completed" + # The run was stopped by a limit, an approval refusal or another policy decision. + HALTED = "halted" + # The run was cancelled by its caller or by session disposal. + CANCELLED = "cancelled" + # The run failed, with `failureType` carrying the class when it has one. + ERROR = "error" + + class HandoffSourceType(Enum): "Origin type of the session being handed off" # The handoff originated from a remote session. @@ -9356,25 +11845,31 @@ class ManagedSettingsEnforcedAction(Enum): 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. + # Full allow-all permissions β€” automatically approving tools, paths, and URLs. ALLOW_ALL = "allow_all" - # Auto-approval of all tool permission requests. + # Automatic 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" + # Assisted mode β€” keeps normal prompt paths and adds an LLM recommendation, distinct from allow-all. + ASSISTED_APPROVAL = "assisted_approval" # Unrestricted filesystem access outside the session's allowed directories. UNRESTRICTED_PATHS = "unrestricted_paths" # Unrestricted URL fetch access. UNRESTRICTED_URLS = "unrestricted_urls" + # A server-wide MCP "Always Allow" (or `--allow-tool `) blanket that would auto-approve every tool from an MCP server. Capped to per-tool approval; each tool still prompts. + SERVER_WIDE_MCP_APPROVAL = "server_wide_mcp_approval" class ManagedSettingsResolvedSource(Enum): - "Which channel supplied the effective enterprise managed settings (highest-authority present layer wins wholesale)" - # Account/org policy self-fetched from the GitHub managed-settings endpoint (higher authority). + "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" - # Device-level MDM policy discovered from plist/registry/file (lower authority). + # Only the device MDM/plist/registry/file channel contributed. DEVICE = "device" - # No managed policy is in force (no layer contributed). + # 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" @@ -9431,7 +11926,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. @@ -9442,6 +11937,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" @@ -9492,6 +11989,44 @@ class ModelCallFailureTransport(Enum): WEBSOCKET = "websocket" +class ModelCallFinishedOutcome(Enum): + "Final outcome of one logical model dispatch after response acceptance processing" + # The provider response was accepted for continued agent processing. + SUCCESS = "success" + # The dispatch ended with a provider or transport error. + ERROR = "error" + # The dispatch was cancelled before an accepted response was produced. + CANCELLED = "cancelled" + # The provider response was rejected during post-response acceptance processing. + REJECTED = "rejected" + + +class ModelChangeSource(Enum): + "Origin of an effective session model change." + # The user selected a model directly with `/model `. + MODEL_COMMAND = "model_command" + # The user selected the model with `/settings`. + SETTINGS_COMMAND = "settings_command" + # The user selected the model with the `/config` alias. + CONFIG_COMMAND = "config_command" + # The user selected the model in the model picker, including the picker opened by bare `/model`. + MODEL_PICKER = "model_picker" + # Organization-managed settings selected the model. + MANAGED_SETTINGS = "managed_settings" + # Repository settings selected the model. + REPO_SETTINGS = "repo_settings" + # Startup model resolution selected the model. + STARTUP = "startup" + # Selecting an agent selected its configured model. + AGENT = "agent" + # Entering, leaving, or reconfiguring plan mode selected the model. + PLAN_MODE = "plan_mode" + # The runtime selected the model automatically, such as rate-limit recovery or refusal fallback. + AUTOMATIC = "automatic" + # An SDK or RPC caller selected the model. + SDK = "sdk" + + 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. @@ -9534,6 +12069,14 @@ class PermissionRequestMemoryDirection(Enum): DOWNVOTE = "downvote" +class PermissionRequestMemoryScope(Enum): + "Scope of a stored memory." + # Store the memory for the current repository. + REPOSITORY = "repository" + # Store the memory for the current user. + USER = "user" + + class PersistedBinaryImageType(Enum): "Binary result type discriminator. Use \"image\" for images and \"resource\" for other binary data." # Binary image data. @@ -9562,6 +12105,14 @@ 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. @@ -9636,6 +12187,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. @@ -9708,7 +12281,7 @@ class WorkspaceFileChangedOperation(Enum): UPDATE = "update" -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 | 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 | SessionSkillsLoadedData | SessionCustomAgentsUpdatedData | SessionMcpServersLoadedData | SessionMcpServerStatusChangedData | McpToolsListChangedData | McpResourcesListChangedData | McpPromptsListChangedData | SessionExtensionsLoadedData | SessionCanvasOpenedData | SessionCanvasRegistryChangedData | SessionCanvasClosedData | SessionCanvasUnavailableData | SessionCanvasRecordedData | SessionCanvasRemovedData | SessionExtensionsAttachmentsPushedData | 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 | SessionFusionRouteStartedData | SessionFusionRouteFailedData | SessionFusionResolvedData | SessionFusionCompletedData | UserMessageData | PendingMessagesModifiedData | AssistantTurnStartData | AssistantTurnRetryData | AgentInterruptedData | AssistantIntentData | AssistantFusionPhaseStartedData | AssistantFusionPhaseCompletedData | AssistantFusionPhaseFailedData | AssistantServerToolProgressData | AssistantReasoningData | AssistantReasoningDeltaData | AssistantToolCallDeltaData | AssistantStreamingDeltaData | AssistantMessageData | AssistantMessageStartData | AssistantMessageDeltaData | AssistantTurnEndData | AssistantIdleData | AssistantUsageData | PromptCacheBreakData | ModelCallFailureData | ModelCallFinishedData | ModelCallStartData | AbortData | ToolUserRequestedData | ToolExecutionStartData | ToolExecutionPartialResultData | ToolExecutionProgressData | ToolExecutionCompleteData | ToolSearchActivatedData | SkillInvokedData | SandboxDecisionData | SubagentStartedData | SubagentConfiguredData | SubagentCompletedData | SubagentFailedData | SubagentSelectedData | SubagentDeselectedData | HookStartData | HookEndData | HookProgressData | SessionBinaryAssetData | SystemMessageData | SystemNotificationData | PermissionRequestedData | PermissionCompletedData | UserInputRequestedData | UserInputCompletedData | ElicitationRequestedData | ElicitationCompletedData | SamplingRequestedData | SamplingCompletedData | McpOauthRequiredData | McpOauthCompletedData | McpHeadersRefreshRequiredData | McpHeadersRefreshCompletedData | SessionCustomNotificationData | UiEphemeralQueryData | ExternalToolRequestedData | ExternalToolCompletedData | CommandQueuedData | CommandExecuteData | CommandCompletedData | AutoModeSwitchRequestedData | AutoModeSwitchCompletedData | SessionLimitsExhaustedRequestedData | SessionLimitsExhaustedCompletedData | SessionAutoModeResolvedData | SessionManagedSettingsResolvedData | SessionManagedSettingsEnforcedData | CommandsChangedData | CapabilitiesChangedData | ExitPlanModeRequestedData | ExitPlanModeCompletedData | SessionToolsUpdatedData | SessionBackgroundTasksChangedData | FactoryRunUpdatedData | FactoryRunStartedData | FactoryRunSettledData | SessionSkillsLoadedData | SessionCustomAgentsUpdatedData | SessionMcpServersLoadedData | SessionMcpServerStatusChangedData | McpToolsListChangedData | McpResourcesListChangedData | McpPromptsListChangedData | SessionExtensionsLoadedData | SessionCanvasOpenedData | SessionCanvasRegistryChangedData | SessionCanvasClosedData | SessionCanvasUnavailableData | SessionCanvasRecordedData | SessionCanvasRemovedData | SessionExtensionsAttachmentsPushedData | McpAppToolCallCompleteData | RawSessionEventData | Data @dataclass @@ -9760,14 +12333,23 @@ def from_dict(obj: Any) -> "SessionEvent": 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.SESSION_FUSION_ROUTE_STARTED: data = SessionFusionRouteStartedData.from_dict(data_obj) + case SessionEventType.SESSION_FUSION_ROUTE_FAILED: data = SessionFusionRouteFailedData.from_dict(data_obj) + case SessionEventType.SESSION_FUSION_RESOLVED: data = SessionFusionResolvedData.from_dict(data_obj) + case SessionEventType.SESSION_FUSION_COMPLETED: data = SessionFusionCompletedData.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.AGENT_INTERRUPTED: data = AgentInterruptedData.from_dict(data_obj) case SessionEventType.ASSISTANT_INTENT: data = AssistantIntentData.from_dict(data_obj) + case SessionEventType.ASSISTANT_FUSION_PHASE_STARTED: data = AssistantFusionPhaseStartedData.from_dict(data_obj) + case SessionEventType.ASSISTANT_FUSION_PHASE_COMPLETED: data = AssistantFusionPhaseCompletedData.from_dict(data_obj) + case SessionEventType.ASSISTANT_FUSION_PHASE_FAILED: data = AssistantFusionPhaseFailedData.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) @@ -9779,7 +12361,9 @@ def from_dict(obj: Any) -> "SessionEvent": 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.PROMPT_CACHE_BREAK: data = PromptCacheBreakData.from_dict(data_obj) case SessionEventType.MODEL_CALL_FAILURE: data = ModelCallFailureData.from_dict(data_obj) + case SessionEventType.MODEL_CALL_FINISHED: data = ModelCallFinishedData.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) @@ -9789,7 +12373,9 @@ def from_dict(obj: Any) -> "SessionEvent": 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.SANDBOX_DECISION: data = SandboxDecisionData.from_dict(data_obj) case SessionEventType.SUBAGENT_STARTED: data = SubagentStartedData.from_dict(data_obj) + case SessionEventType.SUBAGENT_CONFIGURED: data = SubagentConfiguredData.from_dict(data_obj) case SessionEventType.SUBAGENT_COMPLETED: data = SubagentCompletedData.from_dict(data_obj) case SessionEventType.SUBAGENT_FAILED: data = SubagentFailedData.from_dict(data_obj) case SessionEventType.SUBAGENT_SELECTED: data = SubagentSelectedData.from_dict(data_obj) @@ -9813,6 +12399,7 @@ def from_dict(obj: Any) -> "SessionEvent": 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.UI_EPHEMERAL_QUERY: data = UiEphemeralQueryData.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) case SessionEventType.COMMAND_QUEUED: data = CommandQueuedData.from_dict(data_obj) @@ -9831,6 +12418,9 @@ def from_dict(obj: Any) -> "SessionEvent": 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.FACTORY_RUN_STARTED: data = FactoryRunStartedData.from_dict(data_obj) + case SessionEventType.FACTORY_RUN_SETTLED: data = FactoryRunSettledData.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) @@ -9883,10 +12473,17 @@ def session_event_to_dict(x: SessionEvent) -> Any: __all__ = [ "AbortData", "AbortReason", + "AgentInterruptedActivity", + "AgentInterruptedCancelPhase", + "AgentInterruptedData", + "AssistantFusionPhaseCompletedData", + "AssistantFusionPhaseFailedData", + "AssistantFusionPhaseStartedData", "AssistantIdleData", "AssistantIntentData", "AssistantMessageData", "AssistantMessageDeltaData", + "AssistantMessageReasoningBlocks", "AssistantMessageServerTools", "AssistantMessageStartData", "AssistantMessageToolRequest", @@ -9903,6 +12500,9 @@ def session_event_to_dict(x: SessionEvent) -> Any: "AssistantUsageCopilotUsage", "AssistantUsageCopilotUsageTokenDetail", "AssistantUsageData", + "AssistantUsageTransport", + "AssistedApprovalJudgeFailureReason", + "AssistedApprovalRecommendation", "Attachment", "AttachmentBlob", "AttachmentDirectory", @@ -9926,7 +12526,6 @@ def session_event_to_dict(x: SessionEvent) -> Any: "AttachmentSelectionDetails", "AttachmentSelectionDetailsEnd", "AttachmentSelectionDetailsStart", - "AutoApprovalRecommendation", "AutoModeResolvedReasoningBucket", "AutoModeSwitchCompletedData", "AutoModeSwitchRequestedData", @@ -9957,6 +12556,7 @@ def session_event_to_dict(x: SessionEvent) -> Any: "CommandsChangedData", "CompactionCompleteCompactionTokensUsed", "CompactionCompleteCompactionTokensUsedCopilotUsageTokenDetail", + "CompactionTrigger", "ContextTier", "CustomAgentsUpdatedAgent", "Data", @@ -9975,6 +12575,23 @@ def session_event_to_dict(x: SessionEvent) -> Any: "ExtensionsLoadedExtensionStatus", "ExternalToolCompletedData", "ExternalToolRequestedData", + "FactoryPermissionOperation", + "FactoryPermissionPhase", + "FactoryRunSettledData", + "FactoryRunSettledStatus", + "FactoryRunStartedData", + "FactoryRunUpdatedData", + "FusionAttribution", + "FusionConversationScope", + "FusionFollowUpAction", + "FusionFollowUpRecommendation", + "FusionPattern", + "FusionPhaseKind", + "FusionPhaseStatus", + "FusionPhaseUsage", + "FusionScores", + "FusionTurnKind", + "GitHubMcpToolConfig", "GitHubRepoRef", "HandoffRepository", "HandoffSourceType", @@ -10014,16 +12631,18 @@ def session_event_to_dict(x: SessionEvent) -> Any: "ModelCallFailureRequestFingerprint", "ModelCallFailureSource", "ModelCallFailureTransport", + "ModelCallFinishedData", + "ModelCallFinishedOutcome", "ModelCallStartData", + "ModelChangeSource", "OmittedBinaryOmittedReason", "OmittedBinaryResult", "OmittedBinaryType", "PendingMessagesModifiedData", - "PermissionAllowAllMode", "PermissionApproved", "PermissionApprovedForLocation", "PermissionApprovedForSession", - "PermissionAutoApproval", + "PermissionAssistedApproval", "PermissionCancelled", "PermissionCompletedData", "PermissionDeniedByContentExclusionPolicy", @@ -10031,11 +12650,14 @@ def session_event_to_dict(x: SessionEvent) -> Any: "PermissionDeniedByRules", "PermissionDeniedInteractivelyByUser", "PermissionDeniedNoApprovalRuleAndCouldNotRequestFromUser", + "PermissionMode", "PermissionPromptRequest", "PermissionPromptRequestCommands", "PermissionPromptRequestCustomTool", + "PermissionPromptRequestExtensionEnvAccess", "PermissionPromptRequestExtensionManagement", "PermissionPromptRequestExtensionPermissionAccess", + "PermissionPromptRequestFactory", "PermissionPromptRequestHook", "PermissionPromptRequestMcp", "PermissionPromptRequestMemory", @@ -10044,18 +12666,23 @@ def session_event_to_dict(x: SessionEvent) -> Any: "PermissionPromptRequestRead", "PermissionPromptRequestUrl", "PermissionPromptRequestWrite", + "PermissionRecommendation", "PermissionRequest", "PermissionRequestCustomTool", + "PermissionRequestExtensionEnvAccess", "PermissionRequestExtensionManagement", "PermissionRequestExtensionPermissionAccess", + "PermissionRequestFactory", "PermissionRequestHook", "PermissionRequestMcp", "PermissionRequestMemory", "PermissionRequestMemoryAction", "PermissionRequestMemoryDirection", + "PermissionRequestMemoryScope", "PermissionRequestRead", "PermissionRequestShell", "PermissionRequestShellCommand", + "PermissionRequestShellCommandSegment", "PermissionRequestShellPossibleUrl", "PermissionRequestUrl", "PermissionRequestWrite", @@ -10066,10 +12693,13 @@ def session_event_to_dict(x: SessionEvent) -> Any: "PersistedBinaryImageType", "PersistedBinaryResult", "PlanChangedOperation", + "PromptCacheBreakData", "RawSessionEventData", "ReasoningSummary", "SamplingCompletedData", "SamplingRequestedData", + "SandboxDecisionData", + "ScheduleOrigin", "SessionAutoModeResolvedData", "SessionAutopilotObjectiveChangedData", "SessionBackgroundTasksChangedData", @@ -10083,6 +12713,7 @@ def session_event_to_dict(x: SessionEvent) -> Any: "SessionCompactionCompleteData", "SessionCompactionStartData", "SessionContextChangedData", + "SessionContextClearedData", "SessionCustomAgentsUpdatedData", "SessionCustomNotificationData", "SessionErrorData", @@ -10091,6 +12722,10 @@ def session_event_to_dict(x: SessionEvent) -> Any: "SessionEventType", "SessionExtensionsAttachmentsPushedData", "SessionExtensionsLoadedData", + "SessionFusionCompletedData", + "SessionFusionResolvedData", + "SessionFusionRouteFailedData", + "SessionFusionRouteStartedData", "SessionHandoffData", "SessionIdleData", "SessionInfoData", @@ -10127,6 +12762,7 @@ def session_event_to_dict(x: SessionEvent) -> Any: "SessionUsageInfoData", "SessionWarningData", "SessionWorkspaceFileChangedData", + "ShutdownAgentMetric", "ShutdownCodeChanges", "ShutdownModelMetric", "ShutdownModelMetricRequests", @@ -10139,6 +12775,7 @@ def session_event_to_dict(x: SessionEvent) -> Any: "SkillSource", "SkillsLoadedSkill", "SubagentCompletedData", + "SubagentConfiguredData", "SubagentDeselectedData", "SubagentFailedData", "SubagentSelectedData", @@ -10151,10 +12788,14 @@ def session_event_to_dict(x: SessionEvent) -> Any: "SystemNotificationAgentCompletedStatus", "SystemNotificationAgentIdle", "SystemNotificationData", + "SystemNotificationFactoryCompleted", + "SystemNotificationFactoryCompletedStatus", "SystemNotificationInstructionDiscovered", "SystemNotificationNewInboxMessage", "SystemNotificationShellCompleted", "SystemNotificationShellDetachedCompleted", + "SystemNotificationUnclassified", + "TaskCompletionOutcome", "ToolExecutionCompleteContent", "ToolExecutionCompleteContentAudio", "ToolExecutionCompleteContentImage", @@ -10192,6 +12833,8 @@ def session_event_to_dict(x: SessionEvent) -> Any: "ToolExecutionStartToolDescriptionMetaUIVisibility", "ToolSearchActivatedData", "ToolUserRequestedData", + "UIEphemeralQueryPhase", + "UiEphemeralQueryData", "UserInputCompletedData", "UserInputRequestedData", "UserMessageAgentMode", @@ -10200,8 +12843,10 @@ def session_event_to_dict(x: SessionEvent) -> Any: "UserToolSessionApproval", "UserToolSessionApprovalCommands", "UserToolSessionApprovalCustomTool", + "UserToolSessionApprovalExtensionEnvAccess", "UserToolSessionApprovalExtensionManagement", "UserToolSessionApprovalExtensionPermissionAccess", + "UserToolSessionApprovalFactory", "UserToolSessionApprovalMcp", "UserToolSessionApprovalMemory", "UserToolSessionApprovalRead", diff --git a/python/copilot/rpc.py b/python/copilot/rpc.py index 73c3d976d3..5585d8ce7a 100644 --- a/python/copilot/rpc.py +++ b/python/copilot/rpc.py @@ -7,7 +7,12 @@ """ from .generated.rpc import * # noqa: F401, F403 +from .generated.rpc import ( + BuiltinToolInputSchemaType as UIElicitationSchemaType, # noqa: F401 +) from .generated.rpc import ( SessionFsReaddirWithTypesEntryType as SessionFSReaddirWithTypesEntryType, # noqa: F401 ) -from .generated.rpc import __all__ # noqa: F401 +from .generated.rpc import __all__ as _generated_all + +__all__ = [*_generated_all, "UIElicitationSchemaType"] diff --git a/python/copilot/session.py b/python/copilot/session.py index d9fc04dcef..78afdde139 100644 --- a/python/copilot/session.py +++ b/python/copilot/session.py @@ -27,24 +27,22 @@ from ._telemetry import get_trace_context, trace_context from .canvas import CanvasError, CanvasHandler, OpenCanvasInstance from .generated.rpc import ( - CanvasHandler as RpcCanvasHandler, -) -from .generated.rpc import ( + BuiltinToolInputSchemaType, CanvasProviderCloseRequest, CanvasProviderInvokeActionRequest, CanvasProviderOpenRequest, CanvasProviderOpenResult, ClientSessionApiHandlers, CommandsHandlePendingCommandRequest, - ExternalToolTextResultForLlm, + GitHubTokenAcquireResultKind, HandlePendingToolCallRequest, LogRequest, MCPOauthHandlePendingRequest, MCPOauthPendingRequestResponse, - MCPOauthPendingRequestResponseKind, ModelSwitchToRequest, PermissionDecision, PermissionDecisionApproveOnce, + PermissionDecisionContext, PermissionDecisionRequest, PermissionDecisionUserNotAvailable, ProviderTokenAcquireRequest, @@ -57,9 +55,11 @@ UIElicitationSchema, UIElicitationSchemaProperty, UIElicitationSchemaPropertyType, - UIElicitationSchemaType, UIHandlePendingElicitationRequest, ) +from .generated.rpc import ( + CanvasHandler as RpcCanvasHandler, +) from .generated.rpc import ( ContextTier as _RpcContextTier, ) @@ -78,12 +78,19 @@ SessionErrorData, SessionEvent, SessionIdleData, + SessionMode, session_event_from_dict, ) 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__) @@ -164,7 +171,7 @@ def _capabilities_to_dict(caps: ModelCapabilitiesOverride) -> dict: return result -ReasoningEffort = Literal["low", "medium", "high", "xhigh"] +ReasoningEffort = Literal["low", "medium", "high", "xhigh", "max"] ReasoningSummary = Literal["none", "concise", "detailed"] ContextTier = Literal["default", "long_context"] SessionFsConventions = Literal["posix", "windows"] @@ -342,12 +349,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" @@ -355,24 +361,74 @@ 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() @@ -706,7 +762,7 @@ async def confirm(self, message: str) -> bool: UIElicitationRequest( message=message, requested_schema=UIElicitationSchema( - type=UIElicitationSchemaType.OBJECT, + type=BuiltinToolInputSchemaType.OBJECT, properties={ "confirmed": UIElicitationSchemaProperty( type=UIElicitationSchemaPropertyType.BOOLEAN, @@ -741,7 +797,7 @@ async def select(self, message: str, options: list[str]) -> str | None: UIElicitationRequest( message=message, requested_schema=UIElicitationSchema( - type=UIElicitationSchemaType.OBJECT, + type=BuiltinToolInputSchemaType.OBJECT, properties={ "selection": UIElicitationSchemaProperty( type=UIElicitationSchemaPropertyType.STRING, @@ -943,6 +999,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""" @@ -1049,6 +1127,7 @@ 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 @@ -1084,6 +1163,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 # ============================================================================ @@ -1449,7 +1544,12 @@ 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, + on_disconnect: Callable[[], None] | None = None, ): """ Initialize a new CopilotSession. @@ -1463,8 +1563,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() @@ -1499,6 +1602,17 @@ def __init__( self._open_canvases_lock = threading.Lock() self._rpc: SessionRpc | None = None self._destroyed = False + self._on_disconnect = on_disconnect + + def _set_disconnect_callback(self, callback: Callable[[], None]) -> None: + """Set the client-owned cleanup callback before the session becomes active.""" + self._on_disconnect = callback + + def _run_disconnect_callback(self) -> None: + callback = self._on_disconnect + self._on_disconnect = None + if callback is not None: + callback() @property def rpc(self) -> SessionRpc: @@ -1680,7 +1794,7 @@ def handler(event: SessionEventTypeAlias) -> None: total_start, session_id=self.session_id, ) - case SessionIdleData(): + case SessionIdleData() as data if data.mode != SessionMode.AUTOPILOT: log_timing( logger, logging.DEBUG, @@ -2063,13 +2177,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_references=tool_result.tool_references, - tool_telemetry=tool_result.tool_telemetry, - ), + result=tool_result_to_external_tool_text_result_for_llm(tool_result), ) ) log_timing( @@ -2102,7 +2210,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( @@ -2114,7 +2228,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 @@ -2123,6 +2241,7 @@ async def _execute_permission_and_respond( PermissionDecisionRequest( request_id=request_id, result=result, + decision_context=decision_context, ) ) log_timing( @@ -2134,6 +2253,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( @@ -2169,14 +2292,14 @@ async def _execute_mcp_auth_and_respond( if result and result.get("kind", "token") == "token": rpc_result = MCPOauthPendingRequestResponse( - kind=MCPOauthPendingRequestResponseKind.TOKEN, + kind=GitHubTokenAcquireResultKind.TOKEN, access_token=result["accessToken"], expires_in=result.get("expiresIn"), token_type=result.get("tokenType"), ) else: rpc_result = MCPOauthPendingRequestResponse( - kind=MCPOauthPendingRequestResponseKind.CANCELLED + kind=GitHubTokenAcquireResultKind.CANCELLED ) await self.rpc.mcp.oauth.handle_pending_request( MCPOauthHandlePendingRequest( @@ -2190,7 +2313,7 @@ async def _execute_mcp_auth_and_respond( MCPOauthHandlePendingRequest( request_id=request_id, result=MCPOauthPendingRequestResponse( - kind=MCPOauthPendingRequestResponseKind.CANCELLED + kind=GitHubTokenAcquireResultKind.CANCELLED ), ) ) @@ -2528,7 +2651,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( @@ -2538,11 +2667,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, ) @@ -2744,6 +2876,7 @@ 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"), @@ -2853,6 +2986,7 @@ async def disconnect(self) -> None: try: await self._client.request("session.destroy", {"sessionId": self.session_id}) finally: + self._run_disconnect_callback() # Clear handlers even if the request fails. with self._event_handlers_lock: self._event_handlers.clear() @@ -2926,7 +3060,7 @@ async def set_model( Args: 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. diff --git a/python/copilot/session_fs_provider.py b/python/copilot/session_fs_provider.py index 355724da48..c9e90a6442 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 b96e303e3b..ad0bcb41bd 100644 --- a/python/copilot/tools.py +++ b/python/copilot/tools.py @@ -11,13 +11,23 @@ import json from collections.abc import Awaitable, Callable from dataclasses import dataclass, field +from datetime import date, datetime, time +from decimal import Decimal +from enum import Enum from typing import TYPE_CHECKING, Any, Literal, TypeVar, get_type_hints, overload +from uuid import UUID 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"] @@ -76,6 +86,11 @@ class Tool: 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) @@ -91,6 +106,7 @@ def define_tool( 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 @@ -106,6 +122,7 @@ def define_tool( skip_permission: bool = False, defer: Literal["auto", "never"] | None = None, metadata: dict[str, Any] | None = None, + is_terminal: bool = False, ) -> Tool: pass @@ -121,6 +138,7 @@ def define_tool( skip_permission: bool = False, defer: Literal["auto", "never"] | None = None, metadata: dict[str, Any] | None = None, + is_terminal: bool = False, ) -> Tool: pass @@ -135,6 +153,7 @@ def define_tool( 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. @@ -187,6 +206,10 @@ def lookup_issue(params: LookupIssueParams) -> str: 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 @@ -282,6 +305,7 @@ async def wrapped_handler(invocation: ToolInvocation) -> ToolResult: skip_permission=skip_permission, defer=defer, metadata=metadata, + is_terminal=is_terminal, ) # If handler is provided, call decorator immediately @@ -302,6 +326,7 @@ async def wrapped_handler(invocation: ToolInvocation) -> ToolResult: skip_permission=skip_permission, defer=defer, metadata=metadata, + is_terminal=is_terminal, ) # Otherwise return decorator for @define_tool(...) usage @@ -342,10 +367,18 @@ def _normalize_result(result: Any) -> ToolResult: result_type="success", ) - # Everything else gets JSON-serialized (with Pydantic model support) + # Everything else gets JSON-serialized (with common Python and Pydantic values) def default(obj: Any) -> Any: if isinstance(obj, BaseModel): - return obj.model_dump() + return obj.model_dump(mode="json") + if isinstance(obj, (date, datetime, time)): + return obj.isoformat() + if isinstance(obj, (Decimal, UUID)): + return str(obj) + if isinstance(obj, Enum): + return obj.value + if isinstance(obj, set): + return list(obj) raise TypeError(f"Object of type {type(obj).__name__} is not JSON serializable") try: @@ -408,3 +441,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/test_client_options_e2e.py b/python/e2e/test_client_options_e2e.py index bca4dbb722..fe1ed54820 100644 --- a/python/e2e/test_client_options_e2e.py +++ b/python/e2e/test_client_options_e2e.py @@ -164,6 +164,10 @@ def _get_available_port() -> int: }); return; } + if (message.method === "session.options.update") { + writeResponse(message.id, { success: true }); + return; + } writeResponse(message.id, {}); } @@ -284,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) @@ -295,8 +301,72 @@ 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() diff --git a/python/e2e/test_hooks_extended_e2e.py b/python/e2e/test_hooks_extended_e2e.py index b38534ea22..7af20f32bb 100644 --- a/python/e2e/test_hooks_extended_e2e.py +++ b/python/e2e/test_hooks_extended_e2e.py @@ -3,7 +3,8 @@ 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_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. @@ -48,6 +49,32 @@ async def on_user_prompt_submitted(input_data, invocation): 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] = [] diff --git a/python/e2e/test_mcp_and_agents_e2e.py b/python/e2e/test_mcp_and_agents_e2e.py index e583dbdd78..6f443a970c 100644 --- a/python/e2e/test_mcp_and_agents_e2e.py +++ b/python/e2e/test_mcp_and_agents_e2e.py @@ -99,7 +99,6 @@ async def test_should_accept_mcp_server_configuration_on_session_resume( on_permission_request=PermissionHandler.approve_all ) session_id = session1.session_id - await session1.send_and_wait("What is 1+1?") # Resume with MCP servers mcp_servers = _test_mcp_servers("test-server") diff --git a/python/e2e/test_mcp_oauth_e2e.py b/python/e2e/test_mcp_oauth_e2e.py index 9d70597c3e..76f1cbf721 100644 --- a/python/e2e/test_mcp_oauth_e2e.py +++ b/python/e2e/test_mcp_oauth_e2e.py @@ -8,11 +8,11 @@ import pytest from copilot.generated.rpc import ( + GitHubTokenAcquireResultKind, MCPAppsCallToolRequest, MCPListToolsRequest, MCPOauthHandlePendingRequest, MCPOauthPendingRequestResponse, - MCPOauthPendingRequestResponseKind, ) from copilot.session import MCPServerConfig, PermissionHandler from copilot.session_events import McpServerStatus @@ -206,7 +206,7 @@ async def on_mcp_auth_request(request, _invocation): MCPOauthHandlePendingRequest( request_id=request["requestId"], result=MCPOauthPendingRequestResponse( - kind=MCPOauthPendingRequestResponseKind.TOKEN, + kind=GitHubTokenAcquireResultKind.TOKEN, access_token=EXPECTED_TOKEN, token_type="Bearer", expires_in=3600, diff --git a/python/e2e/test_pending_work_resume_e2e.py b/python/e2e/test_pending_work_resume_e2e.py index 64c06c0421..5b6d978f31 100644 --- a/python/e2e/test_pending_work_resume_e2e.py +++ b/python/e2e/test_pending_work_resume_e2e.py @@ -20,11 +20,12 @@ HandlePendingToolCallRequest, PermissionDecisionRequest, PermissionDecisionUserNotAvailable, + SessionsCheckInUseRequest, ) from copilot.session import PermissionHandler from copilot.tools import Tool, ToolInvocation, ToolResult -from .testharness import DEFAULT_GITHUB_TOKEN, E2ETestContext +from .testharness import DEFAULT_GITHUB_TOKEN, E2ETestContext, wait_for_condition pytestmark = pytest.mark.asyncio(loop_scope="module") @@ -464,6 +465,7 @@ async def blocking_external_tool(args): await server.start() try: cli_url = f"localhost:{server.runtime_port}" + lock_observer: CopilotClient | None = None suspended_client = CopilotClient( connection=RuntimeConnection.for_uri( @@ -487,8 +489,41 @@ async def blocking_external_tool(args): assert (await asyncio.wait_for(tool_started, PENDING_WORK_TIMEOUT)) == "beta" if disconnect_original_client: + # force_stop closes the local socket before the server necessarily + # processes that disconnect. Observe the session lock from another + # runtime so resume cannot race the server's active-session cleanup. + lock_observer = _make_subprocess_client(ctx) + await lock_observer.start() + + async def session_lock_is_held() -> bool: + result = await lock_observer.rpc.sessions.check_in_use( + SessionsCheckInUseRequest(session_ids=[session_id]) + ) + return session_id in result.in_use + + await wait_for_condition( + session_lock_is_held, + timeout=PENDING_WORK_TIMEOUT, + timeout_message=( + f"Timed out waiting for session '{session_id}' to acquire its lock." + ), + ) await suspended_client.force_stop() + async def session_lock_is_released() -> bool: + result = await lock_observer.rpc.sessions.check_in_use( + SessionsCheckInUseRequest(session_ids=[session_id]) + ) + return session_id not in result.in_use + + await wait_for_condition( + session_lock_is_released, + timeout=PENDING_WORK_TIMEOUT, + timeout_message=( + f"Timed out waiting for session '{session_id}' to release its lock." + ), + ) + resumed_client = CopilotClient( connection=RuntimeConnection.for_uri( cli_url, connection_token="py-tcp-shared-test-token" @@ -550,6 +585,8 @@ async def resumed_external_tool(args): if not release_original.done(): release_original.set_result("ORIGINAL_SHOULD_NOT_WIN") await _safe_force_stop(suspended_client) + if lock_observer is not None: + await _safe_force_stop(lock_observer) finally: await _safe_force_stop(server) diff --git a/python/e2e/test_rewind_e2e.py b/python/e2e/test_rewind_e2e.py new file mode 100644 index 0000000000..10e7bc4dd9 --- /dev/null +++ b/python/e2e/test_rewind_e2e.py @@ -0,0 +1,97 @@ +"""E2E coverage for rewinding tracked files and conversation history.""" + +from __future__ import annotations + +import asyncio +import os +import sys +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): + if sys.platform == "win32": + pytest.skip("blocked on CLI 1.0.81 file-change tracking regression on Windows") + + 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 + + # File change capture settles asynchronously after the turn completes, so a + # rewind point can briefly report zero restorable files. Poll until the + # capture lands instead of sampling once; the assertions below still run if + # it never does. + rewind_points = await session.rpc.history.list_rewind_points() + deadline = asyncio.get_running_loop().time() + 30 + while asyncio.get_running_loop().time() < deadline and not ( + rewind_points.unavailable_reason is None + and rewind_points.points + and rewind_points.points[0].can_restore_files + ): + 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 747eb4d1ef..32fbc5b184 100644 --- a/python/e2e/test_rpc_commands_e2e.py +++ b/python/e2e/test_rpc_commands_e2e.py @@ -6,10 +6,10 @@ 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_mcp_config_e2e.py b/python/e2e/test_rpc_mcp_config_e2e.py index efa41cda2d..db605e07d6 100644 --- a/python/e2e/test_rpc_mcp_config_e2e.py +++ b/python/e2e/test_rpc_mcp_config_e2e.py @@ -18,8 +18,8 @@ MCPConfigRemoveRequest, MCPConfigUpdateRequest, MCPGrantType, - MCPServerConfig, - MCPServerConfigHTTPType, + MCPSerializableServerConfig, + MCPSerializableServerConfigType, ) from .testharness import E2ETestContext @@ -27,7 +27,7 @@ pytestmark = pytest.mark.asyncio(loop_scope="module") -def _server_config(servers: dict, name: str) -> MCPServerConfig: +def _server_config(servers: dict, name: str) -> MCPSerializableServerConfig: assert name in servers, f"Expected MCP server '{name}' to be present." return servers[name] @@ -37,8 +37,8 @@ async def test_should_call_server_mcp_config_rpcs(self, ctx: E2ETestContext): await ctx.client.start() server_name = f"sdk-test-{uuid.uuid4().hex}" - config = MCPServerConfig(command="node", args=[]) - updated_config = MCPServerConfig(command="node", args=["--version"]) + config = MCPSerializableServerConfig(command="node", args=[]) + updated_config = MCPSerializableServerConfig(command="node", args=["--version"]) initial = await ctx.client.rpc.mcp.config.list() assert server_name not in initial.servers @@ -70,8 +70,8 @@ async def test_should_round_trip_http_mcp_oauth_config_rpc(self, ctx: E2ETestCon await ctx.client.start() server_name = f"sdk-http-oauth-{uuid.uuid4().hex}" - config = MCPServerConfig( - type=MCPServerConfigHTTPType.HTTP, + config = MCPSerializableServerConfig( + type=MCPSerializableServerConfigType.HTTP, url="https://example.com/mcp", headers={"Authorization": "Bearer token"}, oauth_client_id="client-id", @@ -80,8 +80,8 @@ async def test_should_round_trip_http_mcp_oauth_config_rpc(self, ctx: E2ETestCon tools=["*"], timeout=3000, ) - updated_config = MCPServerConfig( - type=MCPServerConfigHTTPType.HTTP, + updated_config = MCPSerializableServerConfig( + type=MCPSerializableServerConfigType.HTTP, url="https://example.com/updated-mcp", oauth_client_id="updated-client-id", oauth_public_client=True, @@ -96,7 +96,7 @@ async def test_should_round_trip_http_mcp_oauth_config_rpc(self, ctx: E2ETestCon ) after_add = await ctx.client.rpc.mcp.config.list() added = _server_config(after_add.servers, server_name) - assert added.type == MCPServerConfigHTTPType.HTTP + assert added.type == MCPSerializableServerConfigType.HTTP assert added.url == "https://example.com/mcp" assert added.headers is not None assert added.headers["Authorization"] == "Bearer token" diff --git a/python/e2e/test_rpc_server_e2e.py b/python/e2e/test_rpc_server_e2e.py index bcef26754b..e7c4a446ce 100644 --- a/python/e2e/test_rpc_server_e2e.py +++ b/python/e2e/test_rpc_server_e2e.py @@ -55,7 +55,7 @@ ) from copilot.session import PermissionHandler -from .testharness import E2ETestContext +from .testharness import E2ETestContext, wait_for_condition pytestmark = pytest.mark.asyncio(loop_scope="module") @@ -282,30 +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 - - listed = await ctx.client.rpc.sessions.list( - SessionsListRequest( - filter=SessionListFilter(cwd=str(working_directory)), - metadata_limit=0, + await client.start() + session = await client.create_session( + session_id=session_id, + working_directory=str(working_directory), + on_permission_request=PermissionHandler.approve_all, + ) + + await session.send( + "Record a turn for sessions.list discriminator coverage", mode="enqueue" + ) + + 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)) @@ -313,32 +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 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()) diff --git a/python/e2e/test_rpc_session_state_e2e.py b/python/e2e/test_rpc_session_state_e2e.py index 51c1059bb7..f4b03d2e65 100644 --- a/python/e2e/test_rpc_session_state_e2e.py +++ b/python/e2e/test_rpc_session_state_e2e.py @@ -33,6 +33,7 @@ ModeSetRequest, NameSetAutoRequest, NameSetRequest, + PermissionsResetSessionApprovalsRequest, PermissionsSetApproveAllRequest, PlanUpdateRequest, SessionSetCredentialsParams, @@ -594,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( diff --git a/python/e2e/test_rpc_session_state_extras_e2e.py b/python/e2e/test_rpc_session_state_extras_e2e.py index 5d0d881a00..7523059c7b 100644 --- a/python/e2e/test_rpc_session_state_extras_e2e.py +++ b/python/e2e/test_rpc_session_state_extras_e2e.py @@ -19,7 +19,7 @@ MetadataContextHeaviestMessagesRequest, ModelSwitchToRequest, NamedProviderConfig, - PermissionsSetAllowAllRequest, + PermissionsSetModeRequest, ProviderAddRequest, ProviderModelConfig, ProviderType, @@ -32,6 +32,7 @@ VisibilitySetRequest, ) from copilot.session import PermissionHandler +from copilot.session_events import PermissionMode from .testharness import E2ETestContext @@ -185,26 +186,26 @@ async def test_should_get_and_set_allowall_permissions(self, ctx: E2ETestContext on_permission_request=PermissionHandler.approve_all, ) as session: try: - initial = await session.rpc.permissions.get_allow_all() - assert initial.enabled is False + initial = await session.rpc.permissions.get_mode() + assert initial.mode is PermissionMode.MANUAL - enable = await session.rpc.permissions.set_allow_all( - PermissionsSetAllowAllRequest(enabled=True) + enable = await session.rpc.permissions.set_mode( + PermissionsSetModeRequest(mode=PermissionMode.ALLOW_ALL) ) assert enable.success is True - assert enable.enabled is True - assert (await session.rpc.permissions.get_allow_all()).enabled is True + assert enable.mode is PermissionMode.ALLOW_ALL + assert (await session.rpc.permissions.get_mode()).mode is PermissionMode.ALLOW_ALL - disable = await session.rpc.permissions.set_allow_all( - PermissionsSetAllowAllRequest(enabled=False) + disable = await session.rpc.permissions.set_mode( + PermissionsSetModeRequest(mode=PermissionMode.MANUAL) ) assert disable.success is True - assert disable.enabled is False - assert (await session.rpc.permissions.get_allow_all()).enabled is False + assert disable.mode is PermissionMode.MANUAL + assert (await session.rpc.permissions.get_mode()).mode is PermissionMode.MANUAL finally: with contextlib.suppress(Exception): - await session.rpc.permissions.set_allow_all( - PermissionsSetAllowAllRequest(enabled=False) + await session.rpc.permissions.set_mode( + PermissionsSetModeRequest(mode=PermissionMode.MANUAL) ) async def test_should_get_context_attribution_and_heaviest_messages_after_turn( diff --git a/python/e2e/test_rpc_shell_and_fleet_e2e.py b/python/e2e/test_rpc_shell_and_fleet_e2e.py index d5a88456ab..422feab520 100644 --- a/python/e2e/test_rpc_shell_and_fleet_e2e.py +++ b/python/e2e/test_rpc_shell_and_fleet_e2e.py @@ -37,11 +37,10 @@ def _write_file_command(marker_path: Path, marker: str) -> str: if sys.platform == "win32": - return ( - f"powershell -NoLogo -NoProfile -Command " - f"\"Set-Content -LiteralPath '{marker_path}' -Value '{marker}'\"" - ) - return f"sh -c \"printf '%s' '{marker}' > '{marker_path}'\"" + # shell.exec already runs through cmd.exe on Windows. Use its built-in echo + # instead of spawning a nested PowerShell process just to write the marker. + return f'echo {marker}>"{marker_path.name}"' + return f"sh -c \"printf '%s' '{marker}' > '{marker_path.name}'\"" async def _wait_for_file_text(path: Path, expected: str, *, timeout: float = 30.0) -> None: @@ -57,19 +56,21 @@ async def _wait_for_file_text(path: Path, expected: str, *, timeout: float = 30. class TestRpcShellAndFleet: async def test_should_execute_shell_command(self, ctx: E2ETestContext): - session = await ctx.client.create_session( + async with await ctx.client.create_session( on_permission_request=PermissionHandler.approve_all, - ) - marker_path = Path(ctx.work_dir) / f"shell-rpc-{uuid.uuid4().hex}.txt" - marker = "copilot-sdk-shell-rpc" - - result = await session.rpc.shell.exec( - ShellExecRequest(command=_write_file_command(marker_path, marker), cwd=ctx.work_dir) - ) - assert (result.process_id or "").strip() - await _wait_for_file_text(marker_path, marker) - - await session.disconnect() + ) as session: + command_dir = Path(ctx.work_dir) / f"shell-rpc-{uuid.uuid4().hex}" + command_dir.mkdir() + marker_path = command_dir / "marker.txt" + marker = "copilot-sdk-shell-rpc" + + result = await session.rpc.shell.exec( + ShellExecRequest( + command=_write_file_command(marker_path, marker), cwd=str(command_dir) + ) + ) + assert (result.process_id or "").strip() + await _wait_for_file_text(marker_path, marker) async def test_should_kill_shell_process(self, ctx: E2ETestContext): session = await ctx.client.create_session( diff --git a/python/e2e/test_rpc_tasks_and_handlers_e2e.py b/python/e2e/test_rpc_tasks_and_handlers_e2e.py index 6a99cbb75d..f0dd8f7577 100644 --- a/python/e2e/test_rpc_tasks_and_handlers_e2e.py +++ b/python/e2e/test_rpc_tasks_and_handlers_e2e.py @@ -445,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 index 117fe083d2..b7f3b94d22 100644 --- a/python/e2e/test_rpc_ui_ephemeral_query_e2e.py +++ b/python/e2e/test_rpc_ui_ephemeral_query_e2e.py @@ -18,6 +18,12 @@ class TestRpcUiEphemeralQuery: + # TODO(cli-1.0.81-2): CLI 1.0.81-5 still fails session.ui.ephemeralQuery against the + # recorded snapshot on macOS ("Failed to get response from the AI model"). Re-enable + # once the runtime fix ships. + @pytest.mark.skip( + reason="blocked on CLI 1.0.81-5 session.ui.ephemeralQuery regression on macOS" + ) async def test_should_answer_ephemeral_query(self, ctx: E2ETestContext): async with await ctx.client.create_session( on_permission_request=PermissionHandler.approve_all, diff --git a/python/e2e/test_session_e2e.py b/python/e2e/test_session_e2e.py index aed1340f55..08413f228f 100644 --- a/python/e2e/test_session_e2e.py +++ b/python/e2e/test_session_e2e.py @@ -16,6 +16,7 @@ E2ETestContext, get_final_assistant_message, get_next_event_of_type, + wait_for_condition, ) pytestmark = pytest.mark.asyncio(loop_scope="module") @@ -396,19 +397,26 @@ async def test_should_delete_session(self, ctx: E2ETestContext): ) async def test_should_get_session_metadata(self, ctx: E2ETestContext): - import asyncio - # Create a session and send a message to persist it session = await ctx.client.create_session( on_permission_request=PermissionHandler.approve_all ) await session.send_and_wait("Say hello") - # Small delay to ensure session file is written to disk - await asyncio.sleep(0.2) + metadata = None + + async def metadata_is_available() -> bool: + nonlocal metadata + metadata = await ctx.client.get_session_metadata(session.session_id) + return metadata is not None + + await wait_for_condition( + metadata_is_available, + timeout=10.0, + timeout_message="Timed out waiting for session metadata to persist.", + ) # Get metadata for the session we just created - metadata = await ctx.client.get_session_metadata(session.session_id) assert metadata is not None assert metadata.session_id == session.session_id assert isinstance(metadata.start_time, datetime) @@ -679,27 +687,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 diff --git a/python/e2e/test_session_fs_e2e.py b/python/e2e/test_session_fs_e2e.py index fbfde6ee78..035db125ba 100644 --- a/python/e2e/test_session_fs_e2e.py +++ b/python/e2e/test_session_fs_e2e.py @@ -174,6 +174,9 @@ def get_big_string() -> str: messages = await session.get_events() tool_result = find_tool_call_result(messages, "get_big_string") assert tool_result is not None + # The CLI joins the temp path using the host separator, so normalize before + # matching to keep the assertion valid on Windows. + tool_result = tool_result.replace("\\", "/") assert f"{SESSION_STATE_PATH}/temp/" in tool_result match = re.search(rf"({re.escape(SESSION_STATE_PATH)}/temp/[^\s]+)", tool_result) assert match is not None @@ -280,6 +283,8 @@ async def test_should_map_all_sessionfs_handler_operations(self, ctx: E2ETestCon SessionFSSqliteExistsRequest, SessionFSSqliteQueryRequest, SessionFSSqliteQueryType, + SessionFSSqliteTransactionErrorClass, + SessionFSSqliteTransactionRequest, SessionFSStatRequest, SessionFSWriteFileRequest, ) @@ -403,6 +408,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) ) @@ -429,6 +443,8 @@ async def test_sessionfsprovider_converts_exceptions_to_rpc_errors(self): SessionFSSqliteExistsRequest, SessionFSSqliteQueryRequest, SessionFSSqliteQueryType, + SessionFSSqliteTransactionErrorClass, + SessionFSSqliteTransactionRequest, SessionFSStatRequest, SessionFSWriteFileRequest, ) @@ -536,6 +552,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 @@ -624,7 +646,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 c82cc793f1..f48bcd2cdc 100644 --- a/python/e2e/test_session_fs_sqlite_e2e.py +++ b/python/e2e/test_session_fs_sqlite_e2e.py @@ -8,6 +8,7 @@ import sqlite3 import tempfile from pathlib import Path +from typing import Any import pytest import pytest_asyncio @@ -17,6 +18,8 @@ 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_streaming_fidelity_e2e.py b/python/e2e/test_streaming_fidelity_e2e.py index a82c7f674d..a644acb838 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.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)) - + 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_telemetry_e2e.py b/python/e2e/test_telemetry_e2e.py index 14c03ada30..8b9c82abef 100644 --- a/python/e2e/test_telemetry_e2e.py +++ b/python/e2e/test_telemetry_e2e.py @@ -118,9 +118,6 @@ def echo(invocation: ToolInvocation) -> ToolResult: scope = span.get("instrumentationScope") or {} assert scope.get("name") == source_name - trace_ids = {s.get("traceId") for s in spans if s.get("traceId")} - assert len(trace_ids) == 1 - for span in spans: status = (span.get("status") or {}).get("code", 0) assert status != 2, f"span in error state: {span}" @@ -132,11 +129,14 @@ def echo(invocation: ToolInvocation) -> ToolResult: assert _is_root_span(invoke_agent) invoke_agent_span_id = invoke_agent.get("spanId") assert invoke_agent_span_id + invoke_agent_trace_id = invoke_agent.get("traceId") + assert invoke_agent_trace_id chat_spans = [s for s in spans if _string_attribute(s, "gen_ai.operation.name") == "chat"] assert chat_spans for chat in chat_spans: assert chat.get("parentSpanId") == invoke_agent_span_id + assert chat.get("traceId") == invoke_agent_trace_id assert any( prompt in (_string_attribute(c, "gen_ai.input.messages") or "") for c in chat_spans ) @@ -149,6 +149,7 @@ def echo(invocation: ToolInvocation) -> ToolResult: s for s in spans if _string_attribute(s, "gen_ai.operation.name") == "execute_tool" ) assert tool_span.get("parentSpanId") == invoke_agent_span_id + assert tool_span.get("traceId") == invoke_agent_trace_id assert _string_attribute(tool_span, "gen_ai.tool.name") == tool_name assert (_string_attribute(tool_span, "gen_ai.tool.call.id") or "").strip() assert ( diff --git a/python/e2e/test_tool_results_e2e.py b/python/e2e/test_tool_results_e2e.py index b7b05b7af5..41d1967bc9 100644 --- a/python/e2e/test_tool_results_e2e.py +++ b/python/e2e/test_tool_results_e2e.py @@ -184,10 +184,11 @@ def on_event(event): unsubscribe = session.on(on_event) try: - asyncio.ensure_future( - session.send( + send_task = asyncio.create_task( + session.send_and_wait( "Use access_secret to get the API key." - " If access is denied, tell me it was 'access denied'." + " If access is denied, tell me it was 'access denied'.", + timeout=60.0, ) ) tool_evt = await asyncio.wait_for(tool_complete_future, timeout=60.0) @@ -201,7 +202,7 @@ def on_event(event): error_msg = error if isinstance(error, str) else getattr(error, "message", None) assert "Access denied" in (error_msg or "") - answer = await get_final_assistant_message(session, timeout=60.0) + answer = await send_task assert answer is not None finally: unsubscribe() diff --git a/python/e2e/testharness/context.py b/python/e2e/testharness/context.py index 679a36e28c..2171e25f2d 100644 --- a/python/e2e/testharness/context.py +++ b/python/e2e/testharness/context.py @@ -11,18 +11,66 @@ 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(): @@ -30,15 +78,22 @@ def get_cli_path_for_tests() -> str: # 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). + # 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] github_modules = base_path / "nodejs" / "node_modules" / "@github" - for platform_pkg in sorted(github_modules.glob("copilot-*")): - candidate = platform_pkg / "index.js" - if candidate.exists(): - return str(candidate.resolve()) - - raise RuntimeError("CLI not found for tests. Run 'npm install' in the nodejs directory.") + package_names = _cli_platform_package_names() + found = _find_cli_in_node_modules(github_modules, package_names) + if found is not None: + return found + + 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() diff --git a/python/pyproject.toml b/python/pyproject.toml index 7e6274d9c0..e96c587a64 100644 --- a/python/pyproject.toml +++ b/python/pyproject.toml @@ -46,6 +46,7 @@ dev = [ "pytest>=7.0.0", "pytest-asyncio>=0.21.0", "pytest-timeout>=2.0.0", + "pytest-xdist>=3.6.0", "websockets>=12.0", "opentelemetry-sdk>=1.0.0", ] diff --git a/python/test_client.py b/python/test_client.py index a37d8dce2b..a33f0ecd60 100644 --- a/python/test_client.py +++ b/python/test_client.py @@ -6,7 +6,9 @@ import asyncio import inspect +import os from datetime import UTC, datetime +from tempfile import TemporaryDirectory from unittest.mock import AsyncMock, Mock, patch import pytest @@ -15,6 +17,7 @@ CanvasProviderIdentity, CapiSessionOptions, CopilotClient, + DisableBypassPermissionsModes, ExtensionInfo, ModelBillingTokenPrices, ModelBillingTokenPricesLongContext, @@ -27,6 +30,8 @@ CloudSessionRepository, CopilotExpAssignmentResponse, ExpConfigEntry, + ManagedSettings, + ManagedSettingsPermissions, ModelBilling, ModelCapabilities, ModelInfo, @@ -54,6 +59,50 @@ def test_inprocess_connection_has_no_child_process_options(): 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): @@ -162,6 +211,46 @@ async def test_resume_session_allows_none_permission_handler(self): 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)) @@ -504,6 +593,46 @@ async def mock_request(method, params, **kwargs): 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)) @@ -537,6 +666,210 @@ async def mock_request(method, params, **kwargs): 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=DisableBypassPermissionsModes.ALLOW_AUTO_ONLY, + 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( + disable_bypass_permissions_mode="future-fail-closed-mode", + 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": "allow-auto-only", + "deny": ["Shell(git push)"], + "ask": ["Domain(publish.example)"], + "allow": ["Read(**)"], + } + } + assert captured["session.resume"]["managedSettings"] == { + "permissions": { + "disableBypassPermissionsMode": "future-fail-closed-mode", + "ask": ["Domain(publish.example)"], + } + } + + await client.create_session( + on_permission_request=PermissionHandler.approve_all, + managed_settings=ManagedSettings( + permissions=ManagedSettingsPermissions( + disable_bypass_permissions_mode=DisableBypassPermissionsModes.DISABLE, + ) + ), + ) + assert captured["session.create"]["managedSettings"] == { + "permissions": { + "disableBypassPermissionsMode": "disable", + } + } + 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)) @@ -610,6 +943,45 @@ async def mock_request(method, params, **kwargs): 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)) @@ -674,6 +1046,7 @@ async def mock_request(method, params, **kwargs): 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}, ) @@ -681,14 +1054,17 @@ async def mock_request(method, params, **kwargs): 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: @@ -754,6 +1130,7 @@ async def mock_request(method, params, **kwargs): 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, @@ -768,19 +1145,45 @@ async def mock_request(method, params, **kwargs): 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 + + 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"] == [] + + omitted_session = await client.create_session( + on_permission_request=PermissionHandler.approve_all, + ) + 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() diff --git a/python/test_codegen_type_names.py b/python/test_codegen_type_names.py new file mode 100644 index 0000000000..5242f1c786 --- /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 b1905b9350..5710d106bc 100644 --- a/python/test_commands_and_elicitation.py +++ b/python/test_commands_and_elicitation.py @@ -80,7 +80,7 @@ async def mock_request(method, params, **kwargs): payload = captured["session.create"] assert payload["commands"] == [ {"name": "deploy", "description": "Deploy the app"}, - {"name": "rollback", "description": None}, + {"name": "rollback", "description": ""}, ] finally: await client.force_stop() diff --git a/python/test_e2e_harness_cli_path.py b/python/test_e2e_harness_cli_path.py new file mode 100644 index 0000000000..8a50ba7a51 --- /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 1ffbd59c54..2e8015a97d 100644 --- a/python/test_event_forward_compatibility.py +++ b/python/test_event_forward_compatibility.py @@ -18,10 +18,12 @@ ElicitationCompletedAction, ElicitationRequestedMode, ElicitationRequestedSchema, + ManagedSettingsResolvedSource, PermissionPromptRequestMemory, PermissionRequestMemory, PermissionRequestMemoryAction, SessionEventType, + SessionManagedSettingsResolvedData, SessionTaskCompleteData, UserMessageAgentMode, session_event_from_dict, @@ -136,6 +138,42 @@ def test_explicit_generated_symbols_remain_available(self): ) 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( diff --git a/python/test_github_token_provider.py b/python/test_github_token_provider.py new file mode 100644 index 0000000000..5b203f3e34 --- /dev/null +++ b/python/test_github_token_provider.py @@ -0,0 +1,273 @@ +from __future__ import annotations + +import asyncio +from typing import Any, cast + +import pytest + +from copilot import ( + CopilotClient, + GitHubTokenAcquireReason, + RuntimeConnection, +) +from copilot._jsonrpc import JsonRpcClient, JsonRpcError +from copilot.rpc import GitHubTokenAcquireRequest + + +class FakeJsonRpcClient: + def __init__(self, *, fail_method: str | None = None) -> None: + self.fail_method = fail_method + self.requests: list[tuple[str, dict[str, Any]]] = [] + self.request_handlers: dict[str, Any] = {} + self.notification_method_handlers: dict[str, Any] = {} + + async def request(self, method: str, params: dict[str, Any], **kwargs: Any) -> dict[str, Any]: + self.requests.append((method, params)) + if method == self.fail_method: + raise RuntimeError(f"{method} failed") + if method in {"session.create", "session.resume"}: + response = {"sessionId": params["sessionId"]} + callback = kwargs.get("on_response_inline") + if callback is not None: + callback(response) + return response + if method == "session.destroy": + return {} + if method == "session.delete": + return {"success": True} + raise RuntimeError(f"Unexpected method: {method}") + + async def stop(self) -> None: + pass + + def set_request_handler(self, method: str, handler: Any) -> None: + self.request_handlers[method] = handler + + def set_notification_method_handler(self, method: str, handler: Any) -> None: + self.notification_method_handlers[method] = handler + + +class ConcurrentResumeJsonRpcClient(FakeJsonRpcClient): + def __init__(self) -> None: + super().__init__() + self.resume_responses: list[asyncio.Future[dict[str, Any]]] = [] + + async def request(self, method: str, params: dict[str, Any], **kwargs: Any) -> dict[str, Any]: + self.requests.append((method, params)) + if method == "session.create": + response = {"sessionId": params["sessionId"]} + callback = kwargs.get("on_response_inline") + if callback is not None: + callback(response) + return response + if method == "session.resume": + response = asyncio.get_running_loop().create_future() + self.resume_responses.append(response) + return await response + raise RuntimeError(f"Unexpected method: {method}") + + +def make_client(fake: FakeJsonRpcClient) -> CopilotClient: + client = CopilotClient(connection=RuntimeConnection.for_uri("localhost:1234")) + client._client = cast(JsonRpcClient, fake) + return client + + +class TestGitHubTokenProvider: + async def test_mutual_exclusion(self) -> None: + client = CopilotClient(connection=RuntimeConnection.for_uri("localhost:1234")) + + with pytest.raises( + ValueError, match="github_token and github_token_provider are mutually exclusive" + ): + await client.create_session( + github_token="static", + github_token_provider=lambda _: {"kind": "cancelled"}, + ) + + async def test_wire_mapping_token_and_cancelled(self) -> None: + fake = FakeJsonRpcClient() + client = make_client(fake) + observed: list[dict[str, Any]] = [] + + async def provider(args): + observed.append(dict(args)) + if len(observed) == 1: + return { + "kind": "token", + "accessToken": "secret-token", + "tokenType": "Bearer", + "expiresIn": 28_800, + } + return {"kind": "cancelled"} + + await client.create_session( + session_id="python-session", + github_token_provider=provider, + ) + create_payload = fake.requests[0][1] + registration_id = create_payload["gitHubTokenProviderRegistrationId"] + assert "github_token_provider" not in create_payload + assert "gitHubToken" not in create_payload + client._register_client_global_handlers() + get_token = fake.request_handlers["gitHubToken.getToken"] + + token = await get_token( + { + "registrationId": registration_id, + "host": "github.example.com", + "reason": "initial", + } + ) + cancelled = await get_token( + { + "registrationId": registration_id, + "host": "github.example.com", + "reason": "refresh", + "sessionId": "python-session", + } + ) + + assert token == { + "kind": "token", + "accessToken": "secret-token", + "tokenType": "Bearer", + "expiresIn": 28_800, + } + assert cancelled == {"kind": "cancelled"} + assert observed == [ + { + "host": "github.example.com", + "session_id": "python-session", + "reason": GitHubTokenAcquireReason.INITIAL, + }, + { + "host": "github.example.com", + "session_id": "python-session", + "reason": GitHubTokenAcquireReason.REFRESH, + }, + ] + + async def test_callback_and_unknown_registration_errors(self) -> None: + fake = FakeJsonRpcClient() + client = make_client(fake) + failure = RuntimeError("credential broker failed") + + def provider(_args): + raise failure + + await client.create_session( + session_id="error-session", + github_token_provider=provider, + ) + registration_id = fake.requests[0][1]["gitHubTokenProviderRegistrationId"] + + with pytest.raises(RuntimeError, match="credential broker failed") as exc: + await client._github_token_provider_adapter.get_token( + GitHubTokenAcquireRequest( + registration_id=registration_id, + host="github.com", + reason=GitHubTokenAcquireReason.INITIAL, + ) + ) + assert exc.value is failure + + with pytest.raises(JsonRpcError, match="No GitHub token provider registered"): + await client._github_token_provider_adapter.get_token( + GitHubTokenAcquireRequest( + registration_id="unknown", + host="github.com", + reason=GitHubTokenAcquireReason.REFRESH, + ) + ) + + async def test_failure_session_close_and_client_close_cleanup(self) -> None: + failing = make_client(FakeJsonRpcClient(fail_method="session.create")) + with pytest.raises(RuntimeError, match="session.create failed"): + await failing.create_session(github_token_provider=lambda _: {"kind": "cancelled"}) + assert failing._github_token_providers == {} + + fake = FakeJsonRpcClient() + client = make_client(fake) + first = await client.create_session( + session_id="first", + github_token_provider=lambda _: {"kind": "cancelled"}, + ) + await client.create_session( + session_id="second", + github_token_provider=lambda _: {"kind": "cancelled"}, + ) + assert len(client._github_token_providers) == 2 + + await first.disconnect() + assert len(client._github_token_providers) == 1 + await client.delete_session("second") + assert client._github_token_providers == {} + await client.force_stop() + assert client._github_token_providers == {} + + async def test_resume_rotates_provider(self) -> None: + fake = FakeJsonRpcClient() + client = make_client(fake) + calls: list[str] = [] + + await client.create_session( + session_id="resumed", + github_token_provider=lambda _: calls.append("first") or {"kind": "cancelled"}, + ) + first_registration = fake.requests[0][1]["gitHubTokenProviderRegistrationId"] + await client.resume_session( + "resumed", + github_token_provider=lambda _: calls.append("second") or {"kind": "cancelled"}, + ) + second_registration = fake.requests[1][1]["gitHubTokenProviderRegistrationId"] + + with pytest.raises(JsonRpcError): + await client._github_token_provider_adapter.get_token( + GitHubTokenAcquireRequest( + registration_id=first_registration, + host="github.com", + reason=GitHubTokenAcquireReason.REFRESH, + ) + ) + assert await client._github_token_provider_adapter.get_token( + GitHubTokenAcquireRequest( + registration_id=second_registration, + host="github.com", + reason=GitHubTokenAcquireReason.REFRESH, + ) + ) == {"kind": "cancelled"} + assert calls == ["second"] + + async def test_concurrent_resume_keeps_pending_registration(self) -> None: + fake = ConcurrentResumeJsonRpcClient() + client = make_client(fake) + await client.create_session( + session_id="concurrent", + github_token_provider=lambda _: {"kind": "cancelled"}, + ) + + first_resume = asyncio.create_task( + client.resume_session( + "concurrent", + github_token_provider=lambda _: {"kind": "cancelled"}, + ) + ) + second_resume = asyncio.create_task( + client.resume_session( + "concurrent", + github_token_provider=lambda _: {"kind": "cancelled"}, + ) + ) + while len(fake.resume_responses) < 2: + await asyncio.sleep(0) + + fake.resume_responses[0].set_result({"sessionId": "concurrent"}) + await first_resume + assert len(client._github_token_providers) == 2 + + fake.resume_responses[1].set_result({"sessionId": "concurrent"}) + await second_resume + assert len(client._github_token_providers) == 1 + second_registration = fake.requests[2][1]["gitHubTokenProviderRegistrationId"] + assert second_registration in client._github_token_providers diff --git a/python/test_jsonrpc.py b/python/test_jsonrpc.py index 56ce44e374..2f2ecafce9 100644 --- a/python/test_jsonrpc.py +++ b/python/test_jsonrpc.py @@ -5,6 +5,7 @@ of large payloads and short reads from pipes. """ +import asyncio import io import json import os @@ -13,7 +14,7 @@ import pytest -from copilot._jsonrpc import JsonRpcClient +from copilot._jsonrpc import JsonRpcClient, ProcessExitedError class MockProcess: @@ -162,6 +163,29 @@ def test_read_exact_partial_data_raises_eof(self): client._read_exact(100) +@pytest.mark.asyncio +async def test_process_exit_waits_for_stderr_reader(): + process = MockProcess() + process.returncode = 1 + client = JsonRpcClient(process) + future = asyncio.get_running_loop().create_future() + client.pending_requests["request-id"] = future + + def capture_stderr(): + time.sleep(0.01) + with client._stderr_lock: + client._stderr_output.append("unsupported argument\n") + + client._stderr_thread = threading.Thread(target=capture_stderr) + client._stderr_thread.start() + + client._fail_pending_requests() + + await asyncio.sleep(0) + with pytest.raises(ProcessExitedError, match=r"stderr: unsupported argument"): + future.result() + + class TestReadMessageWithLargePayloads: """Tests for _read_message() with large JSON-RPC messages""" diff --git a/python/test_managed_permissions.py b/python/test_managed_permissions.py new file mode 100644 index 0000000000..ca07556da1 --- /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 0000000000..70b3a74de5 --- /dev/null +++ b/python/test_permission_decision_context.py @@ -0,0 +1,104 @@ +from unittest.mock import AsyncMock, MagicMock + +from copilot import PermissionResponseCapability +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 test_permission_response_capability_is_exported_from_package_root() -> None: + assert PermissionResponseCapability.INTERACTIVE.value == "interactive" + + +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 8b9423c137..a23173727a 100644 --- a/python/test_rpc_generated.py +++ b/python/test_rpc_generated.py @@ -1,13 +1,25 @@ """Tests for generated RPC method behavior.""" +import json from unittest.mock import AsyncMock import pytest from copilot.rpc import ( + BuiltinToolInputSchemaType, CommandsApi, CommandsInvokeRequest, + CommandsRespondToQueuedCommandRequest, + LocalSessionMetadataValue, + QueuedCommandHandled, + QueuedCommandNotHandled, + RemoteControlStatusOff, + RemoteControlStatusResult, + RemoteSessionMetadataValue, + SessionList, SlashCommandTextResult, + TaskAgentInfo, + UIElicitationSchemaType, ) @@ -22,3 +34,100 @@ 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_ui_elicitation_schema_type_preserves_public_alias(): + assert UIElicitationSchemaType is BuiltinToolInputSchemaType + + +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" + + +def test_task_agent_info_deserializes_integral_float_milliseconds(): + task = TaskAgentInfo.from_dict( + { + "agentType": "general-purpose", + "description": "Example task", + "id": "agent-1", + "prompt": "Do the task", + "startedAt": "2026-08-19T12:00:00Z", + "status": "running", + "toolCallId": "tool-1", + "type": "agent", + "activeTimeMs": 43.0, + } + ) + + assert task.active_time_ms == 43 + assert task.to_dict()["activeTimeMs"] == 43 + + +@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 7e85729cab..6a1535c301 100644 --- a/python/test_rpc_timeout.py +++ b/python/test_rpc_timeout.py @@ -54,7 +54,7 @@ async def test_custom_timeout_forwarded(self): @pytest.mark.asyncio async def test_timeout_on_session_params_method(self): client = AsyncMock() - client.request = AsyncMock(return_value={"mode": "plan"}) + client.request = AsyncMock(return_value={"modelChanged": False, "status": "completed"}) api = ModeApi(client, "sess-1") await api.set(ModeSetRequest(mode=SessionMode.PLAN), timeout=120.0) diff --git a/python/test_session.py b/python/test_session.py new file mode 100644 index 0000000000..dd2d0a72f6 --- /dev/null +++ b/python/test_session.py @@ -0,0 +1,69 @@ +"""CopilotSession unit tests.""" + +import asyncio +from datetime import UTC, datetime +from unittest.mock import AsyncMock, Mock +from uuid import uuid4 + +import pytest + +from copilot.session import CopilotSession +from copilot.session_events import ( + AssistantMessageData, + SessionEvent, + SessionEventType, + SessionIdleData, + SessionMode, +) + + +def _event(data, event_type: SessionEventType) -> SessionEvent: + return SessionEvent( + data=data, + id=uuid4(), + timestamp=datetime.now(UTC), + type=event_type, + ) + + +@pytest.mark.asyncio +async def test_send_and_wait_skips_autopilot_continuation_idle(): + client = Mock() + client.request = AsyncMock(return_value={"messageId": "message-1"}) + session = CopilotSession("session-1", client) + + pending = asyncio.create_task(session.send_and_wait("keep going")) + await asyncio.sleep(0) + client.request.assert_awaited_once() + + session._dispatch_event( + _event( + AssistantMessageData(content="intermediate", message_id="assistant-1"), + SessionEventType.ASSISTANT_MESSAGE, + ) + ) + session._dispatch_event( + _event( + SessionIdleData(mode=SessionMode.AUTOPILOT), + SessionEventType.SESSION_IDLE, + ) + ) + assert not pending.done() + + session._dispatch_event( + _event( + AssistantMessageData(content="final", message_id="assistant-2"), + SessionEventType.ASSISTANT_MESSAGE, + ) + ) + session._dispatch_event( + _event( + SessionIdleData(mode=SessionMode.INTERACTIVE), + SessionEventType.SESSION_IDLE, + ) + ) + + result = await asyncio.wait_for(pending, timeout=1) + assert result is not None + assert isinstance(result.data, AssistantMessageData) + assert result.data.content == "final" diff --git a/python/test_tool_set.py b/python/test_tool_set.py index 6a65e0df20..3468ccee34 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): @@ -244,6 +248,7 @@ def test_empty_mode_defaults(self): "coauthorEnabled": False, "manageScheduleEnabled": False, "installedPlugins": [], + "includedBuiltinSkills": [], } def test_empty_mode_caller_wins(self): @@ -254,14 +259,105 @@ def test_empty_mode_caller_wins(self): "coauthorEnabled": True, "manageScheduleEnabled": True, "installedPlugins": [], + "includedBuiltinSkills": [], } + def test_empty_mode_preserves_explicit_builtin_skill_allowlist(self): + patch = _post_create_options_patch("empty", None, None, None, None, ["code-review"]) + assert patch is not None + assert patch["includedBuiltinSkills"] == ["code-review"] + def test_copilot_cli_returns_none_when_unset(self): assert _post_create_options_patch("copilot-cli", None, None, None, None) is None + # Non-empty mode never injects the built-in skill restriction. + assert "includedBuiltinSkills" not in ( + _post_create_options_patch("copilot-cli", True, None, False, None) or {} + ) def test_copilot_cli_passes_through_explicit_values(self): - patch = _post_create_options_patch("copilot-cli", True, None, False, None) - assert patch == {"skipCustomInstructions": True, "coauthorEnabled": False} + patch = _post_create_options_patch("copilot-cli", True, None, False, None, ["code-review"]) + assert patch == { + "skipCustomInstructions": True, + "coauthorEnabled": False, + "includedBuiltinSkills": ["code-review"], + } + + +class _CapturingOptions: + """Captures the params passed to ``session.rpc.options.update``.""" + + def __init__(self) -> None: + self.captured: list = [] + + async def update(self, params) -> None: + self.captured.append(params) + + +class _CapturingRpc: + def __init__(self) -> None: + self.options = _CapturingOptions() + + +class _FakeSession: + def __init__(self, session_id: str = "sid-1") -> None: + self.session_id = session_id + self.rpc = _CapturingRpc() + + async def disconnect(self) -> None: + pass + + +class TestApplyPostCreateOptionsPatch: + """Guards the translation from the patch dict to ``SessionUpdateOptionsParams``. + + This covers the wire request emitted on both create and resume, which both + funnel through ``_apply_post_create_options_patch``. + """ + + def _make_client(self): + return CopilotClient( + mode="empty", + connection=UriRuntimeConnection(url="http://localhost:1234"), + ) + + async def test_empty_mode_sends_included_builtin_skills_empty(self): + client = self._make_client() + session = _FakeSession() + await client._apply_post_create_options_patch(session, "empty", None, None, None, None) + assert len(session.rpc.options.captured) == 1 + params = session.rpc.options.captured[0] + # The Empty post-patch must reach the wire request as an empty list, not + # be silently dropped during translation. + assert params.included_builtin_skills == [] + assert params.installed_plugins == [] + + async def test_empty_mode_explicit_allowlist_reaches_wire(self): + client = self._make_client() + session = _FakeSession() + await client._apply_post_create_options_patch( + session, "empty", False, False, True, True, ["code-review"] + ) + params = session.rpc.options.captured[0] + assert params.included_builtin_skills == ["code-review"] + + async def test_copilot_cli_mode_omits_included_builtin_skills(self): + client = self._make_client() + session = _FakeSession() + # Non-empty mode with no overrides sends no patch at all. + await client._apply_post_create_options_patch( + session, "copilot-cli", None, None, None, None + ) + assert session.rpc.options.captured == [] + + async def test_copilot_cli_mode_never_sets_included_builtin_skills(self): + client = self._make_client() + session = _FakeSession() + await client._apply_post_create_options_patch( + session, "copilot-cli", True, None, False, None + ) + params = session.rpc.options.captured[0] + # copilot-cli mode must not inject the built-in skill restriction. + assert params.included_builtin_skills is None class TestClientConstruction: diff --git a/python/test_tools.py b/python/test_tools.py index 90498c2b8e..031f68c053 100644 --- a/python/test_tools.py +++ b/python/test_tools.py @@ -8,10 +8,12 @@ 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, ) @@ -387,6 +389,77 @@ 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_plain_dict_with_non_primitive_fields_is_serialized(self): + from datetime import date, datetime, time + from decimal import Decimal + from enum import Enum + from uuid import UUID + + class Status(Enum): + ACTIVE = "active" + + result = _normalize_result( + { + "id": UUID("12345678-1234-5678-1234-567812345678"), + "created": datetime(2026, 1, 15, 10, 30, 0), + "day": date(2026, 1, 15), + "at": time(10, 30, 0), + "score": Decimal("99.5"), + "status": Status.ACTIVE, + "tags": {"python", "sdk"}, + } + ) + 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", + "at": "10:30:00", + "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"): @@ -550,3 +623,47 @@ def test_tool_references_round_trip_from_wire(self): } ) 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/README.md b/rust/README.md index e89ea55604..323d525d37 100644 --- a/rust/README.md +++ b/rust/README.md @@ -4,7 +4,7 @@ A Rust SDK for programmatic access to the GitHub Copilot CLI. 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. -**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. +**Releases:** [github.com/github/copilot-sdk/releases](https://github.com/github/copilot-sdk/releases) β€” combined release notes for all SDK languages. ## Prerequisites @@ -31,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 @@ -102,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; @@ -224,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 { @@ -244,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 @@ -262,6 +274,34 @@ let config = SessionConfig { let session = client.create_session(config).await?; ``` +For rotating per-session GitHub credentials, install a `GitHubTokenProvider` +instead of setting `github_token`: + +```rust,ignore +use github_copilot_sdk::{ + GitHubToken, GitHubTokenProviderArgs, GitHubTokenProviderResult, SessionConfig, +}; + +let provider = Arc::new(|args: GitHubTokenProviderArgs| async move { + let access_token = acquire_for_host(&args.host).await?; + Ok(GitHubTokenProviderResult::Token(GitHubToken::new( + access_token, + 8 * 60 * 60, + ))) +}); +let config = SessionConfig::default().with_github_token_provider(provider); +``` + +The remaining lifetime is required and must be positive when the callback +completes; production GitHub tokens typically last eight hours. Static +`github_token` and a provider are mutually exclusive. The same provider API is +available on `ResumeSessionConfig`. + +Initial acquisition runs during session creation or resume. Cancellation, +provider errors, and invalid token responses reject that operation instead of +falling back to ambient authentication. Idle sessions refresh only before their +next credential-consuming operation; there is no background refresh timer. + ### Session Hooks Hooks intercept CLI behavior at lifecycle points β€” tool use, prompt submission, session start/end, and errors. Install a `SessionHooks` impl with [`SessionConfig::with_hooks`] β€” the SDK auto-enables `hooks` in `SessionConfig` when one is set. @@ -308,7 +348,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 @@ -424,6 +464,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( @@ -585,6 +627,8 @@ 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: @@ -949,3 +993,22 @@ 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 de0252de8b..06e362f54e 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/examples/manual_tool_resume.rs b/rust/examples/manual_tool_resume.rs index e513cf921c..ad8ad5a044 100644 --- a/rust/examples/manual_tool_resume.rs +++ b/rust/examples/manual_tool_resume.rs @@ -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/src/errors.rs b/rust/src/errors.rs index 6e05bbfae1..70f4c14ff1 100644 --- a/rust/src/errors.rs +++ b/rust/src/errors.rs @@ -218,6 +218,8 @@ pub enum ErrorKind { }, /// Invalid combination of options or configuration. InvalidConfig, + /// A session-scoped GitHub token provider failed or returned invalid data. + GitHubTokenProvider, } impl fmt::Display for ErrorKind { @@ -238,6 +240,7 @@ impl fmt::Display for ErrorKind { write!(f, "binary not found: {name}") } ErrorKind::InvalidConfig => write!(f, "invalid configuration"), + ErrorKind::GitHubTokenProvider => write!(f, "GitHub token provider error"), } } } diff --git a/rust/src/generated/api_types.rs b/rust/src/generated/api_types.rs index bd32d490cd..e22c888f23 100644 --- a/rust/src/generated/api_types.rs +++ b/rust/src/generated/api_types.rs @@ -10,9 +10,10 @@ use std::collections::HashMap; use serde::{Deserialize, Serialize}; use super::session_events::{ - AbortReason, ContextTier, McpServerSource, McpServerStatus, PermissionPromptRequest, - PermissionRule, ReasoningSummary, SessionLimitsConfig, SessionMode, ShutdownType, SkillSource, - UserToolSessionApproval, Verbosity, + AbortReason, ContextTier, McpOauthHttpResponse, McpOauthWWWAuthenticateParams, McpServerSource, + McpServerStatus, ModelChangeSource, OmittedBinaryOmittedReason, PermissionMode, + PermissionPromptRequest, PermissionRule, ReasoningSummary, SessionLimitsConfig, SessionMode, + ShutdownType, SkillSource, TaskCompletionOutcome, UserToolSessionApproval, Verbosity, }; use crate::types::{RequestId, SessionEvent, SessionId}; @@ -24,6 +25,8 @@ 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` @@ -54,6 +57,18 @@ pub mod rpc_methods { pub const MCP_CONFIG_RELOAD: &str = "mcp.config.reload"; /// `mcp.discover` pub const MCP_DISCOVER: &str = "mcp.discover"; + /// `mcp.planInstall` + pub const MCP_PLANINSTALL: &str = "mcp.planInstall"; + /// `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"; + /// `catalog.search` + pub const CATALOG_SEARCH: &str = "catalog.search"; /// `plugins.list` pub const PLUGINS_LIST: &str = "plugins.list"; /// `plugins.install` @@ -68,6 +83,8 @@ pub mod rpc_methods { pub const PLUGINS_ENABLE: &str = "plugins.enable"; /// `plugins.disable` pub const PLUGINS_DISABLE: &str = "plugins.disable"; + /// `plugins.builtin.set` + pub const PLUGINS_BUILTIN_SET: &str = "plugins.builtin.set"; /// `plugins.marketplaces.list` pub const PLUGINS_MARKETPLACES_LIST: &str = "plugins.marketplaces.list"; /// `plugins.marketplaces.add` @@ -80,6 +97,8 @@ pub mod rpc_methods { pub const PLUGINS_MARKETPLACES_REFRESH: &str = "plugins.marketplaces.refresh"; /// `skills.config.setDisabledSkills` pub const SKILLS_CONFIG_SETDISABLEDSKILLS: &str = "skills.config.setDisabledSkills"; + /// `skills.config.setSkillDisabled` + pub const SKILLS_CONFIG_SETSKILLDISABLED: &str = "skills.config.setSkillDisabled"; /// `skills.discover` pub const SKILLS_DISCOVER: &str = "skills.discover"; /// `skills.getDiscoveryPaths` @@ -100,6 +119,8 @@ pub mod rpc_methods { 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` @@ -118,6 +139,10 @@ pub mod rpc_methods { 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` @@ -136,6 +161,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` @@ -175,14 +202,37 @@ pub mod rpc_methods { 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.gitHubAuth.getStatus` pub const SESSION_GITHUBAUTH_GETSTATUS: &str = "session.gitHubAuth.getStatus"; /// `session.gitHubAuth.setCredentials` pub const SESSION_GITHUBAUTH_SETCREDENTIALS: &str = "session.gitHubAuth.setCredentials"; + /// `session.gitHubAuth.getCurrentAuthInfo` + pub const SESSION_GITHUBAUTH_GETCURRENTAUTHINFO: &str = "session.gitHubAuth.getCurrentAuthInfo"; + /// `session.gitHubAuth.getAllAuthAvailable` + pub const SESSION_GITHUBAUTH_GETALLAUTHAVAILABLE: &str = + "session.gitHubAuth.getAllAuthAvailable"; + /// `session.gitHubAuth.refreshCopilotUser` + pub const SESSION_GITHUBAUTH_REFRESHCOPILOTUSER: &str = "session.gitHubAuth.refreshCopilotUser"; + /// `session.gitHubAuth.login` + pub const SESSION_GITHUBAUTH_LOGIN: &str = "session.gitHubAuth.login"; + /// `session.gitHubAuth.switchToAuth` + pub const SESSION_GITHUBAUTH_SWITCHTOAUTH: &str = "session.gitHubAuth.switchToAuth"; + /// `session.gitHubAuth.logout` + pub const SESSION_GITHUBAUTH_LOGOUT: &str = "session.gitHubAuth.logout"; + /// `session.gitHubAuth.logoutUser` + pub const SESSION_GITHUBAUTH_LOGOUTUSER: &str = "session.gitHubAuth.logoutUser"; + /// `session.gitHubAuth.lastAuthErrors` + pub const SESSION_GITHUBAUTH_LASTAUTHERRORS: &str = "session.gitHubAuth.lastAuthErrors"; /// `session.debug.collectLogs` pub const SESSION_DEBUG_COLLECTLOGS: &str = "session.debug.collectLogs"; /// `session.canvas.list` @@ -195,10 +245,26 @@ 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.canvas.provider.register` + pub const SESSION_CANVAS_PROVIDER_REGISTER: &str = "session.canvas.provider.register"; + /// `session.canvas.provider.unregister` + pub const SESSION_CANVAS_PROVIDER_UNREGISTER: &str = "session.canvas.provider.unregister"; /// `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.runFromTool` + pub const SESSION_FACTORY_RUNFROMTOOL: &str = "session.factory.runFromTool"; + /// `session.factory.resumeFromTool` + pub const SESSION_FACTORY_RESUMEFROMTOOL: &str = "session.factory.resumeFromTool"; /// `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` @@ -213,6 +279,8 @@ pub mod rpc_methods { pub const SESSION_MODEL_GETCURRENT: &str = "session.model.getCurrent"; /// `session.model.switchTo` pub const SESSION_MODEL_SWITCHTO: &str = "session.model.switchTo"; + /// `session.model.applyStartupOverlay` + pub const SESSION_MODEL_APPLYSTARTUPOVERLAY: &str = "session.model.applyStartupOverlay"; /// `session.model.setReasoningEffort` pub const SESSION_MODEL_SETREASONINGEFFORT: &str = "session.model.setReasoningEffort"; /// `session.model.list` @@ -240,6 +308,10 @@ pub mod rpc_methods { "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` @@ -250,6 +322,22 @@ 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` @@ -265,6 +353,8 @@ pub mod rpc_methods { 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` @@ -318,6 +408,8 @@ pub mod rpc_methods { pub const SESSION_MCP_DISABLE: &str = "session.mcp.disable"; /// `session.mcp.reload` pub const SESSION_MCP_RELOAD: &str = "session.mcp.reload"; + /// `session.mcp.moveLoadingToBackground` + pub const SESSION_MCP_MOVELOADINGTOBACKGROUND: &str = "session.mcp.moveLoadingToBackground"; /// `session.mcp.reloadWithConfig` pub const SESSION_MCP_RELOADWITHCONFIG: &str = "session.mcp.reloadWithConfig"; /// `session.mcp.executeSampling` @@ -345,8 +437,15 @@ pub mod rpc_methods { /// `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.probe` + pub const SESSION_MCP_OAUTH_PROBE: &str = "session.mcp.oauth.probe"; + /// `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"; @@ -391,18 +490,29 @@ pub mod rpc_methods { /// `session.extensions.sendAttachmentsToMessage` pub const SESSION_EXTENSIONS_SENDATTACHMENTSTOMESSAGE: &str = "session.extensions.sendAttachmentsToMessage"; + /// `session.tools.execute` + pub const SESSION_TOOLS_EXECUTE: &str = "session.tools.execute"; + /// `session.tools.getBuiltinDescriptors` + pub const SESSION_TOOLS_GETBUILTINDESCRIPTORS: &str = "session.tools.getBuiltinDescriptors"; + /// `session.tools.taskCompleteEventData` + pub const SESSION_TOOLS_TASKCOMPLETEEVENTDATA: &str = "session.tools.taskCompleteEventData"; /// `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.set` + pub const SESSION_TOOLS_SET: &str = "session.tools.set"; /// `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` pub const SESSION_COMMANDS_INVOKE: &str = "session.commands.invoke"; + /// `session.commands.finalizeInvocationEffect` + pub const SESSION_COMMANDS_FINALIZEINVOCATIONEFFECT: &str = + "session.commands.finalizeInvocationEffect"; /// `session.commands.handlePendingCommand` pub const SESSION_COMMANDS_HANDLEPENDINGCOMMAND: &str = "session.commands.handlePendingCommand"; /// `session.commands.execute` @@ -449,10 +559,10 @@ pub mod rpc_methods { pub const SESSION_PERMISSIONS_PENDINGREQUESTS: &str = "session.permissions.pendingRequests"; /// `session.permissions.setApproveAll` pub const SESSION_PERMISSIONS_SETAPPROVEALL: &str = "session.permissions.setApproveAll"; - /// `session.permissions.setAllowAll` - pub const SESSION_PERMISSIONS_SETALLOWALL: &str = "session.permissions.setAllowAll"; - /// `session.permissions.getAllowAll` - pub const SESSION_PERMISSIONS_GETALLOWALL: &str = "session.permissions.getAllowAll"; + /// `session.permissions.setMode` + pub const SESSION_PERMISSIONS_SETMODE: &str = "session.permissions.setMode"; + /// `session.permissions.getMode` + pub const SESSION_PERMISSIONS_GETMODE: &str = "session.permissions.getMode"; /// `session.permissions.modifyRules` pub const SESSION_PERMISSIONS_MODIFYRULES: &str = "session.permissions.modifyRules"; /// `session.permissions.setRequired` @@ -518,6 +628,8 @@ pub mod rpc_methods { 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` @@ -530,6 +642,12 @@ pub mod rpc_methods { 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"; @@ -537,12 +655,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` @@ -553,6 +704,8 @@ 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` @@ -565,6 +718,20 @@ pub mod rpc_methods { 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` @@ -595,6 +762,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` @@ -639,7 +808,7 @@ pub struct AbortResult { pub success: bool, } -/// Authenticated account entry returned by `account.getAllUsers`, with auth info and an optional associated token. +/// Endpoint URLs from the raw Copilot `/copilot_internal/v2/token` user-response passthrough. /// ///
/// @@ -649,50 +818,25 @@ pub struct AbortResult { ///
#[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 +pub struct CopilotUserResponseEndpoints { + /// Copilot API endpoint URL. #[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 + pub api: Option, + /// Experimental-service endpoint URL. #[serde(skip_serializing_if = "Option::is_none")] - pub auth_errors: Option>, - /// Current authentication information, if authenticated + pub exp: Option, + /// Origin-tracker endpoint URL. + #[serde(rename = "origin-tracker", skip_serializing_if = "Option::is_none")] + pub origin_tracker: Option, + /// Copilot proxy endpoint URL. #[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 { - /// GitHub token for per-user quota lookup. When provided, resolves this token to determine the user's quota instead of using the global auth. + pub proxy: Option, + /// Copilot telemetry endpoint URL. #[serde(skip_serializing_if = "Option::is_none")] - pub git_hub_token: Option, + pub telemetry: Option, } -/// Quota usage snapshot for a Copilot quota type, including entitlement, used requests, overage, reset date, and remaining percentage. +/// Chat quota snapshot from the raw Copilot user-response passthrough, with entitlement, overage, remaining quota, reset, and billing fields. /// ///
/// @@ -702,61 +846,49 @@ pub struct AccountGetQuotaRequest { ///
#[derive(Debug, Clone, Default, Serialize, Deserialize)] #[serde(rename_all = "camelCase")] -pub struct AccountQuotaSnapshot { - /// Number of requests included in the entitlement, or -1 for unlimited entitlements - pub entitlement_requests: i64, - /// Whether the user has an unlimited usage entitlement - pub is_unlimited_entitlement: bool, - /// Number of additional usage requests made this period - pub overage: f64, - /// Whether additional usage is allowed when quota is exhausted - pub overage_allowed_with_exhausted_quota: bool, - /// Percentage of entitlement remaining - pub remaining_percentage: f64, - /// Date when the quota resets (ISO 8601 string) +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 reset_date: Option, - /// Whether usage is still permitted after quota exhaustion - pub usage_allowed_with_exhausted_quota: bool, - /// Number of requests used so far this period - pub used_requests: i64, -} - -/// 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 { - /// Quota snapshots keyed by type (e.g., chat, completions, premium_interactions) - pub quota_snapshots: HashMap, -} - -/// 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, + 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, } -/// Result of a successful login; throws on failure +/// Completions quota snapshot from the raw Copilot user-response passthrough, with entitlement, overage, remaining quota, reset, and billing fields. /// ///
/// @@ -766,12 +898,49 @@ pub struct AccountLoginRequest { ///
#[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, +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, } -/// User to log out +/// Premium-interactions quota snapshot from the raw Copilot user-response passthrough, with entitlement, overage, remaining quota, reset, and billing fields. /// ///
/// @@ -781,12 +950,49 @@ pub struct AccountLoginResult { ///
#[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, +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, } -/// Logout result indicating if more users remain +/// Quota snapshot map from the raw Copilot user-response passthrough, with chat, completions, premium-interactions, and other entries. /// ///
/// @@ -796,12 +1002,22 @@ pub struct AccountLogoutRequest { ///
#[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, +pub struct CopilotUserResponseQuotaSnapshots { + /// 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, + /// 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, + /// 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" + )] + pub premium_interactions: Option, } -/// Canonical directory where custom agents can be discovered or created, with scope, preference, and optional project path. +/// 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. /// ///
/// @@ -811,34 +1027,124 @@ pub struct AccountLogoutResult { ///
#[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, +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, + /// 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, + /// 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" + )] + pub token_based_billing: Option, } -/// Custom agent metadata, including identifiers, display details, source, tools, model, MCP servers, skills, and file path. +/// Authentication-info input variant for GitHub-internal HMAC auth, carrying the public GitHub host and HMAC secret. /// ///
/// @@ -848,46 +1154,19 @@ pub struct AgentDiscoveryPathList { ///
#[derive(Debug, Clone, Default, Serialize, Deserialize)] #[serde(rename_all = "camelCase")] -pub struct AgentInfo { - /// Description of the agent's purpose - pub description: String, - /// Human-readable display name - pub display_name: 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. - pub id: String, - /// MCP server configurations attached to this agent, keyed by server name. Server config shape mirrors the MCP `mcpServers` schema. - /// - ///
- /// - /// **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_servers: Option>, - /// Preferred model id for this agent. When omitted, inherits the outer agent's model. - #[serde(skip_serializing_if = "Option::is_none")] - pub model: Option, - /// Unique identifier of the custom agent - 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, - /// Skill names preloaded into this agent's context. Omitted means none. - #[serde(skip_serializing_if = "Option::is_none")] - pub skills: Option>, - /// Where the agent definition was loaded from - #[serde(skip_serializing_if = "Option::is_none")] - pub source: Option, - /// Allowed tool names for this agent. Empty array means none; omitted means inherit defaults. - #[serde(skip_serializing_if = "Option::is_none")] - pub tools: Option>, - /// Whether the agent can be selected directly by the user. Agents marked `false` are subagent-only. +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 user_invocable: Option, + 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, } -/// The currently selected custom agent, or null when using the default agent. +/// Authentication-info input variant for a token sourced from an environment variable, with host, optional login, token, and env var name. /// ///
/// @@ -897,12 +1176,24 @@ pub struct AgentInfo { ///
#[derive(Debug, Clone, Default, Serialize, Deserialize)] #[serde(rename_all = "camelCase")] -pub struct AgentGetCurrentResult { - /// Currently selected custom agent, or null if using the default agent - pub agent: AgentInfo, +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, } -/// Custom agents available to the session. +/// Authentication-info input variant for SDK-configured token authentication, carrying host and the secret token value. /// ///
/// @@ -912,12 +1203,22 @@ pub struct AgentGetCurrentResult { ///
#[derive(Debug, Clone, Default, Serialize, Deserialize)] #[serde(rename_all = "camelCase")] -pub struct AgentList { - /// Available custom agents - pub agents: Vec, +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, + /// Opaque native GitHub credential registration backing this token identity, when applicable. + #[serde(skip_serializing_if = "Option::is_none")] + pub registration_id: Option, + /// 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, } -/// Full registry entry for the spawned child. Lets the controller call `handleLiveTargetSelected(entry)` directly without re-reading the registry (avoids a TOCTOU window). +/// Authentication-info variant backed by an SDK GitHub token callback. It carries routing metadata but never a plaintext token. /// ///
/// @@ -927,57 +1228,19 @@ pub struct AgentList { ///
#[derive(Debug, Clone, Default, Serialize, Deserialize)] #[serde(rename_all = "camelCase")] -pub struct AgentRegistryLiveTargetEntry { - /// Kind of attention required when status === "attention". Meaningful only when status === "attention". - #[serde(skip_serializing_if = "Option::is_none")] - pub attention_kind: Option, - /// Git branch of the session (when known) - #[serde(skip_serializing_if = "Option::is_none")] - pub branch: Option, - /// Copilot CLI version that wrote the entry - pub copilot_version: String, - /// Working directory of the session (when known) +pub struct TokenProviderAuthInfo { + /// Snapshot of the authenticated user's Copilot subscription info, if known. #[serde(skip_serializing_if = "Option::is_none")] - pub cwd: Option, - /// Bind host for the entry's JSON-RPC server + pub copilot_user: Option, + /// Authentication host. pub host: String, - /// Process kind tag for the registry entry - pub kind: AgentRegistryLiveTargetEntryKind, - /// Wall-clock milliseconds since the watcher last observed this entry (heartbeat freshness) - pub last_seen_ms: i64, - /// How the most recent turn ended (clean vs aborted). Lets the renderer distinguish done from done_cancelled. - #[serde(skip_serializing_if = "Option::is_none")] - pub last_terminal_event: Option, - /// Model identifier currently selected for the session - #[serde(skip_serializing_if = "Option::is_none")] - pub model: Option, - /// Operating-system pid of the process owning this entry - pub pid: i64, - /// TCP port the entry's JSON-RPC server is listening on - pub port: i64, - /// Registry entry schema version (1 = ui-server, 2 = managed-server) - pub schema_version: i64, - /// Session ID of the foreground session for this entry - #[serde(skip_serializing_if = "Option::is_none")] - pub session_id: Option, - /// Friendly session name (when set) - #[serde(skip_serializing_if = "Option::is_none")] - pub session_name: Option, - /// ISO 8601 timestamp captured at registration - pub started_at: String, - /// Coarse lifecycle status of the foreground session - #[serde(skip_serializing_if = "Option::is_none")] - pub status: Option, - /// Monotonic per-publisher revision counter incremented on every status update. Lets watchers detect transient flips. - #[serde(skip_serializing_if = "Option::is_none")] - pub status_revision: Option, - /// Connection token (null when the target is unauthenticated) - #[doc(hidden)] - #[serde(skip_serializing_if = "Option::is_none")] - pub(crate) token: Option, + /// Opaque SDK callback registration identifier. + pub registration_id: String, + /// SDK callback-backed GitHub token authentication. + pub r#type: TokenProviderAuthInfoType, } -/// Per-spawn log-capture outcome; populated from spawnLiveTarget. +/// Authentication-info variant for direct Copilot API token auth sourced from environment variables, with public GitHub host. /// ///
/// @@ -987,21 +1250,17 @@ pub struct AgentRegistryLiveTargetEntry { ///
#[derive(Debug, Clone, Default, Serialize, Deserialize)] #[serde(rename_all = "camelCase")] -pub struct AgentRegistryLogCapture { - /// Whether per-spawn log capture is on (false when env-disabled or open failed) - pub enabled: bool, - /// Human-readable open failure message (only set when enabled === false AND the env-disable opt-out was NOT used) +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 open_error: Option, - /// Categorized reason for log-open failure - #[serde(skip_serializing_if = "Option::is_none")] - pub open_error_reason: Option, - /// Absolute path to the per-spawn log file (only set when enabled) - #[serde(skip_serializing_if = "Option::is_none")] - pub path: Option, + 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, } -/// `child_process.spawn` itself failed before the child entered the registry. +/// Authentication-info variant for OAuth user auth, with host and login; the token remains in the runtime secret store. /// ///
/// @@ -1011,17 +1270,19 @@ pub struct AgentRegistryLogCapture { ///
#[derive(Debug, Clone, Default, Serialize, Deserialize)] #[serde(rename_all = "camelCase")] -pub struct AgentRegistrySpawnError { - /// Underlying errno code (e.g. ENOENT, EACCES) when available +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 code: Option, - /// Discriminator: child_process.spawn itself failed - pub kind: AgentRegistrySpawnErrorKind, - /// Human-readable error message - pub message: String, + 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, } -/// Spawn succeeded but the child did not publish a matching managed-server entry within the timeout. +/// Authentication-info input variant for GitHub CLI credentials, carrying host, login, and the `gh auth token` value. /// ///
/// @@ -1031,17 +1292,21 @@ pub struct AgentRegistrySpawnError { ///
#[derive(Debug, Clone, Default, Serialize, Deserialize)] #[serde(rename_all = "camelCase")] -pub struct AgentRegistrySpawnRegistryTimeout { - /// Process ID of the orphaned child (so the caller can offer 'kill the pid' guidance) - pub child_pid: i64, - /// Discriminator: spawn succeeded but child never registered - pub kind: AgentRegistrySpawnRegistryTimeoutKind, - /// Per-spawn log-capture outcome; populated from spawnLiveTarget. +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 log_capture: Option, + 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, } -/// Inputs to spawn a managed-server child via the controller's spawn delegate. +/// Authentication-info input variant for API-key authentication to a non-GitHub LLM provider, carrying the secret `apiKey` and host. /// ///
/// @@ -1051,27 +1316,19 @@ pub struct AgentRegistrySpawnRegistryTimeout { ///
#[derive(Debug, Clone, Default, Serialize, Deserialize)] #[serde(rename_all = "camelCase")] -pub struct AgentRegistrySpawnRequest { - /// Custom or built-in agent name (e.g. 'explore'). When omitted, the child uses its own default. - #[serde(skip_serializing_if = "Option::is_none")] - pub agent_name: Option, - /// Working directory for the spawned child (must be an existing directory) - pub cwd: String, - /// Optional first user message. Forwarded to the caller (the CLI's spawn wrapper sends it post-attach via the standard LocalRpcSession.send path). - #[serde(skip_serializing_if = "Option::is_none")] - pub initial_prompt: Option, - /// Model identifier to apply to the new session - #[serde(skip_serializing_if = "Option::is_none")] - pub model: Option, - /// Friendly session name. Must satisfy validateSessionName: non-empty, no leading/trailing whitespace, <=100 chars, no control chars, no double quotes. - #[serde(skip_serializing_if = "Option::is_none")] - pub name: Option, - /// Permission posture for the new session. 'yolo' requires the controller-local session to currently be in allow-all mode. +pub struct ApiKeyAuthInfo { + /// The API key. Treat as a secret. + pub api_key: String, + /// 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 permission_mode: Option, + pub copilot_user: Option, + /// Authentication host. + pub host: String, + /// API-key authentication for non-GitHub LLM providers (e.g. when running BYOM-style). + pub r#type: ApiKeyAuthInfoType, } -/// Managed-server child was spawned and registered successfully. +/// Authenticated account entry returned by `account.getAllUsers`. /// ///
/// @@ -1079,25 +1336,20 @@ pub struct AgentRegistrySpawnRequest { /// 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 AgentRegistrySpawnSpawned { - /// Full registry entry for the spawned child. Lets the controller call `handleLiveTargetSelected(entry)` directly without re-reading the registry (avoids a TOCTOU window). - pub entry: AgentRegistryLiveTargetEntry, - /// If the delegate attempted to send the initial prompt and failed, the categorized error message. - #[serde(skip_serializing_if = "Option::is_none")] - pub initial_prompt_error: Option, - /// 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. +pub struct AccountAllUsers { + /// Authentication information for this user + pub auth_info: AuthInfo, + /// Opaque identifier accepted by account and model selection APIs #[serde(skip_serializing_if = "Option::is_none")] - pub initial_prompt_sent: Option, - /// Discriminator: managed-server child spawned successfully - pub kind: AgentRegistrySpawnSpawnedKind, - /// Per-spawn log-capture outcome; populated from spawnLiveTarget. + pub selection_id: Option, + /// Associated token, if available #[serde(skip_serializing_if = "Option::is_none")] - pub log_capture: Option, + pub token: Option, } -/// Synchronous pre-validation rejected the spawn request. +/// Current authentication state /// ///
/// @@ -1107,19 +1359,16 @@ pub struct AgentRegistrySpawnSpawned { ///
#[derive(Debug, Clone, Default, Serialize, Deserialize)] #[serde(rename_all = "camelCase")] -pub struct AgentRegistrySpawnValidationError { - /// Which parameter field was invalid. Omitted when the rejection is not field-specific. +pub struct AccountGetCurrentAuthResult { + /// Authentication errors from the last auth attempt, if any #[serde(skip_serializing_if = "Option::is_none")] - pub field: Option, - /// Discriminator: synchronous pre-validation rejected the request - pub kind: AgentRegistrySpawnValidationErrorKind, - /// Human-readable explanation; safe to surface in the UI banner. Never logged to unrestricted telemetry. - pub message: String, - /// Categorized reason for the rejection. Low-cardinality enum so telemetry can aggregate by reason without leaking raw paths or agent/model names. - pub reason: AgentRegistrySpawnValidationErrorReason, + pub auth_errors: Option>, + /// Current authentication information, if authenticated + #[serde(skip_serializing_if = "Option::is_none")] + pub auth_info: Option, } -/// Custom agents available to the session after reloading definitions from disk. +/// Optional opaque account selection or compatibility GitHub token used to look up quota. /// ///
/// @@ -1129,12 +1378,16 @@ pub struct AgentRegistrySpawnValidationError { ///
#[derive(Debug, Clone, Default, Serialize, Deserialize)] #[serde(rename_all = "camelCase")] -pub struct AgentReloadResult { - /// Reloaded custom agents - pub agents: Vec, +pub struct AccountGetQuotaRequest { + /// GitHub token accepted for compatibility with existing SDK clients. When provided, resolves this token instead of using the current account. + #[serde(skip_serializing_if = "Option::is_none")] + pub git_hub_token: Option, + /// Opaque account identifier returned by `account.getAllUsers`. When omitted, the current account is used. + #[serde(skip_serializing_if = "Option::is_none")] + pub selection_id: Option, } -/// Optional project paths to include in agent discovery. +/// Quota usage snapshot for a Copilot quota type, including entitlement, used requests, overage, reset date, and remaining percentage. /// ///
/// @@ -1144,16 +1397,27 @@ pub struct AgentReloadResult { ///
#[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). +pub struct AccountQuotaSnapshot { + /// Number of requests included in the entitlement, or -1 for unlimited entitlements + pub entitlement_requests: i64, + /// Whether the user has an unlimited usage entitlement + pub is_unlimited_entitlement: bool, + /// Number of additional usage requests made this period + pub overage: f64, + /// Whether additional usage is allowed when quota is exhausted + pub overage_allowed_with_exhausted_quota: bool, + /// Percentage of entitlement remaining + pub remaining_percentage: f64, + /// Date when the quota resets (ISO 8601 string) #[serde(skip_serializing_if = "Option::is_none")] - pub project_paths: Option>, + pub reset_date: Option, + /// Whether usage is still permitted after quota exhaustion + pub usage_allowed_with_exhausted_quota: bool, + /// Number of requests used so far this period + pub used_requests: i64, } -/// Name of the custom agent to select for subsequent turns. +/// Quota usage snapshots for the resolved user, keyed by quota type. /// ///
/// @@ -1163,12 +1427,12 @@ pub struct AgentsDiscoverRequest { ///
#[derive(Debug, Clone, Default, Serialize, Deserialize)] #[serde(rename_all = "camelCase")] -pub struct AgentSelectRequest { - /// Name of the custom agent to select - pub name: String, +pub struct AccountGetQuotaResult { + /// Quota snapshots keyed by type (e.g., chat, completions, premium_interactions) + pub quota_snapshots: HashMap, } -/// The newly selected custom agent. +/// Credentials to validate and store. Omit login to resolve the authenticated user from the token. /// ///
/// @@ -1178,12 +1442,17 @@ pub struct AgentSelectRequest { ///
#[derive(Debug, Clone, Default, Serialize, Deserialize)] #[serde(rename_all = "camelCase")] -pub struct AgentSelectResult { - /// The newly selected custom agent - pub agent: AgentInfo, +pub struct AccountLoginRequest { + /// GitHub host URL + pub host: String, + /// User login/username. When omitted, the runtime validates the token and resolves the login from GitHub. + #[serde(skip_serializing_if = "Option::is_none")] + pub login: Option, + /// GitHub authentication token + pub token: String, } -/// Optional project paths to include when enumerating agent discovery directories. +/// Result of a successful login; throws on failure /// ///
/// @@ -1193,16 +1462,12 @@ pub struct AgentSelectResult { ///
#[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>, +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, } -/// Indicates whether the operation succeeded and reports the post-mutation state. +/// User to log out /// ///
/// @@ -1212,17 +1477,16 @@ pub struct AgentsGetDiscoveryPathsRequest { ///
#[derive(Debug, Clone, Default, Serialize, Deserialize)] #[serde(rename_all = "camelCase")] -pub struct AllowAllPermissionSetResult { - /// Authoritative full allow-all state after the mutation - pub enabled: bool, - /// Authoritative allow-all mode after the mutation +pub struct AccountLogoutRequest { + /// Authentication information for the user to log out #[serde(skip_serializing_if = "Option::is_none")] - pub mode: Option, - /// Whether the operation succeeded - pub success: bool, + pub auth_info: Option, + /// Opaque account identifier returned by `account.getAllUsers` + #[serde(skip_serializing_if = "Option::is_none")] + pub selection_id: Option, } -/// Current allow-all permission mode. +/// Logout result indicating if more users remain /// ///
/// @@ -1232,15 +1496,12 @@ pub struct AllowAllPermissionSetResult { ///
#[derive(Debug, Clone, Default, Serialize, Deserialize)] #[serde(rename_all = "camelCase")] -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, +pub struct AccountLogoutResult { + /// Whether other authenticated users remain after logout + pub has_more_users: bool, } -/// Endpoint URLs from the raw Copilot `/copilot_internal/v2/token` user-response passthrough. +/// Canonical directory where custom agents can be discovered or created, with scope, preference, and optional project path. /// ///
/// @@ -1250,18 +1511,19 @@ pub struct AllowAllPermissionState { ///
#[derive(Debug, Clone, Default, Serialize, Deserialize)] #[serde(rename_all = "camelCase")] -pub struct CopilotUserResponseEndpoints { - #[serde(skip_serializing_if = "Option::is_none")] - pub api: Option, - #[serde(rename = "origin-tracker", skip_serializing_if = "Option::is_none")] - pub origin_tracker: Option, - #[serde(skip_serializing_if = "Option::is_none")] - pub proxy: Option, +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 telemetry: Option, + pub project_path: Option, + /// Which tier this directory belongs to + pub scope: AgentDiscoveryPathScope, } -/// Chat quota snapshot from the raw Copilot user-response passthrough, with entitlement, overage, remaining quota, reset, and billing fields. +/// Canonical locations where custom agents can be created so the runtime will recognize them. /// ///
/// @@ -1271,49 +1533,12 @@ 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, +pub struct AgentDiscoveryPathList { + /// Canonical agent create/discovery directories, in priority order + pub paths: Vec, } -/// Completions quota snapshot from the raw Copilot user-response passthrough, with entitlement, overage, remaining quota, reset, and billing fields. +/// Agent metadata, including identifiers, display details, source, tools, model, MCP servers, skills, and file path. /// ///
/// @@ -1323,49 +1548,49 @@ 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. +pub struct AgentInfo { + /// Description of the agent's purpose + pub description: String, + /// Human-readable display name + pub display_name: 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. + pub id: String, + /// MCP server configurations attached to this agent, keyed by server name. Server config shape mirrors the MCP `mcpServers` schema. + /// + ///
+ /// + /// **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 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. + pub mcp_servers: Option>, + /// 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 unlimited: Option, + pub model: Option, + /// 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>, + /// Where the agent definition was loaded from + #[serde(skip_serializing_if = "Option::is_none")] + pub source: Option, + /// Allowed tool names for this agent. Empty array means none; omitted means inherit defaults. + #[serde(skip_serializing_if = "Option::is_none")] + pub tools: Option>, + /// Whether the agent can be selected directly by the user. Agents marked `false` are subagent-only. + #[serde(skip_serializing_if = "Option::is_none")] + pub user_invocable: Option, } -/// Premium-interactions quota snapshot from the raw Copilot user-response passthrough, with entitlement, overage, remaining quota, reset, and billing fields. +/// The currently selected custom agent, or null when using the default agent. /// ///
/// @@ -1375,49 +1600,12 @@ 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, +pub struct AgentGetCurrentResult { + /// Currently selected custom agent, or null if using the default agent + pub agent: AgentInfo, } -/// Quota snapshot map from the raw Copilot user-response passthrough, with chat, completions, premium-interactions, and other entries. +/// Agents available to the session. /// ///
/// @@ -1427,22 +1615,12 @@ pub struct CopilotUserResponseQuotaSnapshotsPremiumInteractions { ///
#[derive(Debug, Clone, Default, Serialize, Deserialize)] #[serde(rename_all = "camelCase")] -pub struct CopilotUserResponseQuotaSnapshots { - /// 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, - /// 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, - /// 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" - )] - pub premium_interactions: Option, +pub struct AgentList { + /// Available agents + pub agents: Vec, } -/// 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. +/// Controls whether built-in agents and authored prompt text are included. /// ///
/// @@ -1452,124 +1630,16 @@ 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, - /// 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. +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 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, - /// 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. + 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 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" - )] - pub token_based_billing: Option, + pub include_prompt: Option, } -/// Authentication-info variant for API-key authentication to a non-GitHub LLM provider, carrying the secret `apiKey` and host. +/// Full registry entry for the spawned child. Lets the controller call `handleLiveTargetSelected(entry)` directly without re-reading the registry (avoids a TOCTOU window). /// ///
/// @@ -1579,19 +1649,57 @@ pub struct CopilotUserResponse { ///
#[derive(Debug, Clone, Default, Serialize, Deserialize)] #[serde(rename_all = "camelCase")] -pub struct ApiKeyAuthInfo { - /// The API key. Treat as a secret. - pub api_key: String, - /// 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 AgentRegistryLiveTargetEntry { + /// Kind of attention required when status === "attention". Meaningful only when status === "attention". #[serde(skip_serializing_if = "Option::is_none")] - pub copilot_user: Option, - /// Authentication host. - pub host: String, - /// API-key authentication for non-GitHub LLM providers (e.g. when running BYOM-style). - pub r#type: ApiKeyAuthInfoType, + pub attention_kind: Option, + /// Git branch of the session (when known) + #[serde(skip_serializing_if = "Option::is_none")] + pub branch: Option, + /// Copilot CLI version that wrote the entry + pub copilot_version: String, + /// Working directory of the session (when known) + #[serde(skip_serializing_if = "Option::is_none")] + pub cwd: Option, + /// Bind host for the entry's JSON-RPC server + pub host: String, + /// Process kind tag for the registry entry + pub kind: AgentRegistryLiveTargetEntryKind, + /// Wall-clock milliseconds since the watcher last observed this entry (heartbeat freshness) + pub last_seen_ms: i64, + /// How the most recent turn ended (clean vs aborted). Lets the renderer distinguish done from done_cancelled. + #[serde(skip_serializing_if = "Option::is_none")] + pub last_terminal_event: Option, + /// Model identifier currently selected for the session + #[serde(skip_serializing_if = "Option::is_none")] + pub model: Option, + /// Operating-system pid of the process owning this entry + pub pid: i64, + /// TCP port the entry's JSON-RPC server is listening on + pub port: i64, + /// Registry entry schema version (1 = ui-server, 2 = managed-server) + pub schema_version: i64, + /// Session ID of the foreground session for this entry + #[serde(skip_serializing_if = "Option::is_none")] + pub session_id: Option, + /// Friendly session name (when set) + #[serde(skip_serializing_if = "Option::is_none")] + pub session_name: Option, + /// ISO 8601 timestamp captured at registration + pub started_at: String, + /// Coarse lifecycle status of the foreground session + #[serde(skip_serializing_if = "Option::is_none")] + pub status: Option, + /// Monotonic per-publisher revision counter incremented on every status update. Lets watchers detect transient flips. + #[serde(skip_serializing_if = "Option::is_none")] + pub status_revision: Option, + /// Connection token (null when the target is unauthenticated) + #[doc(hidden)] + #[serde(skip_serializing_if = "Option::is_none")] + pub(crate) token: Option, } -/// Blob attachment with inline base64-encoded data +/// Per-spawn log-capture outcome; populated from spawnLiveTarget. /// ///
/// @@ -1601,29 +1709,21 @@ pub struct ApiKeyAuthInfo { ///
#[derive(Debug, Clone, Default, Serialize, Deserialize)] #[serde(rename_all = "camelCase")] -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 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, - /// 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. +pub struct AgentRegistryLogCapture { + /// Whether per-spawn log capture is on (false when env-disabled or open failed) + pub enabled: bool, + /// Human-readable open failure message (only set when enabled === false AND the env-disable opt-out was NOT used) #[serde(skip_serializing_if = "Option::is_none")] - pub data: Option, - /// User-facing display name for the attachment + pub open_error: Option, + /// Categorized reason for log-open failure #[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. + pub open_error_reason: Option, + /// Absolute path to the per-spawn log file (only set when enabled) #[serde(skip_serializing_if = "Option::is_none")] - pub omitted_reason: Option, - /// Attachment type discriminator - pub r#type: AttachmentBlobType, + pub path: Option, } -/// Directory attachment +/// `child_process.spawn` itself failed before the child entered the registry. /// ///
/// @@ -1633,19 +1733,17 @@ pub struct AttachmentBlob { ///
#[derive(Debug, Clone, Default, Serialize, Deserialize)] #[serde(rename_all = "camelCase")] -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. +pub struct AgentRegistrySpawnError { + /// Underlying errno code (e.g. ENOENT, EACCES) when available #[serde(skip_serializing_if = "Option::is_none")] - pub tagged_files_entry: Option, - /// Attachment type discriminator - pub r#type: AttachmentDirectoryType, + pub code: Option, + /// Discriminator: child_process.spawn itself failed + pub kind: AgentRegistrySpawnErrorKind, + /// Human-readable error message + pub message: String, } -/// 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. +/// Spawn succeeded but the child did not publish a matching managed-server entry within the timeout. /// ///
/// @@ -1655,27 +1753,17 @@ pub struct AttachmentDirectory { ///
#[derive(Debug, Clone, Default, Serialize, Deserialize)] #[serde(rename_all = "camelCase")] -pub struct AttachmentExtensionContext { - /// Provider-local canvas identifier when the push was bound to a canvas instance - #[serde(skip_serializing_if = "Option::is_none")] - 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 +pub struct AgentRegistrySpawnRegistryTimeout { + /// Process ID of the orphaned child (so the caller can offer 'kill the pid' guidance) + pub child_pid: i64, + /// Discriminator: spawn succeeded but child never registered + pub kind: AgentRegistrySpawnRegistryTimeoutKind, + /// Per-spawn log-capture outcome; populated from spawnLiveTarget. #[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, + pub log_capture: Option, } -/// Optional line range to scope the attachment to a specific section of the file +/// Inputs to spawn a managed-server child via the controller's spawn delegate. /// ///
/// @@ -1685,14 +1773,27 @@ pub struct AttachmentExtensionContext { ///
#[derive(Debug, Clone, Default, Serialize, Deserialize)] #[serde(rename_all = "camelCase")] -pub struct AttachmentFileLineRange { - /// End line number (1-based, inclusive) - pub end: i64, - /// Start line number (1-based) - pub start: i64, +pub struct AgentRegistrySpawnRequest { + /// Custom or built-in agent name (e.g. 'explore'). When omitted, the child uses its own default. + #[serde(skip_serializing_if = "Option::is_none")] + pub agent_name: Option, + /// Working directory for the spawned child (must be an existing directory) + pub cwd: String, + /// Optional first user message. Forwarded to the caller (the CLI's spawn wrapper sends it post-attach via the standard LocalRpcSession.send path). + #[serde(skip_serializing_if = "Option::is_none")] + pub initial_prompt: Option, + /// Model identifier to apply to the new session + #[serde(skip_serializing_if = "Option::is_none")] + pub model: Option, + /// Friendly session name. Must satisfy validateSessionName: non-empty, no leading/trailing whitespace, <=100 chars, no control chars, no double quotes. + #[serde(skip_serializing_if = "Option::is_none")] + pub name: Option, + /// Permission posture for the new session. 'yolo' requires the controller-local session to currently be in allow-all mode. + #[serde(skip_serializing_if = "Option::is_none")] + pub permission_mode: Option, } -/// File attachment +/// Managed-server child was spawned and registered successfully. /// ///
/// @@ -1702,34 +1803,23 @@ pub struct AttachmentFileLineRange { ///
#[derive(Debug, Clone, Default, Serialize, Deserialize)] #[serde(rename_all = "camelCase")] -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 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. +pub struct AgentRegistrySpawnSpawned { + /// Full registry entry for the spawned child. Lets the controller call `handleLiveTargetSelected(entry)` directly without re-reading the registry (avoids a TOCTOU window). + pub entry: AgentRegistryLiveTargetEntry, + /// If the delegate attempted to send the initial prompt and failed, the categorized error message. #[serde(skip_serializing_if = "Option::is_none")] - pub mime_type: Option, - /// Internal: why model-facing bytes are absent from persistence. Absent externally. + pub initial_prompt_error: Option, + /// 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. #[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). + pub initial_prompt_sent: Option, + /// Discriminator: managed-server child spawned successfully + pub kind: AgentRegistrySpawnSpawnedKind, + /// Per-spawn log-capture outcome; populated from spawnLiveTarget. #[serde(skip_serializing_if = "Option::is_none")] - pub tagged_files_entry: Option, - /// Attachment type discriminator - pub r#type: AttachmentFileType, + pub log_capture: Option, } -/// Pointer to a GitHub repository. +/// Synchronous pre-validation rejected the spawn request. /// ///
/// @@ -1739,17 +1829,19 @@ pub struct AttachmentFile { ///
#[derive(Debug, Clone, Default, Serialize, Deserialize)] #[serde(rename_all = "camelCase")] -pub struct GitHubRepoRef { - /// Numeric GitHub repository id +pub struct AgentRegistrySpawnValidationError { + /// Which parameter field was invalid. Omitted when the rejection is not field-specific. #[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, + pub field: Option, + /// Discriminator: synchronous pre-validation rejected the request + pub kind: AgentRegistrySpawnValidationErrorKind, + /// Human-readable explanation; safe to surface in the UI banner. Never logged to unrestricted telemetry. + pub message: String, + /// Categorized reason for the rejection. Low-cardinality enum so telemetry can aggregate by reason without leaking raw paths or agent/model names. + pub reason: AgentRegistrySpawnValidationErrorReason, } -/// Pointer to a GitHub Actions job. +/// Custom agents available to the session after reloading definitions from disk. /// ///
/// @@ -1759,25 +1851,12 @@ pub struct GitHubRepoRef { ///
#[derive(Debug, Clone, Default, Serialize, Deserialize)] #[serde(rename_all = "camelCase")] -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 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, +pub struct AgentReloadResult { + /// Reloaded custom agents + pub agents: Vec, } -/// Pointer to a GitHub commit. +/// Optional project paths to include in agent discovery. /// ///
/// @@ -1787,20 +1866,16 @@ pub struct AttachmentGitHubActionsJob { ///
#[derive(Debug, Clone, Default, Serialize, Deserialize)] #[serde(rename_all = "camelCase")] -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, +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>, } -/// Pointer to a file in a GitHub repository at a specific ref. +/// Name of the custom agent to select for subsequent turns. /// ///
/// @@ -1810,20 +1885,12 @@ pub struct AttachmentGitHubCommit { ///
#[derive(Debug, Clone, Default, Serialize, Deserialize)] #[serde(rename_all = "camelCase")] -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, +pub struct AgentSelectRequest { + /// Name of the custom agent to select + pub name: String, } -/// One side of a file diff (head or base) +/// The newly selected custom agent. /// ///
/// @@ -1833,16 +1900,12 @@ pub struct AttachmentGitHubFile { ///
#[derive(Debug, Clone, Default, Serialize, Deserialize)] #[serde(rename_all = "camelCase")] -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, +pub struct AgentSelectResult { + /// The newly selected custom agent + pub agent: AgentInfo, } -/// Pointer to a single-file diff. At least one of `head` and `base` must be present. +/// An in-memory authored prompt override for an available agent. /// ///
/// @@ -1852,20 +1915,14 @@ pub struct AttachmentGitHubFileDiffSide { ///
#[derive(Debug, Clone, Default, Serialize, Deserialize)] #[serde(rename_all = "camelCase")] -pub struct AttachmentGitHubFileDiff { - /// File location on the base side of the diff. Absent for additions. - #[serde(skip_serializing_if = "Option::is_none")] - pub base: Option, - /// File location on the head side of the diff. Absent for deletions. - #[serde(skip_serializing_if = "Option::is_none")] - 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, +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, } -/// GitHub issue, pull request, or discussion reference +/// Optional project paths to include when enumerating agent discovery directories. /// ///
/// @@ -1875,22 +1932,16 @@ pub struct AttachmentGitHubFileDiff { ///
#[derive(Debug, Clone, Default, Serialize, Deserialize)] #[serde(rename_all = "camelCase")] -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, +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>, } -/// Pointer to a GitHub release. +/// Blob attachment with inline base64-encoded data /// ///
/// @@ -1900,20 +1951,29 @@ pub struct AttachmentGitHubReference { ///
#[derive(Debug, Clone, Default, Serialize, Deserialize)] #[serde(rename_all = "camelCase")] -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, +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 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, + /// 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: AttachmentGitHubReleaseType, - /// URL to the release on GitHub - pub url: String, + pub r#type: AttachmentBlobType, } -/// Pointer to a GitHub repository. +/// Directory attachment /// ///
/// @@ -1923,22 +1983,19 @@ pub struct AttachmentGitHubRelease { ///
#[derive(Debug, Clone, Default, Serialize, Deserialize)] #[serde(rename_all = "camelCase")] -pub struct AttachmentGitHubRepository { - /// 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. +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 r#ref: Option, - /// Repository pointer - pub repo: GitHubRepoRef, + pub tagged_files_entry: Option, /// Attachment type discriminator - pub r#type: AttachmentGitHubRepositoryType, - /// URL to the repository on GitHub - pub url: String, + pub r#type: AttachmentDirectoryType, } -/// Pointer to a line range inside a file in a GitHub repository. +/// 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. /// ///
/// @@ -1948,22 +2005,27 @@ pub struct AttachmentGitHubRepository { ///
#[derive(Debug, Clone, Default, Serialize, Deserialize)] #[serde(rename_all = "camelCase")] -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, +pub struct AttachmentExtensionContext { + /// Provider-local canvas identifier when the push was bound to a canvas instance + #[serde(skip_serializing_if = "Option::is_none")] + 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: AttachmentGitHubSnippetType, - /// URL to the snippet on GitHub (with line anchor) - pub url: String, + pub r#type: AttachmentExtensionContextType, } -/// One side of a tree comparison (head or base) +/// Optional line range to scope the attachment to a specific section of the file /// ///
/// @@ -1973,14 +2035,14 @@ pub struct AttachmentGitHubSnippet { ///
#[derive(Debug, Clone, Default, Serialize, Deserialize)] #[serde(rename_all = "camelCase")] -pub struct AttachmentGitHubTreeComparisonSide { - /// Repository the revision belongs to - pub repo: GitHubRepoRef, - /// Git revision (branch, tag, or commit SHA) - pub revision: String, +pub struct AttachmentFileLineRange { + /// End line number (1-based, inclusive) + pub end: i64, + /// Start line number (1-based) + pub start: i64, } -/// Pointer to a comparison between two git revisions. +/// File attachment /// ///
/// @@ -1990,18 +2052,34 @@ pub struct AttachmentGitHubTreeComparisonSide { ///
#[derive(Debug, Clone, Default, Serialize, Deserialize)] #[serde(rename_all = "camelCase")] -pub struct AttachmentGitHubTreeComparison { - /// Base side of the comparison - pub base: AttachmentGitHubTreeComparisonSide, - /// Head side of the comparison - pub head: AttachmentGitHubTreeComparisonSide, +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 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: AttachmentGitHubTreeComparisonType, - /// URL to the comparison on GitHub - pub url: String, + pub r#type: AttachmentFileType, } -/// Generic GitHub URL reference. +/// Pointer to a GitHub repository. /// ///
/// @@ -2011,14 +2089,17 @@ pub struct AttachmentGitHubTreeComparison { ///
#[derive(Debug, Clone, Default, Serialize, Deserialize)] #[serde(rename_all = "camelCase")] -pub struct AttachmentGitHubUrl { - /// Attachment type discriminator - pub r#type: AttachmentGitHubUrlType, - /// URL to the GitHub resource - pub url: String, +pub struct GitHubRepoRef { + /// 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, } -/// End position of the selection +/// Pointer to a GitHub Actions job. /// ///
/// @@ -2028,14 +2109,25 @@ pub struct AttachmentGitHubUrl { ///
#[derive(Debug, Clone, Default, Serialize, Deserialize)] #[serde(rename_all = "camelCase")] -pub struct AttachmentSelectionDetailsEnd { - /// End character offset within the line (0-based) - pub character: i64, - /// End line number (0-based) - pub line: i64, +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 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, } -/// Start position of the selection +/// Pointer to a GitHub commit. /// ///
/// @@ -2045,14 +2137,20 @@ pub struct AttachmentSelectionDetailsEnd { ///
#[derive(Debug, Clone, Default, Serialize, Deserialize)] #[serde(rename_all = "camelCase")] -pub struct AttachmentSelectionDetailsStart { - /// Start character offset within the line (0-based) - pub character: i64, - /// Start line number (0-based) - pub line: i64, +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, } -/// Position range of the selection within the file +/// Pointer to a file in a GitHub repository at a specific ref. /// ///
/// @@ -2062,14 +2160,20 @@ pub struct AttachmentSelectionDetailsStart { ///
#[derive(Debug, Clone, Default, Serialize, Deserialize)] #[serde(rename_all = "camelCase")] -pub struct AttachmentSelectionDetails { - /// End position of the selection - pub end: AttachmentSelectionDetailsEnd, - /// Start position of the selection - pub start: AttachmentSelectionDetailsStart, +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, } -/// Code selection attachment from an editor +/// One side of a file diff (head or base) /// ///
/// @@ -2079,20 +2183,39 @@ pub struct AttachmentSelectionDetails { ///
#[derive(Debug, Clone, Default, Serialize, Deserialize)] #[serde(rename_all = "camelCase")] -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, +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, +} + +/// 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 AttachmentGitHubFileDiff { + /// File location on the base side of the diff. Absent for additions. + #[serde(skip_serializing_if = "Option::is_none")] + pub base: Option, + /// File location on the head side of the diff. Absent for deletions. + #[serde(skip_serializing_if = "Option::is_none")] + pub head: Option, /// Attachment type discriminator - pub r#type: AttachmentSelectionType, + pub r#type: AttachmentGitHubFileDiffType, + /// URL to the diff on GitHub (e.g., a commit, compare, or PR-file URL) + pub url: String, } -/// Cancellation result for a user-requested shell command. +/// GitHub issue, pull request, or discussion reference /// ///
/// @@ -2102,12 +2225,22 @@ pub struct AttachmentSelection { ///
#[derive(Debug, Clone, Default, Serialize, Deserialize)] #[serde(rename_all = "camelCase")] -pub struct CancelUserRequestedShellCommandResult { - /// Whether an in-flight execution was found and signalled to cancel - pub cancelled: bool, +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 action that the agent or host can invoke. To discover the input schema for a particular action, call the list_canvas_capabilities tool. +/// Pointer to a GitHub release. /// ///
/// @@ -2117,18 +2250,20 @@ pub struct CancelUserRequestedShellCommandResult { ///
#[derive(Debug, Clone, Default, Serialize, Deserialize)] #[serde(rename_all = "camelCase")] -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 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. +/// Pointer to a GitHub repository. /// ///
/// @@ -2138,17 +2273,22 @@ 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 AttachmentGitHubRepository { + /// Short description of the repository #[serde(skip_serializing_if = "Option::is_none")] - pub input: Option, - /// Open canvas instance identifier - pub instance_id: String, + 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: GitHubRepoRef, + /// Attachment type discriminator + pub r#type: AttachmentGitHubRepositoryType, + /// URL to the repository on GitHub + pub url: String, } -/// Canvas action invocation result. +/// Pointer to a line range inside a file in a GitHub repository. /// ///
/// @@ -2158,13 +2298,22 @@ pub struct CanvasActionInvokeRequest { ///
#[derive(Debug, Clone, Default, Serialize, Deserialize)] #[serde(rename_all = "camelCase")] -pub struct CanvasActionInvokeResult { - /// Provider-supplied action result - #[serde(skip_serializing_if = "Option::is_none")] - pub result: 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 close parameters. +/// One side of a tree comparison (head or base) /// ///
/// @@ -2174,12 +2323,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 AttachmentGitHubTreeComparisonSide { + /// Repository the revision belongs to + pub repo: GitHubRepoRef, + /// Git revision (branch, tag, or commit SHA) + pub revision: String, } -/// Host capabilities +/// Pointer to a comparison between two git revisions. /// ///
/// @@ -2189,13 +2340,18 @@ pub struct CanvasCloseRequest { ///
#[derive(Debug, Clone, Default, Serialize, Deserialize)] #[serde(rename_all = "camelCase")] -pub struct CanvasHostContextCapabilities { - /// Whether canvas rendering is supported - #[serde(skip_serializing_if = "Option::is_none")] - pub canvases: 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, } -/// Host context supplied by the runtime. +/// Generic GitHub URL reference. /// ///
/// @@ -2205,13 +2361,14 @@ pub struct CanvasHostContextCapabilities { ///
#[derive(Debug, Clone, Default, Serialize, Deserialize)] #[serde(rename_all = "camelCase")] -pub struct CanvasHostContext { - /// Host capabilities - #[serde(skip_serializing_if = "Option::is_none")] - pub capabilities: Option, +pub struct AttachmentGitHubUrl { + /// Attachment type discriminator + pub r#type: AttachmentGitHubUrlType, + /// URL to the GitHub resource + pub url: String, } -/// Canvas available in the current session. +/// End position of the selection /// ///
/// @@ -2221,30 +2378,14 @@ 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 - #[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, +pub struct AttachmentSelectionDetailsEnd { + /// End character offset within the line (0-based) + pub character: i64, + /// End line number (0-based) + pub line: i64, } -/// Declared canvases available in this session. +/// Start position of the selection /// ///
/// @@ -2254,12 +2395,14 @@ 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 AttachmentSelectionDetailsStart { + /// Start character offset within the line (0-based) + pub character: i64, + /// Start line number (0-based) + pub line: i64, } -/// Open canvas instance snapshot. +/// Position range of the selection within the file /// ///
/// @@ -2269,34 +2412,14 @@ pub struct CanvasList { ///
#[derive(Debug, Clone, Default, Serialize, Deserialize)] #[serde(rename_all = "camelCase")] -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 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, +pub struct AttachmentSelectionDetails { + /// End position of the selection + pub end: AttachmentSelectionDetailsEnd, + /// Start position of the selection + pub start: AttachmentSelectionDetailsStart, } -/// Live open-canvas snapshot. +/// Code selection attachment from an editor /// ///
/// @@ -2306,12 +2429,20 @@ 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 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, } -/// Canvas open parameters. +/// Credential-free authentication identity safe to expose to hosts and user interfaces. /// ///
/// @@ -2321,20 +2452,26 @@ 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 AuthIdentity { + /// Snapshot of the authenticated user's Copilot subscription info, if known #[serde(skip_serializing_if = "Option::is_none")] - pub extension_id: Option, - /// Canvas open input + pub copilot_user: Option, + /// Name of the environment variable that supplied the credential, when applicable #[serde(skip_serializing_if = "Option::is_none")] - pub input: Option, - /// Caller-supplied stable instance identifier - pub instance_id: String, + pub env_var: Option, + /// Authentication host + pub host: String, + /// Authenticated login, when available + #[serde(skip_serializing_if = "Option::is_none")] + pub login: Option, + /// Opaque SDK GitHub credential registration backing this identity. Routing metadata only; never a credential. + #[serde(skip_serializing_if = "Option::is_none")] + pub registration_id: Option, + /// Authentication type + pub r#type: AuthInfoType, } -/// Session context supplied by the runtime. +/// Validation error from an authentication attempt. /// ///
/// @@ -2344,13 +2481,15 @@ pub struct CanvasOpenRequest { ///
#[derive(Debug, Clone, Default, Serialize, Deserialize)] #[serde(rename_all = "camelCase")] -pub struct CanvasSessionContext { - /// Active session working directory, when known. +pub struct AuthValidationError { + /// Optional message returned by GitHub #[serde(skip_serializing_if = "Option::is_none")] - pub working_directory: Option, + pub github_message: Option, + /// Authentication validation error message + pub message: String, } -/// Canvas close parameters sent to the provider. +/// A well-known model in the runtime's built-in catalog. /// ///
/// @@ -2360,24 +2499,12 @@ 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 BuiltInModelCatalogEntry { + /// Well-known runtime model ID suitable for provider or provider-model metadata. This is not necessarily the provider-facing deployment or model name and does not indicate CAPI entitlement or provider availability. + pub id: String, } -/// Canvas action invocation parameters sent to the provider. +/// The running runtime's complete catalog of well-known built-in model IDs, including supported models and additional IDs with built-in metadata. /// ///
/// @@ -2387,29 +2514,12 @@ 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. - #[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 BuiltInModelCatalog { + /// Built-in model entries. + pub models: Vec, } -/// Canvas open parameters sent to the provider. +/// Custom grammar input format accepted by a built-in tool. /// ///
/// @@ -2419,27 +2529,16 @@ 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 BuiltinToolFormat { + /// Grammar definition accepted by the tool. + pub definition: String, + /// Grammar syntax used by the format definition. + pub syntax: String, + /// Custom input-format discriminator. + pub r#type: BuiltinToolFormatType, } -/// Canvas open result returned by the provider. +/// JSON Schema object accepted by a built-in tool. /// ///
/// @@ -2449,19 +2548,12 @@ 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 BuiltinToolInputSchema { + /// Root type of the tool input schema. + pub r#type: BuiltinToolInputSchemaType, } -/// Options scoped to the built-in CAPI (Copilot API) provider. +/// Rust-owned metadata and input schema for a built-in tool. /// ///
/// @@ -2471,13 +2563,30 @@ pub struct CanvasProviderOpenResult { ///
#[derive(Debug, Clone, Default, Serialize, Deserialize)] #[serde(rename_all = "camelCase")] -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, +pub struct BuiltinToolDescriptor { + /// Model-facing description of the tool's behavior. + pub description: String, + /// Optional custom input format used instead of a JSON Schema. + pub format: Option, + /// Whether the tool provides a specialized intention summary. + pub has_summarise_intention: bool, + /// JSON Schema for the tool input, or null when the tool uses a custom format. + pub input_schema: Option, + /// Optional supplemental usage instructions for the tool. + pub instructions: Option, + /// Whether the tool executes commands in a terminal. + pub is_terminal: bool, + /// Stable name used to invoke the built-in tool. + pub name: String, + /// Policy describing which tool metadata may be recorded without obfuscation. + pub safe_for_telemetry: serde_json::Value, + /// Optional human-readable title for the tool. + pub title: Option, + /// Optional tool category discriminator. + pub r#type: Option, } -/// A literal choice the command input accepts, with a human-facing description +/// Per-field telemetry-safety policy for a built-in tool. /// ///
/// @@ -2487,14 +2596,16 @@ pub struct CapiSessionOptions { ///
#[derive(Debug, Clone, Default, Serialize, Deserialize)] #[serde(rename_all = "camelCase")] -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, +pub struct BuiltinToolSafeTelemetryFields { + /// Whether tool input names may be included in telemetry without obfuscation. + #[serde(skip_serializing_if = "Option::is_none")] + pub inputs_names: Option, + /// Whether the tool name may be included in telemetry without obfuscation. + #[serde(skip_serializing_if = "Option::is_none")] + pub name: Option, } -/// Optional unstructured input hint +/// Cancellation result for a user-requested shell command. /// ///
/// @@ -2504,24 +2615,12 @@ pub struct SlashCommandInputChoice { ///
#[derive(Debug, Clone, Default, Serialize, Deserialize)] #[serde(rename_all = "camelCase")] -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 choices: Option>, - /// 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 CancelUserRequestedShellCommandResult { + /// Whether an in-flight execution was found and signalled to cancel + pub cancelled: bool, } -/// Slash-command metadata with name, aliases, description, kind, input hint, execution allowance, and schedulability. +/// Canvas action that the agent or host can invoke. To discover the input schema for a particular action, call the list_canvas_capabilities tool. /// ///
/// @@ -2531,30 +2630,18 @@ 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 +pub struct CanvasAction { + /// Description of the action #[serde(skip_serializing_if = "Option::is_none")] - pub experimental: Option, - /// Optional unstructured input hint + pub description: Option, + /// JSON Schema for the action input #[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 input_schema: Option, + /// Action name exposed by the canvas provider 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 schedulable: Option, } -/// Slash commands available in the session, after applying any include/exclude filters. +/// Canvas action invocation parameters. /// ///
/// @@ -2564,12 +2651,17 @@ 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 CanvasActionInvokeRequest { + /// Action name to invoke + pub action_name: String, + /// Action input + #[serde(skip_serializing_if = "Option::is_none")] + pub input: Option, + /// Open canvas instance identifier + pub instance_id: String, } -/// Pending command request ID and an optional error if the client handler failed. +/// Canvas action invocation result. /// ///
/// @@ -2579,15 +2671,13 @@ pub struct CommandList { ///
#[derive(Debug, Clone, Default, Serialize, Deserialize)] #[serde(rename_all = "camelCase")] -pub struct CommandsHandlePendingCommandRequest { - /// Error message if the command handler failed +pub struct CanvasActionInvokeResult { + /// Provider-supplied action result #[serde(skip_serializing_if = "Option::is_none")] - pub error: Option, - /// Request ID from the command invocation event - pub request_id: RequestId, + pub result: Option, } -/// Indicates whether the pending client-handled command was completed successfully. +/// Canvas close parameters. /// ///
/// @@ -2597,12 +2687,12 @@ 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 CanvasCloseRequest { + /// Open canvas instance identifier + pub instance_id: String, } -/// Slash command name and optional raw input string to invoke. +/// Host capabilities /// ///
/// @@ -2612,15 +2702,13 @@ pub struct CommandsHandlePendingCommandResult { ///
#[derive(Debug, Clone, Default, Serialize, Deserialize)] #[serde(rename_all = "camelCase")] -pub struct CommandsInvokeRequest { - /// Raw input after the command name +pub struct CanvasHostContextCapabilities { + /// Whether canvas rendering is supported #[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 canvases: Option, } -/// Optional filters controlling which command sources to include in the listing. +/// Host context supplied by the runtime. /// ///
/// @@ -2630,19 +2718,13 @@ 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 +pub struct CanvasHostContext { + /// Host capabilities #[serde(skip_serializing_if = "Option::is_none")] - pub include_skills: Option, + pub capabilities: Option, } -/// Queued-command request ID and the result indicating whether the host executed it (and whether to stop processing further queued commands). +/// Canvas available in the current session. /// ///
/// @@ -2652,14 +2734,30 @@ 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 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 queued-command response was matched to a pending request. +/// Declared canvases available in this session. /// ///
/// @@ -2669,12 +2767,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 CanvasList { + /// Declared canvases available in this session + pub canvases: Vec, } -/// 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`). +/// Open canvas instance snapshot. /// ///
/// @@ -2684,12 +2782,34 @@ pub struct CommandsRespondToQueuedCommandResult { ///
#[derive(Debug, Clone, Default, Serialize, Deserialize)] #[serde(rename_all = "camelCase")] -pub struct CompletionsGetTriggerCharactersResult { - /// Trigger characters advertised by the host (e.g. `["@", "#"]`). Empty disables host-driven completions for the session. - pub trigger_characters: Vec, +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 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, } -/// Request host-driven completions for the current composer input. +/// Live open-canvas snapshot. /// ///
/// @@ -2699,14 +2819,12 @@ pub struct CompletionsGetTriggerCharactersResult { ///
#[derive(Debug, Clone, Default, Serialize, Deserialize)] #[serde(rename_all = "camelCase")] -pub struct CompletionsRequestRequest { - /// Cursor offset within `text`, in UTF-16 code units. - pub offset: i64, - /// The full composed composer input. - pub text: String, +pub struct CanvasListOpenResult { + /// Currently open canvas instances + pub open_canvases: Vec, } -/// 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. +/// Canvas open parameters. /// ///
/// @@ -2716,24 +2834,20 @@ pub struct CompletionsRequestRequest { ///
#[derive(Debug, Clone, Default, Serialize, Deserialize)] #[serde(rename_all = "camelCase")] -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. +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 range_end: Option, - /// Start of the replacement range in `text`, in UTF-16 code units. + pub extension_id: Option, + /// Canvas open input #[serde(skip_serializing_if = "Option::is_none")] - pub range_start: Option, + pub input: Option, + /// Caller-supplied stable instance identifier + pub instance_id: String, } -/// Host-driven completion items for the current composer input. Empty when the host returns no items or does not support completions. +/// Session context supplied by the runtime. /// ///
/// @@ -2743,12 +2857,13 @@ pub struct SessionCompletionItem { ///
#[derive(Debug, Clone, Default, Serialize, Deserialize)] #[serde(rename_all = "camelCase")] -pub struct CompletionsRequestResult { - /// Completion items in host-ranked order. - pub items: Vec, +pub struct CanvasSessionContext { + /// Active session working directory, when known. + #[serde(skip_serializing_if = "Option::is_none")] + pub working_directory: Option, } -/// Params to attach or detach an in-process ExtensionController delegate. +/// Canvas close parameters sent to the provider. /// ///
/// @@ -2758,16 +2873,24 @@ pub struct CompletionsRequestResult { ///
#[derive(Debug, Clone, Default, Serialize, Deserialize)] #[serde(rename_all = "camelCase")] -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 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, } -/// Repository associated with the connected remote session. +/// Canvas action invocation parameters sent to the provider. /// ///
/// @@ -2777,16 +2900,29 @@ pub(crate) struct ConfigureSessionExtensionsParams { ///
#[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 name: String, - /// Repository owner or organization login. - pub owner: String, +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. + #[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, } -/// Metadata for a connected remote session. +/// Canvas open parameters sent to the provider. /// ///
/// @@ -2796,38 +2932,27 @@ 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 struct CanvasProviderOpenRequest { + /// Target session identifier pub session_id: SessionId, - /// Remote session staleness deadline as an ISO 8601 string. + /// 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 stale_at: Option, - /// Session start time as an ISO 8601 string. - pub start_time: String, - /// Remote session state returned by the backing service. + pub input: Option, + /// Host context supplied by the runtime. #[serde(skip_serializing_if = "Option::is_none")] - pub state: Option, - /// Optional session summary. + pub host: Option, + /// Session context supplied by the runtime. #[serde(skip_serializing_if = "Option::is_none")] - pub summary: Option, + pub session: Option, } -/// Remote session connection parameters. +/// Canvas open result returned by the provider. /// ///
/// @@ -2837,12 +2962,19 @@ 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, +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, } -/// Parameters for the `server.connect` handshake: an optional connection token and optional connection-level opt-ins (e.g. GitHub telemetry forwarding). +/// Internal canvas provider registration parameters. /// ///
/// @@ -2852,16 +2984,16 @@ pub struct ConnectRemoteSessionParams { ///
#[derive(Debug, Clone, Default, Serialize, Deserialize)] #[serde(rename_all = "camelCase")] -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, in addition to the runtime's normal GitHub/CTS emission (dual-write). 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. - #[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, +pub struct CanvasProviderRegisterRequest { + /// Canvas contributions supplied by the provider + pub canvases: Vec, + /// Connection identifier for callback routing + pub connection_id: String, + /// Provider metadata supplied by the host + pub info: serde_json::Value, } -/// Handshake result reporting the server's protocol version and package version on success. +/// Internal canvas provider unregistration parameters. /// ///
/// @@ -2871,16 +3003,12 @@ pub(crate) struct ConnectRequest { ///
#[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 struct CanvasProviderUnregisterRequest { + /// Connection identifier to unregister + pub connection_id: String, } -/// A single large message currently in context. +/// Options scoped to the built-in CAPI (Copilot API) provider. /// ///
/// @@ -2890,18 +3018,13 @@ pub(crate) struct ConnectResult { ///
#[derive(Debug, Clone, Default, Serialize, Deserialize)] #[serde(rename_all = "camelCase")] -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, +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, } -/// Authentication-info variant for direct Copilot API token auth sourced from environment variables, with public GitHub host. +/// Semantic digest of a strictly parsed and schema-validated JSON MCP card. Both URL-backed and embedded cards are canonicalised with RFC 8785 JSON Canonicalization Scheme, encoded as UTF-8, and hashed with SHA-256. /// ///
/// @@ -2911,17 +3034,14 @@ pub struct ContextHeaviestMessage { ///
#[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 CardDigest { + /// Digest algorithm and canonical representation + pub algorithm: CardDigestAlgorithm, + /// SHA-256 digest of the RFC 8785 canonical UTF-8 bytes, encoded as exactly 64 lowercase hexadecimal characters. + pub value: String, } -/// 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. +/// Where and when an AI skill catalog reference was observed. Discovery provenance deliberately carries no content digest because search does not establish the exact validated content a later plan will bind. /// ///
/// @@ -2931,19 +3051,16 @@ pub struct CopilotApiTokenAuthInfo { ///
#[derive(Debug, Clone, Default, Serialize, Deserialize)] #[serde(rename_all = "camelCase")] -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, +pub struct CatalogAiSkillCandidateProvenance { + /// Host of the catalog authority that advertised the reference, without path, query, or credentials. Inert untrusted data. + pub authority: String, + /// Media type advertised for the referenced AI skill card + pub media_type: CatalogAiSkillCandidateProvenanceMediaType, + /// ISO 8601 timestamp at which the runtime observed the catalog reference. This is not a retrieval or validation timestamp. + pub observed_at: String, } -/// Lightweight metadata for a currently initialized session tool +/// Candidate whose card is retrieved from a URL through the runtime's hardened fetch boundary. /// ///
/// @@ -2953,29 +3070,14 @@ 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, +pub struct CatalogCandidateSourceUrl { + /// Discriminator: the card is URL-backed, and carries no embedded data + pub kind: CatalogCandidateSourceUrlKind, + /// Card URL as advertised. Inert untrusted data: the runtime retrieves it only through its own hardened boundary, and it is never logged. + pub url: String, } -/// A file included in the redacted debug bundle. +/// Candidate whose card reference arrived inline. The document and its content-derived properties stay behind the runtime boundary. /// ///
/// @@ -2985,35 +3087,66 @@ pub struct CurrentToolMetadata { ///
#[derive(Debug, Clone, Default, Serialize, Deserialize)] #[serde(rename_all = "camelCase")] -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, +pub struct CatalogCandidateSourceEmbedded { + /// Discriminator: the card is embedded, and carries no URL + pub kind: CatalogCandidateSourceEmbeddedKind, } -#[derive(Debug, Clone, Default, Serialize, Deserialize)] +/// An inert AI skill catalog result. AI skills are discovery-only and cannot be represented as installable through this surface. +/// +///
+/// +/// **Experimental.** This 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(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. +pub struct CatalogAiSkillCandidate { + /// Description taken verbatim from the card. Inert untrusted text. #[serde(skip_serializing_if = "Option::is_none")] - pub no_overwrite: Option, - /// Absolute or server-relative path for the .tgz archive to create. - pub output_path: String, + pub description: Option, + /// Display name taken verbatim from the card. Inert untrusted text. + pub display_name: String, + /// Opaque, runtime-instance scoped, TTL-bound, single-use handle for this candidate. Carries no readable information and is rejected when stale, replayed, or presented to a different runtime instance. Never logged. + pub handle: String, + /// ISO 8601 timestamp after which the handle is stale and will be rejected. + pub handle_expires_at: String, + /// AI skills are discovery-only and cannot be installed through this surface + pub installability: CatalogAiSkillCandidateInstallability, + /// Discriminator: this candidate describes an AI skill + pub kind: CatalogAiSkillCandidateKind, + /// Media type of the underlying AI skill card + pub media_type: CatalogAiSkillCandidateMediaType, + /// Where the catalog reference was observed, without the card itself or any content digest. + pub provenance: CatalogAiSkillCandidateProvenance, + /// Publisher taken verbatim from the card. Inert untrusted text. + #[serde(skip_serializing_if = "Option::is_none")] + pub publisher: Option, + /// Where the card came from: exactly one of a URL or embedded data, encoded as a tagged union so neither both nor neither can be represented. + pub source: CatalogCandidateSource, } +/// An optional catalog authentication exchange did not establish the caller's identity. Anonymous search remains supported; this refusal is reserved for an operation that cannot continue after the attempted exchange. It is distinct from `policy-rejected` and from a network failure, and the reason identifies the recovery 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 DebugCollectLogsDestinationDirectory { - pub kind: DebugCollectLogsDestinationDirectoryKind, - /// Directory where redacted files should be staged. The directory is created if needed. - pub output_directory: String, +pub struct CatalogAuthenticationRequiredError { + /// Discriminator: the caller is not authenticated + pub kind: CatalogAuthenticationRequiredErrorKind, + /// Human-readable explanation, safe to surface. Never contains a credential or token, nor a query, URL, handle, or secret. + pub message: String, + /// Why authentication failed. Only an expired credential justifies attempting a silent refresh; an absent or rejected credential requires sign-in. + pub reason: CatalogAuthenticationRequiredReason, } -/// A caller-provided server-local file or directory to include in the debug bundle. +/// Where and when an MCP server catalog reference was observed. Discovery provenance deliberately carries no content digest because search does not establish the exact validated content a later plan will bind. /// ///
/// @@ -3023,22 +3156,16 @@ pub struct DebugCollectLogsDestinationDirectory { ///
#[derive(Debug, Clone, Default, Serialize, Deserialize)] #[serde(rename_all = "camelCase")] -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 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 required: Option, +pub struct CatalogMcpServerCandidateProvenance { + /// Host of the catalog authority that advertised the reference, without path, query, or credentials. Inert untrusted data. + pub authority: String, + /// JSON MCP media type advertised for the referenced card. + pub media_type: McpServerCardMediaType, + /// ISO 8601 timestamp at which the runtime observed the catalog reference. This is not a retrieval or validation timestamp. + pub observed_at: String, } -/// Built-in session diagnostics to include in the bundle. Omitted fields default to true. +/// An inert MCP server catalog result. Every free-text field is untrusted external data and must never be treated as an instruction, and the handle is the only way to refer to the candidate in a later operation. /// ///
/// @@ -3046,33 +3173,34 @@ pub struct DebugCollectLogsEntry { /// 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 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. +pub struct CatalogMcpServerCandidate { + /// Description taken verbatim from the card. Inert untrusted text. #[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. + pub description: Option, + /// Display name taken verbatim from the card. Inert untrusted text. + pub display_name: String, + /// Opaque, runtime-instance scoped, TTL-bound, single-use handle for this candidate. Carries no readable information and is rejected when stale, replayed, or presented to a different runtime instance. Never logged. + pub handle: String, + /// ISO 8601 timestamp after which the handle is stale and will be rejected. + pub handle_expires_at: String, + /// Whether this MCP server can be planned for installation, and if policy prevents it. + pub installability: CatalogMcpServerInstallability, + /// Discriminator: this candidate describes an MCP server + pub kind: CatalogMcpServerCandidateKind, + /// JSON MCP media type of the underlying card. + pub media_type: McpServerCardMediaType, + /// Where the catalog reference was observed, without the card itself or any content digest. + pub provenance: CatalogMcpServerCandidateProvenance, + /// Publisher taken verbatim from the card. Inert untrusted text. #[serde(skip_serializing_if = "Option::is_none")] - pub shell_logs: Option, + pub publisher: Option, + /// Where the card came from: exactly one of a URL or embedded data, encoded as a tagged union so neither both nor neither can be represented. + pub source: CatalogCandidateSource, } -/// Options for collecting a redacted session debug bundle. +/// The protocol version and capability set a caller requires, supplied on every catalog request so negotiation cannot be skipped by omission. /// ///
/// @@ -3080,20 +3208,16 @@ pub struct DebugCollectLogsInclude { /// 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 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 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 include: Option, +pub struct CatalogClientContract { + /// SDK protocol version the caller was generated against. A caller below the runtime's minimum supported version is refused rather than served a partial result. + pub protocol_version: i64, + /// Wire features the caller requires the runtime to understand. Identifiers are bounded but extensible so a newer caller can negotiate with an older runtime. Requiring an unknown feature yields a typed refusal listing what is understood, never a partial grant. A grant does not promise that a deployment has enabled the operation; typed unavailable results report that separately. + pub required_capabilities: Vec, } -/// An optional debug bundle entry that could not be included. +/// An upstream catalog response broke the wire contract. Most importantly, every result must carry exactly one of a URL or embedded data: a result carrying both, or neither, is refused here rather than being guessed at. /// ///
/// @@ -3103,17 +3227,16 @@ pub struct DebugCollectLogsRequest { ///
#[derive(Debug, Clone, Default, Serialize, Deserialize)] #[serde(rename_all = "camelCase")] -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 path: Option, - /// Reason the entry was skipped. - pub reason: String, +pub struct CatalogContractViolationError { + /// Discriminator: the upstream response broke the contract + pub kind: CatalogContractViolationErrorKind, + /// Human-readable explanation, safe to surface. Never echoes response content, nor a query, URL, handle, or secret. + pub message: String, + /// Which rule the response broke. + pub reason: CatalogContractViolationReason, } -/// Result of collecting a redacted debug bundle. +/// A presented handle was not accepted. Handles are runtime-instance scoped, TTL-bound, and single-use, so each way of failing is reported distinctly. /// ///
/// @@ -3123,19 +3246,18 @@ pub struct DebugCollectLogsSkippedEntry { ///
#[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 skipped_entries: Option>, +pub struct CatalogHandleRejectedError { + /// Which kind of handle was presented. + pub handle_type: CatalogHandleType, + /// Discriminator: a handle was rejected + pub kind: CatalogHandleRejectedErrorKind, + /// Human-readable explanation, safe to surface. Never contains the handle itself, nor a query, URL, or secret. + pub message: String, + /// Why the handle was rejected. + pub reason: CatalogHandleRejectionReason, } -/// MCP server discovered by `mcp.discover`, with config source, optional plugin source, transport type, and enabled state. +/// The request was rejected before any work was done, because a bounded field fell outside its permitted range or a required field was unusable. /// ///
/// @@ -3145,25 +3267,16 @@ pub struct DebugCollectLogsResult { ///
#[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, - /// 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, +pub struct CatalogInvalidRequestError { + /// Which request field was rejected. + pub field: CatalogInvalidRequestField, + /// Discriminator: the request itself was invalid + pub kind: CatalogInvalidRequestErrorKind, + /// Human-readable explanation, safe to surface. Never echoes the offending value, nor a query, URL, handle, or secret. + pub message: String, } -/// Slash-prefixed command string to enqueue for FIFO processing. +/// A card could not be parsed or did not satisfy its declared media type's schema. /// ///
/// @@ -3173,12 +3286,19 @@ 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 CatalogMalformedCardError { + /// Discriminator: the card was malformed + pub kind: CatalogMalformedCardErrorKind, + /// Media type the card was interpreted as, when it declared one this runtime recognises. + #[serde(skip_serializing_if = "Option::is_none")] + pub media_type: Option, + /// Human-readable explanation, safe to surface. Never echoes card content, nor a query, URL, handle, or secret. + pub message: String, + /// How the card failed validation. + pub reason: CatalogMalformedCardReason, } -/// Indicates whether the command was accepted into the local execution queue. +/// The protocol version and capability set the runtime actually honoured for a successful catalog operation. /// ///
/// @@ -3188,12 +3308,14 @@ 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 CatalogNegotiatedContract { + /// Wire features the runtime understood for this operation. Always a superset of the caller's required features, because any shortfall is a refusal instead. Operation availability remains a separate typed result. + pub granted_capabilities: Vec, + /// Protocol version of the runtime that served the request. + pub runtime_protocol_version: i64, } -/// Authentication-info variant for a token sourced from an environment variable, with host, optional login, token, and env var name. +/// The caller's protocol version or required capabilities cannot be honoured. Returned instead of a partial or ambiguous success. /// ///
/// @@ -3203,24 +3325,24 @@ 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. - #[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, +pub struct CatalogNegotiationRefusedError { + /// Discriminator: capability or protocol-version negotiation failed + pub kind: CatalogNegotiationRefusedErrorKind, + /// Human-readable explanation, safe to surface. Never contains a query, URL, handle, or secret. + pub message: String, + /// Lowest caller protocol version this runtime will serve. + pub minimum_supported_protocol_version: i64, + /// Whether the version or the capability set was the problem. + pub reason: CatalogNegotiationRefusedReason, + /// Protocol version of the runtime that refused the request. + pub runtime_protocol_version: i64, + /// Every wire feature this runtime understands, so the caller can retry within that contract. This list does not imply that every deployment has enabled every operation. + pub supported_capabilities: Vec, + /// The subset of the caller's bounded extensible capability identifiers this runtime cannot honour. + pub unsupported_capabilities: Vec, } -/// Cursor, batch size, and optional long-poll/filter parameters for reading session events. +/// The runtime could not reach the catalog authority or retrieve a card. Covers being offline as well as transport-level failure. /// ///
/// @@ -3230,25 +3352,19 @@ 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). +pub struct CatalogNetworkFailureError { + /// Discriminator: the network operation failed + pub kind: CatalogNetworkFailureErrorKind, + /// Human-readable explanation, safe to surface. Never contains a query, URL, handle, or secret. + pub message: String, + /// Categorised failure, low cardinality so it can be aggregated without carrying a URL. + pub reason: CatalogNetworkFailureReason, + /// HTTP status code, when the failure was a rejected response. #[serde(skip_serializing_if = "Option::is_none")] - pub wait_ms: Option, + pub status_code: Option, } -/// Indicates whether the operation succeeded. +/// The candidate is discoverable but cannot be installed. `application/ai-skill` resolves here, because it stays searchable while remaining typed non-installable. /// ///
/// @@ -3258,12 +3374,16 @@ 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 CatalogNotInstallableError { + /// Discriminator: the candidate cannot be installed + pub kind: CatalogNotInstallableErrorKind, + /// Human-readable explanation, safe to surface. Never contains a query, URL, handle, or secret. + pub message: String, + /// Why the candidate cannot be installed. + pub reason: CatalogNotInstallableReason, } -/// 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). +/// Registry or enterprise policy refused the operation. /// ///
/// @@ -3273,12 +3393,16 @@ 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 CatalogPolicyRejectedError { + /// Discriminator: policy refused the operation + pub kind: CatalogPolicyRejectedErrorKind, + /// Human-readable explanation, safe to surface. Never contains a query, URL, handle, or secret. + pub message: String, + /// Which authority produced the decision. + pub source: McpPlanPolicySource, } -/// Batch of session events returned by a read, with cursor and continuation metadata. +/// A bounded catalog search. Both the query length and the result count are capped by the schema so a caller cannot request an unbounded scan. /// ///
/// @@ -3288,18 +3412,20 @@ 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, +pub struct CatalogSearchRequest { + /// Protocol version and capabilities the caller requires. + pub contract: CatalogClientContract, + /// Restrict results to these candidate kinds. When omitted, every kind the runtime supports is searched. + #[serde(skip_serializing_if = "Option::is_none")] + pub kinds: Option>, + /// Maximum number of candidates to return. Defaults to 10 when omitted. + #[serde(skip_serializing_if = "Option::is_none")] + pub limit: Option, + /// Free-text search query. Never written to logs or telemetry. + pub query: String, } -/// Slash command name and argument string to execute synchronously. +/// A completed catalog search: inert candidate summaries, each carrying a single-use handle. /// ///
/// @@ -3309,14 +3435,20 @@ pub struct EventsReadResult { ///
#[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 CatalogSearchSucceeded { + /// Matching candidates, never more than the requested limit. All text is inert untrusted data. + pub candidates: Vec, + /// Discriminator: the search completed + pub kind: CatalogSearchSucceededKind, + /// Protocol version and capabilities the runtime honoured. + pub negotiated: CatalogNegotiatedContract, + /// Pseudonymous identifier for this search, issued by the runtime or by the catalog authority it queried and never by the caller, so it cannot be forged or replayed to attribute an install to a search that never happened. Always present on a success, so a result set can be tied to the installs it leads to. It identifies a search rather than a person: it is derived from no user, account, device, or query data, and must never be joined with user identity to re-identify anyone. + pub search_id: String, + /// Whether further matches existed beyond the requested limit. + pub truncated: bool, } -/// Error message produced while executing the command, if any. +/// The request asked for a candidate kind this runtime does not serve. /// ///
/// @@ -3326,13 +3458,18 @@ 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. - #[serde(skip_serializing_if = "Option::is_none")] - pub error: Option, +pub struct CatalogUnsupportedKindError { + /// Discriminator: an unsupported candidate kind was requested + pub kind: CatalogUnsupportedKindErrorKind, + /// Human-readable explanation, safe to surface. Never contains a query, URL, handle, or secret. + pub message: String, + /// The kinds from the request that are not supported. + pub requested_kinds: Vec, + /// Every candidate kind this runtime can serve. + pub supported_kinds: Vec, } -/// Discovered extension metadata, including source-qualified ID, name, discovery source, status, and optional process ID. +/// Retrieval was refused by the runtime's hardened fetch boundary before any request left the process, or before a redirect was followed. /// ///
/// @@ -3342,21 +3479,16 @@ 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', '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, +pub struct CatalogUnsafeRetrievalError { + /// Discriminator: retrieval was refused as unsafe + pub kind: CatalogUnsafeRetrievalErrorKind, + /// Human-readable explanation, safe to surface. Never contains the refused URL, nor a query, handle, or secret. + pub message: String, + /// Which control refused the retrieval, low cardinality so it can be aggregated without carrying a URL. + pub reason: CatalogUnsafeRetrievalReason, } -/// Slim input shape for extension_context attachments; identity fields are runtime-derived. +/// The operation is not available on this runtime. Distinct from a network failure: nothing was attempted. /// ///
/// @@ -3366,16 +3498,16 @@ pub struct Extension { ///
#[derive(Debug, Clone, Default, Serialize, Deserialize)] #[serde(rename_all = "camelCase")] -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, +pub struct CatalogUnavailableError { + /// Discriminator: the operation is not available + pub kind: CatalogUnavailableErrorKind, + /// Human-readable explanation, safe to surface. Never contains a query, URL, handle, or secret. + pub message: String, + /// Why the operation is unavailable. + pub reason: CatalogUnavailableReason, } -/// Extensions discovered for the session, with their current status. +/// No transport this runtime can use is available for the requested server. /// ///
/// @@ -3385,12 +3517,16 @@ pub struct ExtensionContextPushInput { ///
#[derive(Debug, Clone, Default, Serialize, Deserialize)] #[serde(rename_all = "camelCase")] -pub struct ExtensionList { - /// Discovered extensions and their current status - pub extensions: Vec, +pub struct CatalogUnavailableTransportError { + /// Discriminator: no usable transport is available + pub kind: CatalogUnavailableTransportErrorKind, + /// Human-readable explanation, safe to surface. Never contains a query, URL, handle, or secret. + pub message: String, + /// Why no transport could be offered. + pub reason: CatalogUnavailableTransportReason, } -/// Source-qualified extension identifier to disable for the session. +/// A literal choice the command input accepts, with a human-facing description /// ///
/// @@ -3400,12 +3536,14 @@ 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 SlashCommandInputChoice { + /// Human-readable description shown alongside the choice + pub description: String, + /// The literal choice value (e.g. 'on', 'off', 'show') + pub name: String, } -/// Source-qualified extension identifier to enable for the session. +/// Optional unstructured input hint /// ///
/// @@ -3415,12 +3553,24 @@ 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 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 choices: Option>, + /// 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, } -/// Binary result returned by a tool for the model +/// Slash-command metadata with name, aliases, description, kind, input hint, execution allowance, and schedulability. /// ///
/// @@ -3430,22 +3580,30 @@ 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 SlashCommandInfo { + /// Canonical aliases without leading slashes #[serde(skip_serializing_if = "Option::is_none")] - pub description: Option, - /// Optional metadata from the producing tool. + 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 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 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, + /// 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 schedulable: Option, } -/// Expanded external tool result payload +/// Slash commands available in the session, after applying any include/exclude filters. /// ///
/// @@ -3455,33 +3613,12 @@ 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 - #[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. - #[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>, +pub struct CommandList { + /// Commands available in this session + pub commands: Vec, } -/// Audio content block with base64-encoded data +/// The pending slash-command invocation effect to finalize, plus whether the host applied or cancelled it. /// ///
/// @@ -3491,16 +3628,14 @@ 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 CommandsFinalizeInvocationEffectRequest { + /// The slash-command result object that produced the pending effect, echoed back unchanged. + pub effect: serde_json::Value, + /// Whether the host applied or cancelled the pending invocation effect. + pub outcome: CommandsInvocationEffectOutcome, } -/// Image content block with base64-encoded data +/// Whether finalizing the invocation effect succeeded, and the failure reason when it did not. /// ///
/// @@ -3510,16 +3645,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 CommandsFinalizeInvocationEffectResult { + /// Failure reason when the invocation effect could not be finalized. + #[serde(skip_serializing_if = "Option::is_none")] + pub error: Option, + /// Whether the pending invocation effect was finalized successfully. + pub success: bool, } -/// Embedded resource content block with inline text or binary data +/// Pending command request ID and an optional error if the client handler failed. /// ///
/// @@ -3529,14 +3663,15 @@ 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 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, } -/// Icon image for a resource +/// Indicates whether the pending client-handled command was completed successfully. /// ///
/// @@ -3546,21 +3681,12 @@ 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 - #[serde(skip_serializing_if = "Option::is_none")] - pub theme: Option, +pub struct CommandsHandlePendingCommandResult { + /// Whether the command was handled successfully + pub success: bool, } -/// Resource link content block referencing an external resource +/// Slash command name and optional raw input string to invoke. /// ///
/// @@ -3570,31 +3696,18 @@ 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 CommandsInvokeRequest { + /// Raw input after the command name #[serde(skip_serializing_if = "Option::is_none")] - pub mime_type: Option, - /// Resource name identifier + pub input: Option, + /// Command name. Leading slashes are stripped and the name is matched case-insensitively. pub name: String, - /// Size of the resource in bytes - #[serde(skip_serializing_if = "Option::is_none")] - pub size: Option, - /// Human-readable display title for the resource + /// Optional client surface that initiated the invocation #[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 origin: Option, } -/// Shell command exit metadata with optional output preview +/// Optional filters controlling which command sources to include in the listing. /// ///
/// @@ -3604,25 +3717,19 @@ pub struct ExternalToolTextResultForLlmContentResourceLink { ///
#[derive(Debug, Clone, Default, Serialize, Deserialize)] #[serde(rename_all = "camelCase")] -pub struct ExternalToolTextResultForLlmContentShellExit { - /// Working directory where the shell command was executed +pub struct CommandsListRequest { + /// Include runtime built-in commands #[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. + pub include_builtins: Option, + /// Include commands registered by protocol clients, including SDK clients and extensions #[serde(skip_serializing_if = "Option::is_none")] - pub output_preview: Option, - /// Whether outputPreview is known to be incomplete or truncated + pub include_client_commands: Option, + /// Include enabled user-invocable skills and commands #[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, + 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). /// ///
/// @@ -3632,20 +3739,14 @@ pub struct ExternalToolTextResultForLlmContentShellExit { ///
#[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. /// ///
/// @@ -3655,14 +3756,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, } -/// Parameters for cooperatively aborting a factory body. +/// 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`). /// ///
/// @@ -3672,14 +3771,12 @@ pub struct ExternalToolTextResultForLlmContentText { ///
#[derive(Debug, Clone, Default, Serialize, Deserialize)] #[serde(rename_all = "camelCase")] -pub struct FactoryAbortRequest { - /// Target session identifier - pub session_id: SessionId, - /// Factory run identifier. - pub run_id: String, +pub struct CompletionsGetTriggerCharactersResult { + /// Trigger characters advertised by the host (e.g. `["@", "#"]`). Empty disables host-driven completions for the session. + pub trigger_characters: Vec, } -/// Acknowledgement that a factory request was accepted. +/// Request host-driven completions for the current composer input. /// ///
/// @@ -3689,9 +3786,14 @@ pub struct FactoryAbortRequest { ///
#[derive(Debug, Clone, Default, Serialize, Deserialize)] #[serde(rename_all = "camelCase")] -pub struct FactoryAckResult {} +pub struct CompletionsRequestRequest { + /// Cursor offset within `text`, in UTF-16 code units. + pub offset: i64, + /// The full composed composer input. + pub text: String, +} -/// Options for one factory-scoped subagent call. +/// 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. /// ///
/// @@ -3701,19 +3803,24 @@ pub struct FactoryAckResult {} ///
#[derive(Debug, Clone, Default, Serialize, Deserialize)] #[serde(rename_all = "camelCase")] -pub struct FactoryAgentOptions { - /// Optional label distinguishing otherwise identical memoized agent calls. +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, - /// Optional model identifier for the subagent. + /// End (exclusive) of the replacement range in `text`, in UTF-16 code units. #[serde(skip_serializing_if = "Option::is_none")] - pub model: Option, - /// Optional JSON Schema for structured agent output. + pub range_end: Option, + /// Start of the replacement range in `text`, in UTF-16 code units. #[serde(skip_serializing_if = "Option::is_none")] - pub schema: Option, + pub range_start: Option, } -/// Parameters for one factory-scoped subagent call. +/// Host-driven completion items for the current composer input. Empty when the host returns no items or does not support completions. /// ///
/// @@ -3723,16 +3830,12 @@ pub struct FactoryAgentOptions { ///
#[derive(Debug, Clone, Default, Serialize, Deserialize)] #[serde(rename_all = "camelCase")] -pub struct FactoryAgentRequest { - /// 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, +pub struct CompletionsRequestResult { + /// Completion items in host-ranked order. + pub items: Vec, } -/// Result of one factory-scoped subagent call. +/// Params to attach or detach an in-process ExtensionController delegate. /// ///
/// @@ -3742,13 +3845,16 @@ pub struct FactoryAgentRequest { ///
#[derive(Debug, Clone, Default, Serialize, Deserialize)] #[serde(rename_all = "camelCase")] -pub struct FactoryAgentResult { - /// Agent result, omitted when the agent produced no result. +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 result: Option, + pub(crate) controller: Option, + /// Session to attach the extension controller delegate to. + pub session_id: SessionId, } -/// Parameters for cancelling a factory run. +/// Identity of the integrating host, declared once on the `server.connect` handshake so telemetry from this connection is attributed to a single, consistent surface. All fields are optional; omit them to keep the default attribution. /// ///
/// @@ -3758,12 +3864,22 @@ pub struct FactoryAgentResult { ///
#[derive(Debug, Clone, Default, Serialize, Deserialize)] #[serde(rename_all = "camelCase")] -pub struct FactoryCancelRequest { - /// Factory run identifier. - pub run_id: String, +pub(crate) struct ConnectClientInfo { + /// Name of the host editor, e.g. `"vscode"`. + #[serde(skip_serializing_if = "Option::is_none")] + pub editor_name: Option, + /// Version of the host editor, e.g. `"1.124.2"`. Ignored unless it looks like a version string. + #[serde(skip_serializing_if = "Option::is_none")] + pub editor_version: Option, + /// Name of the Copilot extension within the host, e.g. `"copilot-chat"`. + #[serde(skip_serializing_if = "Option::is_none")] + pub extension_name: Option, + /// Version of the Copilot extension within the host, e.g. `"0.54.0"`. Ignored unless it looks like a version string. + #[serde(skip_serializing_if = "Option::is_none")] + pub extension_version: Option, } -/// Parameters sent to the owning extension to execute a factory closure. +/// Repository associated with the connected remote session. /// ///
/// @@ -3773,33 +3889,16 @@ pub struct FactoryCancelRequest { ///
#[derive(Debug, Clone, Default, Serialize, Deserialize)] #[serde(rename_all = "camelCase")] -pub struct FactoryExecuteRequest { - /// Target session identifier - pub session_id: SessionId, - /// Registered factory name. +pub struct ConnectedRemoteSessionMetadataRepository { + /// Branch associated with the remote session. + pub branch: String, + /// Repository name. pub name: String, - /// Factory run identifier. - pub run_id: String, - /// Factory input value. - pub args: serde_json::Value, -} - -/// Result returned by an extension factory closure. -/// -///
-/// -/// **Experimental.** This type is part of an experimental wire-protocol surface -/// and may change or be removed in future SDK or CLI releases. -/// -///
-#[derive(Debug, Clone, Default, Serialize, Deserialize)] -#[serde(rename_all = "camelCase")] -pub struct FactoryExecuteResult { - /// Factory result value. - pub result: serde_json::Value, + /// Repository owner or organization login. + pub owner: String, } -/// Parameters for retrieving a factory run. +/// Metadata for a connected remote session. /// ///
/// @@ -3809,12 +3908,38 @@ pub struct FactoryExecuteResult { ///
#[derive(Debug, Clone, Default, Serialize, Deserialize)] #[serde(rename_all = "camelCase")] -pub struct FactoryGetRunRequest { - /// Factory run identifier. - pub run_id: String, +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. + #[serde(skip_serializing_if = "Option::is_none")] + pub summary: Option, } -/// Parameters for reading a factory journal entry. +/// Remote session connection parameters. /// ///
/// @@ -3824,14 +3949,12 @@ pub struct FactoryGetRunRequest { ///
#[derive(Debug, Clone, Default, Serialize, Deserialize)] #[serde(rename_all = "camelCase")] -pub struct FactoryJournalGetRequest { - /// Namespaced journal key. - pub key: String, - /// Factory run identifier. - pub run_id: String, +pub struct ConnectRemoteSessionParams { + /// Session ID to connect to. + pub session_id: SessionId, } -/// Result of reading a factory journal entry. +/// Connection-level opt-ins for the `server.connect` handshake. Transport authentication is consumed by the native protocol boundary before dispatch. /// ///
/// @@ -3841,15 +3964,20 @@ pub struct FactoryJournalGetRequest { ///
#[derive(Debug, Clone, Default, Serialize, Deserialize)] #[serde(rename_all = "camelCase")] -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. +pub(crate) struct ConnectRequest { + /// Identity of the integrating host. Optional; omit it to keep the default attribution. + #[doc(hidden)] #[serde(skip_serializing_if = "Option::is_none")] - pub result_json: Option, + pub(crate) client_info: Option, + /// 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, } -/// Parameters for storing a factory journal entry. +/// Handshake result reporting the server's protocol version and package version on success. /// ///
/// @@ -3859,16 +3987,16 @@ pub struct FactoryJournalGetResult { ///
#[derive(Debug, Clone, Default, Serialize, Deserialize)] #[serde(rename_all = "camelCase")] -pub struct FactoryJournalPutRequest { - /// Namespaced journal key. - pub key: String, - /// JSON result to memoize. - pub result_json: serde_json::Value, - /// Factory run identifier. - pub run_id: String, +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, } -/// One ordered factory progress line. +/// Local file system absolute paths within the session working directory to check against its content-exclusion policy. /// ///
/// @@ -3878,16 +4006,12 @@ pub struct FactoryJournalPutRequest { ///
#[derive(Debug, Clone, Default, Serialize, Deserialize)] #[serde(rename_all = "camelCase")] -pub struct FactoryLogLine { - /// Progress line kind. - pub kind: FactoryLogLineKind, - /// Monotonic sequence number within the factory run. - pub seq: i64, - /// Progress text. - pub text: String, +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, } -/// Parameters for recording factory progress. +/// Content-exclusion decision for one requested path. /// ///
/// @@ -3897,14 +4021,14 @@ pub struct FactoryLogLine { ///
#[derive(Debug, Clone, Default, Serialize, Deserialize)] #[serde(rename_all = "camelCase")] -pub struct FactoryLogRequest { - /// Ordered progress lines to append. - pub lines: Vec, - /// Factory run identifier. - pub run_id: String, +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, } -/// Wire-only per-invocation factory resource ceiling overrides. +/// Batch content-exclusion result. Callers must fail closed when policy evaluation is unavailable. /// ///
/// @@ -3914,19 +4038,14 @@ pub struct FactoryLogRequest { ///
#[derive(Debug, Clone, Default, Serialize, Deserialize)] #[serde(rename_all = "camelCase")] -pub struct FactoryRunLimits { - /// 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, - /// Factory active-run timeout in milliseconds. - #[serde(skip_serializing_if = "Option::is_none")] - pub timeout: Option, +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, } -/// Options controlling factory invocation. +/// A single large message currently in context. /// ///
/// @@ -3936,16 +4055,18 @@ pub struct FactoryRunLimits { ///
#[derive(Debug, Clone, Default, Serialize, Deserialize)] #[serde(rename_all = "camelCase")] -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, +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, } -/// Parameters for invoking a registered factory. +/// 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. /// ///
/// @@ -3955,17 +4076,19 @@ pub struct RunOptions { ///
#[derive(Debug, Clone, Default, Serialize, Deserialize)] #[serde(rename_all = "camelCase")] -pub struct FactoryRunRequest { - /// Factory input value. - pub args: serde_json::Value, - /// Registered factory name. - pub name: String, - /// Factory invocation options. +pub struct CurrentModel { + /// Context tier for models that support multiple context-window sizes. #[serde(skip_serializing_if = "Option::is_none")] - pub options: Option, + 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, } -/// Complete current or terminal factory run envelope. +/// Lightweight metadata for a currently initialized session tool /// ///
/// @@ -3975,29 +4098,29 @@ pub struct FactoryRunRequest { ///
#[derive(Debug, Clone, Default, Serialize, Deserialize)] #[serde(rename_all = "camelCase")] -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. +pub struct CurrentToolMetadata { + /// Whether the tool is loaded on demand via tool search #[serde(skip_serializing_if = "Option::is_none")] - pub failure: Option, - /// Reason for a halted or cancelled run. + 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 reason: Option, - /// Completed factory result. + pub mcp_server_name: Option, + /// Raw MCP tool name for MCP-backed tools #[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. + 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 snapshot: Option, - /// Current or terminal factory run status. - pub status: FactoryRunStatus, + pub namespaced_name: Option, } -/// Optional user prompt to combine with the fleet orchestration instructions. +/// A file included in the redacted debug bundle. /// ///
/// @@ -4007,43 +4130,37 @@ pub struct FactoryRunResult { ///
#[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 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, } -/// 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 FleetStartResult { - /// Whether fleet mode was successfully activated - pub started: bool, +pub struct DebugCollectLogsDestinationArchive { + /// Destination variant discriminator. + 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 no_overwrite: Option, + /// Absolute or server-relative path for the .tgz archive to create. + pub output_path: String, } -/// Folder path to add to trusted folders. -/// -///
-/// -/// **Experimental.** This type is part of an experimental wire-protocol surface -/// and may change or be removed in future SDK or CLI releases. -/// -///
#[derive(Debug, Clone, Default, Serialize, Deserialize)] #[serde(rename_all = "camelCase")] -pub struct FolderTrustAddParams { - /// Folder path to mark as trusted - pub path: String, +pub struct DebugCollectLogsDestinationDirectory { + /// Destination variant discriminator. + pub kind: DebugCollectLogsDestinationDirectoryKind, + /// Directory where redacted files should be staged. The directory is created if needed. + pub output_directory: String, } -/// Folder path to check for trust. +/// A caller-provided server-local file or directory to include in the debug bundle. /// ///
/// @@ -4053,12 +4170,22 @@ pub struct FolderTrustAddParams { ///
#[derive(Debug, Clone, Default, Serialize, Deserialize)] #[serde(rename_all = "camelCase")] -pub struct FolderTrustCheckParams { - /// Folder path to check +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 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 required: Option, } -/// Folder trust check result. +/// Built-in session diagnostics to include in the bundle. Omitted fields default to true. /// ///
/// @@ -4068,12 +4195,31 @@ 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 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, } -/// Authentication-info variant for GitHub CLI credentials, carrying host, login, and the `gh auth token` value. +/// Options for collecting a redacted session debug bundle. /// ///
/// @@ -4081,23 +4227,20 @@ pub struct FolderTrustCheckResult { /// 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 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. +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 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 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 include: Option, } -/// Client environment metadata describing the process that produced a telemetry event. +/// An optional debug bundle entry that could not be included. /// ///
/// @@ -4107,40 +4250,17 @@ pub struct GhCliAuthInfo { ///
#[derive(Debug, Clone, Default, Serialize, Deserialize)] #[serde(rename_all = "camelCase")] -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, +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 path: Option, + /// Reason the entry was skipped. + pub reason: 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. +/// Result of collecting a redacted debug bundle. /// ///
/// @@ -4150,43 +4270,19 @@ pub struct GitHubTelemetryClientInfo { ///
#[derive(Debug, Clone, Default, Serialize, Deserialize)] #[serde(rename_all = "camelCase")] -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. +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 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, + pub skipped_entries: Option>, } -/// 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. +/// Installed plugin that contributes a discovered extension. /// ///
/// @@ -4196,17 +4292,12 @@ pub struct GitHubTelemetryEvent { ///
#[derive(Debug, Clone, Default, Serialize, Deserialize)] #[serde(rename_all = "camelCase")] -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 session_id: Option, +pub struct DiscoveredExtensionPlugin { + /// Installed plugin name + pub name: String, } -/// Pending external tool call request ID, with the tool result or an error describing why it failed. +/// Discovered extension metadata and persistent enablement state. /// ///
/// @@ -4216,18 +4307,23 @@ pub struct GitHubTelemetryNotification { ///
#[derive(Debug, Clone, Default, Serialize, Deserialize)] #[serde(rename_all = "camelCase")] -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) +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 result: Option, + pub plugin: Option, + /// Discovery source + pub source: DiscoveredExtensionSource, } -/// Indicates whether the external tool call result was handled successfully. +/// Extensions discovered from persisted Copilot home state and their effective loading mode. Launch-scoped additional plugins are not included. /// ///
/// @@ -4237,12 +4333,14 @@ 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 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, } -/// Indicates whether an in-progress manual compaction was aborted. +/// Source-qualified extension identifiers to persistently disable for future sessions. /// ///
/// @@ -4252,12 +4350,12 @@ 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 struct DiscoveredExtensionsDisableRequest { + /// Source-qualified user or plugin extension IDs to disable + pub ids: Vec, } -/// Indicates whether an in-progress background compaction was cancelled. +/// Source-qualified extension identifiers to persistently enable for future sessions. /// ///
/// @@ -4267,12 +4365,12 @@ 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 struct DiscoveredExtensionsEnableRequest { + /// Source-qualified user or plugin extension IDs to enable + pub ids: Vec, } -/// Post-compaction context window usage breakdown +/// MCP server discovered by `mcp.discover`, with config source, optional plugin source, transport type, and enabled state. /// ///
/// @@ -4282,25 +4380,25 @@ 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) +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 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) + pub source_plugin: Option, + /// Plugin version that provided this server, when source is plugin. #[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 + pub source_plugin_version: Option, + /// Server transport type: stdio, http, sse (deprecated), or memory #[serde(skip_serializing_if = "Option::is_none")] - pub tool_definitions_tokens: Option, + pub r#type: Option, } -/// Optional compaction parameters. +/// Slash-prefixed command string to enqueue for FIFO processing. /// ///
/// @@ -4310,13 +4408,12 @@ 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 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, } -/// Compaction outcome with the number of tokens and messages removed, summary text, and the resulting context window breakdown. +/// Indicates whether the command was accepted into the local execution queue. /// ///
/// @@ -4326,22 +4423,12 @@ 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 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, } -/// Markdown summary of the conversation context (empty when not available). +/// Cursor, batch size, and optional long-poll/filter parameters for reading session events. /// ///
/// @@ -4351,12 +4438,34 @@ 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 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 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 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, + /// 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 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 include_ephemeral: 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). 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, } -/// Identifier of the event to truncate to; this event and all later events are removed. +/// Indicates whether the operation succeeded. /// ///
/// @@ -4366,12 +4475,12 @@ 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 EventLogReleaseInterestResult { + /// Whether the operation succeeded + pub success: bool, } -/// Number of events that were removed by the truncation. +/// 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). /// ///
/// @@ -4381,12 +4490,12 @@ 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 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, } -/// Authentication-info variant for GitHub-internal HMAC auth, carrying the public GitHub host and HMAC secret. +/// Batch of session events returned by a read, with cursor and continuation metadata. /// ///
/// @@ -4396,37 +4505,35 @@ 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. - #[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 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, } -/// Runtime-owned wire payload for a server-to-client hook callback invocation. -#[derive(Debug, Clone, Default, Serialize, Deserialize)] -#[serde(rename_all = "camelCase")] -pub(crate) struct HookInvokeRequest { - #[doc(hidden)] - pub(crate) hook_type: HookType, - pub input: serde_json::Value, - pub session_id: SessionId, -} - -/// Optional output returned by an SDK callback hook. +/// 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(crate) struct HookInvokeResponse { - #[serde(skip_serializing_if = "Option::is_none")] - pub output: Option, +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, } -/// Installed plugin record from global state, with marketplace, version, install time, enabled state, cache path, and source. +/// Error message produced while executing the command, if any. /// ///
/// @@ -4436,28 +4543,13 @@ pub(crate) struct HookInvokeResponse { ///
#[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) - #[serde(skip_serializing_if = "Option::is_none")] - pub source: Option, - /// Version installed (if available) +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 version: Option, + pub error: Option, } -/// Information about an installed plugin tracked in global state. +/// Discovered extension metadata, including source-qualified ID, name, discovery source, status, and optional process ID. /// ///
/// @@ -4467,22 +4559,21 @@ pub struct InstalledPlugin { ///
#[derive(Debug, Clone, Default, Serialize, Deserialize)] #[serde(rename_all = "camelCase")] -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 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, - /// Installed version (when reported by the plugin manifest) + /// Process ID if the extension is running #[serde(skip_serializing_if = "Option::is_none")] - pub version: Option, + 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, } -/// Source descriptor for a direct GitHub plugin install, with `owner/repo`, optional ref, and optional subpath. +/// Slim input shape for extension_context attachments; identity fields are runtime-derived. /// ///
/// @@ -4492,17 +4583,16 @@ pub struct InstalledPluginInfo { ///
#[derive(Debug, Clone, Default, Serialize, Deserialize)] #[serde(rename_all = "camelCase")] -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, - /// Constant value. Always "github". - pub source: InstalledPluginSourceGitHubSource, +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, } -/// Source descriptor for a direct local plugin install, with a local filesystem path. +/// Opaque integrator-owned process launch profile for one extension entrypoint. /// ///
/// @@ -4512,13 +4602,16 @@ 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 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, } -/// Source descriptor for a direct URL plugin install, with URL, optional ref, and optional subpath. +/// A discovered extension entrypoint that the registered integrator may classify and resolve to an opaque launch profile. /// ///
/// @@ -4528,17 +4621,18 @@ pub struct InstalledPluginSourceLocal { ///
#[derive(Debug, Clone, Default, Serialize, Deserialize)] #[serde(rename_all = "camelCase")] -pub struct InstalledPluginSourceUrl { - #[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: InstalledPluginSourceUrlSource, - pub url: String, +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, } -/// Canonical file or directory where custom instructions can be discovered or created, with location, kind, preference, and project path. +/// The launch profile for a supported entrypoint. Omit launch when the provider does not support the entrypoint. /// ///
/// @@ -4548,21 +4642,13 @@ pub struct InstalledPluginSourceUrl { ///
#[derive(Debug, Clone, Default, Serialize, Deserialize)] #[serde(rename_all = "camelCase")] -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) +pub struct ExtensionLaunchProviderResolveResult { + /// Opaque launch profile, omitted when this provider does not support the entrypoint. #[serde(skip_serializing_if = "Option::is_none")] - pub project_path: Option, + pub launch: Option, } -/// Canonical files and directories where custom instructions can be created so the runtime will recognize them. +/// Extensions discovered for the session, with their current status. /// ///
/// @@ -4572,12 +4658,12 @@ pub struct InstructionDiscoveryPath { ///
#[derive(Debug, Clone, Default, Serialize, Deserialize)] #[serde(rename_all = "camelCase")] -pub struct InstructionDiscoveryPathList { - /// Canonical instruction create/discovery files and directories, in priority order - pub paths: Vec, +pub struct ExtensionList { + /// Discovered extensions and their current status + pub extensions: Vec, } -/// Optional project paths to include in instruction discovery. +/// Source-qualified extension identifier to disable for the session. /// ///
/// @@ -4587,16 +4673,12 @@ pub struct InstructionDiscoveryPathList { ///
#[derive(Debug, Clone, Default, Serialize, Deserialize)] #[serde(rename_all = "camelCase")] -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>, +pub struct ExtensionsDisableRequest { + /// Source-qualified extension ID to disable + pub id: String, } -/// Optional project paths to include when enumerating instruction discovery targets. +/// Source-qualified extension identifier to enable for the session. /// ///
/// @@ -4606,16 +4688,12 @@ pub struct InstructionsDiscoverRequest { ///
#[derive(Debug, Clone, Default, Serialize, Deserialize)] #[serde(rename_all = "camelCase")] -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>, +pub struct ExtensionsEnableRequest { + /// Source-qualified extension ID to enable + pub id: String, } -/// Loaded instruction source for a session, including path, content, category, location, applicability, and optional description. +/// Binary result returned by a tool for the model /// ///
/// @@ -4625,34 +4703,22 @@ pub struct InstructionsGetDiscoveryPathsRequest { ///
#[derive(Debug, Clone, Default, Serialize, Deserialize)] #[serde(rename_all = "camelCase")] -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 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 +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, - /// 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 sources, where it disambiguates same-named files (e.g. .github/copilot-instructions.md) across multiple workspace roots. The session-scoped getSources leaves it unset. + /// Optional metadata from the producing tool. #[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, + 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, } -/// Instruction sources loaded for the session, in merge order. +/// Expanded external tool result payload /// ///
/// @@ -4662,78 +4728,71 @@ pub struct InstructionSource { ///
#[derive(Debug, Clone, Default, Serialize, Deserialize)] #[serde(rename_all = "camelCase")] -pub struct InstructionsGetSourcesResult { - /// Instruction sources for the session - pub sources: Vec, -} - -/// 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. +pub struct ExternalToolTextResultForLlm { + /// Base64-encoded binary results returned to the model #[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. + pub binary_results_for_llm: Option>, + /// Structured content blocks from the tool #[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. + pub contents: Option>, + /// Optional error message for failed executions #[serde(skip_serializing_if = "Option::is_none")] - pub cancel: Option, - /// Optional human-readable reason for the cancellation, propagated for logging. + 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 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. + pub result_type: Option, + /// Detailed log content for timeline display #[serde(skip_serializing_if = "Option::is_none")] - pub end: Option, - /// Matches the requestId from the originating httpRequestStart frame. - pub request_id: RequestId, + 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>, } -/// Acknowledgement. The SDK is free to ignore the ack and treat chunk delivery as fire-and-forget. +/// Audio content block with base64-encoded 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, Serialize, Deserialize)] #[serde(rename_all = "camelCase")] -pub struct LlmInferenceHttpRequestChunkResult {} +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, +} -/// The head of an outbound model-layer HTTP request. +/// Image content block with base64-encoded 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, 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, +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, } -/// 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. +/// Embedded resource content block with inline text or binary data /// ///
/// @@ -4743,15 +4802,14 @@ pub struct LlmInferenceHttpRequestStartResult {} ///
#[derive(Debug, Clone, Default, Serialize, Deserialize)] #[serde(rename_all = "camelCase")] -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, +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, } -/// A response body chunk or terminal error. +/// Icon image for a resource /// ///
/// @@ -4761,23 +4819,21 @@ pub struct LlmInferenceHttpResponseChunkError { ///
#[derive(Debug, Clone, Default, Serialize, Deserialize)] #[serde(rename_all = "camelCase")] -pub struct LlmInferenceHttpResponseChunkRequest { - /// When true, `data` is base64-encoded bytes. When absent or false, `data` is UTF-8 text. +pub struct ExternalToolTextResultForLlmContentResourceLinkIcon { + /// MIME type of the icon image #[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. + pub mime_type: Option, + /// Available icon sizes (e.g., ['16x16', '32x32']) #[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. + 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 error: Option, - /// Matches the requestId from the originating httpRequestStart frame. - pub request_id: RequestId, + pub theme: Option, } -/// Whether the chunk was accepted. +/// Resource link content block referencing an external resource /// ///
/// @@ -4787,12 +4843,31 @@ pub struct LlmInferenceHttpResponseChunkRequest { ///
#[derive(Debug, Clone, Default, Serialize, Deserialize)] #[serde(rename_all = "camelCase")] -pub struct LlmInferenceHttpResponseChunkResult { - /// True when the chunk was matched to a pending request; false when unknown. - pub accepted: bool, +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 + #[serde(skip_serializing_if = "Option::is_none")] + pub mime_type: Option, + /// Resource name identifier + pub name: String, + /// Size of the resource in bytes + #[serde(skip_serializing_if = "Option::is_none")] + pub size: Option, + /// Human-readable display title for the resource + #[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, } -/// Response head. +/// Shell command exit metadata with optional output preview /// ///
/// @@ -4802,18 +4877,28 @@ pub struct LlmInferenceHttpResponseChunkResult { ///
#[derive(Debug, Clone, Default, Serialize, Deserialize)] #[serde(rename_all = "camelCase")] -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. +pub struct ExternalToolTextResultForLlmContentShellExit { + /// Working directory where the shell command was executed #[serde(skip_serializing_if = "Option::is_none")] - pub status_text: Option, + pub cwd: Option, + /// Exit code from the completed shell command + pub exit_code: i64, + /// Path reported in the shell session's filesystem namespace when shell output exceeded the configured large-output threshold. + #[serde(skip_serializing_if = "Option::is_none")] + pub output_file_path: Option, + /// 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, } -/// Whether the start frame was accepted. +/// Terminal/shell output content block with optional exit code and working directory /// ///
/// @@ -4823,12 +4908,20 @@ pub struct LlmInferenceHttpResponseStartRequest { ///
#[derive(Debug, Clone, Default, Serialize, Deserialize)] #[serde(rename_all = "camelCase")] -pub struct LlmInferenceHttpResponseStartResult { - /// True when the response start was matched to a pending request; false when unknown. - pub accepted: bool, +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, } -/// Indicates whether the calling client was registered as the LLM inference provider. +/// Plain text content block /// ///
/// @@ -4838,12 +4931,14 @@ pub struct LlmInferenceHttpResponseStartResult { ///
#[derive(Debug, Clone, Default, Serialize, Deserialize)] #[serde(rename_all = "camelCase")] -pub struct LlmInferenceSetProviderResult { - /// Whether the provider was set successfully - pub success: bool, +pub struct ExternalToolTextResultForLlmContentText { + /// The text content + pub text: String, + /// Content block type discriminator + pub r#type: ExternalToolTextResultForLlmContentTextType, } -/// Pre-resolved working-directory context for session startup. +/// Parameters for cooperatively aborting a factory body. /// ///
/// @@ -4853,24 +4948,14 @@ pub struct LlmInferenceSetProviderResult { ///
#[derive(Debug, Clone, Default, Serialize, Deserialize)] #[serde(rename_all = "camelCase")] -pub struct SessionContext { - /// Active git branch - #[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 - #[serde(skip_serializing_if = "Option::is_none")] - pub git_root: Option, - /// Repository host type - #[serde(skip_serializing_if = "Option::is_none")] - pub host_type: Option, - /// Repository slug in `owner/name` form, when known - #[serde(skip_serializing_if = "Option::is_none")] - pub repository: Option, +pub struct FactoryAbortRequest { + /// Target session identifier + pub session_id: SessionId, + /// Factory run identifier. + pub run_id: String, } -/// Persisted local session metadata, including identifiers, timestamps, summary/name, client, context, detached state, and task ID. +/// Acknowledgement that a factory request was accepted. /// ///
/// @@ -4880,36 +4965,9 @@ pub struct SessionContext { ///
#[derive(Debug, Clone, Default, Serialize, Deserialize)] #[serde(rename_all = "camelCase")] -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, -} +pub struct FactoryAckResult {} -/// Message text, optional severity level, persistence flag, optional follow-up URL, and optional tip. +/// Options for one factory-scoped subagent call. /// ///
/// @@ -4919,27 +4977,28 @@ pub struct LocalSessionMetadataValue { ///
#[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 +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 ephemeral: Option, - /// Log severity level. Determines how the message is displayed in the timeline. Defaults to "info". + 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 level: Option, - /// Human-readable message - pub message: String, - /// Optional actionable tip displayed alongside the message. Only honored on `level: "info"`. + pub context_tier: Option, + /// Optional label distinguishing otherwise identical memoized agent calls. #[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". + pub label: Option, + /// Optional model identifier for the subagent. #[serde(skip_serializing_if = "Option::is_none")] - pub r#type: Option, - /// Optional URL the user can open in their browser for more details + 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 url: Option, + pub reasoning_effort: Option, + /// Optional JSON Schema for structured agent output. + #[serde(skip_serializing_if = "Option::is_none")] + pub schema: Option, } -/// Identifier of the session event that was emitted for the log message. +/// Parameters for one factory-scoped subagent call. /// ///
/// @@ -4949,12 +5008,18 @@ 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 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, } -/// Parameters for (re)loading the merged LSP configuration set. +/// Result of one factory-scoped subagent call. /// ///
/// @@ -4964,19 +5029,13 @@ 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. +pub struct FactoryAgentResult { + /// Agent result, omitted when the agent produced no result. #[serde(skip_serializing_if = "Option::is_none")] - pub working_directory: Option, + pub result: Option, } -/// Result of registering a new marketplace. +/// Prompt-safe durable identity and live status for a direct factory agent. /// ///
/// @@ -4986,30 +5045,44 @@ pub struct LspInitializeRequest { ///
#[derive(Debug, Clone, Default, Serialize, Deserialize)] #[serde(rename_all = "camelCase")] -pub struct MarketplaceAddResult { - /// Final name of the marketplace as resolved from its manifest - pub name: String, -} - -/// Plugin entry advertised by a 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 MarketplacePluginInfo { - /// Short description from the marketplace catalog, when present +pub struct FactoryAgentSummary { + /// Accumulated active agent time in milliseconds. + pub active_ms: i64, + /// Prompt-safe live activity text. #[serde(skip_serializing_if = "Option::is_none")] - pub description: Option, - /// Plugin name as listed in the marketplace catalog - pub name: String, + pub activity: Option, + /// Stable direct-agent identifier. + pub agent_id: String, + /// Registered agent type. + pub agent_type: String, + /// Epoch milliseconds when the agent completed. + #[serde(skip_serializing_if = "Option::is_none")] + pub completed_at: Option, + /// Friendly, non-unique name intended for display + #[serde(skip_serializing_if = "Option::is_none")] + pub display_name: Option, + /// Friendly, non-unique name intended for display + pub label: String, + /// Phase identifier active when the agent was launched, or null. + pub phase_id: Option, + /// Model requested when the agent was launched. + #[serde(skip_serializing_if = "Option::is_none")] + pub requested_model: Option, + /// Concrete model resolved for the agent. + #[serde(skip_serializing_if = "Option::is_none")] + pub resolved_model: Option, + /// Owning factory run identifier. + pub run_id: String, + /// Epoch milliseconds when the agent started. + #[serde(skip_serializing_if = "Option::is_none")] + pub started_at: Option, + /// Current durable or live agent status. + pub status: String, + /// Tool-call identifier that launched the agent. + pub tool_call_id: String, } -/// Plugins advertised by the marketplace. +/// Parameters for cancelling a factory run. /// ///
/// @@ -5019,12 +5092,12 @@ pub struct MarketplacePluginInfo { ///
#[derive(Debug, Clone, Default, Serialize, Deserialize)] #[serde(rename_all = "camelCase")] -pub struct MarketplaceBrowseResult { - /// Plugins advertised by the marketplace - pub plugins: Vec, +pub struct FactoryCancelRequest { + /// Factory run identifier. + pub run_id: String, } -/// Registered marketplace summary. +/// Current factory phase identity. /// ///
/// @@ -5034,17 +5107,14 @@ pub struct MarketplaceBrowseResult { ///
#[derive(Debug, Clone, Default, Serialize, Deserialize)] #[serde(rename_all = "camelCase")] -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 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, +pub struct FactoryCurrentPhase { + /// Current phase identifier. + pub id: String, + /// Zero-based declared phase ordinal, or null for an undeclared phase. + pub ordinal: Option, } -/// All registered marketplaces, including built-in defaults. +/// Declared or approved factory resource ceilings. /// ///
/// @@ -5054,12 +5124,22 @@ pub struct MarketplaceInfo { ///
#[derive(Debug, Clone, Default, Serialize, Deserialize)] #[serde(rename_all = "camelCase")] -pub struct MarketplaceListResult { - /// Registered marketplaces - pub marketplaces: Vec, +pub struct FactoryDeclaredLimits { + /// Maximum AI credits consumed by subagents and descendants. + #[serde(skip_serializing_if = "Option::is_none")] + pub max_ai_credits: Option, + /// Maximum concurrently active subagents. + #[serde(skip_serializing_if = "Option::is_none")] + pub max_concurrent_subagents: Option, + /// Maximum total subagents spawned by the run. + #[serde(skip_serializing_if = "Option::is_none")] + pub max_total_subagents: Option, + /// Maximum accumulated active execution time in seconds. + #[serde(skip_serializing_if = "Option::is_none")] + pub timeout_seconds: Option, } -/// Per-marketplace refresh result, including marketplace name, success flag, and optional failure error. +/// Parameters sent to the owning extension to execute a factory closure. /// ///
/// @@ -5069,17 +5149,20 @@ pub struct MarketplaceListResult { ///
#[derive(Debug, Clone, Default, Serialize, Deserialize)] #[serde(rename_all = "camelCase")] -pub struct MarketplaceRefreshEntry { - /// Error message (failure only) - #[serde(skip_serializing_if = "Option::is_none")] - pub error: Option, - /// Marketplace name that was refreshed +pub struct FactoryExecuteRequest { + /// Target session identifier + pub session_id: SessionId, + /// Registered factory name. pub name: String, - /// Whether the refresh succeeded - pub success: bool, + /// 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, } -/// Result of refreshing one or more marketplace catalogs. +/// Result returned by an extension factory closure. /// ///
/// @@ -5089,12 +5172,13 @@ pub struct MarketplaceRefreshEntry { ///
#[derive(Debug, Clone, Default, Serialize, Deserialize)] #[serde(rename_all = "camelCase")] -pub struct MarketplaceRefreshResult { - /// Per-marketplace refresh results in deterministic order. - pub results: Vec, +pub struct FactoryExecuteResult { + /// Factory result value. + #[serde(skip_serializing_if = "Option::is_none")] + pub result: Option, } -/// Outcome of the remove attempt, including dependent-plugin info when applicable. +/// Parameters for paging factory progress. /// ///
/// @@ -5104,15 +5188,24 @@ pub struct MarketplaceRefreshResult { ///
#[derive(Debug, Clone, Default, Serialize, Deserialize)] #[serde(rename_all = "camelCase")] -pub struct MarketplaceRemoveResult { - /// Names of installed plugins that prevented removal. Populated only when `removed=false`. +pub struct FactoryGetRunProgressRequest { + /// Exclusive forward cursor. #[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, + pub after_seq: Option, + /// Exclusive backward cursor. + #[serde(skip_serializing_if = "Option::is_none")] + pub before_seq: Option, + /// Maximum records to return. Defaults to 200 and is capped at 500. + #[serde(skip_serializing_if = "Option::is_none")] + pub limit: Option, + /// Optional phase identifier used to scope records and cursors. + #[serde(skip_serializing_if = "Option::is_none")] + pub phase_id: Option, + /// Factory run identifier. + pub run_id: String, } -/// MCP server allowed by policy, with server name and optional PII-free explanatory note. +/// Parameters for retrieving a factory run. /// ///
/// @@ -5122,15 +5215,12 @@ pub struct MarketplaceRemoveResult { ///
#[derive(Debug, Clone, Default, Serialize, Deserialize)] #[serde(rename_all = "camelCase")] -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, +pub struct FactoryGetRunRequest { + /// Factory run identifier. + pub run_id: String, } -/// MCP server, tool name, and arguments to invoke from an MCP App view. +/// Parameters for reading a factory journal entry. /// ///
/// @@ -5140,19 +5230,16 @@ pub struct McpAllowedServer { ///
#[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 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, } -/// Capability negotiation snapshot +/// Result of reading a factory journal entry. /// ///
/// @@ -5162,16 +5249,15 @@ 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 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 result_json: Option, } -/// MCP server to diagnose MCP Apps wiring for. +/// Parameters for storing a factory journal entry. /// ///
/// @@ -5181,12 +5267,18 @@ 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 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, } -/// What the server returned for this session +/// Parameters for paging factory runs. /// ///
/// @@ -5196,18 +5288,19 @@ 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 FactoryListRunsRequest { + /// Exclusive forward cursor. + #[serde(skip_serializing_if = "Option::is_none")] + pub after_seq: Option, + /// Exclusive backward cursor. + #[serde(skip_serializing_if = "Option::is_none")] + 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 limit: Option, } -/// Diagnostic snapshot of MCP Apps wiring for the named server. +/// Durable factory resource consumption. /// ///
/// @@ -5217,14 +5310,16 @@ 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 FactoryRunConsumed { + /// Accumulated active execution time in milliseconds. + pub active_ms: i64, + /// AI usage consumed by the run in nano-AIU. + pub nano_aiu: i64, + /// Total subagents spawned by the run. + pub subagents: i64, } -/// Current host context +/// Prompt-safe terminal factory outcome. /// ///
/// @@ -5234,31 +5329,22 @@ pub struct McpAppsDiagnoseResult { ///
#[derive(Debug, Clone, Default, Serialize, Deserialize)] #[serde(rename_all = "camelCase")] -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 +pub struct FactoryRunTerminal { + /// Human-readable terminal error. #[serde(skip_serializing_if = "Option::is_none")] - pub platform: Option, - /// UI theme preference per SEP-1865 + pub error: Option, + /// Machine-readable terminal failure. #[serde(skip_serializing_if = "Option::is_none")] - pub theme: Option, - /// IANA timezone, e.g. 'America/New_York' + pub failure: Option, + /// Human-readable terminal reason. #[serde(skip_serializing_if = "Option::is_none")] - pub time_zone: Option, - /// Host application identifier + pub reason: Option, + /// Prompt-safe preview of the completed result. #[serde(skip_serializing_if = "Option::is_none")] - pub user_agent: Option, + pub result_preview: Option, } -/// Current host context advertised to MCP App guests. +/// Durable factory run summary with read-time live overlays. /// ///
/// @@ -5268,12 +5354,48 @@ pub struct McpAppsHostContextDetails { ///
#[derive(Debug, Clone, Default, Serialize, Deserialize)] #[serde(rename_all = "camelCase")] -pub struct McpAppsHostContext { - /// Current host context - pub context: McpAppsHostContextDetails, +pub struct FactoryRunSummary { + /// Epoch milliseconds when the current active segment started, or null while inactive. + pub active_segment_started_at: Option, + /// Approved effective resource ceilings, or null until approved. + pub approved: Option, + /// Epoch milliseconds when the run completed, or null while nonterminal. + pub completed_at: Option, + /// Durable resource consumption. + pub consumed: FactoryRunConsumed, + /// Epoch milliseconds when the run was created. + pub created_at: i64, + /// Current phase identity, or null before any phase is entered. + pub current_phase: Option, + /// Resource ceilings declared by the factory. + pub declared_limits: FactoryDeclaredLimits, + /// Number of phases declared by the factory. + pub declared_phase_count: i64, + /// Human-readable factory description. + pub description: String, + /// Registered factory name. + pub factory_name: String, + /// Number of direct factory agents currently live. + pub live_agent_count: i64, + /// Epoch milliseconds when this live-overlay snapshot was observed. + pub observed_at: i64, + /// Monotonic durable run revision. + pub revision: i64, + /// Factory run identifier. + pub run_id: String, + /// Epoch milliseconds when execution first started, or null before start. + pub started_at: Option, + /// Current factory run status. + pub status: FactoryRunStatus, + /// Terminal run outcome, or null while nonterminal. + pub terminal: Option, + /// Total direct factory agents spawned across all attempts. + pub total_spawned_agent_count: i64, + /// Epoch milliseconds when the durable run was last updated. + pub updated_at: i64, } -/// MCP server to list app-callable tools for. +/// A page of factory runs in durable creation order. /// ///
/// @@ -5283,14 +5405,24 @@ 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 FactoryListRunsResult { + /// 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, + /// Factory run summaries in durable creation order. + pub runs: Vec, } -/// App-callable tools from the named MCP server. +/// One ordered factory progress line. /// ///
/// @@ -5300,12 +5432,16 @@ 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 FactoryLogLine { + /// Progress line kind. + pub kind: FactoryLogLineKind, + /// Monotonic sequence number within the factory run. + pub seq: i64, + /// Progress text. + pub text: String, } -/// MCP server and resource URI to fetch. +/// Parameters for recording factory progress. /// ///
/// @@ -5315,14 +5451,16 @@ 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 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, } -/// MCP Apps resource content with URI, optional MIME type, text or base64 blob, and resource metadata. +/// Durable lifecycle and timing for one factory phase. /// ///
/// @@ -5332,24 +5470,39 @@ 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 FactoryPhaseObservation { + /// Completed active time accumulated by this phase in milliseconds. + pub accumulated_active_ms: i64, + /// Epoch milliseconds when this phase completed; for a skipped phase, the synthetic skip timestamp (equal to `startedAt`). #[serde(skip_serializing_if = "Option::is_none")] - pub mime_type: Option, - /// Text content (e.g. HTML) + pub completed_at: Option, + /// Current live active time for this phase in milliseconds. + pub current_active_ms: i64, + /// Optional human-readable phase detail. #[serde(skip_serializing_if = "Option::is_none")] - pub text: Option, - /// The resource URI (typically ui://...) - pub uri: String, + pub detail: Option, + /// Number of times execution entered this phase. + pub entry_count: i64, + /// Phase identifier. + pub id: String, + /// Most recent run attempt that entered this phase, or `0` if the phase has never been entered. + pub last_entered_run_attempt: i64, + /// Direct agents in this phase that are currently live. + pub live_agent_count: i64, + /// Zero-based declared phase ordinal, or null for an undeclared phase. + pub ordinal: Option, + /// Epoch milliseconds when this phase first started; for a skipped phase, the synthetic skip timestamp (equal to `completedAt`). + #[serde(skip_serializing_if = "Option::is_none")] + pub started_at: Option, + /// Derived lifecycle state of the phase. + pub status: FactoryPhaseStatus, + /// Human-readable phase title. + pub title: String, + /// Total direct agents associated with this phase. + pub total_agent_count: i64, } -/// Resource contents returned by the MCP server. +/// One durable factory progress record. /// ///
/// @@ -5359,12 +5512,22 @@ 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 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, } -/// Host context advertised to MCP App guests +/// A bidirectional page of factory progress. /// ///
/// @@ -5374,31 +5537,22 @@ 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 FactoryProgressPage { + /// Whether progress records newer than this page exist. + pub has_more_newer: bool, + /// Whether progress records older than this page exist. + pub has_more_older: bool, + /// Newest sequence number in this page, or null when empty. + pub newest_seq: Option, + /// Oldest sequence number in this page, or null when empty. + pub oldest_seq: Option, + /// Progress records in sequence order. + pub records: Vec, + /// Run revision reflected by this page. + pub revision: i64, } -/// Host context to advertise to MCP App guests. +/// Wire-only per-invocation factory resource ceiling overrides. /// ///
/// @@ -5408,12 +5562,22 @@ 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 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 requestId previously passed to executeSampling that should be cancelled. +/// Parameters for resuming a factory run from its persisted identity. /// ///
/// @@ -5423,12 +5587,21 @@ 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 FactoryResumeRequest { + /// Optional per-invocation resource ceiling overrides. + #[serde(skip_serializing_if = "Option::is_none")] + pub limits: Option, + /// Whether to emit factory phase names to the session transcript. + #[serde(skip_serializing_if = "Option::is_none")] + pub log_phase_names: Option, + /// Whether to notify the originating session when the factory completes. + #[serde(skip_serializing_if = "Option::is_none")] + pub notify_on_complete: Option, + /// Factory run identifier. + pub run_id: String, } -/// Indicates whether an in-flight sampling execution with the given requestId was found and cancelled. +/// Complete current or terminal factory run envelope. /// ///
/// @@ -5438,12 +5611,29 @@ 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, +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, } -/// MCP server name and configuration to add to user configuration. +/// Resolved persisted factory identity and resumed run envelope. /// ///
/// @@ -5453,14 +5643,14 @@ pub struct McpCancelSamplingExecutionResult { ///
#[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, +pub struct FactoryResumeResult { + /// Persisted factory name resolved for the resumed run. + pub factory_name: String, + /// Terminal resumed run envelope. + pub run: FactoryRunResult, } -/// MCP server names to disable for new sessions. +/// Full factory run observability detail. /// ///
/// @@ -5470,12 +5660,54 @@ pub struct McpConfigAddRequest { ///
#[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, +pub struct FactoryRunDetail { + /// Epoch milliseconds when the current active segment started, or null while inactive. + pub active_segment_started_at: Option, + /// Durable identities and live statuses for direct factory agents. + pub agents: Vec, + /// Approved effective resource ceilings, or null until approved. + pub approved: Option, + /// Epoch milliseconds when the run completed, or null while nonterminal. + pub completed_at: Option, + /// Durable resource consumption. + pub consumed: FactoryRunConsumed, + /// Epoch milliseconds when the run was created. + pub created_at: i64, + /// Current phase identity, or null before any phase is entered. + pub current_phase: Option, + /// Resource ceilings declared by the factory. + pub declared_limits: FactoryDeclaredLimits, + /// Number of phases declared by the factory. + pub declared_phase_count: i64, + /// Human-readable factory description. + pub description: String, + /// Registered factory name. + pub factory_name: String, + /// Number of direct factory agents currently live. + pub live_agent_count: i64, + /// Epoch milliseconds when this live-overlay snapshot was observed. + pub observed_at: i64, + /// Lifecycle and timing observations for each factory phase. + pub phases: Vec, + /// Bidirectional page of durable factory progress. + pub progress: FactoryProgressPage, + /// Monotonic durable run revision. + pub revision: i64, + /// Factory run identifier. + pub run_id: String, + /// Epoch milliseconds when execution first started, or null before start. + pub started_at: Option, + /// Current factory run status. + pub status: FactoryRunStatus, + /// Terminal run outcome, or null while nonterminal. + pub terminal: Option, + /// Total direct factory agents spawned across all attempts. + pub total_spawned_agent_count: i64, + /// Epoch milliseconds when the durable run was last updated. + pub updated_at: i64, } -/// MCP server names to enable for new sessions. +/// Options controlling factory invocation. /// ///
/// @@ -5485,12 +5717,22 @@ pub struct McpConfigDisableRequest { ///
#[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, +pub struct RunOptions { + /// Per-invocation resource ceiling overrides. + #[serde(skip_serializing_if = "Option::is_none")] + pub limits: Option, + /// Whether to emit factory phase names to the session transcript. + #[serde(skip_serializing_if = "Option::is_none")] + pub log_phase_names: Option, + /// Whether to notify the originating session when the factory completes. + #[serde(skip_serializing_if = "Option::is_none")] + pub notify_on_complete: 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, } -/// User-configured MCP servers, keyed by server name. +/// Parameters for invoking a registered factory. /// ///
/// @@ -5500,12 +5742,17 @@ pub struct McpConfigEnableRequest { ///
#[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, +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, } -/// MCP server name to remove from user configuration. +/// Internal parameters for resuming a factory run from a tool. /// ///
/// @@ -5515,12 +5762,18 @@ pub struct McpConfigList { ///
#[derive(Debug, Clone, Default, Serialize, Deserialize)] #[serde(rename_all = "camelCase")] -pub struct McpConfigRemoveRequest { - /// Name of the MCP server to remove - pub name: String, +pub(crate) struct FactoryToolResumeRequest { + /// Optional per-invocation resource ceiling overrides. + #[serde(skip_serializing_if = "Option::is_none")] + pub limits: Option, + /// Factory run identifier. + pub run_id: String, + /// Opaque identifier of the originating tool call. + #[serde(skip_serializing_if = "Option::is_none")] + pub tool_call_id: Option, } -/// MCP server name and replacement configuration to write to user configuration. +/// Options for an internal tool-originated factory invocation. /// ///
/// @@ -5530,14 +5783,16 @@ pub struct McpConfigRemoveRequest { ///
#[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(crate) struct FactoryToolRunOptions { + /// 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, } -/// Opaque auth info used to configure GitHub MCP. +/// Internal parameters for invoking a registered factory from a tool. /// ///
/// @@ -5547,13 +5802,21 @@ pub struct McpConfigUpdateRequest { ///
#[derive(Debug, Clone, Default, Serialize, Deserialize)] #[serde(rename_all = "camelCase")] -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). +pub(crate) struct FactoryToolRunRequest { + /// Factory input value. + pub args: serde_json::Value, + /// Registered factory name. + pub name: String, + /// Tool-originated factory invocation options. #[doc(hidden)] - pub(crate) auth_info: serde_json::Value, + #[serde(skip_serializing_if = "Option::is_none")] + pub(crate) options: Option, + /// Opaque identifier of the originating tool call. + #[serde(skip_serializing_if = "Option::is_none")] + pub tool_call_id: Option, } -/// Result of configuring GitHub MCP. +/// Optional user prompt to combine with the fleet orchestration instructions. /// ///
/// @@ -5563,12 +5826,13 @@ pub(crate) struct McpConfigureGitHubRequest { ///
#[derive(Debug, Clone, Default, Serialize, Deserialize)] #[serde(rename_all = "camelCase")] -pub struct McpConfigureGitHubResult { - /// Whether GitHub MCP configuration changed. - pub changed: bool, +pub struct FleetStartRequest { + /// Optional user prompt to combine with fleet instructions + #[serde(skip_serializing_if = "Option::is_none")] + pub prompt: Option, } -/// Name of the MCP server to disable for the session. +/// Indicates whether fleet mode was successfully activated. /// ///
/// @@ -5578,12 +5842,12 @@ pub struct McpConfigureGitHubResult { ///
#[derive(Debug, Clone, Default, Serialize, Deserialize)] #[serde(rename_all = "camelCase")] -pub struct McpDisableRequest { - /// Name of the MCP server to disable - pub server_name: String, +pub struct FleetStartResult { + /// Whether fleet mode was successfully activated + pub started: bool, } -/// Optional working directory used as context for MCP server discovery. +/// Folder path to add to trusted folders. /// ///
/// @@ -5593,13 +5857,12 @@ pub struct McpDisableRequest { ///
#[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, +pub struct FolderTrustAddParams { + /// Folder path to mark as trusted + pub path: String, } -/// MCP servers discovered from user, workspace, plugin, and built-in sources. +/// Folder path to check for trust. /// ///
/// @@ -5609,12 +5872,12 @@ pub struct McpDiscoverRequest { ///
#[derive(Debug, Clone, Default, Serialize, Deserialize)] #[serde(rename_all = "camelCase")] -pub struct McpDiscoverResult { - /// MCP servers discovered from all sources - pub servers: Vec, +pub struct FolderTrustCheckParams { + /// Folder path to check + pub path: String, } -/// Name of the MCP server to enable for the session. +/// Folder trust check result. /// ///
/// @@ -5624,24 +5887,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 FolderTrustCheckResult { + /// Whether the folder is trusted + pub trusted: bool, } -/// 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.** This type is part of an experimental wire-protocol surface -/// and may change or be removed in future SDK or CLI releases. -/// -///
-#[derive(Debug, Clone, Default, Serialize, Deserialize)] -#[serde(rename_all = "camelCase")] -pub struct McpExecuteSamplingRequest {} - -/// Identifiers and raw MCP CreateMessageRequest params used to run a sampling inference. +/// Client environment metadata describing the process that produced a telemetry event. /// ///
/// @@ -5651,18 +5902,46 @@ 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 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, + /// Number of logical CPU cores on the host. + #[serde(rename = "cpu_count", skip_serializing_if = "Option::is_none")] + pub cpu_count: Option, + /// Distinct CPU model names for the host, comma-separated. + #[serde(rename = "cpu_model", skip_serializing_if = "Option::is_none")] + pub cpu_model: 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, } -/// MCP server filtered by policy, with name, reason, optional redacted reason, and enterprise login. +/// 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. /// ///
/// @@ -5672,34 +5951,43 @@ pub struct McpExecuteSamplingParams { ///
#[derive(Debug, Clone, Default, Serialize, Deserialize)] #[serde(rename_all = "camelCase")] -pub struct McpFilteredServer { - /// Enterprise login associated with an allowlist policy - #[serde(skip_serializing_if = "Option::is_none")] - pub enterprise_name: Option, - /// Filtered server name - pub name: String, - /// Human-readable filter reason - pub reason: String, - /// PII-free filter reason +pub struct GitHubTelemetryEvent { + /// Client environment metadata. #[serde(skip_serializing_if = "Option::is_none")] - pub redacted_reason: Option, -} - -#[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, + 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, } -/// MCP headers refresh request id and the host response. +/// 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. /// ///
/// @@ -5707,16 +5995,19 @@ pub struct McpHeadersHandlePendingHeadersRefreshRequestNone { /// 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 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, +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 session_id: Option, } -/// Indicates whether the pending MCP headers refresh response was accepted. +/// Asks the SDK client to acquire a GitHub access token from an opaque callback registration. /// ///
/// @@ -5726,12 +6017,40 @@ pub struct McpHeadersHandlePendingHeadersRefreshRequestRequest { ///
#[derive(Debug, Clone, Default, Serialize, Deserialize)] #[serde(rename_all = "camelCase")] -pub struct McpHeadersHandlePendingHeadersRefreshRequestResult { - /// Whether the response was accepted. False if the request was unknown, timed out, or already resolved. - pub success: bool, +pub struct GitHubTokenAcquireRequest { + /// Effective GitHub host for which the callback must return a token. + pub host: String, + /// Why the runtime is requesting a GitHub credential. + pub reason: GitHubTokenAcquireReason, + /// Opaque identifier generated by the SDK for this callback registration. + pub registration_id: String, + /// Session receiving the token. Absent only before a cloud session has been assigned its id. + #[serde(skip_serializing_if = "Option::is_none")] + pub session_id: Option, } -/// Recorded MCP server connection failure. +#[derive(Debug, Clone, Default, Serialize, Deserialize)] +#[serde(rename_all = "camelCase")] +pub struct GitHubTokenAcquireResultToken { + /// GitHub access token acquired by the SDK host. + pub access_token: String, + /// Remaining token lifetime in seconds when callback execution completes. It must exceed the one-hour preflight refresh threshold. + pub expires_in: i64, + /// GitHub credential response variant discriminator. + pub kind: GitHubTokenAcquireResultTokenKind, + /// OAuth token type. Defaults to bearer when omitted. + #[serde(skip_serializing_if = "Option::is_none")] + pub token_type: Option, +} + +#[derive(Debug, Clone, Default, Serialize, Deserialize)] +#[serde(rename_all = "camelCase")] +pub struct GitHubTokenAcquireResultCancelled { + /// GitHub credential response variant discriminator. + pub kind: GitHubTokenAcquireResultCancelledKind, +} + +/// Pending external tool call request ID, with the tool result or an error describing why it failed. /// ///
/// @@ -5741,14 +6060,18 @@ pub struct McpHeadersHandlePendingHeadersRefreshRequestResult { ///
#[derive(Debug, Clone, Default, Serialize, Deserialize)] #[serde(rename_all = "camelCase")] -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, +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, } -/// Recorded MCP server pending-auth state. +/// Indicates whether the external tool call result was handled successfully. /// ///
/// @@ -5758,12 +6081,12 @@ pub struct McpServerFailureInfo { ///
#[derive(Debug, Clone, Default, Serialize, Deserialize)] #[serde(rename_all = "camelCase")] -pub struct McpServerNeedsAuthInfo { - /// epoch-ms timestamp at which the server signalled it needs authentication. - pub timestamp: i64, +pub struct HandlePendingToolCallResult { + /// Whether the tool call result was handled successfully + pub success: bool, } -/// Host-level state, omitted when no MCP host is initialized. +/// Indicates whether an in-progress manual compaction was aborted. /// ///
/// @@ -5773,24 +6096,12 @@ pub struct McpServerNeedsAuthInfo { ///
#[derive(Debug, Clone, Default, Serialize, Deserialize)] #[serde(rename_all = "camelCase")] -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 enterprise allowlist 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, +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, } -/// Server name to check running status for. +/// Indicates whether an in-progress background compaction was cancelled. /// ///
/// @@ -5800,12 +6111,12 @@ pub struct McpHostState { ///
#[derive(Debug, Clone, Default, Serialize, Deserialize)] #[serde(rename_all = "camelCase")] -pub struct McpIsServerRunningRequest { - /// Name of the MCP server to check - pub server_name: String, +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, } -/// Whether the named MCP server is running. +/// Parameters for clearing the conversation and seeding the window that replaces it. /// ///
/// @@ -5815,12 +6126,12 @@ pub struct McpIsServerRunningRequest { ///
#[derive(Debug, Clone, Default, Serialize, Deserialize)] #[serde(rename_all = "camelCase")] -pub struct McpIsServerRunningResult { - /// True if the server has an active client and transport. - pub running: bool, +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, } -/// Server name whose tool list should be returned. +/// What a successful clear removed. A clear that could not be applied rejects instead of reporting a count. /// ///
/// @@ -5830,12 +6141,12 @@ pub struct McpIsServerRunningResult { ///
#[derive(Debug, Clone, Default, Serialize, Deserialize)] #[serde(rename_all = "camelCase")] -pub struct McpListToolsRequest { - /// Name of the connected MCP server whose tools to list. - pub server_name: String, +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, } -/// Normalized MCP Apps discovery metadata from a tool's `_meta.ui` block. +/// Post-compaction context window usage breakdown /// ///
/// @@ -5845,16 +6156,25 @@ pub struct McpListToolsRequest { ///
#[derive(Debug, Clone, Default, Serialize, Deserialize)] #[serde(rename_all = "camelCase")] -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. +pub struct HistoryCompactContextWindow { + /// Token count from non-system messages (user, assistant, tool) #[serde(skip_serializing_if = "Option::is_none")] - pub resource_uri: Option, - /// Tool visibility advertised by the server. When absent, MCP Apps defaults apply. + 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 visibility: Option>, + 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, } -/// MCP tool metadata with tool name, optional description, and normalized MCP Apps discovery metadata. +/// Optional compaction parameters. /// ///
/// @@ -5864,18 +6184,19 @@ pub struct McpToolUi { ///
#[derive(Debug, Clone, Default, Serialize, Deserialize)] #[serde(rename_all = "camelCase")] -pub struct McpTools { - /// Tool description, when provided. +pub struct HistoryCompactRequest { + /// Optional user-provided instructions to focus the compaction summary #[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. + 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 ui: Option, + 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, } -/// Tools exposed by the connected MCP server. Throws when the server is not connected. +/// Compaction outcome with the number of tokens and messages removed, summary text, and the resulting context window breakdown. /// ///
/// @@ -5885,32 +6206,53 @@ pub struct McpTools { ///
#[derive(Debug, Clone, Default, Serialize, Deserialize)] #[serde(rename_all = "camelCase")] -pub struct McpListToolsResult { - /// Tools exposed by the server. - pub tools: Vec, -} - -#[derive(Debug, Clone, Default, Serialize, Deserialize)] -#[serde(rename_all = "camelCase")] -pub struct McpOauthPendingRequestResponseToken { - /// Access token acquired by the SDK host - pub access_token: String, - /// Token lifetime in seconds, if known. +pub struct HistoryCompactResult { + /// Post-compaction context window usage breakdown #[serde(skip_serializing_if = "Option::is_none")] - pub expires_in: Option, - pub kind: McpOauthPendingRequestResponseTokenKind, - /// OAuth token type. Defaults to Bearer when omitted. + 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 token_type: Option, + pub summary_content: Option, + /// Number of tokens freed by compaction + pub tokens_removed: i64, } +/// A root user turn that the session can rewind 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 McpOauthPendingRequestResponseCancelled { - pub kind: McpOauthPendingRequestResponseCancelledKind, +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, } -/// Pending MCP OAuth request ID and host-provided token or cancellation response. +/// Rewind points and file-change-tracking availability for the session. /// ///
/// @@ -5918,16 +6260,19 @@ pub struct McpOauthPendingRequestResponseCancelled { /// 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 McpOauthHandlePendingRequest { - /// OAuth request identifier from the mcp.oauth_required event - pub request_id: RequestId, - /// Host response to the pending OAuth request. - pub result: McpOauthPendingRequestResponse, +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, } -/// Indicates whether the pending MCP OAuth response was accepted. +/// Event boundary to preview for conversation-and-files rewind. /// ///
/// @@ -5937,12 +6282,12 @@ pub struct McpOauthHandlePendingRequest { ///
#[derive(Debug, Clone, Default, Serialize, Deserialize)] #[serde(rename_all = "camelCase")] -pub struct McpOauthHandlePendingResult { - /// Whether the response was accepted. False if the request was unknown, timed out, or already resolved. - pub success: bool, +pub struct HistoryPreviewRewindRequest { + /// ID of the user.message event that begins the discarded suffix. + pub event_id: String, } -/// Remote MCP server name and optional overrides controlling reauthentication, OAuth client display name, callback success-page copy, and static OAuth client selection. +/// A file that a conversation-and-files rewind would restore. /// ///
/// @@ -5952,33 +6297,18 @@ pub struct McpOauthHandlePendingResult { ///
#[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. - #[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, +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, } -/// OAuth authorization URL the caller should open, or empty when cached tokens already authenticated the server. +/// Files and aggregate changes for a prospective rewind. /// ///
/// @@ -5988,13 +6318,19 @@ 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. +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 authorization_url: Option, + pub reason: Option, } -/// Registration parameters for an external MCP client. +/// Boundary and mode for rewinding session history. /// ///
/// @@ -6004,21 +6340,14 @@ pub struct McpOauthLoginResult { ///
#[derive(Debug, Clone, Default, Serialize, Deserialize)] #[serde(rename_all = "camelCase")] -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, +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, } -/// Opaque MCP reload configuration. +/// A captured file that rewind intentionally left unchanged. /// ///
/// @@ -6028,13 +6357,14 @@ pub(crate) struct McpRegisterExternalClientRequest { ///
#[derive(Debug, Clone, Default, Serialize, Deserialize)] #[serde(rename_all = "camelCase")] -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, +pub struct HistorySkippedFileRestore { + /// Absolute path of the skipped file. + pub path: String, + /// Reason the file was not restored. + pub reason: HistoryFileRestoreSkipReason, } -/// Indicates whether the auto-managed `github` MCP server was removed (false when nothing to remove). +/// Structured outcome of a rewind request. /// ///
/// @@ -6044,12 +6374,22 @@ pub(crate) struct McpReloadWithConfigRequest { ///
#[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 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, } -/// Standard MCP resource annotations plus preserved non-standard annotation fields. +/// Markdown summary of the conversation context (empty when not available). /// ///
/// @@ -6059,22 +6399,12 @@ pub struct McpRemoveGitHubResult { ///
#[derive(Debug, Clone, Default, Serialize, Deserialize)] #[serde(rename_all = "camelCase")] -pub struct McpResourceAnnotations { - /// Server-provided non-standard annotation fields preserved from the MCP response - #[serde(skip_serializing_if = "Option::is_none")] - pub additional_properties: Option>, - /// Intended audience roles for this resource - #[serde(skip_serializing_if = "Option::is_none")] - pub audience: Option>, - /// Last-modified timestamp hint - #[serde(skip_serializing_if = "Option::is_none")] - pub last_modified: Option, - /// Priority hint for model/client use - #[serde(skip_serializing_if = "Option::is_none")] - pub priority: Option, +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, } -/// A resource icon descriptor plus preserved non-standard icon fields. +/// Identifier of the event to truncate to; this event and all later events are removed. /// ///
/// @@ -6084,24 +6414,12 @@ pub struct McpResourceAnnotations { ///
#[derive(Debug, Clone, Default, Serialize, Deserialize)] #[serde(rename_all = "camelCase")] -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, +pub struct HistoryTruncateRequest { + /// Event ID to truncate to. This event and all events after it are removed from the session. + pub event_id: String, } -/// 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`. +/// Number of events that were removed by the truncation. /// ///
/// @@ -6111,38 +6429,36 @@ pub struct McpResourceIcon { ///
#[derive(Debug, Clone, Default, Serialize, Deserialize)] #[serde(rename_all = "camelCase")] -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 additional_properties: Option>, - /// Model/client annotations associated with this resource - #[serde(skip_serializing_if = "Option::is_none")] - pub annotations: Option, - /// Optional description of what this resource represents - #[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, if known +pub struct HistoryTruncateResult { + /// Failure detail when checkpointCleanupFailed is true. #[serde(skip_serializing_if = "Option::is_none")] - pub mime_type: Option, - /// The programmatic name of the resource - pub name: String, - /// Resource size in bytes, when known + 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 size: Option, - /// Optional human-readable display title + pub checkpoint_cleanup_failed: Option, + /// Number of events that were removed + pub events_removed: i64, +} + +/// Runtime-owned wire payload for a server-to-client hook callback invocation. +#[derive(Debug, Clone, Default, Serialize, Deserialize)] +#[serde(rename_all = "camelCase")] +pub(crate) struct HookInvokeRequest { + #[doc(hidden)] + pub(crate) hook_type: HookType, + pub input: serde_json::Value, + pub session_id: SessionId, +} + +/// Optional output returned by an SDK callback hook. +#[derive(Debug, Clone, Default, Serialize, Deserialize)] +#[serde(rename_all = "camelCase")] +pub(crate) struct HookInvokeResponse { #[serde(skip_serializing_if = "Option::is_none")] - pub title: Option, - /// The resource URI (e.g. ui://... or file:///...) - pub uri: String, + pub output: Option, } -/// MCP resource content with URI, optional MIME type, text or base64 blob, and resource metadata. +/// Installed plugin record from global state, with marketplace, version, install time, enabled state, cache path, and source. /// ///
/// @@ -6152,24 +6468,34 @@ pub struct McpResource { ///
#[derive(Debug, Clone, Default, Serialize, Deserialize)] #[serde(rename_all = "camelCase")] -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 +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, + /// Absolute path of the marketplace directory a live plugin was resolved from. Present only on live, never-persisted records β€” those synthesized at session start for a directory/local marketplace, whose cache_path points at the real plugin directory on disk rather than a copy under the installed-plugins cache. Its presence is what marks a record as live, and no record carrying it is ever written to the persisted installedPlugins key. + #[serde(rename = "installed_from", skip_serializing_if = "Option::is_none")] + pub installed_from: Option, + /// 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 mime_type: Option, - /// Text content (e.g. HTML) + 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 text: Option, - /// The resource URI - pub uri: String, + pub version: Option, } -/// MCP server whose resources to enumerate. +/// Information about an installed plugin tracked in global state. /// ///
/// @@ -6179,15 +6505,25 @@ pub struct McpResourceContent { ///
#[derive(Debug, Clone, Default, Serialize, Deserialize)] #[serde(rename_all = "camelCase")] -pub struct McpResourcesListRequest { - /// Opaque MCP pagination cursor from a prior `nextCursor` value +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 cursor: Option, - /// Name of the MCP server whose resources to enumerate - pub server_name: String, + pub direct_source_id: Option, + /// Whether the plugin is currently enabled for new sessions + pub enabled: bool, + /// Absolute path of the marketplace directory a live plugin was resolved from. Present only on live, never-persisted records β€” a plugin belonging to a directory/local marketplace, which is loaded from its real directory on every pass instead of a copy under the installed-plugins cache. Its presence is what marks a listed plugin as live: such a plugin is always present on disk, so `enabled` is its only meaningful state and it is never "not installed". + #[serde(skip_serializing_if = "Option::is_none")] + pub installed_from: Option, + /// 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, } -/// One page of resources advertised by the named MCP server. +/// Source descriptor for a direct GitHub plugin install, with `owner/repo`, optional ref or full commit SHA, and optional subpath. /// ///
/// @@ -6197,15 +6533,23 @@ pub struct McpResourcesListRequest { ///
#[derive(Debug, Clone, Default, Serialize, Deserialize)] #[serde(rename_all = "camelCase")] -pub struct McpResourcesListResult { - /// Opaque cursor for the next page, if the server has more resources +pub struct InstalledPluginSourceGitHub { + /// Optional repository-relative path to the plugin. #[serde(skip_serializing_if = "Option::is_none")] - pub next_cursor: Option, - /// Resources advertised by the server (proxied MCP `resources/list`) - pub resources: Vec, + pub path: Option, + /// Optional Git ref to resolve. + #[serde(skip_serializing_if = "Option::is_none")] + pub r#ref: Option, + /// GitHub repository in `owner/repo` form. + 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, } -/// MCP server whose resource templates to enumerate. +/// Source descriptor for a direct local plugin install, with a local filesystem path. /// ///
/// @@ -6215,15 +6559,14 @@ pub struct McpResourcesListResult { ///
#[derive(Debug, Clone, Default, Serialize, Deserialize)] #[serde(rename_all = "camelCase")] -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, +pub struct InstalledPluginSourceLocal { + /// Local filesystem path to the plugin. + pub path: String, + /// Constant value. Always "local". + pub source: InstalledPluginSourceLocalSource, } -/// 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`. +/// Source descriptor for a direct URL plugin install, with URL, optional ref or full commit SHA, and optional subpath. /// ///
/// @@ -6233,35 +6576,23 @@ pub struct McpResourcesListTemplatesRequest { ///
#[derive(Debug, Clone, Default, Serialize, Deserialize)] #[serde(rename_all = "camelCase")] -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 +pub struct InstalledPluginSourceUrl { + /// Optional source-relative path to the plugin. #[serde(skip_serializing_if = "Option::is_none")] - pub icons: Option>, - /// MIME type for resources matching this template, if uniform + pub path: Option, + /// Optional Git ref to resolve. #[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 + pub r#ref: Option, + /// Optional full 40-character hexadecimal commit SHA. #[serde(skip_serializing_if = "Option::is_none")] - pub title: Option, - /// An RFC 6570 URI template for constructing resource URIs - pub uri_template: String, + pub sha: Option, + /// Constant value. Always "url". + pub source: InstalledPluginSourceUrlSource, + /// URL of the plugin source. + pub url: String, } -/// One page of resource templates advertised by the named MCP server. +/// Canonical file or directory where custom instructions can be discovered or created, with location, kind, preference, and project path. /// ///
/// @@ -6271,15 +6602,21 @@ pub struct McpResourceTemplate { ///
#[derive(Debug, Clone, Default, Serialize, Deserialize)] #[serde(rename_all = "camelCase")] -pub struct McpResourcesListTemplatesResult { - /// Opaque cursor for the next page, if the server has more resource templates +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 next_cursor: Option, - /// Resource templates advertised by the server (proxied MCP `resources/templates/list`) - pub resource_templates: Vec, + pub project_path: Option, } -/// MCP server and resource URI to fetch. +/// Canonical files and directories where custom instructions can be created so the runtime will recognize them. /// ///
/// @@ -6289,14 +6626,12 @@ pub struct McpResourcesListTemplatesResult { ///
#[derive(Debug, Clone, Default, Serialize, Deserialize)] #[serde(rename_all = "camelCase")] -pub struct McpResourcesReadRequest { - /// Name of the MCP server hosting the resource - pub server_name: String, - /// Resource URI - pub uri: String, +pub struct InstructionDiscoveryPathList { + /// Canonical instruction create/discovery files and directories, in priority order + pub paths: Vec, } -/// Resource contents returned by the MCP server. +/// Optional project paths to include in instruction discovery. /// ///
/// @@ -6306,14 +6641,18 @@ pub struct McpResourcesReadRequest { ///
#[derive(Debug, Clone, Default, Serialize, Deserialize)] #[serde(rename_all = "camelCase")] -pub struct McpResourcesReadResult { - /// Resource contents returned by the server - pub contents: Vec, -} - -/// 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. -/// -///
+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>, +} + +/// Optional project paths to include when enumerating instruction discovery targets. +/// +///
/// /// **Experimental.** This type is part of an experimental wire-protocol surface /// and may change or be removed in future SDK or CLI releases. @@ -6321,15 +6660,16 @@ pub struct McpResourcesReadResult { ///
#[derive(Debug, Clone, Default, Serialize, Deserialize)] #[serde(rename_all = "camelCase")] -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). +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 config: Option, - /// Name of the MCP server to restart - pub server_name: String, + 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>, } -/// Outcome of an MCP sampling execution: success result, failure error, or cancellation. +/// Loaded instruction source for a session, including path, content, category, location, applicability, and optional description. /// ///
/// @@ -6339,18 +6679,34 @@ pub struct McpRestartServerRequest { ///
#[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'. +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 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 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 result: Option, + 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, } -/// MCP server status entry, including config source/plugin source and any connection error. +/// Instruction sources loaded for the session, in merge order. /// ///
/// @@ -6360,26 +6716,12 @@ pub struct McpSamplingExecutionResult { ///
#[derive(Debug, Clone, Default, Serialize, Deserialize)] #[serde(rename_all = "camelCase")] -pub struct McpServer { - /// Error message if the server failed to connect - #[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, - /// 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, or not_configured - pub status: McpServerStatus, +pub struct InstructionsGetSourcesResult { + /// Instruction sources for the session + pub sources: Vec, } -/// Authentication settings with optional redirect port configuration. +/// Parameters for interrupting the main agent turn. /// ///
/// @@ -6389,13 +6731,13 @@ pub struct McpServer { ///
#[derive(Debug, Clone, Default, Serialize, Deserialize)] #[serde(rename_all = "camelCase")] -pub struct McpServerAuthConfigRedirectPort { - /// Fixed port for the OAuth redirect callback server. +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 redirect_port: Option, + pub flush_queued: Option, } -/// Remote MCP server configuration accessed over HTTP or SSE. +/// Result of interrupting the main agent turn. /// ///
/// @@ -6405,48 +6747,79 @@ pub struct McpServerAuthConfigRedirectPort { ///
#[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, - /// 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) +pub struct InterruptMainTurnResult { + /// Whether an in-flight main agent turn was interrupted. False when the main loop was not processing. + pub interrupted: bool, +} + +/// 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 defer_tools: Option, - /// Content filtering mode to apply to all tools, or a map of tool name to content filtering mode. + 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 filter_mapping: Option, - /// HTTP headers to include in requests to the remote MCP server. + 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 headers: Option>, - /// Whether this server is a built-in fallback used when the user has not configured their own server. + pub cancel: Option, + /// Optional human-readable reason for the cancellation, propagated for logging. #[serde(skip_serializing_if = "Option::is_none")] - pub is_default_server: Option, - /// OAuth client ID for a pre-registered remote MCP OAuth client. + 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 oauth_client_id: Option, - /// OAuth grant type to use when authenticating to the remote MCP server. + 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 oauth_grant_type: Option, - /// Whether the configured OAuth client is public and does not require a client secret. + 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 oauth_public_client: Option, - /// Set to `true` to use defaults, or provide an object with additional auth or OIDC settings. + pub agent_invocation_id: Option, + /// HTTP request headers, preserving multiple values per name. + 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 oidc: Option, - /// Timeout in milliseconds for tool calls to this server. + 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 timeout: Option, - /// Tools to include. Defaults to all tools if not specified. + 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 tools: Option>, - /// Remote transport type. Defaults to "http" when omitted. + 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 r#type: Option, - /// URL of the remote MCP server endpoint. + pub transport: Option, + /// Absolute request URL. pub url: String, } -/// Stdio MCP server configuration launched as a child process. +/// 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. /// ///
/// @@ -6456,42 +6829,15 @@ pub struct McpServerConfigHttp { ///
#[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, - /// 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, - /// 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. +pub struct LlmInferenceHttpResponseChunkError { + /// Optional machine-readable error code. #[serde(skip_serializing_if = "Option::is_none")] - pub tools: Option>, + pub code: Option, + /// Human-readable failure description. + pub message: String, } -/// MCP servers configured for the session, with their connection status and host-level state. +/// A response body chunk or terminal error. /// ///
/// @@ -6501,15 +6847,23 @@ pub struct McpServerConfigStdio { ///
#[derive(Debug, Clone, Default, Serialize, Deserialize)] #[serde(rename_all = "camelCase")] -pub struct McpServerList { - /// Host-level state, omitted when no MCP host is initialized. +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 host: Option, - /// Configured MCP servers - pub servers: Vec, + 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, } -/// Mode controlling how MCP server env values are resolved (`direct` or `indirect`). +/// Whether the chunk was accepted. /// ///
/// @@ -6519,12 +6873,12 @@ 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 LlmInferenceHttpResponseChunkResult { + /// True when the chunk was matched to a pending request; false when unknown. + pub accepted: bool, } -/// Env-value mode recorded on the session after the update. +/// Response head. /// ///
/// @@ -6534,12 +6888,19 @@ 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 LlmInferenceHttpResponseStartRequest { + /// HTTP response headers, preserving multiple values per name. + 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, } -/// Server name and configuration for an individual MCP server start. +/// Whether the start frame was accepted. /// ///
/// @@ -6549,14 +6910,12 @@ pub struct McpSetEnvValueModeResult { ///
#[derive(Debug, Clone, Default, Serialize, Deserialize)] #[serde(rename_all = "camelCase")] -pub struct McpStartServerRequest { - /// MCP server configuration (stdio process or remote HTTP/SSE) - pub config: serde_json::Value, - /// Name of the MCP server to start - pub server_name: String, +pub struct LlmInferenceHttpResponseStartResult { + /// True when the response start was matched to a pending request; false when unknown. + pub accepted: bool, } -/// MCP server startup filtering result. +/// Indicates whether the calling client was registered as the LLM inference provider. /// ///
/// @@ -6566,15 +6925,12 @@ pub struct McpStartServerRequest { ///
#[derive(Debug, Clone, Default, Serialize, Deserialize)] #[serde(rename_all = "camelCase")] -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, +pub struct LlmInferenceSetProviderResult { + /// Whether the provider was set successfully + pub success: bool, } -/// Server name for an individual MCP server stop. +/// Pre-resolved working-directory context for session startup. /// ///
/// @@ -6584,12 +6940,24 @@ pub struct McpStartServersResult { ///
#[derive(Debug, Clone, Default, Serialize, Deserialize)] #[serde(rename_all = "camelCase")] -pub struct McpStopServerRequest { - /// Name of the MCP server to stop - pub server_name: String, +pub struct SessionContext { + /// Active git branch + #[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 + #[serde(skip_serializing_if = "Option::is_none")] + pub git_root: Option, + /// Repository host type + #[serde(skip_serializing_if = "Option::is_none")] + pub host_type: Option, + /// Repository slug in `owner/name` form, when known + #[serde(skip_serializing_if = "Option::is_none")] + pub repository: Option, } -/// Server name identifying the external client to remove. +/// Persisted local session metadata, including identifiers, timestamps, summary/name, client, context, detached state, and task ID. /// ///
/// @@ -6599,12 +6967,36 @@ pub struct McpStopServerRequest { ///
#[derive(Debug, Clone, Default, Serialize, Deserialize)] #[serde(rename_all = "camelCase")] -pub(crate) struct McpUnregisterExternalClientRequest { - /// Server name of the external client to unregister - pub server_name: 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, } -/// Memory configuration for this session. +/// Message text, optional severity level, persistence flag, optional follow-up URL, and optional tip. /// ///
/// @@ -6614,51 +7006,83 @@ pub(crate) struct McpUnregisterExternalClientRequest { ///
#[derive(Debug, Clone, Default, Serialize, Deserialize)] #[serde(rename_all = "camelCase")] -pub struct MemoryConfiguration { - /// Whether memory is enabled for the session. - pub enabled: bool, +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, } -/// Successful compaction history for the session. +/// 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 MetadataContextAttributionResultContextAttributionCompactions { - /// Number of successful compactions in this session. - pub count: i64, +pub struct LogResult { + /// The unique identifier of the emitted session event + pub event_id: String, } +/// Parameters for (re)loading the merged LSP configuration 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 MetadataContextAttributionResultContextAttributionEntriesItem { - /// Supplementary per-entry metadata (e.g. `messageCount`, `role`, `evictable`, `pluginSource`). Values are stringified; parse as needed and ignore unrecognized keys. +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 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. + 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 parent_id: Option, - /// Token count currently in context attributable to this entry. - pub tokens: i64, + 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, } -/// Per-source token attribution snapshot for the current context window. The heaviest individual messages are available separately via `metadata.getContextHeaviestMessages`. +/// Validated device-managed settings discovered before a 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 MetadataContextAttributionResultContextAttribution { - /// Successful compaction history for the session. - pub compactions: MetadataContextAttributionResultContextAttributionCompactions, - /// 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, - /// 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, +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, } -/// Per-source attribution breakdown for the session's current context window, or null if uninitialized. +/// Result of registering a new marketplace. /// ///
/// @@ -6668,12 +7092,12 @@ pub struct MetadataContextAttributionResultContextAttribution { ///
#[derive(Debug, Clone, Default, Serialize, Deserialize)] #[serde(rename_all = "camelCase")] -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, +pub struct MarketplaceAddResult { + /// Final name of the marketplace as resolved from its manifest + pub name: String, } -/// Parameters for the heaviest-messages query. +/// Plugin entry advertised by a marketplace. /// ///
/// @@ -6683,13 +7107,15 @@ pub struct MetadataContextAttributionResult { ///
#[derive(Debug, Clone, Default, Serialize, Deserialize)] #[serde(rename_all = "camelCase")] -pub struct MetadataContextHeaviestMessagesRequest { - /// Maximum number of messages to return, most-expensive first. Omit for the server default. +pub struct MarketplacePluginInfo { + /// Short description from the marketplace catalog, when present #[serde(skip_serializing_if = "Option::is_none")] - pub limit: Option, + pub description: Option, + /// Plugin name as listed in the marketplace catalog + pub name: String, } -/// The heaviest individual messages in the session's context window, most-expensive first. +/// Plugins advertised by the marketplace. /// ///
/// @@ -6699,14 +7125,12 @@ pub struct MetadataContextHeaviestMessagesRequest { ///
#[derive(Debug, Clone, Default, Serialize, Deserialize)] #[serde(rename_all = "camelCase")] -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, +pub struct MarketplaceBrowseResult { + /// Plugins advertised by the marketplace + pub plugins: Vec, } -/// Model identifier and token limits used to compute the context-info breakdown. +/// Registered marketplace summary. /// ///
/// @@ -6716,43 +7140,17 @@ pub struct MetadataContextHeaviestMessagesResult { ///
#[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. +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 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, + 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, } -/// Token breakdown for the session's current context window, or null if uninitialized. +/// All registered marketplaces, including built-in defaults. /// ///
/// @@ -6762,12 +7160,12 @@ 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 MarketplaceListResult { + /// Registered marketplaces + pub marketplaces: Vec, } -/// Indicates whether the local session is currently processing a turn or background continuation. +/// Per-marketplace refresh result, including marketplace name, success flag, and optional failure error. /// ///
/// @@ -6777,12 +7175,17 @@ 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 MarketplaceRefreshEntry { + /// Error message (failure only) + #[serde(skip_serializing_if = "Option::is_none")] + pub error: Option, + /// Marketplace name that was refreshed + pub name: String, + /// Whether the refresh succeeded + pub success: bool, } -/// Model identifier to use when re-tokenizing the session's existing messages. +/// Result of refreshing one or more marketplace catalogs. /// ///
/// @@ -6792,12 +7195,12 @@ 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 MarketplaceRefreshResult { + /// Per-marketplace refresh results in deterministic order. + pub results: Vec, } -/// 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. +/// Outcome of the remove attempt, including dependent-plugin info when applicable. /// ///
/// @@ -6807,16 +7210,15 @@ 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 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, } -/// Updated working directory and git context. Emitted as the new payload of `session.context_changed`. +/// MCP server allowed by policy, with server name and optional PII-free explanatory note. /// ///
/// @@ -6826,33 +7228,15 @@ 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 - #[serde(skip_serializing_if = "Option::is_none")] - pub git_root: Option, - /// 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") +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 repository_host: Option, + pub redacted_note: Option, } -/// Updated working-directory/git context to record on the session. +/// MCP server, tool name, and arguments to invoke from an MCP App view. /// ///
/// @@ -6862,12 +7246,19 @@ 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 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, } -/// 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. +/// Capability negotiation snapshot /// ///
/// @@ -6877,9 +7268,16 @@ pub struct MetadataRecordContextChangeRequest { ///
#[derive(Debug, Clone, Default, Serialize, Deserialize)] #[serde(rename_all = "camelCase")] -pub struct MetadataRecordContextChangeResult {} +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, +} -/// 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. +/// MCP server to diagnose MCP Apps wiring for. /// ///
/// @@ -6889,12 +7287,12 @@ 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 McpAppsDiagnoseRequest { + /// MCP server to probe + pub server_name: 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 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. +/// What the server returned for this session /// ///
/// @@ -6904,12 +7302,18 @@ 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 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, } -/// The repository the remote session targets. +/// Diagnostic snapshot of MCP Apps wiring for the named server. /// ///
/// @@ -6919,16 +7323,14 @@ 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 McpAppsDiagnoseResult { + /// Capability negotiation snapshot + pub capability: McpAppsDiagnoseCapability, + /// What the server returned for this session + pub server: McpAppsDiagnoseServer, } -/// Remote-session-specific metadata. Populated only when `isRemote` is true. Fields are immutable for the lifetime of the session. +/// Current host context /// ///
/// @@ -6938,21 +7340,31 @@ 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. +pub struct McpAppsHostContextDetails { + /// Display modes the host supports #[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. + pub available_display_modes: Option>, + /// Current display mode (SEP-1865) #[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. + pub display_mode: Option, + /// BCP-47 locale, e.g. 'en-US' #[serde(skip_serializing_if = "Option::is_none")] - pub task_type: Option, + 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, } -/// Active server-driven promotion for a model, including its discount and expiry. +/// Current host context advertised to MCP App guests. /// ///
/// @@ -6962,21 +7374,12 @@ pub struct MetadataSnapshotRemoteMetadata { ///
#[derive(Debug, Clone, Default, Serialize, Deserialize)] #[serde(rename_all = "camelCase")] -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. Always present: the API only surfaces a promo whose expiry parses and is in the future. Consumers should treat a past value as expired. - pub ends_at: String, - /// 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. - #[serde(skip_serializing_if = "Option::is_none")] - pub message: Option, +pub struct McpAppsHostContext { + /// Current host context + pub context: McpAppsHostContextDetails, } -/// Long context tier pricing (available for models with extended context windows) +/// MCP server to list app-callable tools for. /// ///
/// @@ -6986,35 +7389,14 @@ pub struct ModelBillingPromo { ///
#[derive(Debug, Clone, Default, Serialize, Deserialize)] #[serde(rename_all = "camelCase")] -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, +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, } -/// Token-level pricing information for this model +/// App-callable tools from the named MCP server. /// ///
/// @@ -7024,41 +7406,12 @@ pub struct ModelBillingTokenPricesLongContext { ///
#[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, - /// 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, +pub struct McpAppsListToolsResult { + /// App-callable tools from the server + pub tools: Vec>, } -/// Billing information +/// MCP server and resource URI to fetch. /// ///
/// @@ -7068,22 +7421,14 @@ pub struct ModelBillingTokenPrices { ///
#[derive(Debug, Clone, Default, Serialize, Deserialize)] #[serde(rename_all = "camelCase")] -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 time-boxed discount. - #[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, +pub struct McpAppsReadResourceRequest { + /// Name of the MCP server hosting the resource + pub server_name: String, + /// Resource URI (typically ui://...) + pub uri: String, } -/// Vision-specific limits +/// MCP Apps resource content with URI, optional MIME type, text or base64 blob, and resource metadata. /// ///
/// @@ -7093,19 +7438,24 @@ pub struct ModelBilling { ///
#[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 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, } -/// Token limits for prompts, outputs, and context window +/// Resource contents returned by the MCP server. /// ///
/// @@ -7115,25 +7465,12 @@ pub struct ModelCapabilitiesLimitsVision { ///
#[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 McpAppsReadResourceResult { + /// Resource contents returned by the server + pub contents: Vec, } -/// Feature flags indicating what the model supports +/// Host context advertised to MCP App guests /// ///
/// @@ -7143,19 +7480,31 @@ pub struct ModelCapabilitiesLimits { ///
#[derive(Debug, Clone, Default, Serialize, Deserialize)] #[serde(rename_all = "camelCase")] -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 +pub struct McpAppsSetHostContextDetails { + /// Display modes the host supports #[serde(skip_serializing_if = "Option::is_none")] - pub reasoning_effort: Option, - /// Whether this model supports vision/image input + pub available_display_modes: Option>, + /// Current display mode (SEP-1865) #[serde(skip_serializing_if = "Option::is_none")] - pub vision: Option, + 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, } -/// Model capabilities and limits +/// Host context to advertise to MCP App guests. /// ///
/// @@ -7165,16 +7514,12 @@ pub struct ModelCapabilitiesSupports { ///
#[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 - #[serde(skip_serializing_if = "Option::is_none")] - pub supports: Option, +pub struct McpAppsSetHostContextRequest { + /// Host context advertised to MCP App guests + pub context: McpAppsSetHostContextDetails, } -/// Policy state (if applicable) +/// The requestId previously passed to executeSampling that should be cancelled. /// ///
/// @@ -7184,15 +7529,12 @@ pub struct ModelCapabilities { ///
#[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 McpCancelSamplingExecutionParams { + /// The requestId previously passed to executeSampling that should be cancelled + pub request_id: RequestId, } -/// Copilot model metadata, including identifier, display name, capabilities, policy, billing, reasoning efforts, and picker categories. +/// Indicates whether an in-flight sampling execution with the given requestId was found and cancelled. /// ///
/// @@ -7202,34 +7544,12 @@ pub struct ModelPolicy { ///
#[derive(Debug, Clone, Default, Serialize, Deserialize)] #[serde(rename_all = "camelCase")] -pub struct Model { - /// Billing information - #[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) - #[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>, +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, } -/// Vision-specific limits +/// MCP server name and configuration to add to user configuration. /// ///
/// @@ -7239,25 +7559,14 @@ 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 McpConfigAddRequest { + /// MCP server configuration (stdio process or remote HTTP/SSE) + pub config: serde_json::Value, + /// Unique name for the MCP server + pub name: String, } -/// Token limits for prompts, outputs, and context window +/// MCP server names to disable for new sessions. /// ///
/// @@ -7267,25 +7576,12 @@ 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 - #[serde(skip_serializing_if = "Option::is_none")] - pub vision: Option, +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, } -/// Feature flags indicating what the model supports +/// MCP server names to enable for new sessions. /// ///
/// @@ -7295,19 +7591,12 @@ pub struct ModelCapabilitiesOverrideLimits { ///
#[derive(Debug, Clone, Default, Serialize, Deserialize)] #[serde(rename_all = "camelCase")] -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 reasoning_effort: Option, - /// Whether this model supports vision/image input - #[serde(skip_serializing_if = "Option::is_none")] - pub vision: 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, } -/// Optional capability overrides (vision, tool_calls, reasoning, etc.). +/// User-configured MCP servers, keyed by server name. /// ///
/// @@ -7317,16 +7606,12 @@ pub struct ModelCapabilitiesOverrideSupports { ///
#[derive(Debug, Clone, Default, Serialize, Deserialize)] #[serde(rename_all = "camelCase")] -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, +pub struct McpConfigList { + /// All MCP servers from user config, keyed by name + pub servers: HashMap, } -/// List of Copilot models available to the resolved user, including capabilities and billing metadata. +/// MCP server name to remove from user configuration. /// ///
/// @@ -7336,12 +7621,12 @@ pub struct ModelCapabilitiesOverride { ///
#[derive(Debug, Clone, Default, Serialize, Deserialize)] #[serde(rename_all = "camelCase")] -pub struct ModelList { - /// List of available models with full metadata - pub models: Vec, +pub struct McpConfigRemoveRequest { + /// Name of the MCP server to remove + pub name: String, } -/// Optional listing options. +/// MCP server name and replacement configuration to write to user configuration. /// ///
/// @@ -7351,13 +7636,14 @@ 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 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, } -/// Reasoning effort level to apply to the currently selected model. +/// Credential-free authentication identity used to configure GitHub MCP. /// ///
/// @@ -7367,12 +7653,13 @@ 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(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, } -/// 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. +/// Result of configuring GitHub MCP. /// ///
/// @@ -7382,12 +7669,12 @@ 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, +pub struct McpConfigureGitHubResult { + /// Whether GitHub MCP configuration changed. + pub changed: bool, } -/// Optional GitHub token used to list models for a specific user instead of the global auth context. +/// Name of the MCP server to disable for the session. /// ///
/// @@ -7397,13 +7684,12 @@ pub struct ModelSetReasoningEffortResult { ///
#[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. - #[serde(skip_serializing_if = "Option::is_none")] - pub git_hub_token: Option, +pub struct McpDisableRequest { + /// Name of the MCP server to disable + pub server_name: String, } -/// Target model identifier and optional reasoning effort, summary, capability overrides, and context tier. +/// Optional working directory used as context for MCP server discovery. /// ///
/// @@ -7413,27 +7699,13 @@ 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"` 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, - /// 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. "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, - /// Output verbosity level to request for supported models +pub struct McpDiscoverRequest { + /// Working directory used as context for discovery (e.g., plugin resolution) #[serde(skip_serializing_if = "Option::is_none")] - pub verbosity: Option, + pub working_directory: Option, } -/// The model identifier active on the session after the switch. +/// MCP servers discovered from user, workspace, plugin, and built-in sources. /// ///
/// @@ -7443,13 +7715,12 @@ 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 McpDiscoverResult { + /// MCP servers discovered from all sources + pub servers: Vec, } -/// Agent interaction mode to apply to the session. +/// Name of the MCP server to enable for the session. /// ///
/// @@ -7459,12 +7730,12 @@ 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 McpEnableRequest { + /// Name of the MCP server to enable + pub server_name: String, } -/// Azure-specific provider options. +/// 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. /// ///
/// @@ -7474,13 +7745,9 @@ pub struct ModeSetRequest { ///
#[derive(Debug, Clone, Default, Serialize, Deserialize)] #[serde(rename_all = "camelCase")] -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 api_version: Option, -} +pub struct McpExecuteSamplingRequest {} -/// A named BYOK provider connection (transport + credentials). +/// Identifiers and raw MCP CreateMessageRequest params used to run a sampling inference. /// ///
/// @@ -7490,38 +7757,18 @@ pub struct ProviderConfigAzure { ///
#[derive(Debug, Clone, Default, Serialize, Deserialize)] #[serde(rename_all = "camelCase")] -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, +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, } -/// The session's friendly name, or null when not yet set. +/// MCP server whose connection attempt failed. /// ///
/// @@ -7531,12 +7778,15 @@ pub struct NamedProviderConfig { ///
#[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 McpFailedServer { + /// The captured connection failure detail. + #[serde(skip_serializing_if = "Option::is_none")] + pub error: Option, + /// The config key of the server that failed to connect. + pub name: String, } -/// Auto-generated session summary to apply as the session's name when no user-set name exists. +/// MCP server filtered by policy, with name, reason, and optional redacted reason. /// ///
/// @@ -7546,12 +7796,38 @@ 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 McpFilteredServer { + /// Deprecated. This field is no longer populated. + #[doc(hidden)] + #[deprecated] + #[serde(skip_serializing_if = "Option::is_none")] + 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, } -/// Indicates whether the auto-generated summary was applied as the session's name. +#[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, + /// Headers-refresh response variant discriminator. + pub kind: McpHeadersHandlePendingHeadersRefreshRequestHeadersKind, +} + +#[derive(Debug, Clone, Default, Serialize, Deserialize)] +#[serde(rename_all = "camelCase")] +pub struct McpHeadersHandlePendingHeadersRefreshRequestNone { + /// Headers-refresh response variant discriminator. + pub kind: McpHeadersHandlePendingHeadersRefreshRequestNoneKind, +} + +/// MCP headers refresh request id and the host response. /// ///
/// @@ -7559,14 +7835,16 @@ pub struct NameSetAutoRequest { /// 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 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 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 friendly name to apply to the session. +/// Indicates whether the pending MCP headers refresh response was accepted. /// ///
/// @@ -7576,12 +7854,12 @@ 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 McpHeadersHandlePendingHeadersRefreshRequestResult { + /// Whether the response was accepted. False if the request was unknown, timed out, or already resolved. + pub success: bool, } -/// Source descriptor for a `session.options.update` content-exclusion rule, with source name and type. +/// Recorded MCP server connection failure. /// ///
/// @@ -7591,12 +7869,14 @@ pub struct NameSetRequest { ///
#[derive(Debug, Clone, Default, Serialize, Deserialize)] #[serde(rename_all = "camelCase")] -pub struct OptionsUpdateAdditionalContentExclusionPolicyRuleSource { - pub name: String, - pub r#type: String, +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, } -/// Single content-exclusion rule supplied to `session.options.update`, with paths, match conditions, and source. +/// Recorded MCP server pending-auth state. /// ///
/// @@ -7606,17 +7886,12 @@ pub struct OptionsUpdateAdditionalContentExclusionPolicyRuleSource { ///
#[derive(Debug, Clone, Default, Serialize, Deserialize)] #[serde(rename_all = "camelCase")] -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, +pub struct McpServerNeedsAuthInfo { + /// epoch-ms timestamp at which the server signalled it needs authentication. + pub timestamp: i64, } -/// Content-exclusion policy supplied to `session.options.update`, with rules, last-updated data, and scope. +/// Host-level state, omitted when no MCP host is initialized. /// ///
/// @@ -7626,15 +7901,24 @@ pub struct OptionsUpdateAdditionalContentExclusionPolicyRule { ///
#[derive(Debug, Clone, Default, Serialize, Deserialize)] #[serde(rename_all = "camelCase")] -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, +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, } -/// Pending permission prompt reconstructed from event history, with request ID and user-facing prompt details. +/// One change applying the plan would make, described rather than serialised so the configuration payload stays behind the runtime boundary. /// ///
/// @@ -7642,16 +7926,22 @@ pub struct OptionsUpdateAdditionalContentExclusionPolicy { /// 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 McpPlanConfigurationChange { + /// Names of the configuration fields the change would set, without their values. + pub changed_fields: Vec, + /// Configuration key the change applies to. + pub config_key: String, + /// Whether the change would create a new entry or modify an existing one. + pub operation: McpPlanConfigurationOperation, + /// Scope the change would be written to. + pub scope: McpPlanScope, + /// Secret placeholders the written configuration would reference. The constrained placeholder type cannot carry a literal secret value. + pub secret_references: Vec, } -/// List of pending permission requests reconstructed from event history. +/// Normalised identity of the MCP server a plan targets, independent of how the card spelled it. /// ///
/// @@ -7661,12 +7951,20 @@ 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 McpPlanResourceIdentity { + /// Canonical, normalised name of the server, for example `io.github.owner/server`. + pub canonical_name: String, + /// Registry identifier of the server, when it came from a registry. + #[serde(skip_serializing_if = "Option::is_none")] + pub registry_id: Option, + /// Local configuration key the server would be recorded under. + pub server_name: String, + /// Version advertised by the card, when it declares one. + #[serde(skip_serializing_if = "Option::is_none")] + pub version: Option, } -/// Permission-decision request variant to approve only the current permission request. +/// Outcome of evaluating the planned server against registry and enterprise policy. Evaluation is read-only. /// ///
/// @@ -7676,12 +7974,17 @@ 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 McpPlanPolicyResult { + /// What policy decided for this server. + pub decision: McpPlanPolicyDecision, + /// Human-readable explanation, safe to surface. Never contains a query, URL, handle, or secret. + #[serde(skip_serializing_if = "Option::is_none")] + pub reason: Option, + /// Which authority produced the decision. + pub source: McpPlanPolicySource, } -/// Session-scoped approval details for specific command identifiers. +/// Provenance of the exact validated JSON MCP card content bound privately to a completed plan and its opaque handle. /// ///
/// @@ -7691,14 +7994,18 @@ 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 McpPlanProvenance { + /// Authority associated with the validated card, without path, query, or credentials. Inert untrusted data. + pub authority: String, + /// Semantic digest of the exact validated JSON content bound to the plan handle. + pub card_digest: CardDigest, + /// JSON MCP media type the validated card was interpreted as. + pub media_type: McpServerCardMediaType, + /// ISO 8601 timestamp at which the runtime completed strict parsing and schema validation of the card content. + pub validated_at: String, } -/// Session-scoped approval details for read-only filesystem operations. +/// Where a plan would be written. /// ///
/// @@ -7708,12 +8015,14 @@ 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 McpPlanTarget { + /// Configuration key the server would be recorded under within that scope. + pub config_key: String, + /// Configuration scope the plan targets. + pub scope: McpPlanScope, } -/// Session-scoped approval details for filesystem write operations. +/// A normalised, inert description of what installing an MCP server would involve. Carries no raw card, no install specification, and no secret value. /// ///
/// @@ -7723,12 +8032,33 @@ 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 McpInstallPlan { + /// The configuration changes installing would make, described rather than serialised, so the mutable configuration payload stays behind the runtime boundary. + pub configuration_changes: Vec, + /// Normalised identity of the server the plan would install. + pub identity: McpPlanResourceIdentity, + /// Opaque, runtime-instance scoped, TTL-bound, single-use handle for this plan. Rejected when stale, replayed, or presented to a different runtime instance. Never logged. + pub plan_handle: String, + /// ISO 8601 timestamp after which the plan handle is stale and will be rejected. Abandoning a plan needs no call: an unused handle simply expires, so cancellation before commit is side-effect free. + pub plan_handle_expires_at: String, + /// Outcome of evaluating the server against registry and enterprise policy. + pub policy: McpPlanPolicyResult, + /// Origin and semantic digest of the exact validated JSON MCP card content bound to this plan. + pub provenance: McpPlanProvenance, + /// Identifier of the choice the runtime would pick by default. Omitted when there is no eligible transport, or when the runtime expresses no preference. + #[serde(skip_serializing_if = "Option::is_none")] + pub recommended_transport_choice_id: Option, + /// Whether applying this plan would require an MCP reload to take effect. Planning itself never reloads. + pub reload_required: bool, + /// Whether the plan cannot be applied without further input, because a required value has no default or a secret must be supplied. + pub requires_interactive_configuration: bool, + /// Configuration scope and key the plan would write to. + pub target: McpPlanTarget, + /// Every eligible transport, so a host can present an explicit choice. A completed plan always has at least one; when none is eligible, planning returns `CatalogUnavailableTransportError` instead. + pub transport_choices: Vec, } -/// Session-scoped approval details for an MCP server tool, or all tools on the server when `toolName` is null. +/// Server name to check running status for. /// ///
/// @@ -7738,16 +8068,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 struct McpIsServerRunningRequest { + /// Name of the MCP server to check pub server_name: String, - /// MCP tool name, or null to cover every tool on the server. - pub tool_name: Option, } -/// Session-scoped approval details for MCP sampling requests from a server. +/// Whether the named MCP server is running. /// ///
/// @@ -7757,14 +8083,12 @@ 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 McpIsServerRunningResult { + /// True if the server has an active client and transport. + pub running: bool, } -/// Session-scoped approval details for writes to long-term memory. +/// Server name whose tool list should be returned. /// ///
/// @@ -7774,12 +8098,12 @@ 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 McpListToolsRequest { + /// Name of the connected MCP server whose tools to list. + pub server_name: String, } -/// Session-scoped approval details for a custom tool, keyed by tool name. +/// Normalized MCP Apps discovery metadata from a tool's `_meta.ui` block. /// ///
/// @@ -7789,14 +8113,16 @@ 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 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 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>, } -/// Session-scoped approval details for extension-management operations, optionally narrowed by operation. +/// MCP tool metadata with tool name, optional description, and normalized MCP Apps discovery metadata. /// ///
/// @@ -7806,15 +8132,18 @@ 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 McpTools { + /// Tool description, when provided. #[serde(skip_serializing_if = "Option::is_none")] - pub operation: Option, + 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, } -/// Session-scoped approval details for an extension's permission-gated capability access, keyed by extension name. +/// Tools exposed by the connected MCP server. Throws when the server is not connected. /// ///
/// @@ -7824,14 +8153,12 @@ 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 McpListToolsResult { + /// Tools exposed by the server. + pub tools: Vec, } -/// Permission-decision request variant to approve for the rest of the session, with optional tool approval or URL domain. +/// Identifies the MCP server whose persisted OAuth credentials were updated. /// ///
/// @@ -7841,50 +8168,38 @@ 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) +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 approval: Option, - /// URL domain to approve for the rest of the session (URL prompts only) + 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 domain: Option, - /// Approve and remember for the rest of the session - pub kind: PermissionDecisionApproveForSessionKind, + pub server_name: Option, } -/// Location-scoped approval details for specific command identifiers. -/// -///
-/// -/// **Experimental.** This type is part of an experimental wire-protocol surface -/// and may change or be removed in future SDK or CLI releases. -/// -///
#[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 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, + /// OAuth response variant discriminator. + pub kind: McpOauthPendingRequestResponseTokenKind, + /// OAuth token type. Defaults to bearer when omitted. + #[serde(skip_serializing_if = "Option::is_none")] + pub token_type: Option, } -/// Location-scoped approval details for read-only filesystem operations. -/// -///
-/// -/// **Experimental.** This type is part of an experimental wire-protocol surface -/// and may change or be removed in future SDK or CLI releases. -/// -///
#[derive(Debug, Clone, Default, Serialize, Deserialize)] #[serde(rename_all = "camelCase")] -pub struct PermissionDecisionApproveForLocationApprovalRead { - /// Approval covering read-only filesystem operations. - pub kind: PermissionDecisionApproveForLocationApprovalReadKind, +pub struct McpOauthPendingRequestResponseCancelled { + /// OAuth response variant discriminator. + pub kind: McpOauthPendingRequestResponseCancelledKind, } -/// Location-scoped approval details for filesystem write operations. +/// Pending MCP OAuth request ID and host-provided token or cancellation response. /// ///
/// @@ -7892,14 +8207,16 @@ pub struct PermissionDecisionApproveForLocationApprovalRead { /// 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 PermissionDecisionApproveForLocationApprovalWrite { - /// Approval covering filesystem write operations. - pub kind: PermissionDecisionApproveForLocationApprovalWriteKind, +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, } -/// Location-scoped approval details for an MCP server tool, or all tools on the server when `toolName` is null. +/// Indicates whether the pending MCP OAuth response was accepted. /// ///
/// @@ -7909,16 +8226,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 McpOauthHandlePendingResult { + /// Whether the response was accepted. False if the request was unknown, timed out, or already resolved. + pub success: bool, } -/// Location-scoped approval details for MCP sampling requests from a server. +/// Remote MCP server name and optional overrides controlling reauthentication, OAuth client display name, callback success-page copy, and static OAuth client selection. /// ///
/// @@ -7928,14 +8241,33 @@ 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 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, } -/// Location-scoped approval details for writes to long-term memory. +/// OAuth authorization URL the caller should open, or empty when cached tokens already authenticated the server. /// ///
/// @@ -7945,12 +8277,13 @@ 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 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, } -/// Location-scoped approval details for a custom tool, keyed by tool name. +/// Remote MCP server name for a passive OAuth status probe. /// ///
/// @@ -7960,14 +8293,56 @@ 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 McpOauthProbeRequest { + /// Name of the configured remote MCP server to probe. + pub server_name: String, } -/// Location-scoped approval details for extension-management operations, optionally narrowed by operation. +#[derive(Debug, Clone, Default, Serialize, Deserialize)] +#[serde(rename_all = "camelCase")] +pub struct McpOauthProbeResultNoAuthRequired { + /// HTTP response returned by the server. + pub http_response: McpOauthHttpResponse, + /// Probe outcome variant discriminator. + pub status: McpOauthProbeResultNoAuthRequiredStatus, +} + +#[derive(Debug, Clone, Default, Serialize, Deserialize)] +#[serde(rename_all = "camelCase")] +pub struct McpOauthProbeResultAuthenticated { + /// HTTP response returned by the server. + pub http_response: McpOauthHttpResponse, + /// Probe outcome variant discriminator. + pub status: McpOauthProbeResultAuthenticatedStatus, +} + +#[derive(Debug, Clone, Default, Serialize, Deserialize)] +#[serde(rename_all = "camelCase")] +pub struct McpOauthProbeResultNeedsAuth { + /// HTTP 401 or 403 response returned by the server. + pub http_response: McpOauthHttpResponse, + /// Why authentication is needed. + pub reason: McpOauthProbeNeedsAuthReason, + /// Probe outcome variant discriminator. + pub status: McpOauthProbeResultNeedsAuthStatus, + /// Parsed WWW-Authenticate challenge parameters, when present and parseable. + #[serde(skip_serializing_if = "Option::is_none")] + pub www_authenticate_params: Option, +} + +#[derive(Debug, Clone, Default, Serialize, Deserialize)] +#[serde(rename_all = "camelCase")] +pub struct McpOauthProbeResultFailed { + /// Human-readable probe failure detail. + pub error: String, + /// HTTP response returned by the server, when the probe reached the server and captured the complete response. + #[serde(skip_serializing_if = "Option::is_none")] + pub http_response: Option, + /// Probe outcome variant discriminator. + pub status: McpOauthProbeResultFailedStatus, +} + +/// Pending MCP OAuth request id to respond to. /// ///
/// @@ -7977,15 +8352,12 @@ 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 McpOauthRespondRequest { + /// OAuth request identifier from the mcp.oauth_required event + pub request_id: RequestId, } -/// Location-scoped approval details for an extension's permission-gated capability access, keyed by extension name. +/// Indicates whether the pending MCP OAuth response was accepted. /// ///
/// @@ -7995,14 +8367,12 @@ 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 McpOauthRespondResult { + /// Whether the response was accepted. False if the request was unknown, timed out, or already resolved. + pub success: bool, } -/// Permission-decision request variant to approve and persist a permission for a project location, with approval details and location key. +/// A computed MCP install plan. Nothing has been applied: the plan describes what installing would change, and the plan handle is what a later apply operation would consume. /// ///
/// @@ -8010,18 +8380,18 @@ 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 McpPlanInstallPlanned { + /// Discriminator: a plan was computed and nothing was changed + pub kind: McpPlanInstallPlannedKind, + /// Protocol version and capabilities the runtime honoured. + pub negotiated: CatalogNegotiatedContract, + /// The normalised plan. + pub plan: McpInstallPlan, } -/// Permission-decision request variant to permanently approve a URL domain across sessions. +/// Plan from a candidate returned by a previous catalog search. /// ///
/// @@ -8031,14 +8401,16 @@ 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 McpPlanInstallSourceCandidate { + /// Single-use candidate handle. Consumed by this call, so a replay of the same handle is rejected. + pub candidate_handle: String, + /// Discriminator: plan from a previously returned candidate + pub kind: McpPlanInstallSourceCandidateKind, + /// The runtime- or authority-minted `searchId` returned with the search that produced this candidate. A search implementation binds it to private candidate-handle context; a planning implementation must verify that context before returning a plan. The unavailable planning implementation in this contract layer validates presence but does not claim the verification has occurred. It identifies a search rather than a person and must never be joined with user identity to re-identify anyone. + pub search_id: String, } -/// Permission-decision request variant to reject a pending permission request, with optional feedback. +/// An MCP server card to be retrieved from a URL through the runtime's hardened fetch boundary. /// ///
/// @@ -8048,15 +8420,16 @@ pub struct PermissionDecisionApprovePermanently { ///
#[derive(Debug, Clone, Default, Serialize, Deserialize)] #[serde(rename_all = "camelCase")] -pub struct PermissionDecisionReject { - /// Optional feedback explaining the rejection - #[serde(skip_serializing_if = "Option::is_none")] - pub feedback: Option, - /// Reject the request - pub kind: PermissionDecisionRejectKind, +pub struct McpServerCardUrl { + /// Discriminator: the card is URL-backed, and carries no embedded data + pub kind: McpServerCardUrlKind, + /// Media type the card is expected to conform to. + pub media_type: McpServerCardMediaType, + /// Card URL. Retrieved only through the runtime's hardened boundary, with scheme, credential, address-range, redirect, timeout, and response-size controls applied. Never logged. + pub url: String, } -/// Permission-decision variant indicating no user was available to confirm the request. +/// An MCP server card supplied inline as an inert document. /// ///
/// @@ -8066,12 +8439,16 @@ 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 McpServerCardEmbedded { + /// The card document verbatim, treated as inert untrusted bytes. The runtime parses and validates it; the host is not expected to interpret it. Never logged. + pub data: String, + /// Discriminator: the card is embedded, and carries no URL + pub kind: McpServerCardEmbeddedKind, + /// Media type the card is expected to conform to. + pub media_type: McpServerCardMediaType, } -/// Permission-decision variant indicating the request was approved. +/// Plan from a card supplied directly by the caller, without a preceding search. /// ///
/// @@ -8079,14 +8456,16 @@ pub struct PermissionDecisionUserNotAvailable { /// 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 PermissionDecisionApproved { - /// The permission request was approved - pub kind: PermissionDecisionApprovedKind, +pub struct McpPlanInstallSourceCard { + /// The card to plan from: exactly one of a URL or embedded data. + pub card: McpServerCardReference, + /// Discriminator: plan from a caller-supplied card + pub kind: McpPlanInstallSourceCardKind, } -/// Permission-decision variant indicating approval was remembered for the session, with approval details. +/// A side-effect-free request for an MCP install plan. Computing a plan never writes configuration, stores a secret, or reloads MCP servers. /// ///
/// @@ -8096,14 +8475,17 @@ pub struct PermissionDecisionApproved { ///
#[derive(Debug, Clone, 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 McpPlanInstallRequest { + /// Protocol version and capabilities the caller requires. + pub contract: CatalogClientContract, + /// Configuration scope the plan targets. Defaults to user scope when omitted. + #[serde(skip_serializing_if = "Option::is_none")] + pub scope: Option, + /// What to plan: either a candidate handle from a previous search, or a card supplied directly. + pub source: McpPlanInstallSource, } -/// Permission-decision variant indicating approval was persisted for a project location, with approval details and location key. +/// One non-secret scalar value a transport choice needs before it can be applied. /// ///
/// @@ -8111,18 +8493,33 @@ 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 McpPlanRequiredValueScalar { + /// Where the value is applied when the server is launched. + pub category: McpPlanValueCategory, + /// Default supplied by the card, when the value can be resolved without input. Presence is the authoritative indication that a default exists. Inert untrusted data. + #[serde(skip_serializing_if = "Option::is_none")] + pub default_value: Option, + /// Human-readable explanation from the card. Inert untrusted text. + #[serde(skip_serializing_if = "Option::is_none")] + pub description: Option, + /// Whether the value may be supplied more than once. + pub is_repeated: bool, + /// Key the value is supplied under. Inert untrusted data. + pub key: String, + /// Discriminator: this required value uses a scalar type. + pub kind: McpPlanRequiredValueScalarKind, + /// Whether the value must be present for the plan to be applicable. + pub required: bool, + /// Human-readable label from the card. Inert untrusted text. + #[serde(skip_serializing_if = "Option::is_none")] + pub title: Option, + /// Scalar type the value must conform to. + pub value_type: McpPlanScalarValueType, } -/// Permission-decision variant indicating the request was cancelled before use, with an optional reason. +/// One enumerated non-secret value a transport choice needs before it can be applied. The permitted values are structurally required. /// ///
/// @@ -8132,15 +8529,33 @@ 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 +pub struct McpPlanRequiredValueEnum { + /// Where the value is applied when the server is launched. + pub category: McpPlanValueCategory, + /// Default supplied by the card, when the value can be resolved without input. Presence is the authoritative indication that a default exists. Inert untrusted data. #[serde(skip_serializing_if = "Option::is_none")] - pub reason: Option, + pub default_value: Option, + /// Human-readable explanation from the card. Inert untrusted text. + #[serde(skip_serializing_if = "Option::is_none")] + pub description: Option, + /// Non-empty permitted value set. Inert untrusted data. + pub enum_values: Vec, + /// Whether the value may be supplied more than once. + pub is_repeated: bool, + /// Key the value is supplied under. Inert untrusted data. + pub key: String, + /// Discriminator: this required value uses a fixed enumeration. + pub kind: McpPlanRequiredValueEnumKind, + /// Whether the value must be present for the plan to be applicable. + pub required: bool, + /// Human-readable label from the card. Inert untrusted text. + #[serde(skip_serializing_if = "Option::is_none")] + pub title: Option, + /// Discriminator: the value must be one of `enumValues`. + pub value_type: McpPlanEnumValueType, } -/// Permission-decision variant indicating explicit denial by permission rules, with the matching rules. +/// A secret a transport choice needs, referenced by placeholder. No secret value ever appears in a plan, and the placeholder resolves against the keychain only when a plan is applied. /// ///
/// @@ -8150,14 +8565,17 @@ 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 McpPlanSecretPlaceholder { + /// Key the secret is supplied under. Inert untrusted data. + pub key: String, + /// The runtime-assigned `${secret:}` placeholder written into configuration in place of the value. + pub placeholder: String, + /// Human-readable label from the card. Inert untrusted text. + #[serde(skip_serializing_if = "Option::is_none")] + pub title: Option, } -/// Permission-decision variant indicating no approval rule matched and user confirmation was unavailable. +/// An eligible local-package transport choice. Package identity is required and a remote endpoint cannot be represented. /// ///
/// @@ -8167,12 +8585,24 @@ 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 McpPlanTransportChoicePackage { + /// Stable identifier for this choice within the plan, used to select it when the plan is applied. + pub choice_id: String, + /// Discriminator: this choice runs a local package + pub install_method: McpPlanPackageInstallMethod, + /// Package identifier. Inert untrusted data. + pub package_identifier: String, + /// Packaging ecosystem, for example `oci` or `npm`. + pub package_type: String, + /// Typed values this choice requires, excluding secrets. + pub required_values: Vec, + /// Secrets this choice requires, referenced by placeholder only. + pub secret_placeholders: Vec, + /// Local process transport this package choice would use. + pub transport: McpPlanPackageTransport, } -/// Permission-decision variant indicating the user denied an interactive prompt, with optional feedback and force-reject flag. +/// An eligible remote-endpoint transport choice. The endpoint is required and package identity cannot be represented. /// ///
/// @@ -8182,18 +8612,22 @@ pub struct PermissionDecisionDeniedNoApprovalRuleAndCouldNotRequestFromUser { ///
#[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 struct McpPlanTransportChoiceRemote { + /// Stable identifier for this choice within the plan, used to select it when the plan is applied. + pub choice_id: String, + /// Endpoint URL. Inert untrusted data. + pub endpoint: String, + /// Discriminator: this choice connects to a remote endpoint + pub install_method: McpPlanRemoteInstallMethod, + /// Typed values this choice requires, excluding secrets. + pub required_values: Vec, + /// Secrets this choice requires, referenced by placeholder only. + pub secret_placeholders: Vec, + /// Endpoint transport this remote choice would use. + pub transport: McpPlanRemoteTransport, } -/// Permission-decision variant indicating denial by content-exclusion policy, with path and message. +/// Registration parameters for an external MCP client. /// ///
/// @@ -8203,16 +8637,21 @@ pub struct PermissionDecisionDeniedInteractivelyByUser { ///
#[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 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, } -/// Permission-decision variant indicating denial by a permission request hook, with optional message and interrupt flag. +/// In-process MCP reload configuration. /// ///
/// @@ -8222,18 +8661,36 @@ pub struct PermissionDecisionDeniedByContentExclusionPolicy { ///
#[derive(Debug, Clone, Default, Serialize, Deserialize)] #[serde(rename_all = "camelCase")] -pub struct PermissionDecisionDeniedByPermissionRequestHook { - /// Whether to interrupt the current agent turn +pub(crate) struct McpReloadConfig { #[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 active_git_hub_token: Option, + /// Server names the CLI enabled for this session via `--enable-mcp-server`. #[serde(skip_serializing_if = "Option::is_none")] - pub message: Option, + pub cli_enabled_servers: Option>, + #[serde(skip_serializing_if = "Option::is_none")] + pub config_filter: Option, + #[serde(skip_serializing_if = "Option::is_none")] + pub disabled_servers: Option>, + #[serde(skip_serializing_if = "Option::is_none")] + pub enabled_servers: Option>, + #[serde(skip_serializing_if = "Option::is_none")] + pub force_restart: Option, + #[serde(skip_serializing_if = "Option::is_none")] + pub github_mcp_tool_options: Option, + #[serde(skip_serializing_if = "Option::is_none")] + pub github_mcp_user_override: Option, + #[serde(skip_serializing_if = "Option::is_none")] + pub include_workspace_sources: Option, + #[serde(skip_serializing_if = "Option::is_none")] + pub mcp3p_enabled: Option, + pub mcp_servers: HashMap, + #[serde(skip_serializing_if = "Option::is_none")] + pub secret_store: Option, + #[serde(skip_serializing_if = "Option::is_none")] + pub use_cached_tool_snapshots: Option, } -/// Pending permission request ID and the decision to apply (approve/reject and scope). +/// Opaque MCP reload configuration. /// ///
/// @@ -8241,16 +8698,15 @@ 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(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, } -/// Location-persisted tool approval details for specific command identifiers. +/// Indicates whether the auto-managed `github` MCP server was removed (false when nothing to remove). /// ///
/// @@ -8260,14 +8716,12 @@ 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 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, } -/// Location-persisted tool approval details for read-only filesystem operations. +/// Standard MCP resource annotations plus preserved non-standard annotation fields. /// ///
/// @@ -8277,12 +8731,22 @@ 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 McpResourceAnnotations { + /// Server-provided non-standard annotation fields preserved from the MCP response + #[serde(skip_serializing_if = "Option::is_none")] + pub additional_properties: Option>, + /// Intended audience roles for this resource + #[serde(skip_serializing_if = "Option::is_none")] + pub audience: Option>, + /// Last-modified timestamp hint + #[serde(skip_serializing_if = "Option::is_none")] + pub last_modified: Option, + /// Priority hint for model/client use + #[serde(skip_serializing_if = "Option::is_none")] + pub priority: Option, } -/// Location-persisted tool approval details for filesystem write operations. +/// A resource icon descriptor plus preserved non-standard icon fields. /// ///
/// @@ -8292,12 +8756,24 @@ 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 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, } -/// Location-persisted tool approval details for an MCP server tool, or all tools when `toolName` is null. +/// 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`. /// ///
/// @@ -8307,16 +8783,38 @@ 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 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 additional_properties: Option>, + /// Model/client annotations associated with this resource + #[serde(skip_serializing_if = "Option::is_none")] + pub annotations: Option, + /// Optional description of what this resource represents + #[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, if known + #[serde(skip_serializing_if = "Option::is_none")] + 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 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, } -/// Location-persisted tool approval details for MCP sampling requests from a server. +/// MCP resource content with URI, optional MIME type, text or base64 blob, and resource metadata. /// ///
/// @@ -8326,14 +8824,24 @@ 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 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, } -/// Location-persisted tool approval details for writes to long-term memory. +/// MCP server whose resources to enumerate. /// ///
/// @@ -8343,12 +8851,15 @@ 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 McpResourcesListRequest { + /// 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 resources to enumerate + pub server_name: String, } -/// Location-persisted tool approval details for a custom tool, keyed by tool name. +/// One page of resources advertised by the named MCP server. /// ///
/// @@ -8358,14 +8869,15 @@ 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 McpResourcesListResult { + /// 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, } -/// Location-persisted tool approval details for extension-management operations, optionally narrowed by operation. +/// MCP server whose resource templates to enumerate. /// ///
/// @@ -8375,15 +8887,15 @@ 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 McpResourcesListTemplatesRequest { + /// Opaque MCP pagination cursor from a prior `nextCursor` value #[serde(skip_serializing_if = "Option::is_none")] - pub operation: Option, + pub cursor: Option, + /// Name of the MCP server whose resource templates to enumerate + pub server_name: String, } -/// Location-persisted tool approval details for an extension's permission-gated capability access, keyed by extension name. +/// 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`. /// ///
/// @@ -8393,14 +8905,35 @@ 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 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, } -/// Location-scoped tool approval to persist. +/// One page of resource templates advertised by the named MCP server. /// ///
/// @@ -8408,16 +8941,17 @@ 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 McpResourcesListTemplatesResult { + /// 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, } -/// Working directory to load persisted location permissions for. +/// MCP server and resource URI to fetch. /// ///
/// @@ -8427,12 +8961,14 @@ 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 McpResourcesReadRequest { + /// Name of the MCP server hosting the resource + pub server_name: String, + /// Resource URI + pub uri: String, } -/// Summary of persisted location permissions applied to the session. +/// Resource contents returned by the MCP server. /// ///
/// @@ -8442,22 +8978,12 @@ 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 McpResourcesReadResult { + /// Resource contents returned by the server + pub contents: Vec, } -/// Working directory to resolve into a location-permissions key. +/// 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. /// ///
/// @@ -8467,13 +8993,16 @@ 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, -} - -/// Resolved location-permissions key and type. -/// +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, +} + +/// Per-field MCP telemetry-obfuscation policy. +/// ///
/// /// **Experimental.** This type is part of an experimental wire-protocol surface @@ -8482,14 +9011,14 @@ 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 McpSafeForTelemetryFields { + /// Whether MCP tool input names may be included in telemetry without obfuscation. + pub inputs_names: bool, + /// Whether the MCP tool name may be included in telemetry without obfuscation. + pub name: bool, } -/// Directory path to add to the session's allowed directories. +/// Outcome of an MCP sampling execution: success result, failure error, or cancellation. /// ///
/// @@ -8499,12 +9028,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 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, } -/// Path to evaluate against the session's allowed directories. +/// MCP server status entry, including config source/plugin source and any connection error. /// ///
/// @@ -8514,12 +9049,26 @@ 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 McpServer { + /// Error message if the server failed to connect + #[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, + /// 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, } -/// Indicates whether the supplied path is within the session's allowed directories. +/// Authentication settings with optional redirect port configuration. /// ///
/// @@ -8529,12 +9078,13 @@ 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 McpServerAuthConfigRedirectPort { + /// Fixed port for the OAuth redirect callback server. + #[serde(skip_serializing_if = "Option::is_none")] + pub redirect_port: 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. +/// Remote MCP server configuration accessed over HTTP or SSE. /// ///
/// @@ -8544,22 +9094,90 @@ 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 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 additional_directories: Option>, - /// Whether to include the system temp directory in the allowed list (defaults to true). Ignored when `unrestricted` is true. + pub auth: Option, + /// Configuration warnings recorded while loading the server. #[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 config_warnings: 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 unrestricted: Option, - /// Workspace root path (special-cased to be allowed even before the directory exists). Ignored when `unrestricted` is true. + pub defer_tools: Option, + /// Whether secret masking is disabled for calls to this server. #[serde(skip_serializing_if = "Option::is_none")] - pub workspace_path: Option, + pub disable_secret_masking: 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, + /// Optional human-readable server name. + #[serde(skip_serializing_if = "Option::is_none")] + pub display_name: Option, + /// Event types this server receives as Copilot notifications. + #[serde(skip_serializing_if = "Option::is_none")] + pub events: Option>, + /// Tool names excluded after the include filter is applied. + #[serde(skip_serializing_if = "Option::is_none")] + pub exclude_tools: 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>, + /// Dynamic-header refresh cache lifetime in milliseconds. + #[serde(skip_serializing_if = "Option::is_none")] + pub headers_refresh_ttl_ms: 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, + /// Copilot notification types this server may send to the host. + #[serde(skip_serializing_if = "Option::is_none")] + pub notifications: 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, + /// Telemetry-obfuscation policy for this server's tools. + #[serde(skip_serializing_if = "Option::is_none")] + pub safe_for_telemetry: Option, + /// The origin of this server configuration. + #[serde(skip_serializing_if = "Option::is_none")] + pub source: Option, + /// Source file path recorded while loading the config. + #[serde(skip_serializing_if = "Option::is_none")] + pub source_path: Option, + /// Plugin that provided this server. + #[serde(skip_serializing_if = "Option::is_none")] + pub source_plugin: Option, + /// Whether the providing plugin uses the Open Plugin Spec. + #[serde(skip_serializing_if = "Option::is_none")] + pub source_plugin_spec: Option, + /// Version of the plugin that provided this server. + #[serde(skip_serializing_if = "Option::is_none")] + pub source_plugin_version: Option, + /// Timeout in milliseconds for tool discovery and tool calls. + #[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, } -/// Snapshot of the session's allow-listed directories and primary working directory. +/// In-process MCP server configuration used by embedded SDK clients. /// ///
/// @@ -8569,14 +9187,72 @@ 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(crate) struct McpServerConfigMemory { + /// Configuration warnings recorded while loading the server. + #[serde(skip_serializing_if = "Option::is_none")] + pub config_warnings: Option>, + /// Controls whether tools can be loaded on demand. + #[serde(skip_serializing_if = "Option::is_none")] + pub defer_tools: Option, + /// Whether secret masking is disabled for calls to this server. + #[serde(skip_serializing_if = "Option::is_none")] + pub disable_secret_masking: Option, + /// Whether persisted tool snapshots are disabled. + #[serde(skip_serializing_if = "Option::is_none")] + pub disable_tool_cache: Option, + /// Optional human-readable server name. + #[serde(skip_serializing_if = "Option::is_none")] + pub display_name: Option, + /// Event types this server receives as Copilot notifications. + #[serde(skip_serializing_if = "Option::is_none")] + pub events: Option>, + /// Tool names excluded after the include filter is applied. + #[serde(skip_serializing_if = "Option::is_none")] + pub exclude_tools: Option>, + /// Content filtering mode to apply to this server's tools. + #[serde(skip_serializing_if = "Option::is_none")] + pub filter_mapping: Option, + /// Whether this server is a built-in fallback. + #[serde(skip_serializing_if = "Option::is_none")] + pub is_default_server: Option, + /// Copilot notification types this server may send to the host. + #[serde(skip_serializing_if = "Option::is_none")] + pub notifications: Option>, + /// Set to `true` to use default OIDC settings. + #[serde(skip_serializing_if = "Option::is_none")] + pub oidc: Option, + /// Telemetry-obfuscation policy for this server's tools. + #[serde(skip_serializing_if = "Option::is_none")] + pub safe_for_telemetry: Option, + /// In-process MCP server instance. This value cannot cross a JSON-RPC boundary. + #[doc(hidden)] + pub(crate) server_instance: serde_json::Value, + /// The origin of this server configuration. + #[serde(skip_serializing_if = "Option::is_none")] + pub source: Option, + /// Source file path recorded while loading the config. + #[serde(skip_serializing_if = "Option::is_none")] + pub source_path: Option, + /// Plugin that provided this server. + #[serde(skip_serializing_if = "Option::is_none")] + pub source_plugin: Option, + /// Whether the providing plugin uses the Open Plugin Spec. + #[serde(skip_serializing_if = "Option::is_none")] + pub source_plugin_spec: Option, + /// Version of the plugin that provided this server. + #[serde(skip_serializing_if = "Option::is_none")] + pub source_plugin_version: Option, + /// Timeout in milliseconds for tool discovery and tool calls. + #[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>, + #[doc(hidden)] + pub(crate) r#type: McpServerConfigMemoryType, } -/// Directory path to set as the session's new primary working directory. +/// Stdio MCP server configuration launched as a child process. /// ///
/// @@ -8586,12 +9262,84 @@ 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 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, + /// Configuration warnings recorded while loading the server. + #[serde(skip_serializing_if = "Option::is_none")] + pub config_warnings: Option>, + /// 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, + /// Whether secret masking is disabled for calls to this server. + #[serde(skip_serializing_if = "Option::is_none")] + pub disable_secret_masking: 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, + /// Optional human-readable server name. + #[serde(skip_serializing_if = "Option::is_none")] + pub display_name: Option, + /// Environment variables to pass to the Stdio MCP server process. + #[serde(skip_serializing_if = "Option::is_none")] + pub env: Option>, + /// Event types this server receives as Copilot notifications. + #[serde(skip_serializing_if = "Option::is_none")] + pub events: Option>, + /// Tool names excluded after the include filter is applied. + #[serde(skip_serializing_if = "Option::is_none")] + pub exclude_tools: 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, + /// Copilot notification types this server may send to the host. + #[serde(skip_serializing_if = "Option::is_none")] + pub notifications: 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, + /// Telemetry-obfuscation policy for this server's tools. + #[serde(skip_serializing_if = "Option::is_none")] + pub safe_for_telemetry: Option, + /// The origin of this server configuration. + #[serde(skip_serializing_if = "Option::is_none")] + pub source: Option, + /// Source file path recorded while loading the config. + #[serde(skip_serializing_if = "Option::is_none")] + pub source_path: Option, + /// Plugin that provided this server. + #[serde(skip_serializing_if = "Option::is_none")] + pub source_plugin: Option, + /// Whether the providing plugin uses the Open Plugin Spec. + #[serde(skip_serializing_if = "Option::is_none")] + pub source_plugin_spec: Option, + /// Version of the plugin that provided this server. + #[serde(skip_serializing_if = "Option::is_none")] + pub source_plugin_version: Option, + /// Timeout in milliseconds for tool discovery and tool calls. + #[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>, + /// Local transport type. Defaults to stdio when omitted. + #[serde(skip_serializing_if = "Option::is_none")] + pub r#type: Option, } -/// Path to evaluate against the session's workspace (primary) directory. +/// MCP servers configured for the session, with their connection status and host-level state. /// ///
/// @@ -8601,12 +9349,15 @@ 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 McpServerList { + /// 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, } -/// Indicates whether the supplied path is within the session's workspace directory. +/// Mode controlling how MCP server env values are resolved (`direct` or `indirect`). /// ///
/// @@ -8616,12 +9367,12 @@ 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 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, } -/// Notification payload describing the permission prompt that the client just rendered. +/// Env-value mode recorded on the session after the update. /// ///
/// @@ -8631,12 +9382,12 @@ 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 McpSetEnvValueModeResult { + /// Mode recorded on the session after the update + pub mode: McpSetEnvValueModeDetails, } -/// Indicates whether the permission decision was applied; false when the request was already resolved. +/// 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. /// ///
/// @@ -8646,12 +9397,15 @@ 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 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, } -/// If specified, replaces the session's approved/denied permission rules. Omit to leave the current rules unchanged. +/// MCP server startup filtering result. /// ///
/// @@ -8661,14 +9415,18 @@ 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 McpStartServersResult { + /// Non-default servers allowed by policy + #[serde(skip_serializing_if = "Option::is_none")] + pub allowed_servers: Option>, + /// Servers whose connection attempt failed. + #[serde(skip_serializing_if = "Option::is_none")] + pub failed_servers: Option>, + /// Servers filtered out before startup + pub filtered_servers: Vec, +} -/// Source descriptor for a `session.permissions.configure` content-exclusion rule, with source name and type. +/// Server name for an individual MCP server stop. /// ///
/// @@ -8678,12 +9436,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 McpStopServerRequest { + /// Name of the MCP server to stop + pub server_name: String, } -/// Single content-exclusion rule supplied to `session.permissions.configure`, with paths, match conditions, and source. +/// Metadata controlling an MCP task's lifetime. /// ///
/// @@ -8693,17 +9451,13 @@ pub struct PermissionsConfigureAdditionalContentExclusionPolicyRuleSource { ///
#[derive(Debug, Clone, Default, Serialize, Deserialize)] #[serde(rename_all = "camelCase")] -pub struct PermissionsConfigureAdditionalContentExclusionPolicyRule { - #[serde(skip_serializing_if = "Option::is_none")] - pub if_any_match: Option>, +pub struct McpTaskMetadata { + /// Task time-to-live. #[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, + pub ttl: Option, } -/// Content-exclusion policy supplied to `session.permissions.configure`, with rules, last-updated data, and scope. +/// Server name identifying the external client to remove. /// ///
/// @@ -8713,15 +9467,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(crate) struct McpUnregisterExternalClientRequest { + /// Server name of the external client to unregister + pub server_name: String, } -/// 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. +/// Memory configuration for this session. /// ///
/// @@ -8731,16 +9482,85 @@ 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 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 initial_allowed: Option>, - /// If true, the runtime allows access to all URLs without prompting. Initial allow-list is ignored when this is true. + 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 unrestricted: Option, + pub parent_id: Option, + /// Token count currently in context attributable to this entry. + pub tokens: i64, } -/// Patch of permission policy fields to apply (omit a field to leave it unchanged). +/// 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. /// ///
/// @@ -8750,29 +9570,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 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, } -/// Indicates whether the operation succeeded. +/// Parameters for the heaviest-messages query. /// ///
/// @@ -8782,12 +9585,13 @@ 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 MetadataContextHeaviestMessagesRequest { + /// Maximum number of messages to return, most-expensive first. Omit for the server default. + #[serde(skip_serializing_if = "Option::is_none")] + pub limit: Option, } -/// Indicates whether the operation succeeded. +/// The heaviest individual messages in the session's context window, most-expensive first. /// ///
/// @@ -8797,12 +9601,14 @@ 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 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, } -/// No parameters. +/// Model identifier and token limits used to compute the context-info breakdown. /// ///
/// @@ -8812,9 +9618,43 @@ pub struct PermissionsFolderTrustAddTrustedResult { ///
#[derive(Debug, Clone, Default, Serialize, Deserialize)] #[serde(rename_all = "camelCase")] -pub struct PermissionsGetAllowAllRequest {} +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, +} -/// Indicates whether the operation succeeded. +/// 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, +} + +/// Token breakdown for the session's current context window, or null if uninitialized. /// ///
/// @@ -8824,12 +9664,12 @@ 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 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, } -/// Scope and add/remove instructions for modifying session- or location-scoped permission rules. +/// Indicates whether the local session is currently processing a turn or background continuation. /// ///
/// @@ -8839,21 +9679,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 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, } -/// Indicates whether the operation succeeded. +/// Model identifier to use when re-tokenizing the session's existing messages. /// ///
/// @@ -8863,12 +9694,12 @@ 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 MetadataRecomputeContextTokensRequest { + /// Model identifier used for tokenization. The runtime token-counts both chat-context and system-context messages against this model. + pub model_id: String, } -/// Indicates whether the operation 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. /// ///
/// @@ -8878,12 +9709,16 @@ 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 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, } -/// Indicates whether the operation succeeded. +/// Updated working directory and git context. Emitted as the new payload of `session.context_changed`. /// ///
/// @@ -8893,12 +9728,33 @@ 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 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 + #[serde(skip_serializing_if = "Option::is_none")] + pub git_root: Option, + /// 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, } -/// No parameters; returns the session's allow-listed directories. +/// Updated working-directory/git context to record on the session. /// ///
/// @@ -8908,9 +9764,12 @@ pub struct PermissionsPathsAddResult { ///
#[derive(Debug, Clone, Default, Serialize, Deserialize)] #[serde(rename_all = "camelCase")] -pub struct PermissionsPathsListRequest {} +pub struct MetadataRecordContextChangeRequest { + /// Updated working directory and git context. Emitted as the new payload of `session.context_changed`. + pub context: SessionWorkingDirectoryContext, +} -/// Indicates whether the operation succeeded. +/// 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. /// ///
/// @@ -8920,12 +9779,9 @@ 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 MetadataRecordContextChangeResult {} -/// No parameters; returns currently-pending permission requests for the session. +/// 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. /// ///
/// @@ -8935,9 +9791,12 @@ pub struct PermissionsPathsUpdatePrimaryResult { ///
#[derive(Debug, Clone, Default, Serialize, Deserialize)] #[serde(rename_all = "camelCase")] -pub struct PermissionsPendingRequestsRequest {} +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, +} -/// No parameters; clears all session-scoped tool permission approvals. +/// 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. /// ///
/// @@ -8947,9 +9806,12 @@ pub struct PermissionsPendingRequestsRequest {} ///
#[derive(Debug, Clone, Default, Serialize, Deserialize)] #[serde(rename_all = "camelCase")] -pub struct PermissionsResetSessionApprovalsRequest {} +pub struct MetadataSetWorkingDirectoryResult { + /// Working directory after the update + pub working_directory: String, +} -/// Indicates whether the operation succeeded. +/// The repository the remote session targets. /// ///
/// @@ -8959,12 +9821,16 @@ 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 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, } -/// Allow-all mode to apply for the session. +/// Remote-session-specific metadata. Populated only when `isRemote` is true. Fields are immutable for the lifetime of the session. /// ///
/// @@ -8974,22 +9840,21 @@ pub struct PermissionsResetSessionApprovalsResult { ///
#[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 enabled: Option, - /// Allow-all mode to apply. `on` enables full allow-all; `auto` enables advisory LLM auto-approval; `off` disables both. +pub struct MetadataSnapshotRemoteMetadata { + /// The pull request number the remote session is associated with, if any. #[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's active model is used. + 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 model: Option, - /// Optional source for allow-all telemetry. Defaults to `rpc` when omitted for SDK callers. + 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 source: Option, + pub task_type: Option, } -/// Allow-all toggle for tool permission requests, with an optional telemetry source. +/// Active server-driven promotion for a model, including its discount and optional expiry. /// ///
/// @@ -8999,15 +9864,22 @@ 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 ModelBillingPromo { + /// Percentage discount (0-100) applied while the promotion is active. May be fractional. #[serde(skip_serializing_if = "Option::is_none")] - pub source: Option, + 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, } -/// Indicates whether the operation succeeded. +/// Long context tier pricing (available for models with extended context windows) /// ///
/// @@ -9017,12 +9889,38 @@ 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 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 1-hour cache-write (cache creation) tokens. + #[serde(skip_serializing_if = "Option::is_none")] + pub cache_write1h_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, } -/// Toggles whether permission prompts should be bridged into session events for this client. +/// Token-level pricing information for this model /// ///
/// @@ -9032,12 +9930,44 @@ 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 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 1-hour cache-write (cache creation) tokens. + #[serde(skip_serializing_if = "Option::is_none")] + pub cache_write1h_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, } -/// Indicates whether the operation succeeded. +/// Billing information /// ///
/// @@ -9047,12 +9977,22 @@ 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 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, } -/// Indicates whether the operation succeeded. +/// Vision-specific limits /// ///
/// @@ -9062,12 +10002,19 @@ 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 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, } -/// Whether the URL-permission policy should run in unrestricted mode. +/// Token limits for prompts, outputs, and context window /// ///
/// @@ -9077,12 +10024,25 @@ 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, +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, } -/// Optional message to echo back to the caller. +/// Feature flags indicating what the model supports /// ///
/// @@ -9092,13 +10052,19 @@ pub struct PermissionUrlsSetUnrestrictedModeParams { ///
#[derive(Debug, Clone, Default, Serialize, Deserialize)] #[serde(rename_all = "camelCase")] -pub struct PingRequest { - /// Optional message to echo back +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 message: Option, + pub reasoning_effort: Option, + /// Whether this model supports vision/image input + #[serde(skip_serializing_if = "Option::is_none")] + pub vision: Option, } -/// Server liveness response, including the echoed message, current server timestamp, and protocol version. +/// Model capabilities and limits /// ///
/// @@ -9108,16 +10074,16 @@ pub struct PingRequest { ///
#[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 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, } -/// Existence, contents, and resolved path of the session plan file. +/// A service-published message about a model, carrying a stable machine-readable code alongside human-readable text. /// ///
/// @@ -9127,16 +10093,14 @@ 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 ModelMessage { + /// Stable machine-readable identifier for the message, such as `client_version_deprecated`. Hosts can key custom presentation off this; unrecognized codes should fall back to displaying `message`. + pub code: String, + /// Human-readable message text intended for display to the user. + pub message: String, } -/// 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. +/// Policy state (if applicable) /// ///
/// @@ -9146,22 +10110,15 @@ pub struct PlanReadResult { ///
#[derive(Debug, Clone, Default, Serialize, Deserialize)] #[serde(rename_all = "camelCase")] -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. +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 title: Option, + pub terms: Option, } -/// Todo rows read from the session SQL database. Empty when no session database is available. +/// Service-published warning text that hosts should display when presenting a model. /// ///
/// @@ -9171,12 +10128,13 @@ pub struct PlanSqlTodosRow { ///
#[derive(Debug, Clone, Default, Serialize, Deserialize)] #[serde(rename_all = "camelCase")] -pub struct PlanReadSqlTodosResult { - /// Rows from the session SQL todos table, ordered by creation time and id. - pub rows: Vec, +pub struct ModelWarningText { + /// Data-retention warning for the model. The text may contain Markdown links and should be rendered as Markdown when supported. + #[serde(skip_serializing_if = "Option::is_none")] + pub data_retention: Option, } -/// A single dependency edge read from the session SQL `todo_deps` table, indicating that one todo must complete before another. +/// Copilot model metadata, including identifier, display name, capabilities, policy, billing, reasoning efforts, and picker categories. /// ///
/// @@ -9186,31 +10144,46 @@ pub struct PlanReadSqlTodosResult { ///
#[derive(Debug, Clone, Default, Serialize, Deserialize)] #[serde(rename_all = "camelCase")] -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 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, +pub struct Model { + /// Billing information + #[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, + /// Informational notices the service published for this model, such as an upcoming change or a recommended alternative. Present only when the service published at least one notice. Hosts should surface these without implying anything is wrong with the model. + #[serde(skip_serializing_if = "Option::is_none")] + pub info_messages: Option>, + /// 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, + /// Context-window tiers this model offers, when the provider advertises them independently of tiered token pricing. Copilot models carry their tiers in `billing.tokenPrices`; a provider that has no pricing to publish (an agent host reached over AHP, for example) declares them here instead, so the model picker can still offer the tier toggle. + #[serde(skip_serializing_if = "Option::is_none")] + pub supported_context_tiers: Option>, + /// Supported reasoning effort levels (only present if model supports reasoning effort) + #[serde(skip_serializing_if = "Option::is_none")] + pub supported_reasoning_efforts: Option>, + /// Warnings the service published for this model, such as a deprecated client version. Present only when the service published at least one warning. The model remains usable; hosts should surface these as advisory rather than blocking. + #[serde(skip_serializing_if = "Option::is_none")] + pub warning_messages: Option>, + /// Warning text the service requires hosts to surface for this model. Present only when the service published at least one warning. + #[serde(skip_serializing_if = "Option::is_none")] + pub warning_text: Option, } -/// Replacement contents to write to the session plan file. +/// Managed, repository, and CLI model overrides to overlay onto the session at startup. /// ///
/// @@ -9220,12 +10193,31 @@ pub struct PlanReadSqlTodosWithDependenciesResult { ///
#[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 ModelApplyStartupOverlayRequest { + /// Model explicitly selected by the CLI, when provided. + #[serde(skip_serializing_if = "Option::is_none")] + pub cli_model: Option, + /// Whether the overlay is being applied while resuming a deferred session. + #[serde(skip_serializing_if = "Option::is_none")] + pub deferred_resume: Option, + /// Model required by device-managed policy, when configured. + #[serde(skip_serializing_if = "Option::is_none")] + pub device_managed_model: Option, + /// Context tier selected by repository settings, when configured. + #[serde(skip_serializing_if = "Option::is_none")] + pub repo_context_tier: Option, + /// Model selected by repository settings, when configured. + #[serde(skip_serializing_if = "Option::is_none")] + pub repo_model: Option, + /// Reasoning effort selected by repository settings, when configured. + #[serde(skip_serializing_if = "Option::is_none")] + pub repo_reasoning_effort: Option, + /// Model required by server-managed policy, when configured. + #[serde(skip_serializing_if = "Option::is_none")] + pub server_managed_model: Option, } -/// Session plugin metadata, with name, marketplace, optional version, and enabled state. +/// Vision-specific limits /// ///
/// @@ -9235,19 +10227,25 @@ 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 name: String, - /// Installed version - #[serde(skip_serializing_if = "Option::is_none")] - pub version: 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>, } -/// Result of installing a plugin. +/// Token limits for prompts, outputs, and context window /// ///
/// @@ -9257,20 +10255,25 @@ pub struct Plugin { ///
#[derive(Debug, Clone, Default, Serialize, Deserialize)] #[serde(rename_all = "camelCase")] -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) +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 post_install_message: Option, - /// Number of skills discovered and installed from the plugin - pub skills_installed: i64, + pub vision: Option, } -/// Plugins installed for the session, with their enabled state and version metadata. +/// Feature flags indicating what the model supports /// ///
/// @@ -9280,12 +10283,19 @@ pub struct PluginInstallResult { ///
#[derive(Debug, Clone, Default, Serialize, Deserialize)] #[serde(rename_all = "camelCase")] -pub struct PluginList { - /// Installed plugins - pub plugins: Vec, +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 reasoning_effort: Option, + /// Whether this model supports vision/image input + #[serde(skip_serializing_if = "Option::is_none")] + pub vision: Option, } -/// Plugins installed in user/global state. +/// Optional capability overrides (vision, tool_calls, reasoning, etc.). /// ///
/// @@ -9295,12 +10305,16 @@ pub struct PluginList { ///
#[derive(Debug, Clone, Default, Serialize, Deserialize)] #[serde(rename_all = "camelCase")] -pub struct PluginListResult { - /// Installed plugins - pub plugins: Vec, +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, } -/// Plugin names (or specs) to disable. +/// List of Copilot models available to the resolved user, including capabilities and billing metadata. /// ///
/// @@ -9310,12 +10324,12 @@ pub struct PluginListResult { ///
#[derive(Debug, Clone, Default, Serialize, Deserialize)] #[serde(rename_all = "camelCase")] -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, +pub struct ModelList { + /// List of available models with full metadata + pub models: Vec, } -/// Plugin names (or specs) to enable. +/// Optional listing options. /// ///
/// @@ -9325,12 +10339,13 @@ pub struct PluginsDisableRequest { ///
#[derive(Debug, Clone, Default, Serialize, Deserialize)] #[serde(rename_all = "camelCase")] -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, +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, } -/// Plugin source and optional working directory for relative-path resolution. +/// Filesystem and environment context used to resolve model-picker settings. /// ///
/// @@ -9340,15 +10355,16 @@ pub struct PluginsEnableRequest { ///
#[derive(Debug, Clone, Default, Serialize, Deserialize)] #[serde(rename_all = "camelCase")] -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. +pub struct ModelPickerSettingsContext { + /// Optional Copilot configuration directory containing persisted settings. #[serde(skip_serializing_if = "Option::is_none")] - pub working_directory: Option, + pub config_dir: Option, + /// Environment variables consulted while resolving model-picker settings. + pub environment: serde_json::Value, + /// User home directory used when resolving persisted settings. + pub home_directory: String, } -/// Marketplace source and optional working directory for relative-path resolution. /// ///
/// @@ -9358,15 +10374,18 @@ pub struct PluginsInstallRequest { ///
#[derive(Debug, Clone, Default, Serialize, Deserialize)] #[serde(rename_all = "camelCase")] -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. +pub struct ModelPickerPersistenceRequest { + /// Whether context tier was explicitly selected and should be persisted. #[serde(skip_serializing_if = "Option::is_none")] - pub working_directory: Option, + pub context_tier_explicit: Option, + /// Whether reasoning effort was explicitly selected and should be persisted. + #[serde(skip_serializing_if = "Option::is_none")] + pub reasoning_effort_explicit: Option, + /// Filesystem and environment context used to resolve settings persistence. + pub settings_context: ModelPickerSettingsContext, } -/// Name of the marketplace whose plugin catalog to fetch. +/// Reasoning effort level to apply to the currently selected model. /// ///
/// @@ -9376,12 +10395,12 @@ pub struct PluginsMarketplacesAddRequest { ///
#[derive(Debug, Clone, Default, Serialize, Deserialize)] #[serde(rename_all = "camelCase")] -pub struct PluginsMarketplacesBrowseRequest { - /// Marketplace name to browse - pub name: String, +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, } -/// Optional marketplace name; omit to refresh all. +/// 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. /// ///
/// @@ -9391,13 +10410,12 @@ pub struct PluginsMarketplacesBrowseRequest { ///
#[derive(Debug, Clone, Default, Serialize, Deserialize)] #[serde(rename_all = "camelCase")] -pub struct PluginsMarketplacesRefreshRequest { - /// Marketplace name to refresh. When omitted, every registered marketplace is refreshed. - #[serde(skip_serializing_if = "Option::is_none")] - pub name: Option, +pub struct ModelSetReasoningEffortResult { + /// Reasoning effort level recorded on the session after the update + pub reasoning_effort: String, } -/// Name of the marketplace to remove and an optional force flag. +/// Optional opaque account selection or compatibility GitHub token used to list models. /// ///
/// @@ -9407,15 +10425,15 @@ pub struct PluginsMarketplacesRefreshRequest { ///
#[derive(Debug, Clone, Default, Serialize, Deserialize)] #[serde(rename_all = "camelCase")] -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. +pub struct ModelsListRequest { + /// GitHub token accepted for compatibility with existing SDK clients. When provided, resolves this token instead of using the current account. #[serde(skip_serializing_if = "Option::is_none")] - pub force: Option, - /// Marketplace name to remove - pub name: String, + pub git_hub_token: Option, + /// Opaque account identifier returned by `account.getAllUsers`. When omitted, the current account is used. + #[serde(skip_serializing_if = "Option::is_none")] + pub selection_id: Option, } -/// Optional flags controlling which side effects the reload performs. /// ///
/// @@ -9425,25 +10443,16 @@ pub struct PluginsMarketplacesRemoveRequest { ///
#[derive(Debug, Clone, Default, Serialize, Deserialize)] #[serde(rename_all = "camelCase")] -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, +pub struct ModelSwitchConfirmation { + /// Current conversation token count before switching models. + pub current_tokens: f64, + /// Target model token limit used by the compaction preflight. + pub target_limit: f64, + /// Display name of the model that requires compaction confirmation. + pub target_model_display_name: String, } -/// Name (or spec) of the plugin to uninstall. +/// Target model identifier and optional reasoning effort, summary, capability overrides, and context tier. /// ///
/// @@ -9453,15 +10462,51 @@ pub struct PluginsReloadRequest { ///
#[derive(Debug, Clone, Default, Serialize, Deserialize)] #[serde(rename_all = "camelCase")] -pub struct PluginsUninstallRequest { - /// Stable source identity for a direct (non-marketplace) install. Disambiguates uninstall when multiple installed plugins share the same name. +pub struct ModelSwitchToRequest { + /// Explicit response to a model-switch compaction preflight. Omit to request a confirmation projection when compaction is necessary. #[serde(skip_serializing_if = "Option::is_none")] - pub direct_source_id: Option, - /// Plugin name or "plugin@marketplace" spec to uninstall. When ambiguous, prefer the fully-qualified spec. - pub name: String, + pub compaction_decision: Option, + /// 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, + /// Settings scope used when persisting the selected model. + #[serde(skip_serializing_if = "Option::is_none")] + pub model_change_scope: 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, + /// Optional settings context and explicit-override flags used to persist a picker selection. + #[serde(skip_serializing_if = "Option::is_none")] + pub picker_persistence: Option, + /// 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, + /// Optional repository settings scope to persist after the switch commits. + #[serde(skip_serializing_if = "Option::is_none")] + pub repo_scope: Option, + /// Require the target to be currently available and enabled before applying the switch. + #[serde(skip_serializing_if = "Option::is_none")] + pub require_available: Option, + /// When true, evaluate context-window compaction policy before applying the switch. + #[serde(skip_serializing_if = "Option::is_none")] + pub run_compaction_preflight: Option, + /// Origin to record on the effective `session.model_change` event. Defaults to `sdk` when omitted. + #[serde(skip_serializing_if = "Option::is_none")] + pub source: Option, + /// Output verbosity level to request for supported models + #[serde(skip_serializing_if = "Option::is_none")] + pub verbosity: Option, } -/// Name (or spec) of the plugin to update. +/// The model identifier active on the session after the switch. /// ///
/// @@ -9471,12 +10516,34 @@ pub struct PluginsUninstallRequest { ///
#[derive(Debug, Clone, Default, Serialize, Deserialize)] #[serde(rename_all = "camelCase")] -pub struct PluginsUpdateRequest { - /// Plugin name or "plugin@marketplace" spec to update. - pub name: String, +pub struct ModelSwitchToResult { + /// Compaction confirmation projection when status is confirmation_required + #[serde(skip_serializing_if = "Option::is_none")] + pub confirmation: Option, + /// 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, + /// Deprecation warnings associated with the selected model or options. + #[serde(skip_serializing_if = "Option::is_none")] + pub deprecation_warnings: Option>, + /// User-facing outcome message for the model switch. + #[serde(skip_serializing_if = "Option::is_none")] + pub message: Option, + /// Currently active model identifier after the switch + #[serde(skip_serializing_if = "Option::is_none")] + pub model_id: Option, + /// Persistence failure encountered after applying the model switch. + #[serde(skip_serializing_if = "Option::is_none")] + pub persistence_error: Option, + /// Lifecycle result for the requested switch + #[serde(skip_serializing_if = "Option::is_none")] + pub status: Option, + /// User-facing warning produced while applying the model switch. + #[serde(skip_serializing_if = "Option::is_none")] + pub warning: Option, } -/// Per-plugin result from updating all plugins, with versions, skills installed, success flag, and optional error. +/// Agent interaction mode to apply to the session. /// ///
/// @@ -9486,64 +10553,42 @@ pub struct PluginsUpdateRequest { ///
#[derive(Debug, Clone, Default, Serialize, Deserialize)] #[serde(rename_all = "camelCase")] -pub struct PluginUpdateAllEntry { - /// Error message (failure only) +pub struct ModeSetRequest { + /// Explicit response to a model-switch compaction preflight. #[serde(skip_serializing_if = "Option::is_none")] - 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 + pub compaction_decision: Option, + /// Session whose plan-mode base state should be inherited. #[serde(skip_serializing_if = "Option::is_none")] - pub new_version: Option, - /// Previously installed version, when available + pub inherit_plan_base_from_session_id: Option, + /// The session mode the agent is operating in + pub mode: SessionMode, + /// Whether the selected plan model should be persisted. #[serde(skip_serializing_if = "Option::is_none")] - pub previous_version: Option, - /// Number of skills installed after the update (success only) + pub persist_plan_selection: Option, + /// Settings context used when persisting the selected plan model. #[serde(skip_serializing_if = "Option::is_none")] - pub skills_installed: Option, - /// Whether the update succeeded for this plugin - pub success: bool, -} - -/// 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 PluginUpdateAllResult { - /// Per-plugin update results in deterministic order. - pub results: Vec, -} - -/// 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 PluginUpdateResult { - /// Version after the update, when reported by the plugin manifest + pub picker_settings_context: Option, + /// Context tier to use with the dedicated plan model. #[serde(skip_serializing_if = "Option::is_none")] - pub new_version: Option, - /// Version that was previously installed, when available + pub plan_context_tier: Option, + /// Action to perform when leaving plan mode. #[serde(skip_serializing_if = "Option::is_none")] - pub previous_version: Option, - /// Number of skills discovered and installed after the update - pub skills_installed: i64, + pub plan_exit_action: Option, + /// Dedicated model to use in plan mode, when configured. + #[serde(skip_serializing_if = "Option::is_none")] + pub plan_model: Option, + /// Whether a dedicated plan model is configured. + #[serde(skip_serializing_if = "Option::is_none")] + pub plan_model_configured: Option, + /// Reasoning effort to use with the dedicated plan model. + #[serde(skip_serializing_if = "Option::is_none")] + pub plan_reasoning_effort: Option, + /// Whether leaving plan mode should restore the session's previous model. + #[serde(skip_serializing_if = "Option::is_none")] + pub restore_plan_model: Option, } -/// A BYOK model definition referencing a named provider. +/// Outcome of a session mode change, including any model switch it triggered and follow-up the host must perform. /// ///
/// @@ -9553,35 +10598,32 @@ pub struct PluginUpdateResult { ///
#[derive(Debug, Clone, Default, Serialize, Deserialize)] #[serde(rename_all = "camelCase")] -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. +pub struct ModeSetResult { + /// Whether the host should arm an interactive continuation after the mode change. #[serde(skip_serializing_if = "Option::is_none")] - pub max_context_window_tokens: Option, - /// Maximum output tokens for the model. + pub arm_interactive_continuation: Option, + /// Compaction confirmation required before the mode change can complete. #[serde(skip_serializing_if = "Option::is_none")] - pub max_output_tokens: Option, - /// Maximum prompt/input tokens for the model. + pub confirmation: Option, + /// Whether the host must defer implementing the requested mode change. #[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`. + pub defer_implementation: Option, + /// Deprecation warnings associated with the model selected by the mode change. #[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`). + pub deprecation_warnings: Option>, + /// User-facing outcome message for the model switch triggered by the mode change. #[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`. + pub message: Option, + /// Whether applying the mode changed the active model. + pub model_changed: bool, + /// Lifecycle status of the requested mode change. + pub status: String, + /// User-facing warning produced while applying the mode change. #[serde(skip_serializing_if = "Option::is_none")] - pub wire_model: Option, + pub warning: Option, } -/// BYOK providers and/or models to add to the session's registry at runtime. Both fields are optional; provide providers, models, or both. +/// Result of moving in-flight MCP loading to the background. /// ///
/// @@ -9591,16 +10633,12 @@ pub struct ProviderModelConfig { ///
#[derive(Debug, Clone, Default, Serialize, Deserialize)] #[serde(rename_all = "camelCase")] -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>, +pub struct MoveMcpLoadingToBackgroundResult { + /// Whether an in-flight MCP load was moved to the background, releasing turns that were waiting on it. False when no MCP load was in flight or the waiting turns had already been released. + pub moved_to_background: bool, } -/// The selectable model entries synthesized for the models added by this call. +/// Azure-specific provider options. /// ///
/// @@ -9610,12 +10648,13 @@ pub struct ProviderAddRequest { ///
#[derive(Debug, Clone, Default, Serialize, Deserialize)] #[serde(rename_all = "camelCase")] -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, +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 api_version: Option, } -/// Custom model-provider configuration (BYOK). +/// External SDK input for a named custom model provider. Ingested by the native protocol boundary before host dispatch. /// ///
/// @@ -9625,51 +10664,38 @@ pub struct ProviderAddResult { ///
#[derive(Debug, Clone, Default, Serialize, Deserialize)] #[serde(rename_all = "camelCase")] -pub struct ProviderConfig { - /// API key. Optional for local providers like Ollama. +pub struct NamedProviderConfig { + /// Static API key used to authenticate provider requests. #[serde(skip_serializing_if = "Option::is_none")] pub api_key: Option, - /// Azure-specific provider options. + /// Azure authentication configuration for the provider. #[serde(skip_serializing_if = "Option::is_none")] pub azure: Option, - /// API endpoint URL. + /// Base URL for provider API requests. pub base_url: String, - /// Bearer token for authentication. Sets the Authorization header directly. Takes precedence over apiKey when both are set. + /// Static bearer token used to authenticate provider requests. #[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. + /// Whether the host supplies bearer tokens dynamically. #[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. + /// Additional HTTP headers included with provider requests. #[serde(skip_serializing_if = "Option::is_none")] 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". + /// Unique provider name used to qualify model selection IDs. + pub name: String, + /// Transport used to communicate with the provider. #[serde(skip_serializing_if = "Option::is_none")] pub transport: Option, - /// Provider type. Defaults to "openai" for generic OpenAI-compatible APIs. + /// Provider protocol family. #[serde(skip_serializing_if = "Option::is_none")] pub r#type: Option, - /// Wire API format (openai/azure only). Defaults to "completions". + /// Wire API used to communicate with the provider. #[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, } -/// 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. +/// The session's friendly name, or null when not yet set. /// ///
/// @@ -9679,20 +10705,12 @@ pub struct ProviderConfig { ///
#[derive(Debug, Clone, Default, Serialize, Deserialize)] #[serde(rename_all = "camelCase")] -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 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, +pub struct NameGetResult { + /// The session name (user-set or auto-generated), or null if not yet set + pub name: Option, } -/// A snapshot of the provider endpoint the session is currently configured to talk to. +/// Auto-generated session summary to apply as the session's name when no user-set name exists. /// ///
/// @@ -9702,28 +10720,12 @@ pub struct ProviderSessionToken { ///
#[derive(Debug, Clone, Default, Serialize, Deserialize)] #[serde(rename_all = "camelCase")] -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, +pub struct NameSetAutoRequest { + /// Auto-generated session summary. Empty/whitespace-only values are ignored; values are trimmed before persisting. + pub summary: String, } -/// Optional model identifier to scope the endpoint snapshot to. +/// Indicates whether the auto-generated summary was applied as the session's name. /// ///
/// @@ -9733,13 +10735,12 @@ pub struct ProviderEndpoint { ///
#[derive(Debug, Clone, Default, Serialize, Deserialize)] #[serde(rename_all = "camelCase")] -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, +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, } -/// 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. +/// New friendly name to apply to the session. /// ///
/// @@ -9749,14 +10750,12 @@ pub struct ProviderGetEndpointRequest { ///
#[derive(Debug, Clone, Default, Serialize, Deserialize)] #[serde(rename_all = "camelCase")] -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, +pub struct NameSetRequest { + /// New session name (1–100 characters, trimmed of leading/trailing whitespace) + pub name: String, } -/// 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. +/// Source descriptor for a `session.options.update` content-exclusion rule, with source name and type. /// ///
/// @@ -9766,12 +10765,14 @@ pub struct ProviderTokenAcquireRequest { ///
#[derive(Debug, Clone, Default, Serialize, Deserialize)] #[serde(rename_all = "camelCase")] -pub struct ProviderTokenAcquireResult { - /// The bearer token value (without the `Bearer ` prefix). - pub token: String, +pub struct OptionsUpdateAdditionalContentExclusionPolicyRuleSource { + /// Name of the policy source. + pub name: String, + /// Type of the policy source. + pub r#type: String, } -/// Blob attachment with inline base64-encoded data +/// Single content-exclusion rule supplied to `session.options.update`, with paths, match conditions, and source. /// ///
/// @@ -9781,19 +10782,20 @@ pub struct ProviderTokenAcquireResult { ///
#[derive(Debug, Clone, Default, Serialize, Deserialize)] #[serde(rename_all = "camelCase")] -pub struct PushAttachmentBlob { - /// Base64-encoded content - pub data: String, - /// User-facing display name for the attachment +pub struct OptionsUpdateAdditionalContentExclusionPolicyRule { + /// Conditions of which at least one must match. #[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: PushAttachmentBlobType, + pub if_any_match: Option>, + /// Conditions none of which may match. + #[serde(skip_serializing_if = "Option::is_none")] + pub if_none_match: Option>, + /// Path patterns covered by this rule. + pub paths: Vec, + /// Source descriptor for a `session.options.update` content-exclusion rule, with source name and type. + pub source: OptionsUpdateAdditionalContentExclusionPolicyRuleSource, } -/// Directory attachment +/// Content-exclusion policy supplied to `session.options.update`, with rules, last-updated data, and scope. /// ///
/// @@ -9803,16 +10805,17 @@ pub struct PushAttachmentBlob { ///
#[derive(Debug, Clone, Default, Serialize, Deserialize)] #[serde(rename_all = "camelCase")] -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, +pub struct OptionsUpdateAdditionalContentExclusionPolicy { + /// Opaque policy update timestamp supplied by the host. + #[serde(rename = "last_updated_at")] + pub last_updated_at: serde_json::Value, + /// Content-exclusion rules to apply. + pub rules: Vec, + /// Allowed values for the `OptionsUpdateAdditionalContentExclusionPolicyScope` enumeration. + pub scope: OptionsUpdateAdditionalContentExclusionPolicyScope, } -/// Optional line range to scope the attachment to a specific section of the file +/// Pending permission prompt reconstructed from event history, with request ID and user-facing prompt details. /// ///
/// @@ -9820,16 +10823,16 @@ pub struct PushAttachmentDirectory { /// 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 PushAttachmentFileLineRange { - /// End line number (1-based, inclusive) - pub end: i64, - /// Start line number (1-based) - pub start: i64, +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, } -/// File attachment +/// List of pending permission requests reconstructed from event history. /// ///
/// @@ -9839,19 +10842,12 @@ pub struct PushAttachmentFileLineRange { ///
#[derive(Debug, Clone, Default, Serialize, Deserialize)] #[serde(rename_all = "camelCase")] -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, +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, } -/// Pointer to a GitHub repository. +/// Permission-decision request variant to approve only the current permission request. /// ///
/// @@ -9861,17 +10857,15 @@ pub struct PushAttachmentFile { ///
#[derive(Debug, Clone, Default, Serialize, Deserialize)] #[serde(rename_all = "camelCase")] -pub struct PushGitHubRepoRef { - /// Numeric GitHub repository id +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 id: Option, - /// Repository name (without owner) - pub name: String, - /// Repository owner login (user or organization) - pub owner: String, + pub approved_interactively: Option, + /// Approve this single request only + pub kind: PermissionDecisionApproveOnceKind, } -/// Pointer to a GitHub Actions job. +/// Session-scoped approval details for specific command identifiers. /// ///
/// @@ -9881,25 +10875,14 @@ pub struct PushGitHubRepoRef { ///
#[derive(Debug, Clone, Default, Serialize, Deserialize)] #[serde(rename_all = "camelCase")] -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, +pub struct PermissionDecisionApproveForSessionApprovalCommands { + /// Command identifiers covered by this approval. + pub command_identifiers: Vec, + /// Approval scoped to specific command identifiers. + pub kind: PermissionDecisionApproveForSessionApprovalCommandsKind, } -/// Pointer to a GitHub commit. +/// Session-scoped approval details for read-only filesystem operations. /// ///
/// @@ -9909,20 +10892,12 @@ pub struct PushAttachmentGitHubActionsJob { ///
#[derive(Debug, Clone, Default, Serialize, Deserialize)] #[serde(rename_all = "camelCase")] -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, +pub struct PermissionDecisionApproveForSessionApprovalRead { + /// Approval covering read-only filesystem operations. + pub kind: PermissionDecisionApproveForSessionApprovalReadKind, } -/// Pointer to a file in a GitHub repository at a specific ref. +/// Session-scoped approval details for filesystem write operations. /// ///
/// @@ -9932,20 +10907,12 @@ pub struct PushAttachmentGitHubCommit { ///
#[derive(Debug, Clone, Default, Serialize, Deserialize)] #[serde(rename_all = "camelCase")] -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, +pub struct PermissionDecisionApproveForSessionApprovalWrite { + /// Approval covering filesystem write operations. + pub kind: PermissionDecisionApproveForSessionApprovalWriteKind, } -/// One side of a file diff (head or base) +/// Session-scoped approval details for an MCP server tool, or all tools on the server when `toolName` is null. /// ///
/// @@ -9955,16 +10922,16 @@ pub struct PushAttachmentGitHubFile { ///
#[derive(Debug, Clone, Default, Serialize, Deserialize)] #[serde(rename_all = "camelCase")] -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, +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, } -/// Pointer to a single-file diff. At least one of `head` and `base` must be present. +/// Session-scoped approval details for MCP sampling requests from a server. /// ///
/// @@ -9974,20 +10941,14 @@ pub struct PushAttachmentGitHubFileDiffSide { ///
#[derive(Debug, Clone, Default, Serialize, Deserialize)] #[serde(rename_all = "camelCase")] -pub struct PushAttachmentGitHubFileDiff { - /// File location on the base side of the diff. Absent for additions. - #[serde(skip_serializing_if = "Option::is_none")] - pub base: Option, - /// File location on the head side of the diff. Absent for deletions. - #[serde(skip_serializing_if = "Option::is_none")] - 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, +pub struct PermissionDecisionApproveForSessionApprovalMcpSampling { + /// Approval covering MCP sampling requests for a server. + pub kind: PermissionDecisionApproveForSessionApprovalMcpSamplingKind, + /// MCP server name. + pub server_name: String, } -/// GitHub issue, pull request, or discussion reference +/// Session-scoped approval details for writes to long-term memory. /// ///
/// @@ -9997,22 +10958,12 @@ pub struct PushAttachmentGitHubFileDiff { ///
#[derive(Debug, Clone, Default, Serialize, Deserialize)] #[serde(rename_all = "camelCase")] -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, +pub struct PermissionDecisionApproveForSessionApprovalMemory { + /// Approval covering writes to long-term memory. + pub kind: PermissionDecisionApproveForSessionApprovalMemoryKind, } -/// Pointer to a GitHub release. +/// Session-scoped approval details for a custom tool, keyed by tool name. /// ///
/// @@ -10022,20 +10973,14 @@ pub struct PushAttachmentGitHubReference { ///
#[derive(Debug, Clone, Default, Serialize, Deserialize)] #[serde(rename_all = "camelCase")] -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, +pub struct PermissionDecisionApproveForSessionApprovalCustomTool { + /// Approval covering a custom tool. + pub kind: PermissionDecisionApproveForSessionApprovalCustomToolKind, + /// Custom tool name. + pub tool_name: String, } -/// Pointer to a GitHub repository. +/// Session-scoped approval details for extension-management operations, optionally narrowed by operation. /// ///
/// @@ -10045,22 +10990,15 @@ pub struct PushAttachmentGitHubRelease { ///
#[derive(Debug, Clone, Default, Serialize, Deserialize)] #[serde(rename_all = "camelCase")] -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. +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 r#ref: Option, - /// Repository pointer - pub repo: PushGitHubRepoRef, - /// Attachment type discriminator - pub r#type: PushAttachmentGitHubRepositoryType, - /// URL to the repository on GitHub - pub url: String, + pub operation: Option, } -/// Pointer to a line range inside a file in a GitHub repository. +/// Session-scoped factory approval, optionally narrowed by approval key. /// ///
/// @@ -10070,22 +11008,15 @@ pub struct PushAttachmentGitHubRepository { ///
#[derive(Debug, Clone, Default, Serialize, Deserialize)] #[serde(rename_all = "camelCase")] -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, +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, } -/// One side of a tree comparison (head or base) +/// Session-scoped approval details for an extension's permission-gated capability access, keyed by extension name. /// ///
/// @@ -10095,14 +11026,14 @@ pub struct PushAttachmentGitHubSnippet { ///
#[derive(Debug, Clone, Default, Serialize, Deserialize)] #[serde(rename_all = "camelCase")] -pub struct PushAttachmentGitHubTreeComparisonSide { - /// Repository the revision belongs to - pub repo: PushGitHubRepoRef, - /// Git revision (branch, tag, or commit SHA) - pub revision: 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, } -/// Pointer to a comparison between two git revisions. +/// Session-scoped approval details for an extension's access to sensitive environment variables, keyed by extension name and the exact set of variable names. /// ///
/// @@ -10112,18 +11043,16 @@ pub struct PushAttachmentGitHubTreeComparisonSide { ///
#[derive(Debug, Clone, Default, Serialize, Deserialize)] #[serde(rename_all = "camelCase")] -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, +pub struct PermissionDecisionApproveForSessionApprovalExtensionEnvAccess { + /// Names of the sensitive environment variables this approval covers. Values are never persisted. + pub environment_variables: Vec, + /// Extension name. + pub extension_name: String, + /// Approval covering an extension's request to read sensitive environment variables. + pub kind: PermissionDecisionApproveForSessionApprovalExtensionEnvAccessKind, } -/// Generic GitHub URL reference. +/// Permission-decision request variant to approve for the rest of the session, with optional tool approval or URL domain. /// ///
/// @@ -10133,14 +11062,18 @@ pub struct PushAttachmentGitHubTreeComparison { ///
#[derive(Debug, Clone, Default, Serialize, Deserialize)] #[serde(rename_all = "camelCase")] -pub struct PushAttachmentGitHubUrl { - /// Attachment type discriminator - pub r#type: PushAttachmentGitHubUrlType, - /// URL to the GitHub resource - pub url: String, +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, } -/// End position of the selection +/// Location-scoped approval details for specific command identifiers. /// ///
/// @@ -10150,14 +11083,14 @@ pub struct PushAttachmentGitHubUrl { ///
#[derive(Debug, Clone, Default, Serialize, Deserialize)] #[serde(rename_all = "camelCase")] -pub struct PushAttachmentSelectionDetailsEnd { - /// End character offset within the line (0-based) - pub character: i64, - /// End line number (0-based) - pub line: i64, +pub struct PermissionDecisionApproveForLocationApprovalCommands { + /// Command identifiers covered by this approval. + pub command_identifiers: Vec, + /// Approval scoped to specific command identifiers. + pub kind: PermissionDecisionApproveForLocationApprovalCommandsKind, } -/// Start position of the selection +/// Location-scoped approval details for read-only filesystem operations. /// ///
/// @@ -10167,14 +11100,12 @@ pub struct PushAttachmentSelectionDetailsEnd { ///
#[derive(Debug, Clone, Default, Serialize, Deserialize)] #[serde(rename_all = "camelCase")] -pub struct PushAttachmentSelectionDetailsStart { - /// Start character offset within the line (0-based) - pub character: i64, - /// Start line number (0-based) - pub line: i64, +pub struct PermissionDecisionApproveForLocationApprovalRead { + /// Approval covering read-only filesystem operations. + pub kind: PermissionDecisionApproveForLocationApprovalReadKind, } -/// Position range of the selection within the file +/// Location-scoped approval details for filesystem write operations. /// ///
/// @@ -10184,14 +11115,12 @@ pub struct PushAttachmentSelectionDetailsStart { ///
#[derive(Debug, Clone, Default, Serialize, Deserialize)] #[serde(rename_all = "camelCase")] -pub struct PushAttachmentSelectionDetails { - /// End position of the selection - pub end: PushAttachmentSelectionDetailsEnd, - /// Start position of the selection - pub start: PushAttachmentSelectionDetailsStart, +pub struct PermissionDecisionApproveForLocationApprovalWrite { + /// Approval covering filesystem write operations. + pub kind: PermissionDecisionApproveForLocationApprovalWriteKind, } -/// Code selection attachment from an editor +/// Location-scoped approval details for an MCP server tool, or all tools on the server when `toolName` is null. /// ///
/// @@ -10201,20 +11130,16 @@ pub struct PushAttachmentSelectionDetails { ///
#[derive(Debug, Clone, Default, Serialize, Deserialize)] #[serde(rename_all = "camelCase")] -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, +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, } -/// Queued-command response indicating the host executed the command, with an optional flag to stop queue processing. +/// Location-scoped approval details for MCP sampling requests from a server. /// ///
/// @@ -10224,15 +11149,14 @@ pub struct PushAttachmentSelection { ///
#[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 struct PermissionDecisionApproveForLocationApprovalMcpSampling { + /// Approval covering MCP sampling requests for a server. + pub kind: PermissionDecisionApproveForLocationApprovalMcpSamplingKind, + /// MCP server name. + pub server_name: String, } -/// Queued-command response indicating the host did not execute the command and the queue may continue. +/// Location-scoped approval details for writes to long-term memory. /// ///
/// @@ -10242,12 +11166,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 PermissionDecisionApproveForLocationApprovalMemory { + /// Approval covering writes to long-term memory. + pub kind: PermissionDecisionApproveForLocationApprovalMemoryKind, } -/// User-facing pending queue entry, with kind and display text for a queued message, slash command, or model change. +/// Location-scoped approval details for a custom tool, keyed by tool name. /// ///
/// @@ -10257,14 +11181,14 @@ 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 PermissionDecisionApproveForLocationApprovalCustomTool { + /// Approval covering a custom tool. + pub kind: PermissionDecisionApproveForLocationApprovalCustomToolKind, + /// Custom tool name. + pub tool_name: String, } -/// Snapshot of the session's pending queued items and immediate-steering messages. +/// Location-scoped approval details for extension-management operations, optionally narrowed by operation. /// ///
/// @@ -10274,14 +11198,15 @@ 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 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, } -/// Indicates whether a user-facing pending item was removed. +/// Location-scoped factory approval, optionally narrowed by approval key. /// ///
/// @@ -10291,12 +11216,15 @@ 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 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 approval_key: Option, + /// Approval covering factory operations. + pub kind: PermissionDecisionApproveForLocationApprovalFactoryKind, } -/// Event type to register consumer interest for, used by runtime gating logic. +/// Location-scoped approval details for an extension's permission-gated capability access, keyed by extension name. /// ///
/// @@ -10306,12 +11234,14 @@ 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 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, +pub struct PermissionDecisionApproveForLocationApprovalExtensionPermissionAccess { + /// Extension name. + pub extension_name: String, + /// Approval covering an extension's request to access a permission-gated capability. + pub kind: PermissionDecisionApproveForLocationApprovalExtensionPermissionAccessKind, } -/// Opaque handle representing an event-type interest registration. +/// Location-scoped approval details for an extension's access to sensitive environment variables, keyed by extension name and the exact set of variable names. /// ///
/// @@ -10321,12 +11251,16 @@ 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 PermissionDecisionApproveForLocationApprovalExtensionEnvAccess { + /// Names of the sensitive environment variables this approval covers. Values are never persisted. + pub environment_variables: Vec, + /// Extension name. + pub extension_name: String, + /// Approval covering an extension's request to read sensitive environment variables. + pub kind: PermissionDecisionApproveForLocationApprovalExtensionEnvAccessKind, } -/// Optional registration options. +/// Permission-decision request variant to approve and persist a permission for a project location, with approval details and location key. /// ///
/// @@ -10334,16 +11268,18 @@ pub struct RegisterEventInterestResult { /// 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 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, +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, } -/// Params to attach an extension loader's tools to a session. +/// Permission-decision request variant to permanently approve a URL domain across sessions. /// ///
/// @@ -10353,18 +11289,14 @@ pub struct SessionsRegisterExtensionToolsOnSessionOptions { ///
#[derive(Debug, Clone, Default, Serialize, Deserialize)] #[serde(rename_all = "camelCase")] -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, +pub struct PermissionDecisionApprovePermanently { + /// URL domain to approve permanently + pub domain: String, + /// Approve and persist across sessions (URL prompts only) + pub kind: PermissionDecisionApprovePermanentlyKind, } -/// Handle for releasing the extension tool registration. +/// Permission-decision request variant to reject a pending permission request, with optional feedback. /// ///
/// @@ -10374,13 +11306,15 @@ pub(crate) struct RegisterExtensionToolsParams { ///
#[derive(Debug, Clone, Default, Serialize, Deserialize)] #[serde(rename_all = "camelCase")] -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, +pub struct PermissionDecisionReject { + /// Optional feedback explaining the rejection + #[serde(skip_serializing_if = "Option::is_none")] + pub feedback: Option, + /// Reject the request + pub kind: PermissionDecisionRejectKind, } -/// Opaque handle previously returned by `registerInterest` to release. +/// Permission-decision variant indicating no user was available to confirm the request. /// ///
/// @@ -10390,12 +11324,12 @@ pub(crate) struct RegisterExtensionToolsResult { ///
#[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 PermissionDecisionUserNotAvailable { + /// No user is available to confirm the request + pub kind: PermissionDecisionUserNotAvailableKind, } -/// Reattach to an existing MC session without creating a new one. +/// Permission-decision variant indicating the request was approved. /// ///
/// @@ -10405,14 +11339,12 @@ pub struct ReleaseEventInterestParams { ///
#[derive(Debug, Clone, Default, Serialize, Deserialize)] #[serde(rename_all = "camelCase")] -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, +pub struct PermissionDecisionApproved { + /// The permission request was approved + pub kind: PermissionDecisionApprovedKind, } -/// Configuration for the runtime-managed remote-control singleton. +/// Permission-decision variant indicating approval was remembered for the session, with approval details. /// ///
/// @@ -10420,26 +11352,16 @@ pub struct RemoteControlConfigExistingMcSession { /// 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 RemoteControlConfig { - /// Reattach to an existing MC session without creating a new one. - #[serde(skip_serializing_if = "Option::is_none")] - 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 task_id: Option, +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, } -/// Remote control is connected to a local session. +/// Permission-decision variant indicating approval was persisted for a project location, with approval details and location key. /// ///
/// @@ -10447,29 +11369,18 @@ pub struct RemoteControlConfig { /// 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 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, +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, } -/// Remote control is in the middle of initial setup. +/// Permission-decision variant indicating the request was cancelled before use, with an optional reason. /// ///
/// @@ -10479,14 +11390,15 @@ pub struct RemoteControlStatusActive { ///
#[derive(Debug, Clone, Default, Serialize, Deserialize)] #[serde(rename_all = "camelCase")] -pub struct RemoteControlStatusConnecting { - /// Session id the connection is attaching to. - pub attached_session_id: String, - /// Remote control state tag: connecting. - pub state: RemoteControlStatusConnectingState, +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, } -/// The last setup attempt failed. The singleton is otherwise off. +/// Permission-decision variant indicating explicit denial by permission rules, with the matching rules. /// ///
/// @@ -10496,17 +11408,14 @@ pub struct RemoteControlStatusConnecting { ///
#[derive(Debug, Clone, Default, Serialize, Deserialize)] #[serde(rename_all = "camelCase")] -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, +pub struct PermissionDecisionDeniedByRules { + /// Denied because approval rules explicitly blocked it + pub kind: PermissionDecisionDeniedByRulesKind, + /// Rules that denied the request + pub rules: Vec, } -/// Remote control is not connected. +/// Permission-decision variant indicating no approval rule matched and user confirmation was unavailable. /// ///
/// @@ -10516,12 +11425,12 @@ pub struct RemoteControlStatusError { ///
#[derive(Debug, Clone, Default, Serialize, Deserialize)] #[serde(rename_all = "camelCase")] -pub struct RemoteControlStatusOff { - /// Remote control state tag: not connected. - pub state: RemoteControlStatusOffState, +pub struct PermissionDecisionDeniedNoApprovalRuleAndCouldNotRequestFromUser { + /// Denied because no approval rule matched and user confirmation was unavailable + pub kind: PermissionDecisionDeniedNoApprovalRuleAndCouldNotRequestFromUserKind, } -/// Wrapper for the singleton's current status. +/// Permission-decision variant indicating the user denied an interactive prompt, with optional feedback and force-reject flag. /// ///
/// @@ -10531,12 +11440,18 @@ pub struct RemoteControlStatusOff { ///
#[derive(Debug, Clone, Default, Serialize, Deserialize)] #[serde(rename_all = "camelCase")] -pub struct RemoteControlStatusResult { - /// State of the runtime-managed remote-control singleton. - pub status: serde_json::Value, +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, } -/// Outcome of a stopRemoteControl call. +/// Permission-decision variant indicating denial by content-exclusion policy, with path and message. /// ///
/// @@ -10546,14 +11461,16 @@ pub struct RemoteControlStatusResult { ///
#[derive(Debug, Clone, Default, Serialize, Deserialize)] #[serde(rename_all = "camelCase")] -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, +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, } -/// Outcome of a transferRemoteControl call. +/// Permission-decision variant indicating denial by a permission request hook, with optional message and interrupt flag. /// ///
/// @@ -10563,15 +11480,19 @@ pub struct RemoteControlStopResult { ///
#[derive(Debug, Clone, Default, Serialize, Deserialize)] #[serde(rename_all = "camelCase")] -pub struct RemoteControlTransferResult { - /// State of the runtime-managed remote-control singleton. - pub status: serde_json::Value, - /// Whether the rebinding actually happened. - pub transferred: bool, -} - -/// Optional remote session mode ("off", "export", or "on"); defaults to enabling both export and remote steering. -/// +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, +} + +/// Optional informational context describing how and where the permission decision was made. This does not affect permission behavior. +/// ///
/// /// **Experimental.** This type is part of an experimental wire-protocol surface @@ -10580,13 +11501,19 @@ pub struct RemoteControlTransferResult { ///
#[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 PermissionDecisionContext { + /// Disposition of the permission request as observed by the responding client. + pub outcome: PermissionDecisionOutcome, + /// Whether the responding client could ask a user interactively, was running headlessly, or had no response path. Omit when the client cannot determine this authoritatively. #[serde(skip_serializing_if = "Option::is_none")] - pub mode: Option, + pub response_capability: Option, + /// Controlled reason or actor responsible for the response. + pub source: PermissionDecisionSource, + /// Client surface that submitted the response. + pub surface: PermissionDecisionSurface, } -/// GitHub URL for the session and a flag indicating whether remote steering is enabled. +/// Pending permission request ID and the decision to apply (approve/reject and scope). /// ///
/// @@ -10594,17 +11521,19 @@ 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 +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 url: Option, + 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, } -/// New remote-steerability state to persist as a `session.remote_steerable_changed` event. +/// Location-persisted tool approval details for specific command identifiers. /// ///
/// @@ -10614,12 +11543,14 @@ 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 PermissionsLocationsAddToolApprovalDetailsCommands { + /// Command identifiers covered by this approval. + pub command_identifiers: Vec, + /// Approval scoped to specific command identifiers. + pub kind: PermissionsLocationsAddToolApprovalDetailsCommandsKind, } -/// 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. +/// Location-persisted tool approval details for read-only filesystem operations. /// ///
/// @@ -10629,9 +11560,12 @@ pub struct RemoteNotifySteerableChangedRequest { ///
#[derive(Debug, Clone, Default, Serialize, Deserialize)] #[serde(rename_all = "camelCase")] -pub struct RemoteNotifySteerableChangedResult {} +pub struct PermissionsLocationsAddToolApprovalDetailsRead { + /// Approval covering read-only filesystem operations. + pub kind: PermissionsLocationsAddToolApprovalDetailsReadKind, +} -/// Remote session connection result. +/// Location-persisted tool approval details for filesystem write operations. /// ///
/// @@ -10641,14 +11575,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 PermissionsLocationsAddToolApprovalDetailsWrite { + /// Approval covering filesystem write operations. + pub kind: PermissionsLocationsAddToolApprovalDetailsWriteKind, } -/// GitHub repository the remote session belongs to. +/// Location-persisted tool approval details for an MCP server tool, or all tools when `toolName` is null. /// ///
/// @@ -10658,16 +11590,16 @@ pub struct RemoteSessionConnectionResult { ///
#[derive(Debug, Clone, Default, Serialize, Deserialize)] #[serde(rename_all = "camelCase")] -pub struct RemoteSessionMetadataRepository { - /// Branch associated with the remote session. - pub branch: String, - /// Repository name. - pub name: String, - /// Repository owner. - pub owner: String, +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, } -/// Remote session metadata for the session to hand off (typically obtained from `sessions.list` with `source: "remote"`). +/// Location-persisted tool approval details for MCP sampling requests from a server. /// ///
/// @@ -10677,46 +11609,14 @@ pub struct RemoteSessionMetadataRepository { ///
#[derive(Debug, Clone, Default, Serialize, Deserialize)] #[serde(rename_all = "camelCase")] -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, +pub struct PermissionsLocationsAddToolApprovalDetailsMcpSampling { + /// Approval covering MCP sampling requests for a server. + pub kind: PermissionsLocationsAddToolApprovalDetailsMcpSamplingKind, + /// MCP server name. + pub server_name: String, } -/// Repository context for the remote session. +/// Location-persisted tool approval details for writes to long-term memory. /// ///
/// @@ -10726,17 +11626,12 @@ pub struct RemoteSessionMetadataValue { ///
#[derive(Debug, Clone, Default, Serialize, Deserialize)] #[serde(rename_all = "camelCase")] -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, +pub struct PermissionsLocationsAddToolApprovalDetailsMemory { + /// Approval covering writes to long-term memory. + pub kind: PermissionsLocationsAddToolApprovalDetailsMemoryKind, } -/// macOS seatbelt experimental options. +/// Location-persisted tool approval details for a custom tool, keyed by tool name. /// ///
/// @@ -10746,13 +11641,14 @@ pub struct RemoteSessionRepository { ///
#[derive(Debug, Clone, Default, Serialize, Deserialize)] #[serde(rename_all = "camelCase")] -pub struct SandboxConfigUserPolicyExperimentalSeatbelt { - /// Whether the macOS seatbelt profile may access the keychain. - #[serde(skip_serializing_if = "Option::is_none")] - pub keychain_access: Option, +pub struct PermissionsLocationsAddToolApprovalDetailsCustomTool { + /// Approval covering a custom tool. + pub kind: PermissionsLocationsAddToolApprovalDetailsCustomToolKind, + /// Custom tool name. + pub tool_name: String, } -/// Platform-specific experimental policy fields. +/// Location-persisted tool approval details for extension-management operations, optionally narrowed by operation. /// ///
/// @@ -10762,13 +11658,15 @@ pub struct SandboxConfigUserPolicyExperimentalSeatbelt { ///
#[derive(Debug, Clone, Default, Serialize, Deserialize)] #[serde(rename_all = "camelCase")] -pub struct SandboxConfigUserPolicyExperimental { - /// macOS seatbelt experimental options. +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 seatbelt: Option, + pub operation: Option, } -/// Filesystem rules to merge into the base policy. +/// Location-persisted factory approval, optionally narrowed by approval key. /// ///
/// @@ -10778,22 +11676,15 @@ pub struct SandboxConfigUserPolicyExperimental { ///
#[derive(Debug, Clone, Default, Serialize, Deserialize)] #[serde(rename_all = "camelCase")] -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. +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 readwrite_paths: Option>, + pub approval_key: Option, + /// Approval covering factory operations. + pub kind: PermissionsLocationsAddToolApprovalDetailsFactoryKind, } -/// Network rules to merge into the base policy. +/// Location-persisted tool approval details for an extension's permission-gated capability access, keyed by extension name. /// ///
/// @@ -10803,16 +11694,14 @@ pub struct SandboxConfigUserPolicyFilesystem { ///
#[derive(Debug, Clone, Default, Serialize, Deserialize)] #[serde(rename_all = "camelCase")] -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, +pub struct PermissionsLocationsAddToolApprovalDetailsExtensionPermissionAccess { + /// Extension name. + pub extension_name: String, + /// Approval covering an extension's request to access a permission-gated capability. + pub kind: PermissionsLocationsAddToolApprovalDetailsExtensionPermissionAccessKind, } -/// macOS seatbelt-specific options. +/// Location-persisted tool approval details for an extension's access to sensitive environment variables, keyed by extension name and the exact set of variable names. /// ///
/// @@ -10822,13 +11711,33 @@ pub struct SandboxConfigUserPolicyNetwork { ///
#[derive(Debug, Clone, Default, Serialize, Deserialize)] #[serde(rename_all = "camelCase")] -pub struct SandboxConfigUserPolicySeatbelt { - /// Whether the macOS seatbelt profile may access the keychain. - #[serde(skip_serializing_if = "Option::is_none")] - pub keychain_access: Option, +pub struct PermissionsLocationsAddToolApprovalDetailsExtensionEnvAccess { + /// Names of the sensitive environment variables this approval covers. Values are never persisted. + pub environment_variables: Vec, + /// Extension name. + pub extension_name: String, + /// Approval covering an extension's request to read sensitive environment variables. + pub kind: PermissionsLocationsAddToolApprovalDetailsExtensionEnvAccessKind, } -/// User-managed sandbox policy fragment merged into the auto-discovered base policy. +/// Location-scoped tool approval 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, 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, +} + +/// Working directory to load persisted location permissions for. /// ///
/// @@ -10838,22 +11747,12 @@ pub struct SandboxConfigUserPolicySeatbelt { ///
#[derive(Debug, Clone, Default, Serialize, Deserialize)] #[serde(rename_all = "camelCase")] -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, +pub struct PermissionLocationApplyParams { + /// Working directory whose persisted location permissions should be applied + pub working_directory: String, } -/// Resolved sandbox configuration. +/// Summary of persisted location permissions applied to the session. /// ///
/// @@ -10863,24 +11762,22 @@ pub struct SandboxConfigUserPolicy { ///
#[derive(Debug, Clone, Default, Serialize, Deserialize)] #[serde(rename_all = "camelCase")] -pub struct SandboxConfig { - /// Whether to auto-add the current working directory to readwritePaths. Default: true. - #[serde(skip_serializing_if = "Option::is_none")] - pub add_current_working_directory: Option, - /// Whether sandboxing is enabled for the session. - pub enabled: bool, - /// 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_auth: Option, - /// Whether to inject the Copilot GitHub token as an `http..extraheader` so authenticated HTTPS git works inside the sandbox without the shell-based credential helper the sandbox blocks. Default: false (opt-in). - #[serde(skip_serializing_if = "Option::is_none")] - pub git_auth: Option, - /// User-managed sandbox policy fragment merged into the auto-discovered base policy. - #[serde(skip_serializing_if = "Option::is_none")] - pub user_policy: Option, +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, } -/// Scheduled prompt entry with ID, timing (`intervalMs`, `cron`, or `at`), prompt text, recurrence, and next run time. +/// Working directory to resolve into a location-permissions key. /// ///
/// @@ -10890,36 +11787,12 @@ pub struct SandboxConfig { ///
#[derive(Debug, Clone, Default, Serialize, Deserialize)] #[serde(rename_all = "camelCase")] -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, +pub struct PermissionLocationResolveParams { + /// Working directory whose permission location should be resolved + pub working_directory: String, } -/// Snapshot of the currently active recurring prompts for this session. +/// Resolved location-permissions key and type. /// ///
/// @@ -10929,12 +11802,14 @@ 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 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, } -/// Identifier of the scheduled prompt to remove. +/// Directory path to add to the session's allowed directories. /// ///
/// @@ -10944,12 +11819,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 PermissionPathsAddParams { + /// Directory to add to the allow-list. The runtime resolves and validates the path before adding, then loads conventional `.github/skills/` and `.github/agents/` definitions under it when their subsystem gates are enabled. Adding the directory is therefore also a trust decision for configuration stored there. + pub path: String, } -/// Remove a scheduled prompt by id. The result entry is omitted if the id was unknown. +/// Path to evaluate against the session's allowed directories. /// ///
/// @@ -10959,13 +11834,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, +pub struct PermissionPathsAllowedCheckParams { + /// Path to check against the session's allowed directories + pub path: String, } -/// Secret values to add to the redaction filter. +/// Indicates whether the supplied path is within the session's allowed directories. /// ///
/// @@ -10975,12 +11849,12 @@ pub struct ScheduleStopResult { ///
#[derive(Debug, Clone, Default, Serialize, Deserialize)] #[serde(rename_all = "camelCase")] -pub struct SecretsAddFilterValuesRequest { - /// Raw secret values to register for redaction - pub values: Vec, +pub struct PermissionPathsAllowedCheckResult { + /// Whether the path is within the session's allowed directories + pub allowed: bool, } -/// Confirmation that the secret values were registered. +/// 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. /// ///
/// @@ -10990,12 +11864,22 @@ pub struct SecretsAddFilterValuesRequest { ///
#[derive(Debug, Clone, Default, Serialize, Deserialize)] #[serde(rename_all = "camelCase")] -pub struct SecretsAddFilterValuesResult { - /// Whether the values were successfully registered - pub ok: bool, +pub struct PermissionPathsConfig { + /// Additional directories to allow tool access to (in addition to the session's working directory). Conventional `.github/skills/` and `.github/agents/` definitions under them also join the session catalogs when their subsystem gates are enabled, so supplying a directory is a trust decision for configuration stored there. 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 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 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 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 workspace_path: Option, } -/// Parameters for session.extensions.sendAttachmentsToMessage. +/// Snapshot of the session's allow-listed directories and primary working directory. /// ///
/// @@ -11005,15 +11889,14 @@ pub struct SecretsAddFilterValuesResult { ///
#[derive(Debug, Clone, Default, Serialize, Deserialize)] #[serde(rename_all = "camelCase")] -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, +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, } -/// A single user message to append to the session as part of a `session.sendMessages` turn +/// Directory path to set as the session's new primary working directory. /// ///
/// @@ -11023,29 +11906,12 @@ pub struct SendAttachmentsToMessageParams { ///
#[derive(Debug, Clone, Default, Serialize, Deserialize)] #[serde(rename_all = "camelCase")] -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 match one of three forms: the literal `system`, `command-` for messages originating from a command (e.g. slash command, Mission Control command), or `schedule-` for messages originating from a scheduled job. - #[doc(hidden)] - #[serde(skip_serializing_if = "Option::is_none")] - pub(crate) source: Option, +pub struct PermissionPathsUpdatePrimaryParams { + /// Directory to set as the new primary working directory for the session's permission policy. + pub path: String, } -/// 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. +/// Path to evaluate against the session's workspace (primary) directory. /// ///
/// @@ -11055,33 +11921,12 @@ pub struct SendMessageItem { ///
#[derive(Debug, Clone, Default, Serialize, Deserialize)] #[serde(rename_all = "camelCase")] -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. - #[serde(skip_serializing_if = "Option::is_none")] - pub wait: Option, +pub struct PermissionPathsWorkspaceCheckParams { + /// Path to check against the session workspace directory + pub path: String, } -/// Result of sending zero or more user messages +/// Indicates whether the supplied path is within the session's workspace directory. /// ///
/// @@ -11091,12 +11936,12 @@ pub struct SendMessagesRequest { ///
#[derive(Debug, Clone, Default, Serialize, Deserialize)] #[serde(rename_all = "camelCase")] -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, +pub struct PermissionPathsWorkspaceCheckResult { + /// Whether the path is within the session workspace directory + pub allowed: bool, } -/// Parameters for sending a user message to the session +/// Notification payload describing the permission prompt that the client just rendered. /// ///
/// @@ -11106,49 +11951,12 @@ pub struct SendMessagesResult { ///
#[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. Must match one of three forms: the literal `system`, `command-` for messages originating from a command (e.g. slash command, Mission Control command), or `schedule-` for messages originating from a scheduled job. - #[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 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, } -/// Result of sending a user message +/// Indicates whether the permission decision was applied; false when the request was already resolved. /// ///
/// @@ -11158,12 +11966,12 @@ 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, +pub struct PermissionRequestResult { + /// Whether the permission request was handled successfully + pub success: bool, } -/// Agents discovered across user, project, plugin, and remote sources. +/// If specified, replaces the session's approved/denied permission rules. Omit to leave the current rules unchanged. /// ///
/// @@ -11173,12 +11981,14 @@ pub struct SendResult { ///
#[derive(Debug, Clone, Default, Serialize, Deserialize)] #[serde(rename_all = "camelCase")] -pub struct ServerAgentList { - /// All discovered agents across all sources - pub agents: Vec, +pub struct PermissionRulesSet { + /// Rules that auto-approve matching requests + pub approved: Vec, + /// Rules that auto-deny matching requests + pub denied: Vec, } -/// Instruction sources discovered across user, repository, and plugin sources. +/// Source descriptor for a `session.permissions.configure` content-exclusion rule, with source name and type. /// ///
/// @@ -11188,12 +11998,14 @@ pub struct ServerAgentList { ///
#[derive(Debug, Clone, Default, Serialize, Deserialize)] #[serde(rename_all = "camelCase")] -pub struct ServerInstructionSourceList { - /// All discovered instruction sources - pub sources: Vec, +pub struct PermissionsConfigureAdditionalContentExclusionPolicyRuleSource { + /// Name of the policy source. + pub name: String, + /// Type of the policy source. + pub r#type: String, } -/// Server-side skill metadata, including name, description, source, enabled/invocable state, path, project path, and argument hint. +/// Single content-exclusion rule supplied to `session.permissions.configure`, with paths, match conditions, and source. /// ///
/// @@ -11203,29 +12015,20 @@ pub struct ServerInstructionSourceList { ///
#[derive(Debug, Clone, Default, Serialize, Deserialize)] #[serde(rename_all = "camelCase")] -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, - /// 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 +pub struct PermissionsConfigureAdditionalContentExclusionPolicyRule { + /// Conditions of which at least one must match. #[serde(skip_serializing_if = "Option::is_none")] - pub path: Option, - /// The project path this skill belongs to (only for project/inherited skills) + pub if_any_match: Option>, + /// Conditions none of which may match. #[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 if_none_match: Option>, + /// Path patterns covered by this rule. + pub paths: Vec, + /// Source descriptor for a `session.permissions.configure` content-exclusion rule, with source name and type. + pub source: PermissionsConfigureAdditionalContentExclusionPolicyRuleSource, } -/// Skills discovered across global and project sources. +/// Content-exclusion policy supplied to `session.permissions.configure`, with rules, last-updated data, and scope. /// ///
/// @@ -11235,15 +12038,17 @@ pub struct ServerSkill { ///
#[derive(Debug, Clone, Default, Serialize, Deserialize)] #[serde(rename_all = "camelCase")] -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, +pub struct PermissionsConfigureAdditionalContentExclusionPolicy { + /// Opaque policy update timestamp supplied by the host. + #[serde(rename = "last_updated_at")] + pub last_updated_at: serde_json::Value, + /// Content-exclusion rules to apply. + pub rules: Vec, + /// Allowed values for the `PermissionsConfigureAdditionalContentExclusionPolicyScope` enumeration. + pub scope: PermissionsConfigureAdditionalContentExclusionPolicyScope, } -/// Current activity flags for the session. +/// 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. /// ///
/// @@ -11253,14 +12058,16 @@ pub struct ServerSkillList { ///
#[derive(Debug, Clone, Default, Serialize, Deserialize)] #[serde(rename_all = "camelCase")] -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, +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, } -/// Authentication status and account metadata for the session. +/// Patch of permission policy fields to apply (omit a field to leave it unchanged). /// ///
/// @@ -11270,27 +12077,29 @@ pub struct SessionActivity { ///
#[derive(Debug, Clone, Default, Serialize, Deserialize)] #[serde(rename_all = "camelCase")] -pub struct SessionAuthStatus { - /// Authentication type +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 auth_type: Option, - /// Copilot plan tier (e.g., individual_pro, business) + 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 copilot_plan: Option, - /// Authentication host URL + 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 host: Option, - /// Whether the session has resolved authentication - pub is_authenticated: bool, - /// Authenticated login/username, if available + 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 login: Option, - /// Human-readable authentication status description + 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 status_message: Option, + 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, } -/// Map of sessionId -> bytes freed by removing the session's workspace directory. +/// Indicates whether the operation succeeded. /// ///
/// @@ -11300,39 +12109,27 @@ 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, -} - -/// 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, +pub struct PermissionsConfigureResult { + /// 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 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, +pub struct PermissionsFolderTrustAddTrustedResult { + /// Whether the operation succeeded + pub success: bool, } -/// Per-source context-window attribution, or null if the session has not yet been initialized (no system prompt or tool metadata cached). +/// No parameters. /// ///
/// @@ -11342,16 +12139,9 @@ pub struct SessionContextAttributionEntriesItem { ///
#[derive(Debug, Clone, Default, Serialize, Deserialize)] #[serde(rename_all = "camelCase")] -pub struct SessionContextAttribution { - /// Successful compaction history for the session. - pub compactions: SessionContextAttributionCompactions, - /// 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, - /// 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, -} +pub struct PermissionsGetModeRequest {} -/// Token breakdown for the current context window, or null if the session has not yet been initialized (no system prompt or tool metadata cached). +/// Current permission mode. /// ///
/// @@ -11361,30 +12151,12 @@ pub struct SessionContextAttribution { ///
#[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, - /// 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, +pub struct PermissionsGetModeResult { + /// Current permission mode + pub mode: PermissionMode, } -/// The enriched metadata records, with summary and context fields backfilled where available. Sessions confirmed empty and unnamed are omitted. +/// Indicates whether the operation succeeded. /// ///
/// @@ -11394,12 +12166,12 @@ pub struct SessionContextInfo { ///
#[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 PermissionsLocationsAddToolApprovalResult { + /// Whether the operation succeeded + pub success: bool, } -/// File path, content to append, and optional mode for the client-provided session filesystem. +/// Scope and add/remove instructions for modifying session- or location-scoped permission rules. /// ///
/// @@ -11409,19 +12181,21 @@ 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 PermissionsModifyRulesParams { + /// Rules to add to the scope. Applied before `remove`/`removeAll`. #[serde(skip_serializing_if = "Option::is_none")] - pub mode: Option, + 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, } -/// Describes a filesystem error. +/// Indicates whether the operation succeeded. /// ///
/// @@ -11431,15 +12205,12 @@ 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 - #[serde(skip_serializing_if = "Option::is_none")] - pub message: Option, +pub struct PermissionsModifyRulesResult { + /// Whether the operation succeeded + pub success: bool, } -/// Path to test for existence in the client-provided session filesystem. +/// Indicates whether the operation succeeded. /// ///
/// @@ -11449,14 +12220,12 @@ 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 PermissionsNotifyPromptShownResult { + /// Whether the operation succeeded + pub success: bool, } -/// Indicates whether the requested path exists in the client-provided session filesystem. +/// Indicates whether the operation succeeded. /// ///
/// @@ -11466,12 +12235,12 @@ 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 PermissionsPathsAddResult { + /// Whether the operation succeeded + pub success: bool, } -/// Directory path to create in the client-provided session filesystem, with options for recursive creation and POSIX mode. +/// No parameters; returns the session's allow-listed directories. /// ///
/// @@ -11481,20 +12250,9 @@ 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 - #[serde(skip_serializing_if = "Option::is_none")] - pub mode: Option, -} +pub struct PermissionsPathsListRequest {} -/// Directory path whose entries should be listed from the client-provided session filesystem. +/// Indicates whether the operation succeeded. /// ///
/// @@ -11504,14 +12262,12 @@ 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 PermissionsPathsUpdatePrimaryResult { + /// Whether the operation succeeded + pub success: bool, } -/// Names of entries in the requested directory, or a filesystem error if the read failed. +/// No parameters; returns currently-pending permission requests for the session. /// ///
/// @@ -11521,15 +12277,9 @@ 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 PermissionsPendingRequestsRequest {} -/// Directory entry returned by session filesystem `readdirWithTypes`, with name and entry type. +/// Clears session-scoped tool permission approvals, and optionally the location-scoped ones. /// ///
/// @@ -11539,14 +12289,13 @@ 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 PermissionsResetSessionApprovalsRequest { + /// Whether location-scoped approvals are cleared too. Defaults to `true`. + #[serde(skip_serializing_if = "Option::is_none")] + pub include_location: Option, } -/// Directory path whose entries (with type information) should be listed from the client-provided session filesystem. +/// Indicates whether the operation succeeded. /// ///
/// @@ -11556,14 +12305,12 @@ 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 PermissionsResetSessionApprovalsResult { + /// Whether the operation succeeded + pub success: bool, } -/// Entries in the requested directory paired with file/directory type information, or a filesystem error if the read failed. +/// Allow-all toggle for tool permission requests, with an optional telemetry source. /// ///
/// @@ -11573,15 +12320,15 @@ 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 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 error: Option, + pub source: Option, } -/// Path of the file to read from the client-provided session filesystem. +/// Indicates whether the operation succeeded. /// ///
/// @@ -11591,14 +12338,12 @@ 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 PermissionsSetApproveAllResult { + /// Whether the operation succeeded + pub success: bool, } -/// File content as a UTF-8 string, or a filesystem error if the read failed. +/// Permission mode to apply for the session. /// ///
/// @@ -11608,15 +12353,18 @@ 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 PermissionsSetModeRequest { + /// Optional judge model id for assisted mode. When omitted, the session resolves the provider default: `gpt-5.5` for CAPI sessions and the active session model for BYOK sessions. #[serde(skip_serializing_if = "Option::is_none")] - pub error: Option, + pub assisted_approval_model: Option, + /// Permission mode to apply + pub mode: PermissionMode, + /// Optional source for permission-mode telemetry. Defaults to `rpc` when omitted for SDK callers. + #[serde(skip_serializing_if = "Option::is_none")] + pub source: Option, } -/// Source and destination paths for renaming or moving an entry in the client-provided session filesystem. +/// Indicates whether the requested permission mode was applied and reports the authoritative post-mutation mode. /// ///
/// @@ -11626,16 +12374,14 @@ 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 PermissionsSetModeResult { + /// Authoritative permission mode after the mutation + pub mode: PermissionMode, + /// Whether the operation succeeded + pub success: bool, } -/// Path to remove from the client-provided session filesystem, with options for recursive removal and force. +/// Toggles whether permission prompts should be bridged into session events for this client. /// ///
/// @@ -11645,20 +12391,12 @@ 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 - #[serde(skip_serializing_if = "Option::is_none")] - pub force: Option, +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, } -/// Optional capabilities declared by the provider +/// Indicates whether the operation succeeded. /// ///
/// @@ -11668,13 +12406,12 @@ pub struct SessionFsRmRequest { ///
#[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 PermissionsSetRequiredResult { + /// Whether the operation succeeded + pub success: bool, } -/// 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 operation succeeded. /// ///
/// @@ -11684,19 +12421,43 @@ pub struct SessionFsSetProviderCapabilities { ///
#[derive(Debug, Clone, Default, Serialize, Deserialize)] #[serde(rename_all = "camelCase")] -pub struct SessionFsSetProviderRequest { - /// Optional capabilities declared by the provider +pub struct PermissionsUrlsSetUnrestrictedModeResult { + /// Whether the operation succeeded + pub success: bool, +} + +/// Whether the URL-permission policy should run in unrestricted 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 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. +/// +///
+/// +/// **Experimental.** This type is part of an experimental wire-protocol surface +/// and may change or be removed in future SDK or CLI releases. +/// +///
+#[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 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 message: Option, } -/// Indicates whether the calling client was registered as the session filesystem provider. +/// Server liveness response, including the echoed message, current server timestamp, and protocol version. /// ///
/// @@ -11706,12 +12467,16 @@ pub struct SessionFsSetProviderRequest { ///
#[derive(Debug, Clone, Default, Serialize, Deserialize)] #[serde(rename_all = "camelCase")] -pub struct SessionFsSetProviderResult { - /// Whether the provider was set successfully - pub success: bool, +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, } -/// Indicates whether the per-session SQLite database already exists. +/// Existence, contents, and resolved path of the session plan file. /// ///
/// @@ -11721,12 +12486,16 @@ pub struct SessionFsSetProviderResult { ///
#[derive(Debug, Clone, Default, Serialize, Deserialize)] #[serde(rename_all = "camelCase")] -pub struct SessionFsSqliteExistsResult { - /// Whether the session database already exists +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, } -/// SQL query, query type, and optional bind parameters for executing a SQLite query against the per-session database. +/// 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. /// ///
/// @@ -11736,19 +12505,25 @@ 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 +pub struct PlanSqlTodosRow { + /// Todo creation time, as stored by the session SQL schema's `datetime('now')` default: `YYYY-MM-DD HH:MM:SS` in UTC. Lets clients attribute todos to the work item that created them (e.g. scoping a goal's progress to the todos it produced) rather than to the whole session. #[serde(skip_serializing_if = "Option::is_none")] - pub params: Option>, + pub created_at: Option, + /// 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, } -/// Query results including rows, columns, and rows affected, or a filesystem error if execution failed. +/// Todo rows read from the session SQL database. Empty when no session database is available. /// ///
/// @@ -11758,22 +12533,12 @@ 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. - #[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, +pub struct PlanReadSqlTodosResult { + /// Rows from the session SQL todos table, ordered by creation time with insertion order used to break ties when available and id used for WITHOUT ROWID tables. + pub rows: Vec, } -/// Path whose metadata should be returned from the client-provided session filesystem. +/// A single dependency edge read from the session SQL `todo_deps` table, indicating that one todo must complete before another. /// ///
/// @@ -11783,14 +12548,14 @@ 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 PlanSqlTodoDependency { + /// ID of the todo it depends on. + pub depends_on: String, + /// ID of the todo that has the dependency. + pub todo_id: String, } -/// Filesystem metadata for the requested path, or a filesystem error if the stat failed. +/// Todo rows + dependency edges read from the session SQL database. /// ///
/// @@ -11800,23 +12565,14 @@ 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. - #[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 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 with insertion order used to break ties when available and id used for WITHOUT ROWID tables. Empty when no database, no todos table, or the SELECT failed. + pub rows: Vec, } -/// File path, content to write, and optional mode for the client-provided session filesystem. +/// Replacement contents to write to the session plan file. /// ///
/// @@ -11826,19 +12582,12 @@ 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 struct PlanUpdateRequest { + /// The new content for the plan file pub content: String, - /// Optional POSIX-style mode for newly created files - #[serde(skip_serializing_if = "Option::is_none")] - pub mode: Option, } -/// Installed plugin record for a session, with marketplace, version, install time, enabled state, cache path, and source. +/// Session plugin metadata, with name, marketplace, optional version, and enabled state. /// ///
/// @@ -11848,28 +12597,19 @@ 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, +pub struct Plugin { /// 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) + /// Marketplace the plugin came from 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 + /// Installed version #[serde(skip_serializing_if = "Option::is_none")] pub version: Option, } -/// Source descriptor for a direct GitHub plugin install, with `owner/repo`, optional ref, and optional subpath. +/// Result of installing a plugin. /// ///
/// @@ -11879,17 +12619,20 @@ pub struct SessionInstalledPlugin { ///
#[derive(Debug, Clone, Default, Serialize, Deserialize)] #[serde(rename_all = "camelCase")] -pub struct SessionInstalledPluginSourceGitHub { +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 path: Option, + 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 r#ref: Option, - pub repo: String, - /// Constant value. Always "github". - pub source: SessionInstalledPluginSourceGitHubSource, + pub post_install_message: Option, + /// Number of skills discovered and installed from the plugin + pub skills_installed: i64, } -/// Source descriptor for a direct local plugin install, with a local filesystem path. +/// Plugins installed for the session, with their enabled state and version metadata. /// ///
/// @@ -11899,13 +12642,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 PluginList { + /// Installed plugins + pub plugins: Vec, } -/// Source descriptor for a direct URL plugin install, with URL, optional ref, and optional subpath. +/// Plugins installed in user/global state. /// ///
/// @@ -11915,17 +12657,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 PluginListResult { + /// Installed plugins + pub plugins: Vec, } -/// Sessions matching the filter, ordered most-recently-modified first. +/// Trusted built-in plugin directories to use for this runtime process. /// ///
/// @@ -11935,12 +12672,12 @@ pub struct SessionInstalledPluginSourceUrl { ///
#[derive(Debug, Clone, Default, Serialize, Deserialize)] #[serde(rename_all = "camelCase")] -pub struct SessionList { - /// Sessions ordered most-recently-modified first. Discriminated by `isRemote`. - pub sessions: Vec, +pub struct PluginsBuiltinSetRequest { + /// Complete replacement set of trusted built-in plugin directories. Every entry must be an absolute local filesystem path no longer than 4096 characters. + pub paths: Vec, } -/// Optional filter applied to the returned sessions +/// Plugin names (or specs) to disable. /// ///
/// @@ -11950,22 +12687,12 @@ pub struct SessionList { ///
#[derive(Debug, Clone, Default, Serialize, Deserialize)] #[serde(rename_all = "camelCase")] -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, +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, } -/// Queued repo-level startup prompts and the total hook command count after loading. +/// Plugin names (or specs) to enable. /// ///
/// @@ -11975,49 +12702,97 @@ 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 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, } -/// Public-facing projection of workspace metadata for SDK / TUI consumers +/// Plugin source and optional working directory for relative-path resolution. +/// +///
+/// +/// **Experimental.** This type is part of an experimental wire-protocol surface +/// 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 +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 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 + pub working_directory: Option, +} + +/// Marketplace source and optional working directory for relative-path resolution. +/// +///
+/// +/// **Experimental.** This type is part of an experimental wire-protocol surface +/// and may change or be removed in future SDK or CLI releases. +/// +///
+#[derive(Debug, Clone, Default, Serialize, Deserialize)] +#[serde(rename_all = "camelCase")] +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 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 + pub working_directory: Option, +} + +/// Name of the marketplace whose plugin catalog to fetch. +/// +///
+/// +/// **Experimental.** This type is part of an experimental wire-protocol surface +/// and may change or be removed in future SDK or CLI releases. +/// +///
+#[derive(Debug, Clone, Default, Serialize, Deserialize)] +#[serde(rename_all = "camelCase")] +pub struct PluginsMarketplacesBrowseRequest { + /// Marketplace name to browse + pub name: String, +} + +/// Optional marketplace name; omit to refresh all. +/// +///
+/// +/// **Experimental.** This type is part of an experimental wire-protocol surface +/// and may change or be removed in future SDK or CLI releases. +/// +///
+#[derive(Debug, Clone, Default, Serialize, Deserialize)] +#[serde(rename_all = "camelCase")] +pub struct PluginsMarketplacesRefreshRequest { + /// Marketplace name to refresh. When omitted, every registered marketplace is refreshed. #[serde(skip_serializing_if = "Option::is_none")] pub name: Option, - /// Repository identifier in 'owner/repo' or 'org/project/repo' format, if any +} + +/// Name of the marketplace to remove and an optional force 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 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 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, + pub force: Option, + /// Marketplace name to remove + pub name: String, } -/// Point-in-time snapshot of slow-changing session identifier and state fields +/// Optional flags controlling which side effects the reload performs. /// ///
/// @@ -12027,45 +12802,25 @@ 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). +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 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. + pub defer_repo_hooks: Option, + /// Re-run custom-agent discovery after refreshing plugins. Defaults to true. #[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. + 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 remote_metadata: Option, - /// Currently selected model identifier, if any + 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 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. + pub reload_hooks: Option, + /// Reload MCP server connections after refreshing plugins. Defaults to true. #[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 reload_mcp: Option, } -/// Cost-category metadata for a CAPI model. +/// Name (or spec) of the plugin to uninstall. /// ///
/// @@ -12075,12 +12830,15 @@ pub struct SessionMetadataSnapshot { ///
#[derive(Debug, Clone, Default, Serialize, Deserialize)] #[serde(rename_all = "camelCase")] -pub struct SessionModelPriceCategory { - pub id: String, - pub price_category: ModelPickerPriceCategory, +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 direct_source_id: Option, + /// Plugin name or "plugin@marketplace" spec to uninstall. When ambiguous, prefer the fully-qualified spec. + pub name: String, } -/// The list of models available to this session. +/// Name (or spec) of the plugin to update. /// ///
/// @@ -12090,18 +12848,12 @@ pub struct SessionModelPriceCategory { ///
#[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>, +pub struct PluginsUpdateRequest { + /// Plugin name or "plugin@marketplace" spec to update. + pub name: String, } -/// Source descriptor for a `sessions.open` content-exclusion rule, with source name and type. +/// Per-plugin result from updating all plugins, with versions, skills installed, success flag, and optional error. /// ///
/// @@ -12111,12 +12863,28 @@ pub struct SessionModelList { ///
#[derive(Debug, Clone, Default, Serialize, Deserialize)] #[serde(rename_all = "camelCase")] -pub struct SessionOpenOptionsAdditionalContentExclusionPolicyRuleSource { +pub struct PluginUpdateAllEntry { + /// Error message (failure only) + #[serde(skip_serializing_if = "Option::is_none")] + pub error: Option, + /// Marketplace the plugin came from. Empty string ("") for direct installs. + pub marketplace: String, + /// Plugin name that was updated pub name: String, - pub r#type: String, + /// Version after the update, when available + #[serde(skip_serializing_if = "Option::is_none")] + pub new_version: Option, + /// Previously installed version, when available + #[serde(skip_serializing_if = "Option::is_none")] + pub previous_version: Option, + /// Number of skills installed after the update (success only) + #[serde(skip_serializing_if = "Option::is_none")] + pub skills_installed: Option, + /// Whether the update succeeded for this plugin + pub success: bool, } -/// Single content-exclusion rule supplied to `sessions.open` options, with paths, match conditions, and source. +/// Result of updating all installed plugins. /// ///
/// @@ -12126,17 +12894,12 @@ pub struct SessionOpenOptionsAdditionalContentExclusionPolicyRuleSource { ///
#[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, +pub struct PluginUpdateAllResult { + /// Per-plugin update results in deterministic order. + pub results: Vec, } -/// Content-exclusion policy supplied to `sessions.open` options, with rules, last-updated data, and scope. +/// Result of updating a single plugin. /// ///
/// @@ -12146,15 +12909,18 @@ pub struct SessionOpenOptionsAdditionalContentExclusionPolicyRule { ///
#[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, +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, } -/// Session construction options. +/// Serializable definition of a caller-implemented tool whose execution is handled over the SDK connection. /// ///
/// @@ -12164,223 +12930,73 @@ pub struct SessionOpenOptionsAdditionalContentExclusionPolicy { ///
#[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. - /// - ///
+pub struct ProtocolExternalToolDefinition { + /// Tool-loading deferral policy. #[serde(skip_serializing_if = "Option::is_none")] - pub additional_content_exclusion_policies: - Option>, - /// Runtime context discriminator for agent filtering. + pub defer: Option, + /// Model-visible explanation of what the tool does. + pub description: String, + /// Whether the tool executes commands in a terminal. #[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>, - /// 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: 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. + pub is_terminal: Option, + /// Optional caller-defined metadata associated with the tool. #[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, - /// 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. + pub metadata: Option>, + /// Unique model-visible tool name. + pub name: String, + /// Whether this definition replaces a built-in tool with the same name. #[serde(skip_serializing_if = "Option::is_none")] - pub integration_id: Option, - /// Whether experimental behavior is enabled. + pub overrides_built_in_tool: Option, + /// JSON Schema describing the tool's input arguments. #[serde(skip_serializing_if = "Option::is_none")] - pub is_experimental_mode: Option, - /// Whether interactive shell sessions are logged. + pub parameters: Option>, + /// Whether execution bypasses the normal tool permission prompt. #[serde(skip_serializing_if = "Option::is_none")] - pub log_interactive_shells: Option, - /// Identifier sent to LSP-style integrations. + pub skip_permission: Option, + /// Optional human-readable display title. #[serde(skip_serializing_if = "Option::is_none")] - pub lsp_client_name: Option, - /// Maximum decoded byte size of a single inline model-facing binary tool result persisted in session events (default 10 MB). + pub title: Option, +} + +/// A BYOK model definition referencing a named 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 ProviderModelConfig { + /// Optional capability overrides (vision, tool_calls, reasoning, etc.). #[serde(skip_serializing_if = "Option::is_none")] - pub max_inline_binary_bytes: Option, - /// Memory configuration for this session. + 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 memory: Option, - /// Initial model identifier. + pub max_context_window_tokens: Option, + /// Maximum output tokens for the model. #[serde(skip_serializing_if = "Option::is_none")] - pub model: Option, - /// Initial model capability overrides. + pub max_output_tokens: Option, + /// Maximum prompt/input tokens for the model. #[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. - /// - ///
+ 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 models: Option>, - /// Optional human-friendly session name. + 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, - /// 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. - #[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, - /// Shell init profile. - #[serde(skip_serializing_if = "Option::is_none")] - pub shell_init_profile: Option, - /// Per-shell process flags. - #[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. + /// Name of the configured provider 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 working_directory_context: Option, + pub wire_model: Option, } -/// Parameters for creating a new local session. +/// BYOK providers and/or models to add to the session's registry at runtime. Both fields are optional; provide providers, models, or both. /// ///
/// @@ -12390,18 +13006,16 @@ pub struct SessionOpenOptions { ///
#[derive(Debug, Clone, Default, Serialize, Deserialize)] #[serde(rename_all = "camelCase")] -pub struct SessionsOpenCreate { - /// Whether to emit session.start during creation. Defaults to true. +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 emit_start: Option, - /// Create a new local session. - pub kind: SessionsOpenCreateKind, - /// Session construction options. + 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 options: Option, + pub providers: Option>, } -/// Parameters for resuming a specific local session. +/// The selectable model entries synthesized for the models added by this call. /// ///
/// @@ -12411,23 +13025,12 @@ pub struct SessionsOpenCreate { ///
#[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, +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, } -/// Parameters for resuming the most relevant local session. +/// Custom model-provider configuration (BYOK). /// ///
/// @@ -12437,38 +13040,57 @@ pub struct SessionsOpenResume { ///
#[derive(Debug, Clone, Default, Serialize, Deserialize)] #[serde(rename_all = "camelCase")] -pub struct SessionsOpenResumeLast { - /// Working-directory context used to choose the most relevant session. +pub struct ProviderConfig { + /// API key. Optional for local providers like Ollama. #[serde(skip_serializing_if = "Option::is_none")] - pub context: Option, - /// Resume the most relevant existing local session. - pub kind: SessionsOpenResumeLastKind, - /// Session resume options. + pub api_key: Option, + /// Azure-specific provider options. #[serde(skip_serializing_if = "Option::is_none")] - pub options: Option, - /// Suppress workspace.yaml metadata writeback when resuming from an incidental cwd. + 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 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, + 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>, + /// 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, + /// Overrides for model capabilities when they cannot be inferred from modelId. + #[serde(skip_serializing_if = "Option::is_none")] + pub model_capabilities: 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 name used for model and telemetry attribution. + #[serde(skip_serializing_if = "Option::is_none")] + pub provider_name: 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, } -/// Parameters for connecting to a live remote session. +/// 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. /// ///
/// @@ -12478,20 +13100,20 @@ pub struct SessionsOpenAttach { ///
#[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. +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 options: Option, - /// Remote session identifier to connect to. - pub remote_session_id: SessionId, - /// Repository context for the remote session. + 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 repository: Option, + pub model: Option, + /// The short-lived token value. + pub token: String, } -/// Parameters for creating a new cloud session. +/// A snapshot of the provider endpoint the session is currently configured to talk to. /// ///
/// @@ -12501,25 +13123,28 @@ pub struct SessionsOpenRemote { ///
#[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)] +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(crate) on_task_created: Option, - /// Session options for cloud session creation. + 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 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). + pub session_token: Option, + /// Transport to be used for provider requests. #[serde(skip_serializing_if = "Option::is_none")] - pub owner: Option, - /// Repository for the cloud session. + 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 repository: Option, + pub wire_api: Option, } -/// Parameters for fetching a remote session and handing it off to a new local session. +/// Optional model identifier to scope the endpoint snapshot to. /// ///
/// @@ -12529,28 +13154,13 @@ pub struct SessionsOpenCloud { ///
#[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). +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 task_type: Option, + pub model_id: Option, } -/// `sessions.open` handoff progress update with step, status, and optional message. +/// 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. /// ///
/// @@ -12560,17 +13170,14 @@ pub struct SessionsOpenHandoff { ///
#[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, +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 the configured provider name. + pub provider_name: String, } -/// Result of opening a session. +/// 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. /// ///
/// @@ -12580,31 +13187,12 @@ pub struct SessionsOpenProgress { ///
#[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, +pub struct ProviderTokenAcquireResult { + /// The bearer token value (without the `Bearer ` prefix). + pub token: String, } -/// Outcome of the prune operation: deleted IDs, dry-run candidates, skipped IDs, total bytes freed, and the dry-run flag. +/// Blob attachment with inline base64-encoded data /// ///
/// @@ -12614,20 +13202,19 @@ pub struct SessionOpenResult { ///
#[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 PushAttachmentBlob { + /// Base64-encoded content + pub data: String, + /// 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, + /// Attachment type discriminator + pub r#type: PushAttachmentBlobType, } -/// Session IDs to close, deactivate, and delete from disk. +/// Directory attachment /// ///
/// @@ -12637,12 +13224,16 @@ 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 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, } -/// Session IDs to test for live in-use locks. +/// Optional line range to scope the attachment to a specific section of the file /// ///
/// @@ -12652,12 +13243,14 @@ 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 PushAttachmentFileLineRange { + /// End line number (1-based, inclusive) + pub end: i64, + /// Start line number (1-based) + pub start: i64, } -/// Session IDs from the input set that are currently in use by another process. +/// File attachment /// ///
/// @@ -12667,12 +13260,19 @@ 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 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, } -/// Session ID to close. +/// Pointer to a GitHub repository. /// ///
/// @@ -12682,12 +13282,17 @@ 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 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, } -/// 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. +/// Pointer to a GitHub Actions job. /// ///
/// @@ -12697,24 +13302,48 @@ pub struct SessionsCloseRequest { ///
#[derive(Debug, Clone, Default, Serialize, Deserialize)] #[serde(rename_all = "camelCase")] -pub struct SessionsCloseResult {} - -/// Session metadata records to enrich with summary and context information. -/// -///
-/// +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, +} + +/// Pointer to a GitHub commit. +/// +///
+/// /// **Experimental.** This type is part of an experimental wire-protocol surface /// 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, +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, } -/// New auth credentials to install on the session. Omit to leave credentials unchanged. +/// Pointer to a file in a GitHub repository at a specific ref. /// ///
/// @@ -12724,13 +13353,20 @@ 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 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, +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, } -/// Indicates whether the credential update succeeded. +/// One side of a file diff (head or base) /// ///
/// @@ -12740,15 +13376,16 @@ pub struct SessionSetCredentialsParams { ///
#[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, +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, } -/// Availability of built-in job tools surfaced to boundary consumers. +/// Pointer to a single-file diff. At least one of `head` and `base` must be present. /// ///
/// @@ -12758,14 +13395,20 @@ pub struct SessionSetCredentialsResult { ///
#[derive(Debug, Clone, Default, Serialize, Deserialize)] #[serde(rename_all = "camelCase")] -pub struct SessionSettingsBuiltInToolAvailabilitySnapshot { +pub struct PushAttachmentGitHubFileDiff { + /// File location on the base side of the diff. Absent for additions. #[serde(skip_serializing_if = "Option::is_none")] - pub create_pull_request: Option, + pub base: Option, + /// File location on the head side of the diff. Absent for deletions. #[serde(skip_serializing_if = "Option::is_none")] - pub report_progress: 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, } -/// Named Rust-owned settings predicate to evaluate for this session. +/// GitHub issue, pull request, or discussion reference /// ///
/// @@ -12775,15 +13418,22 @@ pub struct SessionSettingsBuiltInToolAvailabilitySnapshot { ///
#[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, +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, } -/// Result of evaluating a Rust-owned settings predicate. +/// Pointer to a GitHub release. /// ///
/// @@ -12793,11 +13443,20 @@ pub struct SessionSettingsEvaluatePredicateRequest { ///
#[derive(Debug, Clone, Default, Serialize, Deserialize)] #[serde(rename_all = "camelCase")] -pub struct SessionSettingsEvaluatePredicateResult { - pub enabled: bool, +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, } -/// Redacted job settings for a session. The job nonce is excluded. +/// Pointer to a GitHub repository. /// ///
/// @@ -12807,16 +13466,22 @@ pub struct SessionSettingsEvaluatePredicateResult { ///
#[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, +pub struct PushAttachmentGitHubRepository { + /// Short description of the repository #[serde(skip_serializing_if = "Option::is_none")] - pub event_type: Option, + 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 is_trigger_job: Option, + 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, } -/// Redacted model routing settings for a session. +/// Pointer to a line range inside a file in a GitHub repository. /// ///
/// @@ -12826,18 +13491,22 @@ pub struct SessionSettingsJobSnapshot { ///
#[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, +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, } -/// Online-evaluation settings safe to expose across the SDK boundary. +/// One side of a tree comparison (head or base) /// ///
/// @@ -12847,14 +13516,14 @@ pub struct SessionSettingsModelSnapshot { ///
#[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, +pub struct PushAttachmentGitHubTreeComparisonSide { + /// Repository the revision belongs to + pub repo: PushGitHubRepoRef, + /// Git revision (branch, tag, or commit SHA) + pub revision: String, } -/// Redacted repository and GitHub host settings for a session. +/// Pointer to a comparison between two git revisions. /// ///
/// @@ -12864,34 +13533,18 @@ pub struct SessionSettingsOnlineEvaluationSnapshot { ///
#[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, +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, } -/// Redacted validation and memory-tool settings for a session. +/// Generic GitHub URL reference. /// ///
/// @@ -12901,28 +13554,14 @@ pub struct SessionSettingsRepoSnapshot { ///
#[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, +pub struct PushAttachmentGitHubUrl { + /// Attachment type discriminator + pub r#type: PushAttachmentGitHubUrlType, + /// URL to the GitHub resource + pub url: String, } -/// Redacted, serializable view of session runtime settings for SDK boundary consumers. Secrets and raw feature flags are intentionally excluded. +/// End position of the selection /// ///
/// @@ -12932,23 +13571,14 @@ pub struct SessionSettingsValidationSnapshot { ///
#[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, +pub struct PushAttachmentSelectionDetailsEnd { + /// End character offset within the line (0-based) + pub character: i64, + /// End line number (0-based) + pub line: i64, } -/// UUID prefix to resolve to a unique session ID. +/// Start position of the selection /// ///
/// @@ -12958,12 +13588,14 @@ pub struct SessionSettingsSnapshot { ///
#[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 PushAttachmentSelectionDetailsStart { + /// Start character offset within the line (0-based) + pub character: i64, + /// Start line number (0-based) + pub line: i64, } -/// Session ID matching the prefix, omitted when no unique match exists. +/// Position range of the selection within the file /// ///
/// @@ -12973,13 +13605,14 @@ 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) - #[serde(skip_serializing_if = "Option::is_none")] - pub session_id: Option, +pub struct PushAttachmentSelectionDetails { + /// End position of the selection + pub end: PushAttachmentSelectionDetailsEnd, + /// Start position of the selection + pub start: PushAttachmentSelectionDetailsStart, } -/// GitHub task ID to look up. +/// Code selection attachment from an editor /// ///
/// @@ -12989,12 +13622,20 @@ 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, +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, } -/// ID of the local session bound to the given GitHub task, or omitted when none. +/// Inputs for starting a deferred-idle drain. /// ///
/// @@ -13004,13 +13645,12 @@ pub struct SessionsFindByTaskIDRequest { ///
#[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 QueueBeginDeferredIdleDrainRequest { + /// Whether the host still has active background work. + pub active_background_work: bool, } -/// Source session identifier to fork from, optional event-ID boundary, and optional friendly name for the new session. +/// Whether a deferred-idle drain should run. /// ///
/// @@ -13020,18 +13660,12 @@ 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. - #[serde(skip_serializing_if = "Option::is_none")] - pub to_event_id: Option, +pub struct QueueBeginDeferredIdleDrainResult { + /// True when the host should run finishDeferredIdleDrain asynchronously. + pub should_drain: bool, } -/// Identifier and optional friendly name assigned to the newly forked session. +/// Internal filter for consuming queued system notifications. /// ///
/// @@ -13041,15 +13675,12 @@ 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. - #[serde(skip_serializing_if = "Option::is_none")] - pub name: Option, - /// The new forked session's ID - pub session_id: SessionId, +pub struct QueueConsumeSystemNotificationsRequest { + /// Opaque runtime-owned filter object. + pub filter: serde_json::Value, } -/// Session ID whose board entry count should be returned. +/// Queued-command response indicating the host executed the command, with an optional flag to stop queue processing. /// ///
/// @@ -13059,12 +13690,15 @@ pub struct SessionsForkResult { ///
#[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, +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, } -/// Dynamic-context board entry count, when available. +/// Queued-command response indicating the host did not execute the command and the queue may continue. /// ///
/// @@ -13074,13 +13708,12 @@ pub struct SessionsGetBoardEntryCountRequest { ///
#[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, +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, } -/// Session ID whose event-log file path to compute. +/// Inputs for marking session.idle deferred in native state. /// ///
/// @@ -13090,12 +13723,12 @@ pub struct SessionsGetBoardEntryCountResult { ///
#[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 QueueDeferSessionIdleRequest { + /// Whether the deferred idle was caused by an aborted foreground turn. + pub aborted: bool, } -/// Absolute path to the session's events.jsonl file on disk. +/// Parameters for duplicating a queued item. /// ///
/// @@ -13105,12 +13738,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 QueueDuplicateAtRequest { + /// Stable opaque ID of the queued item to duplicate. + pub id: String, } -/// Optional working-directory context used to score session relevance. +/// Result of duplicating a queued item. /// ///
/// @@ -13120,13 +13753,12 @@ 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. - #[serde(skip_serializing_if = "Option::is_none")] - pub context: Option, +pub struct QueueDuplicateAtResult { + /// Fresh stable opaque id assigned to the duplicate. + pub id: String, } -/// Most-relevant session ID for the supplied context, or omitted when no sessions exist. +/// Result of enqueueing the resume-pending wake item. /// ///
/// @@ -13136,13 +13768,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 QueueEnqueueResumePendingResult { + /// True when a wake item was newly queued. + pub queued: bool, } -/// Session ID to look up the persisted remote-steerable flag for. +/// Inputs for completing a deferred-idle drain. /// ///
/// @@ -13152,12 +13783,14 @@ 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 QueueFinishDeferredIdleDrainRequest { + /// Whether the host still has active background work. + pub active_background_work: bool, + /// Whether native queued work remains. + pub has_pending: bool, } -/// The session's persisted remote-steerable flag, or omitted when no value has been persisted. +/// Action selected by the native deferred-idle drain. /// ///
/// @@ -13167,13 +13800,14 @@ 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 - #[serde(skip_serializing_if = "Option::is_none")] - pub remote_steerable: Option, +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, } -/// Map of sessionId -> on-disk size in bytes for each session's workspace directory. +/// Whether the native queue has pending work. /// ///
/// @@ -13183,12 +13817,12 @@ 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 QueueHasPendingResult { + /// True when queued or immediate native work is pending. + pub has_pending: bool, } -/// Optional source filter, metadata-load limit, and context filter applied to the returned sessions. +/// Serializable message fields accepted by queue.insertAt. /// ///
/// @@ -13198,25 +13832,45 @@ pub struct SessionSizes { ///
#[derive(Debug, Clone, Default, Serialize, Deserialize)] #[serde(rename_all = "camelCase")] -pub struct SessionsListRequest { - /// Optional filter applied to the returned sessions +pub struct QueueInsertMessage { + /// Optional explicit agent mode. When omitted, the session's current mode is assigned. #[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 agent_mode: Option, + /// Optional attachments for the message. #[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). + pub attachments: Option>, + /// Whether the message is billable. #[serde(skip_serializing_if = "Option::is_none")] - pub metadata_limit: Option, - /// Which session sources to include. Defaults to `local` for backward compatibility. + 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 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. + pub delivery: Option, + /// Optional user-facing display text. #[serde(skip_serializing_if = "Option::is_none")] - pub throw_on_error: Option, + 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, } -/// Active session ID whose deferred repo-level hooks should be loaded. +/// Parameters for inserting a queued message at a public visible position. /// ///
/// @@ -13226,12 +13880,14 @@ 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 QueueInsertAtRequest { + /// Queued message contents and delivery metadata. + pub message: QueueInsertMessage, + /// Zero-based position in the public visible queue. Values outside the queue clamp to an end. + pub position: i64, } -/// Age threshold and optional flags controlling which old sessions are pruned (or simulated when dryRun is true). +/// Result of inserting a queued message. /// ///
/// @@ -13241,21 +13897,12 @@ 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 - #[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 struct QueueInsertAtResult { + /// Fresh stable opaque id assigned to the inserted item. + pub id: String, } -/// Session ID whose in-use lock should be released. +/// Parameters for moving a queued item by stable id. /// ///
/// @@ -13265,12 +13912,14 @@ 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 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, } -/// 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 moving a queued item. /// ///
/// @@ -13280,9 +13929,12 @@ pub struct SessionsReleaseLockRequest { ///
#[derive(Debug, Clone, Default, Serialize, Deserialize)] #[serde(rename_all = "camelCase")] -pub struct SessionsReleaseLockResult {} +pub struct QueueMoveItemResult { + /// True when the item changed position; false when it was already at the requested position. + pub changed: bool, +} -/// Active session ID and an optional flag for deferring repo-level hooks until folder trust. +/// User-facing pending queue entry, with kind and display text for a queued message, slash command, or model change. /// ///
/// @@ -13292,15 +13944,18 @@ 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 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, } -/// 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. +/// Snapshot of the session's pending queued items and immediate-steering messages. /// ///
/// @@ -13310,9 +13965,17 @@ pub struct SessionsReloadPluginHooksRequest { ///
#[derive(Debug, Clone, Default, Serialize, Deserialize)] #[serde(rename_all = "camelCase")] -pub struct SessionsReloadPluginHooksResult {} +pub struct QueuePendingItemsResult { + /// How many leading entries of `steeringMessages` have already been folded into the running turn (and so have an emitted `user.message`), as opposed to still waiting for one. Absent for hosts that do not distinguish the two. + #[serde(skip_serializing_if = "Option::is_none")] + pub in_flight_steering_count: Option, + /// 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, +} -/// Session ID whose pending events should be flushed to disk. +/// Parameters for removing a queued item by stable id. /// ///
/// @@ -13322,12 +13985,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 QueueRemoveAtRequest { + /// Stable opaque ID of the queued item to remove. + pub id: String, } -/// Flush a session's pending events to disk. No-op when no writer exists for the session (e.g., already closed). +/// Result of removing a queued item. /// ///
/// @@ -13337,9 +14000,12 @@ pub struct SessionsSaveRequest { ///
#[derive(Debug, Clone, Default, Serialize, Deserialize)] #[serde(rename_all = "camelCase")] -pub struct SessionsSaveResult {} +pub struct QueueRemoveAtResult { + /// True when the addressed item was removed. + pub removed: bool, +} -/// Manager-wide additional plugins to register; replaces any previously-configured set. +/// Indicates whether a user-facing pending item was removed. /// ///
/// @@ -13349,12 +14015,12 @@ 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 QueueRemoveMostRecentResult { + /// True if a user-facing pending item was removed (LIFO across both queues); false when no removable items remained. + pub removed: bool, } -/// 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. +/// Parameters for steering a queued message into a live turn. /// ///
/// @@ -13364,9 +14030,12 @@ pub struct SessionsSetAdditionalPluginsRequest { ///
#[derive(Debug, Clone, Default, Serialize, Deserialize)] #[serde(rename_all = "camelCase")] -pub struct SessionsSetAdditionalPluginsResult {} +pub struct QueueSendNowRequest { + /// Stable opaque ID of the queued item to steer into the live turn. + pub id: String, +} -/// Patch for the singleton's steering state. +/// Result of trying to steer a queued message into a live turn. /// ///
/// @@ -13376,12 +14045,12 @@ pub struct SessionsSetAdditionalPluginsResult {} ///
#[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, +pub struct QueueSendNowResult { + /// True when the item was accepted into the steering lane; false when no main turn was live. + pub steered: bool, } -/// Parameters for attaching the remote-control singleton to a session. +/// 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. /// ///
/// @@ -13391,14 +14060,12 @@ pub struct SessionsSetRemoteControlSteeringRequest { ///
#[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, +pub struct QueueSetDrainPausedRequest { + /// Whether queued-lane draining should be paused. + pub paused: bool, } -/// Parameters for stopping the remote-control singleton. +/// Internal snapshot of native queue state for local session orchestration. /// ///
/// @@ -13408,16 +14075,20 @@ pub struct SessionsStartRemoteControlRequest { ///
#[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). +pub struct QueueSnapshotResult { + /// Insertion orders for queued items, aligned with `items`. #[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`. + 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 force: Option, + pub steering_message_orders: Option>, + /// Immediate steering messages waiting for an active turn. + pub steering_messages: Vec, } -/// Parameters for atomically rebinding the remote-control singleton. +/// Parameters for editing a single queued message. /// ///
/// @@ -13427,15 +14098,17 @@ pub struct SessionsStopRemoteControlRequest { ///
#[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). +pub struct QueueUpdateTextRequest { + /// Optional replacement prompt displayed to the user. #[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, + pub display_prompt: Option, + /// Stable opaque ID of the queued item to edit. + pub id: String, + /// Replacement prompt sent to the model. + pub prompt: String, } -/// Telemetry engagement ID for the session, when available. +/// Result of editing a queued message. /// ///
/// @@ -13445,13 +14118,12 @@ pub struct SessionsTransferRemoteControlRequest { ///
#[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, +pub struct QueueUpdateTextResult { + /// True when the stored text changed. + pub updated: bool, } -/// Patch of mutable session options to apply to the running session. +/// Event type to register consumer interest for, used by runtime gating logic. /// ///
/// @@ -13461,183 +14133,12 @@ pub struct SessionTelemetryEngagement { ///
#[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` 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, - /// 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 (model-defined enum). - #[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, - /// 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, - /// 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, +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, } -/// Indicates whether the session options patch was applied successfully. +/// Opaque handle representing an event-type interest registration. /// ///
/// @@ -13647,15 +14148,12 @@ pub struct SessionUpdateOptionsParams { ///
#[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, +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, } -/// User-requested shell execution cancellation handle. +/// Optional registration options. /// ///
/// @@ -13665,12 +14163,14 @@ pub struct SessionUpdateOptionsResult { ///
#[derive(Debug, Clone, Default, Serialize, Deserialize)] #[serde(rename_all = "camelCase")] -pub struct ShellCancelUserRequestedRequest { - /// Request ID previously passed to executeUserRequested - pub request_id: RequestId, +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, } -/// Shell command to run, with optional working directory and timeout in milliseconds. +/// Params to attach an extension loader's tools to a session. /// ///
/// @@ -13680,18 +14180,18 @@ pub struct ShellCancelUserRequestedRequest { ///
#[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(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 timeout: Option, + pub options: Option, + /// Session to register extension tools on. + pub session_id: SessionId, } -/// Identifier of the spawned process, used to correlate streamed output and exit notifications. +/// Handle for releasing the extension tool registration. /// ///
/// @@ -13701,12 +14201,13 @@ 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(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, } -/// User-requested shell command and cancellation handle. +/// Opaque handle previously returned by `registerInterest` to release. /// ///
/// @@ -13716,14 +14217,12 @@ pub struct ShellExecResult { ///
#[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, +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, } -/// Identifier of a process previously returned by "shell.exec" and the signal to send. +/// Reattach to an existing MC session without creating a new one. /// ///
/// @@ -13733,15 +14232,14 @@ pub struct ShellExecuteUserRequestedRequest { ///
#[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 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, } -/// Indicates whether the signal was delivered; false if the process was unknown or already exited. +/// Configuration for the runtime-managed remote-control singleton. /// ///
/// @@ -13751,12 +14249,24 @@ 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 RemoteControlConfig { + /// Reattach to an existing MC session without creating a new one. + #[serde(skip_serializing_if = "Option::is_none")] + 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 task_id: Option, } -/// Parameters for shutting down the session +/// Remote control is connected to a local session. /// ///
/// @@ -13766,16 +14276,27 @@ 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'. +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 reason: Option, - /// Why the session is being shut down. Defaults to "routine" when omitted. + pub(crate) awaiting_first_message: Option, + /// MC frontend URL for this session, when known. #[serde(skip_serializing_if = "Option::is_none")] - pub r#type: Option, + 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. Retained as an optional compatibility field; native remote control does not populate or consume it. + #[doc(hidden)] + #[serde(skip_serializing_if = "Option::is_none")] + pub(crate) prompt_manager: Option, + /// Remote control state tag: active. + pub state: RemoteControlStatusActiveState, } -/// Skill metadata available to a session, with name, description, source, enabled/invocable state, path, plugin, and argument hint. +/// Remote control is in the middle of initial setup. /// ///
/// @@ -13785,29 +14306,14 @@ pub struct ShutdownRequest { ///
#[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, - /// 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 RemoteControlStatusConnecting { + /// Session id the connection is attaching to. + pub attached_session_id: String, + /// Remote control state tag: connecting. + pub state: RemoteControlStatusConnectingState, } -/// Canonical directory where skills can be discovered or created, with scope, preference, and optional project path. +/// The last setup attempt failed. The singleton is otherwise off. /// ///
/// @@ -13817,19 +14323,17 @@ pub struct Skill { ///
#[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) +pub struct RemoteControlStatusError { + /// Session id the failing setup attempt targeted, when known. #[serde(skip_serializing_if = "Option::is_none")] - pub project_path: Option, - /// Which tier this directory belongs to - pub scope: SkillDiscoveryScope, + 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, } -/// Canonical locations where skills can be created so the runtime will recognize them. +/// Remote control is not connected. /// ///
/// @@ -13839,12 +14343,12 @@ pub struct SkillDiscoveryPath { ///
#[derive(Debug, Clone, Default, Serialize, Deserialize)] #[serde(rename_all = "camelCase")] -pub struct SkillDiscoveryPathList { - /// Canonical skill create/discovery directories, in priority order - pub paths: Vec, +pub struct RemoteControlStatusOff { + /// Remote control state tag: not connected. + pub state: RemoteControlStatusOffState, } -/// Skills available to the session, with their enabled state. +/// Wrapper for the singleton's current status. /// ///
/// @@ -13854,12 +14358,12 @@ pub struct SkillDiscoveryPathList { ///
#[derive(Debug, Clone, Default, Serialize, Deserialize)] #[serde(rename_all = "camelCase")] -pub struct SkillList { - /// Available skills - pub skills: Vec, +pub struct RemoteControlStatusResult { + /// State of the runtime-managed remote-control singleton. + pub status: serde_json::Value, } -/// Skill names to mark as disabled in global configuration, replacing any previous list. +/// Outcome of a stopRemoteControl call. /// ///
/// @@ -13869,12 +14373,14 @@ pub struct SkillList { ///
#[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 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, } -/// Name of the skill to disable for the session. +/// Outcome of a transferRemoteControl call. /// ///
/// @@ -13884,12 +14390,14 @@ 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, +pub struct RemoteControlTransferResult { + /// State of the runtime-managed remote-control singleton. + pub status: serde_json::Value, + /// Whether the rebinding actually happened. + pub transferred: bool, } -/// Optional project paths and additional skill directories to include in discovery. +/// Optional remote session mode ("off", "export", or "on"); defaults to enabling both export and remote steering. /// ///
/// @@ -13899,19 +14407,13 @@ pub struct SkillsDisableRequest { ///
#[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 +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 skill_directories: Option>, + pub mode: Option, } -/// Name of the skill to enable for the session. +/// GitHub URL for the session and a flag indicating whether remote steering is enabled. /// ///
/// @@ -13921,12 +14423,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 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, } -/// Optional project paths to enumerate. +/// New remote-steerability state to persist as a `session.remote_steerable_changed` event. /// ///
/// @@ -13936,16 +14441,12 @@ pub struct SkillsEnableRequest { ///
#[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>, +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, } -/// Skill invocation record with name, path, content, allowed tools, and turn number. +/// 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. /// ///
/// @@ -13955,21 +14456,9 @@ pub struct SkillsGetDiscoveryPathsRequest { ///
#[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 RemoteNotifySteerableChangedResult {} -/// Skills invoked during this session, ordered by invocation time (most recent last). +/// Remote session connection result. /// ///
/// @@ -13979,12 +14468,14 @@ 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 RemoteSessionConnectionResult { + /// Metadata for a connected remote session. + pub metadata: ConnectedRemoteSessionMetadata, + /// SDK session ID for the connected remote session. + pub session_id: SessionId, } -/// Diagnostics from reloading skill definitions, with warnings and errors as separate lists. +/// GitHub repository the remote session belongs to. /// ///
/// @@ -13994,14 +14485,16 @@ 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 RemoteSessionMetadataRepository { + /// Branch associated with the remote session. + pub branch: String, + /// Repository name. + pub name: String, + /// Repository owner. + pub owner: String, } -/// Slash-command invocation result that submits an agent prompt, with display prompt, optional mode, optional user-facing notice, and settings-change flag. +/// Remote session metadata for the session to hand off (typically obtained from `sessions.list` with `source: "remote"`). /// ///
/// @@ -14011,25 +14504,52 @@ 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 +pub struct RemoteSessionMetadataValue { + /// Most recent working directory context. #[serde(skip_serializing_if = "Option::is_none")] - pub mode: Option, - /// Optional user-facing notice to show before the prompt is submitted + pub context: Option, + /// Host-supplied human description of what the session is doing right now ("running tests", "waiting for approval"). Optional in the protocol and absent on hosts that do not publish it, so never rely on it -- it enriches `hostStatus`, it does not replace it. #[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 + pub host_activity: Option, + /// Live status as the owning host reports it in its session listing, so a row for a session running elsewhere can show that it is running. Absent for hosts that publish no such status (the cloud task managers), which read as idle. #[serde(skip_serializing_if = "Option::is_none")] - pub runtime_settings_changed: Option, + pub host_status: 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, } -/// Slash-command invocation result indicating completion, with optional message and settings-change flag. +/// Repository context for the remote session. /// ///
/// @@ -14039,18 +14559,17 @@ 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 +pub struct RemoteSessionRepository { + /// Optional branch associated with the remote session. #[serde(skip_serializing_if = "Option::is_none")] - pub runtime_settings_changed: Option, + pub branch: Option, + /// Repository name. + pub name: String, + /// Repository owner or organization login. + pub owner: String, } -/// Slash-command invocation result containing text output plus Markdown/ANSI rendering flags. +/// Credential-injection capability flags applied while the sandbox is enabled. For the same capability independent of sandboxing, and matched to the credential's GitHub host, see `shell.credentials`; the two are additive. /// ///
/// @@ -14060,23 +14579,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 +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 markdown: Option, - /// Whether ANSI sequences should be preserved + 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 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 git: Option, } -/// Selectable slash-command subcommand option with name, description, and optional group label. +/// macOS seatbelt experimental options. /// ///
/// @@ -14086,17 +14598,13 @@ 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 +pub struct SandboxConfigUserPolicyExperimentalSeatbelt { + /// Whether the macOS seatbelt profile may access the keychain. #[serde(skip_serializing_if = "Option::is_none")] - pub group: Option, - /// Subcommand name to invoke - pub name: String, + pub keychain_access: Option, } -/// Slash-command invocation result asking the client to present subcommand options for a parent command. +/// Platform-specific experimental policy fields. /// ///
/// @@ -14106,21 +14614,13 @@ 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 +pub struct SandboxConfigUserPolicyExperimental { + /// macOS seatbelt experimental options. #[serde(skip_serializing_if = "Option::is_none")] - pub runtime_settings_changed: Option, - /// Human-readable title for the selection UI - pub title: String, + pub seatbelt: Option, } -/// Subagent model, reasoning effort, and context tier settings +/// Filesystem rules to merge into the base policy. /// ///
/// @@ -14130,19 +14630,22 @@ pub struct SlashCommandSelectSubcommandResult { ///
#[derive(Debug, Clone, Default, Serialize, Deserialize)] #[serde(rename_all = "camelCase")] -pub struct SubagentSettingsEntry { - /// Context tier override for matching subagents +pub struct SandboxConfigUserPolicyFilesystem { + /// Whether to clear the policy when the session exits. #[serde(skip_serializing_if = "Option::is_none")] - pub context_tier: Option, - /// Reasoning effort override for matching subagents + pub clear_policy_on_exit: Option, + /// Paths explicitly denied. #[serde(skip_serializing_if = "Option::is_none")] - pub effort_level: Option, - /// Model override for matching subagents + pub denied_paths: Option>, + /// Paths granted read-only access. #[serde(skip_serializing_if = "Option::is_none")] - pub model: Option, + pub readonly_paths: Option>, + /// Paths granted read/write access. + #[serde(skip_serializing_if = "Option::is_none")] + pub readwrite_paths: Option>, } -/// Subagent settings to apply, or null to clear the live session override +/// HTTP proxy configuration for sandboxed traffic. /// ///
/// @@ -14152,22 +14655,18 @@ pub struct SubagentSettingsEntry { ///
#[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 +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 max_concurrency: Option, - /// Maximum subagent nesting depth; applies to usage-based billing users only + 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 max_depth: Option, + pub username: Option, } -/// Tracked background agent task metadata, including IDs, status, timing, agent type, prompt, model, result, and latest response. +/// Network rules to merge into the base policy. /// ///
/// @@ -14177,59 +14676,60 @@ pub struct SubagentSettings { ///
#[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 +pub struct SandboxConfigUserPolicyNetwork { + /// Whether traffic to local/loopback addresses is allowed. #[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 + pub allow_local_network: Option, + /// Whether outbound network traffic is allowed at all. #[serde(skip_serializing_if = "Option::is_none")] - pub error: Option, - /// Whether task execution is synchronously awaited or managed in the background + 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 execution_mode: Option, - /// Unique task identifier - pub id: String, - /// ISO 8601 timestamp when the agent entered idle state + pub proxy: Option, +} + +/// macOS seatbelt-specific options. +/// +///
+/// +/// **Experimental.** This type is part of an experimental wire-protocol surface +/// and may change or be removed in future SDK or CLI releases. +/// +///
+#[derive(Debug, Clone, Default, Serialize, Deserialize)] +#[serde(rename_all = "camelCase")] +pub struct SandboxConfigUserPolicySeatbelt { + /// Whether the macOS seatbelt profile may access the keychain. #[serde(skip_serializing_if = "Option::is_none")] - pub idle_since: Option, - /// Most recent response text from the agent + pub keychain_access: Option, +} + +/// User-managed sandbox policy fragment merged into the auto-discovered base policy. +/// +///
+/// +/// **Experimental.** This type is part of an experimental wire-protocol surface +/// and may change or be removed in future SDK or CLI releases. +/// +///
+#[derive(Debug, Clone, Default, Serialize, Deserialize)] +#[serde(rename_all = "camelCase")] +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 latest_response: Option, - /// Requested model override for the task when specified + pub experimental: Option, + /// Filesystem rules to merge into the base policy. #[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 + pub filesystem: Option, + /// Network rules to merge into the base policy. #[serde(skip_serializing_if = "Option::is_none")] - pub resolved_model: Option, - /// Result text from the task when available + pub network: Option, + /// macOS seatbelt options to merge into the base policy. #[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 seatbelt: Option, } -/// Timestamped display line for task progress output or recent agent activity. +/// Resolved sandbox configuration. /// ///
/// @@ -14239,14 +14739,24 @@ 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 SandboxConfig { + /// Whether to auto-add the current working directory to readwritePaths. Default: true. + #[serde(skip_serializing_if = "Option::is_none")] + pub add_current_working_directory: Option, + /// Whether to auto-grant read access to tool directories discovered on PATH and in toolchain environment variables (GOROOT, JAVA_HOME, VIRTUAL_ENV, and similar), and to common developer-tool caches, config, and toolchains. Writable grants cover scratch caches, the Unix GitHub CLI cache, and Cargo's registry, git store, and lock/tracker files. A relocated CARGO_HOME gets the same narrow split: registry and git are read-write; bin is read-only; the home root, config.toml, and credentials.toml stay ungranted. Set to false to disable every grant listed above; user-installed toolchains and caches then need explicit userPolicy.filesystem readonlyPaths and readwritePaths entries. The working directory (see addCurrentWorkingDirectory), temporary storage, session log paths, and system locations follow their own rules and stay granted. 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, } -/// Progress snapshot for an agent task, with recent activity lines and optional latest intent. +/// Register an absolute-time scheduled prompt. /// ///
/// @@ -14256,17 +14766,20 @@ 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 ScheduleAddAtRequest { + /// Epoch milliseconds when the prompt should fire. + pub at: i64, + /// Optional display-only prompt label. #[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 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, } -/// Background tasks currently tracked by the session. +/// Register a cron scheduled prompt. /// ///
/// @@ -14276,12 +14789,23 @@ pub struct TaskAgentProgress { ///
#[derive(Debug, Clone, Default, Serialize, Deserialize)] #[serde(rename_all = "camelCase")] -pub struct TaskList { - /// Currently tracked tasks - pub tasks: Vec, +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, } -/// Identifier of the background task to cancel. +/// Register a relative-interval scheduled prompt. /// ///
/// @@ -14291,12 +14815,20 @@ pub struct TaskList { ///
#[derive(Debug, Clone, Default, Serialize, Deserialize)] #[serde(rename_all = "camelCase")] -pub struct TasksCancelRequest { - /// Task identifier - pub id: String, +pub struct ScheduleAddRequest { + /// Optional display-only prompt label. + #[serde(skip_serializing_if = "Option::is_none")] + 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 background task was successfully cancelled. +/// Scheduled prompt entry with ID, timing (`intervalMs`, `cron`, or `at`), prompt text, recurrence, and next run time. /// ///
/// @@ -14306,12 +14838,36 @@ 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 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, } -/// The first sync-waiting task that can currently be promoted to background mode. +/// Result of registering or re-arming a scheduled prompt. /// ///
/// @@ -14321,13 +14877,16 @@ 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 ScheduleAddResult { + /// The registered or updated schedule entry. #[serde(skip_serializing_if = "Option::is_none")] - pub task: Option, + pub entry: Option, + /// User-facing validation error, when registration failed. + #[serde(skip_serializing_if = "Option::is_none")] + pub error: Option, } -/// Identifier of the background task to fetch progress for. +/// Register a self-paced scheduled prompt. /// ///
/// @@ -14337,12 +14896,15 @@ 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 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, } -/// Progress information for the task, or null when no task with that ID is tracked. +/// Whether the session currently has an active self-paced schedule. /// ///
/// @@ -14352,12 +14914,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 ScheduleHasSelfPacedResult { + /// True when at least one active schedule is self-paced. + pub has_self_paced: bool, } -/// Tracked shell task metadata, including ID, command, status, timing, attachment/execution mode, log path, and PID. +/// Snapshot of the currently active recurring prompts for this session. /// ///
/// @@ -14367,39 +14929,12 @@ pub struct TasksGetProgressResult { ///
#[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, +pub struct ScheduleList { + /// Active scheduled prompts, ordered by id. + pub entries: Vec, } -/// Progress snapshot for a shell task, with recent stdout/stderr output and optional process ID. +/// Re-arm a self-paced scheduled prompt. /// ///
/// @@ -14409,17 +14944,14 @@ pub struct TaskShellInfo { ///
#[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, +pub struct ScheduleRearmSelfPacedRequest { + /// Epoch milliseconds when the prompt should next fire. + pub at: i64, + /// Id of the self-paced scheduled prompt. + pub id: i64, } -/// The promoted task as it now exists in background mode, omitted if no promotable task was waiting. +/// Identifier of the scheduled prompt to remove. /// ///
/// @@ -14429,13 +14961,12 @@ 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. - #[serde(skip_serializing_if = "Option::is_none")] - pub task: Option, +pub struct ScheduleStopRequest { + /// Id of the scheduled prompt to remove. + pub id: i64, } -/// Identifier of the task to promote to background mode. +/// Remove a scheduled prompt by id. The result entry is omitted if the id was unknown. /// ///
/// @@ -14445,12 +14976,13 @@ pub struct TasksPromoteCurrentToBackgroundResult { ///
#[derive(Debug, Clone, Default, Serialize, Deserialize)] #[serde(rename_all = "camelCase")] -pub struct TasksPromoteToBackgroundRequest { - /// Task identifier - pub id: String, +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 task was successfully promoted to background mode. +/// Secret values to add to the redaction filter. /// ///
/// @@ -14460,12 +14992,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 SecretsAddFilterValuesRequest { + /// Raw secret values to register for redaction + pub values: Vec, } -/// 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. +/// Confirmation that the secret values were registered. /// ///
/// @@ -14475,9 +15007,12 @@ pub struct TasksPromoteToBackgroundResult { ///
#[derive(Debug, Clone, Default, Serialize, Deserialize)] #[serde(rename_all = "camelCase")] -pub struct TasksRefreshResult {} +pub struct SecretsAddFilterValuesResult { + /// Whether the values were successfully registered + pub ok: bool, +} -/// Identifier of the completed or cancelled task to remove from tracking. +/// Parameters for session.extensions.sendAttachmentsToMessage. /// ///
/// @@ -14487,12 +15022,15 @@ pub struct TasksRefreshResult {} ///
#[derive(Debug, Clone, Default, Serialize, Deserialize)] #[serde(rename_all = "camelCase")] -pub struct TasksRemoveRequest { - /// Task identifier - pub id: String, +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 task was removed. False when the task does not exist or is still running/idle. +/// A single user message to append to the session as part of a `session.sendMessages` turn /// ///
/// @@ -14502,12 +15040,29 @@ 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 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, } -/// Identifier of the target agent task, message content, and optional sender agent ID. +/// 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. /// ///
/// @@ -14517,17 +15072,33 @@ 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 +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 from_agent_id: Option, - /// Agent task identifier - pub id: String, - /// Message content to send to the agent - pub message: String, + 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 message was delivered, with an error message when delivery failed. +/// Result of sending zero or more user messages /// ///
/// @@ -14537,15 +15108,12 @@ pub struct TasksSendMessageRequest { ///
#[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, +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, } -/// Agent type, prompt, name, and optional description and model override for the new task. +/// Parameters for sending a user message to the session /// ///
/// @@ -14555,22 +15123,49 @@ 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 +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 description: Option, - /// Optional model override + 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 model: Option, - /// Short name for the agent, used to generate a human-readable ID - pub name: String, - /// Task prompt for the agent + 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, } -/// Identifier assigned to the newly started background agent task. +/// Result of sending a user message /// ///
/// @@ -14580,12 +15175,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 SendResult { + /// Unique identifier assigned to the message + pub message_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). +/// Internal request for sending a system notification. /// ///
/// @@ -14595,9 +15190,18 @@ pub struct TasksStartAgentResult { ///
#[derive(Debug, Clone, Default, Serialize, Deserialize)] #[serde(rename_all = "camelCase")] -pub struct TasksWaitForPendingResult {} +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, +} -/// Feature override key/value pairs to attach to subsequent telemetry events from this session. +/// Agents discovered across user, project, plugin, and remote sources. /// ///
/// @@ -14607,12 +15211,12 @@ 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 ServerAgentList { + /// All discovered agents across all sources + pub agents: Vec, } -/// Authentication-info variant for SDK-configured token authentication, carrying host and the secret token value. +/// Instruction sources discovered across user, repository, and plugin sources. /// ///
/// @@ -14622,19 +15226,12 @@ 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, +pub struct ServerInstructionSourceList { + /// All discovered instruction sources + pub sources: Vec, } -/// Built-in tool metadata with identifier, optional namespaced name, description, input-parameter schema, and usage instructions. +/// Server-side skill metadata, including name, description, source, enabled/invocable state, path, project path, and argument hint. /// ///
/// @@ -14644,24 +15241,33 @@ pub struct TokenAuthInfo { ///
#[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 +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 instructions: Option, - /// Tool identifier (e.g., "bash", "grep", "str_replace_editor") + 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, - /// Optional namespaced name for declarative filtering (e.g., "playwright/navigate" for MCP tools) + /// Absolute path to the skill file #[serde(skip_serializing_if = "Option::is_none")] - pub namespaced_name: Option, - /// JSON Schema for the tool's input parameters + pub path: Option, + /// The project path this skill belongs to (only for project/inherited skills) #[serde(skip_serializing_if = "Option::is_none")] - pub parameters: Option>, -} - -/// Built-in tools available for the requested model, with their parameters and instructions. -/// + 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, +} + +/// Skills discovered across global and project sources. +/// ///
/// /// **Experimental.** This type is part of an experimental wire-protocol surface @@ -14670,12 +15276,15 @@ pub struct Tool { ///
#[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 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, } -/// Current lightweight tool metadata snapshot for the session. +/// Current activity flags for the session. /// ///
/// @@ -14685,12 +15294,14 @@ 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 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, } -/// 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 authentication information, or null when no authentication is active. /// ///
/// @@ -14700,9 +15311,26 @@ pub struct ToolsGetCurrentMetadataResult { ///
#[derive(Debug, Clone, Default, Serialize, Deserialize)] #[serde(rename_all = "camelCase")] -pub struct ToolsInitializeAndValidateResult {} +pub struct SessionAuthInfoResult { + /// Snapshot of the authenticated user's Copilot subscription info, if known + #[serde(skip_serializing_if = "Option::is_none")] + pub copilot_user: Option, + /// Name of the environment variable that supplied the credential, when applicable + #[serde(skip_serializing_if = "Option::is_none")] + pub env_var: Option, + /// Authentication host + pub host: String, + /// Authenticated login, when available + #[serde(skip_serializing_if = "Option::is_none")] + pub login: Option, + /// Opaque SDK GitHub credential registration backing this identity. Routing metadata only; never a credential. + #[serde(skip_serializing_if = "Option::is_none")] + pub registration_id: Option, + /// Authentication type + pub r#type: AuthInfoType, +} -/// Optional model identifier whose tool overrides should be applied to the listing. +/// Internal GitHub login parameters. /// ///
/// @@ -14712,13 +15340,19 @@ pub struct ToolsInitializeAndValidateResult {} ///
#[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 +pub struct SessionAuthLoginRequest { + /// GitHub host URL + pub host: String, + /// GitHub login + pub login: String, + /// Whether to persist the token after login #[serde(skip_serializing_if = "Option::is_none")] - pub model: Option, + pub persist: Option, + /// GitHub authentication token + pub token: String, } -/// Empty result after applying subagent settings +/// Parameters identifying a GitHub authentication to log out. /// ///
/// @@ -14726,11 +15360,14 @@ pub struct ToolsListRequest { /// 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 ToolsUpdateSubagentSettingsResult {} +pub struct SessionAuthLogoutUserRequest { + /// Authentication information to log out + pub auth_info: AuthInfo, +} -/// Selectable option for a UI elicitation multi-select array item, with submitted value and display label. +/// Authentication status and account metadata for the session. /// ///
/// @@ -14740,14 +15377,27 @@ pub struct ToolsUpdateSubagentSettingsResult {} ///
#[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 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, } -/// Schema applied to each item in the array. +/// Parameters for switching the session's active authentication. /// ///
/// @@ -14755,14 +15405,17 @@ pub struct UIElicitationArrayAnyOfFieldItemsAnyOf { /// 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 UIElicitationArrayAnyOfFieldItems { - /// Selectable options, each with a value and a display label. - pub any_of: Vec, +pub struct SessionAuthSwitchRequest { + /// Authentication information to activate + pub auth_info: AuthInfo, + /// Optional token paired with the authentication information + #[serde(skip_serializing_if = "Option::is_none")] + pub token: Option, } -/// Multi-select string field where each option pairs a value with a display label. +/// Map of sessionId -> bytes freed by removing the session's workspace directory. /// ///
/// @@ -14772,29 +15425,59 @@ 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. +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, +} + +/// 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 min_items: Option, - /// Human-readable label for the field. + 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 title: Option, - /// Type discriminator. Always "array". - pub r#type: UIElicitationArrayAnyOfFieldType, + pub parent_id: Option, + /// Token count currently in context attributable to this entry. + pub tokens: i64, } -/// Schema applied to each item in the array. +/// Per-source context-window attribution, or null if the session has not yet been initialized (no system prompt or tool metadata cached). /// ///
/// @@ -14804,14 +15487,30 @@ pub struct UIElicitationArrayAnyOfField { ///
#[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, +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, } -/// Multi-select string field whose allowed values are defined inline. +/// Token breakdown for the current context window, or null if the session has not yet been initialized (no system prompt or tool metadata cached). /// ///
/// @@ -14821,29 +15520,30 @@ 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 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, } -/// JSON Schema describing the form fields to present to the user +/// The enriched metadata records, with summary and context fields backfilled where available. Sessions confirmed empty and unnamed are omitted. /// ///
/// @@ -14853,17 +15553,12 @@ 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 SessionEnrichMetadataResult { + /// Enriched records, with summary and context backfilled. Sessions confirmed empty and unnamed may be omitted. + pub sessions: Vec, } -/// Prompt message and JSON schema describing the form fields to elicit from the user. +/// File path, content to append, and optional mode for the client-provided session filesystem. /// ///
/// @@ -14873,14 +15568,19 @@ 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 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, } -/// The elicitation response (accept with form values, decline, or cancel) +/// Describes a filesystem error. /// ///
/// @@ -14890,15 +15590,15 @@ 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') +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 content: Option>, + pub message: Option, } -/// Indicates whether the elicitation response was accepted; false if it was already resolved by another client. +/// Path to test for existence in the client-provided session filesystem. /// ///
/// @@ -14908,12 +15608,14 @@ 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 SessionFsExistsRequest { + /// Target session identifier + pub session_id: SessionId, + /// Path using SessionFs conventions + pub path: String, } -/// Boolean field rendered as a yes/no toggle. +/// Indicates whether the requested path exists in the client-provided session filesystem. /// ///
/// @@ -14923,21 +15625,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 SessionFsExistsResult { + /// Whether the path exists + pub exists: bool, } -/// Numeric field accepting either a number or an integer. +/// Directory path to create in the client-provided session filesystem, with options for recursive creation and POSIX mode. /// ///
/// @@ -14947,27 +15640,20 @@ 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). +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 minimum: Option, - /// Human-readable label for the field. + pub recursive: Option, + /// Optional POSIX-style mode for newly created directories #[serde(skip_serializing_if = "Option::is_none")] - pub title: Option, - /// Numeric type accepted by the field. - pub r#type: UIElicitationSchemaPropertyNumberType, + pub mode: Option, } -/// Free-text string field with optional length and format constraints. +/// Directory path whose entries should be listed from the client-provided session filesystem. /// ///
/// @@ -14977,30 +15663,14 @@ 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. - #[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, +pub struct SessionFsReaddirRequest { + /// Target session identifier + pub session_id: SessionId, + /// Path using SessionFs conventions + pub path: String, } -/// Single-select string field whose allowed values are defined inline. +/// Names of entries in the requested directory, or a filesystem error if the read failed. /// ///
/// @@ -15010,26 +15680,15 @@ 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. +pub struct SessionFsReaddirResult { + /// Entry names in the directory + pub entries: Vec, + /// Describes a filesystem error. #[serde(skip_serializing_if = "Option::is_none")] - pub title: Option, - /// Type discriminator. Always "string". - pub r#type: UIElicitationStringEnumFieldType, + pub error: Option, } -/// Selectable option for a UI elicitation single-select string field, with submitted value and display label. +/// Directory entry returned by session filesystem `readdirWithTypes`, with name and entry type. /// ///
/// @@ -15039,14 +15698,14 @@ 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 SessionFsReaddirWithTypesEntry { + /// Entry name + pub name: String, + /// Entry type + pub r#type: SessionFsReaddirWithTypesEntryType, } -/// Single-select string field where each option pairs a value with a display label. +/// Directory path whose entries (with type information) should be listed from the client-provided session filesystem. /// ///
/// @@ -15056,23 +15715,14 @@ 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 SessionFsReaddirWithTypesRequest { + /// Target session identifier + pub session_id: SessionId, + /// Path using SessionFs conventions + pub path: String, } -/// Transient question to answer without adding it to conversation history. +/// Entries in the requested directory paired with file/directory type information, or a filesystem error if the read failed. /// ///
/// @@ -15082,20 +15732,15 @@ pub struct UIElicitationStringOneOfField { ///
#[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)] +pub struct SessionFsReaddirWithTypesResult { + /// Directory entries with type information + pub entries: Vec, + /// Describes a filesystem error. #[serde(skip_serializing_if = "Option::is_none")] - pub(crate) on_chunk: Option, - /// Question to answer from the current conversation context. - pub question: String, + pub error: Option, } -/// Transient answer generated from current conversation context. +/// Path of the file to read from the client-provided session filesystem. /// ///
/// @@ -15105,12 +15750,14 @@ pub struct UIEphemeralQueryRequest { ///
#[derive(Debug, Clone, Default, Serialize, Deserialize)] #[serde(rename_all = "camelCase")] -pub struct UIEphemeralQueryResult { - /// Full assistant response text. - pub answer: String, +pub struct SessionFsReadFileRequest { + /// Target session identifier + pub session_id: SessionId, + /// Path using SessionFs conventions + pub path: String, } -/// User response for a pending exit-plan-mode request, with approval state, selected action, auto-approve flag, and feedback. +/// File content as a UTF-8 string, or a filesystem error if the read failed. /// ///
/// @@ -15120,21 +15767,15 @@ pub struct UIEphemeralQueryResult { ///
#[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'. +pub struct SessionFsReadFileResult { + /// File content as UTF-8 string + pub content: String, + /// Describes a filesystem error. #[serde(skip_serializing_if = "Option::is_none")] - pub selected_action: Option, + pub error: Option, } -/// Request ID of a pending `auto_mode_switch.requested` event and the user's response. +/// Source and destination paths for renaming or moving an entry in the client-provided session filesystem. /// ///
/// @@ -15144,14 +15785,16 @@ 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 SessionFsRenameRequest { + /// Target session identifier + pub session_id: SessionId, + /// Source path using SessionFs conventions + pub src: String, + /// Destination path using SessionFs conventions + pub dest: String, } -/// Pending elicitation request ID and the user's response (accept/decline/cancel + form values). +/// Path to remove from the client-provided session filesystem, with options for recursive removal and force. /// ///
/// @@ -15161,14 +15804,20 @@ 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 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 + #[serde(skip_serializing_if = "Option::is_none")] + pub force: Option, } -/// Request ID of a pending `exit_plan_mode.requested` event and the user's response. +/// Optional capabilities declared by the provider /// ///
/// @@ -15178,14 +15827,13 @@ 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, - /// User response for a pending exit-plan-mode request, with approval state, selected action, auto-approve flag, and feedback. - pub response: UIExitPlanModeResponse, +pub struct SessionFsSetProviderCapabilities { + /// Whether the provider supports SQLite query/exists operations + #[serde(skip_serializing_if = "Option::is_none")] + pub sqlite: Option, } -/// Indicates whether the pending UI request was resolved by this call. +/// Initial working directory, session-state path layout, and path conventions used to register the calling SDK client as the session filesystem provider. /// ///
/// @@ -15195,12 +15843,19 @@ 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 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, } -/// Optional sampling result payload. Omit to reject/cancel the sampling request without providing a result. +/// Indicates whether the calling client was registered as the session filesystem provider. /// ///
/// @@ -15210,9 +15865,12 @@ pub struct UIHandlePendingResult { ///
#[derive(Debug, Clone, Default, Serialize, Deserialize)] #[serde(rename_all = "camelCase")] -pub struct UIHandlePendingSamplingResponse {} +pub struct SessionFsSetProviderResult { + /// Whether the provider was set successfully + pub success: bool, +} -/// Request ID of a pending `sampling.requested` event and an optional sampling result payload (omit to reject). +/// Indicates whether the per-session SQLite database already exists. /// ///
/// @@ -15222,15 +15880,12 @@ 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 SessionFsSqliteExistsResult { + /// Whether the session database already exists + pub exists: bool, } -/// The user's selected action for an exhausted session limit. +/// 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. /// ///
/// @@ -15240,18 +15895,19 @@ pub struct UIHandlePendingSamplingRequest { ///
#[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'. +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 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, + pub params: Option>, } -/// Request ID of a pending `session_limits_exhausted.requested` event and the user's selected limit action. +/// Query results including rows, columns, and rows affected, or a filesystem error if execution failed. /// ///
/// @@ -15261,14 +15917,22 @@ pub struct UISessionLimitsExhaustedResponse { ///
#[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, +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, } -/// User response for a pending user-input request, with answer text and whether it was typed freeform. +/// Classified SQLite transaction failure. busyOrLocked guarantees rollback; postCommitAmbiguous must never be retried. /// ///
/// @@ -15278,14 +15942,14 @@ pub struct UIHandlePendingSessionLimitsExhaustedRequest { ///
#[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 SessionFsSqliteTransactionError { + /// Machine-readable classification of the transaction failure. + pub error_class: SessionFsSqliteTransactionErrorClass, + /// Human-readable transaction failure message. + pub message: String, } -/// Request ID of a pending `user_input.requested` event and the user's response. +/// One statement in an atomic SQLite transaction. /// ///
/// @@ -15295,14 +15959,17 @@ 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, - /// User response for a pending user-input request, with answer text and whether it was typed freeform. - pub response: UIUserInputResponse, +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, } -/// 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). +/// Statements to execute atomically. Providers apply busy handling for every call. /// ///
/// @@ -15312,12 +15979,14 @@ 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 SessionFsSqliteTransactionRequest { + /// Target session identifier + pub session_id: SessionId, + /// Ordered SQL statements to execute in one transaction. + pub statements: Vec, } -/// Opaque handle previously returned by `registerDirectAutoModeSwitchHandler` to release. +/// Per-statement results, or a classified transaction error. /// ///
/// @@ -15327,12 +15996,15 @@ 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 SessionFsSqliteTransactionResult { + /// Classified transaction failure, when execution did not succeed. + #[serde(skip_serializing_if = "Option::is_none")] + pub error: Option, + /// Per-statement query results in input order. + pub results: Vec, } -/// Indicates whether the handle was active and the registration count was decremented. +/// Path whose metadata should be returned from the client-provided session filesystem. /// ///
/// @@ -15342,30 +16014,14 @@ 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, -} - -/// 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, +pub struct SessionFsStatRequest { + /// Target session identifier + pub session_id: SessionId, + /// Path using SessionFs conventions + pub path: String, } -/// Subagent settings to apply to the current session +/// Filesystem metadata for the requested path, or a filesystem error if the stat failed. /// ///
/// @@ -15375,12 +16031,23 @@ pub struct UpdateSubagentSettingsRequestSubagents { ///
#[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, +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, } -/// Aggregated code change metrics +/// File path, content to write, and optional mode for the client-provided session filesystem. /// ///
/// @@ -15390,18 +16057,19 @@ pub struct UpdateSubagentSettingsRequest { ///
#[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 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, } -/// Request count and cost metrics for this model +/// Installed plugin record for a session, with marketplace, version, install time, enabled state, cache path, and source. /// ///
/// @@ -15411,14 +16079,34 @@ 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 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, + /// Absolute path of the marketplace directory a live plugin was resolved from. Present only on live, never-persisted records β€” those synthesized at session start for a directory/local marketplace, whose cache_path points at the real plugin directory on disk rather than a copy under the installed-plugins cache. Its presence is what marks a record as live, and no record carrying it is ever written to the persisted installedPlugins key. + #[serde(rename = "installed_from", skip_serializing_if = "Option::is_none")] + pub installed_from: Option, + /// 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, } -/// Per-model token-detail entry containing the accumulated token count for one token type. +/// Source descriptor for a direct GitHub plugin install, with `owner/repo`, optional ref or full commit SHA, and optional subpath. /// ///
/// @@ -15428,12 +16116,23 @@ 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 SessionInstalledPluginSourceGitHub { + /// Optional repository-relative path to the plugin. + #[serde(skip_serializing_if = "Option::is_none")] + pub path: Option, + /// Optional Git ref to resolve. + #[serde(skip_serializing_if = "Option::is_none")] + pub r#ref: Option, + /// GitHub repository in `owner/repo` form. + 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, } -/// Token usage metrics for this model +/// Source descriptor for a direct local plugin install, with a local filesystem path. /// ///
/// @@ -15443,21 +16142,14 @@ 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 SessionInstalledPluginSourceLocal { + /// Local filesystem path to the plugin. + pub path: String, + /// Constant value. Always "local". + pub source: SessionInstalledPluginSourceLocalSource, } -/// Per-model usage metrics, including request counts/costs, token usage, nano-AI units, and per-token-type details. +/// Source descriptor for a direct URL plugin install, with URL, optional ref or full commit SHA, and optional subpath. /// ///
/// @@ -15467,23 +16159,23 @@ pub struct UsageMetricsModelMetricUsage { ///
#[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. +pub struct SessionInstalledPluginSourceUrl { + /// Optional source-relative path to the plugin. #[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 + pub path: Option, + /// Optional Git ref to resolve. #[serde(skip_serializing_if = "Option::is_none")] - pub token_details: Option>, - /// Accumulated nano-AI units cost for this model + pub r#ref: Option, + /// Optional full 40-character hexadecimal commit SHA. #[serde(skip_serializing_if = "Option::is_none")] - pub total_nano_aiu: Option, - /// Token usage metrics for this model - pub usage: UsageMetricsModelMetricUsage, + pub sha: Option, + /// Constant value. Always "url". + pub source: SessionInstalledPluginSourceUrlSource, + /// URL of the plugin source. + pub url: String, } -/// Session-wide token-detail entry containing the accumulated token count for one token type. +/// Baseline data provenance for a prediction. /// ///
/// @@ -15493,12 +16185,14 @@ 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 SessionLimitPredictionBaselineData { + /// End of the baseline data slice. + pub window_end: String, + /// Start of the baseline data slice. + pub window_start: String, } -/// Accumulated session usage metrics, including premium request cost, token counts, model breakdown, and code-change totals. +/// Semantic usage tier and its AI-credit cap. /// ///
/// @@ -15508,35 +16202,14 @@ 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 SessionLimitPredictionTierOption { + /// AI-credit cap for this tier. + pub cap: f64, + /// Semantic usage tier. + pub tier: SessionLimitPredictionTier, } -/// Authentication-info variant for OAuth user auth, with host and login; the token remains in the runtime secret store. +/// Explainable AI-credit session-limit prediction. /// ///
/// @@ -15546,19 +16219,29 @@ 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. +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 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 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, } -/// Result of a user-requested shell command. +/// Parameters for predicting an AI-credit session limit. Omitting `modelId` uses the session's currently selected model. /// ///
/// @@ -15568,41 +16251,49 @@ pub struct UserAuthInfo { ///
#[derive(Debug, Clone, Default, Serialize, Deserialize)] #[serde(rename_all = "camelCase")] -pub struct UserRequestedShellCommandResult { - /// Error output when the execution failed +pub struct SessionLimitPredictionRequest { + /// Client type to size for. Defaults to `cli-interactive`. #[serde(skip_serializing_if = "Option::is_none")] - pub error: Option, - /// Process exit code, when available + 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 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, + pub model_id: Option, } -/// 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 +#[derive(Debug, Clone, Default, Serialize, Deserialize)] +#[serde(rename_all = "camelCase")] +pub struct SessionLimitPredictionResultAvailable { + /// Prediction result variant discriminator. + pub kind: SessionLimitPredictionResultAvailableKind, + /// Predicted session limit details. + pub prediction: SessionLimitPredictionDetails, +} + +#[derive(Debug, Clone, Default, Serialize, Deserialize)] +#[serde(rename_all = "camelCase")] +pub struct SessionLimitPredictionResultUnavailable { + /// Prediction result variant discriminator. + pub kind: SessionLimitPredictionResultUnavailableKind, + /// Reason no prediction is available. + pub reason: SessionLimitPredictionUnavailableReason, +} + +/// 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 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, +pub struct SessionList { + /// Sessions ordered most-recently-modified first. Discriminated by `isRemote`. + pub sessions: Vec, } -/// 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. +/// Optional filter applied to the returned sessions /// ///
/// @@ -15612,12 +16303,22 @@ pub struct UserSettingMetadata { ///
#[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, +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, } -/// 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. +/// Queued repo-level startup prompts and the total hook command count after loading. /// ///
/// @@ -15627,12 +16328,14 @@ pub struct UserSettingsGetResult { ///
#[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, +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, } -/// Outcome of writing user settings. +/// Enterprise permission policy expressed with the runtime's managed permission-rule syntax. /// ///
/// @@ -15642,12 +16345,22 @@ pub struct UserSettingsSetRequest { ///
#[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, +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 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. `allow-auto-only` blocks full allow-all but permits advisory auto-approval. Any other value is accepted rather than failing the session, but is enforced as `disable`: the key is only present to restrict something, so a mode this runtime cannot interpret fails closed to the most restrictive one it knows. Omit the key entirely to impose no restriction. + #[serde(skip_serializing_if = "Option::is_none")] + pub disable_bypass_permissions_mode: Option, } -/// Current sharing status and shareable GitHub URL for a session. +/// Managed settings an SDK host may inject at session startup. Only permissions are accepted in this initial contract. /// ///
/// @@ -15657,18 +16370,48 @@ pub struct UserSettingsSetResult { ///
#[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. +pub struct SessionManagedSettings { + /// Managed permission policy injected by the SDK host. #[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). + pub permissions: Option, +} + +/// Public-facing projection of workspace metadata for SDK / TUI consumers +#[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 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, + 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, } -/// Desired sharing status for the session. +/// Point-in-time snapshot of slow-changing session identifier and state fields /// ///
/// @@ -15678,12 +16421,45 @@ pub struct VisibilityGetResult { ///
#[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, +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, } -/// Effective sharing status and shareable GitHub URL after updating session visibility. +/// Cost-category metadata for a CAPI model. /// ///
/// @@ -15693,18 +16469,14 @@ pub struct VisibilitySetRequest { ///
#[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, +pub struct SessionModelPriceCategory { + /// CAPI model identifier. + pub id: String, + /// Cost category assigned to the model. + pub price_category: ModelPickerPriceCategory, } -/// A single changed file and its unified diff. +/// The list of models available to this session. /// ///
/// @@ -15714,22 +16486,18 @@ pub struct VisibilitySetResult { ///
#[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. +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 is_truncated: Option, - /// Original file path for renamed files. + 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 old_path: Option, - /// Path to the changed file, relative to the workspace root. - pub path: String, + pub quota_snapshots: Option>, } -/// Workspace diff result for the requested mode. +/// Source descriptor for a `sessions.open` content-exclusion rule, with source name and type. /// ///
/// @@ -15739,21 +16507,14 @@ 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. - #[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 SessionOpenOptionsAdditionalContentExclusionPolicyRuleSource { + /// Name of the policy source. + pub name: String, + /// Type of the policy source. + pub r#type: String, } -/// Workspace checkpoint metadata with assigned number, human-readable title, and checkpoint filename. +/// Single content-exclusion rule supplied to `sessions.open` options, with paths, match conditions, and source. /// ///
/// @@ -15763,16 +16524,20 @@ 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 SessionOpenOptionsAdditionalContentExclusionPolicyRule { + /// Conditions of which at least one must match. + #[serde(skip_serializing_if = "Option::is_none")] + pub if_any_match: Option>, + /// Conditions none of which may match. + #[serde(skip_serializing_if = "Option::is_none")] + pub if_none_match: Option>, + /// Path patterns covered by this rule. + pub paths: Vec, + /// Source descriptor for a `sessions.open` content-exclusion rule, with source name and type. + pub source: SessionOpenOptionsAdditionalContentExclusionPolicyRuleSource, } -/// Relative path and UTF-8 content for the workspace file to create or overwrite. +/// Content-exclusion policy supplied to `sessions.open` options, with rules, last-updated data, and scope. /// ///
/// @@ -15782,14 +16547,33 @@ 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 SessionOpenOptionsAdditionalContentExclusionPolicy { + /// Opaque policy update timestamp supplied by the host. + #[serde(rename = "last_updated_at")] + pub last_updated_at: serde_json::Value, + /// Content-exclusion rules to apply. + pub rules: Vec, + /// Allowed values for the `SessionOpenOptionsAdditionalContentExclusionPolicyScope` enumeration. + pub scope: SessionOpenOptionsAdditionalContentExclusionPolicyScope, } -/// Parameters for computing a workspace diff. +/// Command-scoped GitHub credential injection for the shell commands an agent runs. +/// +/// Each channel is opt-in and independent, and injection is scoped to the individual command +/// spawn: the credential is resolved from the session's *current* authentication at every spawn +/// and reaches only spawns whose script actually invokes `git` or `gh`. Because nothing is +/// retained between spawns, replacing the session credential (`session.gitHubAuth.setCredentials`) +/// changes what the next spawned command presents β€” which seeding a credential into the runtime +/// process's own environment cannot do, since a child's environment is fixed at `exec`. +/// +/// The credential is matched to the host it authenticates to, so a github.com credential is never +/// presented to a GitHub Enterprise host and vice versa. Where a channel cannot express that +/// boundary it injects nothing rather than crossing it -- see `gh` below. +/// +/// This is independent of `sandboxConfig`: it is a decision about which identity the agent +/// presents, not about what the agent may touch, and it works on every platform whether or not +/// an OS sandboxing backend is available. `sandboxConfig.auth` remains the sandbox-scoped +/// spelling and is additive with this one. /// ///
/// @@ -15799,57 +16583,7200 @@ pub struct WorkspacesCreateFileRequest { ///
#[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. +pub struct ShellCredentials { + /// Whether to authenticate the agent's `gh` commands as the session's GitHub credential, by + /// exporting `GH_TOKEN` to a spawn that runs `gh`. Any inherited `gh` credential is removed from + /// spawns that do not, so the credential stays command-scoped. + /// + /// Applies to a github.com credential only. `gh` picks its credential variable from the host a + /// command targets rather than the one the credential belongs to, and the command can choose that + /// target, so `GH_ENTERPRISE_TOKEN` would offer a single-tenant enterprise credential to every + /// other enterprise host. A session whose credential is enterprise-scoped therefore runs `gh` + /// unauthenticated; its `git` commands are unaffected, because `http..extraheader` is scoped + /// to one host by construction. Default: false (opt-in). #[serde(skip_serializing_if = "Option::is_none")] - pub ignore_whitespace: Option, - /// Diff mode requested by the client. - pub mode: WorkspaceDiffMode, + pub gh: Option, + /// Whether to authenticate the agent's `git` commands as the session's GitHub credential, by + /// injecting an `http..extraheader` (plus `insteadOf` rewrites so SSH-spelled remotes for + /// that host use the authenticated HTTPS transport). Applied only to a spawn that runs a + /// remote-contacting `git` subcommand. Default: false (opt-in). + #[serde(skip_serializing_if = "Option::is_none")] + pub git: Option, } +/// A host-provided script sourced before each built-in shell command when its shell target matches the active shell. +/// +///
+/// +/// **Experimental.** This type is part of an experimental wire-protocol surface +/// 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 { +pub struct ShellInitScript { + /// Path to the script to source. + pub path: String, + /// Built-in shell that may source this script. + pub shell: ShellInitScriptShell, +} + +/// Per-session settings for built-in shell tools. +/// +///
+/// +/// **Experimental.** This type is part of an experimental wire-protocol surface +/// and may change or be removed in future SDK or CLI releases. +/// +///
+#[derive(Debug, Clone, Default, Serialize, Deserialize)] +#[serde(rename_all = "camelCase")] +pub struct ShellOptions { + /// Command-scoped GitHub credential injection for shell commands. + #[serde(skip_serializing_if = "Option::is_none")] + pub credentials: Option, + /// 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>, +} + +/// Session construction options. +/// +///
+/// +/// **Experimental.** This type is part of an experimental wire-protocol surface +/// and may change or be removed in future SDK or CLI releases. +/// +///
+#[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). Conventional `.github/skills/` and `.github/agents/` definitions under each directory also join the session's project catalogs when their existing subsystem gates are enabled: added-root skills require both `enableConfigDiscovery` and effective `enableSkills`; added-root agents require `enableConfigDiscovery`. Supplying a directory therefore activates configuration from it and should be treated as a trust decision. 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 during session creation and cold resume and is not persisted, so a cold resume must re-supply the directories. + #[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 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, + /// Whether commit-message coauthor trailers are enabled. #[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 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 for supported Anthropic and OpenAI models, 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>, + /// Built-in skill names to include in this session. When specified, only these runtime-bundled skills are available. Skills from other sources with the same name remain available. + #[serde(skip_serializing_if = "Option::is_none")] + pub included_builtin_skills: 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, - #[serde(rename = "remote_steerable", skip_serializing_if = "Option::is_none")] + /// 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 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 running_in_interactive_mode: Option, + /// Resolved sandbox configuration. + #[serde(skip_serializing_if = "Option::is_none")] + pub sandbox_config: Option, + /// Origin of the sandbox choice. The runtime uses this only for internal telemetry provenance; managed policy is derived independently. + #[doc(hidden)] + #[serde(skip_serializing_if = "Option::is_none")] + pub(crate) sandbox_config_source: 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, +} + +/// Token authentication accepted by session.gitHubAuth.setCredentials. +/// +///
+/// +/// **Experimental.** This type is part of an experimental wire-protocol surface +/// and may change or be removed in future SDK or CLI releases. +/// +///
+#[derive(Debug, Clone, Default, Serialize, Deserialize)] +#[serde(rename_all = "camelCase")] +pub struct SettableTokenAuthInfo { + /// 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: SettableTokenAuthInfoType, +} + +/// 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 { + /// Whether the create-pull-request tool is available. + #[serde(skip_serializing_if = "Option::is_none")] + pub create_pull_request: Option, + /// Whether the report-progress tool is available. + #[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 { + /// Whether the named settings predicate evaluated to enabled. + 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 { + /// Availability of job-specific built-in tools. + #[serde(skip_serializing_if = "Option::is_none")] + pub built_in_tool_availability: Option, + /// GitHub Actions event type for the job. + #[serde(skip_serializing_if = "Option::is_none")] + pub event_type: Option, + /// Whether this is the workflow's trigger job. + #[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 { + /// Agent service callback URL for job and progress updates. + #[serde(skip_serializing_if = "Option::is_none")] + pub callback_url: Option, + /// Default reasoning effort for the selected model. + #[serde(skip_serializing_if = "Option::is_none")] + pub default_reasoning_effort: Option, + /// Agent job identifier for the session. + #[serde(skip_serializing_if = "Option::is_none")] + pub instance_id: Option, + /// Selected model identifier. + #[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 { + /// Whether online evaluation is disabled. + #[serde(skip_serializing_if = "Option::is_none")] + pub disable_online_evaluation: Option, + /// Whether online-evaluation output-file generation is enabled. + #[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 { + /// Checked-out repository branch. + #[serde(skip_serializing_if = "Option::is_none")] + pub branch: Option, + /// Checked-out commit SHA. + #[serde(skip_serializing_if = "Option::is_none")] + pub commit: Option, + /// GitHub server host name. + #[serde(skip_serializing_if = "Option::is_none")] + pub host: Option, + /// Protocol used to access the GitHub host. + #[serde(skip_serializing_if = "Option::is_none")] + pub host_protocol: Option, + /// GitHub repository database ID. + #[serde(skip_serializing_if = "Option::is_none")] + pub id: Option, + /// Repository name. + #[serde(skip_serializing_if = "Option::is_none")] + pub name: Option, + /// GitHub repository owner database ID. + #[serde(skip_serializing_if = "Option::is_none")] + pub owner_id: Option, + /// Repository owner login. + #[serde(skip_serializing_if = "Option::is_none")] + pub owner_name: Option, + /// Number of commits in the pull request. + #[serde(skip_serializing_if = "Option::is_none")] + pub pr_commit_count: Option, + /// Whether the repository is writable. + #[serde(skip_serializing_if = "Option::is_none")] + pub read_write: Option, + /// GitHub secret-scanning service URL. + #[serde(skip_serializing_if = "Option::is_none")] + pub secret_scanning_url: Option, + /// GitHub server base URL. + #[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 { + /// Whether advisory validation is enabled. + #[serde(skip_serializing_if = "Option::is_none")] + pub advisory_enabled: Option, + /// Whether CodeQL validation is enabled. + #[serde(skip_serializing_if = "Option::is_none")] + pub codeql_enabled: Option, + /// Whether code-review validation is enabled. + #[serde(skip_serializing_if = "Option::is_none")] + pub code_review_enabled: Option, + /// Model used for code-review validation. + #[serde(skip_serializing_if = "Option::is_none")] + pub code_review_model: Option, + /// Dependabot validation timeout budget in seconds. + #[serde(skip_serializing_if = "Option::is_none")] + pub dependabot_timeout: Option, + /// Whether the memory-store tool is enabled. + #[serde(skip_serializing_if = "Option::is_none")] + pub memory_store_enabled: Option, + /// Whether the memory-vote tool is enabled. + #[serde(skip_serializing_if = "Option::is_none")] + pub memory_vote_enabled: Option, + /// Whether secret-scanning validation is enabled. + #[serde(skip_serializing_if = "Option::is_none")] + pub secret_scanning_enabled: Option, + /// General validation timeout budget in seconds. + #[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 { + /// Name of the SDK client that created the session. + #[serde(skip_serializing_if = "Option::is_none")] + pub client_name: Option, + /// Redacted job settings. + pub job: SessionSettingsJobSnapshot, + /// Redacted model routing settings. + pub model: SessionSettingsModelSnapshot, + /// Online-evaluation settings safe for SDK consumers. + pub online_evaluation: SessionSettingsOnlineEvaluationSnapshot, + /// Redacted repository and host settings. + pub repo: SessionSettingsRepoSnapshot, + /// Session start time as Unix epoch milliseconds. + #[serde(skip_serializing_if = "Option::is_none")] + pub start_time_ms: Option, + /// Session timeout in milliseconds. + #[serde(skip_serializing_if = "Option::is_none")] + pub timeout_ms: Option, + /// Redacted validation and memory-tool settings. + pub validation: SessionSettingsValidationSnapshot, + /// Agent runtime version selector copied from the session settings, such as `latest` or a runtime release identifier. + #[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>, + /// Built-in skill names to include in this session. When specified, only these runtime-bundled skills are available. Skills from other sources with the same name remain available. Set to null to remove the allowlist restriction. + #[serde(skip_serializing_if = "Option::is_none")] + pub included_builtin_skills: 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, + /// Origin of the sandbox choice. The runtime uses this only for internal telemetry provenance; managed policy is derived independently. + #[doc(hidden)] + #[serde(skip_serializing_if = "Option::is_none")] + pub(crate) sandbox_config_source: 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, +} + +/// Adds or removes a single skill from the global disabled list, leaving every other entry untouched. +/// +///
+/// +/// **Experimental.** This type is part of an experimental wire-protocol surface +/// and may change or be removed in future SDK or CLI releases. +/// +///
+#[derive(Debug, Clone, Default, Serialize, Deserialize)] +#[serde(rename_all = "camelCase")] +pub struct SkillsConfigSetSkillDisabledRequest { + /// True to disable the skill, false to enable it + pub disabled: bool, + /// Name of the skill to add to or remove from the disabled list + pub name: String, +} + +/// 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, +} + +/// +///
+/// +/// **Experimental.** This type is part of an experimental wire-protocol surface +/// and may change or be removed in future SDK or CLI releases. +/// +///
+#[derive(Debug, Clone, Default, Serialize, Deserialize)] +#[serde(rename_all = "camelCase")] +pub struct SlashCommandTimelineEntry { + /// Text displayed for the timeline entry. + pub text: String, + /// Timeline entry presentation type. + pub r#type: String, + /// Optional URL associated with the timeline entry. + #[serde(skip_serializing_if = "Option::is_none")] + pub url: Option, +} + +/// +///
+/// +/// **Experimental.** This type is part of an experimental wire-protocol surface +/// and may change or be removed in future SDK or CLI releases. +/// +///
+#[derive(Debug, Clone, Default, Serialize, Deserialize)] +#[serde(rename_all = "camelCase")] +pub struct SlashCommandAddTimelineEntryResult { + /// Timeline entry the host should append. + pub entry: SlashCommandTimelineEntry, + /// Discriminator for an add-timeline-entry result. + pub kind: SlashCommandAddTimelineEntryResultKind, + /// Optional text the host should prefill into the input editor. + #[serde(skip_serializing_if = "Option::is_none")] + pub prefill_input: Option, + /// Whether command execution changed persisted runtime settings. + #[serde(skip_serializing_if = "Option::is_none")] + pub runtime_settings_changed: Option, +} + +/// 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, +} + +/// +///
+/// +/// **Experimental.** This type is part of an experimental wire-protocol surface +/// and may change or be removed in future SDK or CLI releases. +/// +///
+#[derive(Debug, Clone, Default, Serialize, Deserialize)] +#[serde(rename_all = "camelCase")] +pub struct SlashCommandModelPickerDialog { + /// Discriminator for a model-picker dialog. + pub kind: SlashCommandModelPickerDialogKind, + /// Model that should be enabled before it can be selected. + #[serde(skip_serializing_if = "Option::is_none")] + pub model_to_enable: Option, + /// Settings scope the picker should modify. + #[serde(skip_serializing_if = "Option::is_none")] + pub scope: Option, + /// Model-selection target represented by the picker. + #[serde(skip_serializing_if = "Option::is_none")] + pub target: Option, +} + +/// +///
+/// +/// **Experimental.** This type is part of an experimental wire-protocol surface +/// and may change or be removed in future SDK or CLI releases. +/// +///
+#[derive(Debug, Clone, Default, Serialize, Deserialize)] +#[serde(rename_all = "camelCase")] +pub struct SlashCommandShowDialogResult { + /// Dialog the host should display. + pub dialog: SlashCommandModelPickerDialog, + /// Discriminator for a show-dialog result. + pub kind: SlashCommandShowDialogResultKind, + /// Whether command execution changed persisted runtime settings. + #[serde(skip_serializing_if = "Option::is_none")] + pub runtime_settings_changed: Option, +} + +/// +///
+/// +/// **Experimental.** This type is part of an experimental wire-protocol surface +/// and may change or be removed in future SDK or CLI releases. +/// +///
+#[derive(Debug, Clone, Default, Serialize, Deserialize)] +#[serde(rename_all = "camelCase")] +pub struct SlashCommandSetModelResult { + /// Discriminator for a set-model result. + pub kind: SlashCommandSetModelResultKind, + /// Model selected by the command. + pub model: String, + /// Reasoning effort selected for the model. + #[serde(skip_serializing_if = "Option::is_none")] + pub reasoning_effort: Option, + /// Repository settings scope modified by the command. + #[serde(skip_serializing_if = "Option::is_none")] + pub repo_scope: Option, + /// User-settings snapshot to restore if the host cancels the model switch. + #[serde(skip_serializing_if = "Option::is_none")] + pub revert_on_cancel: Option, + /// Whether command execution changed persisted runtime settings. + #[serde(skip_serializing_if = "Option::is_none")] + pub runtime_settings_changed: Option, + /// Settings scope modified by the command. + #[serde(skip_serializing_if = "Option::is_none")] + pub scope: Option, + /// User-facing warning produced while selecting the model. + #[serde(skip_serializing_if = "Option::is_none")] + pub warning: Option, +} + +/// +///
+/// +/// **Experimental.** This type is part of an experimental wire-protocol surface +/// and may change or be removed in future SDK or CLI releases. +/// +///
+#[derive(Debug, Clone, Default, Serialize, Deserialize)] +#[serde(rename_all = "camelCase")] +pub struct SlashCommandSetPlanModelResult { + /// Discriminator for a set-plan-model result. + pub kind: SlashCommandSetPlanModelResultKind, + /// User-facing confirmation message for the plan-model selection. + pub message: String, + /// Dedicated model selected for plan mode. + #[serde(skip_serializing_if = "Option::is_none")] + pub plan_model: Option, + /// Whether command execution changed persisted runtime settings. + #[serde(skip_serializing_if = "Option::is_none")] + pub runtime_settings_changed: Option, +} + +/// 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, + /// Friendly, non-unique name intended for display + #[serde(skip_serializing_if = "Option::is_none")] + pub display_name: Option, + /// 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, +} + +/// Task completion notification with summary from the 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 TaskCompleteData { + /// 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 + #[serde(skip_serializing_if = "Option::is_none")] + pub summary: Option, +} + +/// +///
+/// +/// **Experimental.** This type is part of an experimental wire-protocol surface +/// and may change or be removed in future SDK or CLI releases. +/// +///
+#[derive(Debug, Clone, Default, Serialize, Deserialize)] +#[serde(rename_all = "camelCase")] +pub struct TaskCompletionDecision { + /// Objective eligibility token captured when the decision was evaluated. + #[serde(skip_serializing_if = "Option::is_none")] + pub completion_eligibility_token: Option, + /// Whether completion was accepted after the reviewer-rejection budget was exhausted. + #[serde(skip_serializing_if = "Option::is_none")] + pub completion_rejection_budget_exhausted: Option, + /// Active autopilot objective evaluated by the completion reviewer. + #[serde(skip_serializing_if = "Option::is_none")] + pub objective_id: Option, + /// Semantic result of evaluating the task completion request. + pub outcome: TaskCompletionOutcome, + /// Rationale for the completion decision, when one is available. + #[serde(skip_serializing_if = "Option::is_none")] + pub reason: Option, + /// Whether the rationale was derived from completion-reviewer output. + #[serde(skip_serializing_if = "Option::is_none")] + pub reviewer_derived: Option, + /// Information-flow metadata captured from the completion reviewer. + #[serde(skip_serializing_if = "Option::is_none")] + pub reviewer_result_meta: Option, +} + +/// 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, + /// Friendly, non-unique name used when displaying the agent + 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, +} + +/// 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, +} + +/// A message injected by a tool 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 ToolResultNewMessage { + /// Message content to inject after the tool result. + pub content: String, + /// Source attributed to the injected message. + pub source: String, +} + +/// Expanded canonical result returned by a session 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, Serialize, Deserialize)] +#[serde(rename_all = "camelCase")] +pub struct ToolResultExpanded { + /// Base64-encoded binary results returned to the model. + #[serde(skip_serializing_if = "Option::is_none")] + pub binary_results_for_llm: Option>, + /// Sources returned by the tool that the model may cite. + #[serde(skip_serializing_if = "Option::is_none")] + pub citable_sources: Option>, + /// Structured content blocks returned to the model. + #[serde(skip_serializing_if = "Option::is_none")] + pub contents: Option>, + /// Error message for an unsuccessful execution. + #[serde(skip_serializing_if = "Option::is_none")] + pub error: Option, + /// Metadata propagated with the tool result, including information-flow labels. + #[serde(skip_serializing_if = "Option::is_none")] + pub mcp_meta: Option>, + /// Messages to inject after the tool result. + #[serde(skip_serializing_if = "Option::is_none")] + pub new_messages: Option>, + /// Whether post-tool-use failure hooks have already processed this result. + #[serde(skip_serializing_if = "Option::is_none")] + pub post_tool_use_failure_hooks_processed: Option, + /// Execution outcome classification. + pub result_type: ToolResultType, + /// Detailed log content available for session display. + #[serde(skip_serializing_if = "Option::is_none")] + pub session_log: Option, + /// Skill invocation metadata produced by the tool. + #[serde(skip_serializing_if = "Option::is_none")] + pub skill_invocation: Option, + /// Whether large-output post-processing should be skipped. + #[serde(skip_serializing_if = "Option::is_none")] + pub skip_large_output_processing: Option, + /// Structured result content in addition to the model-facing text. + #[serde(skip_serializing_if = "Option::is_none")] + pub structured_content: Option, + /// Completion-review decision produced by the task-completion tool. + #[serde(skip_serializing_if = "Option::is_none")] + pub task_completion_decision: Option, + /// Text result returned to the model. + pub text_result_for_llm: String, + /// Deferred tool names made available by this result. + #[serde(skip_serializing_if = "Option::is_none")] + pub tool_references: Option>, + /// Tool-specific telemetry payload. + #[serde(skip_serializing_if = "Option::is_none")] + pub tool_telemetry: Option, + /// Optional UI resource produced by the tool. + #[serde(skip_serializing_if = "Option::is_none")] + pub ui_resource: Option, +} + +/// A tool name and arguments to execute through the session's native invocation pipeline. +/// +///
+/// +/// **Experimental.** This type is part of an experimental wire-protocol surface +/// and may change or be removed in future SDK or CLI releases. +/// +///
+#[derive(Debug, Clone, Default, Serialize, Deserialize)] +#[serde(rename_all = "camelCase")] +pub struct ToolsExecuteRequest { + /// Arguments supplied to the tool. + pub arguments: serde_json::Value, + /// Name of the currently offered tool to execute. + pub name: String, + /// Optional identifier used to correlate this invocation with its tool call. + #[serde(skip_serializing_if = "Option::is_none")] + pub tool_call_id: Option, +} + +/// Shell-specific names and description lines used to materialize built-in shell tool descriptors. +/// +///
+/// +/// **Experimental.** This type is part of an experimental wire-protocol surface +/// and may change or be removed in future SDK or CLI releases. +/// +///
+#[derive(Debug, Clone, Default, Serialize, Deserialize)] +#[serde(rename_all = "camelCase")] +pub struct ToolsShellDescriptorConfig { + /// Additional model-facing shell description lines. + pub description_lines: Vec, + /// Human-readable shell name. + pub display_name: String, + /// Tool name used to list active shells. + pub list_shells_tool_name: String, + /// Tool name used to read shell output. + pub read_shell_tool_name: String, + /// Tool name used to start shell commands. + pub shell_tool_name: String, + /// Stable shell type identifier. + pub shell_type: String, + /// Tool name used to stop shell commands. + pub stop_shell_tool_name: String, +} + +/// Options controlling how Rust-owned built-in tool descriptors are materialized. +/// +///
+/// +/// **Experimental.** This type is part of an experimental wire-protocol surface +/// and may change or be removed in future SDK or CLI releases. +/// +///
+#[derive(Debug, Clone, Default, Serialize, Deserialize)] +#[serde(rename_all = "camelCase")] +pub struct ToolsGetBuiltinDescriptorsRequest { + /// Whether background task completion notifications are enabled. + #[serde(skip_serializing_if = "Option::is_none")] + pub background_task_notifications_enabled: Option, + /// Whether tool descriptors should include authoring metadata. + #[serde(skip_serializing_if = "Option::is_none")] + pub include_author: Option, + /// Whether descriptors should favor fewer user-intervention prompts. + #[serde(skip_serializing_if = "Option::is_none")] + pub reduce_user_intervention: Option, + /// Shell-specific names and description lines for shell tools. + #[serde(skip_serializing_if = "Option::is_none")] + pub shell_config: Option, + /// Whether the configured shell supports PowerShell 7 syntax. + #[serde(skip_serializing_if = "Option::is_none")] + pub shell_supports_power_shell7_syntax: Option, + /// Default shell timeout in milliseconds. + #[serde(skip_serializing_if = "Option::is_none")] + pub shell_timeout_ms: Option, + /// Whether semantic skill lookup is available. + #[serde(skip_serializing_if = "Option::is_none")] + pub skill_embedding_enabled: Option, +} + +/// Rust-owned built-in tool descriptors 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 ToolsGetBuiltinDescriptorsResult { + /// Built-in tool descriptors materialized for the session. + 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, +} + +/// Complete externally implemented tool list for the calling connection. An empty list removes every tool previously supplied by that connection. +/// +///
+/// +/// **Experimental.** This type is part of an experimental wire-protocol surface +/// and may change or be removed in future SDK or CLI releases. +/// +///
+#[derive(Debug, Clone, Default, Serialize, Deserialize)] +#[serde(rename_all = "camelCase")] +pub struct ToolsSetRequest { + /// Complete replacement list for the calling connection. + pub tools: Vec, +} + +/// Empty result after replacing the calling connection's externally implemented tools. +/// +///
+/// +/// **Experimental.** This type is part of an experimental wire-protocol surface +/// and may change or be removed in future SDK or CLI releases. +/// +///
+#[derive(Debug, Clone, Default, Serialize, Deserialize)] +#[serde(rename_all = "camelCase")] +pub struct ToolsSetResult {} + +/// Task-completion tool arguments and final result used to build a label-safe session event payload. +/// +///
+/// +/// **Experimental.** This type is part of an experimental wire-protocol surface +/// and may change or be removed in future SDK or CLI releases. +/// +///
+#[derive(Debug, Clone, Default, Serialize, Deserialize)] +#[serde(rename_all = "camelCase")] +pub struct ToolsTaskCompleteEventDataRequest { + /// Final expanded result returned by the task_complete tool. + pub final_result: ToolResultExpanded, + /// Arguments supplied to the completed task_complete tool call. + pub tool_args: serde_json::Value, +} + +/// 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 { + /// MCP request metadata. + #[serde(rename = "_meta", skip_serializing_if = "Option::is_none")] + pub meta: Option>, + /// Message describing what information is needed from the user + pub message: String, + /// Elicitation mode. Omitted and form are equivalent for structured elicitation. + #[serde(skip_serializing_if = "Option::is_none")] + pub mode: Option, + /// JSON Schema describing the form fields to present to the user + pub requested_schema: UIElicitationSchema, + /// MCP task metadata. + #[serde(skip_serializing_if = "Option::is_none")] + pub task: Option, +} + +/// 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 { + /// MCP response metadata. + #[serde(rename = "_meta", skip_serializing_if = "Option::is_none")] + pub meta: Option>, + /// 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, +} + +/// Completed transient query. Ordered chunks and the terminal outcome are also delivered through `ui.ephemeral_query` session events while it 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 UIEphemeralQueryResult { + /// Answer returned by the model + 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, +} + +/// 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, +} + +/// Usage attributed to one agent instance, including its identity, API duration, AI units, and per-model 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 UsageMetricsAgentMetric { + /// Human-readable label for this subagent invocation, copied from the originating `subagent.started` event. For task-tool subagents this is the invocation's task description rather than the agent's configured display name, so group by `agentName` for stable per-agent labels. + #[serde(skip_serializing_if = "Option::is_none")] + pub agent_display_name: Option, + /// Configured agent name, when this is a subagent + #[serde(skip_serializing_if = "Option::is_none")] + pub agent_name: Option, + /// Per-model usage for this agent, keyed by model identifier + pub model_metrics: HashMap, + /// Time spent in model API calls by this agent, in milliseconds + pub total_api_duration_ms: i64, + /// Accumulated nano-AI units cost for this agent + pub total_nano_aiu: f64, +} + +/// 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, +} + +/// 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 { + /// Per-agent usage metrics, keyed by agent instance identifier. The main conversation uses the stable key `main`. + #[serde(skip_serializing_if = "Option::is_none")] + pub agent_metrics: Option>, + /// 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, +} + +/// 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 { + /// Metadata for the persisted summary. + #[serde(skip_serializing_if = "Option::is_none")] + pub summary: Option, + /// Refreshed metadata for the containing workspace. + #[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 { + /// Current Git branch. + #[serde(skip_serializing_if = "Option::is_none")] + pub branch: Option, + /// Whether the per-session Chronicle upgrade prompt was dismissed for the workspace. + #[serde( + rename = "chronicle_sync_dismissed", + skip_serializing_if = "Option::is_none" + )] + pub chronicle_sync_dismissed: Option, + /// Name of the client that created the workspace. + #[serde(rename = "client_name", skip_serializing_if = "Option::is_none")] + pub client_name: Option, + /// Timestamp when the workspace was created. + #[serde(rename = "created_at", skip_serializing_if = "Option::is_none")] + pub created_at: Option, + /// Current working directory associated with the workspace. + #[serde(skip_serializing_if = "Option::is_none")] + pub cwd: Option, + /// Git repository root associated with the workspace. + #[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, + /// Stable workspace identifier. + pub id: String, + /// Most recent Mission Control event identifier observed for the workspace. + #[serde(rename = "mc_last_event_id", skip_serializing_if = "Option::is_none")] + pub mc_last_event_id: Option, + /// Mission Control session identifier associated with the workspace. + #[serde(rename = "mc_session_id", skip_serializing_if = "Option::is_none")] + pub mc_session_id: Option, + /// Mission Control task identifier associated with the workspace. + #[serde(rename = "mc_task_id", skip_serializing_if = "Option::is_none")] + pub mc_task_id: Option, + /// Workspace display name. + #[serde(skip_serializing_if = "Option::is_none")] + pub name: Option, + /// Whether the workspace session can be steered remotely. + #[serde(rename = "remote_steerable", skip_serializing_if = "Option::is_none")] + pub remote_steerable: Option, + /// Repository identifier associated with the workspace. + #[serde(skip_serializing_if = "Option::is_none")] + pub repository: Option, + /// Number of persisted summaries in the workspace. + #[serde(rename = "summary_count", skip_serializing_if = "Option::is_none")] + pub summary_count: Option, + /// Timestamp when the workspace was last updated. + #[serde(rename = "updated_at", skip_serializing_if = "Option::is_none")] + pub updated_at: Option, + /// Whether the workspace name was explicitly chosen by the user. + #[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, +} + +/// 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 SessionGitHubAuthGetCurrentAuthInfoParams { + /// 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 SessionGitHubAuthGetAllAuthAvailableParams { + /// 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 SessionGitHubAuthRefreshCopilotUserParams { + /// 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 SessionGitHubAuthLogoutParams { + /// 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 SessionGitHubAuthLastAuthErrorsParams { + /// Target session identifier + pub session_id: SessionId, +} + +/// 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 SessionFactoryRunFromToolResult { + /// 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 SessionFactoryResumeFromToolResult { + /// 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, + /// Factory run summaries in durable creation order. + 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 { + /// Epoch milliseconds when the current active segment started, or null while inactive. + pub active_segment_started_at: Option, + /// Durable identities and live statuses for direct factory agents. + pub agents: Vec, + /// Approved effective resource ceilings, or null until approved. + pub approved: Option, + /// Epoch milliseconds when the run completed, or null while nonterminal. + pub completed_at: Option, + /// Durable resource consumption. + pub consumed: FactoryRunConsumed, + /// Epoch milliseconds when the run was created. + pub created_at: i64, + /// Current phase identity, or null before any phase is entered. + pub current_phase: Option, + /// Resource ceilings declared by the factory. + pub declared_limits: FactoryDeclaredLimits, + /// Number of phases declared by the factory. + pub declared_phase_count: i64, + /// Human-readable factory description. + pub description: String, + /// Registered factory name. + pub factory_name: String, + /// Number of direct factory agents currently live. + pub live_agent_count: i64, + /// Epoch milliseconds when this live-overlay snapshot was observed. + pub observed_at: i64, + /// Lifecycle and timing observations for each factory phase. + pub phases: Vec, + /// Bidirectional page of durable factory progress. + pub progress: FactoryProgressPage, + /// Monotonic durable run revision. + pub revision: i64, + /// Factory run identifier. + pub run_id: String, + /// Epoch milliseconds when execution first started, or null before start. + pub started_at: Option, + /// Current factory run status. + pub status: FactoryRunStatus, + /// Terminal run outcome, or null while nonterminal. + pub terminal: Option, + /// Total direct factory agents spawned across all attempts. + pub total_spawned_agent_count: i64, + /// Epoch milliseconds when the durable run was last updated. + 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 { + /// Whether progress records newer than this page exist. + pub has_more_newer: bool, + /// Whether progress records older than this page exist. + pub has_more_older: bool, + /// Newest sequence number in this page, or null when empty. + pub newest_seq: Option, + /// Oldest sequence number in this page, or null when empty. + pub oldest_seq: Option, + /// Progress records in sequence order. + 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 { + /// Compaction confirmation projection when status is confirmation_required + #[serde(skip_serializing_if = "Option::is_none")] + pub confirmation: Option, + /// 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, + /// Deprecation warnings associated with the selected model or options. + #[serde(skip_serializing_if = "Option::is_none")] + pub deprecation_warnings: Option>, + /// User-facing outcome message for the model switch. + #[serde(skip_serializing_if = "Option::is_none")] + pub message: Option, + /// Currently active model identifier after the switch + #[serde(skip_serializing_if = "Option::is_none")] + pub model_id: Option, + /// Persistence failure encountered after applying the model switch. + #[serde(skip_serializing_if = "Option::is_none")] + pub persistence_error: Option, + /// Lifecycle result for the requested switch + #[serde(skip_serializing_if = "Option::is_none")] + pub status: Option, + /// User-facing warning produced while applying the model switch. + #[serde(skip_serializing_if = "Option::is_none")] + pub warning: 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 SessionModelApplyStartupOverlayResult { + /// Compaction confirmation projection when status is confirmation_required + #[serde(skip_serializing_if = "Option::is_none")] + pub confirmation: Option, + /// 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, + /// Deprecation warnings associated with the selected model or options. + #[serde(skip_serializing_if = "Option::is_none")] + pub deprecation_warnings: Option>, + /// User-facing outcome message for the model switch. + #[serde(skip_serializing_if = "Option::is_none")] + pub message: Option, + /// Currently active model identifier after the switch + #[serde(skip_serializing_if = "Option::is_none")] + pub model_id: Option, + /// Persistence failure encountered after applying the model switch. + #[serde(skip_serializing_if = "Option::is_none")] + pub persistence_error: Option, + /// Lifecycle result for the requested switch + #[serde(skip_serializing_if = "Option::is_none")] + pub status: Option, + /// User-facing warning produced while applying the model switch. + #[serde(skip_serializing_if = "Option::is_none")] + pub warning: 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, +} + +/// Outcome of a session mode change, including any model switch it triggered and follow-up the host must perform. +/// +///
+/// +/// **Experimental.** This type is part of an experimental wire-protocol surface +/// and may change or be removed in future SDK or CLI releases. +/// +///
+#[derive(Debug, Clone, Default, Serialize, Deserialize)] +#[serde(rename_all = "camelCase")] +pub struct SessionModeSetResult { + /// Whether the host should arm an interactive continuation after the mode change. + #[serde(skip_serializing_if = "Option::is_none")] + pub arm_interactive_continuation: Option, + /// Compaction confirmation required before the mode change can complete. + #[serde(skip_serializing_if = "Option::is_none")] + pub confirmation: Option, + /// Whether the host must defer implementing the requested mode change. + #[serde(skip_serializing_if = "Option::is_none")] + pub defer_implementation: Option, + /// Deprecation warnings associated with the model selected by the mode change. + #[serde(skip_serializing_if = "Option::is_none")] + pub deprecation_warnings: Option>, + /// User-facing outcome message for the model switch triggered by the mode change. + #[serde(skip_serializing_if = "Option::is_none")] + pub message: Option, + /// Whether applying the mode changed the active model. + pub model_changed: bool, + /// Lifecycle status of the requested mode change. + pub status: String, + /// User-facing warning produced while applying the mode change. + #[serde(skip_serializing_if = "Option::is_none")] + pub warning: 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 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 with insertion order used to break ties when available and id used for WITHOUT ROWID tables. + 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 with insertion order used to break ties when available and id used for WITHOUT ROWID tables. 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 { + /// Current Git branch. + #[serde(skip_serializing_if = "Option::is_none")] + pub branch: Option, + /// Whether the per-session Chronicle upgrade prompt was dismissed for the workspace. + #[serde( + rename = "chronicle_sync_dismissed", + skip_serializing_if = "Option::is_none" + )] + pub chronicle_sync_dismissed: Option, + /// Name of the client that created the workspace. + #[serde(rename = "client_name", skip_serializing_if = "Option::is_none")] + pub client_name: Option, + /// Timestamp when the workspace was created. + #[serde(rename = "created_at", skip_serializing_if = "Option::is_none")] + pub created_at: Option, + /// Current working directory associated with the workspace. + #[serde(skip_serializing_if = "Option::is_none")] + pub cwd: Option, + /// Git repository root associated with the workspace. + #[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, + /// Stable workspace identifier. + pub id: String, + /// Most recent Mission Control event identifier observed for the workspace. + #[serde(rename = "mc_last_event_id", skip_serializing_if = "Option::is_none")] + pub mc_last_event_id: Option, + /// Mission Control session identifier associated with the workspace. + #[serde(rename = "mc_session_id", skip_serializing_if = "Option::is_none")] + pub mc_session_id: Option, + /// Mission Control task identifier associated with the workspace. + #[serde(rename = "mc_task_id", skip_serializing_if = "Option::is_none")] + pub mc_task_id: Option, + /// Workspace display name. + #[serde(skip_serializing_if = "Option::is_none")] + pub name: Option, + /// Whether the workspace session can be steered remotely. + #[serde(rename = "remote_steerable", skip_serializing_if = "Option::is_none")] + pub remote_steerable: Option, + /// Repository identifier associated with the workspace. + #[serde(skip_serializing_if = "Option::is_none")] + pub repository: Option, + /// Number of persisted summaries in the workspace. + #[serde(rename = "summary_count", skip_serializing_if = "Option::is_none")] + pub summary_count: Option, + /// Timestamp when the workspace was last updated. + #[serde(rename = "updated_at", skip_serializing_if = "Option::is_none")] + pub updated_at: Option, + /// Whether the workspace name was explicitly chosen by the user. + #[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 { + /// Current Git branch. + #[serde(skip_serializing_if = "Option::is_none")] + pub branch: Option, + /// Whether the per-session Chronicle upgrade prompt was dismissed for the workspace. + #[serde( + rename = "chronicle_sync_dismissed", + skip_serializing_if = "Option::is_none" + )] + pub chronicle_sync_dismissed: Option, + /// Name of the client that created the workspace. + #[serde(rename = "client_name", skip_serializing_if = "Option::is_none")] + pub client_name: Option, + /// Timestamp when the workspace was created. + #[serde(rename = "created_at", skip_serializing_if = "Option::is_none")] + pub created_at: Option, + /// Current working directory associated with the workspace. + #[serde(skip_serializing_if = "Option::is_none")] + pub cwd: Option, + /// Git repository root associated with the workspace. + #[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, + /// Stable workspace identifier. + pub id: String, + /// Most recent Mission Control event identifier observed for the workspace. + #[serde(rename = "mc_last_event_id", skip_serializing_if = "Option::is_none")] + pub mc_last_event_id: Option, + /// Mission Control session identifier associated with the workspace. + #[serde(rename = "mc_session_id", skip_serializing_if = "Option::is_none")] + pub mc_session_id: Option, + /// Mission Control task identifier associated with the workspace. + #[serde(rename = "mc_task_id", skip_serializing_if = "Option::is_none")] + pub mc_task_id: Option, + /// Workspace display name. + #[serde(skip_serializing_if = "Option::is_none")] + pub name: Option, + /// Whether the workspace session can be steered remotely. + #[serde(rename = "remote_steerable", skip_serializing_if = "Option::is_none")] + pub remote_steerable: Option, + /// Repository identifier associated with the workspace. + #[serde(skip_serializing_if = "Option::is_none")] + pub repository: Option, + /// Number of persisted summaries in the workspace. + #[serde(rename = "summary_count", skip_serializing_if = "Option::is_none")] + pub summary_count: Option, + /// Timestamp when the workspace was last updated. + #[serde(rename = "updated_at", skip_serializing_if = "Option::is_none")] + pub updated_at: Option, + /// Whether the workspace name was explicitly chosen by the user. + #[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 { + /// Current Git branch. + #[serde(skip_serializing_if = "Option::is_none")] + pub branch: Option, + /// Whether the per-session Chronicle upgrade prompt was dismissed for the workspace. + #[serde( + rename = "chronicle_sync_dismissed", + skip_serializing_if = "Option::is_none" + )] + pub chronicle_sync_dismissed: Option, + /// Name of the client that created the workspace. + #[serde(rename = "client_name", skip_serializing_if = "Option::is_none")] + pub client_name: Option, + /// Timestamp when the workspace was created. + #[serde(rename = "created_at", skip_serializing_if = "Option::is_none")] + pub created_at: Option, + /// Current working directory associated with the workspace. + #[serde(skip_serializing_if = "Option::is_none")] + pub cwd: Option, + /// Git repository root associated with the workspace. + #[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, + /// Stable workspace identifier. + pub id: String, + /// Most recent Mission Control event identifier observed for the workspace. + #[serde(rename = "mc_last_event_id", skip_serializing_if = "Option::is_none")] + pub mc_last_event_id: Option, + /// Mission Control session identifier associated with the workspace. + #[serde(rename = "mc_session_id", skip_serializing_if = "Option::is_none")] + pub mc_session_id: Option, + /// Mission Control task identifier associated with the workspace. + #[serde(rename = "mc_task_id", skip_serializing_if = "Option::is_none")] + pub mc_task_id: Option, + /// Workspace display name. + #[serde(skip_serializing_if = "Option::is_none")] + pub name: Option, + /// Whether the workspace session can be steered remotely. + #[serde(rename = "remote_steerable", skip_serializing_if = "Option::is_none")] + pub remote_steerable: Option, + /// Repository identifier associated with the workspace. + #[serde(skip_serializing_if = "Option::is_none")] + pub repository: Option, + /// Number of persisted summaries in the workspace. + #[serde(rename = "summary_count", skip_serializing_if = "Option::is_none")] + pub summary_count: Option, + /// Timestamp when the workspace was last updated. + #[serde(rename = "updated_at", skip_serializing_if = "Option::is_none")] + pub updated_at: Option, + /// Whether the workspace name was explicitly chosen by the user. + #[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 { + /// Metadata for the persisted summary. + #[serde(skip_serializing_if = "Option::is_none")] + pub summary: Option, + /// Refreshed metadata for the containing workspace. + #[serde(skip_serializing_if = "Option::is_none")] + pub workspace: Option, +} + +#[derive(Debug, Clone, Default, Serialize, Deserialize)] +#[serde(rename_all = "camelCase")] +pub struct SessionWorkspacesTruncateSummariesResultWorkspace { + /// Current Git branch. + #[serde(skip_serializing_if = "Option::is_none")] + pub branch: Option, + /// Whether the per-session Chronicle upgrade prompt was dismissed for the workspace. + #[serde( + rename = "chronicle_sync_dismissed", + skip_serializing_if = "Option::is_none" + )] + pub chronicle_sync_dismissed: Option, + /// Name of the client that created the workspace. + #[serde(rename = "client_name", skip_serializing_if = "Option::is_none")] + pub client_name: Option, + /// Timestamp when the workspace was created. + #[serde(rename = "created_at", skip_serializing_if = "Option::is_none")] + pub created_at: Option, + /// Current working directory associated with the workspace. + #[serde(skip_serializing_if = "Option::is_none")] + pub cwd: Option, + /// Git repository root associated with the workspace. + #[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, + /// Stable workspace identifier. + pub id: String, + /// Most recent Mission Control event identifier observed for the workspace. + #[serde(rename = "mc_last_event_id", skip_serializing_if = "Option::is_none")] + pub mc_last_event_id: Option, + /// Mission Control session identifier associated with the workspace. + #[serde(rename = "mc_session_id", skip_serializing_if = "Option::is_none")] + pub mc_session_id: Option, + /// Mission Control task identifier associated with the workspace. + #[serde(rename = "mc_task_id", skip_serializing_if = "Option::is_none")] + pub mc_task_id: Option, + /// Workspace display name. + #[serde(skip_serializing_if = "Option::is_none")] + pub name: Option, + /// Whether the workspace session can be steered remotely. + #[serde(rename = "remote_steerable", skip_serializing_if = "Option::is_none")] + pub remote_steerable: Option, + /// Repository identifier associated with the workspace. + #[serde(skip_serializing_if = "Option::is_none")] + pub repository: Option, + /// Number of persisted summaries in the workspace. + #[serde(rename = "summary_count", skip_serializing_if = "Option::is_none")] + pub summary_count: Option, + /// Timestamp when the workspace was last updated. + #[serde(rename = "updated_at", skip_serializing_if = "Option::is_none")] + pub updated_at: Option, + /// Whether the workspace name was explicitly chosen by the user. + #[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, } -/// Current workspace metadata for the session, including its absolute filesystem path when available. +/// Identifier assigned to the newly started background agent task. /// ///
/// @@ -15859,15 +23786,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 SessionTasksStartAgentResult { + /// Generated agent ID for the background task + pub agent_id: String, } -/// Workspace checkpoints in chronological order; empty when the workspace is not enabled. +/// Identifies the target session. /// ///
/// @@ -15877,12 +23801,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 SessionTasksListParams { + /// Target session identifier + pub session_id: SessionId, } -/// Relative paths of files stored in the session workspace files directory. +/// Background tasks currently tracked by the session. /// ///
/// @@ -15892,12 +23816,12 @@ 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 SessionTasksListResult { + /// Currently tracked tasks + pub tasks: Vec, } -/// Checkpoint number to read. +/// Identifies the target session. /// ///
/// @@ -15907,12 +23831,12 @@ 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 SessionTasksRefreshParams { + /// Target session identifier + pub session_id: SessionId, } -/// Checkpoint content as a UTF-8 string, or null when the checkpoint or workspace is missing. +/// 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. /// ///
/// @@ -15922,12 +23846,24 @@ 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 content: Option, +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, } -/// Relative path of the workspace file to read. +/// 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). /// ///
/// @@ -15937,12 +23873,24 @@ 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 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, } -/// Contents of the requested workspace file as a UTF-8 string. +/// Identifies the target session. /// ///
/// @@ -15952,12 +23900,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 SessionTasksGetCurrentPromotableParams { + /// Target session identifier + pub session_id: SessionId, } -/// Pasted content to save as a UTF-8 file in the session workspace. +/// The first sync-waiting task that can currently be promoted to background mode. /// ///
/// @@ -15967,23 +23915,28 @@ 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 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 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 SessionTasksPromoteToBackgroundResult { + /// Whether the task was successfully promoted to background mode + pub promoted: bool, } -/// Descriptor for the saved paste file, or null when the workspace is unavailable. +/// Identifies the target session. /// ///
/// @@ -15993,12 +23946,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 SessionTasksPromoteCurrentToBackgroundParams { + /// Target session identifier + pub session_id: SessionId, } -/// 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). +/// The promoted task as it now exists in background mode, omitted if no promotable task was waiting. /// ///
/// @@ -16008,39 +23961,61 @@ 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 +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 name: Option, - /// Repository identifier in 'owner/repo' or 'org/project/repo' format, if any + 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 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, + pub error: Option, + /// Whether the message was successfully delivered or steered + pub sent: bool, } -/// List of Copilot models available to the resolved user, including capabilities and billing metadata. +/// Identifies the target session. /// ///
/// @@ -16050,12 +24025,12 @@ pub struct WorkspaceSummary { ///
#[derive(Debug, Clone, Default, Serialize, Deserialize)] #[serde(rename_all = "camelCase")] -pub struct ModelsListResult { - /// List of available models with full metadata - pub models: Vec, +pub struct SessionSkillsListParams { + /// Target session identifier + pub session_id: SessionId, } -/// Built-in tools available for the requested model, with their parameters and instructions. +/// Skills available to the session, with their enabled state. /// ///
/// @@ -16065,12 +24040,12 @@ pub struct ModelsListResult { ///
#[derive(Debug, Clone, Default, Serialize, Deserialize)] #[serde(rename_all = "camelCase")] -pub struct ToolsListResult { - /// List of available built-in tools with metadata - pub tools: Vec, +pub struct SessionSkillsListResult { + /// Available skills + pub skills: Vec, } -/// User-configured MCP servers, keyed by server name. +/// Identifies the target session. /// ///
/// @@ -16080,12 +24055,12 @@ pub struct ToolsListResult { ///
#[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, +pub struct SessionSkillsGetInvokedParams { + /// Target session identifier + pub session_id: SessionId, } -/// Plugins installed in user/global state. +/// Skills invoked during this session, ordered by invocation time (most recent last). /// ///
/// @@ -16095,12 +24070,12 @@ pub struct McpConfigListResult { ///
#[derive(Debug, Clone, Default, Serialize, Deserialize)] #[serde(rename_all = "camelCase")] -pub struct PluginsListResult { - /// Installed plugins - pub plugins: Vec, +pub struct SessionSkillsGetInvokedResult { + /// Skills invoked during this session, ordered by invocation time (most recent last) + pub skills: Vec, } -/// Result of installing a plugin. +/// Identifies the target session. /// ///
/// @@ -16110,20 +24085,12 @@ pub struct PluginsListResult { ///
#[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, +pub struct SessionSkillsReloadParams { + /// Target session identifier + pub session_id: SessionId, } -/// Result of updating a single plugin. +/// Diagnostics from reloading skill definitions, with warnings and errors as separate lists. /// ///
/// @@ -16133,18 +24100,14 @@ pub struct PluginsInstallResult { ///
#[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, +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, } -/// Result of updating all installed plugins. +/// Identifies the target session. /// ///
/// @@ -16154,12 +24117,12 @@ pub struct PluginsUpdateResult { ///
#[derive(Debug, Clone, Default, Serialize, Deserialize)] #[serde(rename_all = "camelCase")] -pub struct PluginsUpdateAllResult { - /// Per-plugin update results in deterministic order. - pub results: Vec, +pub struct SessionSkillsEnsureLoadedParams { + /// Target session identifier + pub session_id: SessionId, } -/// All registered marketplaces, including built-in defaults. +/// Identifies the target session. /// ///
/// @@ -16169,12 +24132,12 @@ pub struct PluginsUpdateAllResult { ///
#[derive(Debug, Clone, Default, Serialize, Deserialize)] #[serde(rename_all = "camelCase")] -pub struct PluginsMarketplacesListResult { - /// Registered marketplaces - pub marketplaces: Vec, +pub struct SessionMcpListParams { + /// Target session identifier + pub session_id: SessionId, } -/// Result of registering a new marketplace. +/// MCP servers configured for the session, with their connection status and host-level state. /// ///
/// @@ -16184,12 +24147,15 @@ pub struct PluginsMarketplacesListResult { ///
#[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, +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, } -/// Outcome of the remove attempt, including dependent-plugin info when applicable. +/// Tools exposed by the connected MCP server. Throws when the server is not connected. /// ///
/// @@ -16199,15 +24165,12 @@ pub struct PluginsMarketplacesAddResult { ///
#[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, +pub struct SessionMcpListToolsResult { + /// Tools exposed by the server. + pub tools: Vec, } -/// Plugins advertised by the marketplace. +/// Identifies the target session. /// ///
/// @@ -16217,12 +24180,12 @@ pub struct PluginsMarketplacesRemoveResult { ///
#[derive(Debug, Clone, Default, Serialize, Deserialize)] #[serde(rename_all = "camelCase")] -pub struct PluginsMarketplacesBrowseResult { - /// Plugins advertised by the marketplace - pub plugins: Vec, +pub struct SessionMcpReloadParams { + /// Target session identifier + pub session_id: SessionId, } -/// Result of refreshing one or more marketplace catalogs. +/// Identifies the target session. /// ///
/// @@ -16232,12 +24195,12 @@ pub struct PluginsMarketplacesBrowseResult { ///
#[derive(Debug, Clone, Default, Serialize, Deserialize)] #[serde(rename_all = "camelCase")] -pub struct PluginsMarketplacesRefreshResult { - /// Per-marketplace refresh results in deterministic order. - pub results: Vec, +pub struct SessionMcpMoveLoadingToBackgroundParams { + /// Target session identifier + pub session_id: SessionId, } -/// Skills discovered across global and project sources. +/// Result of moving in-flight MCP loading to the background. /// ///
/// @@ -16247,15 +24210,12 @@ pub struct PluginsMarketplacesRefreshResult { ///
#[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, +pub struct SessionMcpMoveLoadingToBackgroundResult { + /// Whether an in-flight MCP load was moved to the background, releasing turns that were waiting on it. False when no MCP load was in flight or the waiting turns had already been released. + pub moved_to_background: bool, } -/// Canonical locations where skills can be created so the runtime will recognize them. +/// MCP server startup filtering result. /// ///
/// @@ -16265,12 +24225,18 @@ pub struct SkillsDiscoverResult { ///
#[derive(Debug, Clone, Default, Serialize, Deserialize)] #[serde(rename_all = "camelCase")] -pub struct SkillsGetDiscoveryPathsResult { - /// Canonical skill create/discovery directories, in priority order - pub paths: Vec, +pub struct SessionMcpReloadWithConfigResult { + /// Non-default servers allowed by policy + #[serde(skip_serializing_if = "Option::is_none")] + pub allowed_servers: Option>, + /// Servers whose connection attempt failed. + #[serde(skip_serializing_if = "Option::is_none")] + pub failed_servers: Option>, + /// Servers filtered out before startup + pub filtered_servers: Vec, } -/// Agents discovered across user, project, plugin, and remote sources. +/// Outcome of an MCP sampling execution: success result, failure error, or cancellation. /// ///
/// @@ -16280,12 +24246,18 @@ pub struct SkillsGetDiscoveryPathsResult { ///
#[derive(Debug, Clone, Default, Serialize, Deserialize)] #[serde(rename_all = "camelCase")] -pub struct AgentsDiscoverResult { - /// All discovered agents across all sources - pub agents: Vec, +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, } -/// Canonical locations where custom agents can be created so the runtime will recognize them. +/// Indicates whether an in-flight sampling execution with the given requestId was found and cancelled. /// ///
/// @@ -16295,12 +24267,12 @@ pub struct AgentsDiscoverResult { ///
#[derive(Debug, Clone, Default, Serialize, Deserialize)] #[serde(rename_all = "camelCase")] -pub struct AgentsGetDiscoveryPathsResult { - /// Canonical agent create/discovery directories, in priority order - pub paths: Vec, +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, } -/// Instruction sources discovered across user, repository, and plugin sources. +/// Env-value mode recorded on the session after the update. /// ///
/// @@ -16310,12 +24282,12 @@ pub struct AgentsGetDiscoveryPathsResult { ///
#[derive(Debug, Clone, Default, Serialize, Deserialize)] #[serde(rename_all = "camelCase")] -pub struct InstructionsDiscoverResult { - /// All discovered instruction sources - pub sources: Vec, +pub struct SessionMcpSetEnvValueModeResult { + /// Mode recorded on the session after the update + pub mode: McpSetEnvValueModeDetails, } -/// Canonical files and directories where custom instructions can be created so the runtime will recognize them. +/// Identifies the target session. /// ///
/// @@ -16325,12 +24297,12 @@ pub struct InstructionsDiscoverResult { ///
#[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, +pub struct SessionMcpRemoveGitHubParams { + /// Target session identifier + pub session_id: SessionId, } -/// Slash commands available in the session, after applying any include/exclude filters. +/// Indicates whether the auto-managed `github` MCP server was removed (false when nothing to remove). /// ///
/// @@ -16340,12 +24312,12 @@ pub struct InstructionsGetDiscoveryPathsResult { ///
#[derive(Debug, Clone, Default, Serialize, Deserialize)] #[serde(rename_all = "camelCase")] -pub struct CommandsListResult { - /// Commands available in this session - pub commands: Vec, +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 opening a session. +/// Result of configuring GitHub MCP. /// ///
/// @@ -16355,31 +24327,12 @@ pub struct CommandsListResult { ///
#[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, +pub struct SessionMcpConfigureGitHubResult { + /// Whether GitHub MCP configuration changed. + pub changed: bool, } -/// Remote session connection result. +/// Whether the named MCP server is running. /// ///
/// @@ -16389,14 +24342,12 @@ pub struct SessionsOpenResult { ///
#[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 SessionMcpIsServerRunningResult { + /// True if the server has an active client and transport. + pub running: bool, } -/// Sessions matching the filter, ordered most-recently-modified first. +/// Indicates whether the pending MCP OAuth response was accepted. /// ///
/// @@ -16406,12 +24357,12 @@ pub struct SessionsConnectResult { ///
#[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, +pub struct SessionMcpOauthHandlePendingRequestResult { + /// Whether the response was accepted. False if the request was unknown, timed out, or already resolved. + pub success: bool, } -/// ID of the local session bound to the given GitHub task, or omitted when none. +/// OAuth authorization URL the caller should open, or empty when cached tokens already authenticated the server. /// ///
/// @@ -16421,13 +24372,13 @@ 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 +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 session_id: Option, + pub authorization_url: Option, } -/// Map of sessionId -> on-disk size in bytes for each session's workspace directory. +/// Indicates whether the pending MCP OAuth response was accepted. /// ///
/// @@ -16437,12 +24388,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 SessionMcpOauthRespondResult { + /// Whether the response was accepted. False if the request was unknown, timed out, or already resolved. + pub success: bool, } -/// Map of sessionId -> bytes freed by removing the session's workspace directory. +/// Indicates whether the pending MCP headers refresh response was accepted. /// ///
/// @@ -16452,12 +24403,12 @@ 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 SessionMcpHeadersHandlePendingHeadersRefreshRequestResult { + /// Whether the response was accepted. False if the request was unknown, timed out, or already resolved. + pub success: bool, } -/// Outcome of the prune operation: deleted IDs, dry-run candidates, skipped IDs, total bytes freed, and the dry-run flag. +/// Resource contents returned by the MCP server. /// ///
/// @@ -16467,20 +24418,12 @@ 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 SessionMcpAppsReadResourceResult { + /// Resource contents returned by the server + pub contents: Vec, } -/// The enriched metadata records, with summary and context fields backfilled where available. Sessions confirmed empty and unnamed are omitted. +/// App-callable tools from the named MCP server. /// ///
/// @@ -16490,12 +24433,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 SessionMcpAppsListToolsResult { + /// App-callable tools from the server + pub tools: Vec>, } -/// Queued repo-level startup prompts and the total hook command count after loading. +/// Identifies the target session. /// ///
/// @@ -16505,14 +24448,12 @@ 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 SessionMcpAppsGetHostContextParams { + /// Target session identifier + pub session_id: SessionId, } -/// Wrapper for the singleton's current status. +/// Current host context advertised to MCP App guests. /// ///
/// @@ -16522,12 +24463,12 @@ pub struct SessionsLoadDeferredRepoHooksResult { ///
#[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, +pub struct SessionMcpAppsGetHostContextResult { + /// Current host context + pub context: McpAppsHostContextDetails, } -/// Outcome of a transferRemoteControl call. +/// Diagnostic snapshot of MCP Apps wiring for the named server. /// ///
/// @@ -16537,14 +24478,14 @@ pub struct SessionsStartRemoteControlResult { ///
#[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, +pub struct SessionMcpAppsDiagnoseResult { + /// Capability negotiation snapshot + pub capability: McpAppsDiagnoseCapability, + /// What the server returned for this session + pub server: McpAppsDiagnoseServer, } -/// Wrapper for the singleton's current status. +/// Resource contents returned by the MCP server. /// ///
/// @@ -16554,12 +24495,12 @@ pub struct SessionsTransferRemoteControlResult { ///
#[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, +pub struct SessionMcpResourcesReadResult { + /// Resource contents returned by the server + pub contents: Vec, } -/// Outcome of a stopRemoteControl call. +/// One page of resources advertised by the named MCP server. /// ///
/// @@ -16569,14 +24510,15 @@ pub struct SessionsSetRemoteControlSteeringResult { ///
#[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, +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, } -/// Wrapper for the singleton's current status. +/// One page of resource templates advertised by the named MCP server. /// ///
/// @@ -16586,12 +24528,15 @@ pub struct SessionsStopRemoteControlResult { ///
#[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, +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, } -/// Handle for releasing the extension tool registration. +/// Identifies the target session. /// ///
/// @@ -16601,13 +24546,12 @@ pub struct SessionsGetRemoteControlStatusResult { ///
#[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, +pub struct SessionPluginsListParams { + /// Target session identifier + pub session_id: SessionId, } -/// Identifies the target session. +/// Plugins installed for the session, with their enabled state and version metadata. /// ///
/// @@ -16617,12 +24561,12 @@ pub(crate) struct SessionsRegisterExtensionToolsOnSessionResult { ///
#[derive(Debug, Clone, Default, Serialize, Deserialize)] #[serde(rename_all = "camelCase")] -pub struct SessionSuspendParams { - /// Target session identifier - pub session_id: SessionId, +pub struct SessionPluginsListResult { + /// Installed plugins + pub plugins: Vec, } -/// Result of sending a user message +/// A snapshot of the provider endpoint the session is currently configured to talk to. /// ///
/// @@ -16632,12 +24576,28 @@ 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 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, } -/// Result of sending zero or more user messages +/// The selectable model entries synthesized for the models added by this call. /// ///
/// @@ -16647,12 +24607,12 @@ pub struct SessionSendResult { ///
#[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, +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, } -/// Result of aborting the current turn +/// Indicates whether the session options patch was applied successfully. /// ///
/// @@ -16662,11 +24622,11 @@ pub struct SessionSendMessagesResult { ///
#[derive(Debug, Clone, Default, Serialize, Deserialize)] #[serde(rename_all = "camelCase")] -pub struct SessionAbortResult { - /// Error message if the abort failed +pub struct SessionOptionsUpdateResult { + /// Number of hooks loaded from installed plugins, returned when installedPlugins is updated #[serde(skip_serializing_if = "Option::is_none")] - pub error: Option, - /// Whether the abort completed successfully + pub plugin_hook_count: Option, + /// Whether the operation succeeded pub success: bool, } @@ -16680,12 +24640,12 @@ pub struct SessionAbortResult { ///
#[derive(Debug, Clone, Default, Serialize, Deserialize)] #[serde(rename_all = "camelCase")] -pub struct SessionGitHubAuthGetStatusParams { +pub struct SessionExtensionsListParams { /// Target session identifier pub session_id: SessionId, } -/// Authentication status and account metadata for the session. +/// Extensions discovered for the session, with their current status. /// ///
/// @@ -16695,27 +24655,12 @@ pub struct SessionGitHubAuthGetStatusParams { ///
#[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, +pub struct SessionExtensionsListResult { + /// Discovered extensions and their current status + pub extensions: Vec, } -/// Indicates whether the credential update succeeded. +/// Identifies the target session. /// ///
/// @@ -16725,15 +24670,12 @@ pub struct SessionGitHubAuthGetStatusResult { ///
#[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, +pub struct SessionExtensionsReloadParams { + /// Target session identifier + pub session_id: SessionId, } -/// Result of collecting a redacted debug bundle. +/// Rust-owned built-in tool descriptors for the session. /// ///
/// @@ -16743,19 +24685,12 @@ pub struct SessionGitHubAuthSetCredentialsResult { ///
#[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>, +pub struct SessionToolsGetBuiltinDescriptorsResult { + /// Built-in tool descriptors materialized for the session. + pub tools: Vec, } -/// Identifies the target session. +/// Task completion notification with summary from the agent /// ///
/// @@ -16765,12 +24700,25 @@ pub struct SessionDebugCollectLogsResult { ///
#[derive(Debug, Clone, Default, Serialize, Deserialize)] #[serde(rename_all = "camelCase")] -pub struct SessionCanvasListParams { - /// Target session identifier - pub session_id: SessionId, +pub struct SessionToolsTaskCompleteEventDataResult { + /// 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 + #[serde(skip_serializing_if = "Option::is_none")] + pub summary: Option, } -/// Declared canvases available in this session. +/// Indicates whether the external tool call result was handled successfully. /// ///
/// @@ -16780,9 +24728,9 @@ 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 SessionToolsHandlePendingToolCallResult { + /// Whether the tool call result was handled successfully + pub success: bool, } /// Identifies the target session. @@ -16795,12 +24743,12 @@ pub struct SessionCanvasListResult { ///
#[derive(Debug, Clone, Default, Serialize, Deserialize)] #[serde(rename_all = "camelCase")] -pub struct SessionCanvasListOpenParams { +pub struct SessionToolsInitializeAndValidateParams { /// Target session identifier pub session_id: SessionId, } -/// Live open-canvas snapshot. +/// 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. /// ///
/// @@ -16810,12 +24758,9 @@ 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 SessionToolsInitializeAndValidateResult {} -/// Open canvas instance snapshot. +/// Identifies the target session. /// ///
/// @@ -16825,34 +24770,12 @@ pub struct SessionCanvasListOpenResult { ///
#[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, +pub struct SessionToolsGetCurrentMetadataParams { + /// Target session identifier + pub session_id: SessionId, } -/// Canvas action invocation result. +/// Current lightweight tool metadata snapshot for the session. /// ///
/// @@ -16862,13 +24785,12 @@ pub struct SessionCanvasOpenResult { ///
#[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, +pub struct SessionToolsGetCurrentMetadataResult { + /// Current tool metadata, or null when tools have not been initialized yet + pub tools: Option>, } -/// Complete current or terminal factory run envelope. +/// Empty result after replacing the calling connection's externally implemented tools. /// ///
/// @@ -16878,29 +24800,9 @@ pub struct SessionCanvasActionInvokeResult { ///
#[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, -} +pub struct SessionToolsSetResult {} -/// Complete current or terminal factory run envelope. +/// Empty result after applying subagent settings /// ///
/// @@ -16910,29 +24812,24 @@ pub struct SessionFactoryRunResult { ///
#[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, +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, } -/// Complete current or terminal factory run envelope. +/// Whether finalizing the invocation effect succeeded, and the failure reason when it did not. /// ///
/// @@ -16942,29 +24839,15 @@ pub struct SessionFactoryGetRunResult { ///
#[derive(Debug, Clone, Default, Serialize, Deserialize)] #[serde(rename_all = "camelCase")] -pub struct SessionFactoryCancelResult { - /// Error message for an errored run. +pub struct SessionCommandsFinalizeInvocationEffectResult { + /// Failure reason when the invocation effect could not be finalized. #[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, + /// Whether the pending invocation effect was finalized successfully. + pub success: bool, } -/// Acknowledgement that a factory request was accepted. +/// Indicates whether the pending client-handled command was completed successfully. /// ///
/// @@ -16974,9 +24857,12 @@ pub struct SessionFactoryCancelResult { ///
#[derive(Debug, Clone, Default, Serialize, Deserialize)] #[serde(rename_all = "camelCase")] -pub struct SessionFactoryLogResult {} +pub struct SessionCommandsHandlePendingCommandResult { + /// Whether the command was handled successfully + pub success: bool, +} -/// Result of one factory-scoped subagent call. +/// Error message produced while executing the command, if any. /// ///
/// @@ -16986,13 +24872,13 @@ pub struct SessionFactoryLogResult {} ///
#[derive(Debug, Clone, Default, Serialize, Deserialize)] #[serde(rename_all = "camelCase")] -pub struct SessionFactoryAgentResult { - /// Agent result, omitted when the agent produced no result. +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 result: Option, + pub error: Option, } -/// Result of reading a factory journal entry. +/// Indicates whether the command was accepted into the local execution queue. /// ///
/// @@ -17002,15 +24888,12 @@ pub struct SessionFactoryAgentResult { ///
#[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, +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, } -/// Acknowledgement that a factory request was accepted. +/// Indicates whether the queued-command response was matched to a pending request. /// ///
/// @@ -17020,7 +24903,10 @@ pub struct SessionFactoryJournalGetResult { ///
#[derive(Debug, Clone, Default, Serialize, Deserialize)] #[serde(rename_all = "camelCase")] -pub struct SessionFactoryJournalPutResult {} +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. /// @@ -17032,12 +24918,12 @@ pub struct SessionFactoryJournalPutResult {} ///
#[derive(Debug, Clone, Default, Serialize, Deserialize)] #[serde(rename_all = "camelCase")] -pub struct SessionModelGetCurrentParams { +pub struct SessionTelemetryGetEngagementIdParams { /// 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. +/// Telemetry engagement ID for the session, when available. /// ///
/// @@ -17047,19 +24933,13 @@ pub struct SessionModelGetCurrentParams { ///
#[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. +pub struct SessionTelemetryGetEngagementIdResult { + /// Current telemetry engagement ID, when available. #[serde(skip_serializing_if = "Option::is_none")] - pub reasoning_effort: Option, + pub engagement_id: Option, } -/// The model identifier active on the session after the switch. +/// Completed transient query. Ordered chunks and the terminal outcome are also delivered through `ui.ephemeral_query` session events while it runs. /// ///
/// @@ -17069,13 +24949,12 @@ 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 SessionUiEphemeralQueryResult { + /// Answer returned by the model + pub answer: 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. +/// The elicitation response (accept with form values, decline, or cancel) /// ///
/// @@ -17085,12 +24964,18 @@ 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 SessionUiElicitationResult { + /// MCP response metadata. + #[serde(rename = "_meta", skip_serializing_if = "Option::is_none")] + pub meta: Option>, + /// 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>, } -/// The list of models available to this session. +/// Indicates whether the elicitation response was accepted; false if it was already resolved by another client. /// ///
/// @@ -17100,18 +24985,12 @@ 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. 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>, +pub struct SessionUiHandlePendingElicitationResult { + /// Whether the response was accepted. False if the request was already resolved by another client. + pub success: bool, } -/// Identifies the target session. +/// Indicates whether the pending UI request was resolved by this call. /// ///
/// @@ -17121,12 +25000,12 @@ 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 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, } -/// Identifies the target session. +/// Indicates whether the pending UI request was resolved by this call. /// ///
/// @@ -17136,12 +25015,12 @@ 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 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, } -/// The session's friendly name, or null when not yet set. +/// Indicates whether the pending UI request was resolved by this call. /// ///
/// @@ -17151,12 +25030,12 @@ 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 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 auto-generated summary was applied as the session's name. +/// Indicates whether the pending UI request was resolved by this call. /// ///
/// @@ -17166,12 +25045,12 @@ 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 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, } -/// Identifies the target session. +/// Indicates whether the pending UI request was resolved by this call. /// ///
/// @@ -17181,12 +25060,12 @@ 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 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, } -/// Existence, contents, and resolved path of the session plan file. +/// Identifies the target session. /// ///
/// @@ -17196,16 +25075,12 @@ 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 SessionUiRegisterDirectAutoModeSwitchHandlerParams { + /// Target session identifier + pub session_id: SessionId, } -/// Identifies the target session. +/// 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). /// ///
/// @@ -17215,12 +25090,12 @@ 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 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, } -/// Identifies the target session. +/// Indicates whether the handle was active and the registration count was decremented. /// ///
/// @@ -17230,12 +25105,12 @@ pub struct SessionPlanDeleteParams { ///
#[derive(Debug, Clone, Default, Serialize, Deserialize)] #[serde(rename_all = "camelCase")] -pub struct SessionPlanReadSqlTodosParams { - /// Target session identifier - pub session_id: SessionId, +pub struct SessionUiUnregisterDirectAutoModeSwitchHandlerResult { + /// True if the handle was active and decremented the counter; false if the handle was unknown. + pub unregistered: bool, } -/// Todo rows read from the session SQL database. Empty when no session database is available. +/// Indicates whether the operation succeeded. /// ///
/// @@ -17245,12 +25120,12 @@ pub struct SessionPlanReadSqlTodosParams { ///
#[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, +pub struct SessionPermissionsConfigureResult { + /// Whether the operation succeeded + pub success: bool, } -/// Identifies the target session. +/// Indicates whether the permission decision was applied; false when the request was already resolved. /// ///
/// @@ -17260,12 +25135,12 @@ pub struct SessionPlanReadSqlTodosResult { ///
#[derive(Debug, Clone, Default, Serialize, Deserialize)] #[serde(rename_all = "camelCase")] -pub struct SessionPlanReadSqlTodosWithDependenciesParams { - /// Target session identifier - pub session_id: SessionId, +pub struct SessionPermissionsHandlePendingPermissionRequestResult { + /// Whether the permission request was handled successfully + pub success: bool, } -/// Todo rows + dependency edges read from the session SQL database. +/// List of pending permission requests reconstructed from event history. /// ///
/// @@ -17275,14 +25150,12 @@ pub struct SessionPlanReadSqlTodosWithDependenciesParams { ///
#[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, +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, } -/// Identifies the target session. +/// Indicates whether the operation succeeded. /// ///
/// @@ -17292,54 +25165,29 @@ pub struct SessionPlanReadSqlTodosWithDependenciesResult { ///
#[derive(Debug, Clone, Default, Serialize, Deserialize)] #[serde(rename_all = "camelCase")] -pub struct SessionWorkspacesGetWorkspaceParams { - /// Target session identifier - pub session_id: SessionId, +pub struct SessionPermissionsSetApproveAllResult { + /// Whether the operation succeeded + pub success: bool, } -#[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, +/// Indicates whether the requested permission mode was applied and reports the authoritative post-mutation 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 SessionPermissionsSetModeResult { + /// Authoritative permission mode after the mutation + pub mode: PermissionMode, + /// Whether the operation succeeded + pub success: bool, } -/// Current workspace metadata for the session, including its absolute filesystem path when available. +/// Current permission mode. /// ///
/// @@ -17349,15 +25197,12 @@ 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 SessionPermissionsGetModeResult { + /// Current permission mode + pub mode: PermissionMode, } -/// Identifies the target session. +/// Indicates whether the operation succeeded. /// ///
/// @@ -17367,12 +25212,12 @@ 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 SessionPermissionsModifyRulesResult { + /// Whether the operation succeeded + pub success: bool, } -/// Relative paths of files stored in the session workspace files directory. +/// Indicates whether the operation succeeded. /// ///
/// @@ -17382,12 +25227,12 @@ 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 SessionPermissionsSetRequiredResult { + /// Whether the operation succeeded + pub success: bool, } -/// Contents of the requested workspace file as a UTF-8 string. +/// Indicates whether the operation succeeded. /// ///
/// @@ -17397,12 +25242,12 @@ 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 SessionPermissionsResetSessionApprovalsResult { + /// Whether the operation succeeded + pub success: bool, } -/// Identifies the target session. +/// Indicates whether the operation succeeded. /// ///
/// @@ -17412,12 +25257,12 @@ 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 SessionPermissionsNotifyPromptShownResult { + /// Whether the operation succeeded + pub success: bool, } -/// Workspace checkpoints in chronological order; empty when the workspace is not enabled. +/// Snapshot of the session's allow-listed directories and primary working directory. /// ///
/// @@ -17427,12 +25272,14 @@ 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 SessionPermissionsPathsListResult { + /// All directories currently allowed for tool access on this session. + pub directories: Vec, + /// The primary working directory for this session. + pub primary: String, } -/// Checkpoint content as a UTF-8 string, or null when the checkpoint or workspace is missing. +/// Indicates whether the operation succeeded. /// ///
/// @@ -17442,23 +25289,27 @@ 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, +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 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 SessionPermissionsPathsUpdatePrimaryResult { + /// Whether the operation succeeded + pub success: bool, } -/// Descriptor for the saved paste file, or null when the workspace is unavailable. +/// Indicates whether the supplied path is within the session's allowed directories. /// ///
/// @@ -17468,12 +25319,12 @@ 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 SessionPermissionsPathsIsPathWithinAllowedDirectoriesResult { + /// Whether the path is within the session's allowed directories + pub allowed: bool, } -/// Workspace diff result for the requested mode. +/// Indicates whether the supplied path is within the session's workspace directory. /// ///
/// @@ -17483,21 +25334,12 @@ 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 SessionPermissionsPathsIsPathWithinWorkspaceResult { + /// Whether the path is within the session workspace directory + pub allowed: bool, } -/// Identifies the target session. +/// Resolved location-permissions key and type. /// ///
/// @@ -17507,12 +25349,14 @@ pub struct SessionWorkspacesDiffResult { ///
#[derive(Debug, Clone, Default, Serialize, Deserialize)] #[serde(rename_all = "camelCase")] -pub struct SessionCompletionsGetTriggerCharactersParams { - /// Target session identifier - pub session_id: SessionId, +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, } -/// 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`). +/// Summary of persisted location permissions applied to the session. /// ///
/// @@ -17522,12 +25366,22 @@ pub struct SessionCompletionsGetTriggerCharactersParams { ///
#[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, +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, } -/// Host-driven completion items for the current composer input. Empty when the host returns no items or does not support completions. +/// Indicates whether the operation succeeded. /// ///
/// @@ -17537,12 +25391,12 @@ pub struct SessionCompletionsGetTriggerCharactersResult { ///
#[derive(Debug, Clone, Default, Serialize, Deserialize)] #[serde(rename_all = "camelCase")] -pub struct SessionCompletionsRequestResult { - /// Completion items in host-ranked order. - pub items: Vec, +pub struct SessionPermissionsLocationsAddToolApprovalResult { + /// Whether the operation succeeded + pub success: bool, } -/// Identifies the target session. +/// Folder trust check result. /// ///
/// @@ -17552,12 +25406,12 @@ pub struct SessionCompletionsRequestResult { ///
#[derive(Debug, Clone, Default, Serialize, Deserialize)] #[serde(rename_all = "camelCase")] -pub struct SessionInstructionsGetSourcesParams { - /// Target session identifier - pub session_id: SessionId, +pub struct SessionPermissionsFolderTrustIsTrustedResult { + /// Whether the folder is trusted + pub trusted: bool, } -/// Instruction sources loaded for the session, in merge order. +/// Indicates whether the operation succeeded. /// ///
/// @@ -17567,12 +25421,12 @@ 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 SessionPermissionsFolderTrustAddTrustedResult { + /// Whether the operation succeeded + pub success: bool, } -/// Indicates whether fleet mode was successfully activated. +/// Indicates whether the operation succeeded. /// ///
/// @@ -17582,9 +25436,24 @@ 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 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. @@ -17597,12 +25466,47 @@ pub struct SessionFleetStartResult { /// #[derive(Debug, Clone, Default, Serialize, Deserialize)] #[serde(rename_all = "camelCase")] -pub struct SessionAgentListParams { +pub struct SessionMetadataSnapshotParams { /// Target session identifier pub session_id: SessionId, } -/// Custom agents available to the session. +/// 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 /// ///
/// @@ -17612,9 +25516,42 @@ pub struct SessionAgentListParams { ///
#[derive(Debug, Clone, Default, Serialize, Deserialize)] #[serde(rename_all = "camelCase")] -pub struct SessionAgentListResult { - /// Available custom agents - pub agents: Vec, +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. @@ -17627,27 +25564,12 @@ pub struct SessionAgentListResult { /// #[derive(Debug, Clone, Default, Serialize, Deserialize)] #[serde(rename_all = "camelCase")] -pub struct SessionAgentGetCurrentParams { +pub struct SessionMetadataIsProcessingParams { /// 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. +/// Indicates whether the local session is currently processing a turn or background continuation. /// ///
/// @@ -17657,9 +25579,9 @@ 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 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. @@ -17672,12 +25594,12 @@ pub struct SessionAgentSelectResult { /// #[derive(Debug, Clone, Default, Serialize, Deserialize)] #[serde(rename_all = "camelCase")] -pub struct SessionAgentDeselectParams { +pub struct SessionMetadataActivityParams { /// Target session identifier pub session_id: SessionId, } -/// Identifies the target session. +/// Current activity flags for the session. /// ///
/// @@ -17687,27 +25609,40 @@ 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 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, } -/// 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. -/// -///
+/// Token-usage breakdown for the session's current context window #[derive(Debug, Clone, Default, Serialize, Deserialize)] #[serde(rename_all = "camelCase")] -pub struct SessionAgentReloadResult { - /// Reloaded custom agents - pub agents: Vec, +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, } -/// Identifier assigned to the newly started background agent task. +/// Token breakdown for the session's current context window, or null if uninitialized. /// ///
/// @@ -17717,9 +25652,9 @@ 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 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. @@ -17732,69 +25667,85 @@ pub struct SessionTasksStartAgentResult { /// #[derive(Debug, Clone, Default, Serialize, Deserialize)] #[serde(rename_all = "camelCase")] -pub struct SessionTasksListParams { +pub struct SessionMetadataGetContextAttributionParams { /// 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. -/// -///
+/// 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 SessionTasksListResult { - /// Currently tracked tasks - pub tasks: Vec, +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, } -/// 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. -/// -///
+/// Successful compaction history for the session. #[derive(Debug, Clone, Default, Serialize, Deserialize)] #[serde(rename_all = "camelCase")] -pub struct SessionTasksRefreshParams { - /// Target session identifier - pub session_id: SessionId, +pub struct SessionMetadataGetContextAttributionResultContextAttributionCompactions { + /// Number of successful compactions in this session. + pub count: i64, } -/// 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 {} +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, +} -/// 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. -/// -///
+/// 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 SessionTasksWaitForPendingParams { - /// Target session identifier - pub session_id: SessionId, +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, } -/// 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). +/// Per-source attribution breakdown for the session's current context window, or null if uninitialized. /// ///
/// @@ -17804,9 +25755,12 @@ pub struct SessionTasksWaitForPendingParams { ///
#[derive(Debug, Clone, Default, Serialize, Deserialize)] #[serde(rename_all = "camelCase")] -pub struct SessionTasksWaitForPendingResult {} +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, +} -/// Progress information for the task, or null when no task with that ID is tracked. +/// The heaviest individual messages in the session's context window, most-expensive first. /// ///
/// @@ -17816,12 +25770,14 @@ 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 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, } -/// Identifies the target session. +/// 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. /// ///
/// @@ -17831,12 +25787,9 @@ 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 SessionMetadataRecordContextChangeResult {} -/// The first sync-waiting task that can currently be promoted to background mode. +/// 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. /// ///
/// @@ -17846,13 +25799,12 @@ 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 SessionMetadataSetWorkingDirectoryResult { + /// Working directory after the update + pub working_directory: String, } -/// Indicates whether the task was successfully promoted to background mode. +/// 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. /// ///
/// @@ -17862,9 +25814,13 @@ 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 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. @@ -17877,12 +25833,12 @@ pub struct SessionTasksPromoteToBackgroundResult { /// #[derive(Debug, Clone, Default, Serialize, Deserialize)] #[serde(rename_all = "camelCase")] -pub struct SessionTasksPromoteCurrentToBackgroundParams { +pub struct SessionSettingsSnapshotParams { /// Target session identifier pub session_id: SessionId, } -/// The promoted task as it now exists in background mode, omitted if no promotable task was waiting. +/// Redacted, serializable view of session runtime settings for SDK boundary consumers. Secrets and raw feature flags are intentionally excluded. /// ///
/// @@ -17892,13 +25848,32 @@ 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. +pub struct SessionSettingsSnapshotResult { + /// Name of the SDK client that created the session. #[serde(skip_serializing_if = "Option::is_none")] - pub task: Option, + pub client_name: Option, + /// Redacted job settings. + pub job: SessionSettingsJobSnapshot, + /// Redacted model routing settings. + pub model: SessionSettingsModelSnapshot, + /// Online-evaluation settings safe for SDK consumers. + pub online_evaluation: SessionSettingsOnlineEvaluationSnapshot, + /// Redacted repository and host settings. + pub repo: SessionSettingsRepoSnapshot, + /// Session start time as Unix epoch milliseconds. + #[serde(skip_serializing_if = "Option::is_none")] + pub start_time_ms: Option, + /// Session timeout in milliseconds. + #[serde(skip_serializing_if = "Option::is_none")] + pub timeout_ms: Option, + /// Redacted validation and memory-tool settings. + pub validation: SessionSettingsValidationSnapshot, + /// Agent runtime version selector copied from the session settings, such as `latest` or a runtime release identifier. + #[serde(skip_serializing_if = "Option::is_none")] + pub version: Option, } -/// Indicates whether the background task was successfully cancelled. +/// Batch content-exclusion result. Callers must fail closed when policy evaluation is unavailable. /// ///
/// @@ -17908,12 +25883,14 @@ 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 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, } -/// Indicates whether the task was removed. False when the task does not exist or is still running/idle. +/// Identifier of the spawned process, used to correlate streamed output and exit notifications. /// ///
/// @@ -17923,12 +25900,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 SessionShellExecResult { + /// Unique identifier for tracking streamed output + pub process_id: String, } -/// Indicates whether the message was delivered, with an error message when delivery failed. +/// Indicates whether the signal was delivered; false if the process was unknown or already exited. /// ///
/// @@ -17938,15 +25915,12 @@ 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 SessionShellKillResult { + /// Whether the signal was sent successfully + pub killed: bool, } -/// Identifies the target session. +/// Result of a user-requested shell command. /// ///
/// @@ -17956,12 +25930,22 @@ 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 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, } -/// Skills available to the session, with their enabled state. +/// Cancellation result for a user-requested shell command. /// ///
/// @@ -17971,12 +25955,12 @@ pub struct SessionSkillsListParams { ///
#[derive(Debug, Clone, Default, Serialize, Deserialize)] #[serde(rename_all = "camelCase")] -pub struct SessionSkillsListResult { - /// Available skills - pub skills: Vec, +pub struct SessionShellCancelUserRequestedResult { + /// Whether an in-flight execution was found and signalled to cancel + pub cancelled: bool, } -/// Identifies the target session. +/// Compaction outcome with the number of tokens and messages removed, summary text, and the resulting context window breakdown. /// ///
/// @@ -17986,12 +25970,22 @@ 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 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, } -/// Skills invoked during this session, ordered by invocation time (most recent last). +/// Number of events that were removed by the truncation. /// ///
/// @@ -18001,9 +25995,15 @@ 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 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. @@ -18016,12 +26016,12 @@ pub struct SessionSkillsGetInvokedResult { /// #[derive(Debug, Clone, Default, Serialize, Deserialize)] #[serde(rename_all = "camelCase")] -pub struct SessionSkillsReloadParams { +pub struct SessionHistoryListRewindPointsParams { /// Target session identifier pub session_id: SessionId, } -/// Diagnostics from reloading skill definitions, with warnings and errors as separate lists. +/// Rewind points and file-change-tracking availability for the session. /// ///
/// @@ -18031,14 +26031,17 @@ 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 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, } -/// Identifies the target session. +/// Files and aggregate changes for a prospective rewind. /// ///
/// @@ -18048,12 +26051,19 @@ pub struct SessionSkillsReloadResult { ///
#[derive(Debug, Clone, Default, Serialize, Deserialize)] #[serde(rename_all = "camelCase")] -pub struct SessionSkillsEnsureLoadedParams { - /// Target session identifier - pub session_id: SessionId, +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, } -/// Identifies the target session. +/// Structured outcome of a rewind request. /// ///
/// @@ -18063,12 +26073,22 @@ pub struct SessionSkillsEnsureLoadedParams { ///
#[derive(Debug, Clone, Default, Serialize, Deserialize)] #[serde(rename_all = "camelCase")] -pub struct SessionMcpListParams { - /// Target session identifier - pub session_id: SessionId, +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, } -/// MCP servers configured for the session, with their connection status and host-level state. +/// Identifies the target session. /// ///
/// @@ -18078,15 +26098,12 @@ pub struct SessionMcpListParams { ///
#[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, +pub struct SessionHistoryCancelBackgroundCompactionParams { + /// Target session identifier + pub session_id: SessionId, } -/// Tools exposed by the connected MCP server. Throws when the server is not connected. +/// Indicates whether an in-progress background compaction was cancelled. /// ///
/// @@ -18096,9 +26113,9 @@ pub struct SessionMcpListResult { ///
#[derive(Debug, Clone, Default, Serialize, Deserialize)] #[serde(rename_all = "camelCase")] -pub struct SessionMcpListToolsResult { - /// Tools exposed by the server. - pub tools: Vec, +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. @@ -18111,12 +26128,12 @@ pub struct SessionMcpListToolsResult { /// #[derive(Debug, Clone, Default, Serialize, Deserialize)] #[serde(rename_all = "camelCase")] -pub struct SessionMcpReloadParams { +pub struct SessionHistoryAbortManualCompactionParams { /// Target session identifier pub session_id: SessionId, } -/// MCP server startup filtering result. +/// Indicates whether an in-progress manual compaction was aborted. /// ///
/// @@ -18126,15 +26143,12 @@ pub struct SessionMcpReloadParams { ///
#[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, +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, } -/// Outcome of an MCP sampling execution: success result, failure error, or cancellation. +/// Identifies the target session. /// ///
/// @@ -18144,18 +26158,12 @@ pub struct SessionMcpReloadWithConfigResult { ///
#[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, +pub struct SessionHistorySummarizeForHandoffParams { + /// Target session identifier + pub session_id: SessionId, } -/// Indicates whether an in-flight sampling execution with the given requestId was found and cancelled. +/// Markdown summary of the conversation context (empty when not available). /// ///
/// @@ -18165,12 +26173,12 @@ 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 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, } -/// Env-value mode recorded on the session after the update. +/// What a successful clear removed. A clear that could not be applied rejects instead of reporting a count. /// ///
/// @@ -18180,9 +26188,9 @@ 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 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. @@ -18195,12 +26203,12 @@ pub struct SessionMcpSetEnvValueModeResult { /// #[derive(Debug, Clone, Default, Serialize, Deserialize)] #[serde(rename_all = "camelCase")] -pub struct SessionMcpRemoveGitHubParams { +pub struct SessionQueuePendingItemsParams { /// Target session identifier pub session_id: SessionId, } -/// Indicates whether the auto-managed `github` MCP server was removed (false when nothing to remove). +/// Snapshot of the session's pending queued items and immediate-steering messages. /// ///
/// @@ -18210,12 +26218,17 @@ 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 SessionQueuePendingItemsResult { + /// How many leading entries of `steeringMessages` have already been folded into the running turn (and so have an emitted `user.message`), as opposed to still waiting for one. Absent for hosts that do not distinguish the two. + #[serde(skip_serializing_if = "Option::is_none")] + pub in_flight_steering_count: Option, + /// 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, } -/// Result of configuring GitHub MCP. +/// Identifies the target session. /// ///
/// @@ -18225,12 +26238,12 @@ pub struct SessionMcpRemoveGitHubResult { ///
#[derive(Debug, Clone, Default, Serialize, Deserialize)] #[serde(rename_all = "camelCase")] -pub struct SessionMcpConfigureGitHubResult { - /// Whether GitHub MCP configuration changed. - pub changed: bool, +pub struct SessionQueueSnapshotParams { + /// Target session identifier + pub session_id: SessionId, } -/// Whether the named MCP server is running. +/// Internal snapshot of native queue state for local session orchestration. /// ///
/// @@ -18240,12 +26253,20 @@ pub struct SessionMcpConfigureGitHubResult { ///
#[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, +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, } -/// Indicates whether the pending MCP OAuth response was accepted. +/// Result of moving a queued item. /// ///
/// @@ -18255,12 +26276,12 @@ pub struct SessionMcpIsServerRunningResult { ///
#[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, +pub struct SessionQueueMoveItemResult { + /// True when the item changed position; false when it was already at the requested position. + pub changed: bool, } -/// OAuth authorization URL the caller should open, or empty when cached tokens already authenticated the server. +/// Result of inserting a queued message. /// ///
/// @@ -18270,13 +26291,12 @@ pub struct SessionMcpOauthHandlePendingRequestResult { ///
#[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 SessionQueueInsertAtResult { + /// Fresh stable opaque id assigned to the inserted item. + pub id: String, } -/// Indicates whether the pending MCP headers refresh response was accepted. +/// Result of removing a queued item. /// ///
/// @@ -18286,12 +26306,12 @@ pub struct SessionMcpOauthLoginResult { ///
#[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, +pub struct SessionQueueRemoveAtResult { + /// True when the addressed item was removed. + pub removed: bool, } -/// Resource contents returned by the MCP server. +/// Result of editing a queued message. /// ///
/// @@ -18301,12 +26321,12 @@ pub struct SessionMcpHeadersHandlePendingHeadersRefreshRequestResult { ///
#[derive(Debug, Clone, Default, Serialize, Deserialize)] #[serde(rename_all = "camelCase")] -pub struct SessionMcpAppsReadResourceResult { - /// Resource contents returned by the server - pub contents: Vec, +pub struct SessionQueueUpdateTextResult { + /// True when the stored text changed. + pub updated: bool, } -/// App-callable tools from the named MCP server. +/// Result of duplicating a queued item. /// ///
/// @@ -18316,12 +26336,12 @@ 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 SessionQueueDuplicateAtResult { + /// Fresh stable opaque id assigned to the duplicate. + pub id: String, } -/// Identifies the target session. +/// Result of trying to steer a queued message into a live turn. /// ///
/// @@ -18331,12 +26351,12 @@ 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 SessionQueueSendNowResult { + /// True when the item was accepted into the steering lane; false when no main turn was live. + pub steered: bool, } -/// Current host context advertised to MCP App guests. +/// Identifies the target session. /// ///
/// @@ -18346,12 +26366,12 @@ pub struct SessionMcpAppsGetHostContextParams { ///
#[derive(Debug, Clone, Default, Serialize, Deserialize)] #[serde(rename_all = "camelCase")] -pub struct SessionMcpAppsGetHostContextResult { - /// Current host context - pub context: McpAppsHostContextDetails, +pub struct SessionQueueHasPendingParams { + /// Target session identifier + pub session_id: SessionId, } -/// Diagnostic snapshot of MCP Apps wiring for the named server. +/// Whether the native queue has pending work. /// ///
/// @@ -18361,14 +26381,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 SessionQueueHasPendingResult { + /// True when queued or immediate native work is pending. + pub has_pending: bool, } -/// Resource contents returned by the MCP server. +/// Whether a deferred-idle drain should run. /// ///
/// @@ -18378,12 +26396,12 @@ pub struct SessionMcpAppsDiagnoseResult { ///
#[derive(Debug, Clone, Default, Serialize, Deserialize)] #[serde(rename_all = "camelCase")] -pub struct SessionMcpResourcesReadResult { - /// Resource contents returned by the server - pub contents: Vec, +pub struct SessionQueueBeginDeferredIdleDrainResult { + /// True when the host should run finishDeferredIdleDrain asynchronously. + pub should_drain: bool, } -/// One page of resources advertised by the named MCP server. +/// Action selected by the native deferred-idle drain. /// ///
/// @@ -18393,15 +26411,14 @@ pub struct SessionMcpResourcesReadResult { ///
#[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, +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, } -/// One page of resource templates advertised by the named MCP server. +/// Identifies the target session. /// ///
/// @@ -18411,15 +26428,12 @@ pub struct SessionMcpResourcesListResult { ///
#[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, +pub struct SessionQueueRemoveMostRecentParams { + /// Target session identifier + pub session_id: SessionId, } -/// Identifies the target session. +/// Indicates whether a user-facing pending item was removed. /// ///
/// @@ -18429,12 +26443,12 @@ pub struct SessionMcpResourcesListTemplatesResult { ///
#[derive(Debug, Clone, Default, Serialize, Deserialize)] #[serde(rename_all = "camelCase")] -pub struct SessionPluginsListParams { - /// Target session identifier - pub session_id: SessionId, +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, } -/// Plugins installed for the session, with their enabled state and version metadata. +/// Identifies the target session. /// ///
/// @@ -18444,43 +26458,27 @@ pub struct SessionPluginsListParams { ///
#[derive(Debug, Clone, Default, Serialize, Deserialize)] #[serde(rename_all = "camelCase")] -pub struct SessionPluginsListResult { - /// Installed plugins - pub plugins: Vec, +pub struct SessionQueueClearParams { + /// Target session identifier + pub session_id: SessionId, } -/// A snapshot of the provider endpoint the session is currently configured to talk to. +/// 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 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, +/// **Experimental.** This type is part of an experimental wire-protocol surface +/// 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, } -/// The selectable model entries synthesized for the models added by this call. +/// Identifies the target session. /// ///
/// @@ -18490,12 +26488,12 @@ pub struct SessionProviderGetEndpointResult { ///
#[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, +pub struct SessionQueueEnqueueResumePendingParams { + /// Target session identifier + pub session_id: SessionId, } -/// Indicates whether the session options patch was applied successfully. +/// Result of enqueueing the resume-pending wake item. /// ///
/// @@ -18505,12 +26503,9 @@ pub struct SessionProviderAddResult { ///
#[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, +pub struct SessionQueueEnqueueResumePendingResult { + /// True when a wake item was newly queued. + pub queued: bool, } /// Identifies the target session. @@ -18523,12 +26518,12 @@ pub struct SessionOptionsUpdateResult { /// #[derive(Debug, Clone, Default, Serialize, Deserialize)] #[serde(rename_all = "camelCase")] -pub struct SessionExtensionsListParams { +pub struct SessionQueueProcessParams { /// Target session identifier pub session_id: SessionId, } -/// Extensions discovered for the session, with their current status. +/// Batch of session events returned by a read, with cursor and continuation metadata. /// ///
/// @@ -18538,9 +26533,15 @@ 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 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. @@ -18553,12 +26554,12 @@ pub struct SessionExtensionsListResult { /// #[derive(Debug, Clone, Default, Serialize, Deserialize)] #[serde(rename_all = "camelCase")] -pub struct SessionExtensionsReloadParams { +pub struct SessionEventLogTailParams { /// Target session identifier pub session_id: SessionId, } -/// Indicates whether the external tool call result was handled successfully. +/// 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). /// ///
/// @@ -18568,12 +26569,12 @@ 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 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, } -/// Identifies the target session. +/// Opaque handle representing an event-type interest registration. /// ///
/// @@ -18583,12 +26584,12 @@ 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 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, } -/// 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. +/// Indicates whether the operation succeeded. /// ///
/// @@ -18598,7 +26599,10 @@ pub struct SessionToolsInitializeAndValidateParams { ///
#[derive(Debug, Clone, Default, Serialize, Deserialize)] #[serde(rename_all = "camelCase")] -pub struct SessionToolsInitializeAndValidateResult {} +pub struct SessionEventLogReleaseInterestResult { + /// Whether the operation succeeded + pub success: bool, +} /// Identifies the target session. /// @@ -18610,12 +26614,12 @@ pub struct SessionToolsInitializeAndValidateResult {} /// #[derive(Debug, Clone, Default, Serialize, Deserialize)] #[serde(rename_all = "camelCase")] -pub struct SessionToolsGetCurrentMetadataParams { +pub struct SessionUsageGetMetricsParams { /// Target session identifier pub session_id: SessionId, } -/// Current lightweight tool metadata snapshot for the session. +/// Accumulated session usage metrics, including premium request cost, token counts, model breakdown, and code-change totals. /// ///
/// @@ -18625,12 +26629,38 @@ 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 SessionUsageGetMetricsResult { + /// Per-agent usage metrics, keyed by agent instance identifier. The main conversation uses the stable key `main`. + #[serde(skip_serializing_if = "Option::is_none")] + pub agent_metrics: Option>, + /// 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, } -/// Empty result after applying subagent settings +/// GitHub URL for the session and a flag indicating whether remote steering is enabled. /// ///
/// @@ -18640,9 +26670,15 @@ pub struct SessionToolsGetCurrentMetadataResult { ///
#[derive(Debug, Clone, Default, Serialize, Deserialize)] #[serde(rename_all = "camelCase")] -pub struct SessionToolsUpdateSubagentSettingsResult {} +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, +} -/// Slash commands available in the session, after applying any include/exclude filters. +/// Identifies the target session. /// ///
/// @@ -18652,12 +26688,12 @@ pub struct SessionToolsUpdateSubagentSettingsResult {} ///
#[derive(Debug, Clone, Default, Serialize, Deserialize)] #[serde(rename_all = "camelCase")] -pub struct SessionCommandsListResult { - /// Commands available in this session - pub commands: Vec, +pub struct SessionRemoteDisableParams { + /// Target session identifier + pub session_id: SessionId, } -/// Indicates whether the pending client-handled command was completed successfully. +/// 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. /// ///
/// @@ -18667,12 +26703,9 @@ 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 SessionRemoteNotifySteerableChangedResult {} -/// Error message produced while executing the command, if any. +/// Identifies the target session. /// ///
/// @@ -18682,13 +26715,12 @@ 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. - #[serde(skip_serializing_if = "Option::is_none")] - pub error: Option, +pub struct SessionVisibilityGetParams { + /// Target session identifier + pub session_id: SessionId, } -/// Indicates whether the command was accepted into the local execution queue. +/// Current sharing status and shareable GitHub URL for a session. /// ///
/// @@ -18698,12 +26730,18 @@ 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 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, } -/// Indicates whether the queued-command response was matched to a pending request. +/// Effective sharing status and shareable GitHub URL after updating session visibility. /// ///
/// @@ -18713,9 +26751,15 @@ 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 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. @@ -18728,12 +26772,12 @@ pub struct SessionCommandsRespondToQueuedCommandResult { /// #[derive(Debug, Clone, Default, Serialize, Deserialize)] #[serde(rename_all = "camelCase")] -pub struct SessionTelemetryGetEngagementIdParams { +pub struct SessionScheduleListParams { /// Target session identifier pub session_id: SessionId, } -/// Telemetry engagement ID for the session, when available. +/// Snapshot of the currently active recurring prompts for this session. /// ///
/// @@ -18743,13 +26787,12 @@ pub struct SessionTelemetryGetEngagementIdParams { ///
#[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, +pub struct SessionScheduleListResult { + /// Active scheduled prompts, ordered by id. + pub entries: Vec, } -/// Transient answer generated from current conversation context. +/// Identifies the target session. /// ///
/// @@ -18759,12 +26802,12 @@ pub struct SessionTelemetryGetEngagementIdResult { ///
#[derive(Debug, Clone, Default, Serialize, Deserialize)] #[serde(rename_all = "camelCase")] -pub struct SessionUiEphemeralQueryResult { - /// Full assistant response text. - pub answer: String, +pub struct SessionScheduleHydrateParams { + /// Target session identifier + pub session_id: SessionId, } -/// The elicitation response (accept with form values, decline, or cancel) +/// Identifies the target session. /// ///
/// @@ -18774,15 +26817,12 @@ pub struct SessionUiEphemeralQueryResult { ///
#[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>, +pub struct SessionScheduleHasSelfPacedParams { + /// Target session identifier + pub session_id: SessionId, } -/// Indicates whether the elicitation response was accepted; false if it was already resolved by another client. +/// Whether the session currently has an active self-paced schedule. /// ///
/// @@ -18792,12 +26832,12 @@ 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 SessionScheduleHasSelfPacedResult { + /// 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. +/// Result of registering or re-arming a scheduled prompt. /// ///
/// @@ -18807,12 +26847,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 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, } -/// Indicates whether the pending UI request was resolved by this call. +/// Result of registering or re-arming a scheduled prompt. /// ///
/// @@ -18822,12 +26866,16 @@ 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 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, } -/// Indicates whether the pending UI request was resolved by this call. +/// Result of registering or re-arming a scheduled prompt. /// ///
/// @@ -18837,12 +26885,16 @@ 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 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, } -/// Indicates whether the pending UI request was resolved by this call. +/// Result of registering or re-arming a scheduled prompt. /// ///
/// @@ -18852,12 +26904,16 @@ pub struct SessionUiHandlePendingAutoModeSwitchResult { ///
#[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, +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, } -/// Indicates whether the pending UI request was resolved by this call. +/// Result of registering or re-arming a scheduled prompt. /// ///
/// @@ -18867,12 +26923,16 @@ pub struct SessionUiHandlePendingSessionLimitsExhaustedResult { ///
#[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 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, } -/// Identifies the target session. +/// Remove a scheduled prompt by id. The result entry is omitted if the id was unknown. /// ///
/// @@ -18882,12 +26942,13 @@ 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 SessionScheduleStopResult { + /// The removed entry, or omitted if no entry matched. + #[serde(skip_serializing_if = "Option::is_none")] + pub entry: 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). +/// 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. /// ///
/// @@ -18897,12 +26958,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 ProviderTokenGetTokenResult { + /// The bearer token value (without the `Bearer ` prefix). + pub token: String, } -/// Indicates whether the handle was active and the registration count was decremented. +/// Acknowledgement that a factory request was accepted. /// ///
/// @@ -18912,12 +26973,9 @@ 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 FactoryAbortResult {} -/// Indicates whether the operation succeeded. +/// Identifies the target session. /// ///
/// @@ -18927,12 +26985,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 SessionFsSqliteExistsParams { + /// Target session identifier + pub session_id: SessionId, } -/// Indicates whether the permission decision was applied; false when the request was already resolved. +/// Canvas open result returned by the provider. /// ///
/// @@ -18942,12 +27000,19 @@ 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 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, } -/// List of pending permission requests reconstructed from event history. +/// Validation errors from the most recent authentication attempt. /// ///
/// @@ -18955,14 +27020,9 @@ pub struct SessionPermissionsHandlePendingPermissionRequestResult { /// 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, -} +pub type AuthValidationErrors = Vec; -/// Indicates whether the operation succeeded. +/// SHA-256 digest encoded as exactly 64 lowercase hexadecimal characters. /// ///
/// @@ -18970,14 +27030,9 @@ pub struct SessionPermissionsPendingRequestsResult { /// 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, -} +pub type CardDigestValue = String; -/// Indicates whether the operation succeeded and reports the post-mutation state. +/// Bounded extensible wire-feature identifier. Known values are described by `CatalogCapability`; newer callers may send future identifiers so an older runtime can return a typed negotiation refusal instead of failing schema validation. Capability negotiation establishes contract understanding, while each operation's result separately reports runtime availability. /// ///
/// @@ -18985,19 +27040,9 @@ pub struct SessionPermissionsSetApproveAllResult { /// 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, -} +pub type CatalogCapabilityId = String; -/// Current allow-all permission mode. +/// HTTP headers as a map from lowercased header name to a list of values. Multi-valued headers (e.g. Set-Cookie) preserve all values. /// ///
/// @@ -19005,17 +27050,9 @@ pub struct SessionPermissionsSetAllowAllResult { /// 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, -} +pub type LlmInferenceHeaders = HashMap>; -/// 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. /// ///
/// @@ -19023,14 +27060,9 @@ pub struct SessionPermissionsGetAllowAllResult { /// 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, -} +pub type McpExecuteSamplingResult = HashMap; -/// Indicates whether the operation succeeded. +/// A runtime-assigned secret placeholder. The identifier is carried once, inside the placeholder, so it cannot contradict a separate secret-id field. /// ///
/// @@ -19038,14 +27070,9 @@ pub struct SessionPermissionsModifyRulesResult { /// 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, -} +pub type McpPlanSecretReference = String; -/// Indicates whether the operation succeeded. +/// The form values submitted by the user (present when action is 'accept') /// ///
/// @@ -19053,14 +27080,9 @@ pub struct SessionPermissionsSetRequiredResult { /// 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, -} +pub type UIElicitationResponseContent = HashMap; -/// Indicates whether the operation succeeded. +/// List of all authenticated users /// ///
/// @@ -19068,14 +27090,9 @@ pub struct SessionPermissionsResetSessionApprovalsResult { /// 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, -} +pub type AccountGetAllUsersResult = Vec; -/// Snapshot of the session's allow-listed directories and primary working directory. +/// The number of running background agents (task-registry agents) that were cancelled. /// ///
/// @@ -19083,16 +27100,9 @@ pub struct SessionPermissionsNotifyPromptShownResult { /// 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, -} +pub type SessionCancelAllBackgroundAgentsResult = i64; -/// Indicates whether the operation succeeded. +/// Authentication accounts available to the internal session host. /// ///
/// @@ -19100,14 +27110,9 @@ pub struct SessionPermissionsPathsListResult { /// 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, -} +pub type SessionGitHubAuthGetAllAuthAvailableResult = Vec; -/// Indicates whether the operation succeeded. +/// Whether the current authentication was logged out. /// ///
/// @@ -19115,14 +27120,9 @@ pub struct SessionPermissionsPathsAddResult { /// 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, -} +pub type SessionGitHubAuthLogoutResult = bool; -/// Indicates whether the supplied path is within the session's allowed directories. +/// Whether the requested authentication was logged out. /// ///
/// @@ -19130,14 +27130,9 @@ pub struct SessionPermissionsPathsUpdatePrimaryResult { /// 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, -} +pub type SessionGitHubAuthLogoutUserResult = bool; -/// Indicates whether the supplied path is within the session's workspace directory. +/// Validation errors from the most recent authentication attempt. /// ///
/// @@ -19145,14 +27140,9 @@ pub struct SessionPermissionsPathsIsPathWithinAllowedDirectoriesResult { /// 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, -} +pub type SessionGitHubAuthLastAuthErrorsResult = Vec; -/// Resolved location-permissions key and type. +/// Standard MCP CallToolResult /// ///
/// @@ -19160,16 +27150,89 @@ pub struct SessionPermissionsPathsIsPathWithinWorkspaceResult { /// 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, +pub type SessionMcpAppsCallToolResult = HashMap; + +/// 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, } -/// Summary of persisted location permissions applied to the session. +/// HMAC-based authentication used by GitHub-internal services. +#[derive(Debug, Clone, Default, PartialEq, Eq, Serialize, Deserialize)] +pub enum HMACAuthInfoType { + #[serde(rename = "hmac")] + #[default] + Hmac, +} + +/// 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, +} + +/// SDK-side token authentication; the host configured the token directly via the SDK. +#[derive(Debug, Clone, Default, PartialEq, Eq, Serialize, Deserialize)] +pub enum TokenAuthInfoType { + #[serde(rename = "token")] + #[default] + Token, +} + +/// SDK callback-backed GitHub token authentication. +#[derive(Debug, Clone, Default, PartialEq, Eq, Serialize, Deserialize)] +pub enum TokenProviderAuthInfoType { + #[serde(rename = "token-provider")] + #[default] + TokenProvider, +} + +/// 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, +} + +/// 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 { + #[serde(rename = "user")] + #[default] + User, +} + +/// 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, +} + +/// 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, +} + +/// Authentication credentials accepted only at native protocol ingress. Runtime outputs use credential-free `AuthIdentity` metadata. /// ///
/// @@ -19177,24 +27240,20 @@ pub struct SessionPermissionsLocationsResolveResult { /// 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, +#[derive(Debug, Clone, Serialize, Deserialize)] +#[serde(untagged)] +pub enum AuthInfo { + Hmac(HMACAuthInfo), + Env(EnvAuthInfo), + Token(TokenAuthInfo), + TokenProvider(TokenProviderAuthInfo), + CopilotApiToken(CopilotApiTokenAuthInfo), + User(UserAuthInfo), + GhCli(GhCliAuthInfo), + ApiKey(ApiKeyAuthInfo), } -/// Indicates whether the operation succeeded. +/// Resolved Anthropic adaptive-thinking capability for a model. /// ///
/// @@ -19202,14 +27261,24 @@ pub struct SessionPermissionsLocationsApplyResult { /// 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, +#[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, } -/// Folder trust check result. +/// Which tier this directory belongs to /// ///
/// @@ -19217,14 +27286,21 @@ pub struct SessionPermissionsLocationsAddToolApprovalResult { /// 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, +#[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, } -/// Indicates whether the operation succeeded. +/// Where the agent definition was loaded from /// ///
/// @@ -19232,14 +27308,33 @@ pub struct SessionPermissionsFolderTrustIsTrustedResult { /// 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, +#[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, } -/// Indicates whether the operation succeeded. +/// Kind of attention required when status === "attention". Meaningful only when status === "attention". /// ///
/// @@ -19247,14 +27342,30 @@ pub struct SessionPermissionsFolderTrustAddTrustedResult { /// 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, +#[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, } -/// Identifier of the session event that was emitted for the log message. +/// Process kind tag for the registry entry /// ///
/// @@ -19262,14 +27373,21 @@ pub struct SessionPermissionsUrlsSetUnrestrictedModeResult { /// 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, +#[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, } -/// Identifies the target session. +/// How the most recent turn ended (clean vs aborted). Lets the renderer distinguish done from done_cancelled. /// ///
/// @@ -19277,49 +27395,21 @@ pub struct SessionLogResult { /// 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, +#[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, } -/// Point-in-time snapshot of slow-changing session identifier and state fields +/// Coarse lifecycle status of the foreground session /// ///
/// @@ -19327,47 +27417,27 @@ pub struct SessionMetadataSnapshotResultWorkspace { /// 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, +#[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, } -/// Identifies the target session. +/// Categorized reason for log-open failure /// ///
/// @@ -19375,14 +27445,32 @@ pub struct SessionMetadataSnapshotResult { /// 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, +#[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, } -/// Indicates whether the local session is currently processing a turn or background continuation. +/// 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. /// ///
/// @@ -19390,14 +27478,37 @@ pub struct SessionMetadataIsProcessingParams { /// 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, +#[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. + #[default] + #[serde(other)] + Unknown, +} + +/// 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, } -/// Identifies the target session. +/// Which parameter field was invalid. Omitted when the rejection is not field-specific. /// ///
/// @@ -19405,14 +27516,38 @@ pub struct SessionMetadataIsProcessingResult { /// 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, +#[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, } -/// Current activity flags for the session. +/// 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. /// ///
/// @@ -19420,42 +27555,33 @@ pub struct SessionMetadataActivityParams { /// 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, +#[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, } -/// Token breakdown for the session's current context window, or null if uninitialized. +/// Outcome of an agentRegistry.spawn call. /// ///
/// @@ -19463,14 +27589,80 @@ pub struct SessionMetadataContextInfoResultContextInfo { /// 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, +#[derive(Debug, Clone, Serialize, Deserialize)] +#[serde(untagged)] +pub enum AgentRegistrySpawnResult { + Spawned(AgentRegistrySpawnSpawned), + SpawnError(AgentRegistrySpawnError), + RegistryTimeout(AgentRegistrySpawnRegistryTimeout), + ValidationError(AgentRegistrySpawnValidationError), } -/// Identifies the target session. +/// 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 /// ///
/// @@ -19478,53 +27670,72 @@ pub struct SessionMetadataContextInfoResult { /// 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, +#[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, } -/// 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, +/// Attachment type discriminator +#[derive(Debug, Clone, Default, PartialEq, Eq, Serialize, Deserialize)] +pub enum AttachmentGitHubReleaseType { + #[serde(rename = "github_release")] + #[default] + GitHubRelease, } -#[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, +/// 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, } -/// 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 { - /// Successful compaction history for the session. - pub compactions: SessionMetadataGetContextAttributionResultContextAttributionCompactions, - /// 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, - /// 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, +/// Attachment type discriminator +#[derive(Debug, Clone, Default, PartialEq, Eq, Serialize, Deserialize)] +pub enum AttachmentSelectionType { + #[serde(rename = "selection")] + #[default] + Selection, } -/// Per-source attribution breakdown for the session's current context window, or null if uninitialized. +/// Authentication type /// ///
/// @@ -19532,14 +27743,39 @@ pub struct SessionMetadataGetContextAttributionResultContextAttribution { /// 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, +#[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 an SDK GitHub token callback. + #[serde(rename = "token-provider")] + TokenProvider, + /// Authentication from a Copilot API token. + #[serde(rename = "copilot-api-token")] + CopilotApiToken, + /// Unknown variant for forward compatibility. + #[default] + #[serde(other)] + Unknown, } -/// The heaviest individual messages in the session's context window, most-expensive first. +/// Custom input-format kind. /// ///
/// @@ -19547,16 +27783,18 @@ pub struct SessionMetadataGetContextAttributionResult { /// 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, +#[derive(Debug, Clone, Default, PartialEq, Eq, Serialize, Deserialize)] +pub enum BuiltinToolFormatType { + /// The tool input is parsed with the supplied grammar. + #[serde(rename = "grammar")] + Grammar, + /// Unknown variant for forward compatibility. + #[default] + #[serde(other)] + Unknown, } -/// 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. +/// Root JSON Schema type for a built-in tool input. /// ///
/// @@ -19564,11 +27802,18 @@ pub struct SessionMetadataGetContextHeaviestMessagesResult { /// 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 {} +#[derive(Debug, Clone, Default, PartialEq, Eq, Serialize, Deserialize)] +pub enum BuiltinToolInputSchemaType { + /// The tool accepts a JSON object. + #[serde(rename = "object")] + Object, + /// Unknown variant for forward compatibility. + #[default] + #[serde(other)] + Unknown, +} -/// 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. +/// Canonical digest algorithm for a validated MCP card /// ///
/// @@ -19576,14 +27821,66 @@ pub struct SessionMetadataRecordContextChangeResult {} /// 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, +#[derive(Debug, Clone, Default, PartialEq, Eq, Serialize, Deserialize)] +pub enum CardDigestAlgorithm { + /// SHA-256 over RFC 8785 canonical JSON encoded as UTF-8. + #[serde(rename = "sha256-rfc8785")] + Sha256Rfc8785, + /// Unknown variant for forward compatibility. + #[default] + #[serde(other)] + Unknown, } -/// 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. +/// AI skills are discovery-only and cannot be installed through this surface +#[derive(Debug, Clone, Default, PartialEq, Eq, Serialize, Deserialize)] +pub enum CatalogAiSkillCandidateInstallability { + #[serde(rename = "not-installable-kind")] + #[default] + NotInstallableKind, +} + +/// Discriminator: this candidate describes an AI skill +#[derive(Debug, Clone, Default, PartialEq, Eq, Serialize, Deserialize)] +pub enum CatalogAiSkillCandidateKind { + #[serde(rename = "ai-skill")] + #[default] + AiSkill, +} + +/// Media type of the underlying AI skill card +#[derive(Debug, Clone, Default, PartialEq, Eq, Serialize, Deserialize)] +pub enum CatalogAiSkillCandidateMediaType { + #[serde(rename = "application/ai-skill")] + #[default] + ApplicationAiSkill, +} + +/// Media type advertised for the referenced AI skill card +#[derive(Debug, Clone, Default, PartialEq, Eq, Serialize, Deserialize)] +pub enum CatalogAiSkillCandidateProvenanceMediaType { + #[serde(rename = "application/ai-skill")] + #[default] + ApplicationAiSkill, +} + +/// Discriminator: the card is URL-backed, and carries no embedded data +#[derive(Debug, Clone, Default, PartialEq, Eq, Serialize, Deserialize)] +pub enum CatalogCandidateSourceUrlKind { + #[serde(rename = "url")] + #[default] + Url, +} + +/// Discriminator: the card is embedded, and carries no URL +#[derive(Debug, Clone, Default, PartialEq, Eq, Serialize, Deserialize)] +pub enum CatalogCandidateSourceEmbeddedKind { + #[serde(rename = "embedded")] + #[default] + Embedded, +} + +/// Where a candidate's card came from. Exactly one of a URL or embedded data: the union has no variant carrying both, and no variant carrying neither, so the rule holds structurally rather than by validation. /// ///
/// @@ -19591,18 +27888,22 @@ pub struct SessionMetadataSetWorkingDirectoryResult { /// 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, +#[derive(Debug, Clone, Serialize, Deserialize)] +#[serde(untagged)] +pub enum CatalogCandidateSource { + Url(CatalogCandidateSourceUrl), + Embedded(CatalogCandidateSourceEmbedded), } -/// Identifies the target session. +/// Discriminator: the caller is not authenticated +#[derive(Debug, Clone, Default, PartialEq, Eq, Serialize, Deserialize)] +pub enum CatalogAuthenticationRequiredErrorKind { + #[serde(rename = "authentication-required")] + #[default] + AuthenticationRequired, +} + +/// Why the catalog authority did not accept the caller's identity /// ///
/// @@ -19610,14 +27911,24 @@ pub struct SessionMetadataRecomputeContextTokensResult { /// 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, +#[derive(Debug, Clone, Default, PartialEq, Eq, Serialize, Deserialize)] +pub enum CatalogAuthenticationRequiredReason { + /// No credential was presented, so there is nothing to refresh and the caller must sign in. + #[serde(rename = "no-credential")] + NoCredential, + /// A credential was presented and its lifetime has elapsed. A silent refresh is worth attempting before prompting anyone. + #[serde(rename = "credential-expired")] + CredentialExpired, + /// A credential was presented and the authority refused it, for example because it was revoked, malformed, or issued for another audience. Refreshing the same rejected credential is not useful; the caller must sign in again. + #[serde(rename = "credential-rejected")] + CredentialRejected, + /// Unknown variant for forward compatibility. + #[default] + #[serde(other)] + Unknown, } -/// Redacted, serializable view of session runtime settings for SDK boundary consumers. Secrets and raw feature flags are intentionally excluded. +/// Whether an MCP server candidate can be planned for installation /// ///
/// @@ -19625,25 +27936,29 @@ pub struct SessionSettingsSnapshotParams { /// 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, +#[derive(Debug, Clone, Default, PartialEq, Eq, Serialize, Deserialize)] +pub enum CatalogMcpServerInstallability { + /// An install plan can be computed for this MCP server candidate. + #[serde(rename = "installable")] + Installable, + /// Policy forbids installing this MCP server candidate. + #[serde(rename = "not-installable-policy")] + NotInstallablePolicy, + /// Unknown variant for forward compatibility. + #[default] + #[serde(other)] + Unknown, } -/// Identifier of the spawned process, used to correlate streamed output and exit notifications. +/// Discriminator: this candidate describes an MCP server +#[derive(Debug, Clone, Default, PartialEq, Eq, Serialize, Deserialize)] +pub enum CatalogMcpServerCandidateKind { + #[serde(rename = "mcp-server")] + #[default] + McpServer, +} + +/// JSON MCP card media type accepted for install planning /// ///
/// @@ -19651,14 +27966,21 @@ pub struct SessionSettingsSnapshotResult { /// 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, +#[derive(Debug, Clone, Default, PartialEq, Eq, Serialize, Deserialize)] +pub enum McpServerCardMediaType { + /// The current MCP server card media type. + #[serde(rename = "application/mcp-server-card+json")] + ApplicationMcpServerCardJson, + /// The legacy MCP server card media type, accepted for compatibility. + #[serde(rename = "application/mcp-server+json")] + ApplicationMcpServerJson, + /// Unknown variant for forward compatibility. + #[default] + #[serde(other)] + Unknown, } -/// Indicates whether the signal was delivered; false if the process was unknown or already exited. +/// One inert catalog result, represented as an MCP server or discovery-only AI skill variant so kind, media type, provenance, and installability cannot contradict each other. /// ///
/// @@ -19666,14 +27988,14 @@ pub struct SessionShellExecResult { /// 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, +#[derive(Debug, Clone, Serialize, Deserialize)] +#[serde(untagged)] +pub enum CatalogCandidate { + McpServer(CatalogMcpServerCandidate), + AiSkill(CatalogAiSkillCandidate), } -/// Result of a user-requested shell command. +/// What kind of resource a catalog candidate describes /// ///
/// @@ -19681,24 +28003,21 @@ pub struct SessionShellKillResult { /// 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, +#[derive(Debug, Clone, Default, PartialEq, Eq, Serialize, Deserialize)] +pub enum CatalogCandidateKind { + /// An MCP server, which can be planned for installation. + #[serde(rename = "mcp-server")] + McpServer, + /// An AI skill, which is discoverable but not installable through this surface. + #[serde(rename = "ai-skill")] + AiSkill, + /// Unknown variant for forward compatibility. + #[default] + #[serde(other)] + Unknown, } -/// Cancellation result for a user-requested shell command. +/// A wire feature a caller can require of the catalog surface, negotiated per request. A grant means the runtime understands the feature's contract, not that the deployment has enabled the operation; typed unavailable results report availability separately. /// ///
/// @@ -19706,14 +28025,38 @@ pub struct SessionShellExecuteUserRequestedResult { /// 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, +#[derive(Debug, Clone, Default, PartialEq, Eq, Serialize, Deserialize)] +pub enum CatalogCapability { + /// Understands the current `application/mcp-server-card+json` media type. + #[serde(rename = "mcp-server-card")] + McpServerCard, + /// Understands the legacy `application/mcp-server+json` media type. + #[serde(rename = "legacy-mcp-server-card")] + LegacyMcpServerCard, + /// Understands `application/ai-skill` candidates as discovery-only and typed non-installable. + #[serde(rename = "ai-skill-discovery")] + AiSkillDiscovery, + /// Understands side-effect-free MCP install-plan requests, results, and plan handles; `planning-unavailable` separately reports that planning is not enabled. + #[serde(rename = "mcp-install-planning")] + McpInstallPlanning, + /// Understands plans that enumerate every eligible transport rather than a single preferred one. + #[serde(rename = "multiple-transport-choice")] + MultipleTransportChoice, + /// Unknown variant for forward compatibility. + #[default] + #[serde(other)] + Unknown, } -/// Compaction outcome with the number of tokens and messages removed, summary text, and the resulting context window breakdown. +/// Discriminator: the upstream response broke the contract +#[derive(Debug, Clone, Default, PartialEq, Eq, Serialize, Deserialize)] +pub enum CatalogContractViolationErrorKind { + #[serde(rename = "contract-violation")] + #[default] + ContractViolation, +} + +/// Which wire-contract rule an upstream response broke /// ///
/// @@ -19721,24 +28064,27 @@ pub struct SessionShellCancelUserRequestedResult { /// 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, +#[derive(Debug, Clone, Default, PartialEq, Eq, Serialize, Deserialize)] +pub enum CatalogContractViolationReason { + /// A result carried both a URL and embedded data, when exactly one is permitted. + #[serde(rename = "both-url-and-data")] + BothUrlAndData, + /// A result carried neither a URL nor embedded data, when exactly one is required. + #[serde(rename = "neither-url-nor-data")] + NeitherUrlNorData, + /// Two results claimed the same normalised identity. + #[serde(rename = "duplicate-identity")] + DuplicateIdentity, + /// A result declared no media type, or one this contract does not model. + #[serde(rename = "unknown-media-type")] + UnknownMediaType, + /// Unknown variant for forward compatibility. + #[default] + #[serde(other)] + Unknown, } -/// Number of events that were removed by the truncation. +/// Which kind of opaque handle was presented /// ///
/// @@ -19746,14 +28092,29 @@ pub struct SessionHistoryCompactResult { /// 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 { - /// Number of events that were removed - pub events_removed: i64, +#[derive(Debug, Clone, Default, PartialEq, Eq, Serialize, Deserialize)] +pub enum CatalogHandleType { + /// A search candidate handle. + #[serde(rename = "candidate")] + Candidate, + /// An install plan handle. + #[serde(rename = "plan")] + Plan, + /// Unknown variant for forward compatibility. + #[default] + #[serde(other)] + Unknown, +} + +/// Discriminator: a handle was rejected +#[derive(Debug, Clone, Default, PartialEq, Eq, Serialize, Deserialize)] +pub enum CatalogHandleRejectedErrorKind { + #[serde(rename = "handle-rejected")] + #[default] + HandleRejected, } -/// Identifies the target session. +/// Why a presented handle was rejected /// ///
/// @@ -19761,14 +28122,27 @@ pub struct SessionHistoryTruncateResult { /// 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, +#[derive(Debug, Clone, Default, PartialEq, Eq, Serialize, Deserialize)] +pub enum CatalogHandleRejectionReason { + /// The handle is unparseable, unknown, or was issued for a different operation. + #[serde(rename = "invalid")] + Invalid, + /// The handle's time to live has elapsed. + #[serde(rename = "stale")] + Stale, + /// The handle has already been used, and handles are single-use. + #[serde(rename = "replayed")] + Replayed, + /// The handle was issued by a different runtime instance. + #[serde(rename = "foreign")] + Foreign, + /// Unknown variant for forward compatibility. + #[default] + #[serde(other)] + Unknown, } -/// Indicates whether an in-progress background compaction was cancelled. +/// Which request field was rejected before any work was done /// ///
/// @@ -19776,14 +28150,52 @@ pub struct SessionHistoryCancelBackgroundCompactionParams { /// 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, +#[derive(Debug, Clone, Default, PartialEq, Eq, Serialize, Deserialize)] +pub enum CatalogInvalidRequestField { + /// The search query was empty or longer than permitted. + #[serde(rename = "query")] + Query, + /// The requested result count fell outside its permitted range. + #[serde(rename = "limit")] + Limit, + /// The requested candidate kinds were empty or contained a duplicate. + #[serde(rename = "kinds")] + Kinds, + /// The negotiation block was missing or malformed. + #[serde(rename = "contract")] + Contract, + /// The plan source was missing or malformed. + #[serde(rename = "source")] + Source, + /// The supplied card was missing its media type, URL, or data. + #[serde(rename = "card")] + Card, + /// The requested configuration scope is not one this runtime writes. + #[serde(rename = "scope")] + Scope, + /// Unknown variant for forward compatibility. + #[default] + #[serde(other)] + Unknown, } -/// Identifies the target session. +/// Discriminator: the request itself was invalid +#[derive(Debug, Clone, Default, PartialEq, Eq, Serialize, Deserialize)] +pub enum CatalogInvalidRequestErrorKind { + #[serde(rename = "invalid-request")] + #[default] + InvalidRequest, +} + +/// Discriminator: the card was malformed +#[derive(Debug, Clone, Default, PartialEq, Eq, Serialize, Deserialize)] +pub enum CatalogMalformedCardErrorKind { + #[serde(rename = "malformed-card")] + #[default] + MalformedCard, +} + +/// Media type a catalog card is interpreted as /// ///
/// @@ -19791,14 +28203,24 @@ pub struct SessionHistoryCancelBackgroundCompactionResult { /// 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, +#[derive(Debug, Clone, Default, PartialEq, Eq, Serialize, Deserialize)] +pub enum CatalogMediaType { + /// The current MCP server card media type. + #[serde(rename = "application/mcp-server-card+json")] + ApplicationMcpServerCardJson, + /// The legacy MCP server card media type, accepted for compatibility. + #[serde(rename = "application/mcp-server+json")] + ApplicationMcpServerJson, + /// An AI skill card. Representable and searchable, but typed non-installable. + #[serde(rename = "application/ai-skill")] + ApplicationAiSkill, + /// Unknown variant for forward compatibility. + #[default] + #[serde(other)] + Unknown, } -/// Indicates whether an in-progress manual compaction was aborted. +/// How a card failed validation /// ///
/// @@ -19806,14 +28228,38 @@ pub struct SessionHistoryAbortManualCompactionParams { /// 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, +#[derive(Debug, Clone, Default, PartialEq, Eq, Serialize, Deserialize)] +pub enum CatalogMalformedCardReason { + /// The document is not well-formed JSON. + #[serde(rename = "invalid-json")] + InvalidJson, + /// The document does not satisfy its media type's schema. + #[serde(rename = "schema-violation")] + SchemaViolation, + /// The declared media type is not one this runtime understands. + #[serde(rename = "unsupported-media-type")] + UnsupportedMediaType, + /// A field the media type requires is absent. + #[serde(rename = "missing-required-field")] + MissingRequiredField, + /// The document exceeded the permitted size. + #[serde(rename = "size-limit-exceeded")] + SizeLimitExceeded, + /// Unknown variant for forward compatibility. + #[default] + #[serde(other)] + Unknown, } -/// Identifies the target session. +/// Discriminator: capability or protocol-version negotiation failed +#[derive(Debug, Clone, Default, PartialEq, Eq, Serialize, Deserialize)] +pub enum CatalogNegotiationRefusedErrorKind { + #[serde(rename = "negotiation-refused")] + #[default] + NegotiationRefused, +} + +/// Why capability and protocol-version negotiation refused a caller /// ///
/// @@ -19821,14 +28267,29 @@ pub struct SessionHistoryAbortManualCompactionResult { /// 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, +#[derive(Debug, Clone, Default, PartialEq, Eq, Serialize, Deserialize)] +pub enum CatalogNegotiationRefusedReason { + /// The caller's protocol version is below the lowest this runtime serves. + #[serde(rename = "unsupported-protocol-version")] + UnsupportedProtocolVersion, + /// The caller requires at least one capability this runtime cannot honour. + #[serde(rename = "unsupported-capability")] + UnsupportedCapability, + /// Unknown variant for forward compatibility. + #[default] + #[serde(other)] + Unknown, } -/// Markdown summary of the conversation context (empty when not available). +/// Discriminator: the network operation failed +#[derive(Debug, Clone, Default, PartialEq, Eq, Serialize, Deserialize)] +pub enum CatalogNetworkFailureErrorKind { + #[serde(rename = "network-failure")] + #[default] + NetworkFailure, +} + +/// Categorised network failure, low cardinality so it can be aggregated without carrying a URL /// ///
/// @@ -19836,14 +28297,47 @@ pub struct SessionHistorySummarizeForHandoffParams { /// 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, +#[derive(Debug, Clone, Default, PartialEq, Eq, Serialize, Deserialize)] +pub enum CatalogNetworkFailureReason { + /// No network is available, so nothing was attempted. + #[serde(rename = "offline")] + Offline, + /// The authority's name could not be resolved. + #[serde(rename = "dns")] + Dns, + /// The request exceeded its time budget. + #[serde(rename = "timeout")] + Timeout, + /// The TLS handshake or certificate validation failed. + #[serde(rename = "tls")] + Tls, + /// The connection was refused or reset. + #[serde(rename = "connection-refused")] + ConnectionRefused, + /// The authority returned a status the runtime treats as a failure. + #[serde(rename = "http-status")] + HttpStatus, + /// The response exceeded the permitted size. + #[serde(rename = "response-too-large")] + ResponseTooLarge, + /// A redirect was refused by the runtime's redirect policy. + #[serde(rename = "redirect-rejected")] + RedirectRejected, + /// Unknown variant for forward compatibility. + #[default] + #[serde(other)] + Unknown, } -/// Identifies the target session. +/// Discriminator: the candidate cannot be installed +#[derive(Debug, Clone, Default, PartialEq, Eq, Serialize, Deserialize)] +pub enum CatalogNotInstallableErrorKind { + #[serde(rename = "not-installable")] + #[default] + NotInstallable, +} + +/// Why a discoverable candidate cannot be installed /// ///
/// @@ -19851,14 +28345,32 @@ pub struct SessionHistorySummarizeForHandoffResult { /// 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, +#[derive(Debug, Clone, Default, PartialEq, Eq, Serialize, Deserialize)] +pub enum CatalogNotInstallableReason { + /// This kind of resource is not installable through this surface. + #[serde(rename = "kind-not-installable")] + KindNotInstallable, + /// AI skills are discoverable but have no typed importer in this phase. + #[serde(rename = "ai-skill-not-installable")] + AiSkillNotInstallable, + /// Policy forbids installing this candidate. + #[serde(rename = "policy-forbids")] + PolicyForbids, + /// Unknown variant for forward compatibility. + #[default] + #[serde(other)] + Unknown, } -/// Snapshot of the session's pending queued items and immediate-steering messages. +/// Discriminator: policy refused the operation +#[derive(Debug, Clone, Default, PartialEq, Eq, Serialize, Deserialize)] +pub enum CatalogPolicyRejectedErrorKind { + #[serde(rename = "policy-rejected")] + #[default] + PolicyRejected, +} + +/// Which authority produced a policy decision /// ///
/// @@ -19866,16 +28378,51 @@ pub struct SessionQueuePendingItemsParams { /// 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, +#[derive(Debug, Clone, Default, PartialEq, Eq, Serialize, Deserialize)] +pub enum McpPlanPolicySource { + /// No policy applied, so the server is permitted by default. + #[serde(rename = "none")] + None, + /// An enterprise allowlist evaluated the server. + #[serde(rename = "enterprise-allowlist")] + EnterpriseAllowlist, + /// The registry the card came from evaluated the server. + #[serde(rename = "registry-policy")] + RegistryPolicy, + /// Local trust settings evaluated the server. + #[serde(rename = "local-trust")] + LocalTrust, + /// Unknown variant for forward compatibility. + #[default] + #[serde(other)] + Unknown, } -/// Identifies the target session. +/// Discriminator: the search completed +#[derive(Debug, Clone, Default, PartialEq, Eq, Serialize, Deserialize)] +pub enum CatalogSearchSucceededKind { + #[serde(rename = "succeeded")] + #[default] + Succeeded, +} + +/// Discriminator: an unsupported candidate kind was requested +#[derive(Debug, Clone, Default, PartialEq, Eq, Serialize, Deserialize)] +pub enum CatalogUnsupportedKindErrorKind { + #[serde(rename = "unsupported-kind")] + #[default] + UnsupportedKind, +} + +/// Discriminator: retrieval was refused as unsafe +#[derive(Debug, Clone, Default, PartialEq, Eq, Serialize, Deserialize)] +pub enum CatalogUnsafeRetrievalErrorKind { + #[serde(rename = "unsafe-retrieval")] + #[default] + UnsafeRetrieval, +} + +/// Which hardened-fetch control refused a retrieval /// ///
/// @@ -19883,14 +28430,41 @@ pub struct SessionQueuePendingItemsResult { /// 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, +#[derive(Debug, Clone, Default, PartialEq, Eq, Serialize, Deserialize)] +pub enum CatalogUnsafeRetrievalReason { + /// The URL used a scheme the runtime refuses to fetch. + #[serde(rename = "blocked-scheme")] + BlockedScheme, + /// The URL embedded credentials. + #[serde(rename = "credentials-in-url")] + CredentialsInUrl, + /// The URL resolved to a loopback, private, link-local, or cloud metadata address. + #[serde(rename = "blocked-address")] + BlockedAddress, + /// A redirect target resolved to a blocked address. + #[serde(rename = "redirect-to-blocked-address")] + RedirectToBlockedAddress, + /// The configured proxy policy refused the request. + #[serde(rename = "proxy-rejected")] + ProxyRejected, + /// The authority is not permitted for card retrieval. + #[serde(rename = "host-not-permitted")] + HostNotPermitted, + /// Unknown variant for forward compatibility. + #[default] + #[serde(other)] + Unknown, } -/// Indicates whether a user-facing pending item was removed. +/// Discriminator: the operation is not available +#[derive(Debug, Clone, Default, PartialEq, Eq, Serialize, Deserialize)] +pub enum CatalogUnavailableErrorKind { + #[serde(rename = "unavailable")] + #[default] + Unavailable, +} + +/// Why a catalog operation is not available on this runtime /// ///
/// @@ -19898,14 +28472,27 @@ pub struct SessionQueueRemoveMostRecentParams { /// 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, +#[derive(Debug, Clone, Default, PartialEq, Eq, Serialize, Deserialize)] +pub enum CatalogUnavailableReason { + /// Bounded search is not wired up on this runtime build. + #[serde(rename = "search-unavailable")] + SearchUnavailable, + /// Install planning is not wired up on this runtime build. + #[serde(rename = "planning-unavailable")] + PlanningUnavailable, + /// No catalog authority is configured for this runtime. + #[serde(rename = "authority-not-configured")] + AuthorityNotConfigured, + /// The surface is disabled by policy on this runtime. + #[serde(rename = "disabled-by-policy")] + DisabledByPolicy, + /// Unknown variant for forward compatibility. + #[default] + #[serde(other)] + Unknown, } -/// Identifies the target session. +/// Outcome of a catalog.search call: either bounded inert candidates, or one typed refusal. Never a partial success. /// ///
/// @@ -19913,14 +28500,31 @@ pub struct SessionQueueRemoveMostRecentResult { /// 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, +#[derive(Debug, Clone, Serialize, Deserialize)] +#[serde(untagged)] +pub enum CatalogSearchResult { + Succeeded(CatalogSearchSucceeded), + NegotiationRefused(CatalogNegotiationRefusedError), + UnsupportedKind(CatalogUnsupportedKindError), + InvalidRequest(CatalogInvalidRequestError), + AuthenticationRequired(CatalogAuthenticationRequiredError), + PolicyRejected(CatalogPolicyRejectedError), + NetworkFailure(CatalogNetworkFailureError), + UnsafeRetrieval(CatalogUnsafeRetrievalError), + MalformedCard(CatalogMalformedCardError), + ContractViolation(CatalogContractViolationError), + Unavailable(CatalogUnavailableError), +} + +/// Discriminator: no usable transport is available +#[derive(Debug, Clone, Default, PartialEq, Eq, Serialize, Deserialize)] +pub enum CatalogUnavailableTransportErrorKind { + #[serde(rename = "unavailable-transport")] + #[default] + UnavailableTransport, } -/// Batch of session events returned by a read, with cursor and continuation metadata. +/// Why no usable transport could be offered /// ///
/// @@ -19928,20 +28532,24 @@ pub struct SessionQueueClearParams { /// 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. - 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, +#[derive(Debug, Clone, Default, PartialEq, Eq, Serialize, Deserialize)] +pub enum CatalogUnavailableTransportReason { + /// The card advertises no transport this runtime can use. + #[serde(rename = "no-eligible-transport")] + NoEligibleTransport, + /// Every advertised transport is of a kind this runtime does not implement. + #[serde(rename = "transport-not-supported")] + TransportNotSupported, + /// Eligible remotes could not be enumerated, so no explicit choice can be offered. + #[serde(rename = "remote-enumeration-unavailable")] + RemoteEnumerationUnavailable, + /// Unknown variant for forward compatibility. + #[default] + #[serde(other)] + Unknown, } -/// Identifies the target session. +/// Optional completion hint for the input (e.g. 'directory' for filesystem path completion) /// ///
/// @@ -19949,14 +28557,18 @@ pub struct SessionEventLogReadResult { /// 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, +#[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, } -/// 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). +/// Coarse command category for grouping and behavior: runtime built-in, skill-backed command, or SDK/client-owned command /// ///
/// @@ -19964,14 +28576,24 @@ pub struct SessionEventLogTailParams { /// 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, +#[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, } -/// Opaque handle representing an event-type interest registration. +/// Whether a pending slash-command invocation effect was applied or cancelled by the host. /// ///
/// @@ -19979,14 +28601,20 @@ pub struct SessionEventLogTailResult { /// 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, +#[derive(Debug, Clone, Default, PartialEq, Eq, Serialize, Deserialize)] +pub enum CommandsInvocationEffectOutcome { + /// The host applied the pending invocation effect. + #[serde(rename = "applied")] + Applied, + /// The host cancelled the pending invocation effect, so any provisional state must be reverted. + #[serde(rename = "cancelled")] + Cancelled, + /// Unknown variant for forward compatibility. + #[default] + #[serde(other)] + Unknown, } -/// Indicates whether the operation succeeded. /// ///
/// @@ -19994,14 +28622,17 @@ pub struct SessionEventLogRegisterInterestResult { /// 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, +#[derive(Debug, Clone, Default, PartialEq, Eq, Serialize, Deserialize)] +pub enum CommandsInvocationOrigin { + #[serde(rename = "settings")] + Settings, + /// Unknown variant for forward compatibility. + #[default] + #[serde(other)] + Unknown, } -/// Identifies the target session. +/// Neutral SDK discriminator for the connected remote session kind. /// ///
/// @@ -20009,14 +28640,21 @@ pub struct SessionEventLogReleaseInterestResult { /// 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, +#[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, } -/// Accumulated session usage metrics, including premium request cost, token counts, model breakdown, and code-change totals. +/// 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. /// ///
/// @@ -20024,37 +28662,24 @@ pub struct SessionUsageGetMetricsParams { /// 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, +#[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, } -/// GitHub URL for the session and a flag indicating whether remote steering is enabled. +/// Source category for a collected debug bundle entry. /// ///
/// @@ -20062,17 +28687,43 @@ pub struct SessionUsageGetMetricsResult { /// 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, +#[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, } -/// Identifies the target session. +/// Destination variant discriminator. +#[derive(Debug, Clone, Default, PartialEq, Eq, Serialize, Deserialize)] +pub enum DebugCollectLogsDestinationArchiveKind { + #[serde(rename = "archive")] + #[default] + Archive, +} + +/// Destination variant discriminator. +#[derive(Debug, Clone, Default, PartialEq, Eq, Serialize, Deserialize)] +pub enum DebugCollectLogsDestinationDirectoryKind { + #[serde(rename = "directory")] + #[default] + Directory, +} + +/// Destination for the redacted debug bundle. /// ///
/// @@ -20080,14 +28731,14 @@ pub struct SessionRemoteEnableResult { /// 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, +#[derive(Debug, Clone, Serialize, Deserialize)] +#[serde(untagged)] +pub enum DebugCollectLogsDestination { + Archive(DebugCollectLogsDestinationArchive), + Directory(DebugCollectLogsDestinationDirectory), } -/// 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. +/// Kind of caller-provided debug log entry. /// ///
/// @@ -20095,11 +28746,21 @@ pub struct SessionRemoteDisableParams { /// 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 {} +#[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, +} -/// Identifies the target session. +/// How a collected debug entry should be redacted before being staged. /// ///
/// @@ -20107,14 +28768,21 @@ pub struct SessionRemoteNotifySteerableChangedResult {} /// 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, +#[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, } -/// Current sharing status and shareable GitHub URL for a session. +/// Destination kind that was written. /// ///
/// @@ -20122,20 +28790,21 @@ pub struct SessionVisibilityGetParams { /// 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, +#[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, } -/// Effective sharing status and shareable GitHub URL after updating session visibility. +/// Persisted extension discovery source /// ///
/// @@ -20143,20 +28812,21 @@ pub struct SessionVisibilityGetResult { /// 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, +#[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, } -/// Identifies the target session. +/// Effective extension loading and agent-management mode /// ///
/// @@ -20164,14 +28834,24 @@ pub struct SessionVisibilitySetResult { /// 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, +#[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, } -/// Snapshot of the currently active recurring prompts for this session. +/// Server transport type: stdio, http, sse (deprecated), or memory /// ///
/// @@ -20179,14 +28859,27 @@ pub struct SessionScheduleListParams { /// 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, +#[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, } -/// Remove a scheduled prompt by id. The result entry is omitted if the id was 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. /// ///
/// @@ -20194,30 +28887,43 @@ pub struct SessionScheduleListResult { /// 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, +#[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, } -/// 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. +/// 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, Serialize, Deserialize)] -#[serde(rename_all = "camelCase")] -pub struct ProviderTokenGetTokenResult { - /// The bearer token value (without the `Bearer ` prefix). - pub token: String, +/// +#[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, } -/// Acknowledgement that a factory request was accepted. +/// 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. /// ///
/// @@ -20225,11 +28931,21 @@ pub struct ProviderTokenGetTokenResult { /// 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 {} +#[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, +} -/// Identifies the target session. +/// Discovery source: project (.github/extensions/), user (~/.copilot/extensions/), plugin (installed plugin), or session (session-state//extensions/) /// ///
/// @@ -20237,14 +28953,27 @@ pub struct FactoryAbortResult {} /// 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, +#[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, } -/// Canvas open result returned by the provider. +/// Current status: running, disabled, failed, or starting /// ///
/// @@ -20252,21 +28981,35 @@ pub struct SessionFsSqliteExistsParams { /// 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, +#[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, } -/// HTTP headers as a map from lowercased header name to a list of values. Multi-valued headers (e.g. Set-Cookie) preserve all values. +/// 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. /// ///
/// @@ -20274,9 +29017,45 @@ pub struct CanvasOpenResult { /// and may change or be removed in future SDK or CLI releases. /// ///
-pub type LlmInferenceHeaders = HashMap>; +#[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, +} -/// 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. +/// 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 /// ///
/// @@ -20284,9 +29063,53 @@ pub type LlmInferenceHeaders = HashMap>; /// and may change or be removed in future SDK or CLI releases. /// ///
-pub type McpExecuteSamplingResult = HashMap; +#[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, +} -/// The form values submitted by the user (present when action is 'accept') +/// 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. /// ///
/// @@ -20294,9 +29117,48 @@ pub type McpExecuteSamplingResult = HashMap; /// and may change or be removed in future SDK or CLI releases. /// ///
-pub type UIElicitationResponseContent = HashMap; +#[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, + /// Renewing the durable owner lease that proves this process still owns the run. + #[serde(rename = "refreshLease")] + RefreshLease, + /// Unknown variant for forward compatibility. + #[default] + #[serde(other)] + Unknown, +} -/// List of all authenticated users +/// Current or terminal state of a factory run. /// ///
/// @@ -20304,9 +29166,33 @@ pub type UIElicitationResponseContent = HashMap; /// and may change or be removed in future SDK or CLI releases. /// ///
-pub type AccountGetAllUsersResult = Vec; +#[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, +} -/// Standard MCP CallToolResult +/// Kind of factory progress line. /// ///
/// @@ -20314,9 +29200,21 @@ pub type AccountGetAllUsersResult = Vec; /// and may change or be removed in future SDK or CLI releases. /// ///
-pub type SessionMcpAppsCallToolResult = HashMap; +#[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, +} -/// Resolved Anthropic adaptive-thinking capability for a model. +/// Derived lifecycle state of a factory phase. /// ///
/// @@ -20325,23 +29223,26 @@ pub type SessionMcpAppsCallToolResult = HashMap; /// ///
#[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, +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, } -/// Which tier this directory belongs to +/// Cumulative resource ceiling that stopped a factory run. /// ///
/// @@ -20350,54 +29251,54 @@ pub enum AdaptiveThinkingSupport { /// ///
#[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, +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, } -/// 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. -/// -///
+/// Why the runtime is requesting a GitHub credential. #[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, +pub enum GitHubTokenAcquireReason { + /// The runtime is acquiring the registration's first credential. + #[serde(rename = "initial")] + Initial, + /// The runtime is replacing a credential that is approaching expiry. + #[serde(rename = "refresh")] + Refresh, /// Unknown variant for forward compatibility. #[default] #[serde(other)] Unknown, } -/// Kind of attention required when status === "attention". Meaningful only when status === "attention". +/// GitHub credential response variant discriminator. +#[derive(Debug, Clone, Default, PartialEq, Eq, Serialize, Deserialize)] +pub enum GitHubTokenAcquireResultTokenKind { + #[serde(rename = "token")] + #[default] + Token, +} + +/// GitHub credential response variant discriminator. +#[derive(Debug, Clone, Default, PartialEq, Eq, Serialize, Deserialize)] +pub enum GitHubTokenAcquireResultCancelledKind { + #[serde(rename = "cancelled")] + #[default] + Cancelled, +} + +/// SDK host response to a GitHub credential request. /// ///
/// @@ -20405,30 +29306,29 @@ pub enum AgentInfoSource { /// and may change or be removed in future SDK or CLI releases. /// ///
+#[derive(Debug, Clone, Serialize, Deserialize)] +#[serde(untagged)] +pub enum GitHubTokenAcquireResult { + Token(GitHubTokenAcquireResultToken), + Cancelled(GitHubTokenAcquireResultCancelled), +} + +/// 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 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, +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, } -/// Process kind tag for the registry entry +/// Reason a captured file was not restored. /// ///
/// @@ -20437,20 +29337,20 @@ pub enum AgentRegistryLiveTargetEntryAttentionKind { /// ///
#[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, +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, } -/// How the most recent turn ended (clean vs aborted). Lets the renderer distinguish done from done_cancelled. +/// Reason a rewind read (rewind points, file-restore preview, or session diff) could not be answered from the session's file-change captures. /// ///
/// @@ -20459,20 +29359,23 @@ pub enum AgentRegistryLiveTargetEntryKind { /// ///
#[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, +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, } -/// Coarse lifecycle status of the foreground session +/// Aggregate file change represented by a rewind preview. /// ///
/// @@ -20481,26 +29384,23 @@ pub enum AgentRegistryLiveTargetEntryLastTerminalEvent { /// ///
#[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, +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, } -/// Categorized reason for log-open failure +/// Scope of a rewind operation. /// ///
/// @@ -20509,31 +29409,20 @@ pub enum AgentRegistryLiveTargetEntryStatus { /// ///
#[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, +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, } -/// 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. +/// Outcome of a rewind request. /// ///
/// @@ -20542,75 +29431,125 @@ pub enum AgentRegistrySpawnErrorKind { /// ///
#[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, +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, } -/// Discriminator: spawn succeeded but child never registered +/// Hook event name dispatched through the SDK callback transport. #[derive(Debug, Clone, Default, PartialEq, Eq, Serialize, Deserialize)] -pub enum AgentRegistrySpawnRegistryTimeoutKind { - #[serde(rename = "registry-timeout")] +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] - RegistryTimeout, + #[serde(other)] + Unknown, } -/// Discriminator: managed-server child spawned successfully +/// Constant value. Always "github". #[derive(Debug, Clone, Default, PartialEq, Eq, Serialize, Deserialize)] -pub enum AgentRegistrySpawnSpawnedKind { - #[serde(rename = "spawned")] +pub enum InstalledPluginSourceGitHubSource { + #[serde(rename = "github")] #[default] - Spawned, + GitHub, } -/// 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. -/// -///
+/// Constant value. Always "local". #[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. +pub enum InstalledPluginSourceLocalSource { + #[serde(rename = "local")] #[default] - #[serde(other)] - Unknown, + Local, } -/// Discriminator: synchronous pre-validation rejected the request +/// Constant value. Always "url". #[derive(Debug, Clone, Default, PartialEq, Eq, Serialize, Deserialize)] -pub enum AgentRegistrySpawnValidationErrorKind { - #[serde(rename = "validation-error")] +pub enum InstalledPluginSourceUrlSource { + #[serde(rename = "url")] #[default] - ValidationError, + Url, } -/// Categorized reason for the rejection. Low-cardinality enum so telemetry can aggregate by reason without leaking raw paths or agent/model names. +/// Whether the target is a single file or a directory of instruction files /// ///
/// @@ -20619,32 +29558,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 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, } -/// Outcome of an agentRegistry.spawn call. +/// Which tier this target belongs to /// ///
/// @@ -20652,16 +29579,27 @@ 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 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] + #[serde(other)] + Unknown, } -/// Current or requested allow-all mode. +/// Where this source lives β€” used for UI grouping /// ///
/// @@ -20670,31 +29608,26 @@ pub enum AgentRegistrySpawnResult { /// ///
#[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, +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] #[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 +/// Category of instruction source β€” used for merge logic /// ///
/// @@ -20703,84 +29636,50 @@ pub enum ApiKeyAuthInfoType { /// ///
#[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, +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, + /// 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, } -/// 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 +/// 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 AttachmentGitHubFileDiffType { - #[serde(rename = "github_file_diff")] +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] - GitHubFileDiff, + #[serde(other)] + Unknown, } -/// Type of GitHub reference +/// Repository host type /// ///
/// @@ -20789,71 +29688,20 @@ pub enum AttachmentGitHubFileDiffType { /// ///
#[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, +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, } -/// 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 +/// Log severity level. Determines how the message is displayed in the timeline. Defaults to "info". /// ///
/// @@ -20862,35 +29710,23 @@ pub enum AttachmentSelectionType { /// ///
#[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 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, } -/// Optional completion hint for the input (e.g. 'directory' for filesystem path completion) +/// Allowed values for the `McpAppsHostContextDetailsAvailableDisplayMode` enumeration. /// ///
/// @@ -20899,17 +29735,23 @@ pub enum AuthInfoType { /// ///
#[derive(Debug, Clone, Default, PartialEq, Eq, Serialize, Deserialize)] -pub enum SlashCommandInputCompletion { - /// Input should complete filesystem directories. - #[serde(rename = "directory")] - Directory, +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] #[serde(other)] Unknown, } -/// Coarse command category for grouping and behavior: runtime built-in, skill-backed command, or SDK/client-owned command +/// Current display mode (SEP-1865) /// ///
/// @@ -20918,23 +29760,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 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, } -/// Neutral SDK discriminator for the connected remote session kind. +/// Platform type for responsive design /// ///
/// @@ -20943,20 +29785,23 @@ 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 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, } -/// 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. +/// UI theme preference per SEP-1865 /// ///
/// @@ -20965,39 +29810,20 @@ pub enum ConnectedRemoteSessionMetadataKind { /// ///
#[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, +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, } -/// 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. +/// Allowed values for the `McpAppsSetHostContextDetailsAvailableDisplayMode` enumeration. /// ///
/// @@ -21006,55 +29832,23 @@ pub enum CopilotApiTokenAuthInfoType { /// ///
#[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, +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, } -#[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. +/// Current display mode (SEP-1865) /// ///
/// @@ -21063,20 +29857,23 @@ pub enum DebugCollectLogsDestination { /// ///
#[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, +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, } -/// How a collected debug entry should be redacted before being staged. +/// Platform type for responsive design /// ///
/// @@ -21085,20 +29882,23 @@ pub enum DebugCollectLogsEntryKind { /// ///
#[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, +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, } -/// Destination kind that was written. +/// UI theme preference per SEP-1865 /// ///
/// @@ -21107,20 +29907,20 @@ pub enum DebugCollectLogsRedaction { /// ///
#[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, +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, } -/// Server transport type: stdio, http, sse (deprecated), or memory +/// Structured MCP elicitation mode. /// ///
/// @@ -21129,78 +29929,47 @@ pub enum DebugCollectLogsResultKind { /// ///
#[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 McpElicitationFormMode { + #[serde(rename = "form")] + Form, /// Unknown variant for forward compatibility. #[default] #[serde(other)] Unknown, } -/// Personal access token (PAT) or server-to-server token sourced from an environment variable. +/// Headers-refresh response variant discriminator. #[derive(Debug, Clone, Default, PartialEq, Eq, Serialize, Deserialize)] -pub enum EnvAuthInfoType { - #[serde(rename = "env")] +pub enum McpHeadersHandlePendingHeadersRefreshRequestHeadersKind { + #[serde(rename = "headers")] #[default] - Env, + Headers, } -/// 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. -/// -///
+/// Headers-refresh response variant discriminator. #[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. +pub enum McpHeadersHandlePendingHeadersRefreshRequestNoneKind { + #[serde(rename = "none")] #[default] - #[serde(other)] - Unknown, + None, } -/// 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. +/// 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, 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, +/// +#[derive(Debug, Clone, Serialize, Deserialize)] +#[serde(untagged)] +pub enum McpHeadersHandlePendingHeadersRefreshRequest { + Headers(McpHeadersHandlePendingHeadersRefreshRequestHeaders), + None(McpHeadersHandlePendingHeadersRefreshRequestNone), } -/// Discovery source: project (.github/extensions/), user (~/.copilot/extensions/), plugin (installed plugin), or session (session-state//extensions/) +/// Whether a planned configuration change would create or modify an entry /// ///
/// @@ -21209,26 +29978,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, - /// 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, +pub enum McpPlanConfigurationOperation { + /// Creates a configuration entry that does not exist yet. + #[serde(rename = "add")] + Add, + /// Modifies a configuration entry that already exists. + #[serde(rename = "update")] + Update, /// Unknown variant for forward compatibility. #[default] #[serde(other)] Unknown, } -/// Current status: running, disabled, failed, or starting +/// Configuration scope an MCP install plan targets /// ///
/// @@ -21237,34 +30000,17 @@ 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 McpPlanScope { + /// The user's own MCP configuration. + #[serde(rename = "user")] + User, /// 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. +/// What policy decided for a planned server /// ///
/// @@ -21273,44 +30019,23 @@ pub enum ExtensionContextPushInputType { /// ///
#[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 McpPlanPolicyDecision { + /// Policy permits the server. + #[serde(rename = "allowed")] + Allowed, + /// Policy forbids the server, so the plan cannot be applied. + #[serde(rename = "blocked")] + Blocked, + /// Policy permits the server only after an explicit approval. + #[serde(rename = "requires-approval")] + RequiresApproval, /// 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 +/// Consumer allowed to call an MCP tool. /// ///
/// @@ -21319,52 +30044,36 @@ 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 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, } -/// 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 +/// OAuth response variant discriminator. #[derive(Debug, Clone, Default, PartialEq, Eq, Serialize, Deserialize)] -pub enum ExternalToolTextResultForLlmContentTerminalType { - #[serde(rename = "terminal")] +pub enum McpOauthPendingRequestResponseTokenKind { + #[serde(rename = "token")] #[default] - Terminal, + Token, } -/// Content block type discriminator +/// OAuth response variant discriminator. #[derive(Debug, Clone, Default, PartialEq, Eq, Serialize, Deserialize)] -pub enum ExternalToolTextResultForLlmContentTextType { - #[serde(rename = "text")] +pub enum McpOauthPendingRequestResponseCancelledKind { + #[serde(rename = "cancelled")] #[default] - Text, + Cancelled, } -/// Kind of factory progress line. +/// Host response to the pending OAuth request. /// ///
/// @@ -21372,21 +30081,14 @@ pub enum ExternalToolTextResultForLlmContentTextType { /// 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, +#[derive(Debug, Clone, Serialize, Deserialize)] +#[serde(untagged)] +pub enum McpOauthPendingRequestResponse { + Token(McpOauthPendingRequestResponseToken), + Cancelled(McpOauthPendingRequestResponseCancelled), } -/// Cumulative resource ceiling that stopped a factory run. +/// OAuth grant type override for this login. /// ///
/// @@ -21395,20 +30097,20 @@ pub enum FactoryLogLineKind { /// ///
#[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 timeout deadline. - #[serde(rename = "timeout")] - Timeout, +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, } -/// Current or terminal state of a factory run. +/// Why a passive MCP OAuth probe determined authentication is needed. /// ///
/// @@ -21417,140 +30119,55 @@ pub enum FactoryRunFailureKind { /// ///
#[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, +pub enum McpOauthProbeNeedsAuthReason { + /// No token was sent and the server requires authentication. + #[serde(rename = "initial")] + Initial, + /// A cached token was sent and rejected. + #[serde(rename = "refresh")] + Refresh, + /// The server returned a 403 insufficient_scope challenge, indicating additional scopes or audience are needed. + #[serde(rename = "upscope")] + Upscope, /// 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, -} - -/// 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. +/// Probe outcome variant discriminator. #[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. +pub enum McpOauthProbeResultNoAuthRequiredStatus { + #[serde(rename = "no-auth-required")] #[default] - #[serde(other)] - Unknown, + NoAuthRequired, } -/// Constant value. Always "github". +/// Probe outcome variant discriminator. #[derive(Debug, Clone, Default, PartialEq, Eq, Serialize, Deserialize)] -pub enum InstalledPluginSourceGitHubSource { - #[serde(rename = "github")] +pub enum McpOauthProbeResultAuthenticatedStatus { + #[serde(rename = "authenticated")] #[default] - GitHub, + Authenticated, } -/// Constant value. Always "local". +/// Probe outcome variant discriminator. #[derive(Debug, Clone, Default, PartialEq, Eq, Serialize, Deserialize)] -pub enum InstalledPluginSourceLocalSource { - #[serde(rename = "local")] +pub enum McpOauthProbeResultNeedsAuthStatus { + #[serde(rename = "needs-auth")] #[default] - Local, + NeedsAuth, } -/// Constant value. Always "url". +/// Probe outcome variant discriminator. #[derive(Debug, Clone, Default, PartialEq, Eq, Serialize, Deserialize)] -pub enum InstalledPluginSourceUrlSource { - #[serde(rename = "url")] +pub enum McpOauthProbeResultFailedStatus { + #[serde(rename = "failed")] #[default] - Url, + Failed, } -/// Whether the target is a single file or a directory of instruction files +/// Passive MCP OAuth probe result. `authenticated` means the server accepted the probe request while an OAuth-origin access token was attached; it does not prove the server required or independently validated that token. The probe does not make a second unauthenticated request. Failed is an expected probe-domain outcome; JSON-RPC errors are reserved for API-call failures. /// ///
/// @@ -21558,21 +30175,16 @@ pub enum InstalledPluginSourceUrlSource { /// 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, +#[derive(Debug, Clone, Serialize, Deserialize)] +#[serde(untagged)] +pub enum McpOauthProbeResult { + NoAuthRequired(McpOauthProbeResultNoAuthRequired), + Authenticated(McpOauthProbeResultAuthenticated), + NeedsAuth(McpOauthProbeResultNeedsAuth), + Failed(McpOauthProbeResultFailed), } -/// Which tier this target belongs to +/// Discriminator for an enumerated required value /// ///
/// @@ -21581,26 +30193,25 @@ pub enum InstructionDiscoveryPathKind { /// ///
#[derive(Debug, Clone, Default, PartialEq, Eq, Serialize, Deserialize)] -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, +pub enum McpPlanEnumValueType { + /// One of a fixed, non-empty set of permitted values. + #[serde(rename = "enum")] + Enum, /// Unknown variant for forward compatibility. #[default] #[serde(other)] Unknown, } -/// Where this source lives β€” used for UI grouping +/// Discriminator: a plan was computed and nothing was changed +#[derive(Debug, Clone, Default, PartialEq, Eq, Serialize, Deserialize)] +pub enum McpPlanInstallPlannedKind { + #[serde(rename = "planned")] + #[default] + Planned, +} + +/// Discriminator for a candidate-backed install-plan source /// ///
/// @@ -21609,26 +30220,17 @@ pub enum InstructionDiscoveryPathLocation { /// ///
#[derive(Debug, Clone, Default, PartialEq, Eq, Serialize, Deserialize)] -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, +pub enum McpPlanInstallSourceCandidateKind { + /// Plan from a candidate returned by catalog search. + #[serde(rename = "candidate")] + Candidate, /// Unknown variant for forward compatibility. #[default] #[serde(other)] Unknown, } -/// Category of instruction source β€” used for merge logic +/// Discriminator for a URL-backed MCP server card /// ///
/// @@ -21637,50 +30239,17 @@ pub enum InstructionSourceLocation { /// ///
#[derive(Debug, Clone, Default, PartialEq, Eq, Serialize, Deserialize)] -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, - /// 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, -} - -/// 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 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, +pub enum McpServerCardUrlKind { + /// Retrieve the card from its URL. + #[serde(rename = "url")] + Url, /// Unknown variant for forward compatibility. #[default] #[serde(other)] Unknown, } -/// Repository host type +/// Discriminator for an embedded MCP server card /// ///
/// @@ -21689,20 +30258,17 @@ pub enum LlmInferenceHttpRequestStartTransport { /// ///
#[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, +pub enum McpServerCardEmbeddedKind { + /// Use the embedded card document. + #[serde(rename = "embedded")] + Embedded, /// Unknown variant for forward compatibility. #[default] #[serde(other)] Unknown, } -/// Log severity level. Determines how the message is displayed in the timeline. Defaults to "info". +/// A card supplied directly by the caller. Exactly one of a URL or embedded data, encoded structurally so neither both nor neither can be expressed. /// ///
/// @@ -21710,24 +30276,14 @@ pub enum SessionContextHostType { /// and may change or be removed in future SDK or CLI releases. /// ///
-#[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, +#[derive(Debug, Clone, Serialize, Deserialize)] +#[serde(untagged)] +pub enum McpServerCardReference { + Url(McpServerCardUrl), + Embedded(McpServerCardEmbedded), } -/// Allowed values for the `McpAppsHostContextDetailsAvailableDisplayMode` enumeration. +/// Discriminator for a caller-supplied-card install-plan source /// ///
/// @@ -21736,23 +30292,17 @@ 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 McpPlanInstallSourceCardKind { + /// Plan directly from a caller-supplied card. + #[serde(rename = "card")] + Card, /// Unknown variant for forward compatibility. #[default] #[serde(other)] Unknown, } -/// Current display mode (SEP-1865) +/// What an install plan is computed from: a candidate handle from a previous search, or a card supplied directly. /// ///
/// @@ -21760,24 +30310,14 @@ pub enum McpAppsHostContextDetailsAvailableDisplayMode { /// and may change or be removed in future SDK or CLI releases. /// ///
-#[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, - /// Unknown variant for forward compatibility. - #[default] - #[serde(other)] - Unknown, +#[derive(Debug, Clone, Serialize, Deserialize)] +#[serde(untagged)] +pub enum McpPlanInstallSource { + Candidate(McpPlanInstallSourceCandidate), + Card(McpPlanInstallSourceCard), } -/// Platform type for responsive design +/// Outcome of an mcp.planInstall call: either a normalised plan, or one typed refusal. Nothing is written in either case. /// ///
/// @@ -21785,24 +30325,25 @@ pub enum McpAppsHostContextDetailsDisplayMode { /// 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, +#[derive(Debug, Clone, Serialize, Deserialize)] +#[serde(untagged)] +pub enum McpPlanInstallResult { + Planned(McpPlanInstallPlanned), + NegotiationRefused(CatalogNegotiationRefusedError), + HandleRejected(CatalogHandleRejectedError), + InvalidRequest(CatalogInvalidRequestError), + AuthenticationRequired(CatalogAuthenticationRequiredError), + PolicyRejected(CatalogPolicyRejectedError), + NetworkFailure(CatalogNetworkFailureError), + UnsafeRetrieval(CatalogUnsafeRetrievalError), + MalformedCard(CatalogMalformedCardError), + ContractViolation(CatalogContractViolationError), + UnavailableTransport(CatalogUnavailableTransportError), + NotInstallable(CatalogNotInstallableError), + Unavailable(CatalogUnavailableError), } -/// UI theme preference per SEP-1865 +/// Discriminator for a package-backed transport choice /// ///
/// @@ -21811,20 +30352,17 @@ 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 McpPlanPackageInstallMethod { + /// Install and run a local package. + #[serde(rename = "package")] + Package, /// Unknown variant for forward compatibility. #[default] #[serde(other)] Unknown, } -/// Allowed values for the `McpAppsSetHostContextDetailsAvailableDisplayMode` enumeration. +/// Transport exposed by a locally launched package /// ///
/// @@ -21833,23 +30371,17 @@ 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 McpPlanPackageTransport { + /// A locally launched process spoken to over standard input and output. + #[serde(rename = "stdio")] + Stdio, /// Unknown variant for forward compatibility. #[default] #[serde(other)] Unknown, } -/// Current display mode (SEP-1865) +/// Discriminator for a remote-endpoint transport choice /// ///
/// @@ -21858,23 +30390,17 @@ 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 McpPlanRemoteInstallMethod { + /// Connect to a remote endpoint. + #[serde(rename = "remote")] + Remote, /// Unknown variant for forward compatibility. #[default] #[serde(other)] Unknown, } -/// Platform type for responsive design +/// Transport exposed by a remote endpoint /// ///
/// @@ -21883,23 +30409,23 @@ 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 McpPlanRemoteTransport { + /// An HTTP endpoint. + #[serde(rename = "http")] + Http, + /// A streamable HTTP endpoint. + #[serde(rename = "streamable-http")] + StreamableHttp, + /// A server-sent events endpoint. + #[serde(rename = "sse")] + Sse, /// Unknown variant for forward compatibility. #[default] #[serde(other)] Unknown, } -/// UI theme preference per SEP-1865 +/// Where a required value is applied when the planned server is launched /// ///
/// @@ -21908,34 +30434,29 @@ pub enum McpAppsSetHostContextDetailsPlatform { /// ///
#[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, +pub enum McpPlanValueCategory { + /// Set as an environment variable on the launched process. + #[serde(rename = "environment-variable")] + EnvironmentVariable, + /// Passed to the runtime that launches the package. + #[serde(rename = "runtime-argument")] + RuntimeArgument, + /// Passed to the packaged server itself. + #[serde(rename = "package-argument")] + PackageArgument, + /// Sent as a request header to a remote endpoint. + #[serde(rename = "header")] + Header, + /// Substituted into the remote endpoint URL. + #[serde(rename = "url-variable")] + UrlVariable, /// Unknown variant for forward compatibility. #[default] #[serde(other)] Unknown, } -#[derive(Debug, Clone, Default, PartialEq, Eq, Serialize, Deserialize)] -pub enum McpHeadersHandlePendingHeadersRefreshRequestHeadersKind { - #[serde(rename = "headers")] - #[default] - Headers, -} - -#[derive(Debug, Clone, Default, PartialEq, Eq, Serialize, Deserialize)] -pub enum McpHeadersHandlePendingHeadersRefreshRequestNoneKind { - #[serde(rename = "none")] - #[default] - None, -} - -/// Host response: supply dynamic headers or decline this refresh. +/// Discriminator for a scalar required value /// ///
/// @@ -21943,14 +30464,18 @@ pub enum McpHeadersHandlePendingHeadersRefreshRequestNoneKind { /// 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), +#[derive(Debug, Clone, Default, PartialEq, Eq, Serialize, Deserialize)] +pub enum McpPlanRequiredValueScalarKind { + /// The value uses one scalar type. + #[serde(rename = "scalar")] + Scalar, + /// Unknown variant for forward compatibility. + #[default] + #[serde(other)] + Unknown, } -/// Consumer allowed to call an MCP tool. +/// Scalar type a required value must conform to /// ///
/// @@ -21959,34 +30484,26 @@ pub enum McpHeadersHandlePendingHeadersRefreshRequest { /// ///
#[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, +pub enum McpPlanScalarValueType { + /// Free text. + #[serde(rename = "string")] + String, + /// A number. + #[serde(rename = "number")] + Number, + /// A boolean. + #[serde(rename = "boolean")] + Boolean, + /// A filesystem path. + #[serde(rename = "path")] + Path, /// Unknown variant for forward compatibility. #[default] #[serde(other)] Unknown, } -#[derive(Debug, Clone, Default, PartialEq, Eq, Serialize, Deserialize)] -pub enum McpOauthPendingRequestResponseTokenKind { - #[serde(rename = "token")] - #[default] - Token, -} - -#[derive(Debug, Clone, Default, PartialEq, Eq, Serialize, Deserialize)] -pub enum McpOauthPendingRequestResponseCancelledKind { - #[serde(rename = "cancelled")] - #[default] - Cancelled, -} - -/// Host response to the pending OAuth request. +/// Discriminator for an enumerated required value /// ///
/// @@ -21994,14 +30511,18 @@ pub enum McpOauthPendingRequestResponseCancelledKind { /// 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), +#[derive(Debug, Clone, Default, PartialEq, Eq, Serialize, Deserialize)] +pub enum McpPlanRequiredValueEnumKind { + /// The value uses a fixed non-empty enumeration. + #[serde(rename = "enum")] + Enum, + /// Unknown variant for forward compatibility. + #[default] + #[serde(other)] + Unknown, } -/// OAuth grant type override for this login. +/// One non-secret value a transport choice needs, represented as a scalar or enumerated variant so enum values cannot be missing or attached to another type. /// ///
/// @@ -22009,18 +30530,11 @@ pub enum McpOauthPendingRequestResponse { /// and may change or be removed in future SDK or CLI releases. /// ///
-#[derive(Debug, Clone, Default, PartialEq, Eq, Serialize, Deserialize)] -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, +#[derive(Debug, Clone, Serialize, Deserialize)] +#[serde(untagged)] +pub enum McpPlanRequiredValue { + Scalar(McpPlanRequiredValueScalar), + Enum(McpPlanRequiredValueEnum), } /// 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. @@ -22114,6 +30628,46 @@ pub enum McpServerConfigHttpType { Unknown, } +/// In-process MCP transport 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 McpServerConfigMemoryType { + #[serde(rename = "memory")] + Memory, + /// Unknown variant for forward compatibility. + #[default] + #[serde(other)] + Unknown, +} + +/// Local MCP transport 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 McpServerConfigStdioType { + /// Legacy alias for the local stdio transport. + #[serde(rename = "local")] + Local, + /// Server communicates over stdio with a local child process. + #[serde(rename = "stdio")] + Stdio, + /// Unknown variant for forward compatibility. + #[default] + #[serde(other)] + Unknown, +} + /// 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". /// ///
@@ -22537,6 +31091,14 @@ pub enum PermissionDecisionApproveForSessionApprovalExtensionManagementKind { 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 { @@ -22545,6 +31107,14 @@ pub enum PermissionDecisionApproveForSessionApprovalExtensionPermissionAccessKin ExtensionPermissionAccess, } +/// Approval covering an extension's request to read sensitive environment variables. +#[derive(Debug, Clone, Default, PartialEq, Eq, Serialize, Deserialize)] +pub enum PermissionDecisionApproveForSessionApprovalExtensionEnvAccessKind { + #[serde(rename = "extension-env-access")] + #[default] + ExtensionEnvAccess, +} + /// Session-scoped approval to remember (tool prompts only; omitted for path/url prompts) /// ///
@@ -22564,7 +31134,9 @@ pub enum PermissionDecisionApproveForSessionApproval { Memory(PermissionDecisionApproveForSessionApprovalMemory), CustomTool(PermissionDecisionApproveForSessionApprovalCustomTool), ExtensionManagement(PermissionDecisionApproveForSessionApprovalExtensionManagement), + Factory(PermissionDecisionApproveForSessionApprovalFactory), ExtensionPermissionAccess(PermissionDecisionApproveForSessionApprovalExtensionPermissionAccess), + ExtensionEnvAccess(PermissionDecisionApproveForSessionApprovalExtensionEnvAccess), } /// Approve and remember for the rest of the session @@ -22639,6 +31211,14 @@ pub enum PermissionDecisionApproveForLocationApprovalExtensionManagementKind { 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 { @@ -22647,6 +31227,14 @@ pub enum PermissionDecisionApproveForLocationApprovalExtensionPermissionAccessKi ExtensionPermissionAccess, } +/// Approval covering an extension's request to read sensitive environment variables. +#[derive(Debug, Clone, Default, PartialEq, Eq, Serialize, Deserialize)] +pub enum PermissionDecisionApproveForLocationApprovalExtensionEnvAccessKind { + #[serde(rename = "extension-env-access")] + #[default] + ExtensionEnvAccess, +} + /// Approval to persist for this location /// ///
@@ -22666,9 +31254,11 @@ pub enum PermissionDecisionApproveForLocationApproval { Memory(PermissionDecisionApproveForLocationApprovalMemory), CustomTool(PermissionDecisionApproveForLocationApprovalCustomTool), ExtensionManagement(PermissionDecisionApproveForLocationApprovalExtensionManagement), + Factory(PermissionDecisionApproveForLocationApprovalFactory), ExtensionPermissionAccess( PermissionDecisionApproveForLocationApprovalExtensionPermissionAccess, ), + ExtensionEnvAccess(PermissionDecisionApproveForLocationApprovalExtensionEnvAccess), } /// Approve and persist for this project location @@ -22805,6 +31395,115 @@ pub enum PermissionDecision { 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 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, +} + +/// Response capability available to the client when it settled a permission 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 PermissionResponseCapability { + /// The client could ask a user for this decision. + #[serde(rename = "interactive")] + Interactive, + /// The client could return an automated response but could not ask a user. + #[serde(rename = "headless")] + Headless, + /// The client had no response path available. + #[serde(rename = "none")] + None, + /// Unknown variant for forward compatibility. + #[default] + #[serde(other)] + Unknown, +} + +/// Controlled reason or actor responsible for a permission 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, PartialEq, Eq, Serialize, Deserialize)] +pub enum PermissionDecisionSource { + /// The response followed the assisted-approval judge recommendation. + #[serde(rename = "assisted_approval")] + AssistedApproval, + /// 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, +} + +/// Client surface that submitted a permission 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, PartialEq, Eq, Serialize, Deserialize)] +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, + /// An Agent Client Protocol host. + #[serde(rename = "acp")] + Acp, + /// A generic Copilot SDK client. + #[serde(rename = "sdk")] + Sdk, + /// Unknown variant for forward compatibility. + #[default] + #[serde(other)] + Unknown, +} + /// Approval scoped to specific command identifiers. #[derive(Debug, Clone, Default, PartialEq, Eq, Serialize, Deserialize)] pub enum PermissionsLocationsAddToolApprovalDetailsCommandsKind { @@ -22869,6 +31568,14 @@ pub enum PermissionsLocationsAddToolApprovalDetailsExtensionManagementKind { 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 PermissionsLocationsAddToolApprovalDetailsExtensionPermissionAccessKind { @@ -22877,6 +31584,14 @@ pub enum PermissionsLocationsAddToolApprovalDetailsExtensionPermissionAccessKind ExtensionPermissionAccess, } +/// Approval covering an extension's request to read sensitive environment variables. +#[derive(Debug, Clone, Default, PartialEq, Eq, Serialize, Deserialize)] +pub enum PermissionsLocationsAddToolApprovalDetailsExtensionEnvAccessKind { + #[serde(rename = "extension-env-access")] + #[default] + ExtensionEnvAccess, +} + /// Tool approval to persist and apply /// ///
@@ -22896,7 +31611,9 @@ pub enum PermissionsLocationsAddToolApprovalDetails { Memory(PermissionsLocationsAddToolApprovalDetailsMemory), CustomTool(PermissionsLocationsAddToolApprovalDetailsCustomTool), ExtensionManagement(PermissionsLocationsAddToolApprovalDetailsExtensionManagement), + Factory(PermissionsLocationsAddToolApprovalDetailsFactory), ExtensionPermissionAccess(PermissionsLocationsAddToolApprovalDetailsExtensionPermissionAccess), + ExtensionEnvAccess(PermissionsLocationsAddToolApprovalDetailsExtensionEnvAccess), } /// Whether the location is a git repo or directory @@ -22921,6 +31638,37 @@ pub enum PermissionLocationType { Unknown, } +/// Optional source for permission-mode 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 PermissionModeSource { + /// The mode was set from a CLI command-line flag. + #[serde(rename = "cli_flag")] + CliFlag, + /// The mode was set by a slash command. + #[serde(rename = "slash_command")] + SlashCommand, + /// The mode was set by confirming autopilot behavior. + #[serde(rename = "autopilot_confirmation")] + AutopilotConfirmation, + /// The mode was set at startup by the `defaultPermissionMode` user setting. + #[serde(rename = "user_setting")] + UserSetting, + /// The mode was set through an RPC caller. + #[serde(rename = "rpc")] + Rpc, + /// Unknown variant for forward compatibility. + #[default] + #[serde(other)] + Unknown, +} + /// Allowed values for the `PermissionsConfigureAdditionalContentExclusionPolicyScope` enumeration. /// ///
@@ -22974,7 +31722,7 @@ pub enum PermissionsModifyRulesScope { /// ///
#[derive(Debug, Clone, Default, PartialEq, Eq, Serialize, Deserialize)] -pub enum PermissionsSetAllowAllSource { +pub enum PermissionsSetApproveAllSource { /// Allow-all was enabled from a CLI command-line flag. #[serde(rename = "cli_flag")] CliFlag, @@ -22984,6 +31732,9 @@ pub enum PermissionsSetAllowAllSource { /// Allow-all was enabled by confirming autopilot behavior. #[serde(rename = "autopilot_confirmation")] AutopilotConfirmation, + /// Allow-all was enabled at startup by the `defaultPermissionMode` user setting. + #[serde(rename = "user_setting")] + UserSetting, /// Allow-all was enabled through an RPC caller. #[serde(rename = "rpc")] Rpc, @@ -22993,7 +31744,7 @@ pub enum PermissionsSetAllowAllSource { Unknown, } -/// Optional source for allow-all telemetry. Defaults to `rpc` when omitted for SDK callers. +/// Controls whether the runtime may defer loading an external tool definition. /// ///
/// @@ -23002,19 +31753,13 @@ 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 ProtocolExternalToolDefer { + /// The runtime may defer the tool according to its tool-loading policy. + #[serde(rename = "auto")] + Auto, + /// The runtime must include the tool without deferring it. + #[serde(rename = "never")] + Never, /// Unknown variant for forward compatibility. #[default] #[serde(other)] @@ -23216,7 +31961,57 @@ pub enum PushAttachmentGitHubUrlType { pub enum PushAttachmentSelectionType { #[serde(rename = "selection")] #[default] - Selection, + Selection, +} + +/// 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 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] + #[serde(other)] + Unknown, +} + +/// 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 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] + #[serde(other)] + Unknown, } /// Whether this item is a queued user message or a queued slash command / model change @@ -23298,7 +32093,7 @@ pub enum RemoteSessionMode { Unknown, } -/// Whether the remote task originated from CCA or CLI `--remote`. +/// What a remote host says one of its sessions is doing right now. Deliberately coarse: this is what a host can report for EVERY session in a catalogue listing, without a client subscribing to each one. AHP's `SessionSummary.status` is the source today; `input-needed` covers both a permission prompt and an `ask_user` question, since the summary does not say which. /// ///
/// @@ -23307,20 +32102,26 @@ pub enum RemoteSessionMode { /// ///
#[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, +pub enum RemoteSessionHostStatus { + /// No turn is running. + #[serde(rename = "idle")] + Idle, + /// A turn is running. + #[serde(rename = "working")] + Working, + /// The session is blocked on the user: a permission prompt or an `ask_user` question. + #[serde(rename = "input-needed")] + InputNeeded, + /// The session ended its last turn in an error. + #[serde(rename = "error")] + Error, /// 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. +/// Whether the remote task originated from CCA or CLI `--remote`. /// ///
/// @@ -23329,26 +32130,20 @@ pub enum RemoteSessionMetadataTaskType { /// ///
#[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 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, } -/// How to deliver the message. `enqueue` (default) appends to the message queue. `immediate` interjects during an in-progress turn. +/// Origin of the sandbox choice supplied by an internal client. /// ///
/// @@ -23357,13 +32152,28 @@ pub enum SendAgentMode { /// ///
#[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 SandboxConfigSource { + /// The client applied the default because no sandbox preference was configured. + #[serde(rename = "never_configured")] + NeverConfigured, + /// The user's persisted settings enabled the sandbox. + #[serde(rename = "user_enabled")] + UserEnabled, + /// The user's persisted settings disabled the sandbox. + #[serde(rename = "user_disabled")] + UserDisabled, + /// A command-line flag selected the sandbox state for this session. + #[serde(rename = "session_flag")] + SessionFlag, + /// The user disabled the sandbox for the current session. + #[serde(rename = "session_disabled")] + SessionDisabled, + /// The client disabled the sandbox because the host cannot enforce it. + #[serde(rename = "unsupported_host")] + UnsupportedHost, + /// A repository policy selected the sandbox state. + #[serde(rename = "repository_policy")] + RepositoryPolicy, /// Unknown variant for forward compatibility. #[default] #[serde(other)] @@ -23508,6 +32318,31 @@ pub enum SessionFsSqliteQueryType { Unknown, } +/// 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 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] + #[serde(other)] + Unknown, +} + /// Constant value. Always "github". #[derive(Debug, Clone, Default, PartialEq, Eq, Serialize, Deserialize)] pub enum SessionInstalledPluginSourceGitHubSource { @@ -23532,6 +32367,134 @@ pub enum SessionInstalledPluginSourceUrlSource { Url, } +/// 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 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] + #[serde(other)] + Unknown, +} + +/// Semantic usage tier used for a recommended cap or additional headroom. +/// +///
+/// +/// **Experimental.** This type 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 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, +} + +/// Baseline fallback level used to create the prediction. +/// +///
+/// +/// **Experimental.** This type 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 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, +} + +/// Prediction result variant discriminator. +#[derive(Debug, Clone, Default, PartialEq, Eq, Serialize, Deserialize)] +pub enum SessionLimitPredictionResultAvailableKind { + #[serde(rename = "available")] + #[default] + Available, +} + +/// Prediction result variant discriminator. +#[derive(Debug, Clone, Default, PartialEq, Eq, Serialize, Deserialize)] +pub enum SessionLimitPredictionResultUnavailableKind { + #[serde(rename = "unavailable")] + #[default] + Unavailable, +} + +/// Reason a prediction could not be computed. +/// +///
+/// +/// **Experimental.** This type 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 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, +} + +/// 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 /// ///
@@ -23623,6 +32586,50 @@ pub enum SessionOpenOptionsReasoningSummary { Unknown, } +/// Controls automatic non-interactive profile loading where supported. Explicit initScripts are unaffected. +/// +///
+/// +/// **Experimental.** This type 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 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, +} + +/// Supported built-in shells for initialization scripts. +/// +///
+/// +/// **Experimental.** This type 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 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, +} + /// Create a new local session. #[derive(Debug, Clone, Default, PartialEq, Eq, Serialize, Deserialize)] pub enum SessionsOpenCreateKind { @@ -23808,6 +32815,34 @@ pub enum SessionsOpenStatus { Unknown, } +/// SDK-side token authentication; the host configured the token directly via the SDK. +#[derive(Debug, Clone, Default, PartialEq, Eq, Serialize, Deserialize)] +pub enum SettableTokenAuthInfoType { + #[serde(rename = "token")] + #[default] + Token, +} + +/// Authentication credentials accepted by session.gitHubAuth.setCredentials. Session-owned token-provider identities cannot be installed through this method. +/// +///
+/// +/// **Experimental.** This 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 SettableAuthInfo { + Hmac(HMACAuthInfo), + Env(EnvAuthInfo), + Token(SettableTokenAuthInfo), + CopilotApiToken(CopilotApiTokenAuthInfo), + User(UserAuthInfo), + GhCli(GhCliAuthInfo), + ApiKey(ApiKeyAuthInfo), +} + /// Rust-owned settings predicates exposed across the SDK boundary. Raw feature-flag names are intentionally not part of the contract. /// ///
@@ -23978,6 +33013,14 @@ pub enum SkillDiscoveryScope { Unknown, } +/// Discriminator for an add-timeline-entry result. +#[derive(Debug, Clone, Default, PartialEq, Eq, Serialize, Deserialize)] +pub enum SlashCommandAddTimelineEntryResultKind { + #[serde(rename = "add-timeline-entry")] + #[default] + AddTimelineEntry, +} + /// Agent prompt result discriminator #[derive(Debug, Clone, Default, PartialEq, Eq, Serialize, Deserialize)] pub enum SlashCommandAgentPromptResultKind { @@ -24010,6 +33053,38 @@ pub enum SlashCommandSelectSubcommandResultKind { SelectSubcommand, } +/// Discriminator for a model-picker dialog. +#[derive(Debug, Clone, Default, PartialEq, Eq, Serialize, Deserialize)] +pub enum SlashCommandModelPickerDialogKind { + #[serde(rename = "model-picker")] + #[default] + ModelPicker, +} + +/// Discriminator for a show-dialog result. +#[derive(Debug, Clone, Default, PartialEq, Eq, Serialize, Deserialize)] +pub enum SlashCommandShowDialogResultKind { + #[serde(rename = "show-dialog")] + #[default] + ShowDialog, +} + +/// Discriminator for a set-model result. +#[derive(Debug, Clone, Default, PartialEq, Eq, Serialize, Deserialize)] +pub enum SlashCommandSetModelResultKind { + #[serde(rename = "set-model")] + #[default] + SetModel, +} + +/// Discriminator for a set-plan-model result. +#[derive(Debug, Clone, Default, PartialEq, Eq, Serialize, Deserialize)] +pub enum SlashCommandSetPlanModelResultKind { + #[serde(rename = "set-plan-model")] + #[default] + SetPlanModel, +} + /// Result of invoking the slash command (text output, prompt to send to the agent, completion, or subcommand selection). /// ///
@@ -24025,6 +33100,10 @@ pub enum SlashCommandInvocationResult { AgentPrompt(SlashCommandAgentPromptResult), Completed(SlashCommandCompletedResult), SelectSubcommand(SlashCommandSelectSubcommandResult), + AddTimelineEntry(SlashCommandAddTimelineEntryResult), + ShowDialog(SlashCommandShowDialogResult), + SetModel(SlashCommandSetModelResult), + SetPlanModel(SlashCommandSetPlanModelResult), } /// Context tier override for matching subagents @@ -24159,12 +33238,50 @@ pub enum TaskShellProgressType { Shell, } -/// SDK-side token authentication; the host configured the token directly via the SDK. +/// Execution outcome 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 TokenAuthInfoType { - #[serde(rename = "token")] +pub enum ToolResultType { + /// The tool completed successfully. + #[serde(rename = "success")] + Success, + /// The tool failed. + #[serde(rename = "failure")] + Failure, + /// The tool exceeded its execution timeout. + #[serde(rename = "timeout")] + Timeout, + /// The tool request was rejected before execution. + #[serde(rename = "rejected")] + Rejected, + /// Permission policy denied the tool request. + #[serde(rename = "denied")] + Denied, + /// Unknown variant for forward compatibility. #[default] - Token, + #[serde(other)] + Unknown, +} + +/// Canonical result returned by a session 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, Serialize, Deserialize)] +#[serde(untagged)] +pub enum ToolResult { + String(String), + ToolResultExpanded(ToolResultExpanded), } /// User's choice for auto-mode switching: yes (allow this turn), yes_always (allow + persist as setting), or no (decline). @@ -24387,14 +33504,6 @@ pub enum UISessionLimitsExhaustedResponseAction { 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 { - #[serde(rename = "user")] - #[default] - User, -} - /// Type of change represented by this file diff. /// ///
diff --git a/rust/src/generated/rpc.rs b/rust/src/generated/rpc.rs index 431ffa3aed..4d5b7f1538 100644 --- a/rust/src/generated/rpc.rs +++ b/rust/src/generated/rpc.rs @@ -43,6 +43,13 @@ impl<'a> ClientRpc<'a> { } } + /// `catalog.*` sub-namespace. + pub fn catalog(&self) -> ClientRpcCatalog<'a> { + ClientRpcCatalog { + client: self.client, + } + } + /// `commands.*` sub-namespace. pub fn commands(&self) -> ClientRpcCommands<'a> { ClientRpcCommands { @@ -50,6 +57,13 @@ impl<'a> ClientRpc<'a> { } } + /// `extensions.*` sub-namespace. + pub fn extensions(&self) -> ClientRpcExtensions<'a> { + ClientRpcExtensions { + client: self.client, + } + } + /// `instructions.*` sub-namespace. pub fn instructions(&self) -> ClientRpcInstructions<'a> { ClientRpcInstructions { @@ -64,6 +78,13 @@ impl<'a> ClientRpc<'a> { } } + /// `managedSettings.*` sub-namespace. + pub fn managed_settings(&self) -> ClientRpcManagedSettings<'a> { + ClientRpcManagedSettings { + client: self.client, + } + } + /// `mcp.*` sub-namespace. pub fn mcp(&self) -> ClientRpcMcp<'a> { ClientRpcMcp { @@ -168,7 +189,7 @@ impl<'a> ClientRpc<'a> { /// /// # Parameters /// - /// * `params` - Parameters for the `server.connect` handshake: an optional connection token and optional connection-level opt-ins (e.g. GitHub telemetry forwarding). + /// * `params` - Connection-level opt-ins for the `server.connect` handshake. Transport authentication is consumed by the native protocol boundary before dispatch. /// /// # Returns /// @@ -189,6 +210,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. @@ -198,7 +242,7 @@ pub struct ClientRpcAccount<'a> { } impl<'a> ClientRpcAccount<'a> { - /// Gets Copilot quota usage for the authenticated user or supplied GitHub token. + /// Gets Copilot quota usage for the current or opaquely selected authenticated user. /// /// Wire method: `account.getQuota`. /// @@ -222,13 +266,13 @@ impl<'a> ClientRpcAccount<'a> { Ok(serde_json::from_value(_value)?) } - /// Gets Copilot quota usage for the authenticated user or supplied GitHub token. + /// Gets Copilot quota usage for the current or opaquely selected authenticated user. /// /// Wire method: `account.getQuota`. /// /// # Parameters /// - /// * `params` - Optional GitHub token used to look up quota for a specific user instead of the global auth context. + /// * `params` - Optional opaque account selection or compatibility GitHub token used to look up quota. /// /// # Returns /// @@ -301,13 +345,13 @@ impl<'a> ClientRpcAccount<'a> { Ok(serde_json::from_value(_value)?) } - /// Stores authentication credentials after successful login (e.g., device code flow). + /// Validates and stores authentication credentials. When login is omitted, resolves the authenticated user from the token before persistence. /// /// Wire method: `account.login`. /// /// # Parameters /// - /// * `params` - Credentials to store after successful authentication + /// * `params` - Credentials to validate and store. Omit login to resolve the authenticated user from the token. /// /// # Returns /// @@ -464,6 +508,42 @@ impl<'a> ClientRpcAgents<'a> { } } +/// `catalog.*` RPCs. +#[derive(Clone, Copy)] +pub struct ClientRpcCatalog<'a> { + pub(crate) client: &'a Client, +} + +impl<'a> ClientRpcCatalog<'a> { + /// Requests a bounded catalog search. This host-implemented server method is available through SDK/TUI hosts; standalone and C-ABI runtimes whose host does not implement server-method dispatch return JSON-RPC MethodNotFound. A runtime with search available returns inert candidate summaries, each with an opaque single-use handle scoped to this runtime instance; a runtime without it returns the typed search-unavailable result. Public authorities may be searched anonymously, while an authority that requires credentials yields the typed authentication-required result. All returned text, URLs, and package metadata are untrusted external data and can never trigger instructions, tools, or installation. Read-only: nothing is installed, configured, or persisted. + /// + /// Wire method: `catalog.search`. + /// + /// # Parameters + /// + /// * `params` - A bounded catalog search. Both the query length and the result count are capped by the schema so a caller cannot request an unbounded scan. + /// + /// # Returns + /// + /// Outcome of a catalog.search call: either bounded inert candidates, or one typed refusal. Never a partial 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 async fn search(&self, params: CatalogSearchRequest) -> Result { + let wire_params = serde_json::to_value(params)?; + let _value = self + .client + .call(rpc_methods::CATALOG_SEARCH, Some(wire_params)) + .await?; + Ok(serde_json::from_value(_value)?) + } +} + /// `commands.*` RPCs. #[derive(Clone, Copy)] pub struct ClientRpcCommands<'a> { @@ -496,6 +576,86 @@ impl<'a> ClientRpcCommands<'a> { } } +/// `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: `extensions.discover`. + /// + /// # Returns + /// + /// 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::EXTENSIONS_DISCOVER, Some(wire_params)) + .await?; + Ok(serde_json::from_value(_value)?) + } + + /// Persistently enables extension IDs for future sessions. Active sessions are unchanged; use session.extensions.enable to update them. + /// + /// Wire method: `extensions.enable`. + /// + /// # Parameters + /// + /// * `params` - Source-qualified extension identifiers to persistently enable for future sessions. + /// + ///
+ /// + /// **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: DiscoveredExtensionsEnableRequest) -> Result<(), Error> { + let wire_params = serde_json::to_value(params)?; + let _value = self + .client + .call(rpc_methods::EXTENSIONS_ENABLE, Some(wire_params)) + .await?; + Ok(()) + } + + /// Persistently disables extension IDs for future sessions. Active sessions are unchanged; use session.extensions.disable to update them. + /// + /// Wire method: `extensions.disable`. + /// + /// # Parameters + /// + /// * `params` - Source-qualified extension identifiers to persistently disable for future sessions. + /// + ///
+ /// + /// **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: DiscoveredExtensionsDisableRequest) -> Result<(), Error> { + let wire_params = serde_json::to_value(params)?; + let _value = self + .client + .call(rpc_methods::EXTENSIONS_DISABLE, Some(wire_params)) + .await?; + Ok(()) + } +} + /// `instructions.*` RPCs. #[derive(Clone, Copy)] pub struct ClientRpcInstructions<'a> { @@ -669,6 +829,38 @@ impl<'a> ClientRpcLlmInference<'a> { } } +/// `managedSettings.*` RPCs. +#[derive(Clone, Copy)] +pub struct ClientRpcManagedSettings<'a> { + pub(crate) client: &'a Client, +} + +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: `managedSettings.read`. + /// + /// # Returns + /// + /// Validated device-managed settings discovered before a 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 async fn read(&self) -> Result { + let wire_params = serde_json::json!({}); + let _value = self + .client + .call(rpc_methods::MANAGEDSETTINGS_READ, Some(wire_params)) + .await?; + Ok(serde_json::from_value(_value)?) + } +} + /// `mcp.*` RPCs. #[derive(Clone, Copy)] pub struct ClientRpcMcp<'a> { @@ -710,6 +902,37 @@ impl<'a> ClientRpcMcp<'a> { .await?; Ok(serde_json::from_value(_value)?) } + + /// Requests a side-effect-free MCP install plan from a catalog candidate handle or a caller-supplied card. This host-implemented server method is available through SDK/TUI hosts; standalone and C-ABI runtimes whose host does not implement server-method dispatch return JSON-RPC MethodNotFound. A runtime with planning available returns a normalised plan and opaque single-use plan handle; a runtime without it returns the typed planning-unavailable result. A completed plan reports resource identity, provenance, eligible transport choices, the user-scope target, required typed values and secret placeholders, the policy result, the configuration changes installing would make, and whether a reload would be needed. Planning never writes configuration, stores a secret, or reloads MCP servers, so abandoning a plan needs no call and leaves nothing behind. + /// + /// Wire method: `mcp.planInstall`. + /// + /// # Parameters + /// + /// * `params` - A side-effect-free request for an MCP install plan. Computing a plan never writes configuration, stores a secret, or reloads MCP servers. + /// + /// # Returns + /// + /// Outcome of an mcp.planInstall call: either a normalised plan, or one typed refusal. Nothing is written in either case. + /// + ///
+ /// + /// **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 plan_install( + &self, + params: McpPlanInstallRequest, + ) -> Result { + let wire_params = serde_json::to_value(params)?; + let _value = self + .client + .call(rpc_methods::MCP_PLANINSTALL, Some(wire_params)) + .await?; + Ok(serde_json::from_value(_value)?) + } } /// `mcp.config.*` RPCs. @@ -921,7 +1144,7 @@ impl<'a> ClientRpcModels<'a> { /// /// # Parameters /// - /// * `params` - Optional GitHub token used to list models for a specific user instead of the global auth context. + /// * `params` - Optional opaque account selection or compatibility GitHub token used to list models. /// /// # Returns /// @@ -942,6 +1165,30 @@ impl<'a> ClientRpcModels<'a> { .await?; Ok(serde_json::from_value(_value)?) } + + /// Returns the running runtime's complete catalog of well-known built-in model IDs without authentication or network access. + /// + /// Wire 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. + /// + ///
+ /// + /// **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_built_in_catalog(&self) -> Result { + let wire_params = serde_json::json!({}); + let _value = self + .client + .call(rpc_methods::MODELS_GETBUILTINCATALOG, Some(wire_params)) + .await?; + Ok(serde_json::from_value(_value)?) + } } /// `plugins.*` RPCs. @@ -951,6 +1198,13 @@ pub struct ClientRpcPlugins<'a> { } impl<'a> ClientRpcPlugins<'a> { + /// `plugins.builtin.*` sub-namespace. + pub fn builtin(&self) -> ClientRpcPluginsBuiltin<'a> { + ClientRpcPluginsBuiltin { + client: self.client, + } + } + /// `plugins.marketplaces.*` sub-namespace. pub fn marketplaces(&self) -> ClientRpcPluginsMarketplaces<'a> { ClientRpcPluginsMarketplaces { @@ -1138,6 +1392,38 @@ impl<'a> ClientRpcPlugins<'a> { } } +/// `plugins.builtin.*` RPCs. +#[derive(Clone, Copy)] +pub struct ClientRpcPluginsBuiltin<'a> { + pub(crate) client: &'a Client, +} + +impl<'a> ClientRpcPluginsBuiltin<'a> { + /// Replaces this server's trusted built-in plugin directories while no sessions are active. + /// + /// Wire method: `plugins.builtin.set`. + /// + /// # Parameters + /// + /// * `params` - Trusted built-in plugin directories to use for this runtime 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 set(&self, params: PluginsBuiltinSetRequest) -> Result<(), Error> { + let wire_params = serde_json::to_value(params)?; + let _value = self + .client + .call(rpc_methods::PLUGINS_BUILTIN_SET, Some(wire_params)) + .await?; + Ok(()) + } +} + /// `plugins.marketplaces.*` RPCs. #[derive(Clone, Copy)] pub struct ClientRpcPluginsMarketplaces<'a> { @@ -1569,17 +1855,17 @@ impl<'a> ClientRpcSessions<'a> { Ok(serde_json::from_value(_value)?) } - /// Finds the local session bound to a GitHub task ID, if any. + /// Reads lightweight persisted metadata for one local session without opening it. /// - /// Wire method: `sessions.findByTaskId`. + /// Wire method: `sessions.getMetadata`. /// /// # Parameters /// - /// * `params` - GitHub task ID to look up. + /// * `params` - Session ID whose persisted metadata should be read. /// /// # Returns /// - /// ID of the local session bound to the given GitHub task, or omitted when none. + /// Persisted local session metadata when the session exists. /// ///
/// @@ -1588,29 +1874,29 @@ impl<'a> ClientRpcSessions<'a> { /// SDK and CLI versions if your code depends on it. /// ///
- pub async fn find_by_task_id( + pub(crate) async fn get_metadata( &self, - params: SessionsFindByTaskIDRequest, - ) -> Result { + params: SessionsGetMetadataRequest, + ) -> Result { let wire_params = serde_json::to_value(params)?; let _value = self .client - .call(rpc_methods::SESSIONS_FINDBYTASKID, Some(wire_params)) + .call(rpc_methods::SESSIONS_GETMETADATA, Some(wire_params)) .await?; Ok(serde_json::from_value(_value)?) } - /// Resolves a UUID prefix to a unique session ID, if exactly one session matches. + /// Lists recent local session IDs that contain user-visible history, omitting housekeeping-only sessions. /// - /// Wire method: `sessions.findByPrefix`. + /// Wire method: `sessions.listNonEmptySessionIds`. /// /// # Parameters /// - /// * `params` - UUID prefix to resolve to a unique session ID. + /// * `params` - Limit for non-empty local session IDs. /// /// # Returns /// - /// Session ID matching the prefix, omitted when no unique match exists. + /// Recent local session IDs that contain user-visible history. /// ///
/// @@ -1619,29 +1905,32 @@ impl<'a> ClientRpcSessions<'a> { /// SDK and CLI versions if your code depends on it. /// ///
- pub async fn find_by_prefix( + pub(crate) async fn list_non_empty_session_ids( &self, - params: SessionsFindByPrefixRequest, - ) -> Result { + params: SessionsListNonEmptySessionIdsRequest, + ) -> Result { let wire_params = serde_json::to_value(params)?; let _value = self .client - .call(rpc_methods::SESSIONS_FINDBYPREFIX, Some(wire_params)) + .call( + rpc_methods::SESSIONS_LISTNONEMPTYSESSIONIDS, + Some(wire_params), + ) .await?; Ok(serde_json::from_value(_value)?) } - /// Returns the most-relevant prior session for a given working-directory context. + /// Finds the local session bound to a GitHub task ID, if any. /// - /// Wire method: `sessions.getLastForContext`. + /// Wire method: `sessions.findByTaskId`. /// /// # Parameters /// - /// * `params` - Optional working-directory context used to score session relevance. + /// * `params` - GitHub task ID to look up. /// /// # Returns /// - /// Most-relevant session ID for the supplied context, or omitted when no sessions exist. + /// ID of the local session bound to the given GitHub task, or omitted when none. /// ///
/// @@ -1650,29 +1939,91 @@ impl<'a> ClientRpcSessions<'a> { /// SDK and CLI versions if your code depends on it. /// ///
- pub async fn get_last_for_context( + pub async fn find_by_task_id( &self, - params: SessionsGetLastForContextRequest, - ) -> Result { + params: SessionsFindByTaskIDRequest, + ) -> Result { let wire_params = serde_json::to_value(params)?; let _value = self .client - .call(rpc_methods::SESSIONS_GETLASTFORCONTEXT, Some(wire_params)) + .call(rpc_methods::SESSIONS_FINDBYTASKID, 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. + /// Resolves a UUID prefix to a unique session ID, if exactly one session matches. /// - /// Wire method: `sessions.getEventFilePath`. + /// Wire method: `sessions.findByPrefix`. /// /// # Parameters /// - /// * `params` - Session ID whose event-log file path to compute. + /// * `params` - UUID prefix to resolve to a unique session ID. /// /// # Returns /// - /// Absolute path to the session's events.jsonl file on disk. + /// 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. /// ///
/// @@ -1841,6 +2192,30 @@ impl<'a> ClientRpcSessions<'a> { 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`. @@ -2448,6 +2823,36 @@ impl<'a> ClientRpcSkillsConfig<'a> { .await?; Ok(()) } + + /// Atomically adds or removes one skill from the disabled list. + /// + /// Wire method: `skills.config.setSkillDisabled`. + /// + /// # Parameters + /// + /// * `params` - Adds or removes a single skill from the global disabled list, leaving every other entry untouched. + /// + ///
+ /// + /// **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_skill_disabled( + &self, + params: SkillsConfigSetSkillDisabledRequest, + ) -> Result<(), Error> { + let wire_params = serde_json::to_value(params)?; + let _value = self + .client + .call( + rpc_methods::SKILLS_CONFIG_SETSKILLDISABLED, + Some(wire_params), + ) + .await?; + Ok(()) + } } /// `tools.*` RPCs. @@ -2619,6 +3024,13 @@ impl<'a> SessionRpc<'a> { } } + /// `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 { @@ -2675,6 +3087,13 @@ impl<'a> SessionRpc<'a> { } } + /// `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 { @@ -2927,6 +3346,38 @@ impl<'a> SessionRpc<'a> { 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`. @@ -2957,6 +3408,69 @@ impl<'a> SessionRpc<'a> { 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`. @@ -3021,13 +3535,13 @@ pub struct SessionRpcAgent<'a> { } impl<'a> SessionRpcAgent<'a> { - /// 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. /// /// Wire method: `session.agent.list`. /// /// # Returns /// - /// Custom agents available to the session. + /// Agents available to the session. /// ///
/// @@ -3046,6 +3560,62 @@ impl<'a> SessionRpcAgent<'a> { 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`. @@ -3162,6 +3732,13 @@ impl<'a> SessionRpcCanvas<'a> { } } + /// `session.canvas.provider.*` sub-namespace. + pub fn provider(&self) -> SessionRpcCanvasProvider<'a> { + SessionRpcCanvasProvider { + session: self.session, + } + } + /// Lists canvases declared for the session. /// /// Wire method: `session.canvas.list`. @@ -3310,20 +3887,20 @@ impl<'a> SessionRpcCanvasAction<'a> { } } -/// `session.commands.*` RPCs. +/// `session.canvas.provider.*` RPCs. #[derive(Clone, Copy)] -pub struct SessionRpcCommands<'a> { +pub struct SessionRpcCanvasProvider<'a> { pub(crate) session: &'a Session, } -impl<'a> SessionRpcCommands<'a> { - /// Lists slash commands available in the session. +impl<'a> SessionRpcCanvasProvider<'a> { + /// Registers an internal canvas provider connection and its contributions. /// - /// Wire method: `session.commands.list`. + /// Wire method: `session.canvas.provider.register`. /// - /// # Returns + /// # Parameters /// - /// Slash commands available in the session, after applying any include/exclude filters. + /// * `params` - Internal canvas provider registration parameters. /// ///
/// @@ -3332,13 +3909,85 @@ impl<'a> SessionRpcCommands<'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 register( + &self, + params: CanvasProviderRegisterRequest, + ) -> 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_LIST, Some(wire_params)) - .await?; + .call( + rpc_methods::SESSION_CANVAS_PROVIDER_REGISTER, + Some(wire_params), + ) + .await?; + Ok(()) + } + + /// Unregisters an internal canvas provider connection. + /// + /// Wire method: `session.canvas.provider.unregister`. + /// + /// # Parameters + /// + /// * `params` - Internal canvas provider unregistration 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(crate) async fn unregister( + &self, + params: CanvasProviderUnregisterRequest, + ) -> 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_PROVIDER_UNREGISTER, + Some(wire_params), + ) + .await?; + Ok(()) + } +} + +/// `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)?) } @@ -3408,6 +4057,42 @@ impl<'a> SessionRpcCommands<'a> { Ok(serde_json::from_value(_value)?) } + /// Finalizes persistence associated with a client-applied slash-command effect. + /// + /// Wire method: `session.commands.finalizeInvocationEffect`. + /// + /// # Parameters + /// + /// * `params` - The pending slash-command invocation effect to finalize, plus whether the host applied or cancelled it. + /// + /// # Returns + /// + /// Whether finalizing the invocation effect succeeded, and the failure reason when it did not. + /// + ///
+ /// + /// **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 finalize_invocation_effect( + &self, + params: CommandsFinalizeInvocationEffectRequest, + ) -> 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_FINALIZEINVOCATIONEFFECT, + Some(wire_params), + ) + .await?; + Ok(serde_json::from_value(_value)?) + } + /// Reports completion of a pending client-handled slash command. /// /// Wire method: `session.commands.handlePendingCommand`. @@ -3618,6 +4303,50 @@ impl<'a> SessionRpcCompletions<'a> { } } +/// `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> { @@ -3666,7 +4395,7 @@ pub struct SessionRpcEventLog<'a> { } impl<'a> SessionRpcEventLog<'a> { - /// 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`. /// /// Wire method: `session.eventLog.read`. /// @@ -3976,17 +4705,17 @@ impl<'a> SessionRpcFactory<'a> { Ok(serde_json::from_value(_value)?) } - /// Gets the current or settled envelope for a factory run. + /// Resumes a factory run using its persisted name, arguments, journal, and accounting. /// - /// Wire method: `session.factory.getRun`. + /// Wire method: `session.factory.resume`. /// /// # Parameters /// - /// * `params` - Parameters for retrieving a factory run. + /// * `params` - Parameters for resuming a factory run from its persisted identity. /// /// # Returns /// - /// Complete current or terminal factory run envelope. + /// Resolved persisted factory identity and resumed run envelope. /// ///
/// @@ -3995,24 +4724,24 @@ impl<'a> SessionRpcFactory<'a> { /// SDK and CLI versions if your code depends on it. /// ///
- pub async fn get_run(&self, params: FactoryGetRunRequest) -> Result { + 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_GETRUN, Some(wire_params)) + .call(rpc_methods::SESSION_FACTORY_RESUME, Some(wire_params)) .await?; Ok(serde_json::from_value(_value)?) } - /// Requests cancellation of a factory run and returns its run envelope. + /// Internal tool-originated factory invocation. /// - /// Wire method: `session.factory.cancel`. + /// Wire method: `session.factory.runFromTool`. /// /// # Parameters /// - /// * `params` - Parameters for cancelling a factory run. + /// * `params` - Internal parameters for invoking a registered factory from a tool. /// /// # Returns /// @@ -4025,28 +4754,31 @@ impl<'a> SessionRpcFactory<'a> { /// SDK and CLI versions if your code depends on it. /// ///
- pub async fn cancel(&self, params: FactoryCancelRequest) -> Result { + pub(crate) async fn run_from_tool( + &self, + params: FactoryToolRunRequest, + ) -> 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)) + .call(rpc_methods::SESSION_FACTORY_RUNFROMTOOL, Some(wire_params)) .await?; Ok(serde_json::from_value(_value)?) } - /// Records a batch of ordered factory progress lines. + /// Internal tool-originated factory resume. /// - /// Wire method: `session.factory.log`. + /// Wire method: `session.factory.resumeFromTool`. /// /// # Parameters /// - /// * `params` - Parameters for recording factory progress. + /// * `params` - Internal parameters for resuming a factory run from a tool. /// /// # Returns /// - /// Acknowledgement that a factory request was accepted. + /// Resolved persisted factory identity and resumed run envelope. /// ///
/// @@ -4055,28 +4787,34 @@ impl<'a> SessionRpcFactory<'a> { /// SDK and CLI versions if your code depends on it. /// ///
- pub async fn log(&self, params: FactoryLogRequest) -> Result { + pub(crate) async fn resume_from_tool( + &self, + params: FactoryToolResumeRequest, + ) -> 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)) + .call( + rpc_methods::SESSION_FACTORY_RESUMEFROMTOOL, + Some(wire_params), + ) .await?; Ok(serde_json::from_value(_value)?) } - /// Runs one factory-scoped subagent and returns its result. + /// Gets the current or settled envelope for a factory run. /// - /// Wire method: `session.factory.agent`. + /// Wire method: `session.factory.getRun`. /// /// # Parameters /// - /// * `params` - Parameters for one factory-scoped subagent call. + /// * `params` - Parameters for retrieving a factory run. /// /// # Returns /// - /// Result of one factory-scoped subagent call. + /// Complete current or terminal factory run envelope. /// ///
/// @@ -4085,36 +4823,28 @@ impl<'a> SessionRpcFactory<'a> { /// SDK and CLI versions if your code depends on it. /// ///
- pub async fn agent(&self, params: FactoryAgentRequest) -> Result { + 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_AGENT, Some(wire_params)) + .call(rpc_methods::SESSION_FACTORY_GETRUN, 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. + /// Lists durable factory runs for this session in creation order. /// - /// Wire method: `session.factory.journal.get`. + /// Wire method: `session.factory.listRuns`. /// /// # Parameters /// - /// * `params` - Parameters for reading a factory journal entry. + /// * `params` - Parameters for paging factory runs. /// /// # Returns /// - /// Result of reading a factory journal entry. + /// A page of factory runs in durable creation order. /// ///
/// @@ -4123,31 +4853,31 @@ impl<'a> SessionRpcFactoryJournal<'a> { /// SDK and CLI versions if your code depends on it. /// ///
- pub async fn get( + pub async fn list_runs( &self, - params: FactoryJournalGetRequest, - ) -> Result { + 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_JOURNAL_GET, Some(wire_params)) + .call(rpc_methods::SESSION_FACTORY_LISTRUNS, Some(wire_params)) .await?; Ok(serde_json::from_value(_value)?) } - /// Stores a memoized factory journal entry. + /// Gets durable and live observability detail for one factory run. /// - /// Wire method: `session.factory.journal.put`. + /// Wire method: `session.factory.getRunDetail`. /// /// # Parameters /// - /// * `params` - Parameters for storing a factory journal entry. + /// * `params` - Parameters for retrieving a factory run. /// /// # Returns /// - /// Acknowledgement that a factory request was accepted. + /// Full factory run observability detail. /// ///
/// @@ -4156,36 +4886,31 @@ impl<'a> SessionRpcFactoryJournal<'a> { /// SDK and CLI versions if your code depends on it. /// ///
- pub async fn put(&self, params: FactoryJournalPutRequest) -> Result { + 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_JOURNAL_PUT, Some(wire_params)) + .call(rpc_methods::SESSION_FACTORY_GETRUNDETAIL, 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. + /// Pages durable progress for one factory run. /// - /// Wire method: `session.fleet.start`. + /// Wire method: `session.factory.getRunProgress`. /// /// # Parameters /// - /// * `params` - Optional user prompt to combine with the fleet orchestration instructions. + /// * `params` - Parameters for paging factory progress. /// /// # Returns /// - /// Indicates whether fleet mode was successfully activated. + /// A bidirectional page of factory progress. /// ///
/// @@ -4194,32 +4919,34 @@ 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 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_FLEET_START, Some(wire_params)) + .call( + rpc_methods::SESSION_FACTORY_GETRUNPROGRESS, + 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. + /// Requests cancellation of a factory run and returns its run envelope. /// - /// Wire method: `session.gitHubAuth.getStatus`. + /// Wire method: `session.factory.cancel`. + /// + /// # Parameters + /// + /// * `params` - Parameters for cancelling a factory run. /// /// # Returns /// - /// Authentication status and account metadata for the session. + /// Complete current or terminal factory run envelope. /// ///
/// @@ -4228,27 +4955,28 @@ impl<'a> SessionRpcGitHubAuth<'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 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_GITHUBAUTH_GETSTATUS, Some(wire_params)) + .call(rpc_methods::SESSION_FACTORY_CANCEL, Some(wire_params)) .await?; Ok(serde_json::from_value(_value)?) } - /// Updates the session's auth credentials used for outbound model and API requests. + /// Records a batch of ordered factory progress lines. /// - /// Wire method: `session.gitHubAuth.setCredentials`. + /// Wire method: `session.factory.log`. /// /// # Parameters /// - /// * `params` - New auth credentials to install on the session. Omit to leave credentials unchanged. + /// * `params` - Parameters for recording factory progress. /// /// # Returns /// - /// Indicates whether the credential update succeeded. + /// Acknowledgement that a factory request was accepted. /// ///
/// @@ -4257,38 +4985,28 @@ impl<'a> SessionRpcGitHubAuth<'a> { /// SDK and CLI versions if your code depends on it. /// ///
- pub async fn set_credentials( - &self, - params: SessionSetCredentialsParams, - ) -> Result { + 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_GITHUBAUTH_SETCREDENTIALS, - Some(wire_params), - ) + .call(rpc_methods::SESSION_FACTORY_LOG, 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. + /// Runs one factory-scoped subagent and returns its result. /// - /// Wire method: `session.history.compact`. + /// Wire method: `session.factory.agent`. /// - /// # Returns + /// # Parameters /// - /// Compaction outcome with the number of tokens and messages removed, summary text, and the resulting context window breakdown. + /// * `params` - Parameters for one factory-scoped subagent call. + /// + /// # Returns + /// + /// Result of one factory-scoped subagent call. /// ///
/// @@ -4297,27 +5015,36 @@ impl<'a> SessionRpcHistory<'a> { /// 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() }); + 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_HISTORY_COMPACT, Some(wire_params)) + .call(rpc_methods::SESSION_FACTORY_AGENT, Some(wire_params)) .await?; Ok(serde_json::from_value(_value)?) } +} - /// Compacts the session history to reduce context usage. +/// `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.history.compact`. + /// Wire method: `session.factory.journal.get`. /// /// # Parameters /// - /// * `params` - Optional compaction parameters. + /// * `params` - Parameters for reading a factory journal entry. /// /// # Returns /// - /// Compaction outcome with the number of tokens and messages removed, summary text, and the resulting context window breakdown. + /// Result of reading a factory journal entry. /// ///
/// @@ -4326,31 +5053,31 @@ impl<'a> SessionRpcHistory<'a> { /// SDK and CLI versions if your code depends on it. /// ///
- pub async fn compact_with_params( + pub async fn get( &self, - params: HistoryCompactRequest, - ) -> Result { + 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_HISTORY_COMPACT, Some(wire_params)) + .call(rpc_methods::SESSION_FACTORY_JOURNAL_GET, Some(wire_params)) .await?; Ok(serde_json::from_value(_value)?) } - /// Truncates persisted session history to a specific event. + /// Stores a memoized factory journal entry. /// - /// Wire method: `session.history.truncate`. + /// Wire method: `session.factory.journal.put`. /// /// # Parameters /// - /// * `params` - Identifier of the event to truncate to; this event and all later events are removed. + /// * `params` - Parameters for storing a factory journal entry. /// /// # Returns /// - /// Number of events that were removed by the truncation. + /// Acknowledgement that a factory request was accepted. /// ///
/// @@ -4359,27 +5086,36 @@ impl<'a> SessionRpcHistory<'a> { /// SDK and CLI versions if your code depends on it. /// ///
- pub async fn truncate( - &self, - params: HistoryTruncateRequest, - ) -> Result { + 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_HISTORY_TRUNCATE, Some(wire_params)) + .call(rpc_methods::SESSION_FACTORY_JOURNAL_PUT, Some(wire_params)) .await?; Ok(serde_json::from_value(_value)?) } +} - /// Cancels any in-progress background compaction on a local session. +/// `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.history.cancelBackgroundCompaction`. + /// Wire method: `session.fleet.start`. + /// + /// # Parameters + /// + /// * `params` - Optional user prompt to combine with the fleet orchestration instructions. /// /// # Returns /// - /// Indicates whether an in-progress background compaction was cancelled. + /// Indicates whether fleet mode was successfully activated. /// ///
/// @@ -4388,28 +5124,32 @@ impl<'a> SessionRpcHistory<'a> { /// 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() }); + 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_HISTORY_CANCELBACKGROUNDCOMPACTION, - Some(wire_params), - ) + .call(rpc_methods::SESSION_FLEET_START, Some(wire_params)) .await?; Ok(serde_json::from_value(_value)?) } +} - /// Aborts any in-progress manual compaction on a local session. +/// `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.history.abortManualCompaction`. + /// Wire method: `session.gitHubAuth.getStatus`. /// /// # Returns /// - /// Indicates whether an in-progress manual compaction was aborted. + /// Authentication status and account metadata for the session. /// ///
/// @@ -4418,28 +5158,27 @@ impl<'a> SessionRpcHistory<'a> { /// SDK and CLI versions if your code depends on it. /// ///
- pub async fn abort_manual_compaction( - &self, - ) -> Result { + 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_HISTORY_ABORTMANUALCOMPACTION, - Some(wire_params), - ) + .call(rpc_methods::SESSION_GITHUBAUTH_GETSTATUS, Some(wire_params)) .await?; Ok(serde_json::from_value(_value)?) } - /// Produces a markdown summary of the session's conversation context for hand-off scenarios. + /// Updates the session's auth credentials used for outbound model and API requests. /// - /// Wire method: `session.history.summarizeForHandoff`. + /// Wire method: `session.gitHubAuth.setCredentials`. + /// + /// # Parameters + /// + /// * `params` - New auth credentials to install on the session. Omit to leave credentials unchanged. /// /// # Returns /// - /// Markdown summary of the conversation context (empty when not available). + /// Indicates whether the credential update succeeded. /// ///
/// @@ -4448,34 +5187,30 @@ 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 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_HISTORY_SUMMARIZEFORHANDOFF, + rpc_methods::SESSION_GITHUBAUTH_SETCREDENTIALS, 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. + /// Gets the current authentication information for internal session hosts. /// - /// Wire method: `session.instructions.getSources`. + /// Wire method: `session.gitHubAuth.getCurrentAuthInfo`. /// /// # Returns /// - /// Instruction sources loaded for the session, in merge order. + /// Current authentication information, or null when no authentication is active. /// ///
/// @@ -4484,34 +5219,26 @@ impl<'a> SessionRpcInstructions<'a> { /// SDK and CLI versions if your code depends on it. /// ///
- pub async fn get_sources(&self) -> Result { + pub(crate) async fn get_current_auth_info(&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_GITHUBAUTH_GETCURRENTAUTHINFO, 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. + /// Gets all authentication accounts available to the internal session host. /// - /// Wire method: `session.lsp.initialize`. + /// Wire method: `session.gitHubAuth.getAllAuthAvailable`. /// - /// # Parameters + /// # Returns /// - /// * `params` - Parameters for (re)loading the merged LSP configuration set. + /// Authentication accounts available to the internal session host. /// ///
/// @@ -4520,60 +5247,28 @@ impl<'a> SessionRpcLsp<'a> { /// 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()); + pub(crate) async fn get_all_auth_available( + &self, + ) -> Result { + let wire_params = serde_json::json!({ "sessionId": self.session.id() }); let _value = self .session .client() - .call(rpc_methods::SESSION_LSP_INITIALIZE, Some(wire_params)) + .call( + rpc_methods::SESSION_GITHUBAUTH_GETALLAUTHAVAILABLE, + 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.headers.*` sub-namespace. - pub fn headers(&self) -> SessionRpcMcpHeaders<'a> { - SessionRpcMcpHeaders { - session: self.session, - } - } - - /// `session.mcp.oauth.*` sub-namespace. - pub fn oauth(&self) -> SessionRpcMcpOauth<'a> { - SessionRpcMcpOauth { - session: self.session, - } - } - - /// `session.mcp.resources.*` sub-namespace. - pub fn resources(&self) -> SessionRpcMcpResources<'a> { - SessionRpcMcpResources { - session: self.session, - } + Ok(serde_json::from_value(_value)?) } - /// 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. + /// Refreshes Copilot account metadata for the current authentication. /// - /// Wire method: `session.mcp.list`. + /// Wire method: `session.gitHubAuth.refreshCopilotUser`. /// /// # Returns /// - /// MCP servers configured for the session, with their connection status and host-level state. + /// Current authentication information, or null when no authentication is active. /// ///
/// @@ -4582,27 +5277,30 @@ impl<'a> SessionRpcMcp<'a> { /// SDK and CLI versions if your code depends on it. /// ///
- pub async fn list(&self) -> Result { + pub(crate) async fn refresh_copilot_user(&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)) + .call( + rpc_methods::SESSION_GITHUBAUTH_REFRESHCOPILOTUSER, + 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. + /// Logs in a GitHub user through the internal session host. /// - /// Wire method: `session.mcp.listTools`. + /// Wire method: `session.gitHubAuth.login`. /// /// # Parameters /// - /// * `params` - Server name whose tool list should be returned. + /// * `params` - Internal GitHub login parameters. /// /// # Returns /// - /// Tools exposed by the connected MCP server. Throws when the server is not connected. + /// Authentication credentials accepted only at native protocol ingress. Runtime outputs use credential-free `AuthIdentity` metadata. /// ///
/// @@ -4611,27 +5309,24 @@ impl<'a> SessionRpcMcp<'a> { /// SDK and CLI versions if your code depends on it. /// ///
- pub async fn list_tools( - &self, - params: McpListToolsRequest, - ) -> Result { + pub(crate) async fn login(&self, params: SessionAuthLoginRequest) -> 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)) + .call(rpc_methods::SESSION_GITHUBAUTH_LOGIN, Some(wire_params)) .await?; Ok(serde_json::from_value(_value)?) } - /// Enables an MCP server for the session. + /// Switches the session to another available authentication. /// - /// Wire method: `session.mcp.enable`. + /// Wire method: `session.gitHubAuth.switchToAuth`. /// /// # Parameters /// - /// * `params` - Name of the MCP server to enable for the session. + /// * `params` - Parameters for switching the session's active authentication. /// ///
/// @@ -4640,24 +5335,30 @@ impl<'a> SessionRpcMcp<'a> { /// SDK and CLI versions if your code depends on it. /// ///
- pub async fn enable(&self, params: McpEnableRequest) -> Result<(), Error> { + pub(crate) async fn switch_to_auth( + &self, + params: SessionAuthSwitchRequest, + ) -> 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)) + .call( + rpc_methods::SESSION_GITHUBAUTH_SWITCHTOAUTH, + Some(wire_params), + ) .await?; Ok(()) } - /// Disables an MCP server for the session. + /// Logs out the session's current GitHub authentication. /// - /// Wire method: `session.mcp.disable`. + /// Wire method: `session.gitHubAuth.logout`. /// - /// # Parameters + /// # Returns /// - /// * `params` - Name of the MCP server to disable for the session. + /// Whether the current authentication was logged out. /// ///
/// @@ -4666,20 +5367,27 @@ impl<'a> SessionRpcMcp<'a> { /// 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()); + pub(crate) async fn logout(&self) -> Result { + let wire_params = serde_json::json!({ "sessionId": self.session.id() }); let _value = self .session .client() - .call(rpc_methods::SESSION_MCP_DISABLE, Some(wire_params)) + .call(rpc_methods::SESSION_GITHUBAUTH_LOGOUT, Some(wire_params)) .await?; - Ok(()) + Ok(serde_json::from_value(_value)?) } - /// Reloads MCP server connections for the session. + /// Logs out a specific GitHub authentication. /// - /// Wire method: `session.mcp.reload`. + /// Wire method: `session.gitHubAuth.logoutUser`. + /// + /// # Parameters + /// + /// * `params` - Parameters identifying a GitHub authentication to log out. + /// + /// # Returns + /// + /// Whether the requested authentication was logged out. /// ///
/// @@ -4688,27 +5396,30 @@ 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(crate) async fn logout_user( + &self, + params: SessionAuthLogoutUserRequest, + ) -> 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_GITHUBAUTH_LOGOUTUSER, + Some(wire_params), + ) .await?; - Ok(()) + Ok(serde_json::from_value(_value)?) } - /// Reloads MCP server connections for the session with an explicit host-provided configuration. - /// - /// Wire method: `session.mcp.reloadWithConfig`. + /// Gets validation errors from the most recent authentication attempt. /// - /// # Parameters - /// - /// * `params` - Opaque MCP reload configuration. + /// Wire method: `session.gitHubAuth.lastAuthErrors`. /// /// # Returns /// - /// MCP server startup filtering result. + /// Validation errors from the most recent authentication attempt. /// ///
/// @@ -4717,31 +5428,34 @@ impl<'a> SessionRpcMcp<'a> { /// 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()); + pub(crate) async fn last_auth_errors(&self) -> Result { + let wire_params = serde_json::json!({ "sessionId": self.session.id() }); let _value = self .session .client() - .call(rpc_methods::SESSION_MCP_RELOADWITHCONFIG, Some(wire_params)) + .call( + rpc_methods::SESSION_GITHUBAUTH_LASTAUTHERRORS, + 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 +/// `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. /// - /// * `params` - Identifiers and raw MCP CreateMessageRequest params used to run a sampling inference. + /// Wire method: `session.history.compact`. /// /// # Returns /// - /// Outcome of an MCP sampling execution: success result, failure error, or cancellation. + /// Compaction outcome with the number of tokens and messages removed, summary text, and the resulting context window breakdown. /// ///
/// @@ -4750,31 +5464,27 @@ 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 compact(&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_HISTORY_COMPACT, Some(wire_params)) .await?; Ok(serde_json::from_value(_value)?) } - /// Cancels an in-flight MCP sampling execution by request ID. + /// Compacts the session history to reduce context usage. /// - /// Wire method: `session.mcp.cancelSamplingExecution`. + /// Wire method: `session.history.compact`. /// /// # Parameters /// - /// * `params` - The requestId previously passed to executeSampling that should be cancelled. + /// * `params` - Optional compaction parameters. /// /// # Returns /// - /// Indicates whether an in-flight sampling execution with the given requestId was found and cancelled. + /// Compaction outcome with the number of tokens and messages removed, summary text, and the resulting context window breakdown. /// ///
/// @@ -4783,34 +5493,31 @@ impl<'a> SessionRpcMcp<'a> { /// SDK and CLI versions if your code depends on it. /// ///
- pub async fn cancel_sampling_execution( + pub async fn compact_with_params( &self, - params: McpCancelSamplingExecutionParams, - ) -> Result { + 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_MCP_CANCELSAMPLINGEXECUTION, - Some(wire_params), - ) + .call(rpc_methods::SESSION_HISTORY_COMPACT, Some(wire_params)) .await?; Ok(serde_json::from_value(_value)?) } - /// Sets how environment-variable values supplied to MCP servers are resolved (direct or indirect). + /// Truncates persisted session history to a specific event. /// - /// Wire method: `session.mcp.setEnvValueMode`. + /// Wire method: `session.history.truncate`. /// /// # Parameters /// - /// * `params` - Mode controlling how MCP server env values are resolved (`direct` or `indirect`). + /// * `params` - Identifier of the event to truncate to; this event and all later events are removed. /// /// # Returns /// - /// Env-value mode recorded on the session after the update. + /// Number of events that were removed by the truncation. /// ///
/// @@ -4819,27 +5526,27 @@ impl<'a> SessionRpcMcp<'a> { /// SDK and CLI versions if your code depends on it. /// ///
- pub async fn set_env_value_mode( + pub async fn truncate( &self, - params: McpSetEnvValueModeParams, - ) -> Result { + 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_MCP_SETENVVALUEMODE, Some(wire_params)) + .call(rpc_methods::SESSION_HISTORY_TRUNCATE, Some(wire_params)) .await?; Ok(serde_json::from_value(_value)?) } - /// Removes the auto-managed `github` MCP server when present. + /// 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.mcp.removeGitHub`. + /// Wire method: `session.history.listRewindPoints`. /// /// # Returns /// - /// Indicates whether the auto-managed `github` MCP server was removed (false when nothing to remove). + /// Rewind points and file-change-tracking availability for the session. /// ///
/// @@ -4848,27 +5555,30 @@ 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 list_rewind_points(&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_HISTORY_LISTREWINDPOINTS, + Some(wire_params), + ) .await?; Ok(serde_json::from_value(_value)?) } - /// Configures the built-in GitHub MCP server for the session's current auth context. + /// Previews the files that a conversation-and-files rewind would restore. /// - /// Wire method: `session.mcp.configureGitHub`. + /// Wire method: `session.history.previewRewind`. /// /// # Parameters /// - /// * `params` - Opaque auth info used to configure GitHub MCP. + /// * `params` - Event boundary to preview for conversation-and-files rewind. /// /// # Returns /// - /// Result of configuring GitHub MCP. + /// Files and aggregate changes for a prospective rewind. /// ///
/// @@ -4877,53 +5587,34 @@ impl<'a> SessionRpcMcp<'a> { /// SDK and CLI versions if your code depends on it. /// ///
- pub(crate) async fn configure_git_hub( + pub async fn preview_rewind( &self, - params: McpConfigureGitHubRequest, - ) -> Result { + 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_MCP_CONFIGUREGITHUB, Some(wire_params)) + .call( + rpc_methods::SESSION_HISTORY_PREVIEWREWIND, + Some(wire_params), + ) .await?; Ok(serde_json::from_value(_value)?) } - /// Starts an individual MCP server on the live session from a caller-supplied config. 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. + /// 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.mcp.startServer`. + /// Wire method: `session.history.rewind`. /// /// # Parameters /// - /// * `params` - Server name and configuration for an individual MCP server start. - /// - ///
- /// - /// **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(()) - } - - /// 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`. + /// * `params` - Boundary and mode for rewinding session history. /// - /// # Parameters + /// # Returns /// - /// * `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. + /// Structured outcome of a rewind request. /// ///
/// @@ -4932,24 +5623,24 @@ impl<'a> SessionRpcMcp<'a> { /// SDK and CLI versions if your code depends on it. /// ///
- pub async fn restart_server(&self, params: McpRestartServerRequest) -> Result<(), Error> { + 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_MCP_RESTARTSERVER, Some(wire_params)) + .call(rpc_methods::SESSION_HISTORY_REWIND, Some(wire_params)) .await?; - Ok(()) + Ok(serde_json::from_value(_value)?) } - /// Stops an individual MCP server on the session's host. + /// Cancels any in-progress background compaction on a local session. /// - /// Wire method: `session.mcp.stopServer`. + /// Wire method: `session.history.cancelBackgroundCompaction`. /// - /// # Parameters + /// # Returns /// - /// * `params` - Server name for an individual MCP server stop. + /// Indicates whether an in-progress background compaction was cancelled. /// ///
/// @@ -4958,24 +5649,28 @@ impl<'a> SessionRpcMcp<'a> { /// 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()); + 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_MCP_STOPSERVER, Some(wire_params)) + .call( + rpc_methods::SESSION_HISTORY_CANCELBACKGROUNDCOMPACTION, + Some(wire_params), + ) .await?; - Ok(()) + Ok(serde_json::from_value(_value)?) } - /// 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. + /// Aborts any in-progress manual compaction on a local session. /// - /// Wire method: `session.mcp.registerExternalClient`. + /// Wire method: `session.history.abortManualCompaction`. /// - /// # Parameters + /// # Returns /// - /// * `params` - Registration parameters for an external MCP client. + /// Indicates whether an in-progress manual compaction was aborted. /// ///
/// @@ -4984,30 +5679,28 @@ impl<'a> SessionRpcMcp<'a> { /// SDK and CLI versions if your code depends on it. /// ///
- pub(crate) async fn register_external_client( + pub async fn abort_manual_compaction( &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()); + ) -> Result { + let wire_params = serde_json::json!({ "sessionId": self.session.id() }); let _value = self .session .client() .call( - rpc_methods::SESSION_MCP_REGISTEREXTERNALCLIENT, + rpc_methods::SESSION_HISTORY_ABORTMANUALCOMPACTION, Some(wire_params), ) .await?; - Ok(()) + Ok(serde_json::from_value(_value)?) } - /// 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. + /// Produces a markdown summary of the session's conversation context for hand-off scenarios. /// - /// Wire method: `session.mcp.unregisterExternalClient`. + /// Wire method: `session.history.summarizeForHandoff`. /// - /// # Parameters + /// # Returns /// - /// * `params` - Server name identifying the external client to remove. + /// Markdown summary of the conversation context (empty when not available). /// ///
/// @@ -5016,34 +5709,30 @@ impl<'a> SessionRpcMcp<'a> { /// 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()); + 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_MCP_UNREGISTEREXTERNALCLIENT, + rpc_methods::SESSION_HISTORY_SUMMARIZEFORHANDOFF, Some(wire_params), ) .await?; - Ok(()) + Ok(serde_json::from_value(_value)?) } - /// Checks whether a named MCP server is currently running on the session's host. + /// 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.mcp.isServerRunning`. + /// Wire method: `session.history.clearContext`. /// /// # Parameters /// - /// * `params` - Server name to check running status for. + /// * `params` - Parameters for clearing the conversation and seeding the window that replaces it. /// /// # Returns /// - /// Whether the named MCP server is running. + /// What a successful clear removed. A clear that could not be applied rejects instead of reporting a count. /// ///
/// @@ -5052,39 +5741,35 @@ impl<'a> SessionRpcMcp<'a> { /// SDK and CLI versions if your code depends on it. /// ///
- pub async fn is_server_running( + pub async fn clear_context( &self, - params: McpIsServerRunningRequest, - ) -> Result { + 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_MCP_ISSERVERRUNNING, Some(wire_params)) + .call(rpc_methods::SESSION_HISTORY_CLEARCONTEXT, Some(wire_params)) .await?; Ok(serde_json::from_value(_value)?) } } -/// `session.mcp.apps.*` RPCs. +/// `session.instructions.*` RPCs. #[derive(Clone, Copy)] -pub struct SessionRpcMcpApps<'a> { +pub struct SessionRpcInstructions<'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 +impl<'a> SessionRpcInstructions<'a> { + /// Gets instruction sources loaded for the session. /// - /// * `params` - MCP server and resource URI to fetch. + /// Wire method: `session.instructions.getSources`. /// /// # Returns /// - /// Resource contents returned by the MCP server. + /// Instruction sources loaded for the session, in merge order. /// ///
/// @@ -5093,34 +5778,34 @@ impl<'a> SessionRpcMcpApps<'a> { /// 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()); + 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_MCP_APPS_READRESOURCE, + rpc_methods::SESSION_INSTRUCTIONS_GETSOURCES, 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.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. /// - /// * `params` - MCP server to list app-callable tools for. + /// Wire method: `session.limitPrediction.predict`. /// /// # Returns /// - /// App-callable tools from the named MCP server. + /// Prediction result. Available results include prediction details; unavailable results include an explicit reason. /// ///
/// @@ -5129,31 +5814,30 @@ 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 predict(&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_LIMITPREDICTION_PREDICT, + 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`. + /// 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.mcp.apps.callTool`. + /// Wire method: `session.limitPrediction.predict`. /// /// # Parameters /// - /// * `params` - MCP server, tool name, and arguments to invoke from an MCP App view. + /// * `params` - Parameters for predicting an AI-credit session limit. Omitting `modelId` uses the session's currently selected model. /// /// # Returns /// - /// Standard MCP CallToolResult + /// Prediction result. Available results include prediction details; unavailable results include an explicit reason. /// ///
/// @@ -5162,10 +5846,722 @@ impl<'a> SessionRpcMcpApps<'a> { /// SDK and CLI versions if your code depends on it. /// ///
- pub async fn call_tool( + pub async fn predict_with_params( &self, - params: McpAppsCallToolRequest, - ) -> Result { + 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.mcp.headers.*` sub-namespace. + pub fn headers(&self) -> SessionRpcMcpHeaders<'a> { + SessionRpcMcpHeaders { + session: self.session, + } + } + + /// `session.mcp.oauth.*` sub-namespace. + pub fn oauth(&self) -> SessionRpcMcpOauth<'a> { + SessionRpcMcpOauth { + session: self.session, + } + } + + /// `session.mcp.resources.*` sub-namespace. + pub fn resources(&self) -> SessionRpcMcpResources<'a> { + SessionRpcMcpResources { + 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(()) + } + + /// Releases any turns waiting on an in-flight MCP load without cancelling the load, letting the agent proceed while MCP servers finish connecting in the background. No-op when no MCP load is in flight or waiting turns were already released. + /// + /// Wire method: `session.mcp.moveLoadingToBackground`. + /// + /// # Returns + /// + /// Result of moving in-flight MCP loading to the background. + /// + ///
+ /// + /// **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 move_loading_to_background( + &self, + ) -> Result { + let wire_params = serde_json::json!({ "sessionId": self.session.id() }); + let _value = self + .session + .client() + .call( + rpc_methods::SESSION_MCP_MOVELOADINGTOBACKGROUND, + Some(wire_params), + ) + .await?; + Ok(serde_json::from_value(_value)?) + } + + /// 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)?) + } + + /// Configures the built-in GitHub MCP server for the session's current auth context. + /// + /// Wire method: `session.mcp.configureGitHub`. + /// + /// # Parameters + /// + /// * `params` - Credential-free authentication identity 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)?) + } + + /// 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(()) + } + + /// 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(()) + } + + /// 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(()) + } + + /// 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(()) + } + + /// 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(()) + } + + /// 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.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 + /// + /// * `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)?) + } + + /// 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)?) + } + + /// 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 @@ -5176,13 +6572,820 @@ impl<'a> SessionRpcMcpApps<'a> { Ok(serde_json::from_value(_value)?) } - /// 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. + /// 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(()) + } + + /// 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)?) + } + + /// 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.mcp.headers.*` RPCs. +#[derive(Clone, Copy)] +pub struct SessionRpcMcpHeaders<'a> { + pub(crate) session: &'a 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.mcp.oauth.*` RPCs. +#[derive(Clone, Copy)] +pub struct SessionRpcMcpOauth<'a> { + pub(crate) session: &'a 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)?) + } + + /// 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(()) + } + + /// Starts OAuth authentication for a remote MCP server. + /// + /// 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. + /// + ///
+ /// + /// **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: 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_MCP_OAUTH_LOGIN, Some(wire_params)) + .await?; + Ok(serde_json::from_value(_value)?) + } + + /// Passively probes a configured remote MCP server to classify whether OAuth is required or a cached/override token is accepted. Does not start OAuth, emit pending OAuth requests, or mutate MCP connection state. + /// + /// Wire method: `session.mcp.oauth.probe`. + /// + /// # Parameters + /// + /// * `params` - Remote MCP server name for a passive OAuth status probe. + /// + /// # Returns + /// + /// Passive MCP OAuth probe result. `authenticated` means the server accepted the probe request while an OAuth-origin access token was attached; it does not prove the server required or independently validated that token. The probe does not make a second unauthenticated request. Failed is an expected probe-domain outcome; JSON-RPC errors are reserved for API-call failures. + /// + ///
+ /// + /// **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 probe(&self, params: McpOauthProbeRequest) -> 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_PROBE, Some(wire_params)) + .await?; + Ok(serde_json::from_value(_value)?) + } + + /// Responds to a pending MCP OAuth authorization request by its request id. + /// + /// Wire method: `session.mcp.oauth.respond`. + /// + /// # Parameters + /// + /// * `params` - Pending MCP OAuth request id to respond to. + /// + /// # 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 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_MCP_OAUTH_RESPOND, Some(wire_params)) + .await?; + Ok(serde_json::from_value(_value)?) + } +} + +/// `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.mcp.resources.read`. + /// + /// # 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( + &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_MCP_RESOURCES_READ, Some(wire_params)) + .await?; + Ok(serde_json::from_value(_value)?) + } + + /// 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.mcp.resources.list`. + /// + /// # Parameters + /// + /// * `params` - MCP server whose resources to enumerate. + /// + /// # Returns + /// + /// One page of resources advertised by 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( + &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_MCP_RESOURCES_LIST, Some(wire_params)) + .await?; + Ok(serde_json::from_value(_value)?) + } + + /// 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.mcp.resources.listTemplates`. + /// + /// # Parameters + /// + /// * `params` - MCP server whose resource templates to enumerate. + /// + /// # Returns + /// + /// One page of resource templates advertised by 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_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_MCP_RESOURCES_LISTTEMPLATES, + Some(wire_params), + ) + .await?; + Ok(serde_json::from_value(_value)?) + } +} + +/// `session.metadata.*` RPCs. +#[derive(Clone, Copy)] +pub struct SessionRpcMetadata<'a> { + pub(crate) session: &'a Session, +} + +impl<'a> SessionRpcMetadata<'a> { + /// Returns a snapshot of the session's identifying metadata, mode, agent, and remote info. + /// + /// Wire method: `session.metadata.snapshot`. + /// + /// # Returns + /// + /// Point-in-time snapshot of slow-changing session identifier and state fields + /// + ///
+ /// + /// **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 snapshot(&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)) + .await?; + Ok(serde_json::from_value(_value)?) + } + + /// Reports whether the local session is currently processing user/agent messages. + /// + /// Wire method: `session.metadata.isProcessing`. + /// + /// # Returns + /// + /// Indicates whether the local session is currently processing a turn or background continuation. + /// + ///
+ /// + /// **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_processing(&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), + ) + .await?; + Ok(serde_json::from_value(_value)?) + } + + /// Returns a snapshot of activity flags for the session. + /// + /// 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` - Model identifier and token limits used to compute the context-info breakdown. + /// + /// # Returns + /// + /// Token breakdown for the session's current context window, or null if uninitialized. + /// + ///
+ /// + /// **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 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_METADATA_CONTEXTINFO, Some(wire_params)) + .await?; + Ok(serde_json::from_value(_value)?) + } + + /// 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.metadata.getContextAttribution`. + /// + /// # Returns + /// + /// Per-source attribution breakdown for the session's current context window, or null if uninitialized. + /// + ///
+ /// + /// **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_context_attribution(&self) -> Result { + let wire_params = serde_json::json!({ "sessionId": self.session.id() }); + let _value = self + .session + .client() + .call( + rpc_methods::SESSION_METADATA_GETCONTEXTATTRIBUTION, + Some(wire_params), + ) + .await?; + Ok(serde_json::from_value(_value)?) + } + + /// 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.metadata.getContextHeaviestMessages`. + /// + /// # Parameters + /// + /// * `params` - Parameters for the heaviest-messages query. + /// + /// # Returns + /// + /// The heaviest individual messages in the session's context window, most-expensive 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 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_METADATA_GETCONTEXTHEAVIESTMESSAGES, + Some(wire_params), + ) + .await?; + Ok(serde_json::from_value(_value)?) + } + + /// 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)?) + } + + /// 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 + /// + /// * `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 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 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_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_METADATA_SETWORKINGDIRECTORY, + 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. + /// + /// Wire method: `session.metadata.recomputeContextTokens`. + /// + /// # Parameters + /// + /// * `params` - Model identifier to use when re-tokenizing the session's existing messages. + /// + /// # 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. + /// + ///
+ /// + /// **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 recompute_context_tokens( + &self, + 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_METADATA_RECOMPUTECONTEXTTOKENS, + 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. + /// + /// Wire method: `session.mode.get`. + /// + /// # Returns + /// + /// The session mode the agent is operating in + /// + ///
+ /// + /// **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!({ "sessionId": self.session.id() }); + let _value = self + .session + .client() + .call(rpc_methods::SESSION_MODE_GET, Some(wire_params)) + .await?; + Ok(serde_json::from_value(_value)?) + } + + /// Sets the current agent interaction mode. + /// + /// Wire method: `session.mode.set`. + /// + /// # Parameters + /// + /// * `params` - Agent interaction mode to apply to the session. + /// + /// # Returns + /// + /// Outcome of a session mode change, including any model switch it triggered and follow-up the host must perform. + /// + ///
+ /// + /// **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: ModeSetRequest) -> 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_SET, Some(wire_params)) + .await?; + Ok(serde_json::from_value(_value)?) + } +} + +/// `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. /// - /// Wire method: `session.mcp.apps.setHostContext`. + /// Wire method: `session.model.getCurrent`. + /// + /// # 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. + /// + ///
+ /// + /// **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_MODEL_GETCURRENT, 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 /// - /// * `params` - Host context to advertise to MCP App guests. + /// * `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. /// ///
/// @@ -5191,30 +7394,31 @@ impl<'a> SessionRpcMcpApps<'a> { /// SDK and CLI versions if your code depends on it. /// ///
- pub async fn set_host_context( + pub async fn switch_to( &self, - params: McpAppsSetHostContextRequest, - ) -> Result<(), Error> { + 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_MCP_APPS_SETHOSTCONTEXT, - Some(wire_params), - ) + .call(rpc_methods::SESSION_MODEL_SWITCHTO, Some(wire_params)) .await?; - Ok(()) + Ok(serde_json::from_value(_value)?) } - /// Read the current host context advertised to MCP App guests. + /// Resolves and applies organization-managed and repository model overlays. /// - /// Wire method: `session.mcp.apps.getHostContext`. + /// Wire method: `session.model.applyStartupOverlay`. + /// + /// # Parameters + /// + /// * `params` - Managed, repository, and CLI model overrides to overlay onto the session at startup. /// /// # Returns /// - /// Current host context advertised to MCP App guests. + /// The model identifier active on the session after the switch. /// ///
/// @@ -5223,30 +7427,34 @@ impl<'a> SessionRpcMcpApps<'a> { /// 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() }); + pub(crate) async fn apply_startup_overlay( + &self, + params: ModelApplyStartupOverlayRequest, + ) -> 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_GETHOSTCONTEXT, + rpc_methods::SESSION_MODEL_APPLYSTARTUPOVERLAY, 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. + /// Updates the session's reasoning effort without changing the selected model. /// - /// Wire method: `session.mcp.apps.diagnose`. + /// Wire method: `session.model.setReasoningEffort`. /// /// # Parameters /// - /// * `params` - MCP server to diagnose MCP Apps wiring for. + /// * `params` - Reasoning effort level to apply to the currently selected model. /// /// # Returns /// - /// Diagnostic snapshot of MCP Apps wiring for the named server. + /// 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. /// ///
/// @@ -5255,39 +7463,59 @@ impl<'a> SessionRpcMcpApps<'a> { /// SDK and CLI versions if your code depends on it. /// ///
- pub async fn diagnose( + pub async fn set_reasoning_effort( &self, - params: McpAppsDiagnoseRequest, - ) -> 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_MCP_APPS_DIAGNOSE, Some(wire_params)) + .call( + rpc_methods::SESSION_MODEL_SETREASONINGEFFORT, + Some(wire_params), + ) .await?; Ok(serde_json::from_value(_value)?) } -} -/// `session.mcp.headers.*` RPCs. -#[derive(Clone, Copy)] -pub struct SessionRpcMcpHeaders<'a> { - pub(crate) session: &'a 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.model.list`. + /// + /// # Returns + /// + /// The list of models available to 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_MODEL_LIST, Some(wire_params)) + .await?; + Ok(serde_json::from_value(_value)?) + } -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. + /// 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.mcp.headers.handlePendingHeadersRefreshRequest`. + /// Wire method: `session.model.list`. /// /// # Parameters /// - /// * `params` - MCP headers refresh request id and the host response. + /// * `params` - Optional listing options. /// /// # Returns /// - /// Indicates whether the pending MCP headers refresh response was accepted. + /// The list of models available to this session. /// ///
/// @@ -5296,42 +7524,60 @@ impl<'a> SessionRpcMcpHeaders<'a> { /// SDK and CLI versions if your code depends on it. /// ///
- pub async fn handle_pending_headers_refresh_request( + pub async fn list_with_params( &self, - params: McpHeadersHandlePendingHeadersRefreshRequestRequest, - ) -> 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_MCP_HEADERS_HANDLEPENDINGHEADERSREFRESHREQUEST, - Some(wire_params), - ) + .call(rpc_methods::SESSION_MODEL_LIST, Some(wire_params)) .await?; Ok(serde_json::from_value(_value)?) } } -/// `session.mcp.oauth.*` RPCs. +/// `session.name.*` RPCs. #[derive(Clone, Copy)] -pub struct SessionRpcMcpOauth<'a> { +pub struct SessionRpcName<'a> { pub(crate) session: &'a 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. +impl<'a> SessionRpcName<'a> { + /// Gets the session's friendly name. /// - /// Wire method: `session.mcp.oauth.handlePendingRequest`. + /// Wire method: `session.name.get`. /// - /// # Parameters + /// # Returns /// - /// * `params` - Pending MCP OAuth request ID and host-provided token or cancellation response. + /// The session's friendly name, or null when not yet set. /// - /// # 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 get(&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)) + .await?; + Ok(serde_json::from_value(_value)?) + } + + /// Sets the session's friendly name. + /// + /// Wire method: `session.name.set`. + /// + /// # Parameters + /// + /// * `params` - New friendly name to apply to the session. /// ///
/// @@ -5340,34 +7586,28 @@ impl<'a> SessionRpcMcpOauth<'a> { /// SDK and CLI versions if your code depends on it. /// ///
- pub async fn handle_pending_request( - &self, - params: McpOauthHandlePendingRequest, - ) -> 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_MCP_OAUTH_HANDLEPENDINGREQUEST, - Some(wire_params), - ) + .call(rpc_methods::SESSION_NAME_SET, Some(wire_params)) .await?; - Ok(serde_json::from_value(_value)?) + Ok(()) } - /// Starts OAuth authentication for a remote MCP server. + /// Persists an auto-generated session summary as the session's name when no user-set name exists. /// - /// Wire method: `session.mcp.oauth.login`. + /// Wire method: `session.name.setAuto`. /// /// # Parameters /// - /// * `params` - Remote MCP server name and optional overrides controlling reauthentication, OAuth client display name, callback success-page copy, and static OAuth client selection. + /// * `params` - Auto-generated session summary to apply as the session's name when no user-set name exists. /// /// # Returns /// - /// OAuth authorization URL the caller should open, or empty when cached tokens already authenticated the server. + /// Indicates whether the auto-generated summary was applied as the session's name. /// ///
/// @@ -5376,36 +7616,36 @@ 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 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_MCP_OAUTH_LOGIN, Some(wire_params)) + .call(rpc_methods::SESSION_NAME_SETAUTO, Some(wire_params)) .await?; Ok(serde_json::from_value(_value)?) } } -/// `session.mcp.resources.*` RPCs. +/// `session.options.*` RPCs. #[derive(Clone, Copy)] -pub struct SessionRpcMcpResources<'a> { +pub struct SessionRpcOptions<'a> { pub(crate) session: &'a Session, } -impl<'a> SessionRpcMcpResources<'a> { - /// Fetch an MCP resource from a connected server by URI (proxies MCP `resources/read`). +impl<'a> SessionRpcOptions<'a> { + /// Patches the genuinely-mutable subset of session options. /// - /// Wire method: `session.mcp.resources.read`. + /// Wire method: `session.options.update`. /// /// # Parameters /// - /// * `params` - MCP server and resource URI to fetch. + /// * `params` - Patch of mutable session options to apply to the running session. /// /// # Returns /// - /// Resource contents returned by the MCP server. + /// Indicates whether the session options patch was applied successfully. /// ///
/// @@ -5414,31 +7654,67 @@ impl<'a> SessionRpcMcpResources<'a> { /// SDK and CLI versions if your code depends on it. /// ///
- pub async fn read( + pub async fn update( &self, - params: McpResourcesReadRequest, - ) -> 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_MCP_RESOURCES_READ, 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, + } + } + + /// `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, + } + } - /// Enumerate one page of resources a connected MCP server exposes (proxies MCP `resources/list`). Pass `cursor` to continue from a prior result's `nextCursor`. + /// `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.mcp.resources.list`. + /// Wire method: `session.permissions.configure`. /// /// # Parameters /// - /// * `params` - MCP server whose resources to enumerate. + /// * `params` - Patch of permission policy fields to apply (omit a field to leave it unchanged). /// /// # Returns /// - /// One page of resources advertised by the named MCP server. + /// Indicates whether the operation succeeded. /// ///
/// @@ -5447,31 +7723,34 @@ impl<'a> SessionRpcMcpResources<'a> { /// SDK and CLI versions if your code depends on it. /// ///
- pub async fn list( + pub async fn configure( &self, - params: McpResourcesListRequest, - ) -> 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_MCP_RESOURCES_LIST, Some(wire_params)) + .call( + rpc_methods::SESSION_PERMISSIONS_CONFIGURE, + Some(wire_params), + ) .await?; Ok(serde_json::from_value(_value)?) } - /// 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`. + /// Provides a decision for a pending tool permission request. /// - /// Wire method: `session.mcp.resources.listTemplates`. + /// Wire method: `session.permissions.handlePendingPermissionRequest`. /// /// # Parameters /// - /// * `params` - MCP server whose resource templates to enumerate. + /// * `params` - Pending permission request ID and the decision to apply (approve/reject and scope). /// /// # Returns /// - /// One page of resource templates advertised by the named MCP server. + /// Indicates whether the permission decision was applied; false when the request was already resolved. /// ///
/// @@ -5480,63 +7759,30 @@ impl<'a> SessionRpcMcpResources<'a> { /// SDK and CLI versions if your code depends on it. /// ///
- pub async fn list_templates( + pub async fn handle_pending_permission_request( &self, - params: McpResourcesListTemplatesRequest, - ) -> Result { + 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_MCP_RESOURCES_LISTTEMPLATES, + rpc_methods::SESSION_PERMISSIONS_HANDLEPENDINGPERMISSIONREQUEST, Some(wire_params), ) .await?; Ok(serde_json::from_value(_value)?) } -} - -/// `session.metadata.*` RPCs. -#[derive(Clone, Copy)] -pub struct SessionRpcMetadata<'a> { - pub(crate) session: &'a Session, -} - -impl<'a> SessionRpcMetadata<'a> { - /// Returns a snapshot of the session's identifying metadata, mode, agent, and remote info. - /// - /// Wire method: `session.metadata.snapshot`. - /// - /// # Returns - /// - /// Point-in-time snapshot of slow-changing session identifier and state fields - /// - ///
- /// - /// **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 snapshot(&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)) - .await?; - Ok(serde_json::from_value(_value)?) - } - /// Reports whether the local session is currently processing user/agent messages. + /// Reconstructs the set of pending tool permission requests from the session's event history. /// - /// Wire method: `session.metadata.isProcessing`. + /// Wire method: `session.permissions.pendingRequests`. /// /// # Returns /// - /// Indicates whether the local session is currently processing a turn or background continuation. + /// List of pending permission requests reconstructed from event history. /// ///
/// @@ -5545,26 +7791,30 @@ impl<'a> SessionRpcMetadata<'a> { /// SDK and CLI versions if your code depends on it. /// ///
- pub async fn is_processing(&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_METADATA_ISPROCESSING, + rpc_methods::SESSION_PERMISSIONS_PENDINGREQUESTS, Some(wire_params), ) .await?; Ok(serde_json::from_value(_value)?) } - /// Returns a snapshot of activity flags for the session. + /// Enables or disables automatic approval of tool permission requests for the session. /// - /// Wire method: `session.metadata.activity`. + /// Wire method: `session.permissions.setApproveAll`. + /// + /// # Parameters + /// + /// * `params` - Allow-all toggle for tool permission requests, with an optional telemetry source. /// /// # Returns /// - /// Current activity flags for the session. + /// Indicates whether the operation succeeded. /// ///
/// @@ -5573,27 +7823,34 @@ impl<'a> SessionRpcMetadata<'a> { /// 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() }); + pub async fn set_approve_all( + &self, + 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_METADATA_ACTIVITY, Some(wire_params)) + .call( + rpc_methods::SESSION_PERMISSIONS_SETAPPROVEALL, + 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. + /// Sets the permission mode for the session. `manual` follows the normal approval flow, `assisted` attaches LLM safety recommendations, and `allow-all` automatically approves permission requests. The result returns the authoritative post-mutation mode so callers can update local state without racing the `session.permissions_changed` notification. /// - /// Wire method: `session.metadata.contextInfo`. + /// Wire method: `session.permissions.setMode`. /// /// # Parameters /// - /// * `params` - Model identifier and token limits used to compute the context-info breakdown. + /// * `params` - Permission mode to apply for the session. /// /// # Returns /// - /// Token breakdown for the session's current context window, or null if uninitialized. + /// Indicates whether the requested permission mode was applied and reports the authoritative post-mutation mode. /// ///
/// @@ -5602,27 +7859,27 @@ impl<'a> SessionRpcMetadata<'a> { /// SDK and CLI versions if your code depends on it. /// ///
- pub async fn context_info( + pub async fn set_mode( &self, - params: MetadataContextInfoRequest, - ) -> Result { + params: PermissionsSetModeRequest, + ) -> 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_PERMISSIONS_SETMODE, Some(wire_params)) .await?; Ok(serde_json::from_value(_value)?) } - /// 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 the current permission mode for the session. /// - /// Wire method: `session.metadata.getContextAttribution`. + /// Wire method: `session.permissions.getMode`. /// /// # Returns /// - /// Per-source attribution breakdown for the session's current context window, or null if uninitialized. + /// Current permission mode. /// ///
/// @@ -5631,30 +7888,27 @@ impl<'a> SessionRpcMetadata<'a> { /// SDK and CLI versions if your code depends on it. /// ///
- pub async fn get_context_attribution(&self) -> Result { + pub async fn get_mode(&self) -> Result { let wire_params = serde_json::json!({ "sessionId": self.session.id() }); let _value = self .session .client() - .call( - rpc_methods::SESSION_METADATA_GETCONTEXTATTRIBUTION, - Some(wire_params), - ) + .call(rpc_methods::SESSION_PERMISSIONS_GETMODE, Some(wire_params)) .await?; Ok(serde_json::from_value(_value)?) } - /// 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. + /// Adds or removes session-scoped or location-scoped permission rules. /// - /// Wire method: `session.metadata.getContextHeaviestMessages`. + /// Wire method: `session.permissions.modifyRules`. /// /// # Parameters /// - /// * `params` - Parameters for the heaviest-messages query. + /// * `params` - Scope and add/remove instructions for modifying session- or location-scoped permission rules. /// /// # Returns /// - /// The heaviest individual messages in the session's context window, most-expensive first. + /// Indicates whether the operation succeeded. /// ///
/// @@ -5663,34 +7917,34 @@ impl<'a> SessionRpcMetadata<'a> { /// SDK and CLI versions if your code depends on it. /// ///
- pub async fn get_context_heaviest_messages( + pub async fn modify_rules( &self, - params: MetadataContextHeaviestMessagesRequest, - ) -> Result { + 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_METADATA_GETCONTEXTHEAVIESTMESSAGES, + rpc_methods::SESSION_PERMISSIONS_MODIFYRULES, Some(wire_params), ) .await?; Ok(serde_json::from_value(_value)?) } - /// 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. + /// Sets whether the client wants permission prompts bridged into session events. /// - /// Wire method: `session.metadata.recordContextChange`. + /// Wire method: `session.permissions.setRequired`. /// /// # Parameters /// - /// * `params` - Updated working-directory/git context to record on the session. + /// * `params` - Toggles whether permission prompts should be bridged into session events for this client. /// /// # 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. + /// Indicates whether the operation succeeded. /// ///
/// @@ -5699,34 +7953,34 @@ impl<'a> SessionRpcMetadata<'a> { /// SDK and CLI versions if your code depends on it. /// ///
- pub async fn record_context_change( + pub async fn set_required( &self, - params: MetadataRecordContextChangeRequest, - ) -> Result { + 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_METADATA_RECORDCONTEXTCHANGE, + rpc_methods::SESSION_PERMISSIONS_SETREQUIRED, Some(wire_params), ) .await?; Ok(serde_json::from_value(_value)?) } - /// 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. + /// Clears session-scoped tool permission approvals. /// - /// Wire method: `session.metadata.setWorkingDirectory`. + /// Wire method: `session.permissions.resetSessionApprovals`. /// /// # Parameters /// - /// * `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. + /// * `params` - Clears session-scoped tool permission approvals, and optionally the location-scoped ones. /// /// # 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. + /// Indicates whether the operation succeeded. /// ///
/// @@ -5735,34 +7989,34 @@ impl<'a> SessionRpcMetadata<'a> { /// SDK and CLI versions if your code depends on it. /// ///
- pub async fn set_working_directory( + pub async fn reset_session_approvals( &self, - params: MetadataSetWorkingDirectoryRequest, - ) -> Result { + 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_METADATA_SETWORKINGDIRECTORY, + rpc_methods::SESSION_PERMISSIONS_RESETSESSIONAPPROVALS, 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. + /// Notifies the runtime that a permission prompt UI has been shown to the user. /// - /// Wire method: `session.metadata.recomputeContextTokens`. + /// Wire method: `session.permissions.notifyPromptShown`. /// /// # Parameters /// - /// * `params` - Model identifier to use when re-tokenizing the session's existing messages. + /// * `params` - Notification payload describing the permission prompt that the client just rendered. /// /// # 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. + /// Indicates whether the operation succeeded. /// ///
/// @@ -5771,17 +8025,17 @@ impl<'a> SessionRpcMetadata<'a> { /// SDK and CLI versions if your code depends on it. /// ///
- pub async fn recompute_context_tokens( + pub async fn notify_prompt_shown( &self, - params: MetadataRecomputeContextTokensRequest, - ) -> Result { + 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_METADATA_RECOMPUTECONTEXTTOKENS, + rpc_methods::SESSION_PERMISSIONS_NOTIFYPROMPTSHOWN, Some(wire_params), ) .await?; @@ -5789,20 +8043,24 @@ impl<'a> SessionRpcMetadata<'a> { } } -/// `session.mode.*` RPCs. +/// `session.permissions.folderTrust.*` RPCs. #[derive(Clone, Copy)] -pub struct SessionRpcMode<'a> { +pub struct SessionRpcPermissionsFolderTrust<'a> { pub(crate) session: &'a Session, } -impl<'a> SessionRpcMode<'a> { - /// Gets the current agent interaction mode. +impl<'a> SessionRpcPermissionsFolderTrust<'a> { + /// Reports whether a folder is trusted according to the user's folder trust state. /// - /// Wire method: `session.mode.get`. + /// Wire method: `session.permissions.folderTrust.isTrusted`. + /// + /// # Parameters + /// + /// * `params` - Folder path to check for trust. /// /// # Returns /// - /// The session mode the agent is operating in + /// Folder trust check result. /// ///
/// @@ -5811,23 +8069,34 @@ 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 is_trusted( + &self, + 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_MODE_GET, Some(wire_params)) + .call( + rpc_methods::SESSION_PERMISSIONS_FOLDERTRUST_ISTRUSTED, + Some(wire_params), + ) .await?; Ok(serde_json::from_value(_value)?) } - /// Sets the current agent interaction mode. + /// Adds a folder to the user's trusted folders list. /// - /// Wire method: `session.mode.set`. + /// Wire method: `session.permissions.folderTrust.addTrusted`. /// /// # Parameters /// - /// * `params` - Agent interaction mode to apply to the session. + /// * `params` - Folder path to add to trusted folders. + /// + /// # Returns + /// + /// Indicates whether the operation succeeded. /// ///
/// @@ -5836,32 +8105,42 @@ 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 add_trusted( + &self, + 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_MODE_SET, Some(wire_params)) + .call( + rpc_methods::SESSION_PERMISSIONS_FOLDERTRUST_ADDTRUSTED, + Some(wire_params), + ) .await?; - Ok(()) + Ok(serde_json::from_value(_value)?) } } -/// `session.model.*` RPCs. +/// `session.permissions.locations.*` RPCs. #[derive(Clone, Copy)] -pub struct SessionRpcModel<'a> { +pub struct SessionRpcPermissionsLocations<'a> { pub(crate) session: &'a Session, } -impl<'a> SessionRpcModel<'a> { - /// Gets the currently selected model for the session. +impl<'a> SessionRpcPermissionsLocations<'a> { + /// Resolves the permission location key and type for a working directory. /// - /// Wire method: `session.model.getCurrent`. + /// Wire method: `session.permissions.locations.resolve`. + /// + /// # Parameters + /// + /// * `params` - Working directory to resolve into a location-permissions key. /// /// # 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. + /// Resolved location-permissions key and type. /// ///
/// @@ -5869,28 +8148,35 @@ impl<'a> SessionRpcModel<'a> { /// 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() }); + ///
+ pub async fn resolve( + &self, + 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_MODEL_GETCURRENT, Some(wire_params)) + .call( + rpc_methods::SESSION_PERMISSIONS_LOCATIONS_RESOLVE, + Some(wire_params), + ) .await?; Ok(serde_json::from_value(_value)?) } - /// Switches the session to a model and optional reasoning configuration. + /// Applies persisted location-scoped tool approvals and allowed directories for a working directory to this session's permission service. /// - /// Wire method: `session.model.switchTo`. + /// Wire method: `session.permissions.locations.apply`. /// /// # Parameters /// - /// * `params` - Target model identifier and optional reasoning effort, summary, capability overrides, and context tier. + /// * `params` - Working directory to load persisted location permissions for. /// /// # Returns /// - /// The model identifier active on the session after the switch. + /// Summary of persisted location permissions applied to the session. /// ///
/// @@ -5899,31 +8185,34 @@ impl<'a> SessionRpcModel<'a> { /// SDK and CLI versions if your code depends on it. /// ///
- pub async fn switch_to( + pub async fn apply( &self, - params: ModelSwitchToRequest, - ) -> Result { + 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_MODEL_SWITCHTO, Some(wire_params)) + .call( + rpc_methods::SESSION_PERMISSIONS_LOCATIONS_APPLY, + Some(wire_params), + ) .await?; Ok(serde_json::from_value(_value)?) } - /// Updates the session's reasoning effort without changing the selected model. + /// Persists a tool approval for a permission location and applies its rules to this session's live permission service. /// - /// Wire method: `session.model.setReasoningEffort`. + /// Wire method: `session.permissions.locations.addToolApproval`. /// /// # Parameters /// - /// * `params` - Reasoning effort level to apply to the currently selected model. + /// * `params` - Location-scoped tool approval to persist. /// /// # 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. + /// Indicates whether the operation succeeded. /// ///
/// @@ -5932,30 +8221,38 @@ impl<'a> SessionRpcModel<'a> { /// SDK and CLI versions if your code depends on it. /// ///
- pub async fn set_reasoning_effort( + pub async fn add_tool_approval( &self, - params: ModelSetReasoningEffortRequest, - ) -> Result { + 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_MODEL_SETREASONINGEFFORT, + rpc_methods::SESSION_PERMISSIONS_LOCATIONS_ADDTOOLAPPROVAL, 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. +/// `session.permissions.paths.*` RPCs. +#[derive(Clone, Copy)] +pub struct SessionRpcPermissionsPaths<'a> { + pub(crate) session: &'a Session, +} + +impl<'a> SessionRpcPermissionsPaths<'a> { + /// Returns the session's allowed directories and primary working directory. /// - /// Wire method: `session.model.list`. + /// Wire method: `session.permissions.paths.list`. /// /// # Returns /// - /// The list of models available to this session. + /// Snapshot of the session's allow-listed directories and primary working directory. /// ///
/// @@ -5964,27 +8261,30 @@ impl<'a> SessionRpcModel<'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_MODEL_LIST, Some(wire_params)) + .call( + rpc_methods::SESSION_PERMISSIONS_PATHS_LIST, + 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. + /// Adds a directory to the session's allow-list and activates conventional skill and agent definitions under it. /// - /// Wire method: `session.model.list`. + /// Wire method: `session.permissions.paths.add`. /// /// # Parameters /// - /// * `params` - Optional listing options. + /// * `params` - Directory path to add to the session's allowed directories. /// /// # Returns /// - /// The list of models available to this session. + /// Indicates whether the operation succeeded. /// ///
/// @@ -5993,35 +8293,34 @@ impl<'a> SessionRpcModel<'a> { /// SDK and CLI versions if your code depends on it. /// ///
- pub async fn list_with_params( + pub async fn add( &self, - params: ModelListRequest, - ) -> Result { + 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_MODEL_LIST, Some(wire_params)) + .call( + rpc_methods::SESSION_PERMISSIONS_PATHS_ADD, + Some(wire_params), + ) .await?; Ok(serde_json::from_value(_value)?) } -} - -/// `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. + /// Updates the session's primary working directory used by the permission policy. /// - /// Wire method: `session.name.get`. + /// Wire method: `session.permissions.paths.updatePrimary`. + /// + /// # Parameters + /// + /// * `params` - Directory path to set as the session's new primary working directory. /// /// # Returns /// - /// The session's friendly name, or null when not yet set. + /// Indicates whether the operation succeeded. /// ///
/// @@ -6030,23 +8329,34 @@ impl<'a> SessionRpcName<'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 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_NAME_GET, Some(wire_params)) + .call( + rpc_methods::SESSION_PERMISSIONS_PATHS_UPDATEPRIMARY, + Some(wire_params), + ) .await?; Ok(serde_json::from_value(_value)?) } - /// Sets the session's friendly name. + /// Reports whether a path falls within any of the session's allowed directories. /// - /// Wire method: `session.name.set`. + /// Wire method: `session.permissions.paths.isPathWithinAllowedDirectories`. /// /// # Parameters /// - /// * `params` - New friendly name to apply to 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. /// ///
/// @@ -6055,28 +8365,34 @@ impl<'a> SessionRpcName<'a> { /// SDK and CLI versions if your code depends on it. /// ///
- pub async fn set(&self, params: NameSetRequest) -> 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_NAME_SET, Some(wire_params)) + .call( + rpc_methods::SESSION_PERMISSIONS_PATHS_ISPATHWITHINALLOWEDDIRECTORIES, + Some(wire_params), + ) .await?; - Ok(()) + Ok(serde_json::from_value(_value)?) } - /// Persists an auto-generated session summary as the session's name when no user-set name exists. + /// Reports whether a path falls within the session's workspace (primary) directory. /// - /// Wire method: `session.name.setAuto`. + /// Wire method: `session.permissions.paths.isPathWithinWorkspace`. /// /// # Parameters /// - /// * `params` - Auto-generated session summary to apply as the session's name when no user-set name exists. + /// * `params` - Path to evaluate against the session's workspace (primary) directory. /// /// # Returns /// - /// Indicates whether the auto-generated summary was applied as the session's name. + /// Indicates whether the supplied path is within the session's workspace directory. /// ///
/// @@ -6085,36 +8401,42 @@ impl<'a> SessionRpcName<'a> { /// SDK and CLI versions if your code depends on it. /// ///
- pub async fn set_auto(&self, params: NameSetAutoRequest) -> Result { + 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_NAME_SETAUTO, Some(wire_params)) + .call( + rpc_methods::SESSION_PERMISSIONS_PATHS_ISPATHWITHINWORKSPACE, + Some(wire_params), + ) .await?; Ok(serde_json::from_value(_value)?) } } -/// `session.options.*` RPCs. +/// `session.permissions.urls.*` RPCs. #[derive(Clone, Copy)] -pub struct SessionRpcOptions<'a> { +pub struct SessionRpcPermissionsUrls<'a> { pub(crate) session: &'a Session, } -impl<'a> SessionRpcOptions<'a> { - /// Patches the genuinely-mutable subset of session options. +impl<'a> SessionRpcPermissionsUrls<'a> { + /// Toggles the runtime's URL-permission policy between unrestricted and restricted modes. /// - /// Wire method: `session.options.update`. + /// Wire method: `session.permissions.urls.setUnrestrictedMode`. /// /// # Parameters /// - /// * `params` - Patch of mutable session options to apply to the running session. + /// * `params` - Whether the URL-permission policy should run in unrestricted mode. /// /// # Returns /// - /// Indicates whether the session options patch was applied successfully. + /// Indicates whether the operation succeeded. /// ///
/// @@ -6123,67 +8445,38 @@ impl<'a> SessionRpcOptions<'a> { /// SDK and CLI versions if your code depends on it. /// ///
- pub async fn update( + pub async fn set_unrestricted_mode( &self, - params: SessionUpdateOptionsParams, - ) -> Result { + 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_OPTIONS_UPDATE, Some(wire_params)) + .call( + rpc_methods::SESSION_PERMISSIONS_URLS_SETUNRESTRICTEDMODE, + Some(wire_params), + ) .await?; Ok(serde_json::from_value(_value)?) } } -/// `session.permissions.*` RPCs. +/// `session.plan.*` RPCs. #[derive(Clone, Copy)] -pub struct SessionRpcPermissions<'a> { +pub struct SessionRpcPlan<'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 +impl<'a> SessionRpcPlan<'a> { + /// Reads the session plan file from the workspace. /// - /// * `params` - Patch of permission policy fields to apply (omit a field to leave it unchanged). + /// Wire method: `session.plan.read`. /// /// # Returns /// - /// Indicates whether the operation succeeded. + /// Existence, contents, and resolved path of the session plan file. /// ///
/// @@ -6192,34 +8485,45 @@ 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 async fn read(&self) -> Result { + 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_PLAN_READ, Some(wire_params)) .await?; Ok(serde_json::from_value(_value)?) } - /// Provides a decision for a pending tool permission request. + /// Writes new content to the session plan file. /// - /// Wire method: `session.permissions.handlePendingPermissionRequest`. + /// Wire method: `session.plan.update`. /// /// # Parameters /// - /// * `params` - Pending permission request ID and the decision to apply (approve/reject and scope). + /// * `params` - Replacement contents to write to the session plan file. /// - /// # 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. + /// + ///
+ 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_PLAN_UPDATE, Some(wire_params)) + .await?; + Ok(()) + } + + /// Deletes the session plan file from the workspace. /// - /// Indicates whether the permission decision was applied; false when the request was already resolved. + /// Wire method: `session.plan.delete`. /// ///
/// @@ -6228,30 +8532,23 @@ 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 { - 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_PERMISSIONS_HANDLEPENDINGPERMISSIONREQUEST, - Some(wire_params), - ) + .call(rpc_methods::SESSION_PLAN_DELETE, Some(wire_params)) .await?; - Ok(serde_json::from_value(_value)?) + Ok(()) } - /// Reconstructs the set of pending tool permission requests from the session's event history. + /// Reads todo rows from the session SQL database for plan rendering. /// - /// Wire method: `session.permissions.pendingRequests`. + /// Wire method: `session.plan.readSqlTodos`. /// /// # Returns /// - /// List of pending permission requests reconstructed from event history. + /// Todo rows read from the session SQL database. Empty when no session database is available. /// ///
/// @@ -6260,30 +8557,23 @@ impl<'a> SessionRpcPermissions<'a> { /// SDK and CLI versions if your code depends on it. /// ///
- pub async fn pending_requests(&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_PERMISSIONS_PENDINGREQUESTS, - Some(wire_params), - ) + .call(rpc_methods::SESSION_PLAN_READSQLTODOS, Some(wire_params)) .await?; Ok(serde_json::from_value(_value)?) } - /// Enables or disables automatic approval of tool permission requests for the session. - /// - /// Wire method: `session.permissions.setApproveAll`. - /// - /// # 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` - Allow-all toggle for tool permission requests, with an optional telemetry source. + /// Wire method: `session.plan.readSqlTodosWithDependencies`. /// /// # Returns /// - /// Indicates whether the operation succeeded. + /// Todo rows + dependency edges read from the session SQL database. /// ///
/// @@ -6292,34 +8582,36 @@ impl<'a> SessionRpcPermissions<'a> { /// SDK and CLI versions if your code depends on it. /// ///
- pub async fn set_approve_all( + pub async fn read_sql_todos_with_dependencies( &self, - params: PermissionsSetApproveAllRequest, - ) -> 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_PERMISSIONS_SETAPPROVEALL, + rpc_methods::SESSION_PLAN_READSQLTODOSWITHDEPENDENCIES, Some(wire_params), ) .await?; Ok(serde_json::from_value(_value)?) } +} - /// 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.permissions.setAllowAll`. - /// - /// # 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` - Allow-all mode to apply for the session. + /// Wire method: `session.plugins.list`. /// /// # Returns /// - /// Indicates whether the operation succeeded and reports the post-mutation state. + /// Plugins installed for the session, with their enabled state and version metadata. /// ///
/// @@ -6328,30 +8620,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_PLUGINS_LIST, Some(wire_params)) .await?; Ok(serde_json::from_value(_value)?) } - /// Returns the current allow-all permission mode for the session. - /// - /// Wire method: `session.permissions.getAllowAll`. - /// - /// # 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. /// - /// Current allow-all permission mode. + /// Wire method: `session.plugins.reload`. /// ///
/// @@ -6360,30 +8641,23 @@ impl<'a> SessionRpcPermissions<'a> { /// SDK and CLI versions if your code depends on it. /// ///
- pub async fn get_allow_all(&self) -> Result { + 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_PERMISSIONS_GETALLOWALL, - Some(wire_params), - ) + .call(rpc_methods::SESSION_PLUGINS_RELOAD, Some(wire_params)) .await?; - Ok(serde_json::from_value(_value)?) + Ok(()) } - /// Adds or removes session-scoped or location-scoped permission rules. + /// 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.permissions.modifyRules`. + /// Wire method: `session.plugins.reload`. /// /// # Parameters /// - /// * `params` - Scope and add/remove instructions for modifying session- or location-scoped permission rules. - /// - /// # Returns - /// - /// Indicates whether the operation succeeded. + /// * `params` - Optional flags controlling which side effects the reload performs. /// ///
/// @@ -6392,34 +8666,32 @@ impl<'a> SessionRpcPermissions<'a> { /// SDK and CLI versions if your code depends on it. /// ///
- pub async fn modify_rules( - &self, - params: PermissionsModifyRulesParams, - ) -> Result { + 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_PERMISSIONS_MODIFYRULES, - Some(wire_params), - ) + .call(rpc_methods::SESSION_PLUGINS_RELOAD, Some(wire_params)) .await?; - Ok(serde_json::from_value(_value)?) + Ok(()) } +} - /// Sets whether the client wants permission prompts bridged into session events. - /// - /// Wire method: `session.permissions.setRequired`. - /// - /// # Parameters +/// `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. /// - /// * `params` - Toggles whether permission prompts should be bridged into session events for this client. + /// Wire method: `session.provider.getEndpoint`. /// /// # Returns /// - /// Indicates whether the operation succeeded. + /// A snapshot of the provider endpoint the session is currently configured to talk to. /// ///
/// @@ -6428,30 +8700,27 @@ impl<'a> SessionRpcPermissions<'a> { /// SDK and CLI versions if your code depends on it. /// ///
- 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()); + 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_PERMISSIONS_SETREQUIRED, - Some(wire_params), - ) + .call(rpc_methods::SESSION_PROVIDER_GETENDPOINT, Some(wire_params)) .await?; Ok(serde_json::from_value(_value)?) } - /// Clears session-scoped tool permission approvals. + /// 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.permissions.resetSessionApprovals`. + /// Wire method: `session.provider.getEndpoint`. + /// + /// # Parameters + /// + /// * `params` - Optional model identifier to scope the endpoint snapshot to. /// /// # Returns /// - /// Indicates whether the operation succeeded. + /// A snapshot of the provider endpoint the session is currently configured to talk to. /// ///
/// @@ -6460,32 +8729,31 @@ impl<'a> SessionRpcPermissions<'a> { /// SDK and CLI versions if your code depends on it. /// ///
- pub async fn reset_session_approvals( + pub async fn get_endpoint_with_params( &self, - ) -> Result { - let wire_params = serde_json::json!({ "sessionId": self.session.id() }); + 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_PERMISSIONS_RESETSESSIONAPPROVALS, - Some(wire_params), - ) + .call(rpc_methods::SESSION_PROVIDER_GETENDPOINT, Some(wire_params)) .await?; Ok(serde_json::from_value(_value)?) } - /// Notifies the runtime that a permission prompt UI has been shown to the user. + /// 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.permissions.notifyPromptShown`. + /// Wire method: `session.provider.add`. /// /// # Parameters /// - /// * `params` - Notification payload describing the permission prompt that the client just rendered. + /// * `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 /// - /// Indicates whether the operation succeeded. + /// The selectable model entries synthesized for the models added by this call. /// ///
/// @@ -6494,42 +8762,32 @@ impl<'a> SessionRpcPermissions<'a> { /// SDK and CLI versions if your code depends on it. /// ///
- pub async fn notify_prompt_shown( - &self, - params: PermissionPromptShownNotification, - ) -> 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_PERMISSIONS_NOTIFYPROMPTSHOWN, - Some(wire_params), - ) + .call(rpc_methods::SESSION_PROVIDER_ADD, Some(wire_params)) .await?; Ok(serde_json::from_value(_value)?) } } -/// `session.permissions.folderTrust.*` RPCs. +/// `session.queue.*` RPCs. #[derive(Clone, Copy)] -pub struct SessionRpcPermissionsFolderTrust<'a> { +pub struct SessionRpcQueue<'a> { pub(crate) session: &'a Session, } -impl<'a> SessionRpcPermissionsFolderTrust<'a> { - /// Reports whether a folder is trusted according to the user's folder trust state. - /// - /// Wire method: `session.permissions.folderTrust.isTrusted`. - /// - /// # Parameters +impl<'a> SessionRpcQueue<'a> { + /// Returns the local session's pending user-facing queued items and steering messages. /// - /// * `params` - Folder path to check for trust. + /// Wire method: `session.queue.pendingItems`. /// /// # Returns /// - /// Folder trust check result. + /// Snapshot of the session's pending queued items and immediate-steering messages. /// ///
/// @@ -6538,34 +8796,23 @@ impl<'a> SessionRpcPermissionsFolderTrust<'a> { /// SDK and CLI versions if your code depends on it. /// ///
- pub async fn is_trusted( - &self, - params: FolderTrustCheckParams, - ) -> 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 pending_items(&self) -> Result { + let wire_params = serde_json::json!({ "sessionId": self.session.id() }); let _value = self .session .client() - .call( - rpc_methods::SESSION_PERMISSIONS_FOLDERTRUST_ISTRUSTED, - Some(wire_params), - ) + .call(rpc_methods::SESSION_QUEUE_PENDINGITEMS, Some(wire_params)) .await?; Ok(serde_json::from_value(_value)?) } - /// Adds a folder to the user's trusted folders list. - /// - /// Wire method: `session.permissions.folderTrust.addTrusted`. + /// Returns the internal native queue snapshot for in-process session orchestration. /// - /// # Parameters - /// - /// * `params` - Folder path to add to trusted folders. + /// Wire method: `session.queue.snapshot`. /// /// # Returns /// - /// Indicates whether the operation succeeded. + /// Internal snapshot of native queue state for local session orchestration. /// ///
/// @@ -6574,42 +8821,27 @@ impl<'a> SessionRpcPermissionsFolderTrust<'a> { /// SDK and CLI versions if your code depends on it. /// ///
- pub async fn add_trusted( - &self, - params: FolderTrustAddParams, - ) -> 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_FOLDERTRUST_ADDTRUSTED, - Some(wire_params), - ) + .call(rpc_methods::SESSION_QUEUE_SNAPSHOT, 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. + /// Moves an addressable queued item to a public visible position. /// - /// Wire method: `session.permissions.locations.resolve`. + /// Wire method: `session.queue.moveItem`. /// /// # Parameters /// - /// * `params` - Working directory to resolve into a location-permissions key. + /// * `params` - Parameters for moving a queued item by stable id. /// /// # Returns /// - /// Resolved location-permissions key and type. + /// Result of moving a queued item. /// ///
/// @@ -6618,34 +8850,31 @@ impl<'a> SessionRpcPermissionsLocations<'a> { /// SDK and CLI versions if your code depends on it. /// ///
- pub async fn resolve( + pub async fn move_item( &self, - params: PermissionLocationResolveParams, - ) -> 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_PERMISSIONS_LOCATIONS_RESOLVE, - Some(wire_params), - ) + .call(rpc_methods::SESSION_QUEUE_MOVEITEM, 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. + /// Inserts a new queued message at a public visible position. /// - /// Wire method: `session.permissions.locations.apply`. + /// Wire method: `session.queue.insertAt`. /// /// # Parameters /// - /// * `params` - Working directory to load persisted location permissions for. + /// * `params` - Parameters for inserting a queued message at a public visible position. /// /// # Returns /// - /// Summary of persisted location permissions applied to the session. + /// Result of inserting a queued message. /// ///
/// @@ -6654,34 +8883,31 @@ impl<'a> SessionRpcPermissionsLocations<'a> { /// SDK and CLI versions if your code depends on it. /// ///
- pub async fn apply( + pub async fn insert_at( &self, - params: PermissionLocationApplyParams, - ) -> 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_PERMISSIONS_LOCATIONS_APPLY, - Some(wire_params), - ) + .call(rpc_methods::SESSION_QUEUE_INSERTAT, 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. + /// Removes an addressable queued item by its stable id. /// - /// Wire method: `session.permissions.locations.addToolApproval`. + /// Wire method: `session.queue.removeAt`. /// /// # Parameters /// - /// * `params` - Location-scoped tool approval to persist. + /// * `params` - Parameters for removing a queued item by stable id. /// /// # Returns /// - /// Indicates whether the operation succeeded. + /// Result of removing a queued item. /// ///
/// @@ -6690,38 +8916,31 @@ impl<'a> SessionRpcPermissionsLocations<'a> { /// SDK and CLI versions if your code depends on it. /// ///
- pub async fn add_tool_approval( + pub async fn remove_at( &self, - params: PermissionLocationAddToolApprovalParams, - ) -> Result { + 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_PERMISSIONS_LOCATIONS_ADDTOOLAPPROVAL, - Some(wire_params), - ) + .call(rpc_methods::SESSION_QUEUE_REMOVEAT, Some(wire_params)) .await?; Ok(serde_json::from_value(_value)?) } -} - -/// `session.permissions.paths.*` RPCs. -#[derive(Clone, Copy)] -pub struct SessionRpcPermissionsPaths<'a> { - pub(crate) session: &'a Session, -} -impl<'a> SessionRpcPermissionsPaths<'a> { - /// Returns the session's allowed directories and primary working directory. + /// Updates the text of an addressable single-message queue item. /// - /// Wire method: `session.permissions.paths.list`. + /// Wire method: `session.queue.updateText`. + /// + /// # Parameters + /// + /// * `params` - Parameters for editing a single queued message. /// /// # Returns /// - /// Snapshot of the session's allow-listed directories and primary working directory. + /// Result of editing a queued message. /// ///
/// @@ -6730,30 +8949,31 @@ impl<'a> SessionRpcPermissionsPaths<'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_text( + &self, + 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_PERMISSIONS_PATHS_LIST, - Some(wire_params), - ) + .call(rpc_methods::SESSION_QUEUE_UPDATETEXT, Some(wire_params)) .await?; Ok(serde_json::from_value(_value)?) } - /// Adds a directory to the session's allow-list. + /// Duplicates an addressable queued item immediately after its source. /// - /// Wire method: `session.permissions.paths.add`. + /// Wire method: `session.queue.duplicateAt`. /// /// # Parameters /// - /// * `params` - Directory path to add to the session's allowed directories. + /// * `params` - Parameters for duplicating a queued item. /// /// # Returns /// - /// Indicates whether the operation succeeded. + /// Result of duplicating a queued item. /// ///
/// @@ -6762,34 +8982,27 @@ impl<'a> SessionRpcPermissionsPaths<'a> { /// SDK and CLI versions if your code depends on it. /// ///
- pub async fn add( + pub async fn duplicate_at( &self, - params: PermissionPathsAddParams, - ) -> Result { + 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_PERMISSIONS_PATHS_ADD, - Some(wire_params), - ) + .call(rpc_methods::SESSION_QUEUE_DUPLICATEAT, Some(wire_params)) .await?; Ok(serde_json::from_value(_value)?) } - /// Updates the session's primary working directory used by the permission policy. + /// Acquires or releases the queued-lane drain pause. /// - /// Wire method: `session.permissions.paths.updatePrimary`. + /// Wire method: `session.queue.setDrainPaused`. /// /// # Parameters /// - /// * `params` - Directory path to set as the session's new primary working directory. - /// - /// # Returns - /// - /// Indicates whether the operation succeeded. + /// * `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. /// ///
/// @@ -6798,34 +9011,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 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_PERMISSIONS_PATHS_UPDATEPRIMARY, - Some(wire_params), - ) + .call(rpc_methods::SESSION_QUEUE_SETDRAINPAUSED, Some(wire_params)) .await?; - Ok(serde_json::from_value(_value)?) + Ok(()) } - /// Reports whether a path falls within any of the session's allowed directories. + /// Moves an addressable queued message into the live turn's steering lane. /// - /// Wire method: `session.permissions.paths.isPathWithinAllowedDirectories`. + /// Wire method: `session.queue.sendNow`. /// /// # Parameters /// - /// * `params` - Path to evaluate against the session's allowed directories. + /// * `params` - Parameters for steering a queued message into a live turn. /// /// # Returns /// - /// Indicates whether the supplied path is within the session's allowed directories. + /// Result of trying to steer a queued message into a live turn. /// ///
/// @@ -6834,34 +9041,24 @@ impl<'a> SessionRpcPermissionsPaths<'a> { /// SDK and CLI versions if your code depends on it. /// ///
- pub async fn is_path_within_allowed_directories( - &self, - params: PermissionPathsAllowedCheckParams, - ) -> Result { + 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_PERMISSIONS_PATHS_ISPATHWITHINALLOWEDDIRECTORIES, - Some(wire_params), - ) + .call(rpc_methods::SESSION_QUEUE_SENDNOW, Some(wire_params)) .await?; Ok(serde_json::from_value(_value)?) } - /// Reports whether a path falls within the session's workspace (primary) directory. - /// - /// Wire method: `session.permissions.paths.isPathWithinWorkspace`. - /// - /// # Parameters + /// Reports whether the local session has native queued work pending. /// - /// * `params` - Path to evaluate against the session's workspace (primary) directory. + /// Wire method: `session.queue.hasPending`. /// /// # Returns /// - /// Indicates whether the supplied path is within the session's workspace directory. + /// Whether the native queue has pending work. /// ///
/// @@ -6870,42 +9067,27 @@ impl<'a> SessionRpcPermissionsPaths<'a> { /// SDK and CLI versions if your code depends on it. /// ///
- 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()); + 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_PERMISSIONS_PATHS_ISPATHWITHINWORKSPACE, - Some(wire_params), - ) + .call(rpc_methods::SESSION_QUEUE_HASPENDING, Some(wire_params)) .await?; Ok(serde_json::from_value(_value)?) } -} - -/// `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. + /// Begins a native deferred-idle drain when background work has quiesced. /// - /// Wire method: `session.permissions.urls.setUnrestrictedMode`. + /// Wire method: `session.queue.beginDeferredIdleDrain`. /// /// # Parameters /// - /// * `params` - Whether the URL-permission policy should run in unrestricted mode. + /// * `params` - Inputs for starting a deferred-idle drain. /// /// # Returns /// - /// Indicates whether the operation succeeded. + /// Whether a deferred-idle drain should run. /// ///
/// @@ -6914,38 +9096,34 @@ impl<'a> SessionRpcPermissionsUrls<'a> { /// SDK and CLI versions if your code depends on it. /// ///
- pub async fn set_unrestricted_mode( + pub(crate) async fn begin_deferred_idle_drain( &self, - params: PermissionUrlsSetUnrestrictedModeParams, - ) -> 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_PERMISSIONS_URLS_SETUNRESTRICTEDMODE, + rpc_methods::SESSION_QUEUE_BEGINDEFERREDIDLEDRAIN, 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. + /// Finishes a native deferred-idle drain and reports whether to drain queue work or emit idle. /// - /// Wire method: `session.plan.read`. + /// Wire method: `session.queue.finishDeferredIdleDrain`. + /// + /// # Parameters + /// + /// * `params` - Inputs for completing a deferred-idle drain. /// /// # Returns /// - /// Existence, contents, and resolved path of the session plan file. + /// Action selected by the native deferred-idle drain. /// ///
/// @@ -6954,23 +9132,30 @@ impl<'a> SessionRpcPlan<'a> { /// SDK and CLI versions if your code depends on it. /// ///
- pub async fn read(&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_PLAN_READ, Some(wire_params)) + .call( + rpc_methods::SESSION_QUEUE_FINISHDEFERREDIDLEDRAIN, + Some(wire_params), + ) .await?; Ok(serde_json::from_value(_value)?) } - /// Writes new content to the session plan file. + /// Marks session.idle as deferred by native background work state. /// - /// Wire method: `session.plan.update`. + /// Wire method: `session.queue.deferSessionIdle`. /// /// # Parameters /// - /// * `params` - Replacement contents to write to the session plan file. + /// * `params` - Inputs for marking session.idle deferred in native state. /// ///
/// @@ -6979,20 +9164,30 @@ impl<'a> SessionRpcPlan<'a> { /// SDK and CLI versions if your code depends on it. /// ///
- pub async fn update(&self, params: PlanUpdateRequest) -> Result<(), Error> { + pub(crate) async fn defer_session_idle( + &self, + 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_PLAN_UPDATE, Some(wire_params)) + .call( + rpc_methods::SESSION_QUEUE_DEFERSESSIONIDLE, + Some(wire_params), + ) .await?; Ok(()) } - /// Deletes the session plan file from the workspace. + /// Removes the most recently queued user-facing item (LIFO). /// - /// Wire method: `session.plan.delete`. + /// Wire method: `session.queue.removeMostRecent`. + /// + /// # Returns + /// + /// Indicates whether a user-facing pending item was removed. /// ///
/// @@ -7001,23 +9196,22 @@ impl<'a> SessionRpcPlan<'a> { /// SDK and CLI versions if your code depends on it. /// ///
- pub async fn delete(&self) -> Result<(), Error> { + 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_PLAN_DELETE, Some(wire_params)) + .call( + rpc_methods::SESSION_QUEUE_REMOVEMOSTRECENT, + Some(wire_params), + ) .await?; - Ok(()) + Ok(serde_json::from_value(_value)?) } - /// Reads todo rows from the session SQL database for plan rendering. - /// - /// Wire method: `session.plan.readSqlTodos`. - /// - /// # Returns + /// Clears all pending queued items on the local session. /// - /// Todo rows read from the session SQL database. Empty when no session database is available. + /// Wire method: `session.queue.clear`. /// ///
/// @@ -7026,23 +9220,27 @@ impl<'a> SessionRpcPlan<'a> { /// SDK and CLI versions if your code depends on it. /// ///
- pub async fn read_sql_todos(&self) -> Result { + 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_PLAN_READSQLTODOS, Some(wire_params)) + .call(rpc_methods::SESSION_QUEUE_CLEAR, Some(wire_params)) .await?; - Ok(serde_json::from_value(_value)?) + Ok(()) } - /// 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. + /// Consumes queued native system notifications matching an internal filter. /// - /// Wire method: `session.plan.readSqlTodosWithDependencies`. + /// Wire method: `session.queue.consumeSystemNotifications`. + /// + /// # Parameters + /// + /// * `params` - Internal filter for consuming queued system notifications. /// /// # Returns /// - /// Todo rows + dependency edges read from the session SQL database. + /// Indicates whether a user-facing pending item was removed. /// ///
/// @@ -7051,36 +9249,30 @@ impl<'a> SessionRpcPlan<'a> { /// SDK and CLI versions if your code depends on it. /// ///
- pub async fn read_sql_todos_with_dependencies( + pub(crate) async fn consume_system_notifications( &self, - ) -> Result { - let wire_params = serde_json::json!({ "sessionId": self.session.id() }); + 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_PLAN_READSQLTODOSWITHDEPENDENCIES, + rpc_methods::SESSION_QUEUE_CONSUMESYSTEMNOTIFICATIONS, Some(wire_params), ) .await?; Ok(serde_json::from_value(_value)?) } -} - -/// `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. + /// Enqueues the internal resume-pending wake item when orphan handling needs a follow-up turn. /// - /// Wire method: `session.plugins.list`. + /// Wire method: `session.queue.enqueueResumePending`. /// /// # Returns /// - /// Plugins installed for the session, with their enabled state and version metadata. + /// Result of enqueueing the resume-pending wake item. /// ///
/// @@ -7089,19 +9281,24 @@ impl<'a> SessionRpcPlugins<'a> { /// SDK and CLI versions if your code depends on it. /// ///
- pub async fn list(&self) -> Result { + pub(crate) async fn enqueue_resume_pending( + &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_QUEUE_ENQUEUERESUMEPENDING, + Some(wire_params), + ) .await?; Ok(serde_json::from_value(_value)?) } - /// 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. + /// Drains the native local-session work queue for in-process session orchestration. /// - /// Wire method: `session.plugins.reload`. + /// Wire method: `session.queue.process`. /// ///
/// @@ -7110,57 +9307,35 @@ impl<'a> SessionRpcPlugins<'a> { /// SDK and CLI versions if your code depends on it. /// ///
- pub async fn reload(&self) -> Result<(), Error> { + 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_PLUGINS_RELOAD, Some(wire_params)) - .await?; - Ok(()) - } - - /// 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.plugins.reload`. - /// - /// # Parameters - /// - /// * `params` - Optional flags controlling which side effects the reload performs. - /// - ///
- /// - /// **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_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_PLUGINS_RELOAD, Some(wire_params)) + .call(rpc_methods::SESSION_QUEUE_PROCESS, Some(wire_params)) .await?; Ok(()) } } -/// `session.provider.*` RPCs. +/// `session.remote.*` RPCs. #[derive(Clone, Copy)] -pub struct SessionRpcProvider<'a> { +pub struct SessionRpcRemote<'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. +impl<'a> SessionRpcRemote<'a> { + /// Enables remote session export or steering. /// - /// Wire method: `session.provider.getEndpoint`. + /// Wire method: `session.remote.enable`. + /// + /// # Parameters + /// + /// * `params` - Optional remote session mode ("off", "export", or "on"); defaults to enabling both export and remote steering. /// /// # Returns /// - /// A snapshot of the provider endpoint the session is currently configured to talk to. + /// GitHub URL for the session and a flag indicating whether remote steering is enabled. /// ///
/// @@ -7169,27 +9344,20 @@ impl<'a> SessionRpcProvider<'a> { /// SDK and CLI versions if your code depends on it. /// ///
- pub async fn get_endpoint(&self) -> Result { - let wire_params = serde_json::json!({ "sessionId": self.session.id() }); + 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_PROVIDER_GETENDPOINT, Some(wire_params)) + .call(rpc_methods::SESSION_REMOTE_ENABLE, Some(wire_params)) .await?; Ok(serde_json::from_value(_value)?) } - /// 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.provider.getEndpoint`. - /// - /// # Parameters - /// - /// * `params` - Optional model identifier to scope the endpoint snapshot to. - /// - /// # Returns + /// Disables remote session export and steering. /// - /// A snapshot of the provider endpoint the session is currently configured to talk to. + /// Wire method: `session.remote.disable`. /// ///
/// @@ -7198,31 +9366,27 @@ impl<'a> SessionRpcProvider<'a> { /// SDK and CLI versions if your code depends on it. /// ///
- pub async fn get_endpoint_with_params( - &self, - params: ProviderGetEndpointRequest, - ) -> 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 disable(&self) -> Result<(), Error> { + let wire_params = serde_json::json!({ "sessionId": self.session.id() }); let _value = self .session .client() - .call(rpc_methods::SESSION_PROVIDER_GETENDPOINT, Some(wire_params)) + .call(rpc_methods::SESSION_REMOTE_DISABLE, Some(wire_params)) .await?; - Ok(serde_json::from_value(_value)?) + Ok(()) } - /// 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. + /// Persists a remote-steerability change emitted by the host as a session event. /// - /// Wire method: `session.provider.add`. + /// Wire method: `session.remote.notifySteerableChanged`. /// /// # Parameters /// - /// * `params` - BYOK providers and/or models to add to the session's registry at runtime. Both fields are optional; provide providers, models, or both. + /// * `params` - New remote-steerability state to persist as a `session.remote_steerable_changed` event. /// /// # Returns /// - /// The selectable model entries synthesized for the models added by this call. + /// 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. /// ///
/// @@ -7231,32 +9395,38 @@ impl<'a> SessionRpcProvider<'a> { /// SDK and CLI versions if your code depends on it. /// ///
- pub async fn add(&self, params: ProviderAddRequest) -> Result { + pub async fn notify_steerable_changed( + &self, + 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_PROVIDER_ADD, Some(wire_params)) + .call( + rpc_methods::SESSION_REMOTE_NOTIFYSTEERABLECHANGED, + Some(wire_params), + ) .await?; Ok(serde_json::from_value(_value)?) } } -/// `session.queue.*` RPCs. +/// `session.schedule.*` RPCs. #[derive(Clone, Copy)] -pub struct SessionRpcQueue<'a> { +pub struct SessionRpcSchedule<'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> SessionRpcSchedule<'a> { + /// Lists the session's currently active scheduled prompts. /// - /// Wire method: `session.queue.pendingItems`. + /// Wire method: `session.schedule.list`. /// /// # Returns /// - /// Snapshot of the session's pending queued items and immediate-steering messages. + /// Snapshot of the currently active recurring prompts for this session. /// ///
/// @@ -7265,23 +9435,44 @@ impl<'a> SessionRpcQueue<'a> { /// SDK and CLI versions if your code depends on it. /// ///
- pub async fn pending_items(&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_PENDINGITEMS, Some(wire_params)) + .call(rpc_methods::SESSION_SCHEDULE_LIST, Some(wire_params)) .await?; Ok(serde_json::from_value(_value)?) } - /// Removes the most recently queued user-facing item (LIFO). + /// Hydrates the native schedule registry from persisted session events. /// - /// Wire method: `session.queue.removeMostRecent`. + /// Wire method: `session.schedule.hydrate`. + /// + ///
+ /// + /// **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 hydrate(&self) -> Result<(), Error> { + let wire_params = serde_json::json!({ "sessionId": self.session.id() }); + let _value = self + .session + .client() + .call(rpc_methods::SESSION_SCHEDULE_HYDRATE, Some(wire_params)) + .await?; + Ok(()) + } + + /// Reports whether the session has an active self-paced scheduled prompt. + /// + /// Wire method: `session.schedule.hasSelfPaced`. /// /// # Returns /// - /// Indicates whether a user-facing pending item was removed. + /// Whether the session currently has an active self-paced schedule. /// ///
/// @@ -7290,22 +9481,30 @@ impl<'a> SessionRpcQueue<'a> { /// SDK and CLI versions if your code depends on it. /// ///
- pub async fn remove_most_recent(&self) -> Result { + 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_QUEUE_REMOVEMOSTRECENT, + rpc_methods::SESSION_SCHEDULE_HASSELFPACED, Some(wire_params), ) .await?; Ok(serde_json::from_value(_value)?) } - /// Clears all pending queued items on the local session. + /// Registers a relative-interval scheduled prompt. /// - /// Wire method: `session.queue.clear`. + /// Wire method: `session.schedule.add`. + /// + /// # Parameters + /// + /// * `params` - Register a relative-interval scheduled prompt. + /// + /// # Returns + /// + /// Result of registering or re-arming a scheduled prompt. /// ///
/// @@ -7314,35 +9513,28 @@ impl<'a> SessionRpcQueue<'a> { /// SDK and CLI versions if your code depends on it. /// ///
- pub async fn clear(&self) -> Result<(), Error> { - let wire_params = serde_json::json!({ "sessionId": self.session.id() }); + 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_QUEUE_CLEAR, Some(wire_params)) + .call(rpc_methods::SESSION_SCHEDULE_ADD, 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, -} -impl<'a> SessionRpcRemote<'a> { - /// Enables remote session export or steering. + /// Registers a recurring cron scheduled prompt. /// - /// Wire method: `session.remote.enable`. + /// Wire method: `session.schedule.addCron`. /// /// # Parameters /// - /// * `params` - Optional remote session mode ("off", "export", or "on"); defaults to enabling both export and remote steering. + /// * `params` - Register a cron scheduled prompt. /// /// # Returns /// - /// GitHub URL for the session and a flag indicating whether remote steering is enabled. + /// Result of registering or re-arming a scheduled prompt. /// ///
/// @@ -7351,20 +9543,31 @@ impl<'a> SessionRpcRemote<'a> { /// SDK and CLI versions if your code depends on it. /// ///
- pub async fn enable(&self, params: RemoteEnableRequest) -> Result { + pub(crate) async fn add_cron( + &self, + 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_REMOTE_ENABLE, Some(wire_params)) + .call(rpc_methods::SESSION_SCHEDULE_ADDCRON, Some(wire_params)) .await?; Ok(serde_json::from_value(_value)?) } - /// Disables remote session export and steering. + /// Registers an absolute-time scheduled prompt. /// - /// Wire method: `session.remote.disable`. + /// Wire method: `session.schedule.addAt`. + /// + /// # Parameters + /// + /// * `params` - Register an absolute-time scheduled prompt. + /// + /// # Returns + /// + /// Result of registering or re-arming a scheduled prompt. /// ///
/// @@ -7373,27 +9576,31 @@ impl<'a> SessionRpcRemote<'a> { /// SDK and CLI versions if your code depends on it. /// ///
- pub async fn disable(&self) -> Result<(), Error> { - let wire_params = serde_json::json!({ "sessionId": self.session.id() }); + pub(crate) async fn add_at( + &self, + 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_REMOTE_DISABLE, Some(wire_params)) + .call(rpc_methods::SESSION_SCHEDULE_ADDAT, Some(wire_params)) .await?; - Ok(()) + Ok(serde_json::from_value(_value)?) } - /// Persists a remote-steerability change emitted by the host as a session event. + /// Registers a self-paced scheduled prompt. /// - /// Wire method: `session.remote.notifySteerableChanged`. + /// Wire method: `session.schedule.addSelfPaced`. /// /// # Parameters /// - /// * `params` - New remote-steerability state to persist as a `session.remote_steerable_changed` event. + /// * `params` - Register a self-paced scheduled prompt. /// /// # 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. + /// Result of registering or re-arming a scheduled prompt. /// ///
/// @@ -7402,38 +9609,34 @@ impl<'a> SessionRpcRemote<'a> { /// SDK and CLI versions if your code depends on it. /// ///
- pub async fn notify_steerable_changed( + pub(crate) async fn add_self_paced( &self, - params: RemoteNotifySteerableChangedRequest, - ) -> 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_REMOTE_NOTIFYSTEERABLECHANGED, + rpc_methods::SESSION_SCHEDULE_ADDSELFPACED, 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. + /// Re-arms an active self-paced scheduled prompt. /// - /// Wire method: `session.schedule.list`. + /// Wire method: `session.schedule.rearmSelfPaced`. + /// + /// # Parameters + /// + /// * `params` - Re-arm a self-paced scheduled prompt. /// /// # Returns /// - /// Snapshot of the currently active recurring prompts for this session. + /// Result of registering or re-arming a scheduled prompt. /// ///
/// @@ -7442,12 +9645,19 @@ impl<'a> SessionRpcSchedule<'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 rearm_self_paced( + &self, + 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_SCHEDULE_LIST, Some(wire_params)) + .call( + rpc_methods::SESSION_SCHEDULE_REARMSELFPACED, + Some(wire_params), + ) .await?; Ok(serde_json::from_value(_value)?) } @@ -7559,7 +9769,7 @@ pub struct SessionRpcShell<'a> { } impl<'a> SessionRpcShell<'a> { - /// 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. /// /// Wire method: `session.shell.exec`. /// @@ -7589,7 +9799,7 @@ impl<'a> SessionRpcShell<'a> { Ok(serde_json::from_value(_value)?) } - /// 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. /// /// Wire method: `session.shell.kill`. /// @@ -8219,13 +10429,123 @@ impl<'a> SessionRpcTelemetry<'a> { Ok(serde_json::from_value(_value)?) } - /// Sets feature override key/value pairs to attach to subsequent telemetry events for the session. + /// Sets feature override key/value pairs to attach to subsequent telemetry events for the session. + /// + /// Wire method: `session.telemetry.setFeatureOverrides`. + /// + /// # Parameters + /// + /// * `params` - Feature override key/value pairs to attach to subsequent telemetry events from 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 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_TELEMETRY_SETFEATUREOVERRIDES, + Some(wire_params), + ) + .await?; + Ok(()) + } +} + +/// `session.tools.*` RPCs. +#[derive(Clone, Copy)] +pub struct SessionRpcTools<'a> { + pub(crate) session: &'a Session, +} + +impl<'a> SessionRpcTools<'a> { + /// Executes one tool from the session's currently offered tool set through the native invocation pipeline. + /// + /// Wire method: `session.tools.execute`. + /// + /// # Parameters + /// + /// * `params` - A tool name and arguments to execute through the session's native invocation pipeline. + /// + /// # Returns + /// + /// Canonical result returned by a session tool. + /// + ///
+ /// + /// **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: ToolsExecuteRequest) -> 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_EXECUTE, Some(wire_params)) + .await?; + Ok(serde_json::from_value(_value)?) + } + + /// Returns the Rust-owned built-in tool descriptors used to construct the session's offered tool set. + /// + /// Wire method: `session.tools.getBuiltinDescriptors`. + /// + /// # Parameters + /// + /// * `params` - Options controlling how Rust-owned built-in tool descriptors are materialized. + /// + /// # Returns + /// + /// Rust-owned built-in tool descriptors 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_builtin_descriptors( + &self, + params: ToolsGetBuiltinDescriptorsRequest, + ) -> 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_GETBUILTINDESCRIPTORS, + Some(wire_params), + ) + .await?; + Ok(serde_json::from_value(_value)?) + } + + /// Projects a completed task_complete tool call into its label-safe session event payload. /// - /// Wire method: `session.telemetry.setFeatureOverrides`. + /// Wire method: `session.tools.taskCompleteEventData`. /// /// # Parameters /// - /// * `params` - Feature override key/value pairs to attach to subsequent telemetry events from this session. + /// * `params` - Task-completion tool arguments and final result used to build a label-safe session event payload. + /// + /// # Returns + /// + /// Task completion notification with summary from the agent /// ///
/// @@ -8234,31 +10554,23 @@ impl<'a> SessionRpcTelemetry<'a> { /// SDK and CLI versions if your code depends on it. /// ///
- pub async fn set_feature_overrides( + pub async fn task_complete_event_data( &self, - params: TelemetrySetFeatureOverridesRequest, - ) -> Result<(), Error> { + params: ToolsTaskCompleteEventDataRequest, + ) -> 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_TOOLS_TASKCOMPLETEEVENTDATA, Some(wire_params), ) .await?; - Ok(()) + Ok(serde_json::from_value(_value)?) } -} - -/// `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.tools.handlePendingToolCall`. @@ -8351,6 +10663,36 @@ impl<'a> SessionRpcTools<'a> { Ok(serde_json::from_value(_value)?) } + /// Atomically replaces the complete externally implemented tool list supplied by the calling connection. Built-in, MCP/plugin, extension-discovered, subagent, and tools supplied by other connections remain unchanged. + /// + /// Wire method: `session.tools.set`. + /// + /// # Parameters + /// + /// * `params` - Complete externally implemented tool list for the calling connection. An empty list removes every tool previously supplied by that connection. + /// + /// # Returns + /// + /// Empty result after replacing the calling connection's externally implemented tools. + /// + ///
+ /// + /// **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: ToolsSetRequest) -> 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_SET, Some(wire_params)) + .await?; + Ok(serde_json::from_value(_value)?) + } + /// 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.tools.updateSubagentSettings`. @@ -8405,7 +10747,7 @@ impl<'a> SessionRpcUi<'a> { /// /// # Returns /// - /// Transient answer generated from current conversation context. + /// Completed transient query. Ordered chunks and the terminal outcome are also delivered through `ui.ephemeral_query` session events while it runs. /// ///
/// @@ -8875,6 +11217,75 @@ impl<'a> SessionRpcWorkspaces<'a> { Ok(serde_json::from_value(_value)?) } + /// Updates workspace metadata for a local session and returns the refreshed workspace. + /// + /// Wire method: `session.workspaces.updateMetadata`. + /// + /// # Parameters + /// + /// * `params` - Workspace metadata fields to update. + /// + /// # Returns + /// + /// Current workspace metadata for the session, including its absolute filesystem path 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 async fn update_metadata( + &self, + 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_WORKSPACES_UPDATEMETADATA, + Some(wire_params), + ) + .await?; + Ok(serde_json::from_value(_value)?) + } + + /// Ensures a local session workspace exists and returns it. + /// + /// Wire method: `session.workspaces.ensure`. + /// + /// # Parameters + /// + /// * `params` - Optional session context used when creating a local workspace. + /// + /// # Returns + /// + /// Current workspace metadata for the session, including its absolute filesystem path 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 async fn ensure( + &self, + 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_WORKSPACES_ENSURE, Some(wire_params)) + .await?; + Ok(serde_json::from_value(_value)?) + } + /// Lists files stored in the session workspace files directory. /// /// Wire method: `session.workspaces.listFiles`. @@ -9026,6 +11437,204 @@ impl<'a> SessionRpcWorkspaces<'a> { Ok(serde_json::from_value(_value)?) } + /// Adds a compaction summary checkpoint to the local session workspace. + /// + /// Wire method: `session.workspaces.addSummary`. + /// + /// # Parameters + /// + /// * `params` - Compaction summary checkpoint to persist. + /// + /// # Returns + /// + /// Persisted summary metadata and refreshed workspace 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 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_WORKSPACES_ADDSUMMARY, + Some(wire_params), + ) + .await?; + Ok(serde_json::from_value(_value)?) + } + + /// Truncates local workspace compaction summaries after a rollback. + /// + /// Wire method: `session.workspaces.truncateSummaries`. + /// + /// # Parameters + /// + /// * `params` - Rollback point for local workspace summaries. + /// + /// # Returns + /// + /// Current workspace metadata for the session, including its absolute filesystem path 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 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_TRUNCATESUMMARIES, + Some(wire_params), + ) + .await?; + Ok(serde_json::from_value(_value)?) + } + + /// Reads the autopilot objective state file from the local session workspace. + /// + /// Wire method: `session.workspaces.readAutopilotObjective`. + /// + /// # Returns + /// + /// Autopilot objective file content, or null when missing. + /// + ///
+ /// + /// **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_autopilot_objective( + &self, + ) -> Result { + let wire_params = serde_json::json!({ "sessionId": self.session.id() }); + let _value = self + .session + .client() + .call( + rpc_methods::SESSION_WORKSPACES_READAUTOPILOTOBJECTIVE, + Some(wire_params), + ) + .await?; + Ok(serde_json::from_value(_value)?) + } + + /// Writes the autopilot objective state file in the local session workspace. + /// + /// Wire method: `session.workspaces.writeAutopilotObjective`. + /// + /// # Parameters + /// + /// * `params` - Autopilot objective file content to persist. + /// + /// # Returns + /// + /// Result of writing the autopilot objective file. + /// + ///
+ /// + /// **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 write_autopilot_objective( + &self, + 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_WRITEAUTOPILOTOBJECTIVE, + Some(wire_params), + ) + .await?; + Ok(serde_json::from_value(_value)?) + } + + /// Deletes the autopilot objective state file from the local session workspace. + /// + /// Wire method: `session.workspaces.deleteAutopilotObjective`. + /// + /// # Returns + /// + /// Result of deleting the autopilot objective file. + /// + ///
+ /// + /// **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 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_DELETEAUTOPILOTOBJECTIVE, + Some(wire_params), + ) + .await?; + Ok(serde_json::from_value(_value)?) + } + + /// Checks whether the local session workspace has an autopilot objective state file. + /// + /// Wire method: `session.workspaces.autopilotObjectiveExists`. + /// + /// # Returns + /// + /// Whether the autopilot objective file 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 autopilot_objective_exists( + &self, + ) -> Result { + let wire_params = serde_json::json!({ "sessionId": self.session.id() }); + let _value = self + .session + .client() + .call( + rpc_methods::SESSION_WORKSPACES_AUTOPILOTOBJECTIVEEXISTS, + Some(wire_params), + ) + .await?; + Ok(serde_json::from_value(_value)?) + } + /// Saves pasted content as a UTF-8 file in the session workspace. /// /// Wire method: `session.workspaces.saveLargePaste`. @@ -9062,7 +11671,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 abc7dca626..79284b1671 100644 --- a/rust/src/generated/session_events.rs +++ b/rust/src/generated/session_events.rs @@ -41,6 +41,13 @@ pub enum SessionEventType { SessionModeChanged, #[serde(rename = "session.session_limits_changed")] SessionSessionLimitsChanged, + /// + ///
+ /// + /// **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.permissions_changed")] SessionPermissionsChanged, #[serde(rename = "session.plan_changed")] @@ -63,12 +70,50 @@ pub enum SessionEventType { SessionContextChanged, #[serde(rename = "session.usage_info")] SessionUsageInfo, + #[serde(rename = "session.context_cleared")] + SessionContextCleared, #[serde(rename = "session.compaction_start")] SessionCompactionStart, #[serde(rename = "session.compaction_complete")] SessionCompactionComplete, #[serde(rename = "session.task_complete")] SessionTaskComplete, + /// + ///
+ /// + /// **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.fusion_route_started")] + SessionFusionRouteStarted, + /// + ///
+ /// + /// **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.fusion_route_failed")] + SessionFusionRouteFailed, + /// + ///
+ /// + /// **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.fusion_resolved")] + SessionFusionResolved, + /// + ///
+ /// + /// **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.fusion_completed")] + SessionFusionCompleted, #[serde(rename = "user.message")] UserMessage, #[serde(rename = "pending_messages.modified")] @@ -77,8 +122,37 @@ pub enum SessionEventType { AssistantTurnStart, #[serde(rename = "assistant.turn_retry")] AssistantTurnRetry, + #[serde(rename = "agent.interrupted")] + AgentInterrupted, #[serde(rename = "assistant.intent")] AssistantIntent, + /// + ///
+ /// + /// **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 = "assistant.fusion_phase_started")] + AssistantFusionPhaseStarted, + /// + ///
+ /// + /// **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 = "assistant.fusion_phase_completed")] + AssistantFusionPhaseCompleted, + /// + ///
+ /// + /// **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 = "assistant.fusion_phase_failed")] + AssistantFusionPhaseFailed, #[serde(rename = "assistant.server_tool_progress")] AssistantServerToolProgress, #[serde(rename = "assistant.reasoning")] @@ -101,8 +175,12 @@ pub enum SessionEventType { AssistantIdle, #[serde(rename = "assistant.usage")] AssistantUsage, + #[serde(rename = "prompt_cache_break")] + PromptCacheBreak, #[serde(rename = "model.call_failure")] ModelCallFailure, + #[serde(rename = "model.call_finished")] + ModelCallFinished, #[serde(rename = "model.call_start")] ModelCallStart, #[serde(rename = "abort")] @@ -121,8 +199,12 @@ pub enum SessionEventType { ToolSearchActivated, #[serde(rename = "skill.invoked")] SkillInvoked, + #[serde(rename = "sandbox.decision")] + SandboxDecision, #[serde(rename = "subagent.started")] SubagentStarted, + #[serde(rename = "subagent.configured")] + SubagentConfigured, #[serde(rename = "subagent.completed")] SubagentCompleted, #[serde(rename = "subagent.failed")] @@ -176,6 +258,15 @@ pub enum SessionEventType { McpHeadersRefreshCompleted, #[serde(rename = "session.custom_notification")] SessionCustomNotification, + /// + ///
+ /// + /// **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 = "ui.ephemeral_query")] + UiEphemeralQuery, #[serde(rename = "external_tool.requested")] ExternalToolRequested, #[serde(rename = "external_tool.completed")] @@ -233,6 +324,33 @@ 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, + /// + ///
+ /// + /// **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_started")] + FactoryRunStarted, + /// + ///
+ /// + /// **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_settled")] + FactoryRunSettled, #[serde(rename = "session.skills_loaded")] SessionSkillsLoaded, #[serde(rename = "session.custom_agents_updated")] @@ -349,6 +467,13 @@ pub enum SessionEventData { SessionModeChanged(SessionModeChangedData), #[serde(rename = "session.session_limits_changed")] SessionSessionLimitsChanged(SessionSessionLimitsChangedData), + /// + ///
+ /// + /// **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.permissions_changed")] SessionPermissionsChanged(SessionPermissionsChangedData), #[serde(rename = "session.plan_changed")] @@ -371,12 +496,50 @@ pub enum SessionEventData { 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")] SessionCompactionComplete(SessionCompactionCompleteData), #[serde(rename = "session.task_complete")] SessionTaskComplete(SessionTaskCompleteData), + /// + ///
+ /// + /// **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.fusion_route_started")] + SessionFusionRouteStarted(SessionFusionRouteStartedData), + /// + ///
+ /// + /// **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.fusion_route_failed")] + SessionFusionRouteFailed(SessionFusionRouteFailedData), + /// + ///
+ /// + /// **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.fusion_resolved")] + SessionFusionResolved(SessionFusionResolvedData), + /// + ///
+ /// + /// **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.fusion_completed")] + SessionFusionCompleted(SessionFusionCompletedData), #[serde(rename = "user.message")] UserMessage(UserMessageData), #[serde(rename = "pending_messages.modified")] @@ -385,8 +548,37 @@ pub enum SessionEventData { AssistantTurnStart(AssistantTurnStartData), #[serde(rename = "assistant.turn_retry")] AssistantTurnRetry(AssistantTurnRetryData), + #[serde(rename = "agent.interrupted")] + AgentInterrupted(AgentInterruptedData), #[serde(rename = "assistant.intent")] AssistantIntent(AssistantIntentData), + /// + ///
+ /// + /// **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 = "assistant.fusion_phase_started")] + AssistantFusionPhaseStarted(AssistantFusionPhaseStartedData), + /// + ///
+ /// + /// **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 = "assistant.fusion_phase_completed")] + AssistantFusionPhaseCompleted(AssistantFusionPhaseCompletedData), + /// + ///
+ /// + /// **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 = "assistant.fusion_phase_failed")] + AssistantFusionPhaseFailed(AssistantFusionPhaseFailedData), #[serde(rename = "assistant.server_tool_progress")] AssistantServerToolProgress(AssistantServerToolProgressData), #[serde(rename = "assistant.reasoning")] @@ -409,8 +601,12 @@ pub enum SessionEventData { AssistantIdle(AssistantIdleData), #[serde(rename = "assistant.usage")] AssistantUsage(AssistantUsageData), + #[serde(rename = "prompt_cache_break")] + PromptCacheBreak(PromptCacheBreakData), #[serde(rename = "model.call_failure")] ModelCallFailure(ModelCallFailureData), + #[serde(rename = "model.call_finished")] + ModelCallFinished(ModelCallFinishedData), #[serde(rename = "model.call_start")] ModelCallStart(ModelCallStartData), #[serde(rename = "abort")] @@ -429,8 +625,12 @@ pub enum SessionEventData { ToolSearchActivated(ToolSearchActivatedData), #[serde(rename = "skill.invoked")] SkillInvoked(SkillInvokedData), + #[serde(rename = "sandbox.decision")] + SandboxDecision(SandboxDecisionData), #[serde(rename = "subagent.started")] SubagentStarted(SubagentStartedData), + #[serde(rename = "subagent.configured")] + SubagentConfigured(SubagentConfiguredData), #[serde(rename = "subagent.completed")] SubagentCompleted(SubagentCompletedData), #[serde(rename = "subagent.failed")] @@ -477,6 +677,15 @@ pub enum SessionEventData { McpHeadersRefreshCompleted(McpHeadersRefreshCompletedData), #[serde(rename = "session.custom_notification")] SessionCustomNotification(SessionCustomNotificationData), + /// + ///
+ /// + /// **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 = "ui.ephemeral_query")] + UiEphemeralQuery(UiEphemeralQueryData), #[serde(rename = "external_tool.requested")] ExternalToolRequested(ExternalToolRequestedData), #[serde(rename = "external_tool.completed")] @@ -534,6 +743,33 @@ 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), + /// + ///
+ /// + /// **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_started")] + FactoryRunStarted(FactoryRunStartedData), + /// + ///
+ /// + /// **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_settled")] + FactoryRunSettled(FactoryRunSettledData), #[serde(rename = "session.skills_loaded")] SessionSkillsLoaded(SessionSkillsLoadedData), #[serde(rename = "session.custom_agents_updated")] @@ -658,6 +894,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, @@ -666,6 +905,24 @@ 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")] @@ -693,6 +950,9 @@ pub struct SessionStartData { /// 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") @@ -734,7 +994,7 @@ pub struct SessionResumeData { /// 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. + /// 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 @@ -759,7 +1019,7 @@ pub struct SessionResumeData { /// 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 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. + /// 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") @@ -813,6 +1073,9 @@ pub struct SessionIdleData { /// True when the preceding agentic loop was cancelled via abort signal #[serde(skip_serializing_if = "Option::is_none")] pub aborted: Option, + /// The session mode the agent was operating in when it went idle, when the mode is known. Lets turn-scoped consumers distinguish an autopilot continuation boundary (where the agent keeps working after this idle) from a genuine turn completion. + #[serde(skip_serializing_if = "Option::is_none")] + pub mode: Option, } /// Session event "session.title_changed". Session title change payload containing the new display title @@ -841,6 +1104,9 @@ pub struct SessionScheduleCreatedData { /// 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`) @@ -919,7 +1185,7 @@ 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 @@ -945,6 +1211,9 @@ pub struct SessionModelChangeData { /// Reasoning summary mode after the model change, if applicable #[serde(skip_serializing_if = "Option::is_none")] pub reasoning_summary: Option, + /// Origin of the effective model change, when known. + #[serde(skip_serializing_if = "Option::is_none")] + pub source: Option, /// Output verbosity level after the model change, if applicable #[serde(skip_serializing_if = "Option::is_none")] pub verbosity: Option, @@ -968,11 +1237,18 @@ pub struct SessionSessionLimitsChangedData { pub session_limits: Option, } -/// Session event "session.permissions_changed". Permissions change details carrying the aggregate allow-all transition. +/// Session event "session.permissions_changed". Permission-mode transition 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 SessionPermissionsChangedData { - /// Allow-all mode after the change + /// Explicit LLM judge model override used by assisted mode; omitted when the provider default applies /// ///
/// @@ -981,10 +1257,8 @@ pub struct SessionPermissionsChangedData { /// ///
#[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 + pub assisted_approval_model: Option, + /// Permission mode after the change /// ///
/// @@ -992,10 +1266,16 @@ pub struct SessionPermissionsChangedData { /// 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, + pub mode: PermissionMode, + /// Permission 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. + /// + ///
+ pub previous_mode: PermissionMode, } /// Session event "session.plan_changed". Plan file operation details indicating what changed @@ -1091,18 +1371,6 @@ pub struct SessionSnapshotRewindData { pub up_to_event_id: String, } -/// Aggregate code change metrics for the session -#[derive(Debug, Clone, Default, Serialize, Deserialize)] -#[serde(rename_all = "camelCase")] -pub struct ShutdownCodeChanges { - /// List of file paths that were modified during the session - pub files_modified: Vec, - /// Total number of lines added during the session - pub lines_added: i64, - /// Total number of lines removed during the session - pub lines_removed: i64, -} - /// Request count and cost metrics #[derive(Debug, Clone, Default, Serialize, Deserialize)] #[serde(rename_all = "camelCase")] @@ -1177,6 +1445,36 @@ pub struct ShutdownModelMetric { pub usage: ShutdownModelMetricUsage, } +/// Usage attributed to one agent instance at session shutdown. +#[derive(Debug, Clone, Default, Serialize, Deserialize)] +#[serde(rename_all = "camelCase")] +pub struct ShutdownAgentMetric { + /// Human-readable label for this subagent invocation, copied from the originating `subagent.started` event. For task-tool subagents this is the invocation's task description rather than the agent's configured display name, so group by `agentName` for stable per-agent labels. + #[serde(skip_serializing_if = "Option::is_none")] + pub agent_display_name: Option, + /// Configured agent name, when this is a subagent + #[serde(skip_serializing_if = "Option::is_none")] + pub agent_name: Option, + /// Per-model usage for this agent, keyed by model identifier + pub model_metrics: HashMap, + /// Time spent in model API calls by this agent, in milliseconds + pub total_api_duration_ms: i64, + /// Accumulated nano-AI units cost for this agent + pub total_nano_aiu: f64, +} + +/// Aggregate code change metrics for the session +#[derive(Debug, Clone, Default, Serialize, Deserialize)] +#[serde(rename_all = "camelCase")] +pub struct ShutdownCodeChanges { + /// List of file paths that were modified during the session + pub files_modified: Vec, + /// Total number of lines added during the session + pub lines_added: i64, + /// Total number of lines removed during the session + pub lines_removed: i64, +} + /// A session-wide shutdown token-type entry storing the accumulated token count. #[derive(Debug, Clone, Default, Serialize, Deserialize)] #[serde(rename_all = "camelCase")] @@ -1189,6 +1487,9 @@ pub struct ShutdownTokenDetail { #[derive(Debug, Clone, Default, Serialize, Deserialize)] #[serde(rename_all = "camelCase")] pub struct SessionShutdownData { + /// Per-agent usage breakdown, keyed by agent instance identifier. The main conversation uses the stable key `main`. + #[serde(skip_serializing_if = "Option::is_none")] + pub agent_metrics: Option>, /// Aggregate code change metrics for the session pub code_changes: ShutdownCodeChanges, /// Non-system message token count at shutdown @@ -1260,6 +1561,10 @@ pub struct SessionUsageCheckpointData { #[doc(hidden)] #[serde(skip_serializing_if = "Option::is_none")] pub(crate) model_cache_state: Option>, + /// Internal per-conversation prompt-cache-break detector baselines restored on resume + #[doc(hidden)] + #[serde(skip_serializing_if = "Option::is_none")] + pub(crate) prompt_cache_break_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 @@ -1289,6 +1594,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, @@ -1321,6 +1629,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")] @@ -1328,15 +1647,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 @@ -1398,6 +1726,9 @@ pub struct CompactionCompleteCompactionTokensUsed { #[derive(Debug, Clone, Default, Serialize, Deserialize)] #[serde(rename_all = "camelCase")] pub struct SessionCompactionCompleteData { + /// Canonical model identifier used for model-specific behavior when replaying compaction + #[serde(skip_serializing_if = "Option::is_none")] + pub behavior_model_id: Option, /// Checkpoint snapshot number created for recovery #[serde(skip_serializing_if = "Option::is_none")] pub checkpoint_number: Option, @@ -1445,19 +1776,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 @@ -1465,13 +1811,216 @@ pub struct SessionTaskCompleteData { pub summary: Option, } -/// 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 { - /// The agent mode that was active when this message was sent - #[serde(skip_serializing_if = "Option::is_none")] - pub agent_mode: Option, +/// Session event "session.fusion_route_started". Experimental transient signal that HydraFusion routing has started for an eligible 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 SessionFusionRouteStartedData { + /// Identifier for this routing attempt before a durable Fusion turn exists. + pub attempt_id: String, + /// HydraFusion routing policy requested for the turn. + #[serde(skip_serializing_if = "Option::is_none")] + pub policy: Option, + /// Synthetic HydraFusion model selected for the session. + #[serde(skip_serializing_if = "Option::is_none")] + pub synthetic_model: Option, + /// Kind of turn being routed. + pub turn_kind: FusionTurnKind, +} + +/// Session event "session.fusion_route_failed". Experimental durable HydraFusion routing failure and the deterministic concrete fallback selected for the 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 SessionFusionRouteFailedData { + /// Identifier of the routing attempt that failed. + pub attempt_id: String, + /// Provider or validation error detail, when available. + #[serde(skip_serializing_if = "Option::is_none")] + pub error_message: Option, + /// Concrete model selected as the deterministic fallback. + pub fallback_model: String, + /// HydraFusion routing policy requested for the turn. + pub policy: String, + /// Stable machine-readable reason for the routing failure. + pub reason: String, + /// Elapsed routing time in milliseconds before the failure. + #[serde(skip_serializing_if = "Option::is_none")] + pub routing_latency_ms: Option, + /// Synthetic HydraFusion model selected for the session. + pub synthetic_model: String, +} + +/// Durable server recommendation for subsequent HydraFusion 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 FusionFollowUpRecommendation { + /// Recommended routing action for the next compaction turn. + pub compaction_turn: FusionFollowUpAction, + /// Recommended routing action for the next user-message turn. + pub user_turn: FusionFollowUpAction, +} + +/// Validated HydraFusion routing capability scores. +/// +///
+/// +/// **Experimental.** This type is part of an experimental wire-protocol surface +/// and may change or be removed in future SDK or CLI releases. +/// +///
+#[derive(Debug, Clone, Default, Serialize, Deserialize)] +#[serde(rename_all = "camelCase")] +pub struct FusionScores { + /// Code-generation capability score returned by the authenticated router. + pub code_gen: f64, + /// Debugging capability score returned by the authenticated router. + pub debugging: f64, + /// Reasoning capability score returned by the authenticated router. + pub reasoning: f64, + /// Tool-use capability score returned by the authenticated router. + pub tool_use: f64, +} + +/// Session event "session.fusion_resolved". Experimental durable validated HydraFusion route and turn policy. +/// +///
+/// +/// **Experimental.** This type is part of an experimental wire-protocol surface +/// and may change or be removed in future SDK or CLI releases. +/// +///
+#[derive(Debug, Clone, Default, Serialize, Deserialize)] +#[serde(rename_all = "camelCase")] +pub struct SessionFusionResolvedData { + /// Version of the validated HydraFusion event contract. + pub contract_version: i64, + /// Concrete model used when the planned primary model cannot execute. + pub fallback_model: String, + /// Router recommendation controlling reuse or rerouting on later turns. + #[serde(skip_serializing_if = "Option::is_none")] + pub follow_up: Option, + /// Concrete model recommended for eligible follow-up turns. + pub follow_up_model: String, + /// Stable identifier for the resolved HydraFusion turn. + pub fusion_id: String, + /// Version of the executable model universe used for selection. + #[serde(skip_serializing_if = "Option::is_none")] + pub model_universe_version: Option, + /// Validated orchestration pattern selected for the turn. + pub pattern: FusionPattern, + /// Version of the validated execution-plan format. + #[serde(skip_serializing_if = "Option::is_none")] + pub plan_version: Option, + /// HydraFusion routing policy used to resolve the plan. + pub policy: String, + /// Version of the local routing policy. + #[serde(skip_serializing_if = "Option::is_none")] + pub policy_version: Option, + /// Concrete model selected for the primary solver phase. + pub primary_model: String, + /// Router implementation that supplied the plan. + #[serde(skip_serializing_if = "Option::is_none")] + pub route_source: Option, + /// Elapsed time in milliseconds required to resolve and validate the route. + #[serde(skip_serializing_if = "Option::is_none")] + pub routing_latency_ms: Option, + /// Identifier of the local policy rule that matched. + #[serde(skip_serializing_if = "Option::is_none")] + pub rule_id: Option, + /// Zero-based index of the local policy rule that matched. + #[serde(skip_serializing_if = "Option::is_none")] + pub rule_index: Option, + /// Human-readable name of the local policy rule that matched. + #[serde(skip_serializing_if = "Option::is_none")] + pub rule_name: Option, + /// Validated capability scores used to select the route. + #[serde(skip_serializing_if = "Option::is_none")] + pub scores: Option, + /// Concrete model selected for the review or judge phase, when required. + pub secondary_model: Option, + /// Synthetic HydraFusion model selected for the session. + pub synthetic_model: String, + /// Identifier of the session turn associated with the route. + pub turn_id: String, +} + +/// Session event "session.fusion_completed". Experimental durable aggregate outcome of a HydraFusion 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 SessionFusionCompletedData { + /// Total cached input tokens reported across all phases. + pub cached_tokens: i64, + /// Total tokens written to prompt cache across all phases. + #[serde(skip_serializing_if = "Option::is_none")] + pub cache_write_tokens: Option, + /// Idempotency identifier for the authoritative final commit. + pub commit_id: String, + /// Reason the turn used a degraded route, when applicable. + pub degraded_reason: Option, + /// Total elapsed execution time for the HydraFusion turn in milliseconds. + pub duration_ms: f64, + /// Concrete model that supplied the authoritative final content. + pub final_source_model: Option, + /// Phase whose output supplied the authoritative final content. + pub final_source_phase_id: Option, + /// Concrete model recommended for eligible follow-up turns. + pub follow_up_model: String, + /// Stable identifier for the completed HydraFusion turn. + pub fusion_id: String, + /// Total input tokens consumed across all phases. + pub input_tokens: i64, + /// Stable aggregate outcome of the HydraFusion turn. + pub outcome: String, + /// Total output tokens produced across all phases. + pub output_tokens: i64, + /// HydraFusion orchestration pattern executed for the turn. + pub pattern: FusionPattern, + /// Number of concrete phases attempted by the turn. + pub phase_count: i64, + /// Total concrete model requests made across all phases. + pub request_count: i64, + /// Synthetic HydraFusion model selected for the session. + pub synthetic_model: String, + /// Total normalized AI-unit cost reported across all phases, in nano-AIU. + pub total_nano_aiu: f64, + /// Identifier of the session turn associated with the completion. + pub turn_id: String, +} + +/// 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 { + /// The agent mode that was active when this message was sent + #[serde(skip_serializing_if = "Option::is_none")] + pub agent_mode: Option, /// Files, selections, or GitHub references attached to the message #[serde(skip_serializing_if = "Option::is_none")] pub attachments: Option>, @@ -1492,7 +2041,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 @@ -1501,6 +2050,9 @@ pub struct UserMessageData { /// Transformed version of the message sent to the model, with XML wrapping, timestamps, and other augmentations for prompt caching #[serde(skip_serializing_if = "Option::is_none")] pub transformed_content: Option, + /// The agent-loop turn ID that consumed this message; absent when no agent-loop turn consumed it + #[serde(skip_serializing_if = "Option::is_none")] + pub turn_id: Option, } /// Session event "pending_messages.modified". Empty payload; the event signals that the pending message queue has changed @@ -1536,6 +2088,48 @@ pub struct AssistantTurnRetryData { pub turn_id: String, } +/// Session event "agent.interrupted". Metadata for work the user interrupted while the agent was running +#[derive(Debug, Clone, Default, Serialize, Deserialize)] +#[serde(rename_all = "camelCase")] +pub struct AgentInterruptedData { + /// What the agent was doing when the user interrupted it + pub activity: AgentInterruptedActivity, + /// For an interrupted model call: the provider endpoint the request targeted + #[serde(skip_serializing_if = "Option::is_none")] + pub api_endpoint: Option, + /// For an interrupted model call: whether the user interrupted before any token arrived or while the response was streaming + #[serde(skip_serializing_if = "Option::is_none")] + pub cancel_phase: Option, + /// How long the interrupted work had been running, in milliseconds + pub elapsed_ms: f64, + /// For an interrupted background-agent batch: how many background sub-agents the stop swept. Counts accepted cancellations, so an agent cancelled as a cascade of its interrupted parent is covered by that parent rather than counted again. + #[serde(skip_serializing_if = "Option::is_none")] + pub interrupted_agent_count: Option, + /// For an interrupted model call: the model the request targeted + #[serde(skip_serializing_if = "Option::is_none")] + pub model: Option, + /// For a mid-stream interrupt: the observed time to first observable output, in milliseconds. Deliberately distinct from the `ttftMs` reported on a successful model call, which measures time to first stream event. + #[serde(skip_serializing_if = "Option::is_none")] + pub output_ttft_ms: Option, + /// For an interrupted model call: the reasoning effort the request asked for + #[serde(skip_serializing_if = "Option::is_none")] + pub reasoning_effort: Option, + /// Subset of `toolNames` whose tool metadata marks the tool name as safe to record unhashed in telemetry. + #[serde(skip_serializing_if = "Option::is_none")] + pub safe_tool_names: Option>, + /// Tool call identifiers that were still running + #[serde(skip_serializing_if = "Option::is_none")] + pub tool_call_ids: Option>, + /// Names of the tools that were still running. More than one when the model requested a parallel fan-out. + #[serde(skip_serializing_if = "Option::is_none")] + pub tool_names: Option>, + /// For an interrupted model call: the transport the request used + #[serde(skip_serializing_if = "Option::is_none")] + pub transport: Option, + /// Zero-based agentic-loop iteration the interrupt landed in + pub turn: i64, +} + /// Session event "assistant.intent". Agent intent description for current activity or plan #[derive(Debug, Clone, Default, Serialize, Deserialize)] #[serde(rename_all = "camelCase")] @@ -1544,6 +2138,163 @@ pub struct AssistantIntentData { pub intent: String, } +/// Session event "assistant.fusion_phase_started". Experimental transient HydraFusion phase/model/role signal. +/// +///
+/// +/// **Experimental.** This type is part of an experimental wire-protocol surface +/// and may change or be removed in future SDK or CLI releases. +/// +///
+#[derive(Debug, Clone, Default, Serialize, Deserialize)] +#[serde(rename_all = "camelCase")] +pub struct AssistantFusionPhaseStartedData { + /// Conversation scope in which the phase executes. + pub conversation_scope: FusionConversationScope, + /// Identifier of the HydraFusion turn containing the phase. + pub fusion_id: String, + /// Concrete model executing the phase. + pub model: String, + /// HydraFusion orchestration pattern containing the phase. + pub pattern: FusionPattern, + /// Stable identifier for the concrete phase. + pub phase_id: String, + /// Kind of phase being executed. + pub phase_kind: FusionPhaseKind, + /// Semantic role assigned to the phase. + pub role: String, +} + +/// Internal durable terminal request staged by a HydraFusion phase until an idempotent final commit selects 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(crate) struct FusionStagedTerminal { + pub arguments: String, + pub assistant_message: serde_json::Value, + pub phase_id: String, + pub tool_call_id: String, + pub tool_name: String, +} + +/// Aggregate concrete-model usage for one HydraFusion 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, Serialize, Deserialize)] +#[serde(rename_all = "camelCase")] +pub struct FusionPhaseUsage { + /// Total cached input tokens reported for the phase. + pub cached_tokens: i64, + /// Total tokens written to prompt cache during the phase. + #[serde(skip_serializing_if = "Option::is_none")] + pub cache_write_tokens: Option, + /// Total input tokens consumed by the phase. + pub input_tokens: i64, + /// Total output tokens produced by the phase. + pub output_tokens: i64, + /// Number of concrete model requests made by the phase. + pub request_count: i64, + /// Total normalized AI-unit cost reported for the phase, in nano-AIU. + pub total_nano_aiu: f64, +} + +/// Session event "assistant.fusion_phase_completed". Experimental durable HydraFusion phase output and lossless replay checkpoint. +/// +///
+/// +/// **Experimental.** This type is part of an experimental wire-protocol surface +/// and may change or be removed in future SDK or CLI releases. +/// +///
+#[derive(Debug, Clone, Default, Serialize, Deserialize)] +#[serde(rename_all = "camelCase")] +pub struct AssistantFusionPhaseCompletedData { + /// Provider-normalized textual output produced by the phase. + pub content: String, + /// Conversation scope in which the phase executed. + pub conversation_scope: FusionConversationScope, + /// Elapsed execution time for the phase in milliseconds. + pub duration_ms: f64, + /// Identifier of the HydraFusion turn containing the phase. + pub fusion_id: String, + /// Concrete model that executed the phase. + pub model: String, + /// Stable identifier for the completed phase. + pub phase_id: String, + /// Kind of phase that completed. + pub phase_kind: FusionPhaseKind, + /// Exact provider-normalized message used to reconstruct canonical model history. + #[doc(hidden)] + #[serde(skip_serializing_if = "Option::is_none")] + pub(crate) projection_message: Option, + /// Projection action for the exact internal message. + #[doc(hidden)] + #[serde(skip_serializing_if = "Option::is_none")] + pub(crate) projection_mode: Option, + /// Semantic role assigned to the completed phase. + pub role: String, + /// Terminal request held outside canonical state until selected by the final commit. + #[doc(hidden)] + #[serde(skip_serializing_if = "Option::is_none")] + pub(crate) staged_terminal: Option, + /// Durable outcome status of the phase. + pub status: FusionPhaseStatus, + /// Aggregate concrete-model usage consumed by the phase. + pub usage: FusionPhaseUsage, + /// Structured judge or critic verdict, when the phase produces one. + pub verdict: Option, +} + +/// Session event "assistant.fusion_phase_failed". Experimental durable typed HydraFusion phase failure and degradation transition. +/// +///
+/// +/// **Experimental.** This type is part of an experimental wire-protocol surface +/// and may change or be removed in future SDK or CLI releases. +/// +///
+#[derive(Debug, Clone, Default, Serialize, Deserialize)] +#[serde(rename_all = "camelCase")] +pub struct AssistantFusionPhaseFailedData { + /// Conversation scope in which the phase executed. + pub conversation_scope: FusionConversationScope, + /// Identifier of the fallback phase used to continue the turn after degradation. + #[serde(skip_serializing_if = "Option::is_none")] + pub degraded_to_phase_id: Option, + /// Elapsed execution time before the phase failed, in milliseconds. + pub duration_ms: f64, + /// Provider or execution error detail, when available. + #[serde(skip_serializing_if = "Option::is_none")] + pub error_message: Option, + /// Identifier of the HydraFusion turn containing the phase. + pub fusion_id: String, + /// Concrete model that attempted the phase. + pub model: String, + /// Stable identifier for the failed phase. + pub phase_id: String, + /// Kind of phase that failed. + pub phase_kind: FusionPhaseKind, + /// Stable machine-readable reason for the phase failure. + pub reason: String, + /// Semantic role assigned to the failed phase. + pub role: String, + /// Durable outcome status of the phase. + pub status: FusionPhaseStatus, + /// Aggregate concrete-model usage consumed before the failure. + pub usage: FusionPhaseUsage, +} + /// 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")] @@ -1564,6 +2315,9 @@ pub struct AssistantReasoningData { pub content: String, /// Unique identifier for this reasoning block pub reasoning_id: String, + /// Per-request treatment/eligibility signal returned by the Copilot API in the `X-GitHub-Copilot-Request-TE` response header for the associated model call; `false` when the header was absent or unparseable. + #[serde(skip_serializing_if = "Option::is_none")] + pub rte: Option, } /// Session event "assistant.reasoning_delta". Streaming reasoning delta for incremental extended thinking updates @@ -1686,6 +2440,66 @@ pub struct Citations { pub spans: Vec, } +/// Experimental attribution linking an ordinary event to the HydraFusion turn, phase, and concrete source that produced 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 FusionAttribution { + /// Idempotency identifier for the authoritative commit, when the event belongs to the selected output. + #[serde(skip_serializing_if = "Option::is_none")] + pub commit_id: Option, + /// Conversation scope in which the concrete phase executed. + #[serde(skip_serializing_if = "Option::is_none")] + pub conversation_scope: Option, + /// Stable identifier for the HydraFusion turn that produced the event. + pub fusion_id: String, + /// HydraFusion orchestration pattern selected for the turn. + pub pattern: String, + /// Identifier of the concrete phase that produced the event. + #[serde(skip_serializing_if = "Option::is_none")] + pub phase_id: Option, + /// Kind of concrete phase that produced the event. + #[serde(skip_serializing_if = "Option::is_none")] + pub phase_kind: Option, + /// HydraFusion routing policy used for the turn. + pub policy: String, + /// Semantic role assigned to the concrete phase. + #[serde(skip_serializing_if = "Option::is_none")] + pub role: Option, + /// Concrete model that produced the attributed event. + #[serde(skip_serializing_if = "Option::is_none")] + pub source_model: Option, + /// Phase whose output supplied the authoritative content, when different from the executing phase. + #[serde(skip_serializing_if = "Option::is_none")] + pub source_phase_id: Option, + /// Synthetic HydraFusion model selected for the session. + pub synthetic_model: String, +} + +/// Neutral provider-tagged reasoning content blocks preserved verbatim for 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 AssistantMessageReasoningBlocks { + /// Provider-native reasoning content blocks (e.g. Anthropic `thinking` / `redacted_thinking`) preserved verbatim, in order. A single response can carry several, each signed over the content preceding it, so dropping or reordering any of them invalidates the rest. + #[serde(skip_serializing_if = "Option::is_none")] + pub blocks: Option>, + /// Model provider that produced these reasoning blocks. + pub provider: String, +} + /// Neutral provider-tagged server-side tool-use payload (tool search, advisor) for verbatim round-tripping /// ///
@@ -1697,13 +2511,18 @@ pub struct Citations { #[derive(Debug, Clone, Default, Serialize, Deserialize)] #[serde(rename_all = "camelCase")] pub struct AssistantMessageServerTools { + /// Advisor model identifier associated with the server-tool payload. #[serde(skip_serializing_if = "Option::is_none")] pub advisor_model: Option, + /// Provider function-call namespaces keyed by function-call identifier. #[serde(skip_serializing_if = "Option::is_none")] pub function_call_namespaces: Option>, + /// Provider-native server-tool call and output items preserved verbatim for replay. #[serde(skip_serializing_if = "Option::is_none")] pub items: Option>, + /// Model provider that produced this server-tool payload. pub provider: String, + /// Raw provider content blocks retained for verbatim round-tripping. #[serde(skip_serializing_if = "Option::is_none")] pub raw_content_blocks: Option>, } @@ -1743,6 +2562,12 @@ pub struct AssistantMessageData { /// 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 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. /// ///
@@ -1761,6 +2586,16 @@ pub struct AssistantMessageData { /// Encrypted reasoning content from OpenAI models. Session-bound and stripped on resume. #[serde(skip_serializing_if = "Option::is_none")] pub encrypted_content: Option, + /// Experimental HydraFusion source attribution for this ordinary authoritative assistant message. + /// + ///
+ /// + /// **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 fusion: Option, /// CAPI interaction ID for correlating this message with upstream telemetry #[serde(skip_serializing_if = "Option::is_none")] pub interaction_id: Option, @@ -1780,6 +2615,9 @@ pub struct AssistantMessageData { /// Generation phase for phased-output models (e.g., thinking vs. response phases) #[serde(skip_serializing_if = "Option::is_none")] pub phase: Option, + /// Neutral provider-tagged reasoning content blocks preserved verbatim for round-tripping. `reasoningText` and `reasoningOpaque` are a lossy derived view of these blocks, retained for display. + #[serde(skip_serializing_if = "Option::is_none")] + pub reasoning_blocks: Option, /// Opaque/encrypted extended thinking data from Anthropic models. Session-bound and stripped on resume. #[serde(skip_serializing_if = "Option::is_none")] pub reasoning_opaque: Option, @@ -1792,6 +2630,9 @@ pub struct AssistantMessageData { /// 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, + /// Per-request treatment/eligibility signal returned by the Copilot API in the `X-GitHub-Copilot-Request-TE` response header for the associated model call; `false` when the header was absent or unparseable. + #[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, @@ -1925,18 +2766,33 @@ pub(crate) struct AssistantUsageQuotaSnapshot { #[derive(Debug, Clone, Default, Serialize, Deserialize)] #[serde(rename_all = "camelCase")] pub struct AssistantUsageData { + /// Number of accepted speculative prediction tokens + #[serde(skip_serializing_if = "Option::is_none")] + pub accepted_prediction_tokens: Option, /// 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, + /// 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, + /// Whether the provider reported prompt-cache usage details for this call + #[doc(hidden)] + #[serde(skip_serializing_if = "Option::is_none")] + pub(crate) cache_details_reported: 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, + /// Effective prompt-cache lifetime in seconds for this call + #[doc(hidden)] + #[serde(skip_serializing_if = "Option::is_none")] + pub(crate) cache_ttl_seconds: Option, /// Number of tokens written to prompt cache #[serde(skip_serializing_if = "Option::is_none")] pub cache_write_tokens: Option, @@ -1962,20 +2818,56 @@ pub struct AssistantUsageData { /// 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, + /// How the prompt-cache frontier was determined for this call + #[doc(hidden)] + #[serde(skip_serializing_if = "Option::is_none")] + pub(crate) frontier_source: Option, + /// Experimental HydraFusion attribution for this concrete model call's usage. + /// + ///
+ /// + /// **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 fusion: 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, + /// Whether Auto mode was selected for this model call + #[serde(skip_serializing_if = "Option::is_none")] + pub is_auto: Option, + /// Whether this model call used a bring-your-own-key provider + #[serde(skip_serializing_if = "Option::is_none")] + pub is_byok: Option, + /// Requested maximum output tokens used for this model call + #[serde(skip_serializing_if = "Option::is_none")] + pub max_output_tokens: Option, + /// Effective maximum prompt-token limit used for this model call + #[serde(skip_serializing_if = "Option::is_none")] + pub max_prompt_tokens: 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, + /// Time to first observable model output in milliseconds. Includes text, reasoning, and tool-call output; only available for streaming requests that produce observable output. + #[serde(skip_serializing_if = "Option::is_none")] + pub output_ttft_ms: Option, /// Parent tool call ID when this usage originates from a sub-agent #[doc(hidden)] #[deprecated] @@ -1991,15 +2883,121 @@ pub struct AssistantUsageData { /// 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, + /// Reasoning summary mode used for this model call, if applicable + #[serde(skip_serializing_if = "Option::is_none")] + pub reasoning_summary: Option, /// Number of output tokens used for reasoning (e.g., chain-of-thought) #[serde(skip_serializing_if = "Option::is_none")] pub reasoning_tokens: Option, + /// Number of rejected speculative prediction tokens + #[serde(skip_serializing_if = "Option::is_none")] + pub rejected_prediction_tokens: Option, + /// Per-request treatment/eligibility signal returned by the Copilot API in the `X-GitHub-Copilot-Request-TE` response header for the associated model call; `false` when the header was absent or unparseable. + #[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, + /// 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, + /// Transport used for this model call (http or websocket) + #[serde(skip_serializing_if = "Option::is_none")] + pub transport: Option, +} + +/// Session event "prompt_cache_break". A detected loss of a previously cached prompt prefix +#[derive(Debug, Clone, Default, Serialize, Deserialize)] +#[serde(rename_all = "camelCase")] +pub struct PromptCacheBreakData { + /// Request state whose cached prefix fell short + #[doc(hidden)] + #[serde(skip_serializing_if = "Option::is_none")] + pub(crate) after_request: Option, + /// Name of the sub-agent whose conversation broke, stamped by the parent bridge + #[doc(hidden)] + #[serde(skip_serializing_if = "Option::is_none")] + pub(crate) agent_name: Option, + /// Request state that established the prior cache frontier + #[doc(hidden)] + #[serde(skip_serializing_if = "Option::is_none")] + pub(crate) before_request: Option, + /// Names of the cache-configuration fields that changed + #[doc(hidden)] + #[serde(skip_serializing_if = "Option::is_none")] + pub(crate) cache_config_changed_fields: Option>, + /// All reasons that contributed to the cache break, ordered by precedence + pub contributing_reasons: Vec, + /// Prior cached prompt frontier in tokens + pub frontier_tokens: i64, + /// Model that held the prior cache frontier, when the call changed models + #[doc(hidden)] + #[serde(skip_serializing_if = "Option::is_none")] + pub(crate) model_from: Option, + /// Model this call targeted, when the call changed models + #[doc(hidden)] + #[serde(skip_serializing_if = "Option::is_none")] + pub(crate) model_to: Option, + /// The highest-precedence reason for the cache break + pub primary_reason: String, + /// Fraction of the prior cache frontier that survived + pub retention_ratio: f64, + /// Index of the first conversation message whose content changed + #[doc(hidden)] + #[serde(skip_serializing_if = "Option::is_none")] + pub(crate) rewrite_message_index: Option, + /// Shape of the history rewrite, for example whether the history grew or shrank + #[doc(hidden)] + #[serde(skip_serializing_if = "Option::is_none")] + pub(crate) rewrite_shape: Option, + /// Subsystems that announced a history rewrite before this call, for example compaction or truncation + #[doc(hidden)] + #[serde(skip_serializing_if = "Option::is_none")] + pub(crate) rewrite_source: Option>, + /// Cached prefix tokens lost since the prior call + pub shortfall_tokens: i64, + /// Number of cached prefix tokens that survived + pub survived_tokens: i64, + /// Names of the system-prompt segments whose content changed + #[doc(hidden)] + #[serde(skip_serializing_if = "Option::is_none")] + pub(crate) system_segments_changed: Option>, + /// Telemetry-safe names of tools added since the prior call + #[doc(hidden)] + #[serde(skip_serializing_if = "Option::is_none")] + pub(crate) tools_added: Option>, + /// Raw names of tools added since the prior call, restricted because a tool name can be user-authored + #[doc(hidden)] + #[serde(skip_serializing_if = "Option::is_none")] + pub(crate) tools_added_raw: Option>, + /// Telemetry-safe names of tools whose definition changed since the prior call + #[doc(hidden)] + #[serde(skip_serializing_if = "Option::is_none")] + pub(crate) tools_redefined: Option>, + /// Raw names of tools redefined since the prior call, restricted because a tool name can be user-authored + #[doc(hidden)] + #[serde(skip_serializing_if = "Option::is_none")] + pub(crate) tools_redefined_raw: Option>, + /// Telemetry-safe names of tools removed since the prior call + #[doc(hidden)] + #[serde(skip_serializing_if = "Option::is_none")] + pub(crate) tools_removed: Option>, + /// Raw names of tools removed since the prior call, restricted because a tool name can be user-authored + #[doc(hidden)] + #[serde(skip_serializing_if = "Option::is_none")] + pub(crate) tools_removed_raw: Option>, + /// Whether the tool list kept its members but changed their order + #[doc(hidden)] + #[serde(skip_serializing_if = "Option::is_none")] + pub(crate) tools_reordered: Option, } /// Content-free structural summary of the failing request for diagnosing malformed 4xx calls @@ -2051,9 +3049,22 @@ pub struct ModelCallFailureData { /// Whether the failure originated from an API response or the request transport #[serde(skip_serializing_if = "Option::is_none")] pub failure_kind: Option, + /// Experimental HydraFusion attribution for this failed concrete model 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 fusion: 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, + /// Authoritative interaction classification for the failed call, matching `assistant.usage.interactionType` (for example `conversation-agent`, `conversation-subagent`, or `conversation-sampling`). Absent when the producer cannot classify the interaction. + #[serde(skip_serializing_if = "Option::is_none")] + pub interaction_type: Option, /// Whether the session selected Auto mode for the failed call #[serde(skip_serializing_if = "Option::is_none")] pub is_auto: Option, @@ -2082,6 +3093,9 @@ pub struct ModelCallFailureData { /// 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, + /// Per-request treatment/eligibility signal returned by the Copilot API in the `X-GitHub-Copilot-Request-TE` response header for the associated model call; `false` when the header was absent or unparseable. + #[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, @@ -2095,13 +3109,47 @@ pub struct ModelCallFailureData { pub transport: Option, } +/// Session event "model.call_finished". Final lifecycle outcome for one logical model dispatch. A logical dispatch may include internal reconnect or fallback work, so event count is not provider HTTP-request count. +#[derive(Debug, Clone, Default, Serialize, Deserialize)] +#[serde(rename_all = "camelCase")] +pub struct ModelCallFinishedData { + /// Whether an accepted successful response requested the exact name and command semantics of a built-in file edit tool, including an external tool explicitly replacing that built-in name. Absent when the logical dispatch did not produce an accepted response. + #[serde(skip_serializing_if = "Option::is_none")] + pub contains_built_in_file_edit_request: Option, + /// Monotonic elapsed time spent in the logical model dispatch, including any internal transport reconnect or fallback and excluding orchestrator retry backoff, tool execution, confirmations, and post-response processing + pub dispatch_duration_ms: f64, + /// Version of the built-in file-edit semantic classifier used for this event + pub edit_classifier_version: i64, + /// Identifier of the user interaction that owns the model dispatch, matching assistant.turn_start.interactionId when available + #[serde(skip_serializing_if = "Option::is_none")] + pub interaction_id: Option, + /// Final outcome after post-response acceptance processing + pub outcome: ModelCallFinishedOutcome, + /// Agent-loop iteration within the interaction that initiated the model dispatch + pub turn_id: String, +} + /// 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 { + /// Experimental HydraFusion attribution for this concrete model 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 fusion: Option, /// 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, } @@ -2131,6 +3179,16 @@ pub struct ToolUserRequestedData { #[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. @@ -2182,6 +3240,16 @@ pub struct ToolExecutionStartData { /// When true, the tool output should be displayed expanded (verbatim) in the CLI timeline #[serde(skip_serializing_if = "Option::is_none")] pub display_verbatim: Option, + /// Experimental HydraFusion attribution for this tool execution. + /// + ///
+ /// + /// **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 fusion: Option, /// Name of the MCP server hosting this tool, when the tool is an MCP tool #[serde(skip_serializing_if = "Option::is_none")] pub mcp_server_name: Option, @@ -2196,6 +3264,9 @@ pub struct ToolExecutionStartData { #[deprecated] #[serde(skip_serializing_if = "Option::is_none")] pub parent_tool_call_id: Option, + /// Per-request treatment/eligibility signal returned by the Copilot API in the `X-GitHub-Copilot-Request-TE` response header for the associated model call; `false` when the header was absent or unparseable. + #[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, @@ -2231,15 +3302,87 @@ pub struct ToolExecutionProgressData { pub tool_call_id: String, } -/// Error details when the tool execution failed +/// Error details when the tool execution failed +#[derive(Debug, Clone, Default, Serialize, Deserialize)] +#[serde(rename_all = "camelCase")] +pub struct ToolExecutionCompleteError { + /// Machine-readable error code + #[serde(skip_serializing_if = "Option::is_none")] + pub code: Option, + /// Human-readable error message + pub message: String, +} + +/// Binary result returned by a tool for the model +#[derive(Debug, Clone, Default, Serialize, Deserialize)] +#[serde(rename_all = "camelCase")] +pub struct PersistedBinaryImage { + /// 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: PersistedBinaryImageType, +} + +/// A binary result whose data was omitted from persistence due to the inline size 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 OmittedBinaryResult { + /// Decoded byte length of the omitted binary data + pub byte_length: i64, + /// 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 omitted binary data + pub mime_type: String, + /// Why the binary data is absent: it exceeded the inline size limit, or its asset was unavailable + pub omitted_reason: OmittedBinaryOmittedReason, + /// Binary result type discriminator. Use "image" for images and "resource" for other binary data. + pub r#type: OmittedBinaryType, +} + +/// A reference to binary data persisted once on a session.binary_asset event and shared 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 ToolExecutionCompleteError { - /// Machine-readable error code +pub struct BinaryAssetReference { + /// Content-addressed id of the session.binary_asset event that holds this binary's bytes (e.g. "sha256:..."). + pub asset_id: String, + /// Decoded byte length of the referenced binary data + pub byte_length: i64, + /// Human-readable description of the binary data #[serde(skip_serializing_if = "Option::is_none")] - pub code: Option, - /// Human-readable error message - pub message: String, + pub description: Option, + /// Optional metadata from the producing tool. + #[serde(skip_serializing_if = "Option::is_none")] + pub metadata: Option>, + /// MIME type of the referenced binary data + pub mime_type: String, + /// Binary result type discriminator. Use "image" for images and "resource" for other binary data. + pub r#type: BinaryAssetReferenceType, } /// A source supplied by a tool that should be made available to the model as citable content. @@ -2305,6 +3448,9 @@ pub struct ToolExecutionCompleteContentShellExit { pub cwd: Option, /// Exit code from the completed shell command pub exit_code: i64, + /// Path reported in the shell session's filesystem namespace when shell output exceeded the configured large-output threshold. + #[serde(skip_serializing_if = "Option::is_none")] + pub output_file_path: Option, /// 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, @@ -2425,12 +3571,16 @@ pub struct ToolExecutionCompleteContentResource { #[derive(Debug, Clone, Default, Serialize, Deserialize)] #[serde(rename_all = "camelCase")] pub struct ToolExecutionCompleteUIResourceMetaUICsp { + /// Domains the UI resource may use as document base URIs. #[serde(skip_serializing_if = "Option::is_none")] pub base_uri_domains: Option>, + /// Domains the UI resource may connect to. #[serde(skip_serializing_if = "Option::is_none")] pub connect_domains: Option>, + /// Domains the UI resource may embed as nested frames. #[serde(skip_serializing_if = "Option::is_none")] pub frame_domains: Option>, + /// Domains from which the UI resource may load scripts, styles, images, and other resources. #[serde(skip_serializing_if = "Option::is_none")] pub resource_domains: Option>, } @@ -2480,11 +3630,13 @@ pub struct ToolExecutionCompleteUIResourceMetaUI { /// 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, + /// Optional dedicated origin for the rendered MCP Apps UI resource. #[serde(skip_serializing_if = "Option::is_none")] pub domain: Option, /// 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, + /// Whether the host should render a border around the MCP Apps UI resource. #[serde(skip_serializing_if = "Option::is_none")] pub prefers_border: Option, } @@ -2530,7 +3682,7 @@ pub struct ToolExecutionCompleteResult { /// ///
#[serde(skip_serializing_if = "Option::is_none")] - pub binary_results_for_llm: Option>, + 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. /// ///
@@ -2609,6 +3761,16 @@ pub struct ToolExecutionCompleteData { /// Error details when the tool execution failed #[serde(skip_serializing_if = "Option::is_none")] pub error: Option, + /// Experimental HydraFusion attribution for this tool completion. + /// + ///
+ /// + /// **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 fusion: Option, /// CAPI interaction ID for correlating this tool execution with upstream telemetry #[serde(skip_serializing_if = "Option::is_none")] pub interaction_id: Option, @@ -2636,6 +3798,9 @@ pub struct ToolExecutionCompleteData { /// Tool execution result on success #[serde(skip_serializing_if = "Option::is_none")] pub result: Option, + /// Per-request treatment/eligibility signal returned by the Copilot API in the `X-GitHub-Copilot-Request-TE` response header for the associated model call; `false` when the header was absent or unparseable. + #[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, @@ -2697,6 +3862,11 @@ pub struct SkillInvokedData { pub trigger: Option, } +/// Session event "sandbox.decision". Payload of `sandbox.decision`, a bounded governance record of what the process sandbox was configured to do and whether it took effect. Discriminated by `kind`. +#[derive(Debug, Clone, Default, Serialize, Deserialize)] +#[serde(rename_all = "camelCase")] +pub struct SandboxDecisionData {} + /// Session event "subagent.started". Sub-agent startup details including parent tool call and agent information #[derive(Debug, Clone, Default, Serialize, Deserialize)] #[serde(rename_all = "camelCase")] @@ -2707,13 +3877,44 @@ pub struct SubagentStartedData { pub agent_display_name: String, /// Internal name of the sub-agent pub agent_name: String, + /// Type of the sub-agent selected at spawn time. + #[serde(skip_serializing_if = "Option::is_none")] + pub agent_type: Option, + /// Whether the sub-agent runs synchronously or in the background. + #[serde(skip_serializing_if = "Option::is_none")] + pub execution_mode: Option, + /// Root id of the factory run that spawned this sub-agent, when it was spawned by one. + #[serde(skip_serializing_if = "Option::is_none")] + pub factory_run_id: Option, /// Model the sub-agent will run with, when known at start. #[serde(skip_serializing_if = "Option::is_none")] pub model: Option, + /// Task-registry ID of the spawning sub-agent. Absent when the root session spawned this child. + #[serde(skip_serializing_if = "Option::is_none")] + pub parent_id: Option, + /// Whether this sub-agent can be resumed. Currently always false. + #[serde(skip_serializing_if = "Option::is_none")] + pub resumable: Option, /// Tool call ID of the parent tool invocation that spawned this sub-agent pub tool_call_id: String, } +/// Session event "subagent.configured". Resolved runtime configuration for a configured sub-agent +#[derive(Debug, Clone, Default, Serialize, Deserialize)] +#[serde(rename_all = "camelCase")] +pub struct SubagentConfiguredData { + /// Resolved context tier, when configured for the model + #[serde(skip_serializing_if = "Option::is_none")] + pub context_tier: Option, + /// Resolved model the sub-agent will run with + pub model: String, + /// Whether the sub-agent accepts follow-up turns + pub multi_turn: bool, + /// Resolved reasoning effort, when configured for the model + #[serde(skip_serializing_if = "Option::is_none")] + pub reasoning_effort: Option, +} + /// Session event "subagent.completed". Sub-agent completion details for successful execution #[derive(Debug, Clone, Default, Serialize, Deserialize)] #[serde(rename_all = "camelCase")] @@ -2722,9 +3923,27 @@ 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, + /// Whether the first model actually dispatched matched the user's configured preference + #[serde(skip_serializing_if = "Option::is_none")] + pub configured_model_matches_actual: Option, + /// Concrete model the user configured for this sub-agent via `/subagents`, when present + #[serde(skip_serializing_if = "Option::is_none")] + pub configured_model_preference: Option, /// Wall-clock duration of the sub-agent execution in milliseconds #[serde(skip_serializing_if = "Option::is_none")] pub duration_ms: Option, + /// Whether the explicit task-call model matched the user's configured preference + #[serde(skip_serializing_if = "Option::is_none")] + pub explicit_model_matches_preference: Option, + /// Explicit model supplied by the parent agent on the task call, when present + #[serde(skip_serializing_if = "Option::is_none")] + pub explicit_model_override: Option, + /// First model for which the sub-agent started an inference request, when one was dispatched + #[serde(skip_serializing_if = "Option::is_none")] + pub first_dispatched_model: Option, /// Model used by the sub-agent #[serde(skip_serializing_if = "Option::is_none")] pub model: Option, @@ -2746,11 +3965,26 @@ pub struct SubagentFailedData { pub agent_display_name: String, /// Internal name of the sub-agent pub agent_name: String, + /// Whether the first model actually dispatched matched the user's configured preference + #[serde(skip_serializing_if = "Option::is_none")] + pub configured_model_matches_actual: Option, + /// Concrete model the user configured for this sub-agent via `/subagents`, when present + #[serde(skip_serializing_if = "Option::is_none")] + pub configured_model_preference: Option, /// Wall-clock duration of the sub-agent execution in milliseconds #[serde(skip_serializing_if = "Option::is_none")] pub duration_ms: Option, /// Error message describing why the sub-agent failed pub error: String, + /// Whether the explicit task-call model matched the user's configured preference + #[serde(skip_serializing_if = "Option::is_none")] + pub explicit_model_matches_preference: Option, + /// Explicit model supplied by the parent agent on the task call, when present + #[serde(skip_serializing_if = "Option::is_none")] + pub explicit_model_override: Option, + /// First model for which the sub-agent started an inference request, when one was dispatched + #[serde(skip_serializing_if = "Option::is_none")] + pub first_dispatched_model: Option, /// Model selected for the sub-agent, when known #[serde(skip_serializing_if = "Option::is_none")] pub model: Option, @@ -2792,6 +4026,9 @@ pub struct HookStartData { /// Input data passed to the hook #[serde(skip_serializing_if = "Option::is_none")] pub input: Option, + /// Tool call ID of the parent tool invocation when this event originates from a sub-agent + #[serde(skip_serializing_if = "Option::is_none")] + pub parent_tool_call_id: Option, } /// Error details when the hook failed @@ -2822,6 +4059,9 @@ pub struct HookEndData { /// Output data produced by the hook #[serde(skip_serializing_if = "Option::is_none")] pub output: Option, + /// Tool call ID of the parent tool invocation when this event originates from a sub-agent + #[serde(skip_serializing_if = "Option::is_none")] + pub parent_tool_call_id: Option, /// Whether the hook completed successfully pub success: bool, } @@ -2877,6 +4117,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, @@ -2907,6 +4150,16 @@ pub struct PermissionRequestShellCommand { pub read_only: bool, } +/// 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")] @@ -2923,6 +4176,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 >>) @@ -2931,6 +4187,9 @@ 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 @@ -2963,6 +4222,9 @@ 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, @@ -2985,6 +4247,9 @@ 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. @@ -3007,6 +4272,19 @@ 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, + /// Advisory runtime permission recommendation. The SDK host remains responsible for deciding the request and may reject it. + /// + ///
+ /// + /// **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 permission_recommendation: Option, /// Whether this MCP tool is read-only (no side effects) pub read_only: bool, /// Name of the MCP server providing the tool @@ -3028,6 +4306,12 @@ 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, @@ -3041,6 +4325,30 @@ pub struct PermissionRequestUrl { pub url: String, } +/// Assisted-approval judge information attached to a permission request. Present only in assisted mode; its absence means 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 PermissionAssistedApproval { + /// 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 assisted-approval safety judge's outcome for this request. + pub recommendation: AssistedApprovalRecommendation, +} + /// Memory operation permission request #[derive(Debug, Clone, Default, Serialize, Deserialize)] #[serde(rename_all = "camelCase")] @@ -3048,6 +4356,16 @@ pub struct PermissionRequestMemory { /// Whether this is a store or vote memory operation #[serde(skip_serializing_if = "Option::is_none")] pub action: Option, + /// Assisted-approval judge information for this request; present only in assisted mode. + /// + ///
+ /// + /// **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 assisted_approval: Option, /// Source references for the stored fact (store only) #[serde(skip_serializing_if = "Option::is_none")] pub citations: Option, @@ -3058,9 +4376,18 @@ 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, + /// Repository name with owner associated with the stored memory (store only) + #[serde(skip_serializing_if = "Option::is_none")] + pub repo_nwo: Option, + /// Scope of the stored memory (store only) + #[serde(skip_serializing_if = "Option::is_none")] + pub scope: Option, /// Topic or subject of the memory (store only) #[serde(skip_serializing_if = "Option::is_none")] pub subject: Option, @@ -3078,6 +4405,12 @@ 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, + /// Whether the tool declared that permission may be skipped unless a deny rule matches + #[serde(skip_serializing_if = "Option::is_none")] + pub skip_permission: Option, /// Tool call ID that triggered this permission request #[serde(skip_serializing_if = "Option::is_none")] pub tool_call_id: Option, @@ -3096,6 +4429,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, @@ -3115,6 +4451,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 @@ -3122,6 +4461,67 @@ 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, + /// Factory-declared AI-credit limit before any run/resume caller override is applied. + #[serde(skip_serializing_if = "Option::is_none")] + pub declared_max_ai_credits: Option, + /// Factory-declared concurrent-subagent limit before any run/resume caller override is applied. + #[serde(skip_serializing_if = "Option::is_none")] + pub declared_max_concurrent_subagents: Option, + /// Factory-declared total-subagent limit before any run/resume caller override is applied. + #[serde(skip_serializing_if = "Option::is_none")] + pub declared_max_total_subagents: Option, + /// Factory-declared active-time limit in seconds before any run/resume caller override is applied. + #[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")] @@ -3132,34 +4532,37 @@ 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. -/// -///
+/// Extension sensitive environment variable access request #[derive(Debug, Clone, Default, Serialize, Deserialize)] #[serde(rename_all = "camelCase")] -pub struct PermissionAutoApproval { - /// Human-readable reason for the judge's recommendation, when available. +pub struct PermissionRequestExtensionEnvAccess { + /// Names of the sensitive environment variables the extension is requesting. Values never appear here. + pub environment_variables: Vec, + /// Name of the extension requesting environment variable access + pub extension_name: String, + /// Permission kind discriminator + pub kind: PermissionRequestExtensionEnvAccessKind, + /// When true, managed policy requires an explicit user decision and automatic approval must be bypassed. #[serde(skip_serializing_if = "Option::is_none")] - pub reason: Option, - /// The auto-approval safety judge's outcome for this request. - pub recommendation: AutoApprovalRecommendation, + 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, } /// 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. + /// Assisted-approval judge information for this request; present only in assisted mode. /// ///
/// @@ -3168,7 +4571,7 @@ pub struct PermissionPromptRequestCommands { /// ///
#[serde(skip_serializing_if = "Option::is_none")] - pub auto_approval: Option, + pub assisted_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 @@ -3179,6 +4582,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, @@ -3191,7 +4597,7 @@ 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. + /// Assisted-approval judge information for this request; present only in assisted mode. /// ///
/// @@ -3200,7 +4606,7 @@ pub struct PermissionPromptRequestWrite { /// ///
#[serde(skip_serializing_if = "Option::is_none")] - pub auto_approval: Option, + pub assisted_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 @@ -3211,6 +4617,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, @@ -3223,7 +4632,7 @@ 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. + /// Assisted-approval judge information for this request; present only in assisted mode. /// ///
/// @@ -3232,11 +4641,14 @@ pub struct PermissionPromptRequestRead { /// ///
#[serde(skip_serializing_if = "Option::is_none")] - pub auto_approval: Option, + pub assisted_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 @@ -3251,7 +4663,7 @@ 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. + /// Assisted-approval judge information for this request; present only in assisted mode. /// ///
/// @@ -3260,9 +4672,22 @@ pub struct PermissionPromptRequestMcp { /// ///
#[serde(skip_serializing_if = "Option::is_none")] - pub auto_approval: Option, + pub assisted_approval: Option, + /// Whether the host may offer a server-wide "approve all tools from this server" blanket. Absent is treated as true; the runtime sends false when managed policy disables bypass-permissions mode, which forbids the server-wide escalation while still allowing per-tool approval. + #[serde(skip_serializing_if = "Option::is_none")] + pub can_offer_server_wide_approval: Option, /// Prompt kind discriminator pub kind: PermissionPromptRequestMcpKind, + /// Advisory runtime permission recommendation. The host remains responsible for deciding the request and may reject it. + /// + ///
+ /// + /// **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 permission_recommendation: Option, /// Name of the MCP server providing the tool pub server_name: String, /// Tool call ID that triggered this permission request @@ -3278,7 +4703,7 @@ 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. + /// Assisted-approval judge information for this request; present only in assisted mode. /// ///
/// @@ -3287,11 +4712,17 @@ pub struct PermissionPromptRequestUrl { /// ///
#[serde(skip_serializing_if = "Option::is_none")] - pub auto_approval: Option, + pub assisted_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, @@ -3312,7 +4743,7 @@ 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. + /// Assisted-approval judge information for this request; present only in assisted mode. /// ///
/// @@ -3321,7 +4752,7 @@ pub struct PermissionPromptRequestMemory { /// ///
#[serde(skip_serializing_if = "Option::is_none")] - pub auto_approval: Option, + pub assisted_approval: Option, /// Source references for the stored fact (store only) #[serde(skip_serializing_if = "Option::is_none")] pub citations: Option, @@ -3350,7 +4781,7 @@ pub struct PermissionPromptRequestCustomTool { /// Arguments to pass to the custom 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. + /// Assisted-approval judge information for this request; present only in assisted mode. /// ///
/// @@ -3359,7 +4790,7 @@ pub struct PermissionPromptRequestCustomTool { /// ///
#[serde(skip_serializing_if = "Option::is_none")] - pub auto_approval: Option, + pub assisted_approval: Option, /// Prompt kind discriminator pub kind: PermissionPromptRequestCustomToolKind, /// Tool call ID that triggered this permission request @@ -3377,7 +4808,7 @@ 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. + /// Assisted-approval judge information for this request; present only in assisted mode. /// ///
/// @@ -3386,7 +4817,7 @@ pub struct PermissionPromptRequestPath { /// ///
#[serde(skip_serializing_if = "Option::is_none")] - pub auto_approval: Option, + pub assisted_approval: Option, /// Prompt kind discriminator pub kind: PermissionPromptRequestPathKind, /// File paths that require explicit approval @@ -3400,7 +4831,7 @@ 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. + /// Assisted-approval judge information for this request; present only in assisted mode. /// ///
/// @@ -3409,7 +4840,7 @@ pub struct PermissionPromptRequestHook { /// ///
#[serde(skip_serializing_if = "Option::is_none")] - pub auto_approval: Option, + pub assisted_approval: Option, /// Optional message from the hook explaining why confirmation is needed #[serde(skip_serializing_if = "Option::is_none")] pub hook_message: Option, @@ -3429,7 +4860,7 @@ 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. + /// Assisted-approval judge information for this request; present only in assisted mode. /// ///
/// @@ -3438,7 +4869,7 @@ pub struct PermissionPromptRequestExtensionManagement { /// ///
#[serde(skip_serializing_if = "Option::is_none")] - pub auto_approval: Option, + pub assisted_approval: Option, /// Name of the extension being managed #[serde(skip_serializing_if = "Option::is_none")] pub extension_name: Option, @@ -3451,11 +4882,71 @@ 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, + /// Assisted-approval judge information for this request; present only in assisted mode. + /// + ///
+ /// + /// **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 assisted_approval: Option, + /// Whether this factory is eligible for persistent approval + pub can_persist_approval: bool, + /// Factory-declared AI-credit limit before any run/resume caller override is applied. + #[serde(skip_serializing_if = "Option::is_none")] + pub declared_max_ai_credits: Option, + /// Factory-declared concurrent-subagent limit before any run/resume caller override is applied. + #[serde(skip_serializing_if = "Option::is_none")] + pub declared_max_concurrent_subagents: Option, + /// Factory-declared total-subagent limit before any run/resume caller override is applied. + #[serde(skip_serializing_if = "Option::is_none")] + pub declared_max_total_subagents: Option, + /// Factory-declared active-time limit in seconds before any run/resume caller override is applied. + #[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. + /// Assisted-approval judge information for this request; present only in assisted mode. /// ///
/// @@ -3464,7 +4955,7 @@ pub struct PermissionPromptRequestExtensionPermissionAccess { /// ///
#[serde(skip_serializing_if = "Option::is_none")] - pub auto_approval: Option, + pub assisted_approval: Option, /// Capabilities the extension is requesting pub capabilities: Vec, /// Name of the extension requesting permission access @@ -3476,6 +4967,31 @@ pub struct PermissionPromptRequestExtensionPermissionAccess { pub tool_call_id: Option, } +/// Extension sensitive environment variable access prompt +#[derive(Debug, Clone, Default, Serialize, Deserialize)] +#[serde(rename_all = "camelCase")] +pub struct PermissionPromptRequestExtensionEnvAccess { + /// Assisted-approval judge information for this request; present only in assisted mode. + /// + ///
+ /// + /// **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 assisted_approval: Option, + /// Names of the sensitive environment variables the extension is requesting. Values never appear here. + pub environment_variables: Vec, + /// Name of the extension requesting environment variable access + pub extension_name: String, + /// Prompt kind discriminator + pub kind: PermissionPromptRequestExtensionEnvAccessKind, + /// Tool call ID that triggered this permission request + #[serde(skip_serializing_if = "Option::is_none")] + pub tool_call_id: Option, +} + /// Session event "permission.requested". Permission request notification requiring client approval with request details #[derive(Debug, Clone, Serialize, Deserialize)] #[serde(rename_all = "camelCase")] @@ -3490,6 +5006,9 @@ 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, } /// Permission response variant indicating the request was approved without persisting an approval rule. @@ -3498,6 +5017,9 @@ pub struct PermissionRequestedData { pub struct PermissionApproved { /// The permission request was approved pub kind: PermissionApprovedKind, + /// Whether a managed approval policy already handled this request + #[serde(skip_serializing_if = "Option::is_none")] + pub managed_approval_handled: Option, } /// Session-scoped tool-approval rule for specific shell command identifiers. @@ -3567,6 +5089,17 @@ pub struct UserToolSessionApprovalExtensionManagement { pub operation: Option, } +/// 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")] @@ -3577,6 +5110,18 @@ pub struct UserToolSessionApprovalExtensionPermissionAccess { pub kind: UserToolSessionApprovalExtensionPermissionAccessKind, } +/// Session-scoped tool-approval rule for an extension's access to sensitive environment variables, keyed by extension name and the exact set of variable names. +#[derive(Debug, Clone, Default, Serialize, Deserialize)] +#[serde(rename_all = "camelCase")] +pub struct UserToolSessionApprovalExtensionEnvAccess { + /// Names of the sensitive environment variables this approval covers. Values are never persisted. + pub environment_variables: Vec, + /// Extension name + pub extension_name: String, + /// Extension environment access approval kind + pub kind: UserToolSessionApprovalExtensionEnvAccessKind, +} + /// 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")] @@ -3585,6 +5130,9 @@ pub struct PermissionApprovedForSession { pub approval: UserToolSessionApproval, /// Approved and remembered for the rest of the session pub kind: PermissionApprovedForSessionKind, + /// Whether a managed approval policy already handled this request + #[serde(skip_serializing_if = "Option::is_none")] + pub managed_approval_handled: Option, } /// Permission response variant that approves a request and persists the provided approval to a project location key. @@ -3597,6 +5145,9 @@ pub struct PermissionApprovedForLocation { pub kind: PermissionApprovedForLocationKind, /// The location key (git root or cwd) to persist the approval to pub location_key: String, + /// Whether a managed approval policy already handled this request + #[serde(skip_serializing_if = "Option::is_none")] + pub managed_approval_handled: Option, } /// Permission response variant indicating the request was cancelled before use, with an optional reason. @@ -3923,10 +5474,36 @@ pub struct SessionCustomNotificationData { pub source: String, /// Optional source-defined string identifiers describing the payload subject #[serde(skip_serializing_if = "Option::is_none")] - pub subject: Option>, - /// Optional source-defined payload schema version + pub subject: Option>, + /// Optional source-defined payload schema version + #[serde(skip_serializing_if = "Option::is_none")] + pub version: Option, +} + +/// Session event "ui.ephemeral_query". Ordered output and terminal state for a transient query that does not modify 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 UiEphemeralQueryData { + /// Full response text, present for the `completed` phase. + #[serde(skip_serializing_if = "Option::is_none")] + pub answer: Option, + /// Ordered text delta, present for the `chunk` phase. #[serde(skip_serializing_if = "Option::is_none")] - pub version: Option, + pub chunk: Option, + /// Model or transport failure message, present for the `failed` phase. + #[serde(skip_serializing_if = "Option::is_none")] + pub error: Option, + /// Current query lifecycle phase. + pub phase: UIEphemeralQueryPhase, + /// Runtime-minted query identifier. + pub request_id: RequestId, } /// Session event "external_tool.requested". External tool invocation request for client-side tool execution @@ -3936,6 +5513,9 @@ pub struct ExternalToolRequestedData { /// Arguments to pass to the external tool #[serde(skip_serializing_if = "Option::is_none")] pub arguments: Option, + /// Stable provider identity captured with an extension-owned tool definition; hosts use it to route the request to the same provider that was offered to the model + #[serde(skip_serializing_if = "Option::is_none")] + pub provider_id: Option, /// Unique identifier for this request; used to respond via session.respondToExternalTool() pub request_id: RequestId, /// Session ID that this external tool request belongs to @@ -4066,6 +5646,9 @@ pub struct SessionLimitsExhaustedCompletedData { #[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>, @@ -4074,18 +5657,42 @@ pub struct SessionAutoModeResolvedData { 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 where they came from, so SDK clients can show users what is enterprise-managed and by which authority. 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; for a session-independent pull, use the SDK `getManagedSettings()` API, which returns the identical payload. Managed settings have a single authoritative source, so the highest-authority present layer (server > device) wins wholesale; `bypassPermissionsDisabled` is deny-wins across layers. Marked experimental while the managed-settings surface stabilizes. +/// 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. /// ///
/// @@ -4098,18 +5705,27 @@ pub struct SessionAutoModeResolvedData { 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 the device (MDM/plist/registry/file) managed-settings layer was present + /// 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 effective sandbox policy forces the sandbox on *only* because managed policy could not be determined, rather than because the policy requires it. Lets clients tell a user whose `--no-sandbox` was overridden that the sandbox stayed on as a fail-closed fallback, instead of attributing it to an administrator who set no such policy. + #[serde(skip_serializing_if = "Option::is_none")] + pub sandbox_enabled_by_undetermined_policy: 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, - /// Which channel supplied the effective managed settings (the winning layer), or `none` when no policy is in force + /// 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, } @@ -4186,6 +5802,9 @@ pub struct CapabilitiesChangedData { pub struct ExitPlanModeRequestedData { /// Available actions the user can take pub actions: Vec, + /// Model the session had selected when the plan was authored, when one is known + #[serde(skip_serializing_if = "Option::is_none")] + pub model: Option, /// Full content of the plan file pub plan_content: String, /// Recommended action to preselect for the user @@ -4229,6 +5848,68 @@ pub struct SessionToolsUpdatedData { #[serde(rename_all = "camelCase")] pub struct SessionBackgroundTasksChangedData {} +/// 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, + /// Factory run identifier. + pub run_id: String, +} + +/// Session event "factory.run_started". Ephemeral signal that a factory run attempt began executing. +/// +///
+/// +/// **Experimental.** This type is part of an experimental wire-protocol surface +/// and may change or be removed in future SDK or CLI releases. +/// +///
+#[derive(Debug, Clone, Default, Serialize, Deserialize)] +#[serde(rename_all = "camelCase")] +pub struct FactoryRunStartedData { + /// Attempt number this start committed; a resumed run increments it. + pub attempt: i64, + /// Name of the factory this run executes. Low cardinality by construction. + pub factory_name: String, + /// Identifier of the factory run that started. + pub run_id: String, +} + +/// Session event "factory.run_settled". Ephemeral signal that a factory run reached a terminal 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 FactoryRunSettledData { + /// AI credits this run consumed, in nano-AIU. + pub consumed_nano_aiu: i64, + /// Subagents this run consumed against its limits. + pub consumed_subagents: i64, + /// Active milliseconds accumulated across every attempt of this run. + pub elapsed_ms: i64, + /// Typed failure class recorded on the run, when it failed with one (e.g. `factory_limit_reached`). + #[serde(skip_serializing_if = "Option::is_none")] + pub failure_type: Option, + /// Identifier of the factory run that settled. + pub run_id: String, + /// Terminal status the run committed. + pub status: FactoryRunSettledStatus, +} + /// 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")] @@ -4236,6 +5917,9 @@ 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 @@ -4312,7 +5996,7 @@ 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")] @@ -4336,7 +6020,7 @@ 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, } @@ -4703,6 +6387,39 @@ pub enum Verbosity { Unknown, } +/// The session mode the agent is operating in +#[derive(Debug, Clone, Default, PartialEq, Eq, Serialize, Deserialize)] +pub enum SessionMode { + /// 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, +} + +/// 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)] + Unknown, +} + /// The type of operation performed on the autopilot objective state file #[derive(Debug, Clone, Default, PartialEq, Eq, Serialize, Deserialize)] pub enum AutopilotObjectiveChangedOperation { @@ -4742,25 +6459,49 @@ pub enum AutopilotObjectiveChangedStatus { Unknown, } -/// The session mode the agent is operating in +/// Origin of an effective session model change. #[derive(Debug, Clone, Default, PartialEq, Eq, Serialize, Deserialize)] -pub enum SessionMode { - /// 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, +pub enum ModelChangeSource { + /// The user selected a model directly with `/model `. + #[serde(rename = "model_command")] + ModelCommand, + /// The user selected the model with `/settings`. + #[serde(rename = "settings_command")] + SettingsCommand, + /// The user selected the model with the `/config` alias. + #[serde(rename = "config_command")] + ConfigCommand, + /// The user selected the model in the model picker, including the picker opened by bare `/model`. + #[serde(rename = "model_picker")] + ModelPicker, + /// Organization-managed settings selected the model. + #[serde(rename = "managed_settings")] + ManagedSettings, + /// Repository settings selected the model. + #[serde(rename = "repo_settings")] + RepoSettings, + /// Startup model resolution selected the model. + #[serde(rename = "startup")] + Startup, + /// Selecting an agent selected its configured model. + #[serde(rename = "agent")] + Agent, + /// Entering, leaving, or reconfiguring plan mode selected the model. + #[serde(rename = "plan_mode")] + PlanMode, + /// The runtime selected the model automatically, such as rate-limit recovery or refusal fallback. + #[serde(rename = "automatic")] + Automatic, + /// An SDK or RPC caller selected the model. + #[serde(rename = "sdk")] + Sdk, /// Unknown variant for forward compatibility. #[default] #[serde(other)] Unknown, } -/// Allow-all mode for the session. +/// Permission mode for the session. /// ///
/// @@ -4769,16 +6510,16 @@ pub enum SessionMode { /// ///
#[derive(Debug, Clone, Default, PartialEq, Eq, Serialize, Deserialize)] -pub enum PermissionAllowAllMode { +pub enum PermissionMode { /// Permission requests follow the normal approval flow. - #[serde(rename = "off")] - Off, + #[serde(rename = "manual")] + Manual, + /// Permission requests include an LLM safety recommendation; clients may automatically approve requests judged acceptable. + #[serde(rename = "assisted")] + Assisted, /// 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, + #[serde(rename = "allow-all")] + AllowAll, /// Unknown variant for forward compatibility. #[default] #[serde(other)] @@ -4848,6 +6589,117 @@ 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, +} + +/// Kind of turn for which HydraFusion routing 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, PartialEq, Eq, Serialize, Deserialize)] +pub enum FusionTurnKind { + /// A user-message turn. + #[serde(rename = "user")] + User, + /// A conversation-compaction turn. + #[serde(rename = "compaction")] + Compaction, + /// Unknown variant for forward compatibility. + #[default] + #[serde(other)] + Unknown, +} + +/// Server-recommended routing behavior for a later HydraFusion 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 FusionFollowUpAction { + /// Reuse the durable primary model without routing. + #[serde(rename = "reuse_primary")] + ReusePrimary, + /// Request a new routing decision. + #[serde(rename = "reroute")] + Reroute, + /// Unknown variant for forward compatibility. + #[default] + #[serde(other)] + Unknown, +} + +/// Validated HydraFusion execution pattern. +/// +///
+/// +/// **Experimental.** This type 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 FusionPattern { + /// Run one primary solver phase. + #[serde(rename = "single")] + Single, + /// Run a primary phase, a judge, and an optional repair. + #[serde(rename = "cascade")] + Cascade, + /// Run a primary draft, a read-only critique, and a revision. + #[serde(rename = "critique")] + Critique, + /// 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 { @@ -4871,16 +6723,176 @@ pub enum UserMessageAgentMode { /// 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, +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, +} + +/// What the agent was doing when the user interrupted it. +#[derive(Debug, Clone, Default, PartialEq, Eq, Serialize, Deserialize)] +pub enum AgentInterruptedActivity { + /// A request to the model was open. + #[serde(rename = "model_call")] + ModelCall, + /// The turn was sleeping between retry attempts. + #[serde(rename = "retry_backoff")] + RetryBackoff, + /// One or more tools were executing. + #[serde(rename = "tool_call")] + ToolCall, + /// Background sub-agents were running while the main loop was idle. + #[serde(rename = "background_agent")] + BackgroundAgent, + /// Unknown variant for forward compatibility. + #[default] + #[serde(other)] + Unknown, +} + +/// Where the interruption landed relative to the first streamed token. +#[derive(Debug, Clone, Default, PartialEq, Eq, Serialize, Deserialize)] +pub enum AgentInterruptedCancelPhase { + /// No output had been produced when the request was cancelled. + #[serde(rename = "pre_first_token")] + PreFirstToken, + /// The response was already streaming when the request was cancelled. + #[serde(rename = "mid_stream")] + MidStream, + /// Unknown variant for forward compatibility. + #[default] + #[serde(other)] + 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, +} + +/// Conversation scope in which a HydraFusion phase executes. +/// +///
+/// +/// **Experimental.** This type 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 FusionConversationScope { + /// Canonical root conversation history. + #[serde(rename = "root")] + Root, + /// Isolated read-only review history that does not enter the root conversation. + #[serde(rename = "review")] + Review, + /// Unknown variant for forward compatibility. + #[default] + #[serde(other)] + Unknown, +} + +/// HydraFusion phase 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 FusionPhaseKind { + /// Primary solver phase. + #[serde(rename = "primary")] + Primary, + /// Read-only cascade judge phase. + #[serde(rename = "judge")] + Judge, + /// Cascade repair phase. + #[serde(rename = "repair")] + Repair, + /// Initial critique-pattern draft phase. + #[serde(rename = "draft")] + Draft, + /// Read-only critique phase. + #[serde(rename = "critic")] + Critic, + /// Critique-pattern revision phase. + #[serde(rename = "revision")] + Revision, + /// Follow-up phase continuing from the resolved model. + #[serde(rename = "follow_up")] + FollowUp, + /// Unknown variant for forward compatibility. + #[default] + #[serde(other)] + Unknown, +} + +/// How a durable phase checkpoint contributes its exact message to canonical root 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, PartialEq, Eq, Serialize, Deserialize)] +pub enum FusionProjectionMode { + /// Append the exact root message immediately. + #[serde(rename = "append")] + Append, + /// Hold a terminal message outside canonical history until the final commit selects it. + #[serde(rename = "staged")] + Staged, + /// Do not project the checkpoint into root history. + #[serde(rename = "none")] + None, + /// Unknown variant for forward compatibility. + #[default] + #[serde(other)] + Unknown, +} + +/// Durable outcome status of a HydraFusion 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 FusionPhaseStatus { + /// The phase completed successfully. + #[serde(rename = "succeeded")] + Succeeded, + /// The phase failed. + #[serde(rename = "failed")] + Failed, + /// The phase was cancelled. + #[serde(rename = "cancelled")] + Cancelled, /// Unknown variant for forward compatibility. #[default] #[serde(other)] @@ -4948,6 +6960,21 @@ pub enum AssistantUsageApiEndpoint { Unknown, } +/// Transport used for a successful model call +#[derive(Debug, Clone, Default, PartialEq, Eq, Serialize, Deserialize)] +pub enum AssistantUsageTransport { + /// HTTP transport, including SSE streams. + #[serde(rename = "http")] + Http, + /// WebSocket transport. + #[serde(rename = "websocket")] + Websocket, + /// Unknown variant for forward compatibility. + #[default] + #[serde(other)] + 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 { @@ -4996,15 +7023,21 @@ pub enum ModelCallFailureSource { Unknown, } -/// Transport used for a failed model call +/// Final outcome of one logical model dispatch after response acceptance processing #[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, +pub enum ModelCallFinishedOutcome { + /// The provider response was accepted for continued agent processing. + #[serde(rename = "success")] + Success, + /// The dispatch ended with a provider or transport error. + #[serde(rename = "error")] + Error, + /// The dispatch was cancelled before an accepted response was produced. + #[serde(rename = "cancelled")] + Cancelled, + /// The provider response was rejected during post-response acceptance processing. + #[serde(rename = "rejected")] + Rejected, /// Unknown variant for forward compatibility. #[default] #[serde(other)] @@ -5023,6 +7056,9 @@ 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)] @@ -5044,6 +7080,82 @@ pub enum ToolExecutionStartToolDescriptionMetaUIVisibility { Unknown, } +/// Binary result type discriminator. Use "image" for images and "resource" for other binary data. +#[derive(Debug, Clone, Default, PartialEq, Eq, Serialize, Deserialize)] +pub enum PersistedBinaryImageType { + /// Binary image data. + #[serde(rename = "image")] + Image, + /// Other binary resource data. + #[serde(rename = "resource")] + Resource, + /// Unknown variant for forward compatibility. + #[default] + #[serde(other)] + Unknown, +} + +/// Why the binary data is absent: it exceeded the inline size limit, or its asset was unavailable +#[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, +} + +/// Binary result type discriminator. Use "image" for images and "resource" for other binary data. +#[derive(Debug, Clone, Default, PartialEq, Eq, Serialize, Deserialize)] +pub enum OmittedBinaryType { + /// Binary image data. + #[serde(rename = "image")] + Image, + /// Other binary resource data. + #[serde(rename = "resource")] + Resource, + /// Unknown variant for forward compatibility. + #[default] + #[serde(other)] + Unknown, +} + +/// Binary result type discriminator. Use "image" for images and "resource" for other binary data. +#[derive(Debug, Clone, Default, PartialEq, Eq, Serialize, Deserialize)] +pub enum BinaryAssetReferenceType { + /// Binary image data. + #[serde(rename = "image")] + Image, + /// Other binary resource data. + #[serde(rename = "resource")] + Resource, + /// Unknown variant for forward compatibility. + #[default] + #[serde(other)] + Unknown, +} + +/// A model-facing binary result as persisted: full inline data, a size-omitted marker, or a deduplicated asset 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, Serialize, Deserialize)] +#[serde(untagged)] +pub enum PersistedBinaryResult { + PersistedBinaryImage(PersistedBinaryImage), + OmittedBinaryResult(OmittedBinaryResult), + BinaryAssetReference(BinaryAssetReference), +} + /// Content block type discriminator #[derive(Debug, Clone, Default, PartialEq, Eq, Serialize, Deserialize)] pub enum ToolExecutionCompleteContentTextType { @@ -5231,6 +7343,25 @@ pub enum PermissionRequestMcpKind { Mcp, } +/// Advisory recommendation the runtime attaches to a permission request whose origin it can vouch for by construction. Unlike the auto-approval judge this does not depend on auto mode and does not evaluate what the tool call does; its absence simply means the runtime has no opinion and the request follows the host's normal approval flow. +/// +///
+/// +/// **Experimental.** This type 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 PermissionRecommendation { + /// The runtime vouches for the request's origin and recommends approving it without prompting. The host still owns the decision and may deny it; deny rules, managed policy, and the auto-approval safety judge all outrank this recommendation. + #[serde(rename = "approve")] + Approve, + /// Unknown variant for forward compatibility. + #[default] + #[serde(other)] + Unknown, +} + /// Permission kind discriminator #[derive(Debug, Clone, Default, PartialEq, Eq, Serialize, Deserialize)] pub enum PermissionRequestUrlKind { @@ -5254,6 +7385,65 @@ pub enum PermissionRequestMemoryAction { Unknown, } +/// Why the assisted-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 AssistedApprovalJudgeFailureReason { + /// 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 assisted-approval safety judge for a permission request. Present only in assisted mode; its absence means the judge did not evaluate the 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 AssistedApprovalRecommendation { + /// The judge evaluated the request and recommends automatically approving it. + #[serde(rename = "approve")] + Approve, + /// The judge evaluated the request and does not recommend automatically approving it; explicit approval is required. Whether that means prompting, denying, or something else is the consumer's decision. + #[serde(rename = "requireApproval")] + RequireApproval, + /// Assisted mode is enabled, but this request category is never automatically 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, +} + /// Vote direction (vote only) #[derive(Debug, Clone, Default, PartialEq, Eq, Serialize, Deserialize)] pub enum PermissionRequestMemoryDirection { @@ -5277,6 +7467,21 @@ pub enum PermissionRequestMemoryKind { Memory, } +/// Scope of a stored memory. +#[derive(Debug, Clone, Default, PartialEq, Eq, Serialize, Deserialize)] +pub enum PermissionRequestMemoryScope { + /// Store the memory for the current repository. + #[serde(rename = "repository")] + Repository, + /// Store the memory for the current user. + #[serde(rename = "user")] + User, + /// Unknown variant for forward compatibility. + #[default] + #[serde(other)] + Unknown, +} + /// Permission kind discriminator #[derive(Debug, Clone, Default, PartialEq, Eq, Serialize, Deserialize)] pub enum PermissionRequestCustomToolKind { @@ -5301,6 +7506,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 { @@ -5309,6 +7537,14 @@ pub enum PermissionRequestExtensionPermissionAccessKind { ExtensionPermissionAccess, } +/// Permission kind discriminator +#[derive(Debug, Clone, Default, PartialEq, Eq, Serialize, Deserialize)] +pub enum PermissionRequestExtensionEnvAccessKind { + #[serde(rename = "extension-env-access")] + #[default] + ExtensionEnvAccess, +} + /// Details of the permission being requested #[derive(Debug, Clone, Serialize, Deserialize)] #[serde(untagged)] @@ -5322,35 +7558,9 @@ pub enum PermissionRequest { CustomTool(PermissionRequestCustomTool), Hook(PermissionRequestHook), ExtensionManagement(PermissionRequestExtensionManagement), + Factory(PermissionRequestFactory), ExtensionPermissionAccess(PermissionRequestExtensionPermissionAccess), -} - -/// 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, + ExtensionEnvAccess(PermissionRequestExtensionEnvAccess), } /// Prompt kind discriminator @@ -5451,6 +7661,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 { @@ -5459,6 +7677,14 @@ pub enum PermissionPromptRequestExtensionPermissionAccessKind { ExtensionPermissionAccess, } +/// Prompt kind discriminator +#[derive(Debug, Clone, Default, PartialEq, Eq, Serialize, Deserialize)] +pub enum PermissionPromptRequestExtensionEnvAccessKind { + #[serde(rename = "extension-env-access")] + #[default] + ExtensionEnvAccess, +} + /// Derived user-facing permission prompt details for UI consumers #[derive(Debug, Clone, Serialize, Deserialize)] #[serde(untagged)] @@ -5473,7 +7699,9 @@ pub enum PermissionPromptRequest { Path(PermissionPromptRequestPath), Hook(PermissionPromptRequestHook), ExtensionManagement(PermissionPromptRequestExtensionManagement), + Factory(PermissionPromptRequestFactory), ExtensionPermissionAccess(PermissionPromptRequestExtensionPermissionAccess), + ExtensionEnvAccess(PermissionPromptRequestExtensionEnvAccess), } /// The permission request was approved @@ -5540,6 +7768,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 { @@ -5548,6 +7784,14 @@ pub enum UserToolSessionApprovalExtensionPermissionAccessKind { ExtensionPermissionAccess, } +/// Extension environment access approval kind +#[derive(Debug, Clone, Default, PartialEq, Eq, Serialize, Deserialize)] +pub enum UserToolSessionApprovalExtensionEnvAccessKind { + #[serde(rename = "extension-env-access")] + #[default] + ExtensionEnvAccess, +} + /// The approval to add as a session-scoped rule #[derive(Debug, Clone, Serialize, Deserialize)] #[serde(untagged)] @@ -5559,7 +7803,9 @@ pub enum UserToolSessionApproval { Memory(UserToolSessionApprovalMemory), CustomTool(UserToolSessionApprovalCustomTool), ExtensionManagement(UserToolSessionApprovalExtensionManagement), + Factory(UserToolSessionApprovalFactory), ExtensionPermissionAccess(UserToolSessionApprovalExtensionPermissionAccess), + ExtensionEnvAccess(UserToolSessionApprovalExtensionEnvAccess), } /// Approved and remembered for the rest of the session @@ -5764,6 +8010,37 @@ pub enum McpHeadersRefreshCompletedOutcome { Unknown, } +/// Lifecycle phase for a Rust-owned ephemeral query stream. +/// +///
+/// +/// **Experimental.** This type 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 UIEphemeralQueryPhase { + /// The ephemeral query stream has begun. + #[serde(rename = "started")] + Started, + /// A partial result chunk was produced by the stream. + #[serde(rename = "chunk")] + Chunk, + /// The ephemeral query stream finished successfully. + #[serde(rename = "completed")] + Completed, + /// The ephemeral query stream ended with an error. + #[serde(rename = "failed")] + Failed, + /// The ephemeral query stream was cancelled before completing. + #[serde(rename = "aborted")] + Aborted, + /// 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 { @@ -5821,16 +8098,22 @@ pub enum AutoModeResolvedReasoningBucket { Unknown, } -/// Which channel supplied the effective enterprise managed settings (highest-authority present layer wins wholesale) +/// 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 { - /// Account/org policy self-fetched from the GitHub managed-settings endpoint (higher authority). + /// Only the server/account channel contributed. #[serde(rename = "server")] Server, - /// Device-level MDM policy discovered from plist/registry/file (lower authority). + /// Only the device MDM/plist/registry/file channel contributed. #[serde(rename = "device")] Device, - /// No managed policy is in force (no layer contributed). + /// 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. @@ -5854,21 +8137,24 @@ pub enum ManagedSettingsEnforcedAction { /// 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. + /// Full allow-all permissions β€” automatically approving tools, paths, and URLs. #[serde(rename = "allow_all")] AllowAll, - /// Auto-approval of all tool permission requests. + /// Automatic 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, + /// Assisted mode β€” keeps normal prompt paths and adds an LLM recommendation, distinct from allow-all. + #[serde(rename = "assisted_approval")] + AssistedApproval, /// Unrestricted filesystem access outside the session's allowed directories. #[serde(rename = "unrestricted_paths")] UnrestrictedPaths, /// Unrestricted URL fetch access. #[serde(rename = "unrestricted_urls")] UnrestrictedUrls, + /// A server-wide MCP "Always Allow" (or `--allow-tool `) blanket that would auto-approve every tool from an MCP server. Capped to per-tool approval; each tool still prompts. + #[serde(rename = "server_wide_mcp_approval")] + ServerWideMcpApproval, /// Unknown variant for forward compatibility. #[default] #[serde(other)] @@ -5896,6 +8182,27 @@ pub enum ExitPlanModeAction { Unknown, } +/// Terminal status a factory run committed. A settled run is never `pending` or `running`, so those two members of the run-status domain are deliberately absent. +#[derive(Debug, Clone, Default, PartialEq, Eq, Serialize, Deserialize)] +pub enum FactoryRunSettledStatus { + /// The factory body resolved and its result was committed. + #[serde(rename = "completed")] + Completed, + /// The run was stopped by a limit, an approval refusal or another policy decision. + #[serde(rename = "halted")] + Halted, + /// The run was cancelled by its caller or by session disposal. + #[serde(rename = "cancelled")] + Cancelled, + /// The run failed, with `failureType` carrying the class when it has one. + #[serde(rename = "error")] + Error, + /// Unknown variant for forward compatibility. + #[default] + #[serde(other)] + Unknown, +} + /// Source location type (e.g., project, personal-copilot, plugin, builtin) #[derive(Debug, Clone, Default, PartialEq, Eq, Serialize, Deserialize)] pub enum SkillSource { @@ -5947,7 +8254,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. @@ -5965,6 +8272,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, diff --git a/rust/src/github_token.rs b/rust/src/github_token.rs new file mode 100644 index 0000000000..c5eaa63adf --- /dev/null +++ b/rust/src/github_token.rs @@ -0,0 +1,378 @@ +//! Session-scoped GitHub token provider callbacks. + +use std::collections::HashMap; +use std::future::Future; +use std::sync::{Arc, OnceLock, Weak}; + +use async_trait::async_trait; +use parking_lot::Mutex; +use serde_json::Value; + +use crate::generated::api_types::{ + GitHubTokenAcquireReason, GitHubTokenAcquireRequest, GitHubTokenAcquireResult, + GitHubTokenAcquireResultCancelled, GitHubTokenAcquireResultToken, +}; +use crate::{Client, ClientInner, JsonRpcError, JsonRpcRequest, JsonRpcResponse, error_codes}; + +/// Why the runtime is requesting a GitHub token. +#[derive(Debug, Clone, Copy, PartialEq, Eq)] +pub enum GitHubTokenRequestReason { + /// The session needs its initial token. + Initial, + /// The session needs a refreshed token. + Refresh, +} + +/// Context supplied when the runtime needs a GitHub token for a session. +#[derive(Debug, Clone, PartialEq, Eq)] +pub struct GitHubTokenProviderArgs { + /// Effective GitHub host for which a token is required. + pub host: String, + /// Session receiving the token, when the runtime has assigned its ID. + pub session_id: Option, + /// Whether this is the initial token acquisition or a refresh. + pub reason: GitHubTokenRequestReason, +} + +/// A GitHub access token returned by a session token provider. +/// +/// `expires_in_seconds` is the positive remaining lifetime when the callback +/// completes. Production GitHub tokens typically last eight hours. +pub struct GitHubToken { + access_token: String, + expires_in_seconds: i64, + token_type: Option, +} + +impl GitHubToken { + /// Construct a token response with its remaining lifetime in seconds. + pub fn new(access_token: impl Into, expires_in_seconds: i64) -> Self { + Self { + access_token: access_token.into(), + expires_in_seconds, + token_type: None, + } + } + + /// Override the OAuth token type. The runtime defaults to `bearer` when unset. + pub fn with_token_type(mut self, token_type: impl Into) -> Self { + self.token_type = Some(token_type.into()); + self + } + + fn into_wire(self) -> GitHubTokenAcquireResultToken { + GitHubTokenAcquireResultToken { + access_token: self.access_token, + expires_in: self.expires_in_seconds, + kind: Default::default(), + token_type: self.token_type, + } + } +} + +impl std::fmt::Debug for GitHubToken { + fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result { + f.debug_struct("GitHubToken") + .field("access_token", &"") + .field("expires_in_seconds", &self.expires_in_seconds) + .field("token_type", &self.token_type) + .finish() + } +} + +/// Result of acquiring a session-scoped GitHub token. +pub enum GitHubTokenProviderResult { + /// A token was acquired. + Token(GitHubToken), + /// The host cancelled acquisition. + Cancelled, +} + +impl std::fmt::Debug for GitHubTokenProviderResult { + fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result { + match self { + Self::Token(token) => f.debug_tuple("Token").field(token).finish(), + Self::Cancelled => f.write_str("Cancelled"), + } + } +} + +/// Async callback used to acquire GitHub tokens for one session. +#[async_trait] +pub trait GitHubTokenProvider: Send + Sync { + /// Acquire a token or explicitly cancel the request. + /// + /// Initial cancellation, errors, and invalid token responses reject session + /// creation or resume instead of falling back to ambient authentication. + async fn get_token( + &self, + args: GitHubTokenProviderArgs, + ) -> Result; +} + +#[async_trait] +impl GitHubTokenProvider for F +where + F: Fn(GitHubTokenProviderArgs) -> Fut + Send + Sync, + Fut: Future> + Send, +{ + async fn get_token( + &self, + args: GitHubTokenProviderArgs, + ) -> Result { + (self)(args).await + } +} + +#[derive(Default)] +struct RegistryState { + providers: HashMap>, + session_owners: HashMap, +} + +pub(crate) struct GitHubTokenRegistry { + state: Mutex, + client: OnceLock>, +} + +impl GitHubTokenRegistry { + pub(crate) fn new() -> Self { + Self { + state: Mutex::new(RegistryState::default()), + client: OnceLock::new(), + } + } + + pub(crate) fn set_client(&self, client: Weak) { + let _ = self.client.set(client); + } + + pub(crate) fn register(&self, provider: Arc) -> String { + let registration_id = uuid::Uuid::new_v4().to_string(); + self.state + .lock() + .providers + .insert(registration_id.clone(), provider); + registration_id + } + + pub(crate) fn claim(&self, registration_id: &str, session_id: crate::SessionId) { + let mut state = self.state.lock(); + if let Some(previous) = state + .session_owners + .insert(session_id, registration_id.to_string()) + && previous != registration_id + { + state.providers.remove(&previous); + } + } + + pub(crate) fn unregister(&self, registration_id: &str) { + let mut state = self.state.lock(); + state.providers.remove(registration_id); + state + .session_owners + .retain(|_, owned| owned != registration_id); + } + + pub(crate) fn retire_session(&self, session_id: &crate::SessionId) { + let mut state = self.state.lock(); + if let Some(registration_id) = state.session_owners.remove(session_id) { + state.providers.remove(®istration_id); + } + } + + pub(crate) fn clear(&self) { + let mut state = self.state.lock(); + state.providers.clear(); + state.session_owners.clear(); + } + + pub(crate) async fn dispatch(&self, request: JsonRpcRequest) { + let Some(inner) = self.client.get().and_then(Weak::upgrade) else { + return; + }; + let client = Client::from_inner(inner); + let params = request + .params + .clone() + .unwrap_or(Value::Object(serde_json::Map::new())); + let params: GitHubTokenAcquireRequest = match serde_json::from_value(params) { + Ok(params) => params, + Err(error) => { + send_error( + &client, + request.id, + error_codes::INVALID_PARAMS, + &format!("invalid params: {error}"), + ) + .await; + return; + } + }; + let provider = self + .state + .lock() + .providers + .get(¶ms.registration_id) + .cloned(); + let Some(provider) = provider else { + send_error( + &client, + request.id, + error_codes::INTERNAL_ERROR, + "unknown GitHub token provider registration", + ) + .await; + return; + }; + + let reason = match params.reason { + GitHubTokenAcquireReason::Initial => GitHubTokenRequestReason::Initial, + GitHubTokenAcquireReason::Refresh => GitHubTokenRequestReason::Refresh, + GitHubTokenAcquireReason::Unknown => { + send_error( + &client, + request.id, + error_codes::INVALID_PARAMS, + "unknown GitHub token acquisition reason", + ) + .await; + return; + } + }; + + match provider + .get_token(GitHubTokenProviderArgs { + host: params.host, + session_id: params.session_id, + reason, + }) + .await + { + Ok(GitHubTokenProviderResult::Token(token)) => { + respond( + &client, + request.id, + GitHubTokenAcquireResult::Token(token.into_wire()), + ) + .await; + } + Ok(GitHubTokenProviderResult::Cancelled) => { + respond( + &client, + request.id, + GitHubTokenAcquireResult::Cancelled(GitHubTokenAcquireResultCancelled { + kind: Default::default(), + }), + ) + .await; + } + Err(error) => { + send_error( + &client, + request.id, + error_codes::INTERNAL_ERROR, + &format!("GitHub token provider failed: {error}"), + ) + .await; + } + } + } +} + +pub(crate) struct GitHubTokenRegistration { + registry: Arc, + id: String, +} + +impl GitHubTokenRegistration { + pub(crate) fn new(registry: Arc, id: String) -> Self { + Self { registry, id } + } + + pub(crate) fn id(&self) -> &str { + &self.id + } + + pub(crate) fn claim(&self, session_id: crate::SessionId) { + self.registry.claim(&self.id, session_id); + } +} + +impl Drop for GitHubTokenRegistration { + fn drop(&mut self) { + self.registry.unregister(&self.id); + } +} + +async fn respond(client: &Client, request_id: u64, result: GitHubTokenAcquireResult) { + match serde_json::to_value(result) { + Ok(result) => { + let _ = client + .send_response(&JsonRpcResponse { + jsonrpc: "2.0".to_string(), + id: request_id, + result: Some(result), + error: None, + }) + .await; + } + Err(_) => { + send_error( + client, + request_id, + error_codes::INTERNAL_ERROR, + "serialization failure", + ) + .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(JsonRpcError { + code, + message: message.to_string(), + data: None, + }), + }) + .await; +} + +#[cfg(test)] +mod tests { + use super::*; + + #[test] + fn token_debug_is_redacted() { + let token = GitHubToken::new("do-not-print", 28_800); + assert!(!format!("{token:?}").contains("do-not-print")); + } + + #[test] + fn retiring_session_removes_its_provider() { + let registry = GitHubTokenRegistry::new(); + let provider = Arc::new(|_args: GitHubTokenProviderArgs| async { + Ok(GitHubTokenProviderResult::Cancelled) + }); + let registration_id = registry.register(provider); + let session_id = crate::SessionId::from("session-1"); + registry.claim(®istration_id, session_id.clone()); + + registry.retire_session(&session_id); + + assert!( + !registry + .state + .lock() + .providers + .contains_key(®istration_id) + ); + } +} diff --git a/rust/src/handler.rs b/rust/src/handler.rs index 3287a4f093..e036b75a10 100644 --- a/rust/src/handler.rs +++ b/rust/src/handler.rs @@ -22,7 +22,7 @@ use crate::generated::api_types::{ McpOauthPendingRequestResponse, McpOauthPendingRequestResponseCancelled, McpOauthPendingRequestResponseCancelledKind, McpOauthPendingRequestResponseToken, McpOauthPendingRequestResponseTokenKind, PermissionDecision, PermissionDecisionApproveOnce, - PermissionDecisionReject, PermissionDecisionUserNotAvailable, + PermissionDecisionContext, PermissionDecisionReject, PermissionDecisionUserNotAvailable, }; use crate::session_events::{ McpOauthRequestReason, McpOauthRequiredStaticClientConfig, McpOauthWWWAuthenticateParams, @@ -35,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, @@ -50,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 @@ -75,14 +99,51 @@ 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, + /// response_capability: None, + /// 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 { @@ -273,9 +334,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; @@ -285,9 +349,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() + } } } @@ -322,10 +394,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 @@ -337,7 +448,10 @@ mod tests { .await; assert!(matches!( result, - PermissionResult::Decision(PermissionDecision::Reject(_)) + PermissionResult::Decision { + decision: PermissionDecision::Reject(_), + .. + } )); } diff --git a/rust/src/hooks.rs b/rust/src/hooks.rs index a2b61ed8b9..4986d6cb18 100644 --- a/rust/src/hooks.rs +++ b/rust/src/hooks.rs @@ -199,6 +199,32 @@ 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")] @@ -381,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. @@ -430,6 +463,8 @@ 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. @@ -449,6 +484,7 @@ impl HookOutput { Self::PostToolUse(_) => "PostToolUse", Self::PostToolUseFailure(_) => "PostToolUseFailure", Self::UserPromptSubmitted(_) => "UserPromptSubmitted", + Self::UserPromptTransformed(_) => "UserPromptTransformed", Self::SessionStart(_) => "SessionStart", Self::SessionEnd(_) => "SessionEnd", Self::ErrorOccurred(_) => "ErrorOccurred", @@ -506,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 @@ -583,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( @@ -660,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 } @@ -708,6 +763,9 @@ 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)?), @@ -753,6 +811,14 @@ mod tests { ..Default::default() }) } + HookEvent::UserPromptTransformed { input, .. } => { + HookOutput::UserPromptTransformed(UserPromptTransformedOutput { + modified_transformed_prompt: Some(format!( + "[transformed] {}", + input.transformed_prompt + )), + }) + } _ => HookOutput::None, } } @@ -813,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; diff --git a/rust/src/jsonrpc.rs b/rust/src/jsonrpc.rs index fbdc96505b..25a405080b 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 f998d72255..4a9f73ca4c 100644 --- a/rust/src/lib.rs +++ b/rust/src/lib.rs @@ -22,6 +22,8 @@ pub mod copilot_request_handler; /// `#[doc(hidden)]` β€” re-exports the generated telemetry payload types. #[doc(hidden)] pub mod github_telemetry; +/// Session-scoped GitHub token provider callbacks. +pub mod github_token; /// Event handler traits for session lifecycle. pub mod handler; /// Lifecycle hook callbacks (pre/post tool use, prompt submission, session start/end). @@ -78,6 +80,10 @@ use std::sync::{Arc, OnceLock}; use std::time::{Duration, Instant}; use async_trait::async_trait; +pub use github_token::{ + GitHubToken, GitHubTokenProvider, GitHubTokenProviderArgs, GitHubTokenProviderResult, + GitHubTokenRequestReason, +}; /// 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. @@ -254,6 +260,11 @@ pub struct ClientOptions { pub env_remove: Vec, /// 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 @@ -368,6 +379,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", @@ -632,6 +647,7 @@ impl Default for ClientOptions { 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, @@ -724,6 +740,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; @@ -997,6 +1026,7 @@ struct ClientInner { request_rx: parking_lot::Mutex>>, notification_tx: broadcast::Sender, router: router::SessionRouter, + github_token_registry: Arc, negotiated_protocol_version: OnceLock, state: parking_lot::Mutex, lifecycle_tx: broadcast::Sender, @@ -1071,6 +1101,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 { .. }) { @@ -1333,6 +1387,14 @@ impl Client { 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| { @@ -1368,6 +1430,7 @@ impl Client { &client.inner.request_rx, Some(dispatcher.clone()), client.inner.on_github_telemetry.clone(), + client.inner.github_token_registry.clone(), ); client.rpc().llm_inference().set_provider().await?; let llm_inference_elapsed = llm_inference_start.elapsed(); @@ -1548,6 +1611,7 @@ impl Client { let pid = child.as_ref().and_then(|c| c.id()); info!(pid = ?pid, "copilot CLI client ready"); + let github_token_registry = Arc::new(github_token::GitHubTokenRegistry::new()); let client = Self { inner: Arc::new(ClientInner { child: parking_lot::Mutex::new(child), @@ -1558,6 +1622,7 @@ impl Client { request_rx: parking_lot::Mutex::new(Some(request_rx)), notification_tx: notification_broadcast_tx, router: router::SessionRouter::new(), + github_token_registry: github_token_registry.clone(), negotiated_protocol_version: OnceLock::new(), state: parking_lot::Mutex::new(ConnectionState::Connected), lifecycle_tx: broadcast::channel(256).0, @@ -1573,6 +1638,7 @@ impl Client { startup_timings: OnceLock::new(), }), }; + github_token_registry.set_client(Arc::downgrade(&client.inner)); client.spawn_lifecycle_dispatcher(); debug!( elapsed_ms = setup_start.elapsed().as_millis(), @@ -1586,8 +1652,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 { @@ -1611,7 +1677,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"); @@ -1624,6 +1690,7 @@ impl Client { 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); } @@ -1990,6 +2057,7 @@ impl Client { &self.inner.request_rx, self.inner.llm_inference.get().cloned(), self.inner.on_github_telemetry.clone(), + self.inner.github_token_registry.clone(), ); self.inner.router.register(session_id) } @@ -1999,6 +2067,25 @@ impl Client { self.inner.router.unregister(session_id); } + pub(crate) fn register_github_token_provider( + &self, + provider: Arc, + ) -> github_token::GitHubTokenRegistration { + 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.github_token_registry.clone(), + ); + let id = self.inner.github_token_registry.register(provider); + github_token::GitHubTokenRegistration::new(self.inner.github_token_registry.clone(), id) + } + + pub(crate) fn retire_github_token_provider(&self, session_id: &SessionId) { + self.inner.github_token_registry.retire_session(session_id); + } + /// Returns the protocol version negotiated with the CLI server, if any. /// /// Set during [`start`](Self::start). Returns `None` if the server didn't @@ -2107,6 +2194,7 @@ impl Client { .on_github_telemetry .is_some() .then_some(true), + ..Default::default() }; let value = self .call( @@ -2193,9 +2281,66 @@ impl Client { Some(serde_json::json!({ "sessionId": session_id })), ) .await?; + self.retire_github_token_provider(session_id); 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(), + self.inner.github_token_registry.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); + } + self.inner.github_token_registry.clear(); + + 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 @@ -2344,6 +2489,7 @@ impl Client { } self.inner.router.unregister(&session_id); } + self.inner.github_token_registry.clear(); let should_shutdown_runtime = self.inner.child.lock().is_some(); #[cfg(feature = "bundled-in-process")] @@ -2470,6 +2616,7 @@ impl Client { // Drop all session channels so any awaiters see a closed channel // instead of waiting for responses that will never arrive. self.inner.router.clear(); + self.inner.github_token_registry.clear(); *self.inner.state.lock() = ConnectionState::Disconnected; *self.inner.models_cache.lock() = Arc::new(tokio::sync::OnceCell::new()); } @@ -3161,6 +3308,105 @@ 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 { @@ -3178,6 +3424,7 @@ mod tests { request_rx: parking_lot::Mutex::new(None), notification_tx: broadcast::channel(16).0, router: router::SessionRouter::new(), + github_token_registry: Arc::new(github_token::GitHubTokenRegistry::new()), negotiated_protocol_version: OnceLock::new(), state: parking_lot::Mutex::new(ConnectionState::Connected), lifecycle_tx: broadcast::channel(16).0, diff --git a/rust/src/mode.rs b/rust/src/mode.rs index 580a57bbd3..2b1ab897ce 100644 --- a/rust/src/mode.rs +++ b/rust/src/mode.rs @@ -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 { @@ -283,10 +291,35 @@ pub(crate) fn memory_for_mode( } } +/// 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() @@ -510,4 +543,28 @@ mod tests { 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 2ddd773a30..57c0785708 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/router.rs b/rust/src/router.rs index adc1923824..1dec9d16f3 100644 --- a/rust/src/router.rs +++ b/rust/src/router.rs @@ -87,6 +87,7 @@ impl SessionRouter { request_rx: &Mutex>>, llm_inference: Option>, github_telemetry: Option, + github_token_registry: Arc, ) { let mut started = self.started.lock(); if *started { @@ -181,6 +182,10 @@ impl SessionRouter { let sessions = self.sessions.clone(); tokio::spawn(async move { while let Some(request) = rx.recv().await { + if request.method == "gitHubToken.getToken" { + github_token_registry.dispatch(request).await; + continue; + } // Client-global `llmInference.*` requests carry no routable // session and are handled by the inference dispatcher. if request.method.starts_with("llmInference.") { diff --git a/rust/src/session.rs b/rust/src/session.rs index 89162346e4..b9d2173055 100644 --- a/rust/src/session.rs +++ b/rust/src/session.rs @@ -12,12 +12,12 @@ use tracing::{Instrument, warn}; use crate::canvas::CanvasHandler; use crate::generated::api_types::{ - LogRequest, ModelSwitchToRequest, OpenCanvasInstance, RegisterEventInterestParams, - ToolsGetCurrentMetadataResult, rpc_methods, + LogRequest, ModelSwitchToRequest, OpenCanvasInstance, PermissionDecisionRequest, + RegisterEventInterestParams, ToolsGetCurrentMetadataResult, rpc_methods, }; use crate::generated::session_events::{ CommandExecuteData, ElicitationRequestedData, ExternalToolRequestedData, McpOauthRequiredData, - SessionCanvasClosedData, SessionErrorData, SessionEventType, + SessionCanvasClosedData, SessionErrorData, SessionEventType, SessionIdleData, SessionMode, }; use crate::handler::{ AutoModeSwitchHandler, AutoModeSwitchResponse, ElicitationHandler, ExitPlanModeHandler, @@ -57,6 +57,7 @@ const TOOL_SEARCH_TOOL_NAME: &str = "tool_search_tool"; #[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>, @@ -65,6 +66,13 @@ pub(crate) struct SessionHandlers { 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>>, @@ -182,6 +190,8 @@ pub struct Session { open_canvases: Arc>>, /// Broadcast channel for runtime event subscribers β€” see [`Session::subscribe`]. event_tx: tokio::sync::broadcast::Sender, + github_token_registration: + ParkingLotMutex>, } impl Session { @@ -532,12 +542,20 @@ impl Session { pub async fn set_model(&self, model: &str, opts: Option) -> Result<(), Error> { let opts = opts.unwrap_or_default(); let request = ModelSwitchToRequest { + compaction_decision: None, + context_tier: opts.context_tier, + defer_if_model_change_queued: None, + model_capabilities: opts.model_capabilities, + model_change_scope: None, model_id: model.to_string(), + picker_persistence: None, reasoning_effort: opts.reasoning_effort, reasoning_summary: opts.reasoning_summary, + repo_scope: None, + require_available: None, + run_compaction_preflight: None, + source: None, verbosity: None, - context_tier: opts.context_tier, - model_capabilities: opts.model_capabilities, }; self.rpc().model().switch_to(request).await?; Ok(()) @@ -568,6 +586,7 @@ impl Session { .await?; self.stop_event_loop().await; self.client.unregister_session(&self.id); + self.github_token_registration.lock().take(); Ok(()) } @@ -645,6 +664,7 @@ impl Drop for Session { // it here because Drop is sync. self.shutdown.cancel(); self.client.unregister_session(&self.id); + self.github_token_registration.lock().take(); } } @@ -850,6 +870,8 @@ impl Client { 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); @@ -879,10 +901,13 @@ 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 opt_included_builtin_skills = config.included_builtin_skills.take(); 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); @@ -893,6 +918,10 @@ 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(), @@ -909,6 +938,13 @@ impl Client { 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 github_token_registration = runtime + .github_token_provider + .take() + .map(|provider| self.register_github_token_provider(provider)); + wire.github_token_provider_registration_id = github_token_registration + .as_ref() + .map(|registration| registration.id().to_string()); 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()); @@ -1066,6 +1102,7 @@ impl Client { capabilities, open_canvases, event_tx, + github_token_registration: ParkingLotMutex::new(github_token_registration), }; apply_mode_post_create_patch( &session, @@ -1074,8 +1111,14 @@ impl Client { opt_custom_agents_local_only, opt_coauthor_enabled, opt_manage_schedule_enabled, + opt_included_builtin_skills, ) .await?; + if let Some(registration) = session.github_token_registration.lock().as_ref() { + registration.claim(session.id.clone()); + } else { + self.retire_github_token_provider(&session.id); + } Ok(session) } @@ -1115,6 +1158,8 @@ impl Client { 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); @@ -1144,10 +1189,13 @@ 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 opt_included_builtin_skills = config.included_builtin_skills.take(); let (mut wire, mut runtime) = config.into_wire()?; wire.enable_github_telemetry_forwarding = self.inner.on_github_telemetry.is_some().then_some(true); @@ -1158,6 +1206,10 @@ 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(), @@ -1174,6 +1226,13 @@ impl Client { 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 github_token_registration = runtime + .github_token_provider + .take() + .map(|provider| self.register_github_token_provider(provider)); + wire.github_token_provider_registration_id = github_token_registration + .as_ref() + .map(|registration| registration.id().to_string()); 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()); @@ -1318,6 +1377,7 @@ impl Client { capabilities, open_canvases, event_tx, + github_token_registration: ParkingLotMutex::new(github_token_registration), }; apply_mode_post_create_patch( &session, @@ -1326,8 +1386,14 @@ impl Client { opt_custom_agents_local_only, opt_coauthor_enabled, opt_manage_schedule_enabled, + opt_included_builtin_skills, ) .await?; + if let Some(registration) = session.github_token_registration.lock().as_ref() { + registration.claim(session.id.clone()); + } else { + self.retire_github_token_provider(&session.id); + } Ok(session) } } @@ -1341,7 +1407,42 @@ async fn apply_mode_post_create_patch( opt_custom_agents_local_only: Option, opt_coauthor_enabled: Option, opt_manage_schedule_enabled: Option, + opt_included_builtin_skills: Option>, ) -> Result<(), Error> { + let Some(patch) = build_mode_post_create_patch( + mode, + opt_skip_custom_instructions, + opt_custom_agents_local_only, + opt_coauthor_enabled, + opt_manage_schedule_enabled, + opt_included_builtin_skills, + ) else { + return Ok(()); + }; + if let Err(error) = session.rpc().options().update(patch).await { + let _ = session.disconnect().await; + return Err(error); + } + Ok(()) +} + +/// Builds the `session.options.update` patch applied immediately after a session +/// is created or resumed, or returns `None` when no patch should be sent. +/// +/// Under [`ClientMode::Empty`](crate::ClientMode::Empty) the overridable feature +/// flags fall back to safe defaults (caller values win), while +/// `installed_plugins` is unconditionally empty. `included_builtin_skills` +/// defaults to an empty list, but callers can explicitly allow selected +/// runtime-bundled skills. Under other modes only explicitly-set fields are +/// forwarded. +fn build_mode_post_create_patch( + mode: crate::ClientMode, + opt_skip_custom_instructions: Option, + opt_custom_agents_local_only: Option, + opt_coauthor_enabled: Option, + opt_manage_schedule_enabled: Option, + opt_included_builtin_skills: Option>, +) -> Option { use crate::generated::api_types::SessionUpdateOptionsParams; let mut patch = SessionUpdateOptionsParams::default(); let should_send = if mode == crate::ClientMode::Empty { @@ -1350,6 +1451,7 @@ async fn apply_mode_post_create_patch( patch.coauthor_enabled = Some(opt_coauthor_enabled.unwrap_or(false)); patch.manage_schedule_enabled = Some(opt_manage_schedule_enabled.unwrap_or(false)); patch.installed_plugins = Some(Vec::new()); + patch.included_builtin_skills = Some(opt_included_builtin_skills.unwrap_or_default()); true } else { let mut any = false; @@ -1369,16 +1471,16 @@ async fn apply_mode_post_create_patch( patch.manage_schedule_enabled = Some(v); any = true; } + if let Some(v) = opt_included_builtin_skills { + patch.included_builtin_skills = Some(v); + any = true; + } any }; if !should_send { - return Ok(()); + return None; } - if let Err(error) = session.rpc().options().update(patch).await { - let _ = session.disconnect().await; - return Err(error); - } - Ok(()) + Some(patch) } fn build_command_handler_map(commands: Option<&[CommandDefinition]>) -> Arc { @@ -1519,17 +1621,60 @@ 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> { @@ -1556,6 +1701,12 @@ fn tool_failure_result(message: impl Into) -> ToolResult { }) } +fn is_autopilot_continuation_idle(event: &SessionEvent) -> bool { + event + .typed_data::() + .is_some_and(|data| data.mode == Some(SessionMode::Autopilot)) +} + /// Process a notification from the CLI's broadcast channel. #[allow(clippy::too_many_arguments)] async fn handle_notification( @@ -1600,6 +1751,7 @@ async fn handle_notification( } waiter.last_assistant_message = Some(event.clone()); } + SessionEventType::SessionIdle if is_autopilot_continuation_idle(&event) => {} SessionEventType::SessionIdle | SessionEventType::SessionError => { if let Some(waiter) = guard.take() { if event_type == SessionEventType::SessionIdle { @@ -1704,14 +1856,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, @@ -1729,7 +1877,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). @@ -1738,12 +1887,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!( @@ -2513,31 +2658,305 @@ fn inject_transform_sections_resume( mod tests { use serde_json::json; - use super::notification_permission_payload; + use super::{ + build_mode_post_create_patch, has_managed_settings, is_autopilot_continuation_idle, + permission_request_data, permission_response_params, + }; use crate::handler::PermissionResult; + use crate::types::{ + PermissionDecisionContext, PermissionDecisionOutcome, PermissionDecisionSource, + PermissionDecisionSurface, RequestId, SessionEvent, SessionId, + }; + + #[test] + fn identifies_only_autopilot_continuation_idles() { + let mut event = SessionEvent { + id: "event-1".to_string(), + timestamp: "2026-01-01T00:00:00Z".to_string(), + parent_id: None, + ephemeral: None, + agent_id: None, + debug_cli_received_at_ms: None, + debug_ws_forwarded_at_ms: None, + event_type: "session.idle".to_string(), + data: json!({ "mode": "autopilot" }), + }; + + assert!(is_autopilot_continuation_idle(&event)); + + event.data = json!({ "mode": "interactive" }); + assert!(!is_autopilot_continuation_idle(&event)); + + event.data = json!({}); + assert!(!is_autopilot_continuation_idle(&event)); + } + + #[test] + fn empty_mode_post_patch_sets_empty_included_builtin_skills() { + let patch = + build_mode_post_create_patch(crate::ClientMode::Empty, None, None, None, None, None) + .expect("empty mode always sends a patch"); + assert_eq!( + patch.included_builtin_skills, + Some(Vec::new()), + "empty mode must fail closed with an empty includedBuiltinSkills list" + ); + assert_eq!(patch.installed_plugins.as_ref().map(|p| p.len()), Some(0)); + // Serializes as an explicit empty array (not omitted). + let value = serde_json::to_value(&patch).expect("serialize patch"); + assert_eq!(value["includedBuiltinSkills"], serde_json::json!([])); + } #[test] - fn notification_payload_suppresses_no_result() { - assert!(notification_permission_payload(&PermissionResult::NoResult).is_none()); + fn empty_mode_post_patch_preserves_explicit_builtin_skill_allowlist() { + let patch = build_mode_post_create_patch( + crate::ClientMode::Empty, + Some(false), + Some(false), + Some(true), + Some(true), + Some(vec!["code-review".to_string()]), + ) + .expect("empty mode always sends a patch"); + assert_eq!( + patch.included_builtin_skills, + Some(vec!["code-review".to_string()]) + ); } #[test] - fn notification_payload_serializes_decisions() { + fn copilot_cli_mode_does_not_inject_included_builtin_skills() { + // No fields set -> no patch at all. + assert!( + build_mode_post_create_patch( + crate::ClientMode::CopilotCli, + None, + None, + None, + None, + None + ) + .is_none() + ); + // A field set -> patch sent, but skills field stays absent. + let patch = build_mode_post_create_patch( + crate::ClientMode::CopilotCli, + Some(true), + None, + None, + None, + None, + ) + .expect("a set field triggers a patch"); + assert_eq!(patch.included_builtin_skills, None); + assert!(patch.installed_plugins.is_none()); + let value = serde_json::to_value(&patch).expect("serialize patch"); + assert!(value.get("includedBuiltinSkills").is_none()); + + let patch = build_mode_post_create_patch( + crate::ClientMode::CopilotCli, + None, + None, + None, + None, + Some(vec!["code-review".to_string()]), + ) + .expect("an explicit allowlist triggers a patch"); assert_eq!( - notification_permission_payload(&PermissionResult::approve_once()), - Some(json!({ "kind": "approve-once" })) + patch.included_builtin_skills, + Some(vec!["code-review".to_string()]) ); + } + + #[test] + 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, + response_capability: None, + source: PermissionDecisionSource::AssistedApproval, + 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 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::reject(None)), - Some(json!({ "kind": "reject" })) + params, + json!({ + "sessionId": "session-1", + "requestId": "permission-1", + "result": { "kind": "approve-once" }, + "decisionContext": { + "outcome": "auto_approved", + "source": "assisted_approval", + "surface": "copilot_app", + }, + }) + ); + // 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, + response_capability: None, + 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_fs.rs b/rust/src/session_fs.rs index da4d3e3c96..87868101f5 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 9c5780d37f..c84981ac0c 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/types.rs b/rust/src/types.rs index 163e1d29c0..6e451eb452 100644 --- a/rust/src/types.rs +++ b/rust/src/types.rs @@ -24,6 +24,7 @@ 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::github_token::GitHubTokenProvider; use crate::handler::{ AutoModeSwitchHandler, ElicitationHandler, ExitPlanModeHandler, McpAuthHandler, PermissionHandler, UserInputHandler, @@ -33,7 +34,8 @@ 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; @@ -345,6 +347,12 @@ 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 @@ -469,6 +477,18 @@ 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`]). @@ -511,6 +531,7 @@ 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( @@ -594,12 +615,9 @@ impl std::fmt::Debug for CommandDefinition { impl Serialize for CommandDefinition { fn serialize(&self, serializer: S) -> Result { use serde::ser::SerializeStruct; - let len = if self.description.is_some() { 2 } else { 1 }; - let mut state = serializer.serialize_struct("CommandDefinition", len)?; + let mut state = serializer.serialize_struct("CommandDefinition", 2)?; state.serialize_field("name", &self.name)?; - if let Some(description) = &self.description { - state.serialize_field("description", description)?; - } + state.serialize_field("description", self.description.as_deref().unwrap_or(""))?; state.end() } } @@ -824,6 +842,80 @@ impl ToolSearchConfig { } } +/// 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. /// @@ -1669,6 +1761,96 @@ pub struct CopilotExpAssignmentResponse { pub assignment_context: String, } +/// Well-known managed bypass-permissions policies. +pub struct DisableBypassPermissionsModes; + +impl DisableBypassPermissionsModes { + /// Permit automatic bypass but block full allow-all. + pub const ALLOW_AUTO_ONLY: &'static str = "allow-auto-only"; + /// Turn off bypass-permissions mode entirely. + pub const DISABLE: &'static str = "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 bypass-mode restrictions compose to the most +/// restrictive setting. +#[derive(Clone, Debug, Default, PartialEq, Serialize, Deserialize)] +#[serde(rename_all = "camelCase")] +#[non_exhaustive] +pub struct ManagedSettingsPermissions { + /// Restricts bypass-permissions mode for the session. See + /// [`DisableBypassPermissionsModes`] for well-known values. Unknown values + /// are forwarded so newer runtime policies fail closed. + #[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: impl Into) -> Self { + self.disable_bypass_permissions_mode = Some(value.into()); + 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. @@ -1774,6 +1956,10 @@ pub struct SessionConfig { /// selected or invoked unless a custom agent with the same name is /// configured. pub excluded_builtin_agents: Option>, + /// Built-in skill names to include in the session. In + /// [`ClientMode::Empty`](crate::ClientMode::Empty), `None` excludes all + /// runtime-bundled skills; `Some` opts the named built-ins back in. + pub included_builtin_skills: Option>, /// MCP server configurations passed through to the CLI. pub mcp_servers: Option>, /// Controls how MCP OAuth tokens are stored for this session. @@ -1785,7 +1971,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, @@ -1831,6 +2018,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. @@ -1847,6 +2039,10 @@ pub struct SessionConfig { /// 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). @@ -1896,6 +2092,9 @@ pub struct SessionConfig { 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 @@ -1909,12 +2108,22 @@ pub struct SessionConfig { /// 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 /// the GitHub identity used for content exclusion, model routing, and /// quota checks for *this session*. pub github_token: Option, + /// Provider used to acquire rotating GitHub tokens for this session. + /// + /// Mutually exclusive with [`github_token`](Self::github_token). The callback + /// receives the effective host, optional assigned session ID, and acquisition + /// reason; its opaque registration ID is never exposed. + pub github_token_provider: Option>, /// Per-session remote behavior control: /// - `Off` β€” local only, no remote export (default) /// - `Export` β€” export session events to GitHub without @@ -1942,11 +2151,21 @@ pub struct SessionConfig { 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 + /// session's static [`github_token`](Self::github_token) or + /// [`github_token_provider`](Self::github_token_provider). Requires one of + /// those credentials; if both are 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. @@ -1989,10 +2208,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. @@ -2028,6 +2252,7 @@ impl std::fmt::Debug for SessionConfig { .field("available_tools", &self.available_tools) .field("excluded_tools", &self.excluded_tools) .field("excluded_builtin_agents", &self.excluded_builtin_agents) + .field("included_builtin_skills", &self.included_builtin_skills) .field("mcp_servers", &self.mcp_servers) .field("mcp_oauth_token_storage", &self.mcp_oauth_token_storage) .field("embedding_cache_storage", &self.embedding_cache_storage) @@ -2058,6 +2283,7 @@ impl std::fmt::Debug for SessionConfig { .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) @@ -2067,15 +2293,24 @@ impl std::fmt::Debug for SessionConfig { .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(|_| ""), ) + .field( + "github_token_provider", + &self.github_token_provider.as_ref().map(|_| ""), + ) .field("remote_session", &self.remote_session) .field("cloud", &self.cloud) .field( @@ -2085,6 +2320,8 @@ impl std::fmt::Debug for SessionConfig { .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(|_| ""), @@ -2152,6 +2389,7 @@ impl Default for SessionConfig { available_tools: None, excluded_tools: None, excluded_builtin_agents: None, + included_builtin_skills: None, mcp_servers: None, mcp_oauth_token_storage: None, enable_config_discovery: None, @@ -2164,12 +2402,14 @@ 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, @@ -2181,18 +2421,22 @@ impl Default for SessionConfig { 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, + github_token_provider: 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, @@ -2205,6 +2449,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, } @@ -2230,6 +2475,7 @@ pub(crate) struct SessionConfigRuntime { pub canvas_handler: Option>, pub session_fs_provider: Option>, pub bearer_token_providers: HashMap>, + pub github_token_provider: Option>, pub commands: Option>, } @@ -2249,6 +2495,12 @@ impl SessionConfig { mut self, session_id: Option, ) -> Result<(crate::wire::SessionCreateWire, SessionConfigRuntime), crate::Error> { + if self.github_token.is_some() && self.github_token_provider.is_some() { + return Err(crate::Error::with_message( + crate::ErrorKind::InvalidConfig, + "github_token and github_token_provider are mutually exclusive", + )); + } let permission_active = self.permission_handler.is_some() || self.permission_policy.is_some(); let request_user_input = self.user_input_handler.is_some(); @@ -2275,7 +2527,7 @@ impl SessionConfig { cmds.iter() .map(|c| crate::wire::CommandWireDefinition { name: c.name.clone(), - description: c.description.clone(), + description: c.description.clone().unwrap_or_default(), }) .collect() }); @@ -2322,6 +2574,7 @@ 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, @@ -2329,7 +2582,9 @@ impl SessionConfig { 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, @@ -2339,12 +2594,15 @@ impl SessionConfig { 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, + github_token_provider_registration_id: None, remote_session: self.remote_session, cloud: self.cloud, include_sub_agent_streaming_events: self.include_sub_agent_streaming_events, @@ -2352,6 +2610,8 @@ impl SessionConfig { 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 { @@ -2368,6 +2628,7 @@ impl SessionConfig { canvas_handler, session_fs_provider: self.session_fs_provider, bearer_token_providers, + github_token_provider: self.github_token_provider, commands: self.commands, }; @@ -2640,7 +2901,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 @@ -2701,6 +2963,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 @@ -2711,6 +2979,16 @@ impl SessionConfig { self } + /// Set the runtime-bundled skill allowlist. + pub fn with_included_builtin_skills(mut self, names: I) -> Self + where + I: IntoIterator, + S: Into, + { + self.included_builtin_skills = Some(names.into_iter().map(Into::into).collect()); + self + } + /// Set additional directories to search for custom instruction files. /// Forwarded to the CLI on session create; not the same as /// [`with_skill_directories`](Self::with_skill_directories). @@ -2756,6 +3034,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, @@ -2831,6 +3119,13 @@ impl SessionConfig { 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); @@ -2865,6 +3160,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, @@ -2874,6 +3179,16 @@ impl SessionConfig { self } + /// Install a rotating GitHub token provider for this session. + /// + /// The provider must return a positive remaining lifetime in seconds when + /// its callback completes. Production GitHub tokens typically last eight + /// hours. This option is mutually exclusive with [`with_github_token`](Self::with_github_token). + pub fn with_github_token_provider(mut self, provider: Arc) -> Self { + self.github_token_provider = Some(provider); + self + } + /// Forward sub-agent streaming events to this connection. Defaults /// to true on the CLI when unset. pub fn with_include_sub_agent_streaming_events(mut self, include: bool) -> Self { @@ -2908,6 +3223,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); @@ -2935,13 +3256,23 @@ impl SessionConfig { /// 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). + /// static [`github_token`](Self::github_token) or + /// [`github_token_provider`](Self::github_token_provider). Requires one of + /// those credentials; if both are 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_*` @@ -3005,12 +3336,17 @@ pub struct ResumeSessionConfig { /// selected or invoked unless a custom agent with the same name is /// configured. pub excluded_builtin_agents: Option>, + /// Built-in skill names to include in the resumed session. In + /// [`ClientMode::Empty`](crate::ClientMode::Empty), `None` excludes all + /// runtime-bundled skills; `Some` opts the named built-ins back in. + pub included_builtin_skills: Option>, /// Re-supply MCP servers so they remain available after app restart. 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, @@ -3034,6 +3370,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 @@ -3048,6 +3389,9 @@ pub struct ResumeSessionConfig { 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. @@ -3088,6 +3432,10 @@ pub struct ResumeSessionConfig { 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. @@ -3098,9 +3446,15 @@ pub struct ResumeSessionConfig { 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, + /// Rotating GitHub token provider on resume. See + /// [`SessionConfig::github_token_provider`]. + pub github_token_provider: Option>, /// Per-session remote behavior control on resume. See /// [`SessionConfig::remote_session`]. pub remote_session: Option, @@ -3122,6 +3476,12 @@ pub struct ResumeSessionConfig { /// 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). @@ -3165,6 +3525,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`]. @@ -3197,6 +3562,7 @@ impl std::fmt::Debug for ResumeSessionConfig { .field("available_tools", &self.available_tools) .field("excluded_tools", &self.excluded_tools) .field("excluded_builtin_agents", &self.excluded_builtin_agents) + .field("included_builtin_skills", &self.included_builtin_skills) .field("mcp_servers", &self.mcp_servers) .field("mcp_oauth_token_storage", &self.mcp_oauth_token_storage) .field("embedding_cache_storage", &self.embedding_cache_storage) @@ -3227,6 +3593,7 @@ impl std::fmt::Debug for ResumeSessionConfig { .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) @@ -3236,15 +3603,24 @@ impl std::fmt::Debug for ResumeSessionConfig { .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(|_| ""), ) + .field( + "github_token_provider", + &self.github_token_provider.as_ref().map(|_| ""), + ) .field("remote_session", &self.remote_session) .field( "include_sub_agent_streaming_events", @@ -3253,6 +3629,8 @@ impl std::fmt::Debug for ResumeSessionConfig { .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(|_| ""), @@ -3302,6 +3680,12 @@ impl ResumeSessionConfig { pub(crate) fn into_wire( mut self, ) -> Result<(crate::wire::SessionResumeWire, SessionConfigRuntime), crate::Error> { + if self.github_token.is_some() && self.github_token_provider.is_some() { + return Err(crate::Error::with_message( + crate::ErrorKind::InvalidConfig, + "github_token and github_token_provider are mutually exclusive", + )); + } let permission_active = self.permission_handler.is_some() || self.permission_policy.is_some(); let request_user_input = self.user_input_handler.is_some(); @@ -3328,7 +3712,7 @@ impl ResumeSessionConfig { cmds.iter() .map(|c| crate::wire::CommandWireDefinition { name: c.name.clone(), - description: c.description.clone(), + description: c.description.clone().unwrap_or_default(), }) .collect() }); @@ -3376,6 +3760,7 @@ 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, @@ -3383,7 +3768,9 @@ impl ResumeSessionConfig { 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, @@ -3393,18 +3780,23 @@ impl ResumeSessionConfig { 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, + github_token_provider_registration_id: None, 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, }; @@ -3423,6 +3815,7 @@ impl ResumeSessionConfig { canvas_handler, session_fs_provider: self.session_fs_provider, bearer_token_providers, + github_token_provider: self.github_token_provider, commands: self.commands, }; @@ -3455,6 +3848,7 @@ impl ResumeSessionConfig { available_tools: None, excluded_tools: None, excluded_builtin_agents: None, + included_builtin_skills: None, mcp_servers: None, mcp_oauth_token_storage: None, enable_config_discovery: None, @@ -3467,12 +3861,14 @@ 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, @@ -3484,17 +3880,21 @@ impl ResumeSessionConfig { 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, + github_token_provider: 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, @@ -3509,6 +3909,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, } @@ -3764,7 +4165,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 @@ -3825,6 +4227,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 @@ -3835,6 +4243,16 @@ impl ResumeSessionConfig { self } + /// Set the runtime-bundled skill allowlist on resume. + pub fn with_included_builtin_skills(mut self, names: I) -> Self + where + I: IntoIterator, + S: Into, + { + self.included_builtin_skills = Some(names.into_iter().map(Into::into).collect()); + self + } + /// Set additional directories to search for custom instruction files /// on resume. Forwarded to the CLI; not the same as /// [`with_skill_directories`](Self::with_skill_directories). @@ -3880,6 +4298,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, @@ -3953,6 +4381,13 @@ impl ResumeSessionConfig { 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); @@ -3986,6 +4421,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. @@ -3994,6 +4439,16 @@ impl ResumeSessionConfig { self } + /// Install a rotating GitHub token provider for the resumed session. + /// + /// The provider must return a positive remaining lifetime in seconds when + /// its callback completes. Production GitHub tokens typically last eight + /// hours. Mutually exclusive with [`with_github_token`](Self::with_github_token). + pub fn with_github_token_provider(mut self, provider: Arc) -> Self { + self.github_token_provider = Some(provider); + self + } + /// Forward sub-agent streaming events to this connection on resume. pub fn with_include_sub_agent_streaming_events(mut self, include: bool) -> Self { self.include_sub_agent_streaming_events = Some(include); @@ -4038,6 +4493,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); @@ -4065,6 +4526,14 @@ impl ResumeSessionConfig { 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. @@ -4223,7 +4692,7 @@ 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 @@ -5389,7 +5858,9 @@ pub use crate::generated::api_types::{ Model, ModelBilling, ModelBillingTokenPrices, ModelBillingTokenPricesLongContext, ModelCapabilities, ModelCapabilitiesLimits, ModelCapabilitiesLimitsVision, ModelCapabilitiesSupports, ModelList, ModelPolicy, PermissionDecision, - PermissionDecisionApproveOnce, PermissionDecisionReject, PermissionDecisionUserNotAvailable, + PermissionDecisionApproveOnce, PermissionDecisionContext, PermissionDecisionOutcome, + PermissionDecisionReject, PermissionDecisionSource, PermissionDecisionSurface, + PermissionDecisionUserNotAvailable, PermissionResponseCapability, }; /// Permission categories the CLI may request approval for. @@ -5440,8 +5911,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, } @@ -5490,15 +5968,23 @@ mod tests { AgentMode, Attachment, AttachmentLineRange, AttachmentSelectionPosition, AttachmentSelectionRange, AzureProviderOptions, CapiSessionOptions, ConnectionState, CopilotExpAssignmentResponse, CustomAgentConfig, DeliveryMode, ExpConfigEntry, - ExpFlagValue, ExtensionInfo, GitHubReferenceType, InfiniteSessionConfig, - LargeToolOutputConfig, McpServerConfig, McpStdioServerConfig, MemoryConfiguration, - NamedProviderConfig, ProviderConfig, ProviderModelConfig, ReasoningSummary, - ResumeSessionConfig, SessionConfig, SessionEvent, SessionId, SystemMessageConfig, Tool, - ToolBinaryResult, ToolResult, ToolResultExpanded, ToolResultResponse, - ensure_attachment_display_names, + ExpFlagValue, ExtensionInfo, GitHubMcpToolConfig, GitHubReferenceType, + InfiniteSessionConfig, LargeToolOutputConfig, McpServerConfig, McpStdioServerConfig, + MemoryConfiguration, NamedProviderConfig, PermissionResponseCapability, ProviderConfig, + ProviderModelConfig, ReasoningSummary, ResumeSessionConfig, SessionConfig, SessionEvent, + SessionId, SystemMessageConfig, Tool, ToolBinaryResult, ToolResult, ToolResultExpanded, + ToolResultResponse, ensure_attachment_display_names, }; use crate::generated::session_events::TypedSessionEvent; + #[test] + fn permission_response_capability_is_publicly_exported() { + assert_eq!( + serde_json::to_value(PermissionResponseCapability::Interactive).unwrap(), + json!("interactive") + ); + } + #[test] fn tool_builder_composes() { let tool = Tool::new("greet") @@ -5771,6 +6257,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); @@ -5800,6 +6315,47 @@ 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); @@ -6097,6 +6653,10 @@ mod tests { 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) @@ -6111,6 +6671,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"); @@ -6120,6 +6684,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()); } @@ -6169,6 +6734,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) @@ -6179,6 +6745,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"); @@ -6188,9 +6758,38 @@ 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 indexmap::IndexMap; @@ -6212,9 +6811,11 @@ mod tests { .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) @@ -6249,9 +6850,17 @@ 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, @@ -6283,9 +6892,11 @@ mod tests { .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) @@ -6320,9 +6931,17 @@ 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, @@ -6357,6 +6976,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. @@ -7058,7 +7700,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(_), + .. + } )); } @@ -7068,7 +7713,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(_), + .. + } )); } @@ -7086,11 +7734,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(_), + .. + } )); } @@ -7106,11 +7760,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(_), + .. + } )); } @@ -7122,7 +7782,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(_), + .. + } )); } @@ -7141,11 +7804,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(_), + .. + } )); } @@ -7157,7 +7826,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(_), + .. + } )); } @@ -7173,11 +7845,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 2eabbe848d..f7de33839c 100644 --- a/rust/src/wire.rs +++ b/rust/src/wire.rs @@ -25,9 +25,10 @@ use crate::generated::api_types::{ use crate::generated::session_events::ReasoningSummary; use crate::types::{ CanvasProviderIdentity, CapiSessionOptions, CloudSessionOptions, CustomAgentConfig, - DefaultAgentConfig, ExtensionInfo, InfiniteSessionConfig, LargeToolOutputConfig, - McpServerConfig, MemoryConfiguration, NamedProviderConfig, ProviderConfig, ProviderModelConfig, - SessionId, SessionLimitsConfig, SystemMessageConfig, Tool, ToolSearchConfig, + 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 @@ -37,8 +38,9 @@ use crate::types::{ #[serde(rename_all = "camelCase")] pub(crate) struct CommandWireDefinition { pub name: String, - #[serde(skip_serializing_if = "Option::is_none")] - pub description: Option, + /// Always sent. The runtime requires a string, so a command declared + /// without a description is serialized as `""` rather than omitted. + pub description: String, } /// The exact JSON shape sent on the `session.create` JSON-RPC request. @@ -113,6 +115,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>, @@ -127,8 +131,12 @@ pub(crate) struct SessionCreateWire { #[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, @@ -147,6 +155,8 @@ pub(crate) struct SessionCreateWire { #[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, @@ -156,8 +166,15 @@ pub(crate) struct SessionCreateWire { 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( + rename = "gitHubTokenProviderRegistrationId", + skip_serializing_if = "Option::is_none" + )] + pub github_token_provider_registration_id: Option, #[serde(skip_serializing_if = "Option::is_none")] pub remote_session: Option, #[serde(skip_serializing_if = "Option::is_none")] @@ -175,6 +192,10 @@ pub(crate) struct SessionCreateWire { 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. @@ -249,6 +270,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>, @@ -263,8 +286,12 @@ pub(crate) struct SessionResumeWire { #[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, @@ -283,6 +310,8 @@ pub(crate) struct SessionResumeWire { #[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, @@ -292,8 +321,15 @@ pub(crate) struct SessionResumeWire { 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( + rename = "gitHubTokenProviderRegistrationId", + skip_serializing_if = "Option::is_none" + )] + pub github_token_provider_registration_id: Option, #[serde(skip_serializing_if = "Option::is_none")] pub remote_session: Option, #[serde(skip_serializing_if = "Option::is_none")] @@ -314,4 +350,8 @@ pub(crate) struct SessionResumeWire { 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 bcf2266916..9b86b1367a 100644 --- a/rust/tests/api_types_test.rs +++ b/rust/tests/api_types_test.rs @@ -7,6 +7,7 @@ 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 0000000000..f1310f9b04 --- /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/e2e.rs b/rust/tests/e2e.rs index 3a698abd18..03723dfb1b 100644 --- a/rust/tests/e2e.rs +++ b/rust/tests/e2e.rs @@ -66,6 +66,8 @@ mod permissions; 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"] diff --git a/rust/tests/e2e/abort.rs b/rust/tests/e2e/abort.rs index d4e79452bf..34fc66b605 100644 --- a/rust/tests/e2e/abort.rs +++ b/rust/tests/e2e/abort.rs @@ -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,54 +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"); - - // 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; } #[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 c134ad3c90..d7d0893584 100644 --- a/rust/tests/e2e/ask_user.rs +++ b/rust/tests/e2e/ask_user.rs @@ -12,13 +12,11 @@ use github_copilot_sdk::{ use serde_json::json; use tokio::sync::{Notify, mpsc}; -use super::support::{ - DEFAULT_TEST_TOKEN, assistant_message_content, recv_with_timeout, with_e2e_context, -}; +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| { @@ -62,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| { @@ -107,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| { @@ -164,7 +162,8 @@ async fn should_handle_freeform_user_input_response() { /// 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() { - with_e2e_context( + super::support::with_shared_e2e_context( + &E2E, "ask_user", "ask_user_does_not_block_sibling_tool_call_in_same_turn", |ctx| { @@ -346,3 +345,5 @@ impl ToolHandler for SetMarkerTool { 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 41584d3a06..12bcad4fa8 100644 --- a/rust/tests/e2e/builtin_tools.rs +++ b/rust/tests/e2e/builtin_tools.rs @@ -2,7 +2,7 @@ use std::time::Duration; use github_copilot_sdk::MessageOptions; -use super::support::{assistant_message_content, with_e2e_context}; +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 @@ -16,7 +16,8 @@ fn message(prompt: &str) -> MessageOptions { #[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| { @@ -49,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; @@ -77,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") @@ -106,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| { @@ -144,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") @@ -171,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; @@ -196,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| { @@ -229,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"); @@ -256,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/canvas.rs b/rust/tests/e2e/canvas.rs index 1736e97119..2418e9e5a6 100644 --- a/rust/tests/e2e/canvas.rs +++ b/rust/tests/e2e/canvas.rs @@ -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; @@ -158,64 +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::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::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"); - }) - }) + 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::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; } #[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; @@ -272,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 0ac4c9d457..880c1a28c4 100644 --- a/rust/tests/e2e/client.rs +++ b/rust/tests/e2e/client.rs @@ -79,6 +79,11 @@ async fn should_get_status() { #[tokio::test] async fn should_get_authenticated_status() { + // TODO(cli-1.0.81-2): CLI 1.0.81-2 stopped honoring client-level GitHub tokens over the + // in-process (FFI) host, which resolves auth from the ambient environment instead. + if super::support::skip_inprocess("client-level GitHub tokens are not supported in-process") { + return; + } with_e2e_context("client", "should_get_authenticated_status", |ctx| { Box::pin(async move { ctx.set_default_copilot_user(); @@ -99,6 +104,11 @@ async fn should_get_authenticated_status() { #[tokio::test] async fn should_list_models_when_authenticated() { + // TODO(cli-1.0.81-2): CLI 1.0.81-2 stopped honoring client-level GitHub tokens over the + // in-process (FFI) host, which resolves auth from the ambient environment instead. + if super::support::skip_inprocess("client-level GitHub tokens are not supported in-process") { + return; + } with_e2e_context("client", "should_list_models_when_authenticated", |ctx| { Box::pin(async move { ctx.set_default_copilot_user(); diff --git a/rust/tests/e2e/client_api.rs b/rust/tests/e2e/client_api.rs index 951fe87208..35cdf6f285 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/commands.rs b/rust/tests/e2e/commands.rs index d6cb6699f3..2e15c24a0f 100644 --- a/rust/tests/e2e/commands.rs +++ b/rust/tests/e2e/commands.rs @@ -11,11 +11,12 @@ use github_copilot_sdk::{CommandContext, CommandDefinition, CommandHandler, Requ 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| { @@ -103,6 +105,7 @@ async fn session_commands_invoke_known_builtin_returns_expected_result() { .invoke(CommandsInvokeRequest { name: "context".to_string(), input: None, + ..Default::default() }) .await .expect("invoke context"); @@ -117,6 +120,7 @@ async fn session_commands_invoke_known_builtin_returns_expected_result() { assert!(!prompt.prompt.trim().is_empty()); } SlashCommandInvocationResult::Completed(_) => {} + unexpected => panic!("unexpected command result: {unexpected:?}"), } session.disconnect().await.expect("disconnect session"); @@ -129,7 +133,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 +180,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| { @@ -289,3 +295,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 b9854ef1dc..d56687d5f4 100644 --- a/rust/tests/e2e/compaction.rs +++ b/rust/tests/e2e/compaction.rs @@ -1,10 +1,9 @@ use github_copilot_sdk::rpc::{LogRequest, SessionLogLevel}; -use super::support::with_e2e_context; - #[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/elicitation.rs b/rust/tests/e2e/elicitation.rs index 5575e67f30..31da30adbd 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 770ed5da16..7176a7e669 100644 --- a/rust/tests/e2e/event_fidelity.rs +++ b/rust/tests/e2e/event_fidelity.rs @@ -3,11 +3,12 @@ use github_copilot_sdk::session_events::{ 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 index 2047ee34ff..02af0e2ae8 100644 --- a/rust/tests/e2e/github_telemetry.rs +++ b/rust/tests/e2e/github_telemetry.rs @@ -9,6 +9,11 @@ use super::support::{DEFAULT_TEST_TOKEN, with_e2e_context_no_snapshot}; #[tokio::test] async fn should_forward_github_telemetry_on_session_create() { + // TODO(cli-1.0.81-2): CLI 1.0.81-2 does not forward GitHub telemetry notifications over + // the in-process (FFI) host, mirroring the existing telemetry-configuration limitation. + if super::support::skip_inprocess("GitHub telemetry forwarding is not honored in-process") { + return; + } with_e2e_context_no_snapshot(|ctx| { Box::pin(async move { ctx.set_default_copilot_user(); diff --git a/rust/tests/e2e/hooks.rs b/rust/tests/e2e/hooks.rs index b4a211d878..0510190731 100644 --- a/rust/tests/e2e/hooks.rs +++ b/rust/tests/e2e/hooks.rs @@ -7,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| { @@ -51,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| { @@ -92,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| { @@ -147,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| { @@ -226,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 4c61757e8f..dfd77ed7cd 100644 --- a/rust/tests/e2e/hooks_extended.rs +++ b/rust/tests/e2e/hooks_extended.rs @@ -8,17 +8,19 @@ use github_copilot_sdk::hooks::{ 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| { @@ -50,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| { @@ -82,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| { @@ -113,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| { @@ -144,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| { @@ -184,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.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| { @@ -284,7 +345,8 @@ async fn should_register_erroroccurred_hook() { #[tokio::test] async fn should_invoke_agentstop_hook_and_apply_block_response() { - with_e2e_context( + super::support::with_shared_e2e_context( + &E2E, "hooks_extended", "should_invoke_agentstop_hook_and_apply_block_response", |ctx| { @@ -326,7 +388,8 @@ async fn should_invoke_agentstop_hook_and_apply_block_response() { #[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| { @@ -369,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| { @@ -415,7 +479,7 @@ 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| { @@ -489,6 +553,27 @@ struct AgentStopHooks { 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( @@ -719,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/mode_empty.rs b/rust/tests/e2e/mode_empty.rs index af1e9267e2..2a62d66cfc 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 b4089ca28a..b796096d06 100644 --- a/rust/tests/e2e/mode_handlers.rs +++ b/rust/tests/e2e/mode_handlers.rs @@ -15,9 +15,7 @@ use github_copilot_sdk::session_events::{ 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| { @@ -119,6 +118,7 @@ async fn should_invoke_exit_plan_mode_handler_when_model_uses_tool() { .mode() .set(ModeSetRequest { mode: SessionMode::Plan, + ..Default::default() }) .await .expect("set plan mode"); @@ -181,7 +181,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 +289,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_provider_registry.rs b/rust/tests/e2e/multi_provider_registry.rs index 8c37deaa21..d07acd3565 100644 --- a/rust/tests/e2e/multi_provider_registry.rs +++ b/rust/tests/e2e/multi_provider_registry.rs @@ -5,8 +5,6 @@ use github_copilot_sdk::{ }; use serde_json::Value; -use super::support::with_e2e_context; - const CATEGORY: &str = "multi_provider_registry"; fn headers(provider: &str) -> HashMap { @@ -17,7 +15,8 @@ fn headers(provider: &str) -> HashMap { #[tokio::test] async fn should_register_multiple_providers_with_custom_agents_bound_to_their_models() { - with_e2e_context( + super::support::with_shared_e2e_context( + &E2E, CATEGORY, "should_register_multiple_providers_with_custom_agents_bound_to_their_models", |ctx| { @@ -124,7 +123,7 @@ async fn assert_routing( expected_wire_model: &'static str, expected_provider_header: &'static str, ) { - with_e2e_context(CATEGORY, snapshot_name, move |ctx| { + 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; @@ -241,3 +240,4 @@ async fn should_route_delta_turbo_turn_to_its_provider_and_wire_model() { ) .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 8c3bc5cb9f..e57fe22940 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::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/permissions.rs b/rust/tests/e2e/permissions.rs index e97aeacb07..65b37928db 100644 --- a/rust/tests/e2e/permissions.rs +++ b/rust/tests/e2e/permissions.rs @@ -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 fd05796fcd..31e69d1067 100644 --- a/rust/tests/e2e/pre_mcp_tool_call_hook.rs +++ b/rust/tests/e2e/pre_mcp_tool_call_hook.rs @@ -8,7 +8,7 @@ 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) -> IndexMap { let harness_dir = repo_root.join("test").join("harness"); @@ -88,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| { @@ -138,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| { @@ -186,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| { @@ -231,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 index 3953aad669..6aeff7b1a7 100644 --- a/rust/tests/e2e/provider_endpoint.rs +++ b/rust/tests/e2e/provider_endpoint.rs @@ -91,6 +91,11 @@ async fn byok_provider_endpoint_returns_configured_endpoint() { #[tokio::test] #[allow(deprecated)] async fn capi_provider_endpoint_returns_resolved_credentials() { + // TODO(cli-1.0.81-2): CLI 1.0.81-2 stopped honoring client-level GitHub tokens over the + // in-process (FFI) host, which resolves auth from the ambient environment instead. + if super::support::skip_inprocess("client-level GitHub tokens are not supported in-process") { + return; + } with_e2e_context( "provider-endpoint", "capi_provider_endpoint_returns_resolved_credentials", diff --git a/rust/tests/e2e/rewind.rs b/rust/tests/e2e/rewind.rs new file mode 100644 index 0000000000..c998f96df6 --- /dev/null +++ b/rust/tests/e2e/rewind.rs @@ -0,0 +1,141 @@ +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() { + // TODO(cli-1.0.81): Re-enable when Windows file-change tracking records built-in create tool writes. + if cfg!(windows) { + return; + } + + 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(30); + loop { + let result = session + .rpc() + .history() + .list_rewind_points() + .await + .expect("list rewind points"); + if result.unavailable_reason.is_none() + && result + .points + .first() + .is_some_and(|point| point.can_restore_files && point.file_count == 1) + { + return result; + } + assert!( + tokio::time::Instant::now() < deadline, + "timed out waiting for a restorable rewind point: {result:?}" + ); + 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 cce35a9856..56b9198ab7 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::rpc::{ - ModeSetRequest, NameSetRequest, PermissionsSetApproveAllRequest, PlanUpdateRequest, - ShellExecRequest, WorkspacesCreateFileRequest, WorkspacesReadFileRequest, + 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| { @@ -269,6 +277,7 @@ async fn mode_set_to_same_value_multiple_times_stays_stable() { .mode() .set(ModeSetRequest { mode: SessionMode::Plan, + ..Default::default() }) .await .expect("set mode"); @@ -288,7 +297,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 +332,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 +361,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 +377,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 +392,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 +452,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 +505,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 +559,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 e254460bce..24fbd30673 100644 --- a/rust/tests/e2e/rpc_agent.rs +++ b/rust/tests/e2e/rpc_agent.rs @@ -3,41 +3,47 @@ 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 96eccced90..b116f3e504 100644 --- a/rust/tests/e2e/rpc_event_log.rs +++ b/rust/tests/e2e/rpc_event_log.rs @@ -7,11 +7,10 @@ use github_copilot_sdk::session_events::{ }; 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| { @@ -43,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), @@ -70,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| { @@ -88,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), @@ -110,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| { @@ -156,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| { @@ -170,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), @@ -204,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 4b634cb89f..06adc3f65c 100644 --- a/rust/tests/e2e/rpc_event_side_effects.rs +++ b/rust/tests/e2e/rpc_event_side_effects.rs @@ -8,11 +8,12 @@ use github_copilot_sdk::session_events::{ 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| { @@ -39,6 +40,7 @@ async fn should_emit_mode_changed_event_when_mode_set() { .mode() .set(ModeSetRequest { mode: SessionMode::Plan, + ..Default::default() }) .await .expect("set mode"); @@ -54,7 +56,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 +94,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 +136,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 +182,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 +226,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 +288,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 +359,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 eb8368ebcd..8cf3efd998 100644 --- a/rust/tests/e2e/rpc_mcp_and_skills.rs +++ b/rust/tests/e2e/rpc_mcp_and_skills.rs @@ -9,16 +9,15 @@ use github_copilot_sdk::rpc::{ McpAppsSetHostContextRequest, McpCancelSamplingExecutionParams, McpDisableRequest, McpEnableRequest, McpExecuteSamplingParams, McpExecuteSamplingRequest, McpOauthLoginRequest, McpResourcesReadRequest, McpSamplingExecutionAction, McpSetEnvValueModeDetails, - McpSetEnvValueModeParams, PermissionsAllowAllMode, PermissionsSetAllowAllRequest, - SkillsDisableRequest, SkillsEnableRequest, + McpSetEnvValueModeParams, PermissionsSetModeRequest, SkillsDisableRequest, SkillsEnableRequest, }; +use github_copilot_sdk::session_events::PermissionMode; use github_copilot_sdk::{IndexMap, McpServerConfig, McpStdioServerConfig}; -use super::support::with_e2e_context; - #[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,76 +316,86 @@ 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 = 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"); - - 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"); - }) - }) + 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("create session"); + session + .rpc() + .permissions() + .set_mode(PermissionsSetModeRequest { + assisted_approval_model: None, + mode: PermissionMode::AllowAll, + 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| { @@ -439,7 +453,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| { @@ -503,7 +518,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| { @@ -544,7 +560,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| { @@ -600,7 +617,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| { @@ -639,7 +657,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| { @@ -680,7 +699,8 @@ 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| { @@ -694,10 +714,9 @@ async fn should_report_error_when_extensions_are_not_available() { session .rpc() .permissions() - .set_allow_all(PermissionsSetAllowAllRequest { - enabled: None, - mode: Some(PermissionsAllowAllMode::On), - model: None, + .set_mode(PermissionsSetModeRequest { + assisted_approval_model: None, + mode: PermissionMode::AllowAll, source: None, }) .await @@ -814,3 +833,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 506987fa14..591d7d247c 100644 --- a/rust/tests/e2e/rpc_mcp_config.rs +++ b/rust/tests/e2e/rpc_mcp_config.rs @@ -4,11 +4,10 @@ use github_copilot_sdk::rpc::{ }; 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 index aa3adcf5c3..8e5b74c05b 100644 --- a/rust/tests/e2e/rpc_mcp_lifecycle.rs +++ b/rust/tests/e2e/rpc_mcp_lifecycle.rs @@ -10,11 +10,12 @@ use github_copilot_sdk::{Error, IndexMap, McpServerConfig, McpStdioServerConfig} use serde::de::DeserializeOwned; use serde_json::{Value, json}; -use super::support::{wait_for_condition, with_e2e_context}; +use super::support::wait_for_condition; #[tokio::test] async fn should_list_tools_and_report_running_status_for_connected_server() { - with_e2e_context( + super::support::with_shared_e2e_context( + &E2E, "rpc_mcp_lifecycle", "should_list_tools_and_report_running_status_for_connected_server", |ctx| { @@ -61,7 +62,8 @@ async fn should_list_tools_and_report_running_status_for_connected_server() { #[tokio::test] async fn should_throw_when_listing_tools_for_unconnected_server() { - with_e2e_context( + super::support::with_shared_e2e_context( + &E2E, "rpc_mcp_lifecycle", "should_throw_when_listing_tools_for_unconnected_server", |ctx| { @@ -98,7 +100,8 @@ async fn should_throw_when_listing_tools_for_unconnected_server() { #[tokio::test] async fn should_stop_running_mcp_server() { - with_e2e_context( + super::support::with_shared_e2e_context( + &E2E, "rpc_mcp_lifecycle", "should_stop_running_mcp_server", |ctx| { @@ -135,9 +138,14 @@ async fn should_stop_running_mcp_server() { .await; } +// TODO(cli-1.0.81-2): CLI 1.0.81-2 no longer installs an MCP config from the inline start +// payload, so `session.mcp.startServer` reports "has no installed config to start". +// Re-enable once the runtime fix ships. +#[ignore = "blocked on CLI 1.0.81-2 MCP installed-config regression"] #[tokio::test] async fn should_start_and_restart_mcp_server() { - with_e2e_context( + super::support::with_shared_e2e_context( + &E2E, "rpc_mcp_lifecycle", "should_start_and_restart_mcp_server", |ctx| { @@ -201,8 +209,10 @@ async fn should_start_and_restart_mcp_server() { // internal methods generically; it never exercised a supported wire API. #[tokio::test] +#[ignore = "blocked on CLI 1.0.81-6 missing session.mcp.reloadWithConfig handler"] async fn should_reload_mcp_servers_with_config() { - with_e2e_context( + super::support::with_shared_e2e_context( + &E2E, "rpc_mcp_lifecycle", "should_reload_mcp_servers_with_config", |ctx| { @@ -243,8 +253,10 @@ async fn should_reload_mcp_servers_with_config() { } #[tokio::test] +#[ignore = "blocked on CLI 1.0.81-6 missing session.mcp.configureGitHub handler"] async fn should_configure_github_mcp_server() { - with_e2e_context( + super::support::with_shared_e2e_context( + &E2E, "rpc_mcp_lifecycle", "should_configure_github_mcp_server", |ctx| { @@ -374,3 +386,5 @@ fn assert_error_contains(err: &Error, expected: &str) { "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 2c51f9e37a..6f4f881659 100644 --- a/rust/tests/e2e/rpc_queue.rs +++ b/rust/tests/e2e/rpc_queue.rs @@ -7,7 +7,7 @@ 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 c34a8d5e5e..e98f6c4faa 100644 --- a/rust/tests/e2e/rpc_remote.rs +++ b/rust/tests/e2e/rpc_remote.rs @@ -1,11 +1,12 @@ 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| { @@ -45,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| { @@ -74,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| { @@ -112,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 fc782fe417..af8f6f59b7 100644 --- a/rust/tests/e2e/rpc_schedule.rs +++ b/rust/tests/e2e/rpc_schedule.rs @@ -1,10 +1,9 @@ use github_copilot_sdk::rpc::ScheduleStopRequest; -use super::support::with_e2e_context; - #[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 d0beab2452..8df662ea8e 100644 --- a/rust/tests/e2e/rpc_server.rs +++ b/rust/tests/e2e/rpc_server.rs @@ -21,7 +21,8 @@ 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| { @@ -47,6 +48,11 @@ async fn should_call_rpc_ping_with_typed_params_and_result() { #[tokio::test] async fn should_call_rpc_models_list_with_typed_result() { + // TODO(cli-1.0.81-2): CLI 1.0.81-2 stopped honoring client-level GitHub tokens over the + // in-process (FFI) host, which resolves auth from the ambient environment instead. + if super::support::skip_inprocess("client-level GitHub tokens are not supported in-process") { + return; + } with_e2e_context( "rpc_server", "should_call_rpc_models_list_with_typed_result", @@ -76,6 +82,11 @@ async fn should_call_rpc_models_list_with_typed_result() { #[tokio::test] async fn should_call_rpc_account_get_quota_when_authenticated() { + // TODO(cli-1.0.81-2): CLI 1.0.81-2 stopped honoring client-level GitHub tokens over the + // in-process (FFI) host, which resolves auth from the ambient environment instead. + if super::support::skip_inprocess("client-level GitHub tokens are not supported in-process") { + return; + } with_e2e_context( "rpc_server", "should_call_rpc_account_get_quota_when_authenticated", @@ -118,7 +129,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| { @@ -186,7 +198,8 @@ async fn should_reject_llm_response_frames_for_unknown_request() { #[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| { @@ -401,35 +414,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| { @@ -550,7 +569,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| { @@ -604,7 +624,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| { @@ -655,7 +676,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| { @@ -702,7 +724,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| { @@ -752,34 +775,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"); + 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| { @@ -861,3 +890,5 @@ fn paths_equal(left: &str, right: &str) -> bool { 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 index b9e5cdf5c4..e53cce2e59 100644 --- a/rust/tests/e2e/rpc_server_misc.rs +++ b/rust/tests/e2e/rpc_server_misc.rs @@ -1,6 +1,6 @@ use github_copilot_sdk::Client; use github_copilot_sdk::rpc::{ - AccountLoginRequest, AccountLogoutRequest, AgentRegistrySpawnRequest, + AccountLoginRequest, AccountLogoutRequest, AgentRegistrySpawnRequest, AuthInfo, SendAttachmentsToMessageParams, SessionsOpenStatus, UserSettingsSetRequest, }; use serde_json::{Map, Value, json}; @@ -9,27 +9,33 @@ use super::support::{wait_for_condition, with_e2e_context}; #[tokio::test] async fn should_reload_user_settings() { - with_e2e_context("rpc_server_misc", "should_reload_user_settings", |ctx| { - Box::pin(async move { - let client = ctx.start_client().await; + 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 + .rpc() + .user() + .settings() + .reload() + .await + .expect("reload user settings"); - client.stop().await.expect("stop client"); - }) - }) + client.stop().await.expect("stop client"); + }) + }, + ) .await; } #[tokio::test] async fn should_get_set_and_clear_user_settings() { - with_e2e_context( + super::support::with_shared_e2e_context( + &E2E, "rpc_server_misc", "should_get_set_and_clear_user_settings", |ctx| { @@ -144,7 +150,7 @@ async fn should_login_list_getcurrentauth_and_logout_account() { .account() .login(AccountLoginRequest { host: "https://github.com".to_string(), - login: "rust-account-user".to_string(), + login: Some("rust-account-user".to_string()), token: "rust-account-token".to_string(), }) .await @@ -158,8 +164,11 @@ async fn should_login_list_getcurrentauth_and_logout_account() { .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 AuthInfo::User(user_auth_info) = &auth_info else { + panic!("expected user auth info, got {auth_info:?}"); + }; + assert_eq!(user_auth_info.login, "rust-account-user"); + assert_eq!(user_auth_info.host, "https://github.com"); let users = client .rpc() @@ -167,10 +176,12 @@ async fn should_login_list_getcurrentauth_and_logout_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")) - { + if let Some(user) = users.iter().find(|user| { + matches!( + &user.auth_info, + AuthInfo::User(auth_info) if auth_info.login == "rust-account-user" + ) + }) { user.token .as_deref() .filter(|token| *token == "rust-account-token") @@ -182,7 +193,10 @@ async fn should_login_list_getcurrentauth_and_logout_account() { let logout = client .rpc() .account() - .logout(AccountLogoutRequest { auth_info }) + .logout(AccountLogoutRequest { + auth_info: Some(auth_info), + ..Default::default() + }) .await .expect("account logout"); assert!(!logout.has_more_users); @@ -206,7 +220,8 @@ async fn should_login_list_getcurrentauth_and_logout_account() { #[tokio::test] async fn should_report_agent_registry_spawn_gate_closed() { - with_e2e_context( + super::support::with_shared_e2e_context( + &E2E, "rpc_server_misc", "should_report_agent_registry_spawn_gate_closed", |ctx| { @@ -279,7 +294,8 @@ async fn should_shut_down_owned_runtime() { #[tokio::test] async fn should_report_not_found_when_opening_session_without_context() { - with_e2e_context( + super::support::with_shared_e2e_context( + &E2E, "rpc_server_misc", "should_report_not_found_when_opening_session_without_context", |ctx| { @@ -305,7 +321,8 @@ async fn should_report_not_found_when_opening_session_without_context() { #[tokio::test] async fn should_reject_send_attachments_from_non_extension_connection() { - with_e2e_context( + super::support::with_shared_e2e_context( + &E2E, "rpc_server_misc", "should_reject_send_attachments_from_non_extension_connection", |ctx| { @@ -353,3 +370,5 @@ fn setting_patch(key: &str, value: Value) -> Value { 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 index 054ffa3599..df6072253f 100644 --- a/rust/tests/e2e/rpc_server_plugins.rs +++ b/rust/tests/e2e/rpc_server_plugins.rs @@ -8,15 +8,14 @@ use github_copilot_sdk::rpc::{ PluginsUpdateRequest, }; -use super::support::with_e2e_context; - 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() { - with_e2e_context( + super::support::with_dedicated_group_e2e_context( + &E2E, "rpc_server_plugins", "should_install_and_list_plugin_from_local_marketplace", |ctx| { @@ -65,7 +64,8 @@ async fn should_install_and_list_plugin_from_local_marketplace() { #[tokio::test] async fn should_enable_and_disable_marketplace_plugin() { - with_e2e_context( + super::support::with_dedicated_group_e2e_context( + &E2E, "rpc_server_plugins", "should_enable_and_disable_marketplace_plugin", |ctx| { @@ -135,7 +135,8 @@ async fn should_enable_and_disable_marketplace_plugin() { #[tokio::test] async fn should_update_single_marketplace_plugin() { - with_e2e_context( + super::support::with_dedicated_group_e2e_context( + &E2E, "rpc_server_plugins", "should_update_single_marketplace_plugin", |ctx| { @@ -184,7 +185,8 @@ async fn should_update_single_marketplace_plugin() { #[tokio::test] async fn should_update_all_installed_plugins() { - with_e2e_context( + super::support::with_dedicated_group_e2e_context( + &E2E, "rpc_server_plugins", "should_update_all_installed_plugins", |ctx| { @@ -241,7 +243,8 @@ async fn should_update_all_installed_plugins() { #[tokio::test] async fn should_install_direct_local_plugin_with_deprecation_warning() { - with_e2e_context( + super::support::with_dedicated_group_e2e_context( + &E2E, "rpc_server_plugins", "should_install_direct_local_plugin_with_deprecation_warning", |ctx| { @@ -316,7 +319,8 @@ async fn should_install_direct_local_plugin_with_deprecation_warning() { #[tokio::test] async fn should_list_browse_refresh_and_remove_local_marketplace() { - with_e2e_context( + super::support::with_dedicated_group_e2e_context( + &E2E, "rpc_server_plugins", "should_list_browse_refresh_and_remove_local_marketplace", |ctx| { @@ -434,7 +438,8 @@ async fn should_list_browse_refresh_and_remove_local_marketplace() { #[tokio::test] async fn should_reload_mcp_config_cache() { - with_e2e_context( + super::support::with_dedicated_group_e2e_context( + &E2E, "rpc_server_plugins", "should_reload_mcp_config_cache", |ctx| { @@ -538,3 +543,5 @@ fn single_plugin<'a>( 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 index a49f1d12ab..49809235cc 100644 --- a/rust/tests/e2e/rpc_server_remote_control.rs +++ b/rust/tests/e2e/rpc_server_remote_control.rs @@ -6,11 +6,10 @@ use github_copilot_sdk::rpc::{ }; use serde_json::Value; -use super::support::with_e2e_context; - #[tokio::test] async fn should_report_remote_control_status_as_off() { - with_e2e_context( + super::support::with_shared_e2e_context( + &E2E, "rpc_server_remote_control", "should_report_remote_control_status_as_off", |ctx| { @@ -34,7 +33,8 @@ async fn should_report_remote_control_status_as_off() { #[tokio::test] async fn should_treat_set_steering_as_no_op_when_off() { - with_e2e_context( + super::support::with_shared_e2e_context( + &E2E, "rpc_server_remote_control", "should_treat_set_steering_as_no_op_when_off", |ctx| { @@ -60,7 +60,8 @@ async fn should_treat_set_steering_as_no_op_when_off() { #[tokio::test] async fn should_report_not_stopped_when_remote_control_is_off() { - with_e2e_context( + super::support::with_shared_e2e_context( + &E2E, "rpc_server_remote_control", "should_report_not_stopped_when_remote_control_is_off", |ctx| { @@ -85,7 +86,8 @@ async fn should_report_not_stopped_when_remote_control_is_off() { #[tokio::test] async fn should_reject_transfer_when_off_with_compare_and_swap() { - with_e2e_context( + super::support::with_shared_e2e_context( + &E2E, "rpc_server_remote_control", "should_reject_transfer_when_off_with_compare_and_swap", |ctx| { @@ -116,7 +118,8 @@ async fn should_reject_transfer_when_off_with_compare_and_swap() { #[tokio::test] async fn should_reach_runtime_when_starting_remote_control_for_unknown_session() { - with_e2e_context( + super::support::with_shared_e2e_context( + &E2E, "rpc_server_remote_control", "should_reach_runtime_when_starting_remote_control_for_unknown_session", |ctx| { @@ -177,3 +180,5 @@ fn assert_not_unhandled(message: &str) { "{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 199ff2a2b5..aa67312473 100644 --- a/rust/tests/e2e/rpc_session_state.rs +++ b/rust/tests/e2e/rpc_session_state.rs @@ -5,27 +5,26 @@ use github_copilot_sdk::rpc::{ MetadataRecomputeContextTokensRequest, MetadataRecordContextChangeRequest, MetadataSetWorkingDirectoryRequest, MetadataSnapshotCurrentMode, ModeSetRequest, ModelSetReasoningEffortRequest, ModelSwitchToRequest, NameSetAutoRequest, NameSetRequest, - PermissionsSetApproveAllRequest, PlanUpdateRequest, SessionSetCredentialsParams, - SessionUpdateOptionsParams, SessionWorkingDirectoryContext, - SessionWorkingDirectoryContextHostType, SessionsForkRequest, ShutdownRequest, - TelemetrySetFeatureOverridesRequest, WorkspacesCreateFileRequest, WorkspacesReadFileRequest, + PermissionsResetSessionApprovalsRequest, PermissionsSetApproveAllRequest, PlanUpdateRequest, + SessionSetCredentialsParams, SessionUpdateOptionsParams, SessionWorkingDirectoryContext, + SessionWorkingDirectoryContextHostType, SessionsForkRequest, SettableAuthInfo, ShutdownRequest, + TelemetrySetFeatureOverridesRequest, UserAuthInfo, WorkspacesCreateFileRequest, + WorkspacesReadFileRequest, }; 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| { @@ -107,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| { @@ -128,6 +129,7 @@ async fn should_get_and_set_session_mode() { .mode() .set(ModeSetRequest { mode: SessionMode::Plan, + ..Default::default() }) .await .expect("set plan mode"); @@ -146,7 +148,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| { @@ -184,7 +187,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 +208,10 @@ async fn should_set_and_get_each_session_mode_value() { session .rpc() .mode() - .set(ModeSetRequest { mode: mode.clone() }) + .set(ModeSetRequest { + mode: mode.clone(), + ..Default::default() + }) .await .expect("set mode"); assert_eq!(session.rpc().mode().get().await.expect("get mode"), mode); @@ -220,7 +227,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| { @@ -285,7 +293,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| { @@ -342,7 +351,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| { @@ -386,7 +396,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| { @@ -428,7 +439,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| { @@ -461,7 +473,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| { @@ -516,7 +529,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| { @@ -551,7 +565,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| { @@ -602,7 +617,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| { @@ -651,7 +667,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| { @@ -731,7 +748,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| { @@ -743,18 +761,18 @@ async fn should_update_options_and_initialize_session_services() { .await .expect("create session"); + let mut update_options = SessionUpdateOptionsParams::default(); + update_options.ask_user_disabled = Some(true); + update_options.available_tools = Some(vec!["view".to_string()]); + update_options.client_name = Some("rust-rpc-e2e".to_string()); + update_options.enable_streaming = Some(true); + update_options.model = Some(MODEL_ID.to_string()); + update_options.working_directory = Some(ctx.work_dir().display().to_string()); + let options = session .rpc() .options() - .update(SessionUpdateOptionsParams { - ask_user_disabled: Some(true), - available_tools: Some(vec!["view".to_string()]), - client_name: Some("rust-rpc-e2e".to_string()), - enable_streaming: Some(true), - model: Some(MODEL_ID.to_string()), - working_directory: Some(ctx.work_dir().display().to_string()), - ..SessionUpdateOptionsParams::default() - }) + .update(update_options) .await .expect("update options"); assert!(options.success); @@ -796,7 +814,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| { @@ -854,51 +873,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() - .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"); - }) - }) + 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(SettableAuthInfo::User(UserAuthInfo { + host: "github.com".to_string(), + login: "rpc-session-user".to_string(), + ..Default::default() + })), + }) + .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| { @@ -956,7 +981,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| { @@ -992,7 +1018,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| { @@ -1023,7 +1050,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 @@ -1039,7 +1066,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| { @@ -1074,10 +1102,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(); @@ -1181,3 +1210,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 index 3bd6c99bee..81901d06ae 100644 --- a/rust/tests/e2e/rpc_session_state_extras.rs +++ b/rust/tests/e2e/rpc_session_state_extras.rs @@ -3,11 +3,12 @@ use std::collections::HashMap; use github_copilot_sdk::Client; use github_copilot_sdk::rpc::{ CompletionsRequestRequest, MetadataContextHeaviestMessagesRequest, ModelSwitchToRequest, - NamedProviderConfig, PermissionsSetAllowAllRequest, ProviderAddRequest, ProviderConfigType, + NamedProviderConfig, PermissionsSetModeRequest, ProviderAddRequest, ProviderConfigType, ProviderConfigWireApi, ProviderModelConfig, SessionVisibilityStatus, SubagentSettingsEntry, SubagentSettingsEntryContextTier, UpdateSubagentSettingsRequest, UpdateSubagentSettingsRequestSubagents, VisibilitySetRequest, }; +use github_copilot_sdk::session_events::PermissionMode; use super::support::{assistant_message_content, with_e2e_context}; @@ -54,7 +55,8 @@ async fn should_list_models_for_session() { #[tokio::test] async fn should_report_session_activity_when_idle() { - with_e2e_context( + super::support::with_shared_e2e_context( + &E2E, "rpc_session_state_extras", "should_report_session_activity_when_idle", |ctx| { @@ -86,7 +88,8 @@ async fn should_report_session_activity_when_idle() { #[tokio::test] async fn should_get_and_set_allowall_permissions() { - with_e2e_context( + super::support::with_shared_e2e_context( + &E2E, "rpc_session_state_extras", "should_get_and_set_allowall_permissions", |ctx| { @@ -101,55 +104,55 @@ async fn should_get_and_set_allowall_permissions() { let initial = session .rpc() .permissions() - .get_allow_all() + .get_mode() .await - .expect("get initial allow-all"); - assert!(!initial.enabled); + .expect("get initial permission mode"); + assert_eq!(initial.mode, PermissionMode::Manual); let enable = session .rpc() .permissions() - .set_allow_all(PermissionsSetAllowAllRequest { - enabled: Some(true), - mode: None, - model: None, + .set_mode(PermissionsSetModeRequest { + assisted_approval_model: None, + mode: PermissionMode::AllowAll, source: None, }) .await - .expect("enable allow-all"); + .expect("set allow-all mode"); assert!(enable.success); - assert!(enable.enabled); - assert!( + assert_eq!(enable.mode, PermissionMode::AllowAll); + assert_eq!( session .rpc() .permissions() - .get_allow_all() + .get_mode() .await - .expect("get enabled allow-all") - .enabled + .expect("get allow-all mode") + .mode, + PermissionMode::AllowAll ); let disable = session .rpc() .permissions() - .set_allow_all(PermissionsSetAllowAllRequest { - enabled: Some(false), - mode: None, - model: None, + .set_mode(PermissionsSetModeRequest { + assisted_approval_model: None, + mode: PermissionMode::Manual, source: None, }) .await - .expect("disable allow-all"); + .expect("set manual mode"); assert!(disable.success); - assert!(!disable.enabled); - assert!( - !session + assert_eq!(disable.mode, PermissionMode::Manual); + assert_eq!( + session .rpc() .permissions() - .get_allow_all() + .get_mode() .await - .expect("get disabled allow-all") - .enabled + .expect("get manual mode") + .mode, + PermissionMode::Manual ); session.disconnect().await.expect("disconnect session"); @@ -162,7 +165,8 @@ async fn should_get_and_set_allowall_permissions() { #[tokio::test] async fn should_read_empty_sql_todos_for_fresh_session() { - with_e2e_context( + super::support::with_shared_e2e_context( + &E2E, "rpc_session_state_extras", "should_read_empty_sql_todos_for_fresh_session", |ctx| { @@ -193,7 +197,8 @@ async fn should_read_empty_sql_todos_for_fresh_session() { #[tokio::test] async fn should_get_telemetry_engagement_id() { - with_e2e_context( + super::support::with_shared_e2e_context( + &E2E, "rpc_session_state_extras", "should_get_telemetry_engagement_id", |ctx| { @@ -222,7 +227,8 @@ async fn should_get_telemetry_engagement_id() { #[tokio::test] async fn should_get_current_tool_metadata_after_initialization() { - with_e2e_context( + super::support::with_shared_e2e_context( + &E2E, "rpc_session_state_extras", "should_get_current_tool_metadata_after_initialization", |ctx| { @@ -262,7 +268,8 @@ async fn should_get_current_tool_metadata_after_initialization() { #[tokio::test] async fn should_add_byok_provider_and_model_at_runtime() { - with_e2e_context( + super::support::with_shared_e2e_context( + &E2E, "rpc_session_state_extras", "should_add_byok_provider_and_model_at_runtime", |ctx| { @@ -298,7 +305,7 @@ async fn should_add_byok_provider_and_model_at_runtime() { id: "small".to_string(), max_context_window_tokens: None, max_output_tokens: None, - max_prompt_tokens: Some(4096.0), + max_prompt_tokens: Some(4096), model_id: None, name: Some("Rust Added Model".to_string()), provider: "rust-e2e-provider".to_string(), @@ -314,12 +321,8 @@ async fn should_add_byok_provider_and_model_at_runtime() { .rpc() .model() .switch_to(ModelSwitchToRequest { - context_tier: None, - model_capabilities: None, model_id: selection_id.to_string(), - reasoning_effort: None, - reasoning_summary: None, - verbosity: None, + ..Default::default() }) .await .expect("switch to added model"); @@ -341,7 +344,8 @@ async fn should_add_byok_provider_and_model_at_runtime() { #[tokio::test] async fn should_return_empty_completions_when_host_does_not_provide_them() { - with_e2e_context( + super::support::with_shared_e2e_context( + &E2E, "rpc_session_state_extras", "should_return_empty_completions_when_host_does_not_provide_them", |ctx| { @@ -374,7 +378,8 @@ async fn should_return_empty_completions_when_host_does_not_provide_them() { #[tokio::test] async fn should_report_visibility_as_unsynced_for_local_session() { - with_e2e_context( + super::support::with_shared_e2e_context( + &E2E, "rpc_session_state_extras", "should_report_visibility_as_unsynced_for_local_session", |ctx| { @@ -417,7 +422,8 @@ async fn should_report_visibility_as_unsynced_for_local_session() { #[tokio::test] async fn should_get_context_attribution_and_heaviest_messages_after_turn() { - with_e2e_context( + super::support::with_shared_e2e_context( + &E2E, "rpc_session_state_extras", "should_get_context_attribution_and_heaviest_messages_after_turn", |ctx| { @@ -463,7 +469,8 @@ async fn should_get_context_attribution_and_heaviest_messages_after_turn() { #[tokio::test] async fn should_update_and_clear_live_subagent_settings() { - with_e2e_context( + super::support::with_shared_e2e_context( + &E2E, "rpc_session_state_extras", "should_update_and_clear_live_subagent_settings", |ctx| { @@ -514,7 +521,8 @@ async fn should_update_and_clear_live_subagent_settings() { #[tokio::test] async fn should_reload_session_plugins() { - with_e2e_context( + super::support::with_shared_e2e_context( + &E2E, "rpc_session_state_extras", "should_reload_session_plugins", |ctx| { @@ -553,3 +561,5 @@ async fn should_reload_session_plugins() { ) .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 219929c44d..968d511475 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::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 74ae897369..df5ddb1dc7 100644 --- a/rust/tests/e2e/rpc_shell_edge_cases.rs +++ b/rust/tests/e2e/rpc_shell_edge_cases.rs @@ -1,17 +1,20 @@ use std::path::Path; +use std::time::Duration; 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; @@ -26,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(), @@ -49,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| { @@ -88,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| { @@ -124,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| { @@ -158,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| { @@ -203,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| { @@ -240,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| { @@ -316,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!( @@ -325,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!( @@ -388,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 index 7bd52ae9f9..43de1c2ccd 100644 --- a/rust/tests/e2e/rpc_shell_user_requested.rs +++ b/rust/tests/e2e/rpc_shell_user_requested.rs @@ -5,11 +5,12 @@ use std::time::Duration; use github_copilot_sdk::RequestId; use github_copilot_sdk::rpc::{ShellCancelUserRequestedRequest, ShellExecuteUserRequestedRequest}; -use super::support::{wait_for_condition, with_e2e_context}; +use super::support::wait_for_condition; #[tokio::test] async fn should_execute_user_requested_shell_command() { - with_e2e_context( + super::support::with_shared_e2e_context( + &E2E, "rpc_shell_user_requested", "should_execute_user_requested_shell_command", |ctx| { @@ -52,7 +53,8 @@ async fn should_execute_user_requested_shell_command() { #[tokio::test] async fn should_cancel_user_requested_shell_command() { - with_e2e_context( + super::support::with_shared_e2e_context( + &E2E, "rpc_shell_user_requested", "should_cancel_user_requested_shell_command", |ctx| { @@ -171,3 +173,5 @@ fn powershell_quote(path: &Path) -> String { 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 601cc70bf2..540238ddd0 100644 --- a/rust/tests/e2e/rpc_tasks_and_handlers.rs +++ b/rust/tests/e2e/rpc_tasks_and_handlers.rs @@ -27,11 +27,10 @@ use github_copilot_sdk::rpc::{ 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| { @@ -145,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| { @@ -182,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| { @@ -229,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| { @@ -272,6 +273,7 @@ async fn should_return_expected_results_for_missing_pending_handler_requestids() result: UIElicitationResponse { action: UIElicitationResponseAction::Cancel, content: Default::default(), + meta: None, }, }) .await @@ -322,6 +324,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, }, @@ -358,6 +361,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, }), ), @@ -401,6 +405,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, }) @@ -441,7 +446,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| { @@ -501,3 +507,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 index 83852d0927..5bb09882b0 100644 --- a/rust/tests/e2e/rpc_ui_ephemeral_query.rs +++ b/rust/tests/e2e/rpc_ui_ephemeral_query.rs @@ -1,10 +1,13 @@ use github_copilot_sdk::rpc::UIEphemeralQueryRequest; -use super::support::with_e2e_context; - +// TODO(cli-1.0.81-2): CLI 1.0.81-5 still fails session.ui.ephemeralQuery against the +// recorded snapshot on macOS ("Failed to get response from the AI model"). Re-enable +// once the runtime fix ships. +#[ignore = "blocked on CLI 1.0.81-5 session.ui.ephemeralQuery regression on macOS"] #[tokio::test] async fn should_answer_ephemeral_query() { - with_e2e_context( + super::support::with_shared_e2e_context( + &E2E, "rpc_ui_ephemeral_query", "should_answer_ephemeral_query", |ctx| { @@ -36,3 +39,5 @@ async fn should_answer_ephemeral_query() { ) .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 0a8bf56152..48145970ca 100644 --- a/rust/tests/e2e/rpc_workspace_checkpoints.rs +++ b/rust/tests/e2e/rpc_workspace_checkpoints.rs @@ -6,11 +6,10 @@ use github_copilot_sdk::rpc::{ 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,13 +39,16 @@ async fn should_list_no_checkpoints_for_fresh_session() { #[tokio::test] async fn should_return_null_or_empty_content_for_unknown_checkpoint() { - // In-process, session.workspaces.readCheckpoint is answered by the native runtime, - // which decodes the checkpoint number as a u32 and rejects the i64::MAX sentinel this - // test uses. Covered by the default (stdio) transport. See issue #1934. - if super::support::skip_inprocess("readCheckpoint decodes the id as u32 in-process") { + if super::support::skip_shared_e2e_inprocess( + &E2E, + "readCheckpoint decodes the id as u32 in-process", + ) + .await + { return; } - with_e2e_context( + super::support::with_shared_e2e_context( + &E2E, "rpc_workspace_checkpoints", "should_return_null_or_empty_content_for_unknown_checkpoint", |ctx| { @@ -76,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| { @@ -128,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| { @@ -188,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 45932ffdd0..e2ca76c478 100644 --- a/rust/tests/e2e/session.rs +++ b/rust/tests/e2e/session.rs @@ -21,39 +21,44 @@ 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; } @@ -88,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| { @@ -164,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| { @@ -206,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| { @@ -260,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| { @@ -296,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| { @@ -332,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| { @@ -371,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| { @@ -425,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; @@ -479,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| { @@ -535,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| { @@ -607,7 +630,7 @@ async fn should_resume_a_session_using_a_new_client() { #[tokio::test] async fn resumes_a_persisted_session_from_a_new_client_when_an_mcp_oauth_handler_is_configured() { - with_e2e_context( + super::support::with_dedicated_e2e_context( "session", "resumes_a_persisted_session_from_a_new_client_when_an_mcp_oauth_handler_is_configured", |ctx| { @@ -661,38 +684,44 @@ async fn resumes_a_persisted_session_from_a_new_client_when_an_mcp_oauth_handler #[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| { @@ -731,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| { @@ -767,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; - - 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() - ); + .expect("get missing metadata") + .is_none() + ); - 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 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| { @@ -921,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"); - - session.disconnect().await.expect("disconnect session"); - client.stop().await.expect("stop client"); - }) - }) + 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"); + }) + }, + ) .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=="; @@ -1139,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| { @@ -1394,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| { @@ -1515,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| { @@ -1545,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| { @@ -1659,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 dd498e3761..c3f6b57aea 100644 --- a/rust/tests/e2e/session_config.rs +++ b/rust/tests/e2e/session_config.rs @@ -15,9 +15,10 @@ use http::{HeaderMap, HeaderValue}; use parking_lot::Mutex; use serde_json::{Value, json}; -use super::support::{ - DEFAULT_TEST_TOKEN, E2eContext, with_e2e_context, with_e2e_context_no_snapshot, -}; +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."; @@ -90,7 +91,8 @@ fn task_agent_types(exchange: &Value) -> Vec { #[tokio::test] async fn should_apply_session_limits_on_create() { - with_e2e_context( + super::support::with_shared_e2e_context( + &E2E, "session_config", "should_apply_session_limits_on_create", |ctx| { @@ -123,7 +125,8 @@ async fn should_apply_session_limits_on_create() { #[tokio::test] async fn should_apply_session_limits_on_resume() { - with_e2e_context( + super::support::with_shared_e2e_context( + &E2E, "session_config", "should_apply_session_limits_on_resume", |ctx| { @@ -169,7 +172,8 @@ async fn should_apply_session_limits_on_resume() { #[tokio::test] async fn should_apply_excluded_built_in_agents_on_create() { - with_e2e_context( + super::support::with_shared_e2e_context( + &E2E, "session_config", "should_apply_excluded_built_in_agents_on_create", |ctx| { @@ -222,7 +226,8 @@ async fn should_apply_excluded_built_in_agents_on_create() { #[tokio::test] async fn should_apply_excluded_built_in_agents_on_resume() { - with_e2e_context( + super::support::with_shared_e2e_context( + &E2E, "session_config", "should_apply_excluded_built_in_agents_on_resume", |ctx| { diff --git a/rust/tests/e2e/session_fs_sqlite.rs b/rust/tests/e2e/session_fs_sqlite.rs index 0b99d951b0..919563c691 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( @@ -363,9 +407,13 @@ fn sqlite_session_config( .with_session_fs_provider(provider) } +// TODO(cli-1.0.81-2): CLI 1.0.81-2 hangs servicing the nested SQL tool request, so this test +// times out. Re-enable once the runtime reentrancy fix ships. +#[ignore = "blocked on CLI 1.0.81-2 nested tool-request servicing regression"] #[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 +425,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), @@ -433,9 +481,13 @@ async fn should_route_sql_queries_through_the_sessionfs_sqlite_handler() { .await; } +// TODO(cli-1.0.81-2): CLI 1.0.81-2 hangs servicing the nested SQL tool request, so this test +// times out. Re-enable once the runtime reentrancy fix ships. +#[ignore = "blocked on CLI 1.0.81-2 nested tool-request servicing regression"] #[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 +497,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 24938776f1..545bb49885 100644 --- a/rust/tests/e2e/session_lifecycle.rs +++ b/rust/tests/e2e/session_lifecycle.rs @@ -2,12 +2,12 @@ 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 index ebace39b3b..4b6245206f 100644 --- a/rust/tests/e2e/session_todos_changed.rs +++ b/rust/tests/e2e/session_todos_changed.rs @@ -1,6 +1,6 @@ use github_copilot_sdk::session_events::SessionEventType; -use super::support::{wait_for_event, with_e2e_context}; +use super::support::wait_for_event; const PROMPT: &str = concat!( "Use the sql tool exactly once to execute all three of the following statements ", @@ -14,7 +14,8 @@ const PROMPT: &str = concat!( #[tokio::test] async fn fires_session_todos_changed_and_exposes_rows_and_dependencies() { - with_e2e_context( + super::support::with_shared_e2e_context( + &E2E, "session_todos_changed", "fires_session_todos_changed_and_exposes_rows_and_dependencies", |ctx| { @@ -59,3 +60,5 @@ async fn fires_session_todos_changed_and_exposes_rows_and_dependencies() { ) .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 e0005ddf06..769b28b5f9 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 920ad695d0..a481771748 100644 --- a/rust/tests/e2e/streaming_fidelity.rs +++ b/rust/tests/e2e/streaming_fidelity.rs @@ -7,11 +7,12 @@ use github_copilot_sdk::session_events::{ SessionStartData, }; -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/support.rs b/rust/tests/e2e/support.rs index 6ad609f58e..76f9a21c8f 100644 --- a/rust/tests/e2e/support.rs +++ b/rust/tests/e2e/support.rs @@ -1,13 +1,17 @@ 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}; @@ -16,15 +20,280 @@ use github_copilot_sdk::{ 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>, { @@ -56,11 +325,56 @@ where ); } -/// Like [`with_e2e_context`] but starts the CapiProxy without loading a +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_e2e_context_no_snapshot(test: F) +pub async fn with_dedicated_e2e_context_no_snapshot(test: F) where F: for<'a> FnOnce(&'a mut E2eContext) -> TestFuture<'a>, { @@ -89,6 +403,15 @@ where ); } +/// 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, @@ -193,6 +516,7 @@ impl E2eContext { /// `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) @@ -330,6 +654,9 @@ impl E2eContext { .as_os_str() .to_owned(), ), + ]); + 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()), @@ -347,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() { @@ -783,6 +1234,20 @@ 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, @@ -802,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 { @@ -873,8 +1385,17 @@ impl CapiProxy { "/stop" }; let result = self.post_json(path, ""); - if let Some(mut child) = self.child.take() { - let _ = child.wait(); + if let Some(mut child) = self.child.take() + && let Err(error) = wait_for_child_exit(&mut child) + { + if result.is_err() { + return Err(error); + } + // The proxy acknowledges /stop before its asynchronous server shutdown. + // npm/tsx can occasionally leave its wrapper alive after the proxy has + // accepted the request; wait_for_child_exit has reaped it, so do not turn + // an otherwise successful test into a teardown failure. + eprintln!("force-killed E2E proxy after successful stop request: {error}"); } result } @@ -926,7 +1447,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}", @@ -1003,3 +1524,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 index e582d38464..f133367520 100644 --- a/rust/tests/e2e/system_message_sections.rs +++ b/rust/tests/e2e/system_message_sections.rs @@ -2,11 +2,12 @@ use std::collections::HashMap; use github_copilot_sdk::{SectionOverride, SystemMessageConfig}; -use super::support::{assistant_message_content, with_e2e_context}; +use super::support::assistant_message_content; #[tokio::test] async fn should_use_replaced_identity_section_in_response() { - with_e2e_context( + super::support::with_shared_e2e_context( + &E2E, "system_message_sections", "should_use_replaced_identity_section_in_response", |ctx| { @@ -60,7 +61,8 @@ async fn should_use_replaced_identity_section_in_response() { #[tokio::test] async fn should_use_replaced_preamble_section_in_response() { - with_e2e_context( + super::support::with_shared_e2e_context( + &E2E, "system_message_sections", "should_use_replaced_preamble_section_in_response", |ctx| { @@ -111,3 +113,5 @@ async fn should_use_replaced_preamble_section_in_response() { ) .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 f6905427ae..386cc2f560 100644 --- a/rust/tests/e2e/telemetry.rs +++ b/rust/tests/e2e/telemetry.rs @@ -83,11 +83,6 @@ async fn should_export_file_telemetry_for_sdk_interactions() { == Some(source_name) })); - let trace_ids: std::collections::HashSet<_> = spans - .iter() - .filter_map(|span| string_property(span, "traceId")) - .collect(); - assert_eq!(trace_ids.len(), 1); assert!(spans.iter().all(|span| status_code(span) != Some(2))); let invoke_agent = find_span(&spans, "invoke_agent"); @@ -97,6 +92,8 @@ async fn should_export_file_telemetry_for_sdk_interactions() { ); let invoke_agent_span_id = string_property(invoke_agent, "spanId").expect("invoke_agent span id"); + let invoke_agent_trace_id = + string_property(invoke_agent, "traceId").expect("invoke_agent trace id"); assert!(is_root_span(invoke_agent)); let chat_spans: Vec<_> = spans @@ -109,6 +106,7 @@ async fn should_export_file_telemetry_for_sdk_interactions() { assert!(!chat_spans.is_empty()); assert!(chat_spans.iter().all(|span| { string_property(span, "parentSpanId") == Some(invoke_agent_span_id) + && string_property(span, "traceId") == Some(invoke_agent_trace_id) })); assert!(chat_spans.iter().any(|span| string_attribute( span, @@ -126,6 +124,10 @@ async fn should_export_file_telemetry_for_sdk_interactions() { string_property(tool_span, "parentSpanId"), Some(invoke_agent_span_id) ); + assert_eq!( + string_property(tool_span, "traceId"), + Some(invoke_agent_trace_id) + ); assert_eq!( string_attribute(tool_span, "gen_ai.tool.name").as_deref(), Some(tool_name) diff --git a/rust/tests/e2e/tool_results.rs b/rust/tests/e2e/tool_results.rs index e6e62643fa..c46cacbf38 100644 --- a/rust/tests/e2e/tool_results.rs +++ b/rust/tests/e2e/tool_results.rs @@ -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| { @@ -356,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 2c474bca1b..586a31d3a1 100644 --- a/rust/tests/e2e/tools.rs +++ b/rust/tests/e2e/tools.rs @@ -9,11 +9,11 @@ use github_copilot_sdk::{ use serde_json::json; 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; @@ -75,7 +75,7 @@ async fn invokes_custom_tool() { #[tokio::test] async fn low_level_tool_definition() { - with_e2e_context("tools", "low_level_tool_definition", |ctx| { + 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; @@ -124,7 +124,7 @@ async fn low_level_tool_definition() { #[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; @@ -173,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; @@ -212,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; } @@ -291,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| { @@ -334,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| { @@ -380,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| { @@ -428,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| { @@ -864,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 7f7d432130..1735067c3e 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/protocol_version_test.rs b/rust/tests/protocol_version_test.rs index 9d613d8d76..0d1268c59e 100644 --- a/rust/tests/protocol_version_test.rs +++ b/rust/tests/protocol_version_test.rs @@ -127,6 +127,7 @@ async fn connect_handshake_supplies_protocol_version() { assert_eq!(req["method"], "connect"); // Token is None for the from_streams entry point (no transport spawn). assert!(req["params"].get("token").is_none()); + assert!(req["params"].get("clientInfo").is_none()); let response = serde_json::json!({ "jsonrpc": "2.0", "id": req["id"], diff --git a/rust/tests/session_test.rs b/rust/tests/session_test.rs index 122ec475df..a51d61910d 100644 --- a/rust/tests/session_test.rs +++ b/rust/tests/session_test.rs @@ -7,23 +7,29 @@ use std::time::Duration; use async_trait::async_trait; use github_copilot_sdk::canvas::{CanvasDeclaration, CanvasHandler, CanvasResult}; +use github_copilot_sdk::github_token::{ + GitHubToken, GitHubTokenProviderArgs, GitHubTokenProviderResult, GitHubTokenRequestReason, +}; use github_copilot_sdk::handler::{ ApproveAllHandler, AutoModeSwitchHandler, AutoModeSwitchResponse, ElicitationHandler, ExitPlanModeHandler, ExitPlanModeResult, McpAuthHandler, McpAuthRequest, McpAuthResult, - UserInputHandler, UserInputResponse, + PermissionHandler, PermissionResult, UserInputHandler, UserInputResponse, }; use github_copilot_sdk::rpc::{ CanvasProviderInvokeActionRequest, CanvasProviderOpenRequest, CanvasProviderOpenResult, OpenCanvasInstance, }; use github_copilot_sdk::session_events::{ - McpOauthRequiredData, ReasoningSummary, SessionLimitsConfig, + ManagedSettingsResolvedSource, McpOauthRequiredData, ReasoningSummary, SessionLimitsConfig, + SessionManagedSettingsResolvedData, }; use github_copilot_sdk::types::{ CanvasProviderIdentity, CloudSessionOptions, CloudSessionRepository, CommandContext, - CommandDefinition, CommandHandler, DeliveryMode, ElicitationRequest, ElicitationResult, - ExitPlanModeData, ExtensionInfo, MessageOptions, RequestId, SessionConfig, SessionId, - SetModelOptions, Tool, ToolInvocation, ToolResult, + CommandDefinition, CommandHandler, DeliveryMode, DisableBypassPermissionsModes, + ElicitationRequest, ElicitationResult, ExitPlanModeData, ExtensionInfo, ManagedSettings, + ManagedSettingsPermissions, MessageOptions, PermissionDecisionContext, + PermissionDecisionOutcome, PermissionDecisionSource, PermissionDecisionSurface, RequestId, + SessionConfig, SessionId, SetModelOptions, Tool, ToolInvocation, ToolResult, }; use github_copilot_sdk::{Client, ContextTier, ErrorKind, ProtocolErrorKind, tool}; use serde_json::Value; @@ -36,6 +42,25 @@ 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, + response_capability: None, + source: PermissionDecisionSource::HumanResponse, + surface: PermissionDecisionSurface::CopilotApp, + }) + } +} + #[async_trait] impl McpAuthHandler for CancelMcpAuthHandler { async fn handle( @@ -233,6 +258,228 @@ where (session, server) } +#[tokio::test] +async fn github_token_provider_uses_global_registration_and_maps_results() { + let (client, server_read, server_write) = make_client(); + let mut server = FakeServer { + read: server_read, + write: server_write, + session_id: "github-token-session".to_string(), + }; + let (args_tx, mut args_rx) = tokio::sync::mpsc::unbounded_channel(); + let provider = Arc::new(move |args: GitHubTokenProviderArgs| { + let args_tx = args_tx.clone(); + async move { + args_tx.send(args.clone()).unwrap(); + match args.host.as_str() { + "github.com" => Ok(GitHubTokenProviderResult::Token(GitHubToken::new( + "secret-token", + 8 * 60 * 60, + ))), + "cancel.example" => Ok(GitHubTokenProviderResult::Cancelled), + _ => Err(github_copilot_sdk::Error::with_message( + ErrorKind::GitHubTokenProvider, + "credential service unavailable", + )), + } + } + }); + let create_handle = tokio::spawn({ + let client = client.clone(); + async move { + client + .create_session( + SessionConfig::default() + .with_session_id("github-token-session") + .with_github_token_provider(provider), + ) + .await + .unwrap() + } + }); + + let create_request = server.read_request().await; + assert_eq!(create_request["method"], "session.create"); + assert!(create_request["params"].get("gitHubToken").is_none()); + let registration_id = create_request["params"]["gitHubTokenProviderRegistrationId"] + .as_str() + .unwrap() + .to_string(); + + server + .send_request( + 900, + "gitHubToken.getToken", + serde_json::json!({ + "registrationId": registration_id, + "host": "github.com", + "sessionId": "github-token-session", + "reason": "initial" + }), + ) + .await; + let token_response = server.read_response().await; + assert_eq!(token_response["result"]["kind"], "token"); + assert_eq!(token_response["result"]["accessToken"], "secret-token"); + assert_eq!(token_response["result"]["expiresIn"], 8 * 60 * 60); + let args = args_rx.recv().await.unwrap(); + assert_eq!(args.host, "github.com"); + assert_eq!( + args.session_id.as_ref().map(SessionId::as_str), + Some("github-token-session") + ); + assert_eq!(args.reason, GitHubTokenRequestReason::Initial); + + server + .send_request( + 901, + "gitHubToken.getToken", + serde_json::json!({ + "registrationId": registration_id, + "host": "cancel.example", + "reason": "refresh" + }), + ) + .await; + let cancelled = server.read_response().await; + assert_eq!(cancelled["result"]["kind"], "cancelled"); + + server + .send_request( + 902, + "gitHubToken.getToken", + serde_json::json!({ + "registrationId": registration_id, + "host": "error.example", + "reason": "refresh" + }), + ) + .await; + let provider_error = server.read_response().await; + assert_eq!(provider_error["error"]["code"], -32603); + assert!( + provider_error["error"]["message"] + .as_str() + .unwrap() + .contains("credential service unavailable") + ); + + server + .respond( + &create_request, + serde_json::json!({"sessionId": "github-token-session"}), + ) + .await; + let session = timeout(TIMEOUT, create_handle).await.unwrap().unwrap(); + + let delete_handle = tokio::spawn({ + let client = client.clone(); + async move { + client + .delete_session(&SessionId::new("github-token-session")) + .await + } + }); + let delete_request = server.read_request().await; + assert_eq!(delete_request["method"], "session.delete"); + server.respond(&delete_request, serde_json::json!({})).await; + timeout(TIMEOUT, delete_handle) + .await + .unwrap() + .unwrap() + .unwrap(); + + server + .send_request( + 903, + "gitHubToken.getToken", + serde_json::json!({ + "registrationId": registration_id, + "host": "github.com", + "reason": "refresh" + }), + ) + .await; + let unknown = server.read_response().await; + assert_eq!(unknown["error"]["code"], -32603); + assert!( + unknown["error"]["message"] + .as_str() + .unwrap() + .contains("unknown GitHub token provider registration") + ); + drop(session); +} + +#[tokio::test] +async fn github_token_provider_is_mutually_exclusive_and_rolls_back_failed_create() { + let provider = Arc::new(|_args: GitHubTokenProviderArgs| async { + Ok(GitHubTokenProviderResult::Cancelled) + }); + let (client, server_read, server_write) = make_client(); + let result = client + .create_session( + SessionConfig::default() + .with_github_token("static") + .with_github_token_provider(provider.clone()), + ) + .await; + let Err(error) = result else { + panic!("mutually exclusive GitHub credentials must be rejected"); + }; + assert!(matches!(error.kind(), ErrorKind::InvalidConfig)); + + let mut server = FakeServer { + read: server_read, + write: server_write, + session_id: "failed-create".to_string(), + }; + let create_handle = tokio::spawn({ + let client = client.clone(); + async move { + client + .create_session( + SessionConfig::default() + .with_session_id("failed-create") + .with_github_token_provider(provider), + ) + .await + } + }); + let create_request = server.read_request().await; + let registration_id = create_request["params"]["gitHubTokenProviderRegistrationId"] + .as_str() + .unwrap() + .to_string(); + let response = serde_json::json!({ + "jsonrpc": "2.0", + "id": create_request["id"], + "error": {"code": -32603, "message": "create failed"} + }); + write_framed(&mut server.write, &serde_json::to_vec(&response).unwrap()).await; + assert!( + timeout(TIMEOUT, create_handle) + .await + .unwrap() + .unwrap() + .is_err() + ); + + server + .send_request( + 904, + "gitHubToken.getToken", + serde_json::json!({ + "registrationId": registration_id, + "host": "github.com", + "reason": "initial" + }), + ) + .await; + let unknown = server.read_response().await; + assert_eq!(unknown["error"]["code"], -32603); +} + fn rand_id() -> u64 { static COUNTER: AtomicUsize = AtomicUsize::new(0); COUNTER.fetch_add(1, Ordering::Relaxed) as u64 @@ -639,6 +886,7 @@ async fn create_session_sends_new_session_options() { 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), }), @@ -655,6 +903,7 @@ async fn create_session_sends_new_session_options() { 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(); @@ -683,6 +932,7 @@ async fn resume_session_sends_new_session_options() { 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), }), @@ -700,6 +950,7 @@ async fn resume_session_sends_new_session_options() { 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; @@ -763,6 +1014,159 @@ async fn create_session_sends_canvas_wire_fields() { timeout(TIMEOUT, create_handle).await.unwrap().unwrap(); } +#[test] +fn managed_bypass_permissions_modes_use_wire_values() { + let disabled = ManagedSettingsPermissions::default() + .with_disable_bypass_permissions_mode(DisableBypassPermissionsModes::DISABLE); + assert_eq!( + serde_json::to_value(disabled).unwrap()["disableBypassPermissionsMode"], + "disable" + ); + + let known = ManagedSettingsPermissions::default() + .with_disable_bypass_permissions_mode(DisableBypassPermissionsModes::ALLOW_AUTO_ONLY); + assert_eq!( + serde_json::to_value(known).unwrap()["disableBypassPermissionsMode"], + "allow-auto-only" + ); + + let future = ManagedSettingsPermissions::default() + .with_disable_bypass_permissions_mode("future-fail-closed-mode"); + assert_eq!( + serde_json::to_value(future).unwrap()["disableBypassPermissionsMode"], + "future-fail-closed-mode" + ); +} + +#[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(DisableBypassPermissionsModes::ALLOW_AUTO_ONLY) + .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"], "allow-auto-only"); + 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) { @@ -2360,6 +2764,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; @@ -4172,13 +4615,10 @@ async fn create_serializes_commands_strips_handler() { let rollback = &wire[1]; assert_eq!(rollback["name"], "rollback"); - assert!( - rollback.get("description").is_none(), - "description should be omitted when None, got: {rollback}" - ); + assert_eq!(rollback["description"], ""); assert!(rollback.get("handler").is_none()); let rollback_keys: Vec<&String> = rollback.as_object().unwrap().keys().collect(); - assert_eq!(rollback_keys.len(), 1, "got keys: {rollback_keys:?}"); + assert_eq!(rollback_keys.len(), 2, "got keys: {rollback_keys:?}"); } #[tokio::test] @@ -4309,7 +4749,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 { @@ -4431,6 +4871,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) } @@ -4619,6 +5077,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 24ec217f5b..00afec6000 100644 --- a/scripts/codegen/csharp.ts +++ b/scripts/codegen/csharp.ts @@ -40,6 +40,7 @@ import { isSchemaExperimental, isSchemaInternal, isOpaqueJson, + isOpaqueInProcess, isObjectSchema, isVoidSchema, getNullableInner, @@ -66,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]; @@ -306,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); } @@ -827,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); @@ -845,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); } @@ -872,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 || []); @@ -897,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, " "); @@ -1249,9 +1387,6 @@ function resolveSessionPropertyType( function generateDataClass(variant: EventVariant, knownTypes: Map, nestedClasses: Map, enumOutput: string[]): string { const dataVisibility = isSchemaInternal(variant.dataSchema) ? "internal" : "public"; - if (!variant.dataSchema?.properties) return `${dataVisibility} sealed partial class ${variant.dataClassName} { }`; - - const required = new Set(variant.dataSchema.required || []); const lines: string[] = []; if (variant.dataDescription) { lines.push(...xmlDocComment(variant.dataDescription, "")); @@ -1264,6 +1399,12 @@ function generateDataClass(variant: EventVariant, knownTypes: Map a.localeCompare(b))) { @@ -1399,8 +1540,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); @@ -1420,6 +1566,7 @@ export async function generateSessionEvents(schemaPath?: string): Promise const resolvedPath = schemaPath ?? (await getSessionEventsSchemaPath()); 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}`); @@ -1624,7 +1771,8 @@ function emitRpcClass( className: string, schema: JSONSchema7, visibility: "public" | "internal", - extraClasses: string[] + extraClasses: string[], + inlineTypeParentName: string = className ): string { const effectiveSchema = resolveObjectSchema(schema, rpcDefinitions) ?? @@ -1671,7 +1819,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)); @@ -2037,7 +2185,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); @@ -2451,6 +2607,8 @@ function generateRpcCode( externalJsonSerializableRefs: Map> = new Map(), externalValueTypes: Set = new Set() ): string { + schema = cloneSchemaForCodegen(schema); + omitUnrepresentableInternalProperties(schema); emittedRpcClassSchemas.clear(); emittedRpcEnumResultTypes.clear(); experimentalRpcTypes.clear(); @@ -2563,15 +2721,25 @@ namespace GitHub.Copilot.Rpc; export async function generateRpc(schemaPath?: string, sessionEventsSchema?: JSONSchema7): Promise { console.log("C#: generating RPC types..."); const resolvedPath = schemaPath ?? (await getApiSchemaPath()); + handWrittenCSharpTypeNames = await collectHandWrittenCSharpTypeNames(); let schema = fixNullableRequiredRefsInApiSchema(cloneSchemaForCodegen((await loadSchemaJson(resolvedPath)) as ApiSchema)); + let sessionEventsCode: string | undefined; if (sessionEventsSchema) { + sessionEventsCode = generateSessionEventsCode(sessionEventsSchema); const sharedDefinitions = findSharedSchemaDefinitions( schema as unknown as Record, sessionEventsSchema as unknown as Record ); const reachableDefinitions = collectReachableDefinitionNames(sessionEventsSchema as unknown as Record); for (const name of [...sharedDefinitions]) { - if (!reachableDefinitions.has(name)) { + const typeName = typeToClassName(name); + const declarationPattern = new RegExp( + `\\bpublic\\s+(?:(?:sealed|abstract|partial|readonly)\\s+)*(?:class|struct|enum)\\s+${typeName}\\b` + ); + if ( + !reachableDefinitions.has(name) || + (!declarationPattern.test(sessionEventsCode) && !handWrittenCSharpTypeNames.has(typeName)) + ) { sharedDefinitions.delete(name); } } @@ -2579,8 +2747,7 @@ export async function generateRpc(schemaPath?: string, sessionEventsSchema?: JSO } const externalJsonSerializableRefs = new Map>(); const externalValueTypes = new Set(); - if (sessionEventsSchema) { - const sessionEventsCode = generateSessionEventsCode(sessionEventsSchema); + if (sessionEventsSchema && sessionEventsCode) { const externalRefs = collectExternalSchemaRefNames(schema); const sessionEventRefs = externalRefs.get("session-events.schema.json"); if (sessionEventRefs && sessionEventRefs.size > 0) { @@ -2592,7 +2759,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`); diff --git a/scripts/codegen/go.ts b/scripts/codegen/go.ts index b1d7474b98..acdea09727 100644 --- a/scripts/codegen/go.ts +++ b/scripts/codegen/go.ts @@ -14,6 +14,7 @@ import { fileURLToPath } from "url"; import { promisify } from "util"; import wordwrap from "wordwrap"; import { + addManagedApprovalRequiredToPermissionRequests, cloneSchemaForCodegen, collectDefinitionCollections, collectExperimentalOnlyRpcReferencedDefinitionNames, @@ -559,6 +560,7 @@ interface GoCodegenCtx { discriminatedUnionRawVariantSuffix?: string; skipDefinitionTypeNames?: Set; encodingBlocks?: Set; + unionVariantMarshalers?: Set; packageName?: string; } @@ -1338,8 +1340,11 @@ function pushGoJSONSchemaMatchLines( } } -function goVariantMatchFuncName(variantTypeName: string): string { - return goUnexportedFunctionName("matches", variantTypeName); +function goVariantMatchFuncName(unionTypeName: string, variantTypeName: string): string { + const scopedVariantName = variantTypeName.startsWith(unionTypeName) + ? variantTypeName + : `${unionTypeName}${variantTypeName}`; + return goUnexportedFunctionName("matches", scopedVariantName); } // Minimal checks used to distinguish variants that share the same discriminator. @@ -1711,13 +1716,14 @@ function pushGoJSONTargetedMatchSpecLines( } function goVariantMatchFunctionLines( + unionTypeName: string, variant: GoDiscriminatedUnionVariant, groupVariants: GoDiscriminatedUnionVariant[], discriminatorProp: string, ctx: GoCodegenCtx ): string[] { const lines: string[] = []; - lines.push(`func ${goVariantMatchFuncName(variant.typeName)}(data []byte) bool {`); + lines.push(`func ${goVariantMatchFuncName(unionTypeName, variant.typeName)}(data []byte) bool {`); const spec = goVariantTargetedMatchSpec(variant, groupVariants, discriminatorProp, ctx); if (spec.positiveTerms.length === 0 && spec.negativeExistsPaths.length === 0) { pushGoJSONSchemaMatchLines(lines, variant.schema, "data", ctx, "\t", "raw"); @@ -1812,6 +1818,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(``); @@ -1826,7 +1835,7 @@ function emitGoFlatDiscriminatedUnion( for (const variant of unionVariants) { const groupVariants = ambiguousGroupsByVariantTypeName.get(variant.typeName); if (groupVariants) { - pushGoEncodingBlock(goVariantMatchFunctionLines(variant, groupVariants, discriminatorProp, ctx), ctx); + pushGoEncodingBlock(goVariantMatchFunctionLines(typeName, variant, groupVariants, discriminatorProp, ctx), ctx); } } @@ -1864,7 +1873,7 @@ function emitGoFlatDiscriminatedUnion( unmarshalLines.push(`\t\treturn &d, nil`); } else { for (const mappedVariant of mappedVariants) { - unmarshalLines.push(`\t\tif ${goVariantMatchFuncName(mappedVariant.typeName)}(data) {`); + unmarshalLines.push(`\t\tif ${goVariantMatchFuncName(typeName, mappedVariant.typeName)}(data) {`); unmarshalLines.push(`\t\t\tvar d ${mappedVariant.typeName}`); unmarshalLines.push(`\t\t\tif err := json.Unmarshal(data, &d); err != nil {`); unmarshalLines.push(`\t\t\t\treturn nil, err`); @@ -1967,18 +1976,22 @@ function emitGoFlatDiscriminatedUnion( lines.push(`\treturn ${discGoType}(r.Discriminator)`); } lines.push(`}`); - pushGoEncodingBlock([ - `func (r ${variantTypeName}) MarshalJSON() ([]byte, error) {`, - `\ttype alias ${variantTypeName}`, - `\treturn json.Marshal(struct {`, - `\t\t${discGoName} ${discGoType} \`json:"${discriminatorProp}"\``, - `\t\talias`, - `\t}{`, - `\t\t${discGoName}: r.${discriminatorMethodName}(),`, - `\t\talias: alias(r),`, - `\t})`, - `}`, - ], ctx); + ctx.unionVariantMarshalers ??= new Set(); + if (!ctx.unionVariantMarshalers.has(variantTypeName)) { + ctx.unionVariantMarshalers.add(variantTypeName); + pushGoEncodingBlock([ + `func (r ${variantTypeName}) MarshalJSON() ([]byte, error) {`, + `\ttype alias ${variantTypeName}`, + `\treturn json.Marshal(struct {`, + `\t\t${discGoName} ${discGoType} \`json:"${discriminatorProp}"\``, + `\t\talias`, + `\t}{`, + `\t\t${discGoName}: r.${discriminatorMethodName}(),`, + `\t\talias: alias(r),`, + `\t})`, + `}`, + ], ctx); + } } ctx.structs.push(lines.join("\n")); @@ -2013,7 +2026,7 @@ function emitGoRequiredFieldDiscriminatedUnion( lines.push(``); for (const variant of unionVariants) { - pushGoEncodingBlock(goVariantMatchFunctionLines(variant, unionVariants, "", ctx), ctx); + pushGoEncodingBlock(goVariantMatchFunctionLines(typeName, variant, unionVariants, "", ctx), ctx); } const unmarshalLines: string[] = []; @@ -2022,7 +2035,7 @@ function emitGoRequiredFieldDiscriminatedUnion( unmarshalLines.push(`\t\treturn nil, nil`); unmarshalLines.push(`\t}`); for (const variant of unionVariants) { - unmarshalLines.push(`\tif ${goVariantMatchFuncName(variant.typeName)}(data) {`); + unmarshalLines.push(`\tif ${goVariantMatchFuncName(typeName, variant.typeName)}(data) {`); unmarshalLines.push(`\t\tvar d ${variant.typeName}`); unmarshalLines.push(`\t\tif err := json.Unmarshal(data, &d); err != nil {`); unmarshalLines.push(`\t\t\treturn nil, err`); @@ -2886,10 +2899,13 @@ function emitGoUnionWrapperStruct(typeName: string, schema: JSONSchema7, ctx: Go discriminatorValues: [], })); for (const variant of matchVariants) { - pushGoEncodingBlock(goVariantMatchFunctionLines(variant, matchVariants, "", ctx), ctx); + pushGoEncodingBlock(goVariantMatchFunctionLines(typeName, variant, matchVariants, "", ctx), ctx); } for (const [index, variant] of matchVariants.entries()) { - matchFunctionsByField.set(objectVariantSchemas[index].field.name, goVariantMatchFuncName(variant.typeName)); + matchFunctionsByField.set( + objectVariantSchemas[index].field.name, + goVariantMatchFuncName(typeName, variant.typeName) + ); } } encodingLines.push(`func (r ${typeName}) MarshalJSON() ([]byte, error) {`); @@ -3641,19 +3657,14 @@ function resolveSharedAnyOfVariant( 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; - } + // Read the directory entries with their types so the file check and the read + // are not separate operations on the same path. + const entries = await fs.readdir(goDir, { withFileTypes: true }).catch(() => []); 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"); + if (!entry.isFile()) continue; + if (!entry.name.endsWith(".go")) continue; + if (entry.name.startsWith("z")) continue; + const content = await fs.readFile(path.join(goDir, entry.name), "utf-8"); for (const name of collectGoTopLevelNames(content, "type")) names.add(name); for (const name of collectGoTopLevelNames(content, "const")) names.add(name); } @@ -3679,7 +3690,9 @@ async function generateSessionEvents(schemaPath?: string, apiSchema?: ApiSchema) console.log("Go: generating session-events..."); const resolvedPath = schemaPath ?? (await getSessionEventsSchemaPath()); - const schema = cloneSchemaForCodegen((await loadSchemaJson(resolvedPath)) as JSONSchema7); + const schema = addManagedApprovalRequiredToPermissionRequests( + (await loadSchemaJson(resolvedPath)) as JSONSchema7 + ); const processed = propagateInternalVisibility(postProcessSchema(schema)); const processedApiSchema = apiSchema ? propagateInternalVisibility(postProcessSchema(cloneSchemaForCodegen(apiSchema as JSONSchema7)) as JSONSchema7) diff --git a/scripts/codegen/package-lock.json b/scripts/codegen/package-lock.json index 5ed410e943..3d631c1b11 100644 --- a/scripts/codegen/package-lock.json +++ b/scripts/codegen/package-lock.json @@ -697,9 +697,9 @@ "license": "BSD-3-Clause" }, "node_modules/js-yaml": { - "version": "4.2.0", - "resolved": "https://registry.npmjs.org/js-yaml/-/js-yaml-4.2.0.tgz", - "integrity": "sha512-ePWsvanv0DWuDRsW8dnt+R4jQ31SCRCQ7hhNcPXZPsoBZiemuZNYGf7adZdqX2D86j6rvKp3RpCxVTSb8WQlOw==", + "version": "4.3.1", + "resolved": "https://registry.npmjs.org/js-yaml/-/js-yaml-4.3.1.tgz", + "integrity": "sha512-CY6crGq313MX8GkwvB7tzgp99vjQxY1++5y10/BKN/GUfHqWaOGQMNZkBvqSzsZKWk/ijwHlWzzkLulsGHhjWQ==", "funding": [ { "type": "github", diff --git a/scripts/codegen/python.ts b/scripts/codegen/python.ts index 5b343122b6..bdb4d095b7 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, @@ -200,6 +201,17 @@ function collectPythonExternalEnumNames( return enumNames; } +function preservePythonSessionEventConstructorOrder(schema: JSONSchema7): void { + for (const definitions of [schema.definitions, schema.$defs]) { + if (!definitions) continue; + const customTool = definitions.PermissionRequestCustomTool; + if (!customTool || typeof customTool !== "object") continue; + const skipPermission = (customTool as JSONSchema7).properties?.skipPermission; + if (!skipPermission || typeof skipPermission !== "object") continue; + (skipPermission as Record)["x-copilot-sdk-append-last"] = true; + } +} + function preservePythonRpcStringDateFields(definitions: Record): void { const quotaSnapshot = definitions.AccountQuotaSnapshot; const resetDate = quotaSnapshot?.properties?.resetDate as JSONSchema7 | undefined; @@ -272,6 +284,39 @@ function postProcessExternalUnionAliasesForPython(code: string, aliases: Map; + dispatch: Array<{ value: PyDiscriminatorValue; typeName: string }>; } function postProcessRefBasedDiscriminatedUnionsForPython( code: string, @@ -304,7 +349,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[] = []; @@ -334,7 +379,7 @@ function postProcessRefBasedDiscriminatedUnionsForPython( discriminator.property ]; return { - value: String(discProp.const), + value: pyDiscriminatorValue(discProp.const), typeName: toPascalCase(variantRefNames[i]), }; }); @@ -387,7 +432,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]); @@ -450,7 +495,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}")` @@ -500,7 +545,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 @@ -571,9 +616,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 @@ -895,6 +940,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 @@ -1590,7 +1724,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); @@ -1599,7 +1733,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)) { @@ -1627,7 +1761,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( @@ -2219,9 +2353,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]) => { @@ -2441,6 +2585,13 @@ function emitPyFlatDiscriminatedUnion( ctx.classes.push(lines.join("\n")); } +const PYTHON_INTEGER_DECODER = [ + `def from_int(x: Any) -> int:`, + ` assert isinstance(x, (int, float)) and not isinstance(x, bool)`, + ` assert not isinstance(x, float) or x.is_integer()`, + ` return int(x)`, +].join("\n"); + export function generatePythonSessionEventsCode(schema: JSONSchema7): string { const variants = extractPyEventVariants(schema); const ctx: PyCodegenCtx = { @@ -2509,9 +2660,7 @@ export function generatePythonSessionEventsCode(schema: JSONSchema7): string { out.push(` return x`); out.push(``); out.push(``); - out.push(`def from_int(x: Any) -> int:`); - out.push(` assert isinstance(x, int) and not isinstance(x, bool)`); - out.push(` return x`); + out.push(PYTHON_INTEGER_DECODER); out.push(``); out.push(``); out.push(`def to_int(x: Any) -> int:`); @@ -2808,7 +2957,10 @@ async function generateSessionEvents(schemaPath?: string): Promise { console.log("Python: generating session-events..."); const resolvedPath = schemaPath ?? (await getSessionEventsSchemaPath()); - const schema = (await loadSchemaJson(resolvedPath)) as JSONSchema7; + const schema = addManagedApprovalRequiredToPermissionRequests( + (await loadSchemaJson(resolvedPath)) as JSONSchema7 + ); + preservePythonSessionEventConstructorOrder(schema); const processed = propagateInternalVisibility(postProcessSchema(schema)); let code = generatePythonSessionEventsCode(processed); const { typeNames } = collectInternalSymbols(processed); @@ -3212,6 +3364,14 @@ def _patch_model_capabilities(data: dict) -> dict: // Patch models.list to normalize capabilities before deserialization let finalCode = lines.join("\n"); + finalCode = finalCode.replace( + [ + `def from_int(x: Any) -> int:`, + ` assert isinstance(x, int) and not isinstance(x, bool)`, + ` return x`, + ].join("\n"), + PYTHON_INTEGER_DECODER + ); finalCode = finalCode.replace( `ModelList.from_dict(await self._client.request("models.list"`, `ModelList.from_dict(_patch_model_capabilities(await self._client.request("models.list"`, @@ -3228,6 +3388,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. diff --git a/scripts/codegen/rust.ts b/scripts/codegen/rust.ts index 127dc2e48d..0feec5e98a 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, @@ -299,6 +300,7 @@ function tryEmitRustUnion( const enumName = (typeof schema.title === "string" && schema.title) || parentTypeName + toPascalCase(jsonPropName); + const isAllowedUnionType = ctx.allowedUnionTypeNames.has(enumName); const resolvedVariants: RustUnionVariant[] = []; for (let i = 0; i < nonNull.length; i++) { @@ -317,7 +319,20 @@ function tryEmitRustUnion( resolveObjectSchema(variant, ctx.definitions) ?? resolveSchema(variant, ctx.definitions) ?? variant; - if (!isObjectSchema(resolved)) return null; + if (!isObjectSchema(resolved)) { + if (!isAllowedUnionType) return null; + resolvedVariants.push({ + schema: resolved as JSONSchema7, + typeName: resolveRustType( + resolved as JSONSchema7, + enumName, + `variant${i + 1}`, + true, + ctx, + ), + }); + continue; + } const discriminatorValue = Object.values(resolved.properties ?? {}).find( (prop) => typeof prop === "object" && (prop as JSONSchema7).const !== undefined, ) as JSONSchema7 | undefined; @@ -334,7 +349,6 @@ function tryEmitRustUnion( } const discriminator = findRustDiscriminator(resolvedVariants); - const isAllowedUnionType = ctx.allowedUnionTypeNames.has(enumName); if (discriminator) { if ( ctx.unionDiscriminatorProperties && @@ -343,7 +357,7 @@ function tryEmitRustUnion( ) { return null; } - } else if (!ctx.allowUntaggedUnions || !isAllowedUnionType) { + } else if (!ctx.allowUntaggedUnions && !isAllowedUnionType) { return null; } @@ -1446,7 +1460,10 @@ function generateApiTypesCode( const defCollections = collectDefinitionCollections( apiSchema as Record, ); - const ctx = makeCtx(defCollections, { nonDefaultableTypes }); + const ctx = makeCtx(defCollections, { + nonDefaultableTypes, + allowedUnionTypeNames: ["AuthInfo", "McpOauthProbeResult", "SettableAuthInfo", "ToolResult"], + }); // Collect all RPC methods before emitting shared definitions so method stability // can propagate to referenced data types. @@ -2211,7 +2228,9 @@ async function generate(): Promise { 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 f82e67abe6..4984816d8d 100644 --- a/scripts/codegen/typescript.ts +++ b/scripts/codegen/typescript.ts @@ -40,7 +40,9 @@ import { isSchemaInternal, appendPropertyMarkerTagsToDescriptions, getEnumValueDescriptions, - stripOpaqueJsonMarker, + isBareSchemaNode, + isOpaqueInProcess, + isOpaqueJson, loadSchemaJson, fixBrandCasing, type ApiSchema, @@ -52,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, "* /"); } @@ -252,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; @@ -274,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")) { @@ -338,21 +475,37 @@ export function normalizeSchemaForTypeScript(schema: JSONSchema7): JSONSchema7 { // ── Session Events ────────────────────────────────────────────────────────── -async function generateSessionEvents(schemaPath?: string): Promise { - console.log("TypeScript: generating session-events..."); - - const resolvedPath = schemaPath ?? (await getSessionEventsSchemaPath()); - 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; +/** + * 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 = (sessionEvent.anyOf ?? []).filter((variant) => { + 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)) { @@ -365,6 +518,24 @@ async function generateSessionEvents(schemaPath?: string): Promise { } return false; }); + return { publicVariants, excludedDefinitionNames }; +} + +async function generateSessionEvents(schemaPath?: string): Promise { + console.log("TypeScript: generating session-events..."); + + const resolvedPath = schemaPath ?? (await getSessionEventsSchemaPath()); + 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 { publicVariants, excludedDefinitionNames } = filterPublicSessionEventVariants( + sessionEvent.anyOf ?? [], + definitionCollections + ); const publicDefinitions = Object.fromEntries( Object.entries(definitionCollections.definitions).filter(([name]) => !excludedDefinitionNames.has(name)) ); @@ -384,20 +555,31 @@ async function generateSessionEvents(schemaPath?: string): Promise { ); 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") { @@ -415,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}`); } @@ -546,6 +729,7 @@ 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 || {}); @@ -648,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 @@ -675,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(""); } @@ -758,7 +943,20 @@ function hasInternalMethods(node: Record): boolean { lines.push(...emitClientGlobalApiRegistration(schema.clientGlobal)); } - const outPath = await writeGeneratedFile("nodejs/src/generated/rpc.ts", lines.join("\n")); + // 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}`); } @@ -983,6 +1181,9 @@ function emitClientGlobalApiRegistration(clientSchema: Record): 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) { @@ -994,7 +1195,7 @@ function emitClientGlobalApiRegistration(clientSchema: Record): lines.push(`/** Handler for \`${groupName}\` client global API methods. */`); } lines.push(`export interface ${interfaceName} {`); - for (const method of methods) { + for (const method of publicMethods) { const name = handlerMethodName(method.rpcMethod); const hasParams = hasSchemaPayload(getMethodParamsSchema(method)); const pType = hasParams ? paramsTypeName(method) : ""; @@ -1019,7 +1220,9 @@ function emitClientGlobalApiRegistration(clientSchema: Record): lines.push(`/** All client global API handler groups. */`); lines.push(`export interface ClientGlobalApiHandlers {`); - for (const [groupName] of groups) { + 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};`); } @@ -1039,7 +1242,10 @@ function emitClientGlobalApiRegistration(clientSchema: Record): lines.push(`): void {`); for (const [groupName, methods] of groups) { - for (const method of methods) { + // 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)); diff --git a/scripts/codegen/utils.ts b/scripts/codegen/utils.ts index 9ab335b05f..590213d72b 100644 --- a/scripts/codegen/utils.ts +++ b/scripts/codegen/utils.ts @@ -199,6 +199,27 @@ export function postProcessSchema(schema: JSONSchema7): JSONSchema7 { const processed = { ...schema } as JSONSchema7WithDefs; + if (processed.title === "ProviderModelConfig" && processed.properties) { + const tokenFields = new Set([ + "maxPromptTokens", + "maxContextWindowTokens", + "maxOutputTokens", + ]); + processed.properties = Object.fromEntries( + Object.entries(processed.properties).map(([key, value]) => { + if ( + tokenFields.has(key) && + typeof value === "object" && + value !== null && + (value as JSONSchema7).type === "number" + ) { + return [key, { ...(value as JSONSchema7), type: "integer" }]; + } + return [key, value]; + }) + ); + } + if ("const" in processed && typeof processed.const === "boolean") { processed.enum = [processed.const]; delete processed.const; @@ -453,6 +474,50 @@ export function cloneSchemaForCodegen(value: T): T { return value; } +const PERMISSION_REQUEST_DEFINITION_NAMES = [ + "PermissionRequestCustomTool", + "PermissionRequestExtensionManagement", + "PermissionRequestExtensionEnvAccess", + "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; @@ -900,6 +965,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 60559d62d1..a975812af3 100644 --- a/scripts/corrections/package-lock.json +++ b/scripts/corrections/package-lock.json @@ -1107,9 +1107,9 @@ } }, "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": [ { @@ -1164,9 +1164,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": [ { @@ -1184,7 +1184,7 @@ ], "license": "MIT", "dependencies": { - "nanoid": "^3.3.12", + "nanoid": "^3.3.16", "picocolors": "^1.1.1", "source-map-js": "^1.2.1" }, @@ -1334,9 +1334,9 @@ } }, "node_modules/undici": { - "version": "6.27.0", - "resolved": "https://registry.npmjs.org/undici/-/undici-6.27.0.tgz", - "integrity": "sha512-YmfV3YnEDzXRC5lZ2jWtWWHKGUm1zIt8AhesR1tens+HTNv+YZlN/dp6G727LOvMJ8xjP9Be7Y2Sdr96LDm+pg==", + "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": { diff --git a/scripts/docs-validation/package-lock.json b/scripts/docs-validation/package-lock.json index 7b7ca5a65e..0c2751fa78 100644 --- a/scripts/docs-validation/package-lock.json +++ b/scripts/docs-validation/package-lock.json @@ -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": { diff --git a/scripts/docs-validation/validate.ts b/scripts/docs-validation/validate.ts index b609ef8593..6ce615eab2 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/.npmrc b/test/harness/.npmrc new file mode 100644 index 0000000000..100721e01a --- /dev/null +++ b/test/harness/.npmrc @@ -0,0 +1 @@ +omit-lockfile-registry-resolved=true diff --git a/test/harness/anthropicMessagesAdapter.ts b/test/harness/anthropicMessagesAdapter.ts index acc74a2bf9..36e98c3b36 100644 --- a/test/harness/anthropicMessagesAdapter.ts +++ b/test/harness/anthropicMessagesAdapter.ts @@ -4,6 +4,7 @@ import type { ChatCompletion } from "openai/resources/chat/completions"; import { + canonicalUserMessageSeparator, CanonicalMessage, CanonicalToolCall, formatSseEvent, @@ -178,7 +179,7 @@ function convertAnthropicUserMessage( content: onlyText ? contentParts .map((part) => (part.type === "text" ? part.text : "")) - .join("\n") + .join(canonicalUserMessageSeparator) : [...contentParts], }); contentParts.length = 0; diff --git a/test/harness/modelProtocolAdapterShared.ts b/test/harness/modelProtocolAdapterShared.ts index 1f879da5d0..dcfee3876e 100644 --- a/test/harness/modelProtocolAdapterShared.ts +++ b/test/harness/modelProtocolAdapterShared.ts @@ -4,6 +4,8 @@ export type JsonObject = Record; +export const canonicalUserMessageSeparator = "\n\n\n"; + export type CanonicalToolCall = { id: string; type: "function"; diff --git a/test/harness/modelProtocolAdapters.test.ts b/test/harness/modelProtocolAdapters.test.ts index ddb6fe40bf..c0ed084150 100644 --- a/test/harness/modelProtocolAdapters.test.ts +++ b/test/harness/modelProtocolAdapters.test.ts @@ -128,6 +128,52 @@ async function postJson( } describe("Anthropic Messages adapter", () => { + test("canonicalizes adjacent plain-text content blocks", () => { + const result = JSON.parse( + anthropicMessagesRequestToChatCompletion( + JSON.stringify({ + model: "test-model", + messages: [ + { + role: "user", + content: [ + { type: "text", text: "First prompt" }, + { type: "text", text: "Recovery prompt" }, + ], + }, + ], + }), + ), + ) as { + messages: Array<{ role: string; content: unknown }>; + }; + + expect(result.messages).toEqual([ + { + role: "user", + content: "First prompt\n\n\nRecovery prompt", + }, + ]); + }); + + test.each([ + ["string content", "Hello"], + ["one text block", [{ type: "text", text: "Hello" }]], + ])("preserves a single plain-text user block from %s", (_, content) => { + const result = JSON.parse( + anthropicMessagesRequestToChatCompletion( + JSON.stringify({ + model: "test-model", + messages: [{ role: "user", content }], + }), + ), + ) as { + messages: Array<{ role: string; content: unknown }>; + }; + + expect(result.messages).toEqual([{ role: "user", content: "Hello" }]); + }); + test("normalizes messages, binary content, and tools", () => { const result = JSON.parse( anthropicMessagesRequestToChatCompletion( @@ -589,6 +635,36 @@ describe("protocol-aware replay", () => { }); }); + test("canonicalizes Anthropic content blocks before coalescing user messages", async () => { + await writeSnapshot([ + { role: "system", content: "${system}" }, + { role: "user", content: "First prompt" }, + { role: "user", content: "Recovery prompt" }, + { role: "user", content: "Final prompt" }, + { role: "assistant", content: "Recovered" }, + ]); + const request = requestFor("anthropic-messages", "Final prompt"); + request.messages = [ + { + role: "user", + content: [ + { type: "text", text: "First prompt" }, + { type: "text", text: "Recovery prompt" }, + ], + }, + ...(request.messages as unknown[]), + ]; + + await withProxy("anthropic-messages", async (proxyUrl) => { + const response = await postJson( + proxyUrl, + endpoints["anthropic-messages"], + request, + ); + expect(response.status).toBe(200); + }); + }); + test.each(backends)( "replays compaction responses through %s", async (backend) => { diff --git a/test/harness/package-lock.json b/test/harness/package-lock.json index ca426f38a6..710d725318 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.73", + "@github/copilot": "^1.0.82-0", "@modelcontextprotocol/sdk": "^1.26.0", "@types/node": "^25.3.3", "@types/node-forge": "^1.3.14", @@ -26,7 +26,6 @@ }, "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", @@ -38,7 +37,6 @@ }, "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", @@ -49,7 +47,6 @@ }, "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", @@ -60,7 +57,6 @@ }, "node_modules/@esbuild/aix-ppc64": { "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" @@ -77,7 +73,6 @@ }, "node_modules/@esbuild/android-arm": { "version": "0.28.1", - "resolved": "https://registry.npmjs.org/@esbuild/android-arm/-/android-arm-0.28.1.tgz", "integrity": "sha512-0k2F129Xdio1TdJfzJ8sy1Q47vUD2NnwdhiAf7drUN1EBTfPf4hsFCtmMgu/6m8JSzsBrlmVjudMBQqOfG8usQ==", "cpu": [ "arm" @@ -94,7 +89,6 @@ }, "node_modules/@esbuild/android-arm64": { "version": "0.28.1", - "resolved": "https://registry.npmjs.org/@esbuild/android-arm64/-/android-arm64-0.28.1.tgz", "integrity": "sha512-34EGEbCIAgosYz6goLcopX6Mo7NyGv9tfwEM2/7Ce2VcVRk568iSvniGWcUXIy7wEDR1wzolcxcriFVrWYcwBg==", "cpu": [ "arm64" @@ -111,7 +105,6 @@ }, "node_modules/@esbuild/android-x64": { "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" @@ -128,7 +121,6 @@ }, "node_modules/@esbuild/darwin-arm64": { "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" @@ -145,7 +137,6 @@ }, "node_modules/@esbuild/darwin-x64": { "version": "0.28.1", - "resolved": "https://registry.npmjs.org/@esbuild/darwin-x64/-/darwin-x64-0.28.1.tgz", "integrity": "sha512-zfdzgK9ACBNZLI/CyHTOx81SyNbM6YXn7rxSgX97VjyiPl9W1i4Ka4fgKECEoFCKGpvBj5qArWIGgQjOwkgskQ==", "cpu": [ "x64" @@ -162,7 +153,6 @@ }, "node_modules/@esbuild/freebsd-arm64": { "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" @@ -179,7 +169,6 @@ }, "node_modules/@esbuild/freebsd-x64": { "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" @@ -196,7 +185,6 @@ }, "node_modules/@esbuild/linux-arm": { "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" @@ -213,7 +201,6 @@ }, "node_modules/@esbuild/linux-arm64": { "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" @@ -230,7 +217,6 @@ }, "node_modules/@esbuild/linux-ia32": { "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" @@ -247,7 +233,6 @@ }, "node_modules/@esbuild/linux-loong64": { "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" @@ -264,7 +249,6 @@ }, "node_modules/@esbuild/linux-mips64el": { "version": "0.28.1", - "resolved": "https://registry.npmjs.org/@esbuild/linux-mips64el/-/linux-mips64el-0.28.1.tgz", "integrity": "sha512-mRObBZeHh2OxcBFPWE/FjylkRgZdYuiTR3vaTozquCGOH14iP9oN4x4Ge81CoIDYQrXmIxpFumJBu5MtZpnQJQ==", "cpu": [ "mips64el" @@ -281,7 +265,6 @@ }, "node_modules/@esbuild/linux-ppc64": { "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" @@ -298,7 +281,6 @@ }, "node_modules/@esbuild/linux-riscv64": { "version": "0.28.1", - "resolved": "https://registry.npmjs.org/@esbuild/linux-riscv64/-/linux-riscv64-0.28.1.tgz", "integrity": "sha512-kw0owk1o0GFETUJyW0jc0G4Yzs0BHZn0JDZ8JRT088vjJYX777BAs1fDGxAC+q831qOs2DTC96mNsG2opdfyyQ==", "cpu": [ "riscv64" @@ -315,7 +297,6 @@ }, "node_modules/@esbuild/linux-s390x": { "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" @@ -332,7 +313,6 @@ }, "node_modules/@esbuild/linux-x64": { "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" @@ -349,7 +329,6 @@ }, "node_modules/@esbuild/netbsd-arm64": { "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" @@ -366,7 +345,6 @@ }, "node_modules/@esbuild/netbsd-x64": { "version": "0.28.1", - "resolved": "https://registry.npmjs.org/@esbuild/netbsd-x64/-/netbsd-x64-0.28.1.tgz", "integrity": "sha512-aeL6lAnN89Hz43Mlh1G8ARasbuoYvSITDEx0tHh5b7jJnHcssqgjy9Yx430GDpmCa6OyrKoS0aNRjKundRizGg==", "cpu": [ "x64" @@ -383,7 +361,6 @@ }, "node_modules/@esbuild/openbsd-arm64": { "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" @@ -400,7 +377,6 @@ }, "node_modules/@esbuild/openbsd-x64": { "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" @@ -417,7 +393,6 @@ }, "node_modules/@esbuild/openharmony-arm64": { "version": "0.28.1", - "resolved": "https://registry.npmjs.org/@esbuild/openharmony-arm64/-/openharmony-arm64-0.28.1.tgz", "integrity": "sha512-ge+Z7EXFNt2BO1oAMsVpiQ8EwndV9i1xXerAeTIK7AtPs3bKFXQM7nlRxDSIUIMeueR1CNXxqztLzdNeReKBJg==", "cpu": [ "arm64" @@ -434,7 +409,6 @@ }, "node_modules/@esbuild/sunos-x64": { "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" @@ -451,7 +425,6 @@ }, "node_modules/@esbuild/win32-arm64": { "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" @@ -468,7 +441,6 @@ }, "node_modules/@esbuild/win32-ia32": { "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" @@ -485,7 +457,6 @@ }, "node_modules/@esbuild/win32-x64": { "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 +472,8 @@ } }, "node_modules/@github/copilot": { - "version": "1.0.73", - "resolved": "https://registry.npmjs.org/@github/copilot/-/copilot-1.0.73.tgz", - "integrity": "sha512-8I2Ejg2CX/PQA3c2H8W1zuqhniCeR1q1/bD8CrV53/ZLw8GF7DAV0xQpwa8ELYvFgjXb6AADojafCKwdbVef+A==", + "version": "1.0.82-0", + "integrity": "sha512-fSZVNAzFFYaS6btYD0+cKF7SrrtOklhpkPs/cIMZY7Fgxoa6rfZrlTWXlQNgNIdwLp51XxwTfxnZO+D9+MQ5yg==", "dev": true, "license": "SEE LICENSE IN LICENSE.md", "dependencies": { @@ -513,20 +483,19 @@ "copilot": "npm-loader.js" }, "optionalDependencies": { - "@github/copilot-darwin-arm64": "1.0.73", - "@github/copilot-darwin-x64": "1.0.73", - "@github/copilot-linux-arm64": "1.0.73", - "@github/copilot-linux-x64": "1.0.73", - "@github/copilot-linuxmusl-arm64": "1.0.73", - "@github/copilot-linuxmusl-x64": "1.0.73", - "@github/copilot-win32-arm64": "1.0.73", - "@github/copilot-win32-x64": "1.0.73" + "@github/copilot-darwin-arm64": "1.0.82-0", + "@github/copilot-darwin-x64": "1.0.82-0", + "@github/copilot-linux-arm64": "1.0.82-0", + "@github/copilot-linux-x64": "1.0.82-0", + "@github/copilot-linuxmusl-arm64": "1.0.82-0", + "@github/copilot-linuxmusl-x64": "1.0.82-0", + "@github/copilot-win32-arm64": "1.0.82-0", + "@github/copilot-win32-x64": "1.0.82-0" } }, "node_modules/@github/copilot-darwin-arm64": { - "version": "1.0.73", - "resolved": "https://registry.npmjs.org/@github/copilot-darwin-arm64/-/copilot-darwin-arm64-1.0.73.tgz", - "integrity": "sha512-5jv7t2sw35/zI0cPze38hG6239NT5/q/Emjx6gLibYkolDqMDJjpm17Ps7tc8oafUEOiMQMb+ar7+qi6rSiGJA==", + "version": "1.0.82-0", + "integrity": "sha512-TzBYfyvxcw3z9Mu7U8TsFo/Nq7m5XS6ahT71aPL+gx/YId0kmenI27b9daXsK6LA1D0gsFGwNBDKINddqntt1g==", "cpu": [ "arm64" ], @@ -541,9 +510,8 @@ } }, "node_modules/@github/copilot-darwin-x64": { - "version": "1.0.73", - "resolved": "https://registry.npmjs.org/@github/copilot-darwin-x64/-/copilot-darwin-x64-1.0.73.tgz", - "integrity": "sha512-l794k6Ahb11AG2FQT/P4TEWxWblzM1h8aQQCzG8jBWp8dfwjhyYjJ+d+0CWQzM3Fc1ddNUZRjKXCUsfvFjiZhQ==", + "version": "1.0.82-0", + "integrity": "sha512-Lm/U5Q8kN8yEeBTWKTfIxXAgXaT6zqdBzAAO7lA4DWHZ92AEeZZiVTs6jEWsQ2aWB2uMs6zbn0vi6t+/jIqCGw==", "cpu": [ "x64" ], @@ -558,9 +526,8 @@ } }, "node_modules/@github/copilot-linux-arm64": { - "version": "1.0.73", - "resolved": "https://registry.npmjs.org/@github/copilot-linux-arm64/-/copilot-linux-arm64-1.0.73.tgz", - "integrity": "sha512-Zu0W5nupJjNeem0brqU/pG+VY0IWr6EWr/FsC90g5SEDiaM4VhVNVWcz8t0E3DQCSYetV6IBaNMtjs/3uIIiDQ==", + "version": "1.0.82-0", + "integrity": "sha512-YERVMC1Q4p6l6KQHL5rVOI52rWbvgp9IwyzUBaVSGrfFuqu5BEvZ9bgHPsxTYi3Npkt5KVOXEyPMU5rAY09qQQ==", "cpu": [ "arm64" ], @@ -575,9 +542,8 @@ } }, "node_modules/@github/copilot-linux-x64": { - "version": "1.0.73", - "resolved": "https://registry.npmjs.org/@github/copilot-linux-x64/-/copilot-linux-x64-1.0.73.tgz", - "integrity": "sha512-k33XIr6/PVp+K+5F/zv3No4PPaNImvHz73mcbIw63oxh5iiacXjgr0WqbBIS5s/rkhOWjNPIkbof/TTPZ7mQjA==", + "version": "1.0.82-0", + "integrity": "sha512-z2hxMVjqt4+xDRFTZv3/0K3X+aqcJhd6zPO2JxCpOVTh5CNZFaWk+XIa2iXAPWxFqdKJsQ4muXMl3zInaAOkRw==", "cpu": [ "x64" ], @@ -592,9 +558,8 @@ } }, "node_modules/@github/copilot-linuxmusl-arm64": { - "version": "1.0.73", - "resolved": "https://registry.npmjs.org/@github/copilot-linuxmusl-arm64/-/copilot-linuxmusl-arm64-1.0.73.tgz", - "integrity": "sha512-HJWzhfD3oaiIgfRAHkNWzp17fELtshqM9HVN5n+lFEmSO2EETCEh0P1lhJc4m+FYfXSJnL0raAqVuyaNMuPoPw==", + "version": "1.0.82-0", + "integrity": "sha512-EcUCv2PKhBzCCvpTaS511VYTDWyhudyIRPvBpc9gFNO3hjlgiNDusf4k9vP6+E3/lHenwGYzMsyRHcYIOy4vcQ==", "cpu": [ "arm64" ], @@ -609,9 +574,8 @@ } }, "node_modules/@github/copilot-linuxmusl-x64": { - "version": "1.0.73", - "resolved": "https://registry.npmjs.org/@github/copilot-linuxmusl-x64/-/copilot-linuxmusl-x64-1.0.73.tgz", - "integrity": "sha512-/BpOXSb16wHEu8I1SaKiLszQ4Kvu4+Z4uCn7W0bv4xI4fPZwTEG0u3zgaI2W9Ao3+aBl0XRpPmpWzE9ziYEq+w==", + "version": "1.0.82-0", + "integrity": "sha512-1fKVjUiZ1tdb0/d/re90EpFGXhlIPfjENp2Wo/2Kj592dWO3+IwM2qV/AOdMQ4pacW5iYHII7nibx1/EYq3LGQ==", "cpu": [ "x64" ], @@ -626,9 +590,8 @@ } }, "node_modules/@github/copilot-win32-arm64": { - "version": "1.0.73", - "resolved": "https://registry.npmjs.org/@github/copilot-win32-arm64/-/copilot-win32-arm64-1.0.73.tgz", - "integrity": "sha512-DbPeXiYzQjpOy9oboaBvuCzjRwfcL987c3bG09cK1crdCDrKfkTJ7NXpcp1KWRPIRFO1FQm1qToNE89J+L3uvg==", + "version": "1.0.82-0", + "integrity": "sha512-H341wuxQHhwe/yLmORHzwC3DGzFZgGzh+TpwfyK2zjeYVbwDZ3Bax8M+9CzIED9jIBdEfAmfGzxKUHFugpXTtQ==", "cpu": [ "arm64" ], @@ -643,9 +606,8 @@ } }, "node_modules/@github/copilot-win32-x64": { - "version": "1.0.73", - "resolved": "https://registry.npmjs.org/@github/copilot-win32-x64/-/copilot-win32-x64-1.0.73.tgz", - "integrity": "sha512-8D3E1l5i+N5Eq8HIOQpx+Zbcb3MXdFxszksM2gqq175Z1S7Zna67oY4GoR3psxlbIpSyHKiLEBWYiaps6ayHWw==", + "version": "1.0.82-0", + "integrity": "sha512-f1ba3gG8NaoYWFHtHaHcLN4It7mclkWdCOXvwFPqPEwqCEIx/+Zh6VHiOeIcNWRS0elRP6QYDCKaTDy1TW27uQ==", "cpu": [ "x64" ], @@ -661,7 +623,6 @@ }, "node_modules/@hono/node-server": { "version": "1.19.14", - "resolved": "https://registry.npmjs.org/@hono/node-server/-/node-server-1.19.14.tgz", "integrity": "sha512-GwtvgtXxnWsucXvbQXkRgqksiH2Qed37H9xHZocE5sA3N8O8O8/8FA3uclQXxXVzc9XBZuEOMK7+r02FmSpHtw==", "dev": true, "license": "MIT", @@ -674,14 +635,12 @@ }, "node_modules/@jridgewell/sourcemap-codec": { "version": "1.5.5", - "resolved": "https://registry.npmjs.org/@jridgewell/sourcemap-codec/-/sourcemap-codec-1.5.5.tgz", "integrity": "sha512-cYQ9310grqxueWbl+WuIUIaiUaDcj7WOq5fVhEljNVgRfOUhY9fy2zTvfoqWsnebh8Sl70VScFbICvJnLKB0Og==", "dev": true, "license": "MIT" }, "node_modules/@modelcontextprotocol/sdk": { "version": "1.26.0", - "resolved": "https://registry.npmjs.org/@modelcontextprotocol/sdk/-/sdk-1.26.0.tgz", "integrity": "sha512-Y5RmPncpiDtTXDbLKswIJzTqu2hyBKxTNsgKqKclDbhIgg1wgtf1fRuvxgTnRfcnxtvvgbIEcqUOzZrJ6iSReg==", "dev": true, "license": "MIT", @@ -722,7 +681,6 @@ }, "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", @@ -741,7 +699,6 @@ }, "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", @@ -751,7 +708,6 @@ }, "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" @@ -768,7 +724,6 @@ }, "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" @@ -785,7 +740,6 @@ }, "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" @@ -802,7 +756,6 @@ }, "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" @@ -819,7 +772,6 @@ }, "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" @@ -836,7 +788,6 @@ }, "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" @@ -853,7 +804,6 @@ }, "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": [ "arm64" @@ -870,7 +820,6 @@ }, "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" @@ -887,7 +836,6 @@ }, "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" @@ -904,7 +852,6 @@ }, "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" @@ -921,7 +868,6 @@ }, "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" @@ -938,7 +884,6 @@ }, "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" @@ -955,7 +900,6 @@ }, "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": [ "wasm32" @@ -974,7 +918,6 @@ }, "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": [ "arm64" @@ -991,7 +934,6 @@ }, "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" @@ -1008,21 +950,18 @@ }, "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", @@ -1033,7 +972,6 @@ }, "node_modules/@types/chai": { "version": "5.2.3", - "resolved": "https://registry.npmjs.org/@types/chai/-/chai-5.2.3.tgz", "integrity": "sha512-Mw558oeA9fFbv65/y4mHtXDs9bPnFMZAL/jxdPFUpOHHIXX91mcgEHbS5Lahr+pwZFR8A7GQleRWeI6cGFC2UA==", "dev": true, "license": "MIT", @@ -1044,21 +982,18 @@ }, "node_modules/@types/deep-eql": { "version": "4.0.2", - "resolved": "https://registry.npmjs.org/@types/deep-eql/-/deep-eql-4.0.2.tgz", "integrity": "sha512-c9h9dVVMigMPc4bwTvC5dxqtqJZwQPePsWjPlpSOnojbor6pGqdk541lfA7AqFQr5pB1BRdq0juY9db81BwyFw==", "dev": true, "license": "MIT" }, "node_modules/@types/estree": { "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" }, "node_modules/@types/node": { "version": "25.3.3", - "resolved": "https://registry.npmjs.org/@types/node/-/node-25.3.3.tgz", "integrity": "sha512-DpzbrH7wIcBaJibpKo9nnSQL0MTRdnWttGyE5haGwK86xgMOkFLp7vEyfQPGLOJh5wNYiJ3V9PmUMDhV9u8kkQ==", "dev": true, "license": "MIT", @@ -1068,7 +1003,6 @@ }, "node_modules/@types/node-forge": { "version": "1.3.14", - "resolved": "https://registry.npmjs.org/@types/node-forge/-/node-forge-1.3.14.tgz", "integrity": "sha512-mhVF2BnD4BO+jtOp7z1CdzaK4mbuK0LLQYAvdOLqHTavxFNq4zA1EmYkpnFjP8HOUzedfQkRnp0E2ulSAYSzAw==", "dev": true, "license": "MIT", @@ -1078,7 +1012,6 @@ }, "node_modules/@vitest/expect": { "version": "4.1.8", - "resolved": "https://registry.npmjs.org/@vitest/expect/-/expect-4.1.8.tgz", "integrity": "sha512-h3nDO677RDLEGlBxyQ5CW8RlMThSKSRLUePLOx09gNIWRL40edgA1GCZSZgf1W55MFAG6/Sw14KeaAnqv0NKdQ==", "dev": true, "license": "MIT", @@ -1096,7 +1029,6 @@ }, "node_modules/@vitest/mocker": { "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", @@ -1123,7 +1055,6 @@ }, "node_modules/@vitest/pretty-format": { "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", @@ -1136,7 +1067,6 @@ }, "node_modules/@vitest/runner": { "version": "4.1.8", - "resolved": "https://registry.npmjs.org/@vitest/runner/-/runner-4.1.8.tgz", "integrity": "sha512-EmVxeBAfMJvycdjd6Hm+RbFBbA9fKvo0Kx37hNpBYoYeavH3RNsBXWDooR1mgD52dCrxIIuP7UotpfiwOikvcg==", "dev": true, "license": "MIT", @@ -1150,7 +1080,6 @@ }, "node_modules/@vitest/snapshot": { "version": "4.1.8", - "resolved": "https://registry.npmjs.org/@vitest/snapshot/-/snapshot-4.1.8.tgz", "integrity": "sha512-acfZboRmAIf05DEKcBQy33VXojFJjtUdLyo7oOmV9kebb2xdU01UknNiPuPZoJZQyO7DF0gZdTGTpeAzET9QPQ==", "dev": true, "license": "MIT", @@ -1166,7 +1095,6 @@ }, "node_modules/@vitest/spy": { "version": "4.1.8", - "resolved": "https://registry.npmjs.org/@vitest/spy/-/spy-4.1.8.tgz", "integrity": "sha512-6EevtBp6OZOPF7bmz36HrGMeP3txgVSrgebWxHOafDXGkhIzfXK14f8KF6MuFfgXXUeHxmpD3BQxkV00/3s5mA==", "dev": true, "license": "MIT", @@ -1176,7 +1104,6 @@ }, "node_modules/@vitest/utils": { "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", @@ -1191,7 +1118,6 @@ }, "node_modules/accepts": { "version": "2.0.0", - "resolved": "https://registry.npmjs.org/accepts/-/accepts-2.0.0.tgz", "integrity": "sha512-5cvg6CtKwfgdmVqY1WIiXKc3Q1bkRqGLi+2W/6ao+6Y7gu/RCwRuAhGEzh5B4KlszSuTLgZYuqFqo5bImjNKng==", "dev": true, "license": "MIT", @@ -1205,7 +1131,6 @@ }, "node_modules/ajv": { "version": "8.18.0", - "resolved": "https://registry.npmjs.org/ajv/-/ajv-8.18.0.tgz", "integrity": "sha512-PlXPeEWMXMZ7sPYOHqmDyCJzcfNrUr3fGNKtezX14ykXOEIvyK81d+qydx89KY5O71FKMPaQ2vBfBFI5NHR63A==", "dev": true, "license": "MIT", @@ -1222,7 +1147,6 @@ }, "node_modules/ajv-formats": { "version": "3.0.1", - "resolved": "https://registry.npmjs.org/ajv-formats/-/ajv-formats-3.0.1.tgz", "integrity": "sha512-8iUql50EUR+uUcdRQ3HDqa6EVyo3docL8g5WJ3FNcWmu62IbkGUue/pEyLBW8VGKKucTPgqeks4fIU1DA4yowQ==", "dev": true, "license": "MIT", @@ -1240,7 +1164,6 @@ }, "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", @@ -1250,7 +1173,6 @@ }, "node_modules/body-parser": { "version": "2.2.2", - "resolved": "https://registry.npmjs.org/body-parser/-/body-parser-2.2.2.tgz", "integrity": "sha512-oP5VkATKlNwcgvxi0vM0p/D3n2C3EReYVX+DNYs5TjZFn/oQt2j+4sVJtSMr18pdRr8wjTcBl6LoV+FUwzPmNA==", "dev": true, "license": "MIT", @@ -1275,7 +1197,6 @@ }, "node_modules/bytes": { "version": "3.1.2", - "resolved": "https://registry.npmjs.org/bytes/-/bytes-3.1.2.tgz", "integrity": "sha512-/Nf7TyzTx6S3yRJObOAV7956r8cr2+Oj8AC5dt8wSP3BQAoeX58NoHyCU8P8zGkNXStjTSi6fzO6F0pBdcYbEg==", "dev": true, "license": "MIT", @@ -1285,7 +1206,6 @@ }, "node_modules/call-bind-apply-helpers": { "version": "1.0.2", - "resolved": "https://registry.npmjs.org/call-bind-apply-helpers/-/call-bind-apply-helpers-1.0.2.tgz", "integrity": "sha512-Sp1ablJ0ivDkSzjcaJdxEunN5/XvksFJ2sMBFfq6x0ryhQV/2b/KwFe21cMpmHtPOSij8K99/wSfoEuTObmuMQ==", "dev": true, "license": "MIT", @@ -1299,7 +1219,6 @@ }, "node_modules/call-bound": { "version": "1.0.4", - "resolved": "https://registry.npmjs.org/call-bound/-/call-bound-1.0.4.tgz", "integrity": "sha512-+ys997U96po4Kx/ABpBCqhA9EuxJaQWDQg7295H4hBphv3IZg0boBKuwYpt4YXp6MZ5AmZQnU/tyMTlRpaSejg==", "dev": true, "license": "MIT", @@ -1316,7 +1235,6 @@ }, "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", @@ -1326,7 +1244,6 @@ }, "node_modules/content-disposition": { "version": "1.0.1", - "resolved": "https://registry.npmjs.org/content-disposition/-/content-disposition-1.0.1.tgz", "integrity": "sha512-oIXISMynqSqm241k6kcQ5UwttDILMK4BiurCfGEREw6+X9jkkpEe5T9FZaApyLGGOnFuyMWZpdolTXMtvEJ08Q==", "dev": true, "license": "MIT", @@ -1340,7 +1257,6 @@ }, "node_modules/content-type": { "version": "1.0.5", - "resolved": "https://registry.npmjs.org/content-type/-/content-type-1.0.5.tgz", "integrity": "sha512-nTjqfcBFEipKdXCv4YDQWCfmcLZKm81ldF0pAopTvyrFGVbcR6P/VAAd5G7N+0tTr8QqiU0tFadD6FK4NtJwOA==", "dev": true, "license": "MIT", @@ -1350,14 +1266,12 @@ }, "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", "integrity": "sha512-yki5XnKuf750l50uGTllt6kKILY4nQ1eNIQatoXEByZ5dWgnKqbnqmTrBE5B4N7lrMJKQ2ytWMiTO2o0v6Ew/w==", "dev": true, "license": "MIT", @@ -1367,7 +1281,6 @@ }, "node_modules/cookie-signature": { "version": "1.2.2", - "resolved": "https://registry.npmjs.org/cookie-signature/-/cookie-signature-1.2.2.tgz", "integrity": "sha512-D76uU73ulSXrD1UXF4KE2TMxVVwhsnCgfAyTg9k8P6KGZjlXKrOLe4dJQKI3Bxi5wjesZoFXJWElNWBjPZMbhg==", "dev": true, "license": "MIT", @@ -1377,7 +1290,6 @@ }, "node_modules/cors": { "version": "2.8.6", - "resolved": "https://registry.npmjs.org/cors/-/cors-2.8.6.tgz", "integrity": "sha512-tJtZBBHA6vjIAaF6EnIaq6laBBP9aq/Y3ouVJjEfoHbRBcHBAHYcMh/w8LDrk2PvIMMq8gmopa5D4V8RmbrxGw==", "dev": true, "license": "MIT", @@ -1395,7 +1307,6 @@ }, "node_modules/cross-spawn": { "version": "7.0.6", - "resolved": "https://registry.npmjs.org/cross-spawn/-/cross-spawn-7.0.6.tgz", "integrity": "sha512-uV2QOWP2nWzsy2aMp8aRibhi9dlzF5Hgh5SHaB9OiTGEyDTiJJyx0uy51QXdyWbtAHNua4XJzUKca3OzKUd3vA==", "dev": true, "license": "MIT", @@ -1410,7 +1321,6 @@ }, "node_modules/debug": { "version": "4.4.3", - "resolved": "https://registry.npmjs.org/debug/-/debug-4.4.3.tgz", "integrity": "sha512-RGwwWnwQvkVfavKVt22FGLw+xYSdzARwm0ru6DhTVA3umU5hZc28V3kO4stgYryrTlLpuvgI9GiijltAjNbcqA==", "dev": true, "license": "MIT", @@ -1428,7 +1338,6 @@ }, "node_modules/depd": { "version": "2.0.0", - "resolved": "https://registry.npmjs.org/depd/-/depd-2.0.0.tgz", "integrity": "sha512-g7nH6P6dyDioJogAAGprGpCtVImJhpPk/roCzdb3fIh61/s/nPsfR6onyMwkCAR/OlC3yBC0lESvUoQEAssIrw==", "dev": true, "license": "MIT", @@ -1438,7 +1347,6 @@ }, "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, "license": "Apache-2.0", @@ -1448,7 +1356,6 @@ }, "node_modules/dunder-proto": { "version": "1.0.1", - "resolved": "https://registry.npmjs.org/dunder-proto/-/dunder-proto-1.0.1.tgz", "integrity": "sha512-KIN/nDJBQRcXw0MLVhZE9iQHmG68qAVIBg9CqmUYjmQIhgij9U5MFvrqkUL5FbtyyzZuOeOt0zdeRe4UY7ct+A==", "dev": true, "license": "MIT", @@ -1463,14 +1370,12 @@ }, "node_modules/ee-first": { "version": "1.1.1", - "resolved": "https://registry.npmjs.org/ee-first/-/ee-first-1.1.1.tgz", "integrity": "sha512-WMwm9LhRUo+WUaRN+vRuETqG89IgZphVSNkdFgeb6sS/E4OrDIN7t48CAewSHXc6C8lefD8KKfr5vY61brQlow==", "dev": true, "license": "MIT" }, "node_modules/encodeurl": { "version": "2.0.0", - "resolved": "https://registry.npmjs.org/encodeurl/-/encodeurl-2.0.0.tgz", "integrity": "sha512-Q0n9HRi4m6JuGIV1eFlmvJB7ZEVxu93IrMyiMsGC0lrMJMWzRgx6WGquyfQgZVb31vhGgXnfmPNNXmxnOkRBrg==", "dev": true, "license": "MIT", @@ -1480,7 +1385,6 @@ }, "node_modules/es-define-property": { "version": "1.0.1", - "resolved": "https://registry.npmjs.org/es-define-property/-/es-define-property-1.0.1.tgz", "integrity": "sha512-e3nRfgfUZ4rNGL232gUgX06QNyyez04KdjFrF+LTRoOXmrOgFKDg4BCdsjW8EnT69eqdYGmRpJwiPVYNrCaW3g==", "dev": true, "license": "MIT", @@ -1490,7 +1394,6 @@ }, "node_modules/es-errors": { "version": "1.3.0", - "resolved": "https://registry.npmjs.org/es-errors/-/es-errors-1.3.0.tgz", "integrity": "sha512-Zf5H2Kxt2xjTvbJvP2ZWLEICxA6j+hAmMzIlypy4xcBg1vKVnx89Wy0GbS+kf5cwCVFFzdCFh2XSCFNULS6csw==", "dev": true, "license": "MIT", @@ -1500,14 +1403,12 @@ }, "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/es-object-atoms": { "version": "1.1.1", - "resolved": "https://registry.npmjs.org/es-object-atoms/-/es-object-atoms-1.1.1.tgz", "integrity": "sha512-FGgH2h8zKNim9ljj7dankFPcICIK9Cp5bm+c2gQSYePhpaG5+esrLODihIorn+Pe6FGJzWhXQotPv73jTaldXA==", "dev": true, "license": "MIT", @@ -1520,7 +1421,6 @@ }, "node_modules/esbuild": { "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, @@ -1562,14 +1462,12 @@ }, "node_modules/escape-html": { "version": "1.0.3", - "resolved": "https://registry.npmjs.org/escape-html/-/escape-html-1.0.3.tgz", "integrity": "sha512-NiSupZ4OeuGwr68lGIeym/ksIZMJodUGOSCZ/FSnTxcrekbvqrgdUxlJOMpijaKZVjAJrWrGs/6Jy8OMuyj9ow==", "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", "integrity": "sha512-7RUKfXgSMMkzt6ZuXmqapOurLGPPfgj6l9uRZ7lRGolvk0y2yocc35LdcxKC5PQZdn2DMqioAQ2NoWcrTKmm6g==", "dev": true, "license": "MIT", @@ -1579,7 +1477,6 @@ }, "node_modules/etag": { "version": "1.8.1", - "resolved": "https://registry.npmjs.org/etag/-/etag-1.8.1.tgz", "integrity": "sha512-aIL5Fx7mawVa300al2BnEE4iNvo1qETxLrPI/o05L7z6go7fCw1J6EQmbK4FmJ2AS7kgVF/KEZWufBfdClMcPg==", "dev": true, "license": "MIT", @@ -1589,7 +1486,6 @@ }, "node_modules/eventsource": { "version": "3.0.7", - "resolved": "https://registry.npmjs.org/eventsource/-/eventsource-3.0.7.tgz", "integrity": "sha512-CRT1WTyuQoD771GW56XEZFQ/ZoSfWid1alKGDYMmkt2yl8UXrVR4pspqWNEcqKvVIzg6PAltWjxcSSPrboA4iA==", "dev": true, "license": "MIT", @@ -1602,7 +1498,6 @@ }, "node_modules/eventsource-parser": { "version": "3.0.6", - "resolved": "https://registry.npmjs.org/eventsource-parser/-/eventsource-parser-3.0.6.tgz", "integrity": "sha512-Vo1ab+QXPzZ4tCa8SwIHJFaSzy4R6SHf7BY79rFBDf0idraZWAkYrDjDj8uWaSm3S2TK+hJ7/t1CEmZ7jXw+pg==", "dev": true, "license": "MIT", @@ -1612,7 +1507,6 @@ }, "node_modules/expect-type": { "version": "1.3.0", - "resolved": "https://registry.npmjs.org/expect-type/-/expect-type-1.3.0.tgz", "integrity": "sha512-knvyeauYhqjOYvQ66MznSMs83wmHrCycNEN6Ao+2AeYEfxUIkuiVxdEa1qlGEPK+We3n0THiDciYSsCcgW/DoA==", "dev": true, "license": "Apache-2.0", @@ -1622,7 +1516,6 @@ }, "node_modules/express": { "version": "5.2.1", - "resolved": "https://registry.npmjs.org/express/-/express-5.2.1.tgz", "integrity": "sha512-hIS4idWWai69NezIdRt2xFVofaF4j+6INOpJlVOLDO8zXGpUVEVzIYk12UUi2JzjEzWL3IOAxcTubgz9Po0yXw==", "dev": true, "license": "MIT", @@ -1666,7 +1559,6 @@ }, "node_modules/express-rate-limit": { "version": "8.5.2", - "resolved": "https://registry.npmjs.org/express-rate-limit/-/express-rate-limit-8.5.2.tgz", "integrity": "sha512-5Kb34ipNX694DH48vN9irak1Qx30nb0PLYHXfJgw4YEjiC3ZEmZJhwOp+VfiCYwFzvFTdB9QkArYS5kXa2cx2A==", "dev": true, "license": "MIT", @@ -1685,15 +1577,13 @@ }, "node_modules/fast-deep-equal": { "version": "3.1.3", - "resolved": "https://registry.npmjs.org/fast-deep-equal/-/fast-deep-equal-3.1.3.tgz", "integrity": "sha512-f3qQ9oQy9j2AhBe/H9VC91wLmKBCCU/gDOnKNAYG5hswO7BLKj09Hc5HYNz9cGI++xlpDCIgDaitVs03ATR84Q==", "dev": true, "license": "MIT" }, "node_modules/fast-uri": { - "version": "3.1.4", - "resolved": "https://registry.npmjs.org/fast-uri/-/fast-uri-3.1.4.tgz", - "integrity": "sha512-8JnbkQ4juDyvYs4mgFGQqg4yCYtFDtUtmp2QIQq11ZZe5CFQ5wcqm1rqDgAh/QdMySuBnPzMUiJUNZG5N/AiQw==", + "version": "3.1.5", + "integrity": "sha512-gHwA1O9LDIcKunMKhObS/HimwtehO1nPUECKAu5TpKgaO19fcWEl4bliWe1jWxVFvIXztJjjQ4L8XQ1EU9f7Jw==", "dev": true, "funding": [ { @@ -1709,7 +1599,6 @@ }, "node_modules/fdir": { "version": "6.5.0", - "resolved": "https://registry.npmjs.org/fdir/-/fdir-6.5.0.tgz", "integrity": "sha512-tIbYtZbucOs0BRGqPJkshJUYdL+SDH7dVM8gjy+ERp3WAUjLEFJE+02kanyHtwjWOnwrKYBiwAmM0p4kLJAnXg==", "dev": true, "license": "MIT", @@ -1727,7 +1616,6 @@ }, "node_modules/finalhandler": { "version": "2.1.1", - "resolved": "https://registry.npmjs.org/finalhandler/-/finalhandler-2.1.1.tgz", "integrity": "sha512-S8KoZgRZN+a5rNwqTxlZZePjT/4cnm0ROV70LedRHZ0p8u9fRID0hJUZQpkKLzro8LfmC8sx23bY6tVNxv8pQA==", "dev": true, "license": "MIT", @@ -1749,7 +1637,6 @@ }, "node_modules/forwarded": { "version": "0.2.0", - "resolved": "https://registry.npmjs.org/forwarded/-/forwarded-0.2.0.tgz", "integrity": "sha512-buRG0fpBtRHSTCOASe6hD258tEubFoRLb4ZNA6NxMVHNw2gOcwHo9wyablzMzOA5z9xA9L1KNjk/Nt6MT9aYow==", "dev": true, "license": "MIT", @@ -1759,7 +1646,6 @@ }, "node_modules/fresh": { "version": "2.0.0", - "resolved": "https://registry.npmjs.org/fresh/-/fresh-2.0.0.tgz", "integrity": "sha512-Rx/WycZ60HOaqLKAi6cHRKKI7zxWbJ31MhntmtwMoaTeF7XFH9hhBp8vITaMidfljRQ6eYWCKkaTK+ykVJHP2A==", "dev": true, "license": "MIT", @@ -1769,7 +1655,6 @@ }, "node_modules/fsevents": { "version": "2.3.3", - "resolved": "https://registry.npmjs.org/fsevents/-/fsevents-2.3.3.tgz", "integrity": "sha512-5xoDfX+fL7faATnagmWPpbFtwh/R77WmMMqqHGS65C3vvB0YHrgF+B1YmZ3441tMj5n63k0212XNoJwzlhffQw==", "dev": true, "hasInstallScript": true, @@ -1784,7 +1669,6 @@ }, "node_modules/function-bind": { "version": "1.1.2", - "resolved": "https://registry.npmjs.org/function-bind/-/function-bind-1.1.2.tgz", "integrity": "sha512-7XHNxH7qX9xG5mIwxkhumTox/MIRNcOgDrxWsMt2pAr23WHp6MrRlN7FBSFpCpr+oVO0F744iUgR82nJMfG2SA==", "dev": true, "license": "MIT", @@ -1794,7 +1678,6 @@ }, "node_modules/get-intrinsic": { "version": "1.3.0", - "resolved": "https://registry.npmjs.org/get-intrinsic/-/get-intrinsic-1.3.0.tgz", "integrity": "sha512-9fSjSaos/fRIVIp+xSJlE6lfwhES7LNtKaCBIamHsjr2na1BiABJPo0mOjjz8GJDURarmCPGqaiVg5mfjb98CQ==", "dev": true, "license": "MIT", @@ -1819,7 +1702,6 @@ }, "node_modules/get-proto": { "version": "1.0.1", - "resolved": "https://registry.npmjs.org/get-proto/-/get-proto-1.0.1.tgz", "integrity": "sha512-sTSfBjoXBp89JvIKIefqw7U2CCebsc74kiY6awiGogKtoSGbgjYE/G/+l9sF3MWFPNc9IcoOC4ODfKHfxFmp0g==", "dev": true, "license": "MIT", @@ -1833,7 +1715,6 @@ }, "node_modules/gopd": { "version": "1.2.0", - "resolved": "https://registry.npmjs.org/gopd/-/gopd-1.2.0.tgz", "integrity": "sha512-ZUKRh6/kUFoAiTAtTYPZJ3hw9wNxx+BIBOijnlG9PnrJsCcSjs1wyyD6vJpaYtgnzDrKYRSqf3OO6Rfa93xsRg==", "dev": true, "license": "MIT", @@ -1846,7 +1727,6 @@ }, "node_modules/has-symbols": { "version": "1.1.0", - "resolved": "https://registry.npmjs.org/has-symbols/-/has-symbols-1.1.0.tgz", "integrity": "sha512-1cDNdwJ2Jaohmb3sg4OmKaMBwuC48sYni5HUw2DvsC8LjGTLK9h+eb1X6RyuOHe4hT0ULCW68iomhjUoKUqlPQ==", "dev": true, "license": "MIT", @@ -1859,7 +1739,6 @@ }, "node_modules/hasown": { "version": "2.0.2", - "resolved": "https://registry.npmjs.org/hasown/-/hasown-2.0.2.tgz", "integrity": "sha512-0hJU9SCPvmMzIBdZFqNPXWa6dqh7WdH0cII9y+CyS8rG3nL48Bclra9HmKhVVUHyPWNH5Y7xDwAB7bfgSjkUMQ==", "dev": true, "license": "MIT", @@ -1871,9 +1750,8 @@ } }, "node_modules/hono": { - "version": "4.12.32", - "resolved": "https://registry.npmjs.org/hono/-/hono-4.12.32.tgz", - "integrity": "sha512-XcuyW9qE2kJn07PkecMOBd5Vq/hMy7mmGw+idz1yblbg9N17ijJODrvPkn7/dwL3Kulj8LcRJ69DLOWf91dRUg==", + "version": "4.13.1", + "integrity": "sha512-kdJoFVv2xmayw6cY09H7AbMJMt8Jn5jdlEdXsP7AGBdF2DIptVlKlOLKXP41yPip4/a3yQPv9gVcJYI8YY04dw==", "dev": true, "license": "MIT", "engines": { @@ -1882,7 +1760,6 @@ }, "node_modules/http-errors": { "version": "2.0.1", - "resolved": "https://registry.npmjs.org/http-errors/-/http-errors-2.0.1.tgz", "integrity": "sha512-4FbRdAX+bSdmo4AUFuS0WNiPz8NgFt+r8ThgNWmlrjQjt1Q7ZR9+zTlce2859x4KSXrwIsaeTqDoKQmtP8pLmQ==", "dev": true, "license": "MIT", @@ -1903,7 +1780,6 @@ }, "node_modules/iconv-lite": { "version": "0.7.2", - "resolved": "https://registry.npmjs.org/iconv-lite/-/iconv-lite-0.7.2.tgz", "integrity": "sha512-im9DjEDQ55s9fL4EYzOAv0yMqmMBSZp6G0VvFyTMPKWxiSBHUj9NW/qqLmXUwXrrM7AvqSlTCfvqRb0cM8yYqw==", "dev": true, "license": "MIT", @@ -1920,15 +1796,13 @@ }, "node_modules/inherits": { "version": "2.0.4", - "resolved": "https://registry.npmjs.org/inherits/-/inherits-2.0.4.tgz", "integrity": "sha512-k/vGaX4/Yla3WzyMCvTQOXYeIHvqOKtnqBduzTHpzpQZzAskKMhZ2K+EnBiSM9zGSoIFeMpXKxa4dYeZIQqewQ==", "dev": true, "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", + "integrity": "sha512-oSK96Grm3aP6OrS263xVxbNDGVL7rzBtYdpGqlDG8iQdoenDoTs/nkki+DflYbAEE8Xl6o5YxhxlrKvI3nqKXQ==", "dev": true, "license": "MIT", "engines": { @@ -1937,7 +1811,6 @@ }, "node_modules/ipaddr.js": { "version": "1.9.1", - "resolved": "https://registry.npmjs.org/ipaddr.js/-/ipaddr.js-1.9.1.tgz", "integrity": "sha512-0KI/607xoxSToH7GjN1FfSbLoU0+btTicjsQSWQlh/hZykN8KpmMf7uYwPW3R+akZ6R/w18ZlXSHBYXiYUPO3g==", "dev": true, "license": "MIT", @@ -1947,21 +1820,18 @@ }, "node_modules/is-promise": { "version": "4.0.0", - "resolved": "https://registry.npmjs.org/is-promise/-/is-promise-4.0.0.tgz", "integrity": "sha512-hvpoI6korhJMnej285dSg6nu1+e6uxs7zG3BYAm5byqDsgJNWwxzM6z6iZiAgQR4TJ30JmBTOwqZUw3WlyH3AQ==", "dev": true, "license": "MIT" }, "node_modules/isexe": { "version": "2.0.0", - "resolved": "https://registry.npmjs.org/isexe/-/isexe-2.0.0.tgz", "integrity": "sha512-RHxMLp9lnKHGHRng9QFhRCMbYAcVpn69smSGcq3f36xjgVVWThj4qqLbTLlq7Ssj8B+fIQ1EuCEGI2lKsyQeIw==", "dev": true, "license": "ISC" }, "node_modules/jose": { "version": "6.1.3", - "resolved": "https://registry.npmjs.org/jose/-/jose-6.1.3.tgz", "integrity": "sha512-0TpaTfihd4QMNwrz/ob2Bp7X04yuxJkjRGi4aKmOqwhov54i6u79oCv7T+C7lo70MKH6BesI3vscD1yb/yzKXQ==", "dev": true, "license": "MIT", @@ -1971,21 +1841,18 @@ }, "node_modules/json-schema-traverse": { "version": "1.0.0", - "resolved": "https://registry.npmjs.org/json-schema-traverse/-/json-schema-traverse-1.0.0.tgz", "integrity": "sha512-NM8/P9n3XjXhIZn1lLhkFaACTOURQXjWhV4BA/RnOv8xvgqtqpAX9IO4mRQxSx1Rlo4tqzeqb0sOlruaOy3dug==", "dev": true, "license": "MIT" }, "node_modules/json-schema-typed": { "version": "8.0.2", - "resolved": "https://registry.npmjs.org/json-schema-typed/-/json-schema-typed-8.0.2.tgz", "integrity": "sha512-fQhoXdcvc3V28x7C7BMs4P5+kNlgUURe2jmUT1T//oBRMDrqy1QPelJimwZGo7Hg9VPV3EQV5Bnq4hbFy2vetA==", "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", @@ -2015,7 +1882,6 @@ }, "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" @@ -2036,7 +1902,6 @@ }, "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" @@ -2057,7 +1922,6 @@ }, "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" @@ -2078,7 +1942,6 @@ }, "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" @@ -2099,7 +1962,6 @@ }, "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" @@ -2120,7 +1982,6 @@ }, "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" @@ -2141,7 +2002,6 @@ }, "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" @@ -2162,7 +2022,6 @@ }, "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" @@ -2183,7 +2042,6 @@ }, "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" @@ -2204,7 +2062,6 @@ }, "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" @@ -2225,7 +2082,6 @@ }, "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" @@ -2246,7 +2102,6 @@ }, "node_modules/magic-string": { "version": "0.30.21", - "resolved": "https://registry.npmjs.org/magic-string/-/magic-string-0.30.21.tgz", "integrity": "sha512-vd2F4YUyEXKGcLHoq+TEyCjxueSeHnFxyyjNp80yg0XV4vUhnDer/lvvlqM/arB5bXQN5K2/3oinyCRyx8T2CQ==", "dev": true, "license": "MIT", @@ -2256,7 +2111,6 @@ }, "node_modules/math-intrinsics": { "version": "1.1.0", - "resolved": "https://registry.npmjs.org/math-intrinsics/-/math-intrinsics-1.1.0.tgz", "integrity": "sha512-/IXtbwEk5HTPyEwyKX6hGkYXxM9nbj64B+ilVJnC/R6B0pH5G4V3b0pVbL7DBj4tkhBAppbQUlf6F6Xl9LHu1g==", "dev": true, "license": "MIT", @@ -2266,7 +2120,6 @@ }, "node_modules/media-typer": { "version": "1.1.0", - "resolved": "https://registry.npmjs.org/media-typer/-/media-typer-1.1.0.tgz", "integrity": "sha512-aisnrDP4GNe06UcKFnV5bfMNPBUw4jsLGaWwWfnH3v02GnBuXX2MCVn5RbrWo0j3pczUilYblq7fQ7Nw2t5XKw==", "dev": true, "license": "MIT", @@ -2276,7 +2129,6 @@ }, "node_modules/merge-descriptors": { "version": "2.0.0", - "resolved": "https://registry.npmjs.org/merge-descriptors/-/merge-descriptors-2.0.0.tgz", "integrity": "sha512-Snk314V5ayFLhp3fkUREub6WtjBfPdCPY1Ln8/8munuLuiYhsABgBVWsozAG+MWMbVEvcdcpbi9R7ww22l9Q3g==", "dev": true, "license": "MIT", @@ -2289,7 +2141,6 @@ }, "node_modules/mime-db": { "version": "1.54.0", - "resolved": "https://registry.npmjs.org/mime-db/-/mime-db-1.54.0.tgz", "integrity": "sha512-aU5EJuIN2WDemCcAp2vFBfp/m4EAhWJnUNSSw0ixs7/kXbd6Pg64EmwJkNdFhB8aWt1sH2CTXrLxo/iAGV3oPQ==", "dev": true, "license": "MIT", @@ -2299,7 +2150,6 @@ }, "node_modules/mime-types": { "version": "3.0.2", - "resolved": "https://registry.npmjs.org/mime-types/-/mime-types-3.0.2.tgz", "integrity": "sha512-Lbgzdk0h4juoQ9fCKXW4by0UJqj+nOOrI9MJ1sSj4nI8aI2eo1qmvQEie4VD1glsS250n15LsWsYtCugiStS5A==", "dev": true, "license": "MIT", @@ -2316,15 +2166,13 @@ }, "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.12", - "resolved": "https://registry.npmjs.org/nanoid/-/nanoid-3.3.12.tgz", - "integrity": "sha512-ZB9RH/39qpq5Vu6Y+NmUaFhQR6pp+M2Xt76XBnEwDaGcVAqhlvxrl3B2bKS5D3NH3QR76v3aSrKaF/Kiy7lEtQ==", + "version": "3.3.17", + "integrity": "sha512-xQLf0A3HOMlgHq0n247/LRuAOYmB7dXJ/DvAxGvsSBij45XtBSmQycu+F8ODbHwns/XyFZagyL1+J0Offw1E0g==", "dev": true, "funding": [ { @@ -2342,7 +2190,6 @@ }, "node_modules/negotiator": { "version": "1.0.0", - "resolved": "https://registry.npmjs.org/negotiator/-/negotiator-1.0.0.tgz", "integrity": "sha512-8Ofs/AUQh8MaEcrlq5xOX0CQ9ypTF5dl78mjlMNfOK08fzpgTHQRQPBxcPlEtIw0yRpws+Zo/3r+5WRby7u3Gg==", "dev": true, "license": "MIT", @@ -2352,7 +2199,6 @@ }, "node_modules/node-forge": { "version": "1.4.0", - "resolved": "https://registry.npmjs.org/node-forge/-/node-forge-1.4.0.tgz", "integrity": "sha512-LarFH0+6VfriEhqMMcLX2F7SwSXeWwnEAJEsYm5QKWchiVYVvJyV9v7UDvUv+w5HO23ZpQTXDv/GxdDdMyOuoQ==", "dev": true, "license": "(BSD-3-Clause OR GPL-2.0)", @@ -2362,7 +2208,6 @@ }, "node_modules/object-assign": { "version": "4.1.1", - "resolved": "https://registry.npmjs.org/object-assign/-/object-assign-4.1.1.tgz", "integrity": "sha512-rJgTQnkUnH1sFw8yT6VSU3zD3sWmu6sZhIseY8VX+GRu3P6F7Fu+JNDoXfklElbLJSnc3FUQHVe4cU5hj+BcUg==", "dev": true, "license": "MIT", @@ -2372,7 +2217,6 @@ }, "node_modules/object-inspect": { "version": "1.13.4", - "resolved": "https://registry.npmjs.org/object-inspect/-/object-inspect-1.13.4.tgz", "integrity": "sha512-W67iLl4J2EXEGTbfeHCffrjDfitvLANg0UlX3wFUUSTx92KXRFegMHUVgSqE+wvhAbi4WqjGg9czysTV2Epbew==", "dev": true, "license": "MIT", @@ -2385,7 +2229,6 @@ }, "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": [ @@ -2396,7 +2239,6 @@ }, "node_modules/on-finished": { "version": "2.4.1", - "resolved": "https://registry.npmjs.org/on-finished/-/on-finished-2.4.1.tgz", "integrity": "sha512-oVlzkg3ENAhCk2zdv7IJwd/QUD4z2RxRwpkcGY8psCVcCYZNq4wYnVWALHM+brtuJjePWiYF/ClmuDr8Ch5+kg==", "dev": true, "license": "MIT", @@ -2409,7 +2251,6 @@ }, "node_modules/once": { "version": "1.4.0", - "resolved": "https://registry.npmjs.org/once/-/once-1.4.0.tgz", "integrity": "sha512-lNaJgI+2Q5URQBkccEKHTQOPaXdUxnZZElQTZY0MFUAuaEqe1E+Nyvgdz/aIyNi6Z9MzO5dv1H8n58/GELp3+w==", "dev": true, "license": "ISC", @@ -2419,7 +2260,6 @@ }, "node_modules/openai": { "version": "6.17.0", - "resolved": "https://registry.npmjs.org/openai/-/openai-6.17.0.tgz", "integrity": "sha512-NHRpPEUPzAvFOAFs9+9pC6+HCw/iWsYsKCMPXH5Kw7BpMxqd8g/A07/1o7Gx2TWtCnzevVRyKMRFqyiHyAlqcA==", "dev": true, "license": "Apache-2.0", @@ -2441,7 +2281,6 @@ }, "node_modules/parseurl": { "version": "1.3.3", - "resolved": "https://registry.npmjs.org/parseurl/-/parseurl-1.3.3.tgz", "integrity": "sha512-CiyeOxFT/JZyN5m0z9PfXw4SCBJ6Sygz1Dpl0wqjlhDEGGBP1GnsUVEL0p63hoG1fcj3fHynXi9NYO4nWOL+qQ==", "dev": true, "license": "MIT", @@ -2451,7 +2290,6 @@ }, "node_modules/path-key": { "version": "3.1.1", - "resolved": "https://registry.npmjs.org/path-key/-/path-key-3.1.1.tgz", "integrity": "sha512-ojmeN0qd+y0jszEtoY48r0Peq5dwMEkIlCOu6Q5f41lfkswXuKtYrhgoTpLnyIcHm24Uhqx+5Tqm2InSwLhE6Q==", "dev": true, "license": "MIT", @@ -2461,7 +2299,6 @@ }, "node_modules/path-to-regexp": { "version": "8.4.2", - "resolved": "https://registry.npmjs.org/path-to-regexp/-/path-to-regexp-8.4.2.tgz", "integrity": "sha512-qRcuIdP69NPm4qbACK+aDogI5CBDMi1jKe0ry5rSQJz8JVLsC7jV8XpiJjGRLLol3N+R5ihGYcrPLTno6pAdBA==", "dev": true, "license": "MIT", @@ -2472,21 +2309,18 @@ }, "node_modules/pathe": { "version": "2.0.3", - "resolved": "https://registry.npmjs.org/pathe/-/pathe-2.0.3.tgz", "integrity": "sha512-WUjGcAqP1gQacoQe+OBJsFA7Ld4DyXuUIjZ5cc75cLHvJ7dtNsTugphxIADwspS+AraAUePCKrSVtPLFj/F88w==", "dev": true, "license": "MIT" }, "node_modules/picocolors": { "version": "1.1.1", - "resolved": "https://registry.npmjs.org/picocolors/-/picocolors-1.1.1.tgz", "integrity": "sha512-xceH2snhtb5M9liqDsmEw56le376mTZkEX/jEb/RxNFyegNul7eNslCXP9FDj/Lcu0X8KEyMceP2ntpaHrDEVA==", "dev": true, "license": "ISC" }, "node_modules/picomatch": { "version": "4.0.4", - "resolved": "https://registry.npmjs.org/picomatch/-/picomatch-4.0.4.tgz", "integrity": "sha512-QP88BAKvMam/3NxH6vj2o21R6MjxZUAd6nlwAS/pnGvN9IVLocLHxGYIzFhg6fUQ+5th6P4dv4eW9jX3DSIj7A==", "dev": true, "license": "MIT", @@ -2499,7 +2333,6 @@ }, "node_modules/pkce-challenge": { "version": "5.0.1", - "resolved": "https://registry.npmjs.org/pkce-challenge/-/pkce-challenge-5.0.1.tgz", "integrity": "sha512-wQ0b/W4Fr01qtpHlqSqspcj3EhBvimsdh0KlHhH8HRZnMsEa0ea2fTULOXOS9ccQr3om+GcGRk4e+isrZWV8qQ==", "dev": true, "license": "MIT", @@ -2508,9 +2341,8 @@ } }, "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", + "integrity": "sha512-DTPx3RWSSnWyzLxQnlH0rJP+EW5ekl16ZU4/psbIhA0e53kJfdgaN5vKM+xP7yJtXVu+nfdVFmlgFDEKAe4Pyw==", "dev": true, "funding": [ { @@ -2528,7 +2360,7 @@ ], "license": "MIT", "dependencies": { - "nanoid": "^3.3.12", + "nanoid": "^3.3.16", "picocolors": "^1.1.1", "source-map-js": "^1.2.1" }, @@ -2538,7 +2370,6 @@ }, "node_modules/proxy-addr": { "version": "2.0.7", - "resolved": "https://registry.npmjs.org/proxy-addr/-/proxy-addr-2.0.7.tgz", "integrity": "sha512-llQsMLSUDUPT44jdrU/O37qlnifitDP+ZwrmmZcoSKyLKvtZxpyV0n2/bD/N4tBAAZ/gJEdZU7KMraoK1+XYAg==", "dev": true, "license": "MIT", @@ -2552,7 +2383,6 @@ }, "node_modules/qs": { "version": "6.15.2", - "resolved": "https://registry.npmjs.org/qs/-/qs-6.15.2.tgz", "integrity": "sha512-Rzq0KEyX/w/tEybncDgdkZrJgVUsUMk3xjh3t5bv3S1HTAtg+uOYt72+ZfwiQwKdysThkTBdL/rTi6HDmX9Ddw==", "dev": true, "license": "BSD-3-Clause", @@ -2568,7 +2398,6 @@ }, "node_modules/range-parser": { "version": "1.2.1", - "resolved": "https://registry.npmjs.org/range-parser/-/range-parser-1.2.1.tgz", "integrity": "sha512-Hrgsx+orqoygnmhFbKaHE6c296J+HTAQXoxEF6gNupROmmGJRoyzfG3ccAveqCBrwr/2yxQ5BVd/GTl5agOwSg==", "dev": true, "license": "MIT", @@ -2578,7 +2407,6 @@ }, "node_modules/raw-body": { "version": "3.0.2", - "resolved": "https://registry.npmjs.org/raw-body/-/raw-body-3.0.2.tgz", "integrity": "sha512-K5zQjDllxWkf7Z5xJdV0/B0WTNqx6vxG70zJE4N0kBs4LovmEYWJzQGxC9bS9RAKu3bgM40lrd5zoLJ12MQ5BA==", "dev": true, "license": "MIT", @@ -2594,7 +2422,6 @@ }, "node_modules/require-from-string": { "version": "2.0.2", - "resolved": "https://registry.npmjs.org/require-from-string/-/require-from-string-2.0.2.tgz", "integrity": "sha512-Xf0nWe6RseziFMu+Ap9biiUbmplq6S9/p+7w7YXP/JBHhrUDDUhwa+vANyubuqfZWTveU//DYVGsDG7RKL/vEw==", "dev": true, "license": "MIT", @@ -2604,7 +2431,6 @@ }, "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", @@ -2638,7 +2464,6 @@ }, "node_modules/router": { "version": "2.2.0", - "resolved": "https://registry.npmjs.org/router/-/router-2.2.0.tgz", "integrity": "sha512-nLTrUKm2UyiL7rlhapu/Zl45FwNgkZGaCpZbIHajDYgwlJCOzLSk+cIPAnsEqV955GjILJnKbdQC1nVPz+gAYQ==", "dev": true, "license": "MIT", @@ -2655,14 +2480,12 @@ }, "node_modules/safer-buffer": { "version": "2.1.2", - "resolved": "https://registry.npmjs.org/safer-buffer/-/safer-buffer-2.1.2.tgz", "integrity": "sha512-YZo3K82SD7Riyi0E1EQPojLz7kpepnSQI9IyPbHHg1XXXevb5dJI7tpyN2ADxGcQbHG7vcyRHk0cbwqcQriUtg==", "dev": true, "license": "MIT" }, "node_modules/send": { "version": "1.2.1", - "resolved": "https://registry.npmjs.org/send/-/send-1.2.1.tgz", "integrity": "sha512-1gnZf7DFcoIcajTjTwjwuDjzuz4PPcY2StKPlsGAQ1+YH20IRVrBaXSWmdjowTJ6u8Rc01PoYOGHXfP1mYcZNQ==", "dev": true, "license": "MIT", @@ -2689,7 +2512,6 @@ }, "node_modules/serve-static": { "version": "2.2.1", - "resolved": "https://registry.npmjs.org/serve-static/-/serve-static-2.2.1.tgz", "integrity": "sha512-xRXBn0pPqQTVQiC8wyQrKs2MOlX24zQ0POGaj0kultvoOCstBQM5yvOhAVSUwOMjQtTvsPWoNCHfPGwaaQJhTw==", "dev": true, "license": "MIT", @@ -2709,14 +2531,12 @@ }, "node_modules/setprototypeof": { "version": "1.2.0", - "resolved": "https://registry.npmjs.org/setprototypeof/-/setprototypeof-1.2.0.tgz", "integrity": "sha512-E5LDX7Wrp85Kil5bhZv46j8jOeboKq5JMmYM3gVGdGH8xFpPWXUMsNrlODCrkoxMEeNi/XZIwuRvY4XNwYMJpw==", "dev": true, "license": "ISC" }, "node_modules/shebang-command": { "version": "2.0.0", - "resolved": "https://registry.npmjs.org/shebang-command/-/shebang-command-2.0.0.tgz", "integrity": "sha512-kHxr2zZpYtdmrN1qDjrrX/Z1rR1kG8Dx+gkpK1G4eXmvXswmcE1hTWBWYUzlraYw1/yZp6YuDY77YtvbN0dmDA==", "dev": true, "license": "MIT", @@ -2729,7 +2549,6 @@ }, "node_modules/shebang-regex": { "version": "3.0.0", - "resolved": "https://registry.npmjs.org/shebang-regex/-/shebang-regex-3.0.0.tgz", "integrity": "sha512-7++dFhtcx3353uBaq8DDR4NuxBetBzC7ZQOhmTQInHEd6bSrXdiEyzCvG07Z44UYdLShWUyXt5M/yhz8ekcb1A==", "dev": true, "license": "MIT", @@ -2739,7 +2558,6 @@ }, "node_modules/side-channel": { "version": "1.1.0", - "resolved": "https://registry.npmjs.org/side-channel/-/side-channel-1.1.0.tgz", "integrity": "sha512-ZX99e6tRweoUXqR+VBrslhda51Nh5MTQwou5tnUDgbtyM0dBgmhEDtWGP/xbKn6hqfPRHujUNwz5fy/wbbhnpw==", "dev": true, "license": "MIT", @@ -2759,7 +2577,6 @@ }, "node_modules/side-channel-list": { "version": "1.0.0", - "resolved": "https://registry.npmjs.org/side-channel-list/-/side-channel-list-1.0.0.tgz", "integrity": "sha512-FCLHtRD/gnpCiCHEiJLOwdmFP+wzCmDEkc9y7NsYxeF4u7Btsn1ZuwgwJGxImImHicJArLP4R0yX4c2KCrMrTA==", "dev": true, "license": "MIT", @@ -2776,7 +2593,6 @@ }, "node_modules/side-channel-map": { "version": "1.0.1", - "resolved": "https://registry.npmjs.org/side-channel-map/-/side-channel-map-1.0.1.tgz", "integrity": "sha512-VCjCNfgMsby3tTdo02nbjtM/ewra6jPHmpThenkTYh8pG9ucZ/1P8So4u4FGBek/BjpOVsDCMoLA/iuBKIFXRA==", "dev": true, "license": "MIT", @@ -2795,7 +2611,6 @@ }, "node_modules/side-channel-weakmap": { "version": "1.0.2", - "resolved": "https://registry.npmjs.org/side-channel-weakmap/-/side-channel-weakmap-1.0.2.tgz", "integrity": "sha512-WPS/HvHQTYnHisLo9McqBHOJk2FkHO/tlpvldyrnem4aeQp4hai3gythswg6p01oSoTl58rcpiFAjF2br2Ak2A==", "dev": true, "license": "MIT", @@ -2815,14 +2630,12 @@ }, "node_modules/siginfo": { "version": "2.0.0", - "resolved": "https://registry.npmjs.org/siginfo/-/siginfo-2.0.0.tgz", "integrity": "sha512-ybx0WO1/8bSBLEWXZvEd7gMW3Sn3JFlW3TvX1nREbDLRNQNaeNN8WK0meBwPdAaOI7TtRRRJn/Es1zhrrCHu7g==", "dev": true, "license": "ISC" }, "node_modules/source-map-js": { "version": "1.2.1", - "resolved": "https://registry.npmjs.org/source-map-js/-/source-map-js-1.2.1.tgz", "integrity": "sha512-UXWMKhLOwVKb728IUtQPXxfYU+usdybtUrK/8uGE8CQMvrhOpwvzDBwj0QhSL7MQc7vIsISBG8VQ8+IDQxpfQA==", "dev": true, "license": "BSD-3-Clause", @@ -2832,14 +2645,12 @@ }, "node_modules/stackback": { "version": "0.0.2", - "resolved": "https://registry.npmjs.org/stackback/-/stackback-0.0.2.tgz", "integrity": "sha512-1XMJE5fQo1jGH6Y/7ebnwPOBEkIEnT4QF32d5R1+VXdXveM0IBMJt8zfaxX1P3QhVwrYe+576+jkANtSS2mBbw==", "dev": true, "license": "MIT" }, "node_modules/statuses": { "version": "2.0.2", - "resolved": "https://registry.npmjs.org/statuses/-/statuses-2.0.2.tgz", "integrity": "sha512-DvEy55V3DB7uknRo+4iOGT5fP1slR8wQohVdknigZPMpMstaKJQWhwiYBACJE3Ul2pTnATihhBYnRhZQHGBiRw==", "dev": true, "license": "MIT", @@ -2849,21 +2660,18 @@ }, "node_modules/std-env": { "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/tinybench": { "version": "2.9.0", - "resolved": "https://registry.npmjs.org/tinybench/-/tinybench-2.9.0.tgz", "integrity": "sha512-0+DUvqWMValLmha6lr4kD8iAMK1HzV0/aKnCtWb9v9641TnP/MFb7Pc2bxoxQjTXAErryXVgUOfv2YqNllqGeg==", "dev": true, "license": "MIT" }, "node_modules/tinyexec": { "version": "1.0.2", - "resolved": "https://registry.npmjs.org/tinyexec/-/tinyexec-1.0.2.tgz", "integrity": "sha512-W/KYk+NFhkmsYpuHq5JykngiOCnxeVL8v8dFnqxSD8qEEdRfXk1SDM6JzNqcERbcGYj9tMrDQBYV9cjgnunFIg==", "dev": true, "license": "MIT", @@ -2873,7 +2681,6 @@ }, "node_modules/tinyglobby": { "version": "0.2.17", - "resolved": "https://registry.npmjs.org/tinyglobby/-/tinyglobby-0.2.17.tgz", "integrity": "sha512-wXR/dYpcqKmfWpEdZjiKJOwCNFndD0DMnrW/cYjVGttEkBfVgcLFHoNrlj47mjOVic9yyNu65alsgF4NQyTa2g==", "dev": true, "license": "MIT", @@ -2890,7 +2697,6 @@ }, "node_modules/tinyrainbow": { "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", @@ -2900,7 +2706,6 @@ }, "node_modules/toidentifier": { "version": "1.0.1", - "resolved": "https://registry.npmjs.org/toidentifier/-/toidentifier-1.0.1.tgz", "integrity": "sha512-o5sSPKEkg/DIQNmH43V0/uerLrpzVedkUh8tGNvaeXpfpuwjKenlSox/2O/BTlZUtEe+JG7s5YhEz608PlAHRA==", "dev": true, "license": "MIT", @@ -2910,7 +2715,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", @@ -2918,7 +2722,6 @@ }, "node_modules/tsx": { "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", @@ -2937,7 +2740,6 @@ }, "node_modules/type-is": { "version": "2.0.1", - "resolved": "https://registry.npmjs.org/type-is/-/type-is-2.0.1.tgz", "integrity": "sha512-OZs6gsjF4vMp32qrCbiVSkrFmXtG/AZhY3t0iAMrMBiAZyV9oALtXO8hsrHbMXF9x6L3grlFuwW2oAz7cav+Gw==", "dev": true, "license": "MIT", @@ -2952,7 +2754,6 @@ }, "node_modules/typescript": { "version": "5.9.3", - "resolved": "https://registry.npmjs.org/typescript/-/typescript-5.9.3.tgz", "integrity": "sha512-jl1vZzPDinLr9eUt3J/t7V6FgNEw9QjvBPdysz9KfQDD41fQrC2Y4vKQdiaUpFT4bXlb1RHhLpp8wtm6M5TgSw==", "dev": true, "license": "Apache-2.0", @@ -2966,14 +2767,12 @@ }, "node_modules/undici-types": { "version": "7.18.2", - "resolved": "https://registry.npmjs.org/undici-types/-/undici-types-7.18.2.tgz", "integrity": "sha512-AsuCzffGHJybSaRrmr5eHr81mwJU3kjw6M+uprWvCXiNeN9SOGwQ3Jn8jb8m3Z6izVgknn1R0FTCEAP2QrLY/w==", "dev": true, "license": "MIT" }, "node_modules/unpipe": { "version": "1.0.0", - "resolved": "https://registry.npmjs.org/unpipe/-/unpipe-1.0.0.tgz", "integrity": "sha512-pjy2bYhSsufwWlKwPc+l3cN7+wuJlK6uz0YdJEOlQDbl6jo/YlPi4mb8agUkVC8BF7V8NuzeyPNqRksA3hztKQ==", "dev": true, "license": "MIT", @@ -2983,7 +2782,6 @@ }, "node_modules/vary": { "version": "1.1.2", - "resolved": "https://registry.npmjs.org/vary/-/vary-1.1.2.tgz", "integrity": "sha512-BNGbWLfd0eUPabhkXUVm0j8uuvREyTh5ovRa/dyow/BqAbZJyC+5fU+IzQOzmAKzYqYRAISoRhdQr3eIZ/PXqg==", "dev": true, "license": "MIT", @@ -2993,7 +2791,6 @@ }, "node_modules/vite": { "version": "8.0.16", - "resolved": "https://registry.npmjs.org/vite/-/vite-8.0.16.tgz", "integrity": "sha512-h9bXPmJichP5fLmVQo3PyaGSDE2n3aPuomeAlVRm0JLmt4rY6zmPKd59HYI4LNW8oTK7tlTsuC7l/m7awx9Jcw==", "dev": true, "license": "MIT", @@ -3071,7 +2868,6 @@ }, "node_modules/vitest": { "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", @@ -3161,7 +2957,6 @@ }, "node_modules/which": { "version": "2.0.2", - "resolved": "https://registry.npmjs.org/which/-/which-2.0.2.tgz", "integrity": "sha512-BLI3Tl1TW3Pvl70l3yq3Y64i+awpwXqsGBYWkkqMtnbXgrMD+yj7rhW0kuEDxzJaYXGjEW5ogapKNMEKNMjibA==", "dev": true, "license": "ISC", @@ -3177,7 +2972,6 @@ }, "node_modules/why-is-node-running": { "version": "2.3.0", - "resolved": "https://registry.npmjs.org/why-is-node-running/-/why-is-node-running-2.3.0.tgz", "integrity": "sha512-hUrmaWBdVDcxvYqnyh09zunKzROWjbZTiNy8dBEjkS7ehEDQibXJ7XvlmtbwuTclUiIyN+CyXQD4Vmko8fNm8w==", "dev": true, "license": "MIT", @@ -3194,14 +2988,12 @@ }, "node_modules/wrappy": { "version": "1.0.2", - "resolved": "https://registry.npmjs.org/wrappy/-/wrappy-1.0.2.tgz", "integrity": "sha512-l4Sp/DRseor9wL6EvV2+TuQn63dMkPjZ/sp9XkghTEbV9KlPS1xUsZ3u7/IQO4wxtcFB4bgpQPRcR3QCvezPcQ==", "dev": true, "license": "ISC" }, "node_modules/yaml": { "version": "2.9.0", - "resolved": "https://registry.npmjs.org/yaml/-/yaml-2.9.0.tgz", "integrity": "sha512-2AvhNX3mb8zd6Zy7INTtSpl1F15HW6Wnqj0srWlkKLcpYl/gMIMJiyuGq2KeI2YFxUPjdlB+3Lc10seMLtL4cA==", "dev": true, "license": "ISC", @@ -3217,7 +3009,6 @@ }, "node_modules/zod": { "version": "4.3.6", - "resolved": "https://registry.npmjs.org/zod/-/zod-4.3.6.tgz", "integrity": "sha512-rftlrkhHZOcjDwkGlnUtZZkvaPHCsDATp4pGpuOOMDaTdDDXF91wuVDJoWoPsKX/3YPQ5fHuF3STjcYyKr+Qhg==", "dev": true, "license": "MIT", @@ -3227,7 +3018,6 @@ }, "node_modules/zod-to-json-schema": { "version": "3.25.1", - "resolved": "https://registry.npmjs.org/zod-to-json-schema/-/zod-to-json-schema-3.25.1.tgz", "integrity": "sha512-pM/SU9d3YAggzi6MtR4h7ruuQlqKtad8e9S0fmxcMi+ueAK5Korys/aWcV9LIIHTVbj01NdzxcnXSN+O74ZIVA==", "dev": true, "license": "ISC", diff --git a/test/harness/package.json b/test/harness/package.json index c77a25f541..cceca0b959 100644 --- a/test/harness/package.json +++ b/test/harness/package.json @@ -14,7 +14,7 @@ "node": "^20.19.0 || >=22.12.0" }, "devDependencies": { - "@github/copilot": "^1.0.73", + "@github/copilot": "^1.0.82-0", "@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 c5747a3067..245b035c5c 100644 --- a/test/harness/replayingCapiProxy.test.ts +++ b/test/harness/replayingCapiProxy.test.ts @@ -546,9 +546,65 @@ Always include PINEAPPLE_COCONUT_42. expect(toolMessage?.content).toBe("Tool 'report_intent' does not exist."); }); - test("removes runtime advisories from background agent start results", async () => { + test("normalizes interrupted tool execution results", async () => { + const requestBody = JSON.stringify({ + messages: [ + { role: "user", content: "Run a slow analysis" }, + { + role: "assistant", + tool_calls: [ + { + id: "tc1", + type: "function", + function: { + name: "slow_analysis", + arguments: '{"value":"test_abort"}', + }, + }, + { + id: "tc2", + type: "function", + function: { + name: "powershell", + arguments: '{"command":"sleep 100"}', + }, + }, + ], + }, + { + role: "tool", + tool_call_id: "tc1", + content: + 'Failed to execute `slow_analysis` tool with arguments: {"value":"test_abort"} due to error: Error: Session aborted', + }, + { + role: "tool", + tool_call_id: "tc2", + content: "", + }, + ], + }); + 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 toolMessages = result.conversations[0].messages.filter( + (m) => m.role === "tool", + ); + expect(toolMessages.map((message) => message.content)).toEqual([ + "The execution of this tool, or a previous tool was interrupted.", + "The execution of this tool, or a previous tool was interrupted.", + ]); + }); + + test("normalizes background agent IDs and removes runtime advisories", 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."; + "Agent started in background with agent_id: background-agent. 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" }, @@ -565,7 +621,8 @@ Always include PINEAPPLE_COCONUT_42. { role: "tool", tool_call_id: "tc1", - content: `${stableResult} The agent supports multi-turn conversations.`, + content: + "Agent started in background with agent_id: 3e0c7565-6091-58cb-85bb-6cb14db23ef7. You'll be notified when it completes. Tell the user you're waiting and end your response, or continue unrelated work until notified. The agent supports multi-turn conversations.", }, ], }); @@ -902,6 +959,119 @@ Always include PINEAPPLE_COCONUT_42. } }); + test("matches semantically equivalent interrupted shell results", 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":"sleep 100"}', + }, + }, + ], + }, + { + role: "tool", + tool_call_id: "toolcall_0", + content: + "The execution of this tool, or a previous tool was interrupted.", + }, + { role: "assistant", content: "Ready for another request." }, + ], + }, + ], + } satisfies NormalizedData); + await writeFile(cachePath, cacheContent); + + const proxy = new ReplayingCapiProxy( + "http://localhost:9999", + cachePath, + workDir, + ); + const proxyUrl = await proxy.start(); + + try { + const 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":"sleep 100"}', + }, + }, + ], + }, + ]; + const interruptedResponse = await makeRequest( + proxyUrl, + "/chat/completions", + { + body: { + model: "test-model", + messages: [ + ...messages, + { + role: "tool", + tool_call_id: "runtime-call-id", + content: + "", + }, + ], + }, + }, + ); + + expect(interruptedResponse.status).toBe(200); + expect( + (JSON.parse(interruptedResponse.body) as ChatCompletion).choices[0] + .message.content, + ).toBe("Ready for another request."); + + const meaningfulErrorResponse = await makeRequest( + proxyUrl, + "/chat/completions", + { + body: { + model: "test-model", + messages: [ + ...messages, + { + role: "tool", + tool_call_id: "runtime-call-id", + content: + "The command failed because the executable was missing.", + }, + ], + }, + }, + ); + expect(meaningfulErrorResponse.status).toBe(500); + } 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 @@ -1161,6 +1331,112 @@ Always include PINEAPPLE_COCONUT_42. } }); + test("replays background agent calls with the runtime-generated ID", async () => { + const cachePath = path.join(tempDir, "cache.yaml"); + const startResult = + "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 notification = + '\nAgent "read-file" (explore) has completed successfully. Use read_agent with agent_id "read-file" to retrieve the full results.\n'; + const cacheContent = yaml.stringify({ + models: ["test-model"], + conversations: [ + { + messages: [ + { role: "system", content: "${system}" }, + { role: "user", content: "Read the file" }, + { + role: "assistant", + tool_calls: [ + { + id: "toolcall_0", + type: "function", + function: { + name: "task", + arguments: + '{"agent_type":"explore","name":"read-file","prompt":"Read it","mode":"background"}', + }, + }, + ], + }, + { + role: "tool", + tool_call_id: "toolcall_0", + content: startResult, + }, + { role: "assistant", content: "Waiting." }, + { role: "user", content: notification }, + { + role: "assistant", + tool_calls: [ + { + id: "toolcall_1", + type: "function", + function: { + name: "read_agent", + arguments: '{"agent_id":"read-file","wait":true}', + }, + }, + ], + }, + ], + }, + ], + } satisfies NormalizedData); + await writeFile(cachePath, cacheContent); + + const proxy = new ReplayingCapiProxy( + "http://localhost:9999", + cachePath, + workDir, + ); + const proxyUrl = await proxy.start(); + const runtimeAgentId = "3e0c7565-6091-58cb-85bb-6cb14db23ef7"; + + try { + const response = await makeRequest(proxyUrl, "/chat/completions", { + body: { + model: "test-model", + messages: [ + { role: "system", content: "Be helpful" }, + { role: "user", content: "Read the file" }, + { + role: "assistant", + tool_calls: [ + { + id: "runtime-call-id", + type: "function", + function: { + name: "task", + arguments: + '{"agent_type":"explore","name":"read-file","prompt":"Read it","mode":"background"}', + }, + }, + ], + }, + { + role: "tool", + tool_call_id: "runtime-call-id", + content: startResult.replace("read-file", runtimeAgentId), + }, + { role: "assistant", content: "Waiting." }, + { role: "user", content: notification }, + ], + }, + }); + + expect(response.status).toBe(200); + const parsed = JSON.parse(response.body) as ChatCompletion; + const toolCall = parsed.choices[0].message + .tool_calls![0] as ChatCompletionMessageFunctionToolCall; + expect(JSON.parse(toolCall.function.arguments)).toEqual({ + agent_id: runtimeAgentId, + wait: true, + }); + } finally { + await proxy.stop(); + } + }); + test("matches parallel tool results regardless of arrival order", async () => { const cachePath = path.join(tempDir, "cache.yaml"); const cacheContent = yaml.stringify({ diff --git a/test/harness/replayingCapiProxy.ts b/test/harness/replayingCapiProxy.ts index 5e07449f73..f30a9fbd77 100644 --- a/test/harness/replayingCapiProxy.ts +++ b/test/harness/replayingCapiProxy.ts @@ -2,7 +2,7 @@ * Copyright (c) Microsoft Corporation. All rights reserved. *--------------------------------------------------------------------------------------------*/ -import { appendFileSync, existsSync } from "fs"; +import { appendFileSync } from "fs"; import { mkdir, readFile, writeFile } from "fs/promises"; import type { ChatCompletion, @@ -19,12 +19,14 @@ import { CapturingHttpProxy, PerformRequestOptions, } from "./capturingHttpProxy"; +export type { CapturedRequest } from "./capturingHttpProxy"; import { anthropicMessagesEndpoint, anthropicMessagesRequestToChatCompletion, chatCompletionResponseToAnthropicMessage, chatCompletionResponseToAnthropicSseChunks, } from "./anthropicMessagesAdapter"; +import { canonicalUserMessageSeparator } from "./modelProtocolAdapterShared"; import { chatCompletionResponseToResponsesApiMessage, chatCompletionResponseToResponsesApiSseChunks, @@ -124,6 +126,7 @@ export class ReplayingCapiProxy extends CapturingHttpProxy { private startPromise: Promise | null = null; private defaultToolResultNormalizers: ToolResultNormalizer[] = [ { toolName: "*", normalizer: normalizeLargeOutputFilepaths }, + { toolName: "*", normalizer: normalizeInterruptedToolResult }, { toolName: "${shell}", normalizer: normalizeShellExitMarkers }, { toolName: "*", normalizer: normalizeGhAuthMessages }, { toolName: "*", normalizer: normalizeAvailableToolNames }, @@ -204,17 +207,30 @@ export class ReplayingCapiProxy extends CapturingHttpProxy { } private async loadStoredData(): Promise { - if (this.state && existsSync(this.state.filePath)) { - const content = await readFile(this.state.filePath, "utf-8"); - 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, - ); + if (!this.state) { + return; + } + // Read directly and treat a missing file as "nothing stored" rather than + // checking for existence first, which would be a check-then-use race. + const content = await readFile(this.state.filePath, "utf-8").catch( + (error: NodeJS.ErrnoException) => { + if (error.code === "ENOENT") { + return undefined; + } + throw error; + }, + ); + if (content === undefined) { + return; } + 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 { @@ -327,6 +343,20 @@ export class ReplayingCapiProxy extends CapturingHttpProxy { return; } + // 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. // This must run before the state guard below: the CLI authenticates and // calls /copilot_internal/user at startup, which can race ahead of the @@ -401,6 +431,51 @@ export class ReplayingCapiProxy extends CapturingHttpProxy { 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\//)) { @@ -774,6 +849,7 @@ async function findSavedChatCompletionResponse( if (!requestModel) { throw new Error("Unable to determine model from request"); } + const backgroundAgentIds = extractBackgroundAgentIds(requestBody); // Now find a matching cached conversation (i.e., one for which this request is a prefix) for (const conversation of storedData.conversations) { @@ -787,6 +863,7 @@ async function findSavedChatCompletionResponse( conversation.messages, replyIndex, workDir, + backgroundAgentIds, ); } } @@ -923,7 +1000,7 @@ function coalesceAdjacentUserMessages(requestBody: string): string { typeof previous.content === "string" && typeof message.content === "string" ) { - previous.content = `${previous.content.trimEnd()}\n\n\n${message.content.trimStart()}`; + previous.content = `${previous.content.trimEnd()}${canonicalUserMessageSeparator}${message.content.trimStart()}`; } else { messages.push(message); } @@ -933,7 +1010,7 @@ function coalesceAdjacentUserMessages(requestBody: string): string { if (message.role === "user" && typeof message.content === "string") { message.content = normalizeUserMessage(message.content).replace( /\n{5,}/g, - "\n\n\n", + canonicalUserMessageSeparator, ); } } @@ -1008,8 +1085,11 @@ function normalizeToolCalls( // still match cached responses even if these details change. for (const conv of conversations) { const idMap = new Map(); + const backgroundAgentNamesByToolCallId = new Map(); + const backgroundAgentNamesByRuntimeId = new Map(); const precedingMessages: NormalizedMessage[] = []; let counter = 0; + let unnamedBackgroundAgentCounter = 0; for (const msg of conv.messages) { for (const tc of msg.tool_calls ?? []) { // Normalize ID in tool calls @@ -1022,6 +1102,29 @@ function normalizeToolCalls( if (normalizedToolName) { tc.function!.name = normalizedToolName; } + + if (tc.function?.name === "task") { + const configuredName = getBackgroundAgentName( + tc.function.arguments, + ); + const fallbackName = + unnamedBackgroundAgentCounter === 0 + ? "background-agent" + : `background-agent-${unnamedBackgroundAgentCounter}`; + backgroundAgentNamesByToolCallId.set( + tc.id, + configuredName ?? fallbackName, + ); + unnamedBackgroundAgentCounter++; + } else if ( + tc.function?.name === "read_agent" || + tc.function?.name === "write_agent" + ) { + tc.function.arguments = normalizeBackgroundAgentArguments( + tc.function.arguments, + backgroundAgentNamesByRuntimeId, + ); + } } if (msg.role === "tool" && msg.tool_call_id) { @@ -1034,6 +1137,19 @@ function normalizeToolCalls( .flatMap((m) => m.tool_calls ?? []) .find((tc) => tc.id === msg.tool_call_id); if (precedingToolCall) { + if (precedingToolCall.function?.name === "task") { + const runtimeId = getBackgroundAgentId(msg.content); + const stableName = backgroundAgentNamesByToolCallId.get( + msg.tool_call_id, + ); + if (runtimeId && stableName) { + backgroundAgentNamesByRuntimeId.set(runtimeId, stableName); + msg.content = normalizeBackgroundAgentStartMessageWithId( + msg.content, + stableName, + ); + } + } for (const normalizer of resultNormalizers) { if ( precedingToolCall.function?.name === normalizer.toolName || @@ -1042,6 +1158,10 @@ function normalizeToolCalls( msg.content = normalizer.normalizer(msg.content); } } + msg.content = replaceBackgroundAgentIds( + msg.content, + backgroundAgentNamesByRuntimeId, + ); } } } @@ -1288,7 +1408,8 @@ function coalesceMessages( continue; } - const separator = message.role === "user" ? "\n\n\n" : ""; + const separator = + message.role === "user" ? canonicalUserMessageSeparator : ""; const previousContent = previous.content ?? ""; const currentContent = message.content ?? ""; const content = `${previousContent}${previousContent && currentContent ? separator : ""}${currentContent}`; @@ -1309,6 +1430,7 @@ 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 = normalizeInterruptedToolResult(message.content); message.content = normalizeAvailableToolNames(message.content); message.content = normalizeBackgroundAgentStartMessage(message.content); message.content = normalizeReadAgentResult(message.content); @@ -1432,13 +1554,192 @@ function normalizeAvailableToolNames(result: string): string { ); } +function normalizeInterruptedToolResult(result: string): string { + return result.replace( + /^(?:Failed to execute `[^`]+` tool(?: with arguments: [\s\S]*?)? due to error: (?:Error: )?Session aborted|)$/, + "The execution of this tool, or a previous tool was interrupted.", + ); +} + function normalizeBackgroundAgentStartMessage(result: string): string { + return normalizeBackgroundAgentStartMessageWithId(result); +} + +function normalizeBackgroundAgentStartMessageWithId( + result: string, + stableId?: 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", + /^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, + (_match, runtimeId: string, suffix: string) => + `Agent started in background with agent_id: ${stableId ?? runtimeId}${suffix}`, + ); +} + +function getBackgroundAgentName(argumentsJson: string): string | undefined { + try { + const args = JSON.parse(argumentsJson) as unknown; + if ( + args && + typeof args === "object" && + "name" in args && + typeof args.name === "string" + ) { + return args.name; + } + } catch { + // Invalid tool arguments are left for the runtime to report. + } + return undefined; +} + +function getBackgroundAgentId(content: string): string | undefined { + const match = content.match( + /^Agent started in background with agent_id: (.*?)\. You'll be notified when it completes\./s, + ); + if (match?.[1]) { + return match[1]; + } + + try { + const parsed = JSON.parse(content) as unknown; + if ( + parsed && + typeof parsed === "object" && + "textResultForLlm" in parsed && + typeof parsed.textResultForLlm === "string" + ) { + return getBackgroundAgentId(parsed.textResultForLlm); + } + } catch { + // Plain-text tool results are expected. + } + return undefined; +} + +function replaceBackgroundAgentIds( + content: string, + backgroundAgentNamesByRuntimeId: Map, +): string { + let normalized = content; + for (const [runtimeId, stableName] of backgroundAgentNamesByRuntimeId) { + normalized = normalized.split(runtimeId).join(stableName); + } + return normalized; +} + +function rewriteBackgroundAgentArguments( + argumentsJson: string, + replacements: Map, +): string { + try { + const args = JSON.parse(argumentsJson) as unknown; + if (!args || typeof args !== "object") { + return argumentsJson; + } + + if ( + "agent_id" in args && + typeof args.agent_id === "string" && + replacements.has(args.agent_id) + ) { + args.agent_id = replacements.get(args.agent_id); + } + if ("agent_ids" in args && Array.isArray(args.agent_ids)) { + args.agent_ids = args.agent_ids.map((agentId: unknown) => + typeof agentId === "string" + ? (replacements.get(agentId) ?? agentId) + : agentId, + ); + } + return JSON.stringify(args); + } catch { + return argumentsJson; + } +} + +function normalizeBackgroundAgentArguments( + argumentsJson: string, + backgroundAgentNamesByRuntimeId: Map, +): string { + return rewriteBackgroundAgentArguments( + argumentsJson, + backgroundAgentNamesByRuntimeId, ); } +function extractBackgroundAgentIds( + requestBody: string | undefined, +): Map { + const result = new Map(); + if (!requestBody) { + return result; + } + + try { + const request = JSON.parse(requestBody) as { + messages?: Array<{ + role?: string; + tool_call_id?: string; + content?: unknown; + tool_calls?: Array<{ + id?: string; + function?: { name?: string; arguments?: string }; + }>; + }>; + }; + const backgroundAgentNamesByToolCallId = new Map(); + let unnamedBackgroundAgentCounter = 0; + for (const message of request.messages ?? []) { + for (const toolCall of message.tool_calls ?? []) { + if ( + toolCall.id && + toolCall.function?.name === "task" && + toolCall.function.arguments + ) { + const configuredName = getBackgroundAgentName( + toolCall.function.arguments, + ); + const fallbackName = + unnamedBackgroundAgentCounter === 0 + ? "background-agent" + : `background-agent-${unnamedBackgroundAgentCounter}`; + backgroundAgentNamesByToolCallId.set( + toolCall.id, + configuredName ?? fallbackName, + ); + unnamedBackgroundAgentCounter++; + } + } + + if ( + message.role === "tool" && + message.tool_call_id && + typeof message.content === "string" + ) { + const stableName = backgroundAgentNamesByToolCallId.get( + message.tool_call_id, + ); + const runtimeId = getBackgroundAgentId(message.content); + if (stableName && runtimeId) { + result.set(stableName, runtimeId); + } + } + } + } catch { + // Request parsing failures are handled by the normal replay matcher. + } + + return result; +} + +function expandBackgroundAgentArguments( + argumentsJson: string, + backgroundAgentIds: Map, +): string { + return rewriteBackgroundAgentArguments(argumentsJson, backgroundAgentIds); +} + // Transforms a single OpenAI-style inbound response message into normalized form function transformOpenAIResponseChoice( choices: ChatCompletion.Choice[], @@ -1590,6 +1891,7 @@ function createOpenAIResponse( messages: NormalizedMessage[], responseStartIndex: number, workDir: string, + backgroundAgentIds: Map, ): ChatCompletion { // Here we recreate the strange CAPI/productcode behavior of using multiple choices to represent // multiple assistant messages in a row. This is the inverse of the logic in transformOpenAIResponseChoice(). @@ -1606,7 +1908,10 @@ function createOpenAIResponse( type: "function" as const, function: { name: expandToolName(tc.function?.name ?? ""), - arguments: expandWorkDir(tc.function?.arguments, workDir, true) ?? "{}", + arguments: expandBackgroundAgentArguments( + expandWorkDir(tc.function?.arguments, workDir, true) ?? "{}", + backgroundAgentIds, + ), }, })); @@ -1720,11 +2025,18 @@ function createGetModelsResponse(modelIds: string[]) { } async function writeFileIfDifferent(filePath: string, contents: string) { - if (existsSync(filePath)) { - const existingContents = await readFile(filePath, "utf-8"); - if (existingContents === contents) { - return; - } + // Read directly instead of checking for existence first, which would be a + // check-then-use race on the same path. + const existingContents = await readFile(filePath, "utf-8").catch( + (error: NodeJS.ErrnoException) => { + if (error.code === "ENOENT") { + return undefined; + } + throw error; + }, + ); + if (existingContents === contents) { + return; } await writeFile(filePath, contents, "utf-8"); @@ -1747,6 +2059,7 @@ export type ToolResultNormalizer = { export type CopilotUserResponse = { login: string; copilot_plan?: string; + token_based_billing?: boolean; is_mcp_enabled?: boolean; endpoints?: { api?: string; diff --git a/test/harness/test-mcp-server.mjs b/test/harness/test-mcp-server.mjs index b2b32606dc..a3a84b42b3 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/builtin_tools/should_create_a_new_file.yaml b/test/snapshots/builtin_tools/should_create_a_new_file.yaml index bf9288cf01..8afe8b38b6 100644 --- a/test/snapshots/builtin_tools/should_create_a_new_file.yaml +++ b/test/snapshots/builtin_tools/should_create_a_new_file.yaml @@ -54,6 +54,6 @@ conversations: arguments: '{"path":"${workdir}/new_file.txt"}' - role: tool tool_call_id: toolcall_2 - content: 1. Created by test + content: Created by test - role: assistant 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 0f21418628..3f4e986906 100644 --- a/test/snapshots/builtin_tools/should_edit_a_file_successfully.yaml +++ b/test/snapshots/builtin_tools/should_edit_a_file_successfully.yaml @@ -57,9 +57,8 @@ conversations: - role: tool tool_call_id: toolcall_2 content: |- - 1. Hi Universe - 2. Goodbye World - 3. + Hi Universe + Goodbye World - role: assistant content: |- Done! The file now contains: 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 cd17d86708..601ae0f04c 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 @@ -45,9 +45,9 @@ conversations: - role: tool tool_call_id: toolcall_1 content: |- - 2. line2 - 3. line3 - 4. line4 + line2 + line3 + line4 - role: assistant content: |- Lines 2 through 4 of 'lines.txt' contain: 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 6d9167e94a..469d091288 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 @@ -25,6 +25,6 @@ conversations: task. - role: tool tool_call_id: toolcall_1 - content: 1. I am in the client cwd + content: I am in the client cwd - role: assistant 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 8ce730f0fb..c8f272e6b9 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 @@ -44,7 +44,7 @@ conversations: task. - role: tool tool_call_id: toolcall_1 - content: 1. Hello World + content: Hello World - role: assistant content: |- The file 'hello.txt' contains: 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 a6583a15ec..46fd7715ab 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 @@ -44,7 +44,7 @@ conversations: task. - role: tool tool_call_id: toolcall_1 - content: 1. test data + content: test data - role: assistant content: |- The file `data.txt` contains: diff --git a/test/snapshots/event_fidelity/should_preserve_message_order_in_getmessages_after_tool_use.yaml b/test/snapshots/event_fidelity/should_preserve_message_order_in_getmessages_after_tool_use.yaml index 2799cdec61..1797cc16b1 100644 --- a/test/snapshots/event_fidelity/should_preserve_message_order_in_getmessages_after_tool_use.yaml +++ b/test/snapshots/event_fidelity/should_preserve_message_order_in_getmessages_after_tool_use.yaml @@ -15,6 +15,6 @@ conversations: arguments: '{"path":"order.txt"}' - role: tool tool_call_id: toolcall_0 - content: 1. ORDER_CONTENT_42 + content: ORDER_CONTENT_42 - role: assistant content: The number in 'order.txt' is **42**. 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 6a51857ab0..9ed9431545 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 @@ -44,7 +44,7 @@ conversations: task. - role: tool tool_call_id: toolcall_1 - content: 1. Testing both hooks! + content: Testing both hooks! - role: assistant content: |- The file **both.txt** contains: 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 18b324f098..2a5f1ae446 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 @@ -44,7 +44,7 @@ conversations: task. - role: tool tool_call_id: toolcall_1 - content: 1. World from the test! + content: World from the test! - role: assistant content: |- The file `world.txt` contains: 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 1ce0fe67a0..f695c60f3d 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 @@ -44,7 +44,7 @@ conversations: task. - role: tool tool_call_id: toolcall_1 - content: 1. Hello from the test! + content: Hello from the test! - role: assistant content: |- The file **hello.txt** contains: 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 6a51857ab0..9ed9431545 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 @@ -44,7 +44,7 @@ conversations: task. - role: tool tool_call_id: toolcall_1 - content: 1. Testing both hooks! + content: Testing both hooks! - role: assistant content: |- The file **both.txt** contains: 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 6a51857ab0..9ed9431545 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 @@ -44,7 +44,7 @@ conversations: task. - role: tool tool_call_id: toolcall_1 - content: 1. Testing both hooks! + content: Testing both hooks! - role: assistant content: |- The file **both.txt** contains: 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 18b324f098..2a5f1ae446 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 @@ -44,7 +44,7 @@ conversations: task. - role: tool tool_call_id: toolcall_1 - content: 1. World from the test! + content: World from the test! - role: assistant content: |- The file `world.txt` contains: 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 1ce0fe67a0..f695c60f3d 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 @@ -44,7 +44,7 @@ conversations: task. - role: tool tool_call_id: toolcall_1 - content: 1. Hello from the test! + content: Hello from the test! - role: assistant content: |- The file **hello.txt** contains: 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 0000000000..db2b029680 --- /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/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 0d79c3e1ab..583366363a 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 @@ -83,7 +83,7 @@ conversations: arguments: '{"path":"${workdir}/greeting.txt"}' - role: tool tool_call_id: toolcall_2 - content: 1. Hello from multi-turn test + content: Hello from multi-turn test - role: assistant content: |- The exact contents of `greeting.txt` are: 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 b930bb46ac..96dc365c65 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 @@ -44,7 +44,7 @@ conversations: task. - role: tool tool_call_id: toolcall_1 - content: 1. The magic number is 42. + content: The magic number is 42. - role: assistant content: The magic number is **42**. - messages: @@ -69,7 +69,7 @@ conversations: content: Tool 'report_intent' does not exist. - role: tool tool_call_id: toolcall_1 - content: 1. The magic number is 42. + content: The magic number is 42. - role: assistant content: The magic number is **42**. - role: user diff --git a/test/snapshots/permissions/permission_handler_for_write_operations.yaml b/test/snapshots/permissions/permission_handler_for_write_operations.yaml index a4ede6fcb1..3f05a8c6de 100644 --- a/test/snapshots/permissions/permission_handler_for_write_operations.yaml +++ b/test/snapshots/permissions/permission_handler_for_write_operations.yaml @@ -47,7 +47,7 @@ conversations: task. - role: tool tool_call_id: toolcall_1 - content: 1. original content + content: original content - role: assistant content: "Now I'll replace 'original' with 'modified':" - role: assistant @@ -82,7 +82,7 @@ conversations: task. - role: tool tool_call_id: toolcall_1 - content: 1. original content + content: original content - role: assistant content: "Now I'll replace 'original' with 'modified':" tool_calls: 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 0000000000..ef6f60dbed --- /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 a4ede6fcb1..3f05a8c6de 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 @@ -47,7 +47,7 @@ conversations: task. - role: tool tool_call_id: toolcall_1 - content: 1. original content + content: original content - role: assistant content: "Now I'll replace 'original' with 'modified':" - role: assistant @@ -82,7 +82,7 @@ conversations: task. - role: tool tool_call_id: toolcall_1 - content: 1. original content + content: original content - role: assistant content: "Now I'll replace 'original' with 'modified':" tool_calls: 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 0000000000..2ef3733e00 --- /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_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 0000000000..6760888d7b --- /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/session/should_send_with_file_attachment.yaml b/test/snapshots/session/should_send_with_file_attachment.yaml index 23e05d946b..2e8e4d1d2d 100644 --- a/test/snapshots/session/should_send_with_file_attachment.yaml +++ b/test/snapshots/session/should_send_with_file_attachment.yaml @@ -58,7 +58,7 @@ conversations: task. - role: tool tool_call_id: toolcall_1 - content: 1. FILE_ATTACHMENT_SENTINEL + content: FILE_ATTACHMENT_SENTINEL - role: assistant content: |- The file contains: diff --git a/test/snapshots/session/should_set_model_with_reasoningeffort.yaml b/test/snapshots/session/should_set_model_with_reasoningeffort.yaml index 0e019bdad7..ccf204d2ae 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 e9fbabb05e..5525d1fb04 100644 --- a/test/snapshots/session_config/should_accept_message_attachments.yaml +++ b/test/snapshots/session_config/should_accept_message_attachments.yaml @@ -61,7 +61,7 @@ conversations: task. - role: tool tool_call_id: toolcall_1 - content: 1. This file is attached + content: This file is attached - role: assistant content: |- The attached file contains a single line of text that says: "This file is attached" 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 0000000000..056351ddb4 --- /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_workingdirectory_on_session_resume.yaml b/test/snapshots/session_config/should_apply_workingdirectory_on_session_resume.yaml index 52cc114f94..9d3dd78ff1 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 @@ -25,7 +25,7 @@ conversations: task. - role: tool tool_call_id: toolcall_1 - content: 1. I am in the resume working directory + content: I am in the resume working directory - role: assistant content: |- The file `resume-marker.txt` says: 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 18dfab04e6..40000d491b 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 @@ -44,6 +44,6 @@ conversations: task. - role: tool tool_call_id: toolcall_1 - content: 1. I am in the subdirectory + content: I am in the subdirectory - role: assistant content: 'The file marker.txt says: "I am in the subdirectory"' 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 fd825907f6..e720fc34dc 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 2a73f1ef84..f920f8705b 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,38 +25,6 @@ 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} @@ -88,7 +56,7 @@ conversations: arguments: '{"path":"${workdir}/subagent-test.txt"}' - role: tool tool_call_id: toolcall_0 - content: 1. Hello from subagent test! + content: Hello from subagent test! - role: assistant content: |- The complete contents of the file "subagent-test.txt" are: 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 4b7c058b27..98e57919c6 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 @@ -26,7 +26,7 @@ conversations: task. - role: tool tool_call_id: toolcall_1 - content: 1. Hello! + content: Hello! - role: assistant content: |- The file **hello.txt** contains: 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 0b1d9755f0..c54f25e2aa 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 @@ -47,6 +47,6 @@ conversations: task. - role: tool tool_call_id: toolcall_1 - content: 1. Hello transform! + content: Hello transform! - role: assistant 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 0681b569dd..32d6367390 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 @@ -47,7 +47,7 @@ conversations: task. - role: tool tool_call_id: toolcall_1 - content: 1. Combo test! + content: Combo test! - role: assistant content: |- The file `combo.txt` contains: 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 0000000000..36d5adce4a --- /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/invokes_built_in_tools.yaml b/test/snapshots/tools/invokes_built_in_tools.yaml index 068cc4accf..0fba134424 100644 --- a/test/snapshots/tools/invokes_built_in_tools.yaml +++ b/test/snapshots/tools/invokes_built_in_tools.yaml @@ -15,6 +15,6 @@ conversations: arguments: '{"path":"${workdir}/README.md"}' - role: tool tool_call_id: toolcall_0 - content: "1. # ELIZA, the only chatbot you'll ever need" + content: "# ELIZA, the only chatbot you'll ever need" - role: assistant content: "The first line of README.md is: `# ELIZA, the only chatbot you'll ever need`"